timesteps 0.9.5 → 1.0.0

data/lib/timesteps/{calendar.rb → timestep_calendar.rb}

@@ -1,4 +1,6 @@
 
+autoload :TZInfo, "tzinfo"
+
 class TimeStep
 
   class Calendar
@@ -21,9 +23,13 @@ class TimeStep
       SYM_360_day => DateTime::Fixed360Day,
     }
 
-    def initialize (calendar = "standard", bc: false)
+    # Construct the object
+    #
+    def initialize (calendar = "standard", tz: nil)
+      unless calendar.is_a?(String)
+        raise ArgumentError, "argument calendar '#{calendar}' should be string" 
+      end
       @name = calendar
-      @bc   = bc
       case @name.downcase.intern
       when :standard, :gregorian
         @calendar = :standard
@@ -38,22 +44,30 @@ class TimeStep
       when SYM_360_day
         @calendar = SYM_360_day
       end
+      if tz 
+        raise "'standard' calendar needed for tz" unless @calendar == :standard
+        case tz
+        when nil
+        when String
+          @tz = TZInfo::Timezone.get(tz)
+        when TZInfo::Timezone
+          @tz = tz
+        else
+          raise "invalid tz specification"
+        end
+      end
     end
     
-    attr_reader :name, :calendar
-    
+    attr_reader :name, :calendar, :tz
+      
     def inspect 
-      "#<TimeStep::Calendar calendar='#{@calendar.to_s}' bc='#{@bc}'>"
+      "#<TimeStep::Calendar calendar='#{@calendar.to_s}'>"
     end
     
     def == (other)
-      return @calendar == other.calendar && bc? == other.bc?
+      return @calendar == other.calendar 
     end
-    
-    def bc?
-      return @bc ? true : false
-    end
-    
+        
     def valid_datetime_type? (time)
       return false unless time.is_a?(DateTimeType[@calendar])
       case @calendar
@@ -72,10 +86,31 @@ class TimeStep
     # and creates an date time instance.
     # 
     # @return [DateTime object]
-    def parse (timespec, format: nil)
-      return DateTime.parse_timestamp(timespec, calendar: @calendar.to_s, bc: @bc, format: format)
+    def parse (timespec, format: nil, offset: nil)
+      return DateTime.parse_timestamp(timespec, calendar: @calendar.to_s, format: format, tz: @tz, offset: offset)
     end
-    
+
+    def time_new (year, month, day, hour=0, min=0, sec=0, offset=0)
+      case @calendar
+      when :standard
+        time = DateTime.new(year, month, day, hour, min, sec, offset, Date::ITALY)
+      when :proleptic_gregorian
+        time = DateTime.new(year, month, day, hour, min, sec, offset, Date::GREGORIAN)
+      when :proleptic_julian
+        time = DateTime.new(year, month, day, hour, min, sec, offset, Date::JULIAN)
+      when :noleap
+        time = DateTime::NoLeap.new(year, month, day, hour, min, sec, offset)
+      when :allleap
+        time = DateTime::AllLeap.new(year, month, day, hour, min, sec, offset)
+      when SYM_360_day
+        time = DateTime::Fixed360Day.new(year, month, day, hour, min, sec, offset)
+      end
+      if @tz
+        time = @tz.to_local(time)
+      end
+      return time
+    end
+  
     def jday2date (jday)
       case @calendar
       when :standard
@@ -91,27 +126,17 @@ class TimeStep
       when SYM_360_day
         time = DateTime::Fixed360Day.jd(jday, 0, 0, 0, 0)
       end
+      if @tz
+        time = @tz.to_local(time)
+      end
       return time
     end
 
     def date2jday (year, month, day)
-      case @calendar
-      when :standard
-        time = DateTime.new(year, month, day, 0, 0, 0, 0, Date::ITALY)
-      when :proleptic_gregorian
-        time = DateTime.new(year, month, day, 0, 0, 0, 0, Date::GREGORIAN)
-      when :proleptic_julian
-        time = DateTime.new(year, month, day, 0, 0, 0, 0, Date::JULIAN)
-      when :noleap
-        time = DateTime::NoLeap.new(year, month, day, 0, 0, 0, 0)
-      when :allleap
-        time = DateTime::AllLeap.new(year, month, day, 0, 0, 0, 0)
-      when SYM_360_day
-        time = DateTime::Fixed360Day.new(year, month, day, 0, 0, 0, 0)
-      end
-      return time.jd
+      return time_new(year, month, day).jd
     end
     
   end
 
 end
