tzf 0.1.0

data/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "tzf"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+lazy_static = "1.4.0"
+tzf-rs = "0.3.0"

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tzf.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-rake", "~> 0.6"
+gem "rubocop-rspec", "~> 2.18"

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    tzf (0.1.0)
+      ffi (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.18)
+  tzf!
+
+BUNDLED WITH
+   2.4.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kevin McCormack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# tzf-rb
+
+Time zone lookup using [tzf-rs](https://github.com/ringsaturn/tzf-rs).
+
+## Installation
+
+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
+
+```rb
+require 'tzf'
+
+TZF.tz_name(40.74771675713742, -73.99350390136448)
+# => "America/New_York"
+```
+
+## Development
+
+Requirements:
+
+- (Rust)[https://www.rust-lang.org/learn/get-started]
+- (Ruby)[https://www.ruby-lang.org]
+
+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](https://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](https://github.com/[USERNAME]/tzf/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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](https://github.com/[USERNAME]/tzf/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+desc "Build rust dependencies"
+task :rust_build do
+  `cargo rustc --release`
+  `cp ./target/release/libtzf.so ./lib/tzf/`
+end
+
+desc "Clean rust dependencies"
+task :rust_clean do
+  `cargo clean`
+  `rm -f ./lib/tzf/libtzf.so`
+end
+
+task default: %i[rust_build spec rubocop]

data/lib/tzf/ffi_ext.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "ffi"
+
+module TZF
+  ##
+  # Interface to tsf-rs Rust library.
+  #
+  module RS
+    extend FFI::Library
+
+    ffi_lib File.expand_path("libtzf.so", __dir__)
+    attach_function :get_tz_name, %i[double double], :string
+  end
+end

data/lib/tzf/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TZF
+  VERSION = "0.1.0"
+end

data/lib/tzf.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "tzf/version"
+require_relative "tzf/ffi_ext"
+
+##
+# Top level.
+#
+module TZF
+  class Error < StandardError; end
+
+  def self.tz_name(lat, lng)
+    RS.get_tz_name(lat, lng)
+  end
+end

data/sig/tzf_rs_rb.rbs

@@ -0,0 +1,4 @@
+module tzf
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/src/lib.rs

@@ -0,0 +1,17 @@
+use lazy_static::lazy_static;
+use std::ffi::CString;
+use tzf_rs::DefaultFinder;
+
+lazy_static! {
+  static ref FINDER: DefaultFinder = DefaultFinder::new();
+}
+
+#[no_mangle]
+pub extern fn get_tz_name(lat: f64, lng: f64) -> CString {
+  // let finder = DefaultFinder::new();
+
+  // Create a CString so we can read this in Ruby with FFI
+  let tz_name = CString::new(FINDER.get_tz_name(lng, lat));
+
+  return tz_name.unwrap();
+}

data/tzf.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/tzf/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "tzf"
+  spec.version = TZF::VERSION
+  spec.authors = ["Kevin McCormack"]
+  spec.email = ["kevin@mccormack.tech"]
+
+  spec.summary = "Ruby time zone lookup interface using tzf-rs"
+  spec.description = "Ruby time zone lookup interface using tzf-rs."
+  spec.homepage = "https://github.com/HarlemSquirrel/tzf-rb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/HarlemSquirrel/tzf-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/HarlemSquirrel/tzf-rb/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "ffi", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: tzf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin McCormack
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby time zone lookup interface using tzf-rs.
+email:
+- kevin@mccormack.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Cargo.lock
+- Cargo.toml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tzf.rb
+- lib/tzf/ffi_ext.rb
+- lib/tzf/libtzf.so
+- lib/tzf/version.rb
+- sig/tzf_rs_rb.rbs
+- src/lib.rs
+- tzf.gemspec
+homepage: https://github.com/HarlemSquirrel/tzf-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/HarlemSquirrel/tzf-rb
+  source_code_uri: https://github.com/HarlemSquirrel/tzf-rb
+  changelog_uri: https://github.com/HarlemSquirrel/tzf-rb/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Ruby time zone lookup interface using tzf-rs
+test_files: []