timesteps 1.0.3 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7475cc3a4a0af27a77730770cd4c952282ecfd1054d3bdd08a53d1da76ebe5a7
-  data.tar.gz: fdb95e8bd70ec9f2bcddf3b8c206f8db1330f169b54b531d74e4fc4148be92e3
+  metadata.gz: 1e933e2020424ed914b88472cafe4e2c7634dd6afe07475f4b0b915689fe4693
+  data.tar.gz: be0df225f53617124a675c374f41f47924da31926043a859f548e3d563bf5f6c
 SHA512:
-  metadata.gz: 1c8e36605a8128a20a7bf27af046e44d7f3d37cacb3669a7e28c4fa17aa4f0883bc9b44730756471b73f16afee6ef114b8b7021d2cee7812869914a3c832fdab
-  data.tar.gz: 3598ecc55200ff8e1aa474c0fd3f5c4c443b973c853557db3003e8489eb69f2630b76e4a2a44106ede8328efec69aca90d5e72e23bb95d2cdaed97d226657bfc
+  metadata.gz: 61c5653b8eb7b6423c92abdc89e331aac3f8675732ffc424fb34268bb6b69b24b63d7eaefdd121d4a3e28a3ecf1bd726a5a28639f25ce3f705039b5fb9fd6f32
+  data.tar.gz: 17015550f19920f9ce2c80e7a8e5df53f80deb44d7d6b6842f3eacd89d0eaf41cf2627274191767bacfbecd670630bdff1b95d2b8add41894eae34aeb9951289

data/Note.ja.md

@@ -6,13 +6,36 @@ topicブランチ     -> Feature開発版
 
 "XX since YYY" と since: time を同時に指定下場合は、前者が採用される (sinceオプションは無視される)。
 
-### 時間の単位 (udunits)
-    * years, year
-    * months,month
+### 時間の単位 (udunits + α)
+
+Normal cases
+
+    * years, year, yrs, yr, y
+    * months, month, mons, mon
     * days, day, d
-    * hours, hour, h
-    * minutes, minute, min
-    * seconds, sec, s
+    * hours, hour, hrs, hr, h
+    * minutes, minute, mins, min, m
+    * seconds, second, secs, sec, s
+    * milliseconds, millisecond, msecs, msec, ms
+    * microseconds, microsecond, usecs, usec, us
+    * ayears, ayear
+
+Week days (has a one week intervals and a day offset)
+
+    * weeks-sun, week-sun, w-sun
+    * weeks-mon, week-mon, w-mon
+    * weeks-tue, week-tue, w-tue
+    * weeks-wed, week-wed, w-wed
+    * weeks-thu, week-thu, w-thu
+    * weeks-fri, week-fri, w-fri
+    * weeks-sat, week-sat, w-sat
+    * sundays, sunday 
+    * mondays, monday
+    * tuesdays, tuesday
+    * wednesdays, wednesday
+    * thursdays, thursday
+    * fridays, friday
+    * saturdays, saturdays
 
 ### クラス構成
 
@@ -54,6 +77,7 @@ topicブランチ     -> Feature開発版
     TimeSteps::Calendar#parse(spec)  (initialized with bc: option)
 
 ### 暦の種類
+
 #### standard, gregorian
 
 * 今日使われているグレゴリオ暦 
@@ -86,7 +110,14 @@ topicブランチ     -> Feature開発版
 ts = TimeStep.new("6 hours since 2012-01-10 09:00:00")
 ts = ts.shift_origin_with_days(-256.quo(24))
 
+### 謎仕様（修正求む）
+
+#### 1日を1年単位で求めると...
+
+    ts = TimeStep.new("year since 2022-01-01")
+    ts.in("days").inverse(1) ### => (1/2)
 
+なぜに(1/2)
 
 
 

data/lib/timesteps/timestep.rb

@@ -49,6 +49,8 @@ class TimeStep
     'msecs?',
     'ms',
     'microseconds?', 
+    'usecs?',
+    'us',
     '(?:weeks?|w)(?:\-(?:sun|mon|tue|wed|thu|fri|sat))?',
     'sundays?',
     'mondays?',
@@ -210,13 +212,13 @@ class TimeStep
     end
     @interval = @numeric
     case symbol
-    when /\Ayears?\z/i
+    when /\A(years?|yrs?|y)\z/i
       unless numeric.denominator == 1
         raise "numeric factor for year should be an integer"
       end
       @symbol = :years
       @interval *= 356.242*86400
-    when /\Amonths?\z/i
+    when /\A(months?|mons?)\z/i
       unless numeric.denominator == 1
         raise "numeric factor for month should be an integer"
       end
@@ -228,7 +230,7 @@ class TimeStep
     when /\A(hours?|hrs?|h)\z/i
       @symbol = :hours
       @interval *= 3600