+

data/lib/timesteps/timestep_converter.rb

@@ -2,16 +2,15 @@ require "timesteps"
 
 class TimeStep::Converter
   
-  def initialize (reference, name: "reference", calendar: "standard", bc: false)
+  def initialize (reference, name: "reference", calendar: "standard")
     @calendar = calendar
-    @bc = bc
     case reference
     when String
-      @reference = TimeStep.new(reference, calendar: calendar, bc: bc)
+      @reference = TimeStep.new(reference, calendar: calendar)
     when TimeStep
       @reference = reference
     else
-      raise "first argument should be TimeStep or string"
+      raise ArgumentError, "reference argument '#{reference}' should be time-step or string"
     end
     @pair = {}
     @target = {}
@@ -21,9 +20,9 @@ class TimeStep::Converter
   # Append or reset new target time step for the given name.
   #
   def add_timestep (spec, name:)
-    @pair[name] = TimeStep::Pair.new(@reference, spec, calendar: @calendar, bc: @bc)
+    @pair[name] = TimeStep::Pair.new(@reference, spec, calendar: @calendar)
     @target[name] = @pair[name].to
-    return @target[name]
+    return @pair[name]
   end
   
   # Append or reset new target time step for the given name.
@@ -35,14 +34,14 @@ class TimeStep::Converter
   # Return target time step of the given name.
   #
   def [] (name)
-    return @target[name]
+    return @pair[name]
   end
   
   # Relete target of the given name.
   #
   def delete (name)
-    @pair.delete(name)
     @target.delete(name)
+    @pair.delete(name)
   end
 
   # Returns the time represented by the given index as DateTime object
@@ -56,11 +55,18 @@ class TimeStep::Converter
 
   # Converts index refering `from` timestep to index refering `to`timestep.
   #
-  def forward (*indices, with_time: false)
+  def forward (*indices, with_time: nil)
     if with_time
-      hash = {
-        "time" => time_at(*indices)        
-      }
+      case with_time
+      when String
+        hash = {
+          "time" => time_at(*indices).map{|t| t.strftime(with_time) }
+        }
+      else
+        hash = {
+          "time" => time_at(*indices)        
+        }
+      end
     else
       hash = {}
     end
@@ -70,8 +76,8 @@ class TimeStep::Converter
     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)
+  def range (other, with_time: false)
+    indices = @reference.range(other)
     return forward(*indices, with_time: with_time)    
   end
 
@@ -80,14 +86,5 @@ class TimeStep::Converter
     return forward(*indices, with_time: with_time)
   end
 
-  def valid? (*indices)
-    hash = {}
-    @pair.each do |name, conv|
-      hash[name] = conv.to.valid?(*conv.forward(*indices))
-    end
-    return hash
-  end
-
-
 end
 

data/lib/timesteps/timestep_datetime_ext.rb

@@ -46,28 +46,18 @@ class TimeStep
       #
       # @return [Integer]
       def difference_in_years (other)
-        extra = 0
-        if self.year > other.year && self.compare_md(other) < 0
-          extra = -1
-        end
-        if self.year < other.year && self.compare_md(other) > 0
-          extra = 1
-        end
-        return self.year - other.year + extra
+        my    = self
+        other = other.new_offset(self.offset)
+        return my.year - other.year + my.compare_md(other).quo(2)
       end
       
       # Calculate difference between the object and other object in months.
       #
       # @return [Integer]
       def difference_in_months (other)
-        extra = 0
-        if self.month > other.month && self.compare_d(other) < 0
-          extra = -1
-        end
-        if self.month < other.month && self.compare_d(other) > 0
-          extra = 1
-        end
-        return 12*(self.year - other.year) + self.month - other.month + extra  
+        my    = self
+        other = other.new_offset(self.offset)
+        return 12*(my.year - other.year) + my.month - other.month + my.compare_d(other).quo(2)  
       end
       
     end

data/lib/timesteps/timestep_pair.rb

@@ -8,34 +8,32 @@ class TimeStep::Pair
   # The `from` and `to` arguments are either TimeStep or a string representing
   # the time step definition ("<INTERVAL> since <TIME>").
   # If a string representing the time step definition is given as an argument
