timesteps 0.9.3 → 0.9.5

data/lib/timesteps/datetime_allleap.rb

@@ -0,0 +1,34 @@
+class DateTime
+
+  # datetime class represents `allleap` or `366_day` calendar
+  #
+  class AllLeap < DateTimeLike
+
+    extend DateTimeLikeExtension
+  
+    # Number of days per year
+    DPY = 366
+
+    # Numbers of days per months
+    DPM = [0,31,29,31,30,31,30,31,31,30,31,30,31]
+
+    # Astronomical Julian day number of UNIX epoch
+    UNIX_EPOCH_IN_AJD = Rational(4891223,2)
+
+    def valid_date?
+      if @month != 2
+        return Date.valid_date?(@year, @month, @day)
+      else
+        return ( @day >= 1 and @day <= 29 )
+      end
+    end
+
+    private :valid_date?
+
+    def leap?
+      true
+    end
+
+  end
+
+end

data/lib/timesteps/datetime_noleap.rb

@@ -0,0 +1,39 @@
+
+class DateTime
+
+  # datetime class represents `noleap` or `365_day` calendar
+  #
+  class NoLeap < DateTimeLike
+
+    extend DateTimeLikeExtension
+  
+    # Number of days per year
+    DPY = 365
+
+    # Numbers of days per months
+    DPM = [0,31,28,31,30,31,30,31,31,30,31,30,31]
+
+    # Astronomical Julian day number of UNIX epoch
+    UNIX_EPOCH_IN_AJD = Rational(4877859,2) 
+
+    def valid_date?
+      if @month != 2 
+        return Date.valid_date?(@year, @month, @day)
+      else
+        return ( @day >= 1 and @day <= 28 )
+      end
+    end
+
+    private :valid_date?
+
+    def strftime (spec)
+      DateTime.new(@year, @month, @day, @hour, @minute, @second, @offset).strftime(spec)
+    end
+  
+    def leap?
+      false
+    end
+  
+  end
+
+end

data/lib/timesteps/datetimelike.rb

@@ -424,107 +424,3 @@ class DateTimeLike
   
 end
 
-class DateTime
-
-  # datetime class represents `noleap` or `365_day` calendar
-  #
-  class NoLeap < DateTimeLike
-
-    extend DateTimeLikeExtension
-  
-    # Number of days per year
-    DPY = 365
-
-    # Numbers of days per months
-    DPM = [0,31,28,31,30,31,30,31,31,30,31,30,31]
-
-    # Astronomical Julian day number of UNIX epoch
-    UNIX_EPOCH_IN_AJD = Rational(4877859,2) 
-
-    def valid_date?
-      if @month != 2 
-        return Date.valid_date?(@year, @month, @day)
-      else
-        return ( @day >= 1 and @day <= 28 )
-      end
-    end
-
-    private :valid_date?
-
-    def strftime (spec)
-      DateTime.new(@year, @month, @day, @hour, @minute, @second, @offset).strftime(spec)
-    end
-  
-    def leap?
-      false
-    end
-  
-  end
-
-  # datetime class represents `allleap` or `366_day` calendar
-  #
-  class AllLeap < DateTimeLike
-
-    extend DateTimeLikeExtension
-  
-    # Number of days per year
-    DPY = 366
-
-    # Numbers of days per months
-    DPM = [0,31,29,31,30,31,30,31,31,30,31,30,31]
-
-    # Astronomical Julian day number of UNIX epoch
-    UNIX_EPOCH_IN_AJD = Rational(4891223,2)
-
-    def valid_date?
-      if @month != 2
-        return Date.valid_date?(@year, @month, @day)
-      else
-        return ( @day >= 1 and @day <= 29 )
-      end
-    end
-
-    private :valid_date?
-
-    def leap?
-      true
-    end
-
-  end
-
-  # datetime class represents `360_day` calendar
-  #
-  class Fixed360Day < DateTimeLike
-
-    extend DateTimeLikeExtension
-
-    # Number of days per year
-    DPY = 360
-
-    # Numbers of days per months
-    DPM = [0,30,30,30,30,30,30,30,30,30,30,30,30]
-
-    # Astronomical Julian day number of UNIX epoch
-    UNIX_EPOCH_IN_AJD = Rational(4811039,2)
-
-    def valid_date?
-      if @day >= 31
-        return false
-      end
-      if @month != 2
-        return Date.valid_date?(@year, @month, @day)
-      else
-        return ( @day >= 1 and @day <= 30 )
-      end
-    end
-
-    private :valid_date?
-
-    def leap?
-      raise NotImplementedError
-    end
-  
-  end
-
-end
-

