timesteps 0.9.7 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bac0d24992c8693974390e294212ee592b8b1974486d8ffe95704550810ade9e
-  data.tar.gz: e1da906f7b7e7adc85e597dfc14dc8229ff3625f2be3652c599f56a476a10e95
+  metadata.gz: 6700d400608b814af5cd0fcc0136f8ef717a6e26939a1d91cf37abf65a7afa94
+  data.tar.gz: 3c34321b6468f3136732a3b6e16137486f6fcb1710049e07d208a663048b0730
 SHA512:
-  metadata.gz: e2e1b74b4052d4c16d2c4538c98f7328591a317494c6937a7a48d09c751037693d4235cd4a6cf73fb24f993f8a6d35a24cbcef0f4862b6b7e31ec965e552f725
-  data.tar.gz: c7beea6d38d54bfda596c8f5ea4b77f8ebc68660bc3cf1d7fe7c2305a6a63a7966a925caa8b579538010e14cee370934f7c68a115276a9c64b67d04fa0a69dc5
+  metadata.gz: dc989ec56ef1812a6d8afc2e4e6d6b70b6b67d6490a88a5db5a38eb3942a80ba28fb61c968f29242dc562b039524943ec6fadd43adfd57c70a1b2b80880c378b
+  data.tar.gz: bcfcf00eeb435e11d9a4fbc7366050f048acb1478c46cbdb9bc40175dabf32b80ba0777f18d4ec7582deaa0077ea5ee7558ef3dd3847c5ff44a44da334cb78cd

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/NEWS.md

@@ -0,0 +1,14 @@
+NEWS
+====
+
+0.9.9 -> 1.0.2
+--------------
+
+* [Add] DateTime#next, DateTime#prev
+* [Add] TimeStep#right_time?
+
+0.9.8 -> 0.9.9
+--------------
+
+* [Mod] TimeStep::Range.new was modified to accept `start` and `last` argument of mixed type (Integer, DateTime, DateTimeLike, String).
+

data/Note.ja.md

@@ -4,8 +4,6 @@ masterブランチ    -> gem リリース最新版
 developブランチ   -> 開発統合版
 topicブランチ     -> Feature開発版
 
-
-
 "XX since YYY" と since: time を同時に指定下場合は、前者が採用される (sinceオプションは無視される)。
 
 ### 時間の単位 (udunits)

data/README.md

@@ -1,14 +1,18 @@
-timesteps
+TimeSteps
 ================
 
 A library for handling discrete time series in constant increments.
-The primary purpose of this library is to describe the time axis 
+The primary purpose is to describe the time axis 
 when dealing with time series of observational data and climate data.
 
+This library relies heavily on the DateTime class. However, 
+the DateTime class has been deprecated, 
+so please keep that in mind when using this library.
+
 Features
 --------
 
-* TimeStep holds an origin time and an unit time interval.
+* TimeStep holds an origin time and a unit time interval.
 * Parsing a time step expression like "hours since 2001-01-01 00:00:00" (originate from udunits library)
 * Obtaining time value for the index value (0 for the origin time)
 * Obtaining index value for the time value
@@ -195,6 +199,13 @@ ts = TimeStep.new("3 hours since 2001-01-01 09:00:00", calendar: "noleap")
 
 # specify origin time with DateTime object
 ts = TimeStep.new("3 hours", since: DateTime.parse("2001-01-01 09:00:00"))
+
+# hourly increments whose origin is the most recent convenient time to the current time
+ts = TimeStep.new("1 hour").new_origin(DateTime.now, truncate: true)
+
+# hourly increments whose origin is the most recent convenient time to the current time
+# with +0900 time offset
+ts = TimeStep.new("1 hour", offset: "+0900").new_origin(DateTime.now, truncate: true)
 ```
 
 ### Attributes of TimeStep object
@@ -296,5 +307,6 @@ conv.forward(0, 56, 81, with_time: true)
    #  "ts2"=>[-48, 8, 33],
    #  "ts3"=>[-72, -16, 9]}
 
+
 ```
 

data/lib/timesteps/datetime_timestep.rb

@@ -25,6 +25,34 @@ class DateTime
     return TimePeriod.new(interval_spec, since: self, calendar: calendar, ends: ends, tz: tz)
   end
 
