https://github.com/mamantoha/time_zone

A helper to work with time zones in Crystal
https://github.com/mamantoha/time_zone

crystal

Last synced: 5 months ago
JSON representation

A helper to work with time zones in Crystal

• Host: GitHub
• URL: https://github.com/mamantoha/time_zone
• Owner: mamantoha
• License: mit
• Created: 2022-04-14T08:37:40.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-31T09:43:13.000Z (over 1 year ago)
• Last Synced: 2024-11-02T10:11:33.070Z (over 1 year ago)
• Topics: crystal
• Language: Crystal
• Homepage:
• Size: 19.5 KB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# TimeZone

[![Crystal CI](https://github.com/mamantoha/time_zone/actions/workflows/crystal.yml/badge.svg)](https://github.com/mamantoha/time_zone/actions/workflows/crystal.yml)

[![GitHub release](https://img.shields.io/github/release/mamantoha/time_zone.svg)](https://github.com/mamantoha/time_zone/releases)

[![License](https://img.shields.io/github/license/mamantoha/time_zone.svg)](https://github.com/mamantoha/time_zone/blob/main/LICENSE)

The `TimeZone` class serves as a helper to work with time zones in Crystal.

It allows to do the following:

- Limit the set of zones to a meaningful subset of 151 zones.

- Retrieve and display zones with a friendlier name (e.g., "Eastern Time (US & Canada)" instead of "America/New_York").

## Installation

1. Add the dependency to your `shard.yml`:

   ```yaml

   dependencies:

     time_zone:

       github: mamantoha/time_zone

   ```

2. Run `shards install`

## Usage

```crystal

require "time_zone"

zone = TimeZone.new("Taipei")

zone # => #, @utc_offset=28800>

puts zone

# (GMT+08:00) Taipei

zone.local # returns the current time in time zone "Asia/Taipei"

```

### Converting times between timezones

```crystal

zone_ua = TimeZone.new("Kyiv")

zone_ar = TimeZone.new("Buenos Aires")

time_ua = zone_ua.local(2022, 2, 24, 5, 30, 0)

time_ar = time_ua.in(zone_ar.location)

time_ua

# => 2022-02-24 05:30:00.0 +02:00 Europe/Kiev

time_ar

# => 2022-02-24 00:30:00.0 -03:00 America/Argentina/Buenos_Aires

```

## Contributing

1. Fork it ()

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## Contributors

- [Anton Maminov](https://github.com/mamantoha) - creator and maintainer