-  # `from` or `to`, the options `calendar` and `bc` are used to construct
+  # `from` or `to`, the options `calendar` are used to construct
   # TimeStep. The option `calendar` specifies the calendar for datetime
-  # calculation. The option `bc` is a flag whether AD/BC or EC when parsing
-  # timestamp for negative year.
+  # calculation. 
   #
   # @param from [TimeStep, String]
   # @param to [TimeStep, String]
   # @option calendar [String, TimeStep::Calendar]
-  # @option bc [Boolean]
   # 
-  def initialize (from, to, calendar: "standard", bc: false)
+  def initialize (from, to, calendar: "standard")
 
     case from
     when String
-      @from = TimeStep.new(from, calendar: calendar, bc: bc)
+      @from = TimeStep.new(from, calendar: calendar)
     when TimeStep
       @from = from
     else
-      raise "first argument should be TimeStep or string"
+      raise ArgumentError, "from argument '#{from}' should be a time-step or a string"
     end
             
     case to
     when String
-      @to = TimeStep.new(to, calendar: calendar, bc: bc)
+      @to = TimeStep.new(to, calendar: calendar)
     when TimeStep
       @to = to
     else
-      raise "second argument should be TimeStep or string"
+      raise ArgumentError, "to argument '#{to}' should be a time-step or a string"
     end
 
     @from_origin = @from.origin
@@ -66,13 +64,17 @@ class TimeStep::Pair
     "#<TimeStep::Pair from='#{from.inspect}' to='#{to.inspect}'>"
   end
   
+  def invert
+    return TimeStep::Pair.new(@to, @from)
+  end
+  
   # Returns true if other has same contents of `from` and `to` as self has.
   #
   # @return [Boolean]
   def == (other)
     return @from == other.from && @to == other.to 
   end
-  
+    
   # Returns the time represented by the given index as DateTime object
   #
   # @param indices [Numeric,Array<Numeric>]
@@ -85,10 +87,16 @@ class TimeStep::Pair
   # Converts index refering `from` timestep to index refering `to`timestep.
   #
   def forward (*indices, &block)
-    if indices.size == 1    
+    if indices.empty? || indices.size == 1 && indices.first.is_a?(Range)
+      return forward(*@from.range(*indices), &block)
+    elsif indices.size == 1 
       index = indices.first.to_r
       if @numeric_conversion
-        value = (index*@from_interval + @difference).quo(@to_interval)
+        if @to_interval == 0
+          value = 0
+        else
+          value = (index*@from_interval + @difference).quo(@to_interval)
+        end
       else
         case @from_symbol
         when :years, :months
@@ -97,12 +105,14 @@ class TimeStep::Pair
           target = @from_origin + index*(@from_interval.quo(86400))
         end
         case @to_symbol
-        when :years        
-          value = target.difference_in_years(@to_origin).quo(@to.numeric)
+        when :years
+          diff = target.difference_in_years(@to_origin)
+          value = diff.quo(@to.numeric)
         when :months
-          value = target.difference_in_months(@to_origin).quo(@to.numeric)
+          diff = target.difference_in_months(@to_origin)
+          value = diff.quo(@to.numeric)
         else
-          value = (target.ajd - @to_origin.ajd).quo(@to_interval)
+          value = (target.ajd - @to_origin.ajd).quo(@to_interval)*86400
         end
       end
       value = value.to_i if value.denominator == 1
@@ -126,18 +136,19 @@ class TimeStep::Pair
     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    
+    if indices.empty? || indices.size == 1 && indices.first.is_a?(Range)
+      return inverse(*@to.range(*indices), &block)
+    elsif indices.size == 1    
       index = indices.first.to_r
       if @numeric_conversion
-        value = (index*@to_interval - @difference).quo(@from_interval)
+        if @from_interval == 0
+          value = 0
+        else
+          value = (index*@to_interval - @difference).quo(@from_interval)
+        end
       else
         case @to_symbol
         when :years, :months
@@ -147,11 +158,13 @@ class TimeStep::Pair
         end
         case @from_symbol
         when :years        
-          value = target.difference_in_years(@from_origin).quo(@from.numeric)
+          diff = target.difference_in_years(@from_origin)
+          value = diff.quo(@from.numeric)
         when :months