data/lib/timesteps/parse_timestamp.rb

@@ -1,48 +1,63 @@
 class DateTime
 
-  module ParseTimeStampExtension
-
-    # Parses the given datetime expression and creates an instance.
-    # `DateTime._parse()` is called internally.
-    #
-    # @param spec [String]
-    # @option bc [Boolean]
-    #
-    # @return [DateTimeFixedDPY]
-
-    def parse_timestamp (spec, start=Date::ITALY, bc: false)
+  # @private
+  SYM_365_day = "365_day".intern
+  # @private
+  SYM_366_day = "366_day".intern
+  # @private
+  SYM_360_day = "360_day".intern
+
+  # Parses the given datetime expression and creates an instance.
+  # `DateTime._parse()` is called internally.
+  #
+  # @param spec [String]
+  # @option bc [Boolean]
+  #
+  # @return [DateTimeFixedDPY]
+
+  def self.parse_timestamp (spec, calendar: "standard", bc: false, format: nil)
+    raise "invalid option 'calendar'" if self != DateTime
+    case calendar.downcase.intern
+    when :standard, :gregorian
+      klass = DateTime
+      start = Date::ITALY
+    when :proleptic_gregorian
+      klass = DateTime
+      start = Date::GREGORIAN
+    when :proleptic_julian, :julian
+      klass = DateTime
+      start = Date::JULIAN
+    when :noleap, SYM_365_day
+      klass = DateTime::NoLeap
+      start = nil
+    when :allleap, SYM_366_day
+      klass = DateTime::AllLeap
+      start = nil
+    when SYM_360_day
+      klass = DateTime::Fixed360Day
+      start = nil
+    end
+    if format
+      hash = DateTime._strptime(spec, format)
+      raise "timestring doesn't match with format" unless hash
+    else
       hash = DateTime._parse(spec)
-      year, month, day, hour, minute, second, sec_fraction, offset = 
-             hash.values_at(:year, :mon, :mday, :hour, :min, :sec, :sec_fraction, :offset)
-      if bc and year < 0
-        year = year + 1
-      end
-      hour   ||= 0
-      minute ||= 0
-      second ||= 0.0
-      sec_fraction ||= 0.0
-      offset ||= 0
-      if hour == 24 && minute == 0 && second == 0.0
-        self.new(year, month, day, 23, minute, second + sec_fraction, offset.quo(86400), start) + 1.quo(24)
-      else
-        self.new(year, month, day, hour, minute, second + sec_fraction, offset.quo(86400), start)
-      end
     end
-
-  end
-
-  extend ParseTimeStampExtension
-
-  class NoLeap < DateTimeLike
-    extend ParseTimeStampExtension
-  end
-
-  class AllLeap < DateTimeLike
-    extend ParseTimeStampExtension
-  end
-
-  class Fixed360Day < DateTimeLike
-    extend ParseTimeStampExtension
+    year, month, day, hour, minute, second, sec_fraction, offset = 
+           hash.values_at(:year, :mon, :mday, :hour, :min, :sec, :sec_fraction, :offset)
+    if bc and year < 0
+      year = year + 1
+    end
+    hour   ||= 0
+    minute ||= 0
+    second ||= 0.0
+    sec_fraction ||= 0.0
+    offset ||= 0
+    if hour == 24 && minute == 0 && second == 0.0
+      klass.new(year, month, day, 23, minute, second + sec_fraction, offset.quo(86400), start) + 1.quo(24)
+    else
+      klass.new(year, month, day, hour, minute, second + sec_fraction, offset.quo(86400), start)
+    end
   end
 
 end

