timesteps 0.9.3 → 0.9.5

data/lib/timesteps/{timestepconverter.rb → timestep_converter.rb}

@@ -2,7 +2,7 @@ require "timesteps"
 
 class TimeStep::Converter
   
-  def initialize (reference, calendar: "standard", bc: false)
+  def initialize (reference, name: "reference", calendar: "standard", bc: false)
     @calendar = calendar
     @bc = bc
     case reference
@@ -15,16 +15,22 @@ class TimeStep::Converter
     end
     @pair = {}
     @target = {}
-    self["reference"] = reference
+    self[name] = reference
   end
   
   # Append or reset new target time step for the given name.
   #
-  def []= (name, spec)
+  def add_timestep (spec, name:)
     @pair[name] = TimeStep::Pair.new(@reference, spec, calendar: @calendar, bc: @bc)
     @target[name] = @pair[name].to
     return @target[name]
   end
+  
+  # Append or reset new target time step for the given name.
+  #
+  def []= (name, spec)
+    return add_timestep(spec, name: name)
+  end
 
   # Return target time step of the given name.
   #
@@ -39,14 +45,41 @@ class TimeStep::Converter
     @target.delete(name)
   end
 
-  def forward (*indices)
-    hash = {}
+  # Returns the time represented by the given index as DateTime object
+  #
+  # @param indices [Numeric,Array<Numeric>]
+  #
+  # @return [DateTime]
+  def time_at (*indices)
+    return @reference.time_at(*indices)
+  end
+
+  # Converts index refering `from` timestep to index refering `to`timestep.
+  #
+  def forward (*indices, with_time: false)
+    if with_time
+      hash = {
+        "time" => time_at(*indices)        
+      }
+    else
+      hash = {}
+    end
     @pair.each do |name, conv|
       hash[name] = conv.forward(*indices)
     end
     return hash
   end
 
+  def range (ge: nil, gt: nil, lt: nil, le: nil, with_time: false)
+    indices = @reference.range(ge: ge, gt: gt, lt: lt, le: le)
+    return forward(*indices, with_time: with_time)    
+  end
+
+  def index_at (*times, format: nil, with_time: false)
+    indices = @reference.index_at(*times, format: format)
+    return forward(*indices, with_time: with_time)
+  end
+
   def valid? (*indices)
     hash = {}
     @pair.each do |name, conv|
@@ -55,9 +88,6 @@ class TimeStep::Converter
     return hash
   end
 
-  def time_at (index)
-    return @from.time_at(index)
-  end
 
 end
 

data/lib/timesteps/{timestepdatetimeext.rb → timestep_datetime_ext.rb}

@@ -73,7 +73,7 @@ class TimeStep
     end
 
   end
-
+  
 end
 
 

data/lib/timesteps/{timesteppair.rb → timestep_pair.rb}

@@ -18,7 +18,6 @@ class TimeStep::Pair
   # @option calendar [String, TimeStep::Calendar]
   # @option bc [Boolean]
   # 
-
   def initialize (from, to, calendar: "standard", bc: false)
 
     case from
@@ -60,7 +59,9 @@ class TimeStep::Pair
   end
   
   attr_reader :from, :to, :difference
-    
+
+  # Returns the value as a string for inspection.
+  #
   def inspect
     "#<TimeStep::Pair from='#{from.inspect}' to='#{to.inspect}'>"
   end
@@ -69,14 +70,20 @@ class TimeStep::Pair
   #
   # @return [Boolean]
   def == (other)
-    return @from == other.from && 
-           @to == other.to 
+    return @from == other.from && @to == other.to 
   end
   
+  # Returns the time represented by the given index as DateTime object
+  #
+  # @param indices [Numeric,Array<Numeric>]
+  #
+  # @return [DateTime]
   def time_at (*indices)
     @from.time_at(*indices)
   end
   
+  # Converts index refering `from` timestep to index refering `to`timestep.
+  #
   def forward (*indices, &block)
     if indices.size == 1    
       index = indices.first.to_r
@@ -115,30 +122,17 @@ class TimeStep::Pair
 
   alias [] forward
 
-  def forward_time (index)
-    if @numeric_conversion
-      return @to.time_at((index*@from_interval + @difference).quo(@to_interval))
-    else
-      case @from_symbol
-      when :years, :months
-        target = @from.time_at(index)
-      else
-        target = @from_origin + index*(@from_interval.quo(86400))
-      end
-      case @to_symbol
-      when :years
-        index = (target.year - @from_origin.year).quo(@to.numeric)
-      when :months
-        ms = 12*(target.year - @from_origin.year)
-        ms += target.month - @from_origin.month
-        index = ms.quo(@to.numeric)
-      else
-        index = (target.ajd - @from_origin.ajd).quo(@to_interval)
-      end
-      return @to.time_at(index)
-    end      
+  def forward_time (*indices)
+    return forward(*indices) {|index| @to.time_at(index) }
   end
 
