a0-tzmigration-ruby 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b733404e9d1fc656401129fe8d37b28bedf56f0dc1482dcba9214780c79ef70
-  data.tar.gz: 9282751867db162d40e3516cb6ca0da2785dd1c37e8130e375a063ceda493afa
+  metadata.gz: 5315ca942000e3f71a8f3e37927f20b2eec0ec7a29dbd8ab71808abe76d63b24
+  data.tar.gz: 8a0c381804c482cf2c04b67ad5db8f96c6ec8b71c15d8052e8a9f002f45c9806
 SHA512:
-  metadata.gz: d1580f370557ce698906f8dc55a5f275bac7b9dc90ea07273782a9321288f74ca8b4e062037e427e4448573d6b8613dff0ae36b58ec5e094a2c5de6f2cb8a8ca
-  data.tar.gz: aa0d5f86ab757f7e0605ced7e2980ed74cc23ce89d4b2742d8f83d6fcd498155fd5684672c5a62642305254f9604408f5cd86cb3dc775876ffbd41429ad44709
+  metadata.gz: c64c31ad265828ed9ca784856d8261e02a24c1c60f8e0538cd2ad6dfe38925108af6a5073378148a13a43ec02a95220eb2eb0e607b70a117b020b6d4a5dc6176
+  data.tar.gz: 597161ffde5f4d510ada563e354d4498458123022b9350db906482beb669de0f06efc9d8776223f87ad332f5e0b9c9dee13b73e5d359dd02d43ba40a6e051802

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    a0-tzmigration-ruby (0.1.1)
+    a0-tzmigration-ruby (1.0.0)
       rest-client
 
 GEM

data/README.md

@@ -1,15 +1,14 @@
 # A0::TZMigration
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/a0/tzmigration`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem provides utilities to help with migrations between timezone changes. Please check the official webpage for documentation:
+[https://a0.github.io/a0-tzmigration/](https://a0.github.io/a0-tzmigration/)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'a0-tzmigration'
+gem 'a0-tzmigration-ruby'
 ```
 
 And then execute:
@@ -18,11 +17,56 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install a0-tzmigration
+    $ gem install a0-tzmigration-ruby
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'a0-tzmigration-ruby'
+
+# calculate changes from America/Santiago 2015a to America/Punta_Arenas 2017a
+version_a = A0::TZMigration::TZVersion.new('America/Santiago', '2015a')
+version_b = A0::TZMigration::TZVersion.new('America/Punta_Arenas', '2017a')
+
+version_a.changes(version_b)
+# =>
+[{:ini_str=>"-∞", :fin_str=>"1890-01-01 04:43:40 UTC", :off_str=>"-00:00:54", :ini=>-Infinity, :fin=>-2524504580, :off=>-54},
+ {:ini_str=>"1910-01-01 04:42:46 UTC", :fin_str=>"1910-01-10 04:42:46 UTC", :off_str=>"+00:17:14", :ini=>-1893439034, :fin=>-1892661434, :off=>1034},
+ {:ini_str=>"1918-09-01 04:42:46 UTC", :fin_str=>"1918-09-10 04:42:46 UTC", :off_str=>"-00:42:46", :ini=>-1619983034, :fin=>-1619205434, :off=>-2566},
+ {:ini_str=>"1946-09-01 03:00:00 UTC", :fin_str=>"1947-04-01 04:00:00 UTC", :off_str=>"+01:00:00", :ini=>-736376400, :fin=>-718056000, :off=>3600},
+ {:ini_str=>"1947-05-22 04:00:00 UTC", :fin_str=>"1947-05-22 05:00:00 UTC", :off_str=>"+01:00:00", :ini=>-713649600, :fin=>-713646000, :off=>3600},
+ {:ini_str=>"1988-10-02 04:00:00 UTC", :fin_str=>"1988-10-09 04:00:00 UTC", :off_str=>"-01:00:00", :ini=>591768000, :fin=>592372800, :off=>-3600},
+ {:ini_str=>"1990-03-11 03:00:00 UTC", :fin_str=>"1990-03-18 03:00:00 UTC", :off_str=>"-01:00:00", :ini=>637124400, :fin=>637729200, :off=>-3600},
+ {:ini_str=>"2016-05-15 03:00:00 UTC", :fin_str=>"2016-08-14 04:00:00 UTC", :off_str=>"-01:00:00", :ini=>1463281200, :fin=>1471147200, :off=>-3600}]
+
+
+# get current known versions in the repository
+A0::TZMigration::TZVersion.versions
+# =>
+  { "2013c" =>
+    { "released_at" => "2013-04-19 16:17:40 -0700",
+      "timezones" => [
+        "Africa/Abidjan",
+        "Africa/Accra",
+        "Africa/Addis_Ababa",
+        "Africa/Algiers",
+        "Africa/Asmara",
+        …
+
+
+# get current known timezones in the repository
+A0::TZMigration::TZVersion.timezones
+# =>
+  { "Africa/Abidjan" =>
+    { "versions" => [
+        "2013c",
+        "2013d",
+        "2013e",
+        "2013f",
+        "2013g",
+        …
+
+```
 
 ## Development
 

data/docs/index.md

@@ -1,3 +1,9 @@
+# Ruby API
+
+API usage and documentation for the ruby gem and others can be found at the official webpage:
+[https://a0.github.io/a0-tzmigration/](https://a0.github.io/a0-tzmigration/)
+
+
 # JSON data files
 
 All info is publicly available at the following URL:

data/lib/a0/tzmigration.rb

@@ -2,6 +2,6 @@
 
 require 'a0/tzmigration/config'
 require 'a0/tzmigration/data_generator'
-require 'a0/tzmigration/range_list'
 require 'a0/tzmigration/tzversion'
+require 'a0/tzmigration/util'
 require 'a0/tzmigration/version'

data/lib/a0/tzmigration/tzversion.rb

@@ -1,74 +1,61 @@
 # frozen_string_literal: true
 
-require 'rest-client'
-
 module A0
   module TZMigration
     class TZVersion
-      attr_reader :path, :name, :version
+      attr_reader :name, :version
 
       def initialize(name, version)
         @name = name
         @version = version
-
-        transitions
       end
 
-      def self.load_from_network(path)
-        url = "#{A0::TZMigration.config.base_url}/#{path}"
+      def data
+        return @data if defined? @data
 
-        JSON.parse RestClient.get(url)
+        @data = Util.load_from_network_or_file("timezones/#{name}.json")
       end
 
-      def self.load_from_file(path)
-        conf = A0::TZMigration.config.data_dir
-        file = File.join(conf, path)
-
-        raise "File #{path} not found at #{conf}" unless File.exist? file
-
-        JSON.parse File.read(file)
-      end
+      def version_data
+        return @version_data if defined? @version_data
 
-      def self.load_from_network_or_file(path)
-        load_from_network(path)
-      rescue StandardError => error
-        warn "Unable to fetch from network, using local files (error was: #{error})"
-        load_from_file(path)
-      end
+        raise "Version #{@version} not found for #{@name}." unless (@version_data = data.dig('versions', @version))
 
-      def data
-        return @data if defined? @data
+        if @version_data['alias']
+          @link = TZVersion.new(@version_data['alias'], @version)
+          @version_data = @link.version_data
+        end
 
-        @data = TZVersion.load_from_network_or_file("timezones/#{name}.json")
+        @version_data
       end
 
       def released_at
         return @released_at if defined? @released_at
 
-        @released_at = Time.parse version_data['released_at']
+        @released_at = version_data['released_at']
       end
 
-      def version_data
-        return @version_data if defined? @version_data
-
-        raise "Version #{@version} not found" unless (@version_data = data.dig('versions', @version))
+      def transitions
+        return @transitions if defined? @transitions
 
-        @version_data
+        @transitions = version_data['transitions']
       end
 
-      def transitions
-        return @transitions if defined? @transitions
+      def transition_ranges # rubocop:disable Metrics/AbcSize
+        return @transition_ranges if defined? @transition_ranges
+
+        ini = -Float::INFINITY
+        fin = +Float::INFINITY
 
-        if version_data['alias']
-          @transitions = TZVersion.new(version_data['alias'], @version).transitions
-        else
-          @transitions = version_data['transitions']
-          @transitions.each do |transition|
-            transition['utc_time'] = Time.parse(transition['utc_time'])
-          end
+        return @transition_ranges = [Util.range_item(ini, fin, 0)] if transitions.empty?
+
+        @transition_ranges = transitions.map do |transition|
+          Util.range_item(ini, (ini = transition['utc_timestamp']), transition['utc_prev_offset'])
         end
 
-        @transitions
+        @transition_ranges << Util.range_item(@transition_ranges.last[:fin], fin, transitions.last['utc_offset'])
+
+        @transition_ranges
       end
 
       def timestamps
@@ -83,50 +70,28 @@ module A0
         @timestamps
       end
 
-      def timezone_ranges
-        return @timezone_ranges if defined? @timezone_ranges
-
-        ini = -Float::INFINITY
-        fin = +Float::INFINITY
-
-        @timezone_ranges = transitions.map do |transition|
-          { ini: ini, fin: (ini = transition['utc_timestamp']), off: transition['utc_prev_offset'] }
-        end
-
-        @timezone_ranges << { ini: @timezone_ranges.last[:fin], fin: fin, off: transitions.last['utc_offset'] } unless @timezone_ranges.empty?
-
-        @timezone_ranges
-      end
-
-      def timezone_ranges_timed
-        A0::TZMigration.timestamp_range_list!(Marshal.dump(timezone_ranges))
-      end
-
-      def delta_range_list(other) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        raise "No transitions for self #{@name}/#{@version}" if transitions.empty?
-        raise "No transitions for other #{name}/#{version}" if other.transitions.empty?
-
-        timestamp_list = (timestamps + other.timestamps).uniq.sort
+      def changes(other) # rubocop:disable Metrics/AbcSize
+        timestamp_list = (timestamps + other.timestamps).sort.uniq
 
-        list_a = A0::TZMigration.split_range_list!(Marshal.load(Marshal.dump(timezone_ranges)), timestamp_list)
-        list_b = A0::TZMigration.split_range_list!(Marshal.load(Marshal.dump(other.timezone_ranges)), timestamp_list)
+        list_a = Util.split_ranges(transition_ranges, timestamp_list)
+        list_b = Util.split_ranges(other.transition_ranges, timestamp_list)
 
-        delta = []
+        changes = []
         list_a.each_with_index do |range_a, index|
           range_b = list_b[index]
 
-          delta << { ini: range_a[:ini], fin: range_a[:fin], off: range_b[:off] - range_a[:off] } if range_a[:off] != range_b[:off]
+          changes << Util.range_item(range_a[:ini], range_a[:fin], range_b[:off] - range_a[:off]) if range_a[:off] != range_b[:off]
         end
 
-        A0::TZMigration.timestamp_range_list!(A0::TZMigration.compact_range_list!(delta))
+        Util.compact_ranges!(changes)
       end
 
       def self.versions
-        @versions = load_from_network_or_file('versions/00-index.json')
+        @versions = Util.load_from_network_or_file('versions/00-index.json')['versions']
       end
 
       def self.timezones
-        @timezones = load_from_network_or_file('timezones/00-index.json')
+        @timezones = Util.load_from_network_or_file('timezones/00-index.json')['timezones']
       end
     end
   end

data/lib/a0/tzmigration/util.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+
+module A0
+  module TZMigration
+    module Util
+      def self.compact_ranges!(range_list) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        index = 0
+
+        while index < range_list.count
+          curr_range = range_list[index]
+          next_range = range_list[index + 1]
+
+          if next_range && curr_range[:fin] == next_range[:ini] && curr_range[:off] == next_range[:off]
+            curr_range[:fin] = next_range[:fin]
+            curr_range[:fin_str] = next_range[:fin_str]
+            range_list.delete_at(index + 1)
+          else
+            index += 1
+          end
+        end
+
+        range_list
+      end
+
+      def self.offset_to_str(offset)
+        str = Time.at(offset.abs).utc.strftime('%H:%M:%S')
+        sig = offset.negative? ? '-' : '+'
+
+        "#{sig}#{str}"
+      end
+
+      def self.timestamp_to_str(timestamp)
+        if timestamp == -Float::INFINITY
+          '-∞'
+        elsif timestamp == +Float::INFINITY
+          '∞'
+        else
+          Time.at(timestamp).utc.to_s
+        end
+      end
+
+      def self.range_item(ini, fin, off)
+        { ini_str: timestamp_to_str(ini), fin_str: timestamp_to_str(fin), off_str: offset_to_str(off), ini: ini, fin: fin, off: off }
+      end
+
+      def self.next_index(index, range_list, timestamp)
+        index += 1 while range_list[index + 1] && range_list[index][:ini] < timestamp && range_list[index][:fin] <= timestamp
+
+        index
+      end
+
+      def self.split_ranges(range_list, timestamps) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        range_list = Marshal.load(Marshal.dump(range_list))
+        index = 0
+
+        timestamps.each do |timestamp|
+          index = next_index(index, range_list, timestamp)
+          range = range_list[index]
+
+          if index < range_list.count && timestamp > range[:ini] && timestamp < range[:fin]
+            range_list.insert index + 1, range.merge(ini: timestamp)
+            range_list[index][:fin] = timestamp
+          end
+        end
+
+        range_list
+      end
+
+      def self.load_from_network(path)
+        url = "#{A0::TZMigration.config.base_url}/#{path}"
+
+        JSON.parse RestClient.get(url)
+      end
+
+      def self.load_from_file(path)
+        conf = A0::TZMigration.config.data_dir
+        file = File.join(conf, path)
+
+        raise "File #{path} not found at #{conf}" unless File.exist? file
+
+        JSON.parse File.read(file)
+      end
+
+      def self.load_from_network_or_file(path)
+        load_from_network(path)
+      rescue StandardError => error
+        warn "Unable to fetch from network, using local files (error was: #{error})"
+        load_from_file(path)
+      end
+    end
+  end
+end

data/lib/a0/tzmigration/version.rb

@@ -2,6 +2,6 @@
 
 module A0
   module TZMigration
-    VERSION = '0.1.1'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a0-tzmigration-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Aldrin Martoq
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-31 00:00:00.000000000 Z
+date: 2018-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -827,8 +827,8 @@ files:
 - lib/a0/tzmigration/data_generator/git.rb
 - lib/a0/tzmigration/data_generator/process.rb
 - lib/a0/tzmigration/data_generator/save.rb
-- lib/a0/tzmigration/range_list.rb
 - lib/a0/tzmigration/tzversion.rb
+- lib/a0/tzmigration/util.rb
 - lib/a0/tzmigration/version.rb
 homepage: http://github.com/a0/a0-tzmigration-ruby
 licenses:

data/lib/a0/tzmigration/range_list.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module A0
-  module TZMigration
-    def self.compact_range_list!(range_list) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      index = 0
-
-      while index < range_list.count
-        curr_range = range_list[index]
-        next_range = range_list[index + 1]
-
-        if next_range && curr_range[:fin] == next_range[:ini] && curr_range[:off] == next_range[:off]
-          curr_range[:fin] = next_range[:fin]
-          range_list.delete_at(index + 1)
-        else
-          index += 1
-        end
-      end
-
-      range_list
-    end
-
-    def self.next_index(index, range_list, timestamp)
-      index += 1 while range_list[index + 1] && range_list[index][:ini] < timestamp && range_list[index][:fin] <= timestamp
-
-      index
-    end
-
-    def self.timestamp_to_utc(timestamp)
-      Time.at(timestamp).utc if timestamp && timestamp != Float::INFINITY && timestamp != -Float::INFINITY
-    end
-
-    def self.timestamp_range_list!(range_list)
-      range_list.each do |range|
-        range[:utc_ini] = timestamp_to_utc(range[:ini])
-        range[:utc_fin] = timestamp_to_utc(range[:fin])
-      end
-
-      range_list
-    end
-
-    def self.split_range_list!(range_list, timestamps) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      index = next_index(0, range_list, timestamps.first)
-
-      timestamps.each_with_index do |timestamp, timestamp_index|
-        range = range_list[index]
-
-        if timestamp > range[:ini] && timestamp < range[:fin] && index < range_list.count
-          range_list.insert index + 1, range.merge(ini: timestamp)
-          range_list[index][:fin] = timestamp
-        end
-
-        next_timestamp = timestamps[timestamp_index + 1]
-
-        index = next_index(index, range_list, next_timestamp) if next_timestamp
-      end
-
-      range_list
-    end
-  end
-end