data/lib/timesteps/timestep.rb

@@ -13,12 +13,19 @@ class TimeStep
   #   * "3 days since 2001-01-01 00:00:00 +00:00" 
   #   * "10 years since 1901-01-01 00:00:00 +00:00" 
   # The symbol for time unit symbols should be one of
+  #   * ayears, ayear (astronomical year: 365.242198781 day)
   #   * years, year
   #   * months, month
   #   * days, day, d
-  #   * hours, hr, h
-  #   * minutes, minute, min
-  #   * seconds, second, sec, s
+  #   * hours, hour, hrs, hr, h
+  #   * minutes, minute, mins, min
+  #   * seconds, second, secs, sec, s
+  #   * milliseconds, millisecond, msecs, msec, ms
+  #   * microseconds, microsecond, msecs, msec, ms
+  # If you have already origin time object or general date string, 
+  # you can use `since` option,
+  #     TimeStep.new("3 hours", since: time)
+  #     TimeStep.new("3 hours", since: "2001010121", format: '%Y%m%d%H')
   # The option `calendar` specifies the calendar for datetime calculation,
   #   * standard, gregorian      -> DateTime with Date::ITALY as start
   #   * proleptic_gregorian      -> DateTime with Date::GREGORIAN as start
@@ -32,30 +39,43 @@ class TimeStep
   # some methods (#each etc).
   #
   # @param spec [String]
+  # @option since [DateTime, DateTimeLike, String]
+  # @option format [String]
   # @option calendar [String, TimeStep::Calendar]
   # @option bc [Boolean]
   # @option count [Integer] number of time steps (as hint for some methods)
   # 
-  def initialize (spec, calendar: "standard", bc: false, count: nil)
+  def initialize (spec, since: nil, format: nil, count: nil, calendar: "standard", bc: false)
     case calendar
     when String
       @calendar = Calendar.new(calendar, bc: bc)
     else
       @calendar = calendar
     end
-    intervalspec, timespec = spec.split(/\s+since\s+/)
-    parse_interval(intervalspec)
-    @origin       = @calendar.parse(timespec)
-    @intervalspec = format("%g %s", @numeric, symbol)
-    @timespec     = @origin.strftime("%Y-%m-%d %H:%M:%S.%N %:z")
-    @definition   = format("%s since %s", @intervalspec, @timespec)
+    if since
+      parse_interval(spec)
+      case since
+      when String
+        @origin = @calendar.parse(since, format: format)
+      else
+        raise "mismatch time object with calendar" unless @calendar.valid_datetime_type?(since)
+        @origin = since
+      end
+    else
+      intervalspec, originspec = spec.split(/\s+since\s+/)
+      parse_interval(intervalspec)
+      @origin = @calendar.parse(originspec)
+    end
+    @intervalspec = format("%g %s", @numeric, @symbol)
+    @originspec   = @origin.strftime("%Y-%m-%d %H:%M:%S.%N %:z")
+    @definition   = format("%s since %s", @intervalspec, @originspec)
     @count = count
   end
 
   # @private
   PATTERN_NUMERIC = '[\+\-]?\d*(?:\.\d+)?(?:[eE][\+\-]?\d+)?'
   # @private