+  def range (ge: nil, gt: nil, lt: nil, le: nil)
+    indices = @from.range(ge: ge, gt: gt, lt: lt, le: le)
+    return forward(*indices)    
+  end
+
+  # Converts index refering `to` timestep to index refering `from` timestep.
+  #
   def inverse (*indices, &block)
     if indices.size == 1    
       index = indices.first.to_r
@@ -159,11 +153,12 @@ class TimeStep::Pair
         else
           value = (target.ajd - @from_origin.ajd).quo(@from_interval)
         end
-        if block
-          return block[value]
-        else
-          return value
-        end
+      end
+      value = value.to_i if value.denominator == 1
+      if block
+        return block[value]
+      else
+        return value
       end
     else
       if block
@@ -174,29 +169,8 @@ class TimeStep::Pair
     end
   end
 
-  # 
-  def inverse_time (index)
-    if @numeric_conversion
-      return @from.time_at((index*@to_interval - @difference).quo(@from_interval))
-    else
-      case @to_symbol
-      when :years, :months
-        target = @to.time_at(index)
-      else
-        target = @to_origin + index*(@to_interval.quo(86400))
-      end
-      case @from_symbol
-      when :years
-        index = (target.year - @to_origin.year).quo(@from.numeric)
-      when :months
-        ms = 12*(target.year - @to_origin.year)
-        ms += target.month - @to_origin.month
-        index = ms.quo(@from.numeric)
-      else
-        index = (target.ajd - @to_origin.ajd).quo(@from_interval)
-      end
-      return @from.time_at(index)
-    end
+  def inverse_time (*indices)
+    return inverse(*indices) {|index| @from.time_at(index) }
   end
     
 end

data/spec/allleap_spec.rb

@@ -109,7 +109,7 @@ describe "AllLeap.parse_timestamp" do
       '05-Mar-2001 09:35:12.5 +09:00',
     ].each do |string|
       
-      d2 = DateTime::AllLeap.parse_timestamp(string)
+      d2 = DateTime.parse_timestamp(string, calendar: "allleap")
 
       is_asserted_by { d2 == d1 }
     end
@@ -119,15 +119,15 @@ describe "AllLeap.parse_timestamp" do
   example 'raise for "2000-02-29"' do
 
     # leap day for noleap calendar
-    is_asserted_by { DateTime::AllLeap.parse_timestamp("2000-2-29").is_a?(DateTime::AllLeap) }
+    is_asserted_by { DateTime.parse_timestamp("2000-2-29", calendar: "allleap").is_a?(DateTime::AllLeap) }
     
   end
 
   example "with bc option" do
     
     d1 = DateTime::AllLeap.new(0, 1, 1, 0, 0, 0, 0)
-    d2 = DateTime::AllLeap.parse_timestamp('BC 0001-1-1 00:00:00')
-    d3 = DateTime::AllLeap.parse_timestamp('-0001-1-1 00:00:00', bc: true)
+    d2 = DateTime.parse_timestamp('BC 0001-1-1 00:00:00', calendar: "allleap")
+    d3 = DateTime.parse_timestamp('-0001-1-1 00:00:00', calendar: "allleap", bc: true)
     
     is_asserted_by { d2 == d1 }
     is_asserted_by { d3 == d1 }
@@ -137,7 +137,7 @@ describe "AllLeap.parse_timestamp" do
   example '2000-12-31 24:00:00' do
 
     d1 = DateTime::AllLeap.new(2001, 1, 1, 0, 0, 0, 0)
-    d2 = DateTime::AllLeap.parse_timestamp('2000-12-31 24:00:00')
+    d2 = DateTime.parse_timestamp('2000-12-31 24:00:00', calendar: "allleap")
 
     is_asserted_by { d2 == d1 }
 

data/spec/fixed360day_spec.rb

@@ -118,7 +118,7 @@ describe "Fixed360Day.parse_timestamp" do
       '05-Mar-2001 09:35:12.5 +09:00',
     ].each do |string|
       
-      d2 = DateTime::Fixed360Day.parse_timestamp(string)
+      d2 = DateTime.parse_timestamp(string, calendar: "360_day")
 
       is_asserted_by { d2 == d1 }
     end
@@ -128,7 +128,7 @@ describe "Fixed360Day.parse_timestamp" do
   example 'raise for "2000-02-29"' do
 
     # leap day for noleap calendar
-    is_asserted_by { DateTime::Fixed360Day.parse_timestamp("2000-2-29").is_a?(DateTime::Fixed360Day) }
+    is_asserted_by { DateTime.parse_timestamp("2000-2-29", calendar: "360_day").is_a?(DateTime::Fixed360Day) }
     
     
   end
