timezone_lat_lon 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83f1636b6cbdc2dd4e89a6de5f3388b0e5c49db784a01b34a25cbd12005a18ce
-  data.tar.gz: 3bce6b0fe53d0e27271e10fcf0eb0b8f4c206a129a81ee996182a95f3e391121
+  metadata.gz: f2d1bd9290f69fa622101dc58298187b5661692211700ab4b9137f060c13492f
+  data.tar.gz: c6903a82828a604c3ad63ef123a96df9366cdf381be2c79b30cf9e9cddf92cf9
 SHA512:
-  metadata.gz: fbf6ecb7b358de8b118d83288153b3f90fbbb2c45fb204e1020aad0e0bd2c55dea1da887dd3a12ed171ceb64acead6b1ac00893c2d37100ca4d017ffd8f56379
-  data.tar.gz: f8a4cbf36ef880e1b58804702a9ccf569ae45081d2ee2c2ab5da5a097aad49c912cab218ba14e621280eaef72cd0d9a549d53523189fdea8ec359f8cf8f9bdf7
+  metadata.gz: 954e36f11957d0e78da312072ac999e19c003aa2aeb0dbc1619191bd2f1a5d7f1a953d694576cb8af01316f9f51921c93bfe119d6501961ba4fd7f16efaf8c67
+  data.tar.gz: fd7dc6ae00595de75e1c6cde22edd87d214e7f6aec6ebe7c7640540419eadc35131e2767dc23b9c6addb10c37624abf60af2d306741c53875b9119804b5f3a50

data/lib/timezone_lat_lon.rb

@@ -5,10 +5,8 @@ module TimezoneLatLon
   class << self
     include Search
 
-    @@loader = TimezoneLatLon::Loader.new(geojson_filename: 'combined-compressed.json')
-
     def loader
-      return @@loader
+      @@loader ||= TimezoneLatLon::Loader.new(geojson_filename: 'combined-compressed.json')
     end
   end
 end

data/lib/timezone_lat_lon/loader.rb

@@ -6,6 +6,8 @@ module TimezoneLatLon
   class Loader
     attr_accessor :config, :timezone_data
 
+    CACHE_FILE_NAME = 'time_zones.cache'
+
     def initialize(config = {})
       @config = {
         geojson_filename: 'combined.json'
@@ -17,10 +19,10 @@ module TimezoneLatLon
     private
 
     def load_data
-      begin
-        timezone_data_path = File.expand_path(File.join('..', '..', 'data', 'time_zones.dump'), __dir__)
-        @timezone_data = Marshal.load(File.open(timezone_data_path).read)
-      rescue => exception
+      timezone_dump_file  = File.expand_path(File.join('..', '..', 'data', CACHE_FILE_NAME), __dir__)
+      if File.exists?(timezone_dump_file)
+        @timezone_data = Marshal.load(File.open(timezone_dump_file).read)
+      else # timezone_dump_file does not exist!
         self.load_data_from_geojson
       end
     end
@@ -41,6 +43,11 @@ module TimezoneLatLon
           attributes: attributes,
         }
       end
+
+      timezone_dump_file = File.expand_path(File.join('..', '..', 'data', CACHE_FILE_NAME), __dir__)
+      File.open(timezone_dump_file, "w") do |f|
+        f.write(Marshal.dump(@timezone_data))
+      end
     end
   end
 end

data/lib/timezone_lat_lon/version.rb

@@ -1,3 +1,3 @@
 module TimezoneLatLon
-  VERSION = '1.0'
+  VERSION = '1.0.1'
 end

data/spec/timezone_lat_lon_spec.rb

@@ -0,0 +1,50 @@
+describe 'TimezoneLatLon' do
+  latlon1 = { lat: 49.886505, lon: 25.167341   } # Ukraine
+  latlon2 = { lat: 35.852462, lon: 14.447913   } # Malta
+  latlon3 = { lat: 25.303352, lon: -156.278805 } # Pacific Ocean
+
+  # -- Test storing/loading time_zones.cache after initialization
+  describe 'cache file' do
+    CACHE_FILE = './data/time_zones.cache'
+
+    before :example do
+      cache_exists = File.exists?(CACHE_FILE)
+      File.delete(CACHE_FILE) if cache_exists
+
+      require 'timezone_lat_lon'
+    end
+
+    context 'on first run' do
+      it 'is created' do
+        TimezoneLatLon.find_timezone(latlon3)
+        cache_exists_after = File.exists?(CACHE_FILE)
+        expect(cache_exists_after).to eql(true)
+      end
+    end
+  end
+
+  # -- Test the find_timezone method
+  describe '.find_timezone(lat:, lon:)' do
+    before :context do
+      require 'timezone_lat_lon'
+    end
+
+    context "given #{latlon1.inspect}" do
+      it "returns Europe/Ukraine" do
+        expect(TimezoneLatLon.find_timezone(latlon1)).to eql(TZInfo::Timezone.get('Europe/Kiev'))
+      end
+    end
+
+    context "given #{latlon2}" do
+      it "returns Europe/Malta" do
+        expect(TimezoneLatLon.find_timezone(latlon2)).to eql(TZInfo::Timezone.get('Europe/Malta'))
+      end
+    end
+
+    context "given #{latlon3}" do
+      it "returns nil" do
+        expect(TimezoneLatLon.find_timezone(latlon3)).to eql(nil)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timezone_lat_lon
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
 platform: ruby
 authors:
 - Robert J. Schofield