-          value = target.difference_in_months(@from_origin).quo(@from.numeric)
+          diff = target.difference_in_months(@from_origin)
+          value = diff.quo(@from.numeric)
         else
-          value = (target.ajd - @from_origin.ajd).quo(@from_interval)
+          value = (target.ajd - @from_origin.ajd).quo(@from_interval)*86400
         end
       end
       value = value.to_i if value.denominator == 1

data/lib/timesteps/timestep_query.rb

@@ -0,0 +1,57 @@
+require "timesteps"
+
+class TimeStep::Query
+  
+  def initialize (timestep, format: nil)
+    @timestep = timestep
+    @format   = format
+  end
+
+  def __format__ (time)
+    return ( @format.nil? ) ? time : time.strftime(@format)
+  end
+  
+  private :__format__
+
+  def just_time? (time)
+    return @timestep.index_at(time).denominator == 1
+  end
+
+  def just_before_time_of (time)
+    idx = @timestep.index_at(time)
+    if idx.denominator == 1
+      time0 = time
+    else
+      time0 = @timestep.time_at(idx.floor)
+    end
+    return __format__(time0)
+  end
+
+  def just_after_time_of (time)
+    idx = @timestep.index_at(time)
+    if idx.denominator == 1
+      time0 = time
+    else
+      time0 = @timestep.time_at(idx.ceil)
+    end
+    return __format__(time0)
+  end
+
+  def prev_time_of (time)
+    return __format__(@timestep.prev_time_of(time))
+  end
+
+  def next_time_of (time)
+    return __format__(@timestep.next_time_of(time))
+  end
+  
+end
+
+class TimeStep
+  
+  def query (format = nil)
+    return TimeStep::Query.new(self, format: format)
+  end
+  
+end
+

data/lib/timesteps/timestep_range.rb

@@ -0,0 +1,153 @@
+require "forwardable"
+
+class TimeStep::Range 
+
+  extend Forwardable
+
+  def initialize (timestep, start = nil, last = nil, count: nil, ends: "[]")
+
+    raise "'ends' option should be one of '[]', '()', '(]', '[)" unless ends =~ /\A[\[\(][\]\)]\z/
+    include_start = ends[0] == "["
+    include_last  = ends[1] == "]"
+
+    if last
+      case start
+      when Numeric
+      when Time
+        start = timestep.index_at(start.to_datetime)
+      when DateTime, DateTimeLike, String
+        start = timestep.index_at(start)
+      else
+        raise "unknown type of argument"
+      end
+      case last
+      when Numeric
+      when Time
+        last = timestep.index_at(last.to_datetime)
+      when DateTime, DateTimeLike, String
+        last   = timestep.index_at(last)
+      else
+        raise "unknown argument"
+      end
+    else
+      case start
+      when Integer
+        count = start
+        start = 0
+        last  = count - 1
+      when String
+        raise "count should be set" unless count.is_a?(Integer)
+        start = timestep.index_at(start)
+        last  = start + count - 1
+      when TimePeriod
+        period = range
+        return initialize(timestep, period.origin..period.last, ends: period.ends)
+      else
+        raise "unknown argument"
+      end
+    end
+
+    if include_start
+      @start = start.ceil
+    else
+      @start = start.floor + 1
+    end
+    
+    if include_last
+      @last = last.floor
+    else
+      @last = last.ceil - 1
+    end
+
+    @timestep = timestep.new_origin(timestep.time_at(@start))
+    @count = @last - @start + 1
+    
+    @start_time = @timestep.time_at(@start)
+    @last_time  = @timestep.time_at(@last)
+  end
+
+  attr_reader :timestep, :count, :start, :last, :start_time, :last_time
+
+  def_delegators :@timestep, :numeric, :symbol, :interval, 
+                             :origin, :offset, :calendar, :definition,
+                             :parse, :time_at, :index_at, :duration_at, :[]
+                             
+
+  # FIXME
+  def valid? (*indices)
+    if @count
+      if indices.size == 1
+        index = indices.first
+        if index >= 0 and index < @count 
+          return true
+        else
+          return false
+        end
+      else
+        return indices.map{|index| valid?(index) }
+      end
+    else
+      if indices.size == 1
+        return true
+      else
+        return indices.map{|index| true }
+      end
+    end
+  end
+
+  # Returns TimeStep object which has origin time determined 
+  # by the given `index`.
+  #
+  # @param index [Numeric]
+  #
+  # @return [TimeStep]
+  def shift_origin (index)
+    case with
+    when :index, "index"
+      timestep = @timestep.shift_origin(index)
+      return TimeStep::Range.new(timestep, count: @count)
+    when :duration, "duration", :days, "days"
+      timestep = @timestep.shift_origin(index, with: "duration")
+      return TimeStep::Range.new(timestep, count: @count)
+    end
+  end
+
+  # Returns TimeStep object which has origin time specified 
+  # by the given `time`.
+  #
+  # @param time [DateTime]
+  #
+  # @return [TimeStep]
+  def new_origin (time)
+    timestep = @timestep.new_origin(time)
+    return TimeStep::Range.new(timestep, count: @count)
+  end
+
+  include Enumerable
+  
+  def each_time (&block)
+    if block
+      @start.upto(@last) do |k|
+        block.call(@timestep.time_at(k))
+      end
+    else
+      return Enumerator.new {|y|
+        @start.upto(@last) do |k|
+          y << @timestep.time_at(k)
+        end
+      }
+    end
+  end
+
+  alias each each_time
+  
+  def each_index (&block)
+    (@start..@last).each(&block)
+  end
+
+  def map_index (&block)
+    (@start..@last).map(&block)
+  end
+
+end
+