-  PATTERN_UNITS   = 'years?|months?|days?|hours?|minutes?|seconds?|d|hr|h|min|sec|s'
+  PATTERN_UNITS   = 'ayears?|years?|months?|days?|hours?|minutes?|seconds?|d|hrs?|hrs?|h|mins?|secs?|s|milliseconds?|msecs?|ms|microseconds?'
 
   def parse_interval (spec)
     if spec.strip =~ /(#{PATTERN_NUMERIC}|)\s*(#{PATTERN_UNITS})/
@@ -70,29 +90,39 @@ class TimeStep
     end
     @interval = @numeric
     case symbol
-    when "years", "year"
+    when /\Aayears?/
+      @symbol = :days
+      @numeric *= 365.242198781.to_r
+      @interval = @numeric * 86400
+    when /\Ayears?/
       unless numeric.denominator == 1
         raise "numeric factor for year should be an integer"
       end
       @symbol = :years
       @interval *= 356.242*86400
-    when "months", "month"
+    when /\Amonths?/
       unless numeric.denominator == 1
         raise "numeric factor for month should be an integer"
       end
       @symbol = :months
       @interval *= 30.4368*86400
-    when "days", "day", "d"
+    when /\A(days?|d)/
       @symbol = :days
       @interval *= 86400
-    when "hours", "hour", "hr", "h"
+    when /\A(hours?|hrs?|h)/
       @symbol = :hours
       @interval *= 3600
-    when "minutes", "minute", "min"
+    when /\A(minutes?|mins?)/
       @symbol = :minutes
       @interval *= 60
-    when "seconds", "second", "sec", "s"
+    when /\A(seconds?|secs?|s)/
       @symbol = :seconds
+    when /\A(milliseconds?|msecs?|ms)/
+      @symbol = :seconds
+      @interval *= 1.quo(1000)
+    when /\Amicroseconds?/
+      @symbol = :seconds
+      @interval *= 1.quo(1000000)
     end
   end
   
@@ -100,7 +130,7 @@ class TimeStep
 
   attr_reader :definition, 
               :intervalspec, 
-              :timespec, 
+              :originspec, 
               :numeric, 
               :symbol, 
               :interval, 
@@ -131,6 +161,14 @@ class TimeStep
     end
     return limit
   end
+  
+  def set_limit (time, format: nil)
+    case time
+    when String
+      time = @calendar.parse(time, format: format)
+    end
+    self.limit = time
+  end
 
   def valid? (*indices)
     if @count
@@ -153,11 +191,11 @@ class TimeStep
     end
   end
 
-  def info
+  def debug_info
     return {
       "definition"   => @definition.clone,
       "intervalspec" => @intervalspec.clone,
-      "timespec"     => @timespec.clone,
+      "originspec"   => @originspec.clone,
       "calendar"     => @calendar.name,
       "numeric"      => @numeric,
       "symbol"       => @symbol.to_s,
@@ -168,6 +206,10 @@ class TimeStep
     }
   end
 
+  private :debug_info
+
+  # Returns the value as a string for inspection.
+  #
   def inspect
     "#<TimeStep definition='#{definition}' calendar='#{calendar.name}'>"
   end
@@ -188,6 +230,8 @@ class TimeStep
     return ( 86400 * index.to_r ).quo(@interval)
   end
 
+  private :user_to_days, :days_to_user
+
   # Returns the time represented by the given amount as DateTime object
   #
   # @param indices [Numeric,Array<Numeric>]
@@ -220,58 +264,110 @@ class TimeStep
     end
   end
     
+  # Calculate the time difference in days from origin at the index.
+  #
+  # @param indices [Array]
+  # @return [DateTime, Array<DateTime>]
+  def days_at (*indices)
+    if indices.size == 1
+      index = indices.first
+      case @symbol
+      when :years
+        unless index.denominator == 1
+          raise "index for years should be an integer"
+        end
+        days = @origin.next_year(@numeric*index) - @origin
+      when :months
+        unless index.denominator == 1
+          raise "index for years should be an integer"
+        end
+        days = @origin.next_month(@numeric*index) - @origin
+      else
+        days = user_to_days(index)
+      end
+      days = days.to_i if days.denominator == 1
+      return days
+    else
+      return indices.map{ |index| days_at(index) }            
+    end
+  end
+  
   # Returns the index for the given time in the unit represented by the object
   #
   # @param times [DateTime] time object
   #
   # @return [Numeric]
-  def index_at (*times)
+  def index_at (*times, format: nil)
     if times.size == 1
       time = times.first
-      time = @calendar.parse(time) if time.is_a?(String)
+      time = @calendar.parse(time, format: format) if time.is_a?(String)
       case @symbol
       when :years
-        return time.difference_in_years(@origin).quo(@numeric.to_i)
+        index = time.difference_in_years(@origin).quo(@numeric.to_i)
       when :months
-        return time.difference_in_months(@origin).quo(@numeric.to_i)
+        index = time.difference_in_months(@origin).quo(@numeric.to_i)
       else
         jday  = @calendar.date2jday(time.year, time.month, time.day)
-      	fday  = time.fraction
+      	fday  = time.fraction 
       	udays = days_to_user(jday - @origin.jd)
-      	utime = days_to_user(fday - @origin.fraction)
-      	return udays + utime
+      	utime = days_to_user(time.fraction - time.offset - (@origin.fraction - @origin.offset))
+      	index = udays + utime
       end
+      index = index.to_i if index.denominator == 1
+      return index
     else
-      return times.map{|time| index_at(time) }      
+      return times.map{|time| index_at(time, format: format) }      
     end
   end
   
-  # Calculate the time difference in days from origin at the index.
-  #
-  # @param indices [Array]
-  # @return [DateTime, Array<DateTime>]
-  def days_at (*indices)
-    if indices.size == 1
-      index = indices.first
-      case @symbol
-      when :years
-        unless index.denominator == 1
-          raise "index for years should be an integer"
+  def range (ge: nil, gt: nil, lt: nil, le: nil)
+    raise "lower limit is not given" if ge.nil? and gt.nil?
+    raise "upper limit is not given" if lt.nil? and le.nil?
+    raise "lower limits are duplicated" if ge and gt
+    raise "upper limits are duplicated" if lt and le
+    if ge
+      case ge
+      when Numeric
+        min = ge.floor
+      else
+        min = prev_index_of(ge)
+      end
+    end
+    if gt
+      case gt
+      when Numeric
+        if lt.to_r.denominator == 1
+          min = gt.to_i + 1
+        else
+          min = gt.ceil
         end
-        return @origin.next_year(@numeric*index) - @origin
-      when :months
-        unless index.denominator == 1
-          raise "index for years should be an integer"
+      else
+        min = next_index_of(gt)
+      end
+    end
+    if lt
+      case lt
+      when Numeric
+        if lt.to_r.denominator == 1
+          max = lt.to_i - 1
+        else
+          max = lt.floor
         end
-        return @origin.next_month(@numeric*index) - @origin
       else
-        return user_to_days(index)
+        max = prev_index_of(lt)
       end
-    else
-      return indices.map{ |index| days_at(index) }            
     end
+    if le
+      case le
+      when Numeric
+        max = le.ceil
+      else
+        max = next_index_of(le)
+      end
+    end
+    return (min..max).to_a
   end
-  
+
   # Returns TimeStep object which has origin time determined 
   # by the given `index`.
   #
@@ -280,7 +376,12 @@ class TimeStep
   # @return [TimeStep]
   def shift_origin (index)
     time = time_at(index)
-    return TimeStep.new(@intervalspec + " since " + time.strftime("%Y-%m-%d %H:%M:%S.%N %:z"), calendar: @calendar)
+    return TimeStep.new(@intervalspec, since: time, calendar: @calendar)
+  end
+
+  def shift_origin_with_days (days)
+    time = @origin + days
+    return TimeStep.new(@intervalspec, since: time, calendar: @calendar)
   end
 
   # Returns TimeStep object which has origin time specified 
@@ -326,7 +427,7 @@ class TimeStep
   #
   #
   def in (unit)
-    return TimeStep::Pair.new(self, format("%s since %s", unit, @timespec), calendar: @calendar)
+    return TimeStep::Pair.new(self, format("%s since %s", unit, @originspec), calendar: @calendar)
   end
   
   def next_index_of (time)
@@ -336,7 +437,7 @@ class TimeStep
     end
     index = index_at(time).to_r
     if index.denominator == 1
-      return index + 1
+      return index.to_i + 1
     else
       return index.ceil
     end
@@ -354,8 +455,8 @@ class TimeStep
     return time_at(prev_index_of(time))  
   end
 
-  def parse (time)
-    return @calendar.parse(time)
+  def parse (time, format: nil)
+    return @calendar.parse(time, format: format)
   end
 
 end