-    when /\A(minutes?|mins?)\z/i
+    when /\A(minutes?|mins?|m)\z/i
       @symbol = :minutes
       @interval *= 60
     when /\A(seconds?|secs?|s)\z/i
@@ -236,7 +238,7 @@ class TimeStep
     when /\A(milliseconds?|msecs?|ms)\z/i
       @symbol = :seconds
       @interval *= 1.quo(1000)
-    when /\Amicroseconds?\z/i
+    when /\A(microseconds?|usecs?|us)\z/i
       @symbol = :seconds
       @interval *= 1.quo(1000000)
     when /\A(weeks?|w)\-(sun|mon|tue|wed|thu|fri|sat)\z/i
@@ -247,12 +249,12 @@ class TimeStep
     when /\A(weeks?|w)\z/i
       @symbol = :weeks
       @interval *= 7*86400
-    when /\Asundays?|mondays?|tuesdays?|wednesdays?|thursday?|fridays?|saturdays?\z/i
+    when /\A(sundays?|mondays?|tuesdays?|wednesdays?|thursday?|fridays?|saturdays?)\z/i
       symbol =~ /\A(\w{3})/i
       @wday   = $1.downcase.intern
       @symbol = WDAY_NAME[@wday].intern ### :sundays, :mondays, ...
       @interval *= 7*86400
-    when /\Aayears?\z/i
+    when /\A(ayears?)\z/i
       @symbol = :days
       @numeric *= 365.242198781.to_r
       @interval = @numeric * 86400
@@ -457,6 +459,7 @@ class TimeStep
       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)
+      time = time.new_offset(@origin.offset) if time.offset != @origin.offset
       case @symbol
       when :years
         diff = time.difference_in_years(@origin)
@@ -566,7 +569,7 @@ class TimeStep
   #
   # @return [Numeric]
   def next_index_of (time)
-    time = @calendar.parse(time, offset: @origin.offset) if time.is_a?(String)
+    time = @calendar.parse(time) if time.is_a?(String)
     return index_at(time).floor + 1
   end
 
@@ -583,7 +586,7 @@ class TimeStep
   #
   # @return [Numeric]
   def prev_index_of (time)
-    time = @calendar.parse(time, offset: @origin.offset) if time.is_a?(String)
+    time = @calendar.parse(time) if time.is_a?(String)
     return index_at(time).ceil - 1
   end
 
@@ -691,8 +694,8 @@ class TimeStep
   #   ts.range("2001", "2002", ends: "[)")
   #   ts.range("2001", 1)
   #
-  # @param start [Numeric, DateTime]
-  # @param last  [Numeric, DateTime]
+  # @param start [Numeric, DateTime, String]
+  # @param last  [Numeric, DateTime, String]
   # @param count [Integer]
   # @param ends [String] one of "[]", "()", "[)", "(]"
   #

data/lib/timesteps/timestep_calendar.rb

@@ -1,6 +1,4 @@
 
-autoload :TZInfo, "tzinfo"
-
 class TimeStep
 
   class Calendar
@@ -69,7 +67,10 @@ class TimeStep
     end
         
     def valid_datetime_type? (time)
-      return false unless time.is_a?(DateTimeType[@calendar])
+      if @calendar == :standard and time.is_a?(TZInfo::DateTimeWithOffset)
+        return true
+      end
+      return false unless time.is_a?(DateTimeType[@calendar]) 
       case @calendar
       when :standard
         return time.start == Date::ITALY

data/lib/timesteps.rb

@@ -1,5 +1,6 @@
 
 require "date"
+require "tzinfo"
 require "timesteps/time"
 require "timesteps/datetimelike"
 require "timesteps/datetimelike_format"

data/spec/timestep_spec.rb

@@ -50,12 +50,15 @@ describe "TimeStep.new" do
       ["minute since 2001-02-03 04:05:06 +07:00", 1, :minutes],
       ["second since 2001-02-03 04:05:06 +07:00", 1, :seconds],
 
+      ["yr since 2001-02-03 04:05:06 +07:00",   1, :years],
+      ["mon since 2001-02-03 04:05:06 +07:00",  1, :months],
       ["d since 2001-02-03 04:05:06 +07:00",    1, :days],
       ["hr since 2001-02-03 04:05:06 +07:00",   1, :hours],
       ["h since 2001-02-03 04:05:06 +07:00",   1, :hours],
       ["min since 2001-02-03 04:05:06 +07:00", 1, :minutes],
       ["sec since 2001-02-03 04:05:06 +07:00", 1, :seconds],
       ["s since 2001-02-03 04:05:06 +07:00", 1, :seconds],
+      ["ms since 2001-02-03 04:05:06 +07:00", 1, :seconds],
 
       ["3 years since 2001-02-03 04:05:06 +07:00",   3, :years],
       ["3 months since 2001-02-03 04:05:06 +07:00",  3, :months],
@@ -115,12 +118,23 @@ describe "TimeStep.new" do
     
     tests.each do |spec, numeric, symbol|
       ts = TimeStep.new(spec)