data/lib/timesteps.rb

@@ -1,13 +1,18 @@
 
 require "date"
+require "timesteps/time"
 require "timesteps/datetimelike"
+require "timesteps/datetimelike_format"
 require "timesteps/datetime_noleap"
 require "timesteps/datetime_allleap"
 require "timesteps/datetime_360day"
-require "timesteps/parse_timestamp"
-require "timesteps/format"
+require "timesteps/datetime_parse_timestamp"
 require "timesteps/timestep_datetime_ext"
-require "timesteps/calendar"
+require "timesteps/timestep_calendar"
 require "timesteps/timestep"
 require "timesteps/timestep_pair"
 require "timesteps/timestep_converter"
+require "timesteps/timeperiod"
+require "timesteps/timestep_range"
+require "timesteps/datetime_timestep"
+require "timesteps/timestep_query"

data/spec/allleap_spec.rb

@@ -123,17 +123,6 @@ describe "AllLeap.parse_timestamp" do
     
   end
 
-  example "with bc option" do
-    
-    d1 = DateTime::AllLeap.new(0, 1, 1, 0, 0, 0, 0)
-    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 }
-    
-  end
-
   example '2000-12-31 24:00:00' do
 
     d1 = DateTime::AllLeap.new(2001, 1, 1, 0, 0, 0, 0)
@@ -301,8 +290,8 @@ describe "AllLeap#difference_in_years" do
     d3 = DateTime::AllLeap.new(2002, 3, 5, 9, 35, 11.5, 9.quo(24))
     d4 = DateTime::AllLeap.new(2002, 3, 5, 9, 35, 12.5, 9.quo(24))
     
-    is_asserted_by { d2.difference_in_years(d1) == 0 }
-    is_asserted_by { d3.difference_in_years(d1) == 0 }
+    is_asserted_by { d2.difference_in_years(d1) == 1.quo(2) }
+    is_asserted_by { d3.difference_in_years(d1) == 1.quo(2) }
     is_asserted_by { d4.difference_in_years(d1) == 1 }
     
   end
@@ -319,8 +308,8 @@ describe "AllLeap#difference_in_months" do
     d4 = DateTime::AllLeap.new(2001, 4, 5, 9, 35, 12.5, 9.quo(24))
     d5 = DateTime::AllLeap.new(2002, 3, 5, 9, 35, 12.5, 9.quo(24))
     
-    is_asserted_by { d2.difference_in_months(d1) == 0 }
-    is_asserted_by { d3.difference_in_months(d1) == 0 }
+    is_asserted_by { d2.difference_in_months(d1) == 1.quo(2) }
+    is_asserted_by { d3.difference_in_months(d1) == 1.quo(2) }
     is_asserted_by { d4.difference_in_months(d1) == 1 }
     is_asserted_by { d5.difference_in_months(d1) == 12 }