@@ -80,21 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-description: Find timezones by latitude and longitude.
+description: Utilities for looking up the timezone contained by a latitude and longitude.
 email: rjschofield96@gmail.com
 executables: []
 extensions: []
@@ -107,7 +93,7 @@ files:
 - lib/timezone_lat_lon/loader.rb
 - lib/timezone_lat_lon/search.rb
 - lib/timezone_lat_lon/version.rb
-- scripts/process-timezones.rb
+- spec/timezone_lat_lon_spec.rb
 homepage: https://github.com/rjschof/timezone_lat_lon
 licenses:
 - MIT
@@ -130,5 +116,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: Find timezones by latitude and longitude.
+summary: Timezone lookup by latitude and longitude
 test_files: []

data/scripts/process-timezones.rb

@@ -1,87 +0,0 @@
-require 'benchmark'
-require 'byebug'
-require 'kdtree'
-require 'oj'
-require 'rgeo/shapefile'
-require 'rgeo/geo_json'
-require 'ruby-progressbar'
-
-# -- Global variables
-$timezone_data = []
-
-# -- Helper methods
-def find_containing_timezone(lat:, lon:)
-  factory = RGeo::Geographic.simple_mercator_factory
-  point = factory.point(lon, lat)
-  return $timezone_data.find { |sd| sd[:geometry].contains?(point) }
-end
-
-def load_geojson(geojson_path)
-  load_benchmark = Benchmark.measure do 
-    file = File.open(geojson_path)
-    content = file.read
-    geojson_obj = Oj.load(content)
-    features = RGeo::GeoJSON.decode(geojson_obj)
-    features.each do |feature|
-      attributes = feature.keys.map do |key|
-        [key, feature[key]]
-      end.to_h
-
-      $timezone_data << {
-        geometry: feature.geometry,
-        attributes: attributes,
-      }
-    end
-  end
-  puts("Load Benchmark: #{load_benchmark}")
-end
-
-def load_shapefile(shapefile_path)
-  load_benchmark = Benchmark.measure do 
-    RGeo::Shapefile::Reader.open(shapefile_path) do |file|
-      file.each do |record|
-        progress.increment
-        $timezone_data << {
-          geometry: record.geometry,
-          attributes: record.attributes
-        }
-      end
-    end
-  end
-  puts("Load Benchmark: #{load_benchmark}")
-end
-
-def test_timezone_check(lat:, lon:)
-  timezone = nil
-  benchmark = Benchmark.measure do 
-    timezone = find_containing_timezone(lat: lat, lon: lon)
-  end
-  timezone_attrs = timezone.nil? ? nil : timezone[:attributes]
-  puts("Timezone for [#{lat}, #{lon}]: #{timezone_attrs || 'NOT_FOUND'} - #{benchmark}")
-end
-
-# -- Script processing
-# load_shapefile('./data/timezones/shapefile/combined-shapefile.shp')
-begin
-  timezone_data = File.open(File.expand_path("../../data/time_zones.dump", __FILE__)).read
-  $timezone_data = Marshal.load(timezone_data)
-  puts('Loaded timezone data from from dumpfile.')
-rescue => exception
-  puts("Exception: #{exception.inspect}")
-  load_geojson('./data/timezones/geojson/combined-3.json')
-  File.open(File.expand_path("../../data/time_zones.dump", __FILE__),"w") do |f|
-    f.write(Marshal.dump($timezone_data))
-  end
-  puts('Loaded timezone data from scratch.')
-end
-
-puts("---------- Testing ----------")
-latlon_list = [
-  { lat: 49.886505, lon: 25.167341   }, # Ukraine
-  { lat: 35.852462, lon: 14.447913   }, # Malta
-  { lat: 23.058549, lon: 84.893071   }, # India... Jharkhand
-  { lat: 25.303352, lon: -156.278805 }, # Pacific Ocean .. Near Hawaii
-]
-latlon_list.each do |latlon|
-  test_timezone_check(latlon)
-end