-
       is_asserted_by { ts.numeric == numeric }
       is_asserted_by { ts.symbol  == symbol }
     end
     
   end
+
+  example 'without since' do
+
+    is_asserted_by { TimeStep.new("year").origin  == DateTime.new(0) }
+    is_asserted_by { TimeStep.new("month").origin == DateTime.new(0) }
+    is_asserted_by { TimeStep.new("week").origin  == DateTime.new(0) }
+    is_asserted_by { TimeStep.new("day").origin   == DateTime.new(0) }
+    is_asserted_by { TimeStep.new("hour").origin  == DateTime.new(1970,1,1) }
+    is_asserted_by { TimeStep.new("min").origin   == DateTime.new(1970,1,1) }
+    is_asserted_by { TimeStep.new("sec").origin   == DateTime.new(1970,1,1) }
+
+  end
   
   example 'since option with format' do
     
@@ -337,6 +351,17 @@ describe "TimeStep#index_at" do
   
   end
 
+  example 'different offset' do 
+    
+    ts = TimeStep.new("1 seconds since 1970-01-01 00:00:00")
+    
+    time_utc = DateTime.parse("2001-01-01 00:00:00 +00:00")
+    time_jst = DateTime.parse("2001-01-01 09:00:00 +09:00")
+
+    is_asserted_by { ts.index_at(time_utc) == ts.index_at(time_jst) }
+  
+  end
+
 end
 
 describe "TimeStep#duration_at" do
@@ -436,7 +461,6 @@ describe "TimeStep#new_origin" do
 
 end
 
-
 describe "TimeStep#right_time?" do
   
   example do 
@@ -449,3 +473,33 @@ describe "TimeStep#right_time?" do
 
 end
 
+describe "TimeStep#truncate" do
+
+  example 'hours' do 
+    
+    ts = TimeStep.new("1 hour")
+    
+    time1 = DateTime.parse("2001-01-01 01:30:00 +00:00")
+    time1_jst = DateTime.parse("2001-01-01 10:30:00 +09:00")
+    time2 = DateTime.parse("2001-01-01 01:00:00 +00:00")
+
+    is_asserted_by { ts.truncate(time1).offset == 0 }
+    is_asserted_by { time2 == ts.truncate(time1) }
+    is_asserted_by { time2 == ts.truncate(time1_jst) }
+
+    ts_jst = TimeStep.new("1 hour since 1970-01-01 00:00 +09:00")
+
+    time1 = DateTime.parse("2001-01-01 01:30:00 +00:00")
+    time1_jst = DateTime.parse("2001-01-01 10:30:00 +09:00")
+    time2 = DateTime.parse("2001-01-01 01:00:00 +00:00")
+    time2_jst = DateTime.parse("2001-01-01 10:00:00 +09:00")
+
+    is_asserted_by { ts_jst.truncate(time1).offset == 9.quo(24) }
+    is_asserted_by { time2 == ts_jst.truncate(time1) }
+    is_asserted_by { time2 == ts_jst.truncate(time1_jst) }
+    is_asserted_by { time2_jst == ts_jst.truncate(time1) }
+    is_asserted_by { time2_jst == ts_jst.truncate(time1_jst) }
+    
+  end
+  
+end

data/timesteps.gemspec

@@ -1,29 +1,30 @@
 
 Gem::Specification::new do |s|
-  version = "1.0.3"
+  version = '1.0.6'
 
-  files = Dir.glob("**/*") + [".yardopts"] - [ 
-                               Dir.glob("timesteps-*.gem"), 
-                               Dir.glob("doc/**/*"), 
-                               Dir.glob("examples/**/*"), 
+  files = Dir.glob('**/*') + ['.yardopts'] - [ 
+                               Dir.glob('timesteps-*.gem'), 
+                               Dir.glob('doc/**/*'), 
+                               Dir.glob('examples/**/*'), 
                              ].flatten
 
   s.platform    = Gem::Platform::RUBY
-  s.name        = "timesteps"
-  s.summary     = "A library for handling discrete time series in constant increments"
+  s.name        = 'timesteps'
+  s.summary     = 'A library for handling discrete time series in constant increments'
   s.description = <<-HERE
   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 
+  '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.license     = 'MIT'
-  s.author      = "Hiroki Motoyoshi"
-  s.email       = ""
+  s.author      = 'Hiroki Motoyoshi'
+  s.email       = ''
   s.homepage    = 'https://github.com/himotoyoshi/timesteps'
   s.files       = files
-  s.required_ruby_version = ">= 2.4.1"
+  s.required_ruby_version = '>= 2.4.1'
+  s.add_runtime_dependency 'tzinfo', '~> 2.0'
 end

metadata

@@ -1,19 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: timesteps
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.6
 platform: ruby
 authors:
 - Hiroki Motoyoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
-dependencies: []
+date: 2022-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 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
+  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"