@@ -136,8 +136,8 @@ describe "Fixed360Day.parse_timestamp" do
   example "with bc option" do
     
     d1 = DateTime::Fixed360Day.new(0, 1, 1, 0, 0, 0, 0)
-    d2 = DateTime::Fixed360Day.parse_timestamp('BC 0001-1-1 00:00:00')
-    d3 = DateTime::Fixed360Day.parse_timestamp('-0001-1-1 00:00:00', bc: true)
+    d2 = DateTime.parse_timestamp('BC 0001-1-1 00:00:00', calendar: "360_day")
+    d3 = DateTime.parse_timestamp('-0001-1-1 00:00:00', calendar: "360_day", bc: true)
     
     is_asserted_by { d2 == d1 }
     is_asserted_by { d3 == d1 }
@@ -147,7 +147,7 @@ describe "Fixed360Day.parse_timestamp" do
   example '2000-12-31 24:00:00' do
 
     d1 = DateTime::Fixed360Day.new(2001, 1, 1, 0, 0, 0, 0)
-    d2 = DateTime::Fixed360Day.parse_timestamp('2000-12-30 24:00:00')
+    d2 = DateTime.parse_timestamp('2000-12-30 24:00:00', calendar: "360_day")
 
     is_asserted_by { d2 == d1 }
 

data/spec/noleap_spec.rb

@@ -107,7 +107,7 @@ describe "NoLeap.parse_timestamp" do
       '05-Mar-2001 09:35:12.5 +09:00',
     ].each do |string|
       
-      d2 = DateTime::NoLeap.parse_timestamp(string)
+      d2 = DateTime.parse_timestamp(string, calendar: "noleap")
 
       is_asserted_by { d2 == d1 }
     end
@@ -117,15 +117,15 @@ describe "NoLeap.parse_timestamp" do
   example 'raise for "2000-02-29"' do
 
     # leap day for noleap calendar
-    expect { DateTime::NoLeap.parse_timestamp("2000-2-29") }.to raise_error(RuntimeError)
+    expect { DateTime.parse_timestamp("2000-2-29", calendar: "noleap") }.to raise_error(RuntimeError)
     
   end
 
   example "with bc option" do
     
     d1 = DateTime::NoLeap.new(0, 1, 1, 0, 0, 0, 0)
-    d2 = DateTime::NoLeap.parse_timestamp('BC 0001-1-1 00:00:00')
-    d3 = DateTime::NoLeap.parse_timestamp('-0001-1-1 00:00:00', bc: true)
+    d2 = DateTime.parse_timestamp('BC 0001-1-1 00:00:00', calendar: "noleap")
+    d3 = DateTime.parse_timestamp('-0001-1-1 00:00:00', calendar: "noleap", bc: true)
     
     is_asserted_by { d2 == d1 }
     is_asserted_by { d3 == d1 }
@@ -135,7 +135,7 @@ describe "NoLeap.parse_timestamp" do
   example '2000-12-31 24:00:00' do
 
     d1 = DateTime::NoLeap.new(2001, 1, 1, 0, 0, 0, 0)
-    d2 = DateTime::NoLeap.parse_timestamp('2000-12-31 24:00:00')
+    d2 = DateTime.parse_timestamp('2000-12-31 24:00:00', calendar: "noleap")
 
     is_asserted_by { d2 == d1 }
 

data/spec/timestep_spec.rb

@@ -121,6 +121,53 @@ describe "TimeStep.new" do
     end
     
   end
+  
+  example 'since option with format' do
+    
+    time = "20010203_040506.dat"
+    template = "%Y%m%d_%H%M%S.dat"
+
+    ts = TimeStep.new("3 days", since: time, format: template)
+    
+    is_asserted_by { ts.origin.strftime(template) == time }
+    is_asserted_by { ts.numeric == 3 }
+    is_asserted_by { ts.symbol  == :days }
+
+    ts = TimeStep.new("3 days", since: time, format: template, calendar: "noleap")
+    
+    is_asserted_by { ts.origin.strftime(template) == time }
+    is_asserted_by { ts.numeric == 3 }
+    is_asserted_by { ts.symbol  == :days }
+    
+  end
+
+  example 'since option' do
+    
+    time = DateTime.new(2001,2,3,4,5,6,7.quo(24),Date::ITALY)
+    ts = TimeStep.new("3 days", since: time)
+    
+    is_asserted_by { ts.origin == time }
+    is_asserted_by { ts.numeric == 3 }
+    is_asserted_by { ts.symbol  == :days }
+
+    time = DateTime::NoLeap.new(2001,2,3,4,5,6,7.quo(24))
+    ts = TimeStep.new("3 days", since: time, calendar: "noleap")
+    
+    is_asserted_by { ts.origin == time }
+    is_asserted_by { ts.numeric == 3 }
+    is_asserted_by { ts.symbol  == :days }
+    
+  end
+
+  example 'since option with calendar mismatch' do
+    time = DateTime.new(2001,2,3,4,5,6,7.quo(24),Date::GREGORIAN)
+    expect { TimeStep.new("3 days", since: time) }.to raise_error(RuntimeError)
+    expect { TimeStep.new("3 days", since: time, calendar: "noleap") }.to raise_error(RuntimeError)
+
+    time = DateTime::NoLeap.new(2001,2,3,4,5,6,7.quo(24))
+    expect { TimeStep.new("3 days", since: time) }.to raise_error(RuntimeError)
+    expect { TimeStep.new("3 days", since: time, calendar: "allleap") }.to raise_error(RuntimeError)
+  end
 
 end
 