+  def next (*args)
+    case args.size
+    when 1
+      num = 1
+      unit = args[0]
+    when 2
+      num = args[0]
+      unit = args[1]
+    else
+      raise "invalid number of argumets"
+    end
+    return TimeStep.new(unit, since: self).time_at(num)
+  end
+
+  def prev (*args)
+    case args.size
+    when 1
+      num = 1
+      unit = args[0]
+    when 2
+      num = args[0]
+      unit = args[1]
+    else
+      raise "invalid number of argumets"
+    end
+    return TimeStep.new(unit, since: self).time_at(-num)
+  end
+
 end
 
 class DateTime::NoLeap

data/lib/timesteps/time.rb

@@ -0,0 +1,14 @@
+require 'date'
+
+class Time
+  def to_datetime
+    # Convert seconds + microseconds into a fractional number of seconds
+    seconds = sec + Rational(usec, 10**6)
+
+    # Convert a UTC offset measured in minutes to one measured in a
+    # fraction of a day.
+    offset = Rational(utc_offset, 60 * 60 * 24)
+
+    DateTime.new(year, month, day, hour, min, seconds, offset)
+  end
+end

data/lib/timesteps/timestep.rb

@@ -451,6 +451,7 @@ class TimeStep
   def index_at (*times, format: nil)
     if times.size == 1
       time = times.first
+      time = time.to_datetime if time.is_a?(Time)
       time = @calendar.parse(time, format: format, offset: @origin.offset) if time.is_a?(String)
       case @symbol
       when :years
@@ -515,8 +516,9 @@ class TimeStep
   # @param time [DateTime, String]
   #
   # @return [TimeStep]
-  def new_origin (time)
+  def new_origin (time, truncate: false)
     time = @calendar.parse(time, offset: @origin.offset) if time.is_a?(String)
+    time = self.truncate(time) if truncate
     if @wday
       origin = time - time.wday + WDAY[@wday]
       origin -= 7 unless time >= origin
@@ -626,7 +628,7 @@ class TimeStep
   # @return [TimeStep::Pair]
   def in (unit)
     other = TimeStep.new(unit, since: @origin, calendar: @calendar)
-   return Pair.new(self, other)
+    return Pair.new(self, other)
   end
   
   # Creates new timestep pair object which refers `other` from `self`
@@ -695,5 +697,19 @@ class TimeStep
     return TimeStep::Range.new(self, start, last, count: count, ends: ends)
   end
     
+  # Check whether the given time is right or not for timestep.
+  #
+  # @example
+  #   ts = TimeStep.new("1 hour")
+  #   ts.right_time?(ts.parse("2001-01-01 01:00:00"))
+  #   # => true
+  #   ts.right_time?(ts.parse("2001-01-01 01:30:00"))
+  #   # => false
+  #
+  # @return [TimeStep::Range]
+  def right_time? (time)
+    return index_at(time).integer?
+  end
+    
 end
 

data/lib/timesteps/timestep_query.rb

@@ -4,11 +4,11 @@ class TimeStep::Query
   
   def initialize (timestep, format: nil)
     @timestep = timestep
-    @format   = foramt
+    @format   = format
   end
 
   def __format__ (time)
-    return ( @template.nil? ) ? time : time.strftime(@template)
+    return ( @format.nil? ) ? time : time.strftime(@format)
   end
   
   private :__format__
@@ -19,7 +19,7 @@ class TimeStep::Query
 
   def just_before_time_of (time)
     idx = @timestep.index_at(time)
-    if idx.denomiator == 1
+    if idx.denominator == 1
       time0 = time
     else
       time0 = @timestep.time_at(idx.floor)
@@ -29,7 +29,7 @@ class TimeStep::Query
 
   def just_after_time_of (time)
     idx = @timestep.index_at(time)
-    if idx.denomiator == 1
+    if idx.denominator == 1
       time0 = time
     else
       time0 = @timestep.time_at(idx.ceil)
@@ -47,3 +47,11 @@ class TimeStep::Query
   
 end
 
+class TimeStep
+  
+  def query (format = nil)
+    return TimeStep::Query.new(self, format: format)
+  end
+  
+end
+

data/lib/timesteps/timestep_range.rb

@@ -13,16 +13,19 @@ class TimeStep::Range
     if last
       case start
       when Numeric
-        raise "start and last types doesn't match" unless last.is_a?(Numeric)
+      when Time
+        start = timestep.index_at(start.to_datetime)
       when DateTime, DateTimeLike, String
