timesteps 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ec2401e1d32acce3ddb048864c34b37de56ad5f83066fa617baeea8c65abc3a
-  data.tar.gz: '083c51a6c6fd1f295e7d2359960f5fe893ccc0847bcf014b7928f629c21e1a8e'
+  metadata.gz: 7475cc3a4a0af27a77730770cd4c952282ecfd1054d3bdd08a53d1da76ebe5a7
+  data.tar.gz: fdb95e8bd70ec9f2bcddf3b8c206f8db1330f169b54b531d74e4fc4148be92e3
 SHA512:
-  metadata.gz: e242891a7aed17ea1a3c0c138e80382b55422b5d6c9cbeec0c32e0b5725d5979a1e7631b110eb136ca4942c16023b93b325390f28be30792aa15f637a736c09b
-  data.tar.gz: 4da60d62efce29eeb13b1fe93d2621cdc616c6d8fe4d421922257bbb5e28c5695504d6804806430feb1dd42adbba7870de37b41758cf3df121dae59b57c1d3bf
+  metadata.gz: 1c8e36605a8128a20a7bf27af046e44d7f3d37cacb3669a7e28c4fa17aa4f0883bc9b44730756471b73f16afee6ef114b8b7021d2cee7812869914a3c832fdab
+  data.tar.gz: 3598ecc55200ff8e1aa474c0fd3f5c4c443b973c853557db3003e8489eb69f2630b76e4a2a44106ede8328efec69aca90d5e72e23bb95d2cdaed97d226657bfc

data/NEWS.md

@@ -1,6 +1,12 @@
 NEWS
 ====
 
+0.9.9 -> 1.0.2
+--------------
+
+* [Add] DateTime#next, DateTime#prev
+* [Add] TimeStep#right_time?
+
 0.9.8 -> 0.9.9
 --------------
 

data/Note.ja.md

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

data/README.md

@@ -1,10 +1,14 @@
-timesteps
+TimeSteps
 ================
 
 A library for handling discrete time series in constant increments.
 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
 --------
 
@@ -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/timestep.rb

@@ -35,10 +35,14 @@ class TimeStep
     'hours?',
     'minutes?',
     'seconds?',
+    'yrs?',
+    'y',
+    'mons?',
     'd',
     'hrs?',
     'h',
     'mins?',
+    'm',
     'secs?',
     's',
     'milliseconds?',
@@ -516,8 +520,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
@@ -627,7 +632,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`
@@ -696,5 +701,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_range.rb

@@ -25,7 +25,7 @@ class TimeStep::Range
       when Time
         last = timestep.index_at(last.to_datetime)
       when DateTime, DateTimeLike, String
-        last   = timestep.index_at(last)
+        last = timestep.index_at(last)
       else
         raise "unknown argument"
       end
@@ -48,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
@@ -118,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
 
@@ -127,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/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,6 +1,6 @@
 
 Gem::Specification::new do |s|
-  version = "1.0.0"
+  version = "1.0.3"
 
   files = Dir.glob("**/*") + [".yardopts"] - [ 
                                Dir.glob("timesteps-*.gem"), 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timesteps
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Hiroki Motoyoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2022-06-21 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
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A library for handling discrete time series in constant increments