@@ -281,6 +328,15 @@ describe "TimeStep#index_at" do
     
   end
 
+  example 'unix' do 
+    
+    unixtime = TimeStep.new("seconds since 1970-01-01 00:00:00")
+    time = DateTime.parse("2001-01-01 00:00:00 +09:00")
+
+    is_asserted_by { unixtime.index_at(time) == 978274800 }
+  
+  end
+
 end
 
 describe "TimeStep#days_at" do

data/spec/timesteppair_spec.rb

@@ -90,7 +90,6 @@ describe "TimeStep::Pair#forward" do
 
     is_asserted_by { pair.forward(0) == 978274800 }
     is_asserted_by { pair.forward_time(0) == DateTime.new(2000,12,31,15,0,0,0) }
-    is_asserted_by { Time.at(pair.forward(0), in: "+00:00") == ts.origin.to_time }
     
   end
 

data/timesteps.gemspec

@@ -1,6 +1,6 @@
 
 Gem::Specification::new do |s|
-  version = "0.9.3"
+  version = "0.9.5"
 
   files = Dir.glob("**/*") - [ 
                                Dir.glob("timesteps-*.gem"), 
@@ -12,9 +12,12 @@ Gem::Specification::new do |s|
   s.name        = "timesteps"
   s.summary     = "A library for handling discrete time series in constant increments"
   s.description = <<-HERE
-  A library for handling discrete time series in constant increments.
-  The main purpose of this library is to describe the time axis 
-  when dealing with time series of observational data and climate data.
+  A library for time conversion and intercomparison of multiple time series data 
+  in the case of handling time series data of the type that specifies the time using 
+  indexes of time steps since origin time. It handles time units notation like 
+  "hours since 2001-01-01 00:00:00", which is originate from udunits library and 
+  also is used in CF-convension of NetCDF. The main purpose of this library is to 
+  describe the time axis when dealing with time series of observational data and climate data.
   HERE
   s.version     = version
   s.licenses    = ['MIT']
@@ -22,5 +25,5 @@ Gem::Specification::new do |s|
   s.email       = ""
   s.homepage    = 'https://github.com/himotoyoshi/timesteps'
   s.files       = files
-  s.required_ruby_version = ">= 2.5.1"
+  s.required_ruby_version = ">= 2.4.1"
 end

metadata

@@ -1,18 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: timesteps
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.5
 platform: ruby
 authors:
 - Hiroki Motoyoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies: []
-description: "  A library for handling discrete time series in constant increments.\n
-  \ The main purpose of this library is to describe the time axis \n  when dealing
-  with time series of observational data and climate data.\n"
+description: "  A library for time conversion and intercomparison of multiple time
+  series data \n  in the case of handling time series data of the type that specifies
+  the time using \n  indexes of time steps since origin time. It handles time units
+  notation like \n  \"hours since 2001-01-01 00:00:00\", which is originate from udunits
+  library and \n  also is used in CF-convension of NetCDF. The main purpose of this
+  library is to \n  describe the time axis when dealing with time series of observational
+  data and climate data.\n"
 email: ''
 executables: []
 extensions: []
@@ -24,14 +28,17 @@ files:
 - Rakefile
 - lib/timesteps.rb
 - lib/timesteps/calendar.rb
+- lib/timesteps/datetime_360day.rb
+- lib/timesteps/datetime_allleap.rb
+- lib/timesteps/datetime_noleap.rb
 - lib/timesteps/datetimelike.rb
 - lib/timesteps/format.rb
 - lib/timesteps/grads.rb
 - lib/timesteps/parse_timestamp.rb
 - lib/timesteps/timestep.rb
-- lib/timesteps/timestepconverter.rb
-- lib/timesteps/timestepdatetimeext.rb
-- lib/timesteps/timesteppair.rb
+- lib/timesteps/timestep_converter.rb
+- lib/timesteps/timestep_datetime_ext.rb
+- lib/timesteps/timestep_pair.rb
 - spec/allleap_spec.rb
 - spec/fixed360day_spec.rb
 - spec/noleap_spec.rb
@@ -50,7 +57,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.1
+      version: 2.4.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="