Skip to content

Ruby time zone lookup interface using tzf-rs Rust library

License

Notifications You must be signed in to change notification settings

HarlemSquirrel/tzf-rb

Repository files navigation

tzf-rb

tzf build

Ruby time zone lookup for coordinates using the tzf-rs Rust library.

Data is sourced from Timezone Boundary Builder.

Installation

Install Ruby and clang using your operating system's package manager. Currently, clang is required to build and install the native Rust extensions with rb_sys.

During the below install with RubyGems, the system will attempt to download and install Rust and Cargo if not found. Optionall, install Rust before installing this gem.

Install the gem and add to the application's Gemfile by executing:

$ bundle add tzf

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install tzf

Usage

require 'tzf'

TZF.tz_name(40.74771675713742, -73.99350390136448)
# => "America/New_York"

TZF.tz_names(40.74771675713742, -73.99350390136448)
# => ["America/New_York"]

Development

Requirements:

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tzf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the tzf project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.