-        if last.is_a?(Integer)
-          start = timestep.index_at(start)
-          last  = start + last - 1
-        else
-          raise "start and last types doesn't match" unless last.is_a?(start.class)
-          start  = timestep.index_at(start)
-          last   = timestep.index_at(last)
-        end
+        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
@@ -45,22 +48,24 @@ class TimeStep::Range
     end
 
     if include_start
-      @start = start.ceil
+      start = start.ceil
     else
-      @start = start.floor + 1
+      start = start.floor + 1
     end
     
     if include_last
-      @last = last.floor
+      last = last.floor
     else
-      @last = last.ceil - 1
+      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)
+    @timestep   = timestep.new_origin(timestep.time_at(start))  
+    @start_time = timestep.time_at(start)
+    @last_time  = timestep.time_at(last)
+  
+    @start      = @timestep.index_at(@start_time)
+    @last       = @timestep.index_at(@last_time)
+    @count      = @last - @start + 1
   end
 
   attr_reader :timestep, :count, :start, :last, :start_time, :last_time
@@ -115,8 +120,8 @@ class TimeStep::Range
   # @param time [DateTime]
   #
   # @return [TimeStep]
-  def new_origin (time)
-    timestep = @timestep.new_origin(time)
+  def new_origin (time, truncate: false)
+    timestep = @timestep.new_origin(time, truncate: truncate)
     return TimeStep::Range.new(timestep, count: @count)
   end
 
@@ -124,12 +129,12 @@ class TimeStep::Range
   
   def each_time (&block)
     if block
-      @start.upto(@last) do |k|
+      (@start..@last).each do |k|
         block.call(@timestep.time_at(k))
       end
     else
       return Enumerator.new {|y|
-        @start.upto(@last) do |k|
+        (@start..@last).each do |k|
           y << @timestep.time_at(k)
         end
       }

data/lib/timesteps.rb

@@ -1,5 +1,6 @@
 
 require "date"
+require "timesteps/time"
 require "timesteps/datetimelike"
 require "timesteps/datetimelike_format"
 require "timesteps/datetime_noleap"
@@ -14,3 +15,4 @@ require "timesteps/timestep_converter"
 require "timesteps/timeperiod"
 require "timesteps/timestep_range"
 require "timesteps/datetime_timestep"
+require "timesteps/timestep_query"

data/spec/timestep_spec.rb

@@ -436,3 +436,16 @@ describe "TimeStep#new_origin" do
 
 end
 
+
+describe "TimeStep#right_time?" do
+  
+  example do 
+
+    ts = TimeStep.new("1 hour")
+    is_asserted_by { ts.right_time?(ts.parse("2001-01-01 01:00:00")) == true }
+    is_asserted_by { ts.right_time?(ts.parse("2001-01-01 01:30:00")) == false }
+
+  end
+
+end
+

data/timesteps.gemspec

@@ -1,8 +1,8 @@
 
 Gem::Specification::new do |s|
-  version = "0.9.7"
+  version = "1.0.2"
 
-  files = Dir.glob("**/*") - [ 
+  files = Dir.glob("**/*") + [".yardopts"] - [ 
                                Dir.glob("timesteps-*.gem"), 
                                Dir.glob("doc/**/*"), 
                                Dir.glob("examples/**/*"), 
@@ -20,7 +20,7 @@ Gem::Specification::new do |s|
   describe the time axis when dealing with time series of observational data and climate data.
   HERE
   s.version     = version
-  s.licenses    = ['MIT']
+  s.license     = 'MIT'
   s.author      = "Hiroki Motoyoshi"
   s.email       = ""
   s.homepage    = 'https://github.com/himotoyoshi/timesteps'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timesteps
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 1.0.2
 platform: ruby
 authors:
 - Hiroki Motoyoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies: []
 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
@@ -22,7 +22,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSES
+- ".yardopts"
+- LICENSE
+- NEWS.md
 - Note.ja.md
 - README.md
 - Rakefile
@@ -35,6 +37,7 @@ files:
 - lib/timesteps/datetimelike.rb
 - lib/timesteps/datetimelike_format.rb
 - lib/timesteps/grads.rb
+- lib/timesteps/time.rb
 - lib/timesteps/timeperiod.rb
 - lib/timesteps/timestep.rb
 - lib/timesteps/timestep_calendar.rb
@@ -68,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A library for handling discrete time series in constant increments