timesteps 0.9.3

data/spec/timestep_spec.rb

@@ -0,0 +1,405 @@
+# rspec-power_assert
+require 'timesteps'
+require 'rspec-power_assert'
+
+unless defined? CALENDAR_NAMES
+  CALENDAR_NAMES = [
+    "standard",
+    "proleptic_gregorian",
+    "proleptic_julian",
+    "noleap",
+    "allleap",
+    "360_day"
+  ]
+end
+
+describe "TimeStep.new" do
+
+  example 'origin' do 
+
+    spec = "1 days since 2001-02-03 04:05:06 +07:00"
+    tests = [
+      [spec, "standard", DateTime.new(2001,2,3,4,5,6,7.quo(24),Date::ITALY)],
+      [spec, "gregorian", DateTime.new(2001,2,3,4,5,6,7.quo(24),Date::ITALY)],
+      [spec, "proleptic_gregorian", DateTime.new(2001,2,3,4,5,6,7.quo(24),Date::GREGORIAN)],
+      [spec, "proleptic_julian", DateTime.new(2001,2,3,4,5,6,7.quo(24),Date::JULIAN)],
+      [spec, "noleap",  DateTime::NoLeap.new(2001,2,3,4,5,6,7.quo(24))],
+      [spec, "365_day", DateTime::NoLeap.new(2001,2,3,4,5,6,7.quo(24))],
+      [spec, "allleap", DateTime::AllLeap.new(2001,2,3,4,5,6,7.quo(24))],
+      [spec, "366_day", DateTime::AllLeap.new(2001,2,3,4,5,6,7.quo(24))],
+      [spec, "360_day", DateTime::Fixed360Day.new(2001,2,3,4,5,6,7.quo(24))],
+    ]
+
+    tests.each do |spec, calendar, date|
+
+      ts = TimeStep.new(spec, calendar: calendar)
+
+      is_asserted_by { ts.origin == date }
+
+    end
+    
+  end
+
+  example 'interval' do
+
+    tests = [
+      ["year since 2001-02-03 04:05:06 +07:00",   1, :years],
+      ["month since 2001-02-03 04:05:06 +07:00",  1, :months],
+      ["day since 2001-02-03 04:05:06 +07:00",    1, :days],
+      ["hour since 2001-02-03 04:05:06 +07:00",   1, :hours],
+      ["minute since 2001-02-03 04:05:06 +07:00", 1, :minutes],
+      ["second since 2001-02-03 04:05:06 +07:00", 1, :seconds],
+
+      ["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],
+
+      ["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],
+      ["3 days since 2001-02-03 04:05:06 +07:00",    3, :days],
+      ["3 hours since 2001-02-03 04:05:06 +07:00",   3, :hours],
+      ["3 minutes since 2001-02-03 04:05:06 +07:00", 3, :minutes],
+      ["3 seconds since 2001-02-03 04:05:06 +07:00", 3, :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],
+      ["3 days since     2001-02-03 04:05:06 +07:00",    3, :days],
+      ["3 hours since    2001-02-03 04:05:06 +07:00",   3, :hours],
+      ["3 minutes since  2001-02-03 04:05:06 +07:00", 3, :minutes],
+      ["3 seconds since  2001-02-03 04:05:06 +07:00", 3, :seconds],
+
+      ["3years since 2001-02-03 04:05:06 +07:00",   3, :years],
+      ["3months since 2001-02-03 04:05:06 +07:00",  3, :months],
+      ["3days since 2001-02-03 04:05:06 +07:00",    3, :days],
+      ["3hours since 2001-02-03 04:05:06 +07:00",   3, :hours],
+      ["3minutes since 2001-02-03 04:05:06 +07:00", 3, :minutes],
+      ["3seconds since 2001-02-03 04:05:06 +07:00", 3, :seconds],
+
+      ["60 years since 2001-02-03 04:05:06 +07:00",   60, :years],
+      ["60 months since 2001-02-03 04:05:06 +07:00",  60, :months],
+      ["60 days since 2001-02-03 04:05:06 +07:00",    60, :days],
+      ["60 hours since 2001-02-03 04:05:06 +07:00",   60, :hours],
+      ["60 minutes since 2001-02-03 04:05:06 +07:00", 60, :minutes],
+      ["60 seconds since 2001-02-03 04:05:06 +07:00", 60, :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],
+      ["-3 days since 2001-02-03 04:05:06 +07:00",    -3, :days],
+      ["-3 hours since 2001-02-03 04:05:06 +07:00",   -3, :hours],
+      ["-3 minutes since 2001-02-03 04:05:06 +07:00", -3, :minutes],
+      ["-3 seconds since 2001-02-03 04:05:06 +07:00", -3, :seconds],
+
+      ["3.5 days since 2001-02-03 04:05:06 +07:00",    3.5, :days],
+      ["3.5 hours since 2001-02-03 04:05:06 +07:00",   3.5, :hours],
+      ["3.5 minutes since 2001-02-03 04:05:06 +07:00", 3.5, :minutes],
+      ["3.5 seconds since 2001-02-03 04:05:06 +07:00", 3.5, :seconds],
+
+      ["3.5e2 days since 2001-02-03 04:05:06 +07:00",    3.5e2, :days],
+      ["3.5e2 hours since 2001-02-03 04:05:06 +07:00",   3.5e2, :hours],
+      ["3.5e2 minutes since 2001-02-03 04:05:06 +07:00", 3.5e2, :minutes],
+      ["3.5e2 seconds since 2001-02-03 04:05:06 +07:00", 3.5e2, :seconds],
+
+      ["3.5e21 days since 2001-02-03 04:05:06 +07:00",    3.5e21, :days],
+      ["3.5e21 hours since 2001-02-03 04:05:06 +07:00",   3.5e21, :hours],
+      ["3.5e21 minutes since 2001-02-03 04:05:06 +07:00", 3.5e21, :minutes],
+      ["3.5e21 seconds since 2001-02-03 04:05:06 +07:00", 3.5e21, :seconds],
+
+      ["3.5e-2 days since 2001-02-03 04:05:06 +07:00",    3.5e-2, :days],
+      ["3.5e-2 hours since 2001-02-03 04:05:06 +07:00",   3.5e-2, :hours],
+      ["3.5e-2 minutes since 2001-02-03 04:05:06 +07:00", 3.5e-2, :minutes],
+      ["3.5e-2 seconds since 2001-02-03 04:05:06 +07:00", 3.5e-2, :seconds],
+    ]
+    
+    tests.each do |spec, numeric, symbol|
+      ts = TimeStep.new(spec)
+
+      is_asserted_by { ts.numeric == numeric }
+      is_asserted_by { ts.symbol  == symbol }
+    end
+    
+  end
+
+end
+
+describe "TimeStep#time_at" do
+
+
+  example 'invalid argument' do
+    
+    ts = TimeStep.new("1 seconds since 2001-02-03 04:05:06 +07:00")
+    
+    expect { ts.time_at("string") }.to raise_error(ArgumentError)
+    
+  end
+
+
+  example 'seconds' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 seconds since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.time_at(0) == ts.origin }
+      is_asserted_by { ts.time_at(1) == ts.origin + 1.quo(86400) }
+      is_asserted_by { ts.time_at(1000000) == ts.origin + 1000000.quo(86400) }
+      is_asserted_by { ts.time_at(-1) == ts.origin - 1.quo(86400) }
+      is_asserted_by { ts.time_at(-1000000) == ts.origin - 1000000.quo(86400) }
+
+    end
+    
+  end
+
+  example 'days' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 days since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.time_at(0) == ts.origin }
+      is_asserted_by { ts.time_at(1) == ts.origin.next_day(1) }
+      is_asserted_by { ts.time_at(366) == ts.origin.next_day(366) }
+      is_asserted_by { ts.time_at(-1) == ts.origin.prev_day(1) }
+      is_asserted_by { ts.time_at(-366) == ts.origin.prev_day(366) }
+
+      is_asserted_by { ts.time_at(1.5) == (ts.origin + 1.5) }
+      is_asserted_by { ts.time_at(-1.5) == (ts.origin - 1.5) }
+
+    end
+    
+  end
+
+  example 'months' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 months since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.time_at(0) == ts.origin }
+      is_asserted_by { ts.time_at(1) == ts.origin.next_month(1) }
+      is_asserted_by { ts.time_at(366) == ts.origin.next_month(366) }
+      is_asserted_by { ts.time_at(-1) == ts.origin.prev_month(1) }
+      is_asserted_by { ts.time_at(-366) == ts.origin.prev_month(366) }
+
+      # months timestep don't permit fractional index
+      expect { ts.time_at(1.5) }.to raise_error(RuntimeError)
+
+    end
+    
+  end
+
+  example 'years' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 years since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.time_at(0) == ts.origin }
+      is_asserted_by { ts.time_at(1) == ts.origin.next_year(1) }
+      is_asserted_by { ts.time_at(366) == ts.origin.next_year(366) }
+      is_asserted_by { ts.time_at(-1) == ts.origin.prev_year(1) }
+      is_asserted_by { ts.time_at(-366) == ts.origin.prev_year(366) }
+
+      # years timestep don't permit fractional index
+      expect { ts.time_at(1.5) }.to raise_error(RuntimeError)
+
+    end
+    
+  end
+
+end
+
+describe "TimeStep#index_at" do
+
+  example 'seconds' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 seconds since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.index_at( ts.origin ) == 0 }
+      is_asserted_by { ts.index_at( ts.origin + 1.quo(86400) ) == 1 }
+      is_asserted_by { ts.index_at( ts.origin + 100.quo(86400) ) == 100 }
+      is_asserted_by { ts.index_at( ts.origin + 0.5.to_r.quo(86400) ) == 0.5 }
+      is_asserted_by { ts.index_at( ts.origin - 0.5.to_r.quo(86400) ) == -0.5 }
+
+    end
+    
+  end
+
+  example 'days' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 days since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.index_at( ts.origin ) == 0 }
+      is_asserted_by { ts.index_at( ts.origin + 1 ) == 1 }
+      is_asserted_by { ts.index_at( ts.origin + 100 ) == 100 }
+      is_asserted_by { ts.index_at( ts.origin + 0.5 ) == 0.5 }
+      is_asserted_by { ts.index_at( ts.origin - 0.5 ) == -0.5 }
+
+    end
+    
+  end
+
+  example 'months' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 months since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.index_at( ts.origin ) == 0 }
+      is_asserted_by { ts.index_at( ts.origin.next_month(1) ) == 1 }
+      is_asserted_by { ts.index_at( ts.origin.next_month(100) ) == 100 }
+      is_asserted_by { ts.index_at( ts.origin.prev_month(1) ) == -1 }
+      is_asserted_by { ts.index_at( ts.origin.prev_month(100) ) == -100 }
+
+    end
+    
+  end
+
+  example 'years' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 years since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.index_at( ts.origin ) == 0 }
+      is_asserted_by { ts.index_at( ts.origin.next_year(1) ) == 1 }
+      is_asserted_by { ts.index_at( ts.origin.next_year(100) ) == 100 }
+      is_asserted_by { ts.index_at( ts.origin.prev_year(1) ) == -1 }
+      is_asserted_by { ts.index_at( ts.origin.prev_year(100) ) == -100 }
+      is_asserted_by { ts.index_at( ts.origin.next_year(1) - 1 ) == 0 }
+      is_asserted_by { ts.index_at( ts.origin.next_year(100) - 1 ) == 99 }
+      is_asserted_by { ts.index_at( ts.origin.prev_year(1) + 1 ) == 0 }
+      is_asserted_by { ts.index_at( ts.origin.prev_year(100) + 1 ) == -99 }
+
+    end
+    
+  end
+
+end
+
+describe "TimeStep#days_at" do
+
+  example 'seconds' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 seconds since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.days_at( 1 ) == 1.quo(86400) }
+      is_asserted_by { ts.days_at( 100 ) == 100.quo(86400) }
+      is_asserted_by { ts.days_at( 0.5 ) ==  0.5.to_r.quo(86400) }
+      is_asserted_by { ts.days_at( -0.5 ) == -0.5.to_r.quo(86400) }
+
+    end
+    
+  end
+
+  example 'days' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 days since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.days_at( 1 ) == 1 }
+      is_asserted_by { ts.days_at( 100 ) == 100 }
+      is_asserted_by { ts.days_at( 0.5 ) == 0.5 }
+      is_asserted_by { ts.days_at( -0.5 ) == -0.5 }
+
+    end
+    
+  end
+
+  example 'months' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 months since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.days_at( 1 ) == ts.origin.next_month - ts.origin }
+      is_asserted_by { ts.days_at( 100 ) == ts.origin.next_month(100) - ts.origin }
+      is_asserted_by { ts.days_at( -1 ) == ts.origin.prev_month - ts.origin }
+      is_asserted_by { ts.days_at( -100 ) == ts.origin.prev_month(100) - ts.origin }
+
+    end
+    
+  end
+
+  example 'years' do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 years since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.days_at( 1 ) == ts.origin.next_year - ts.origin }
+      is_asserted_by { ts.days_at( 100 ) == ts.origin.next_year(100) - ts.origin }
+      is_asserted_by { ts.days_at( -1 ) == ts.origin.prev_year - ts.origin }
+      is_asserted_by { ts.days_at( -100 ) == ts.origin.prev_year(100) - ts.origin }
+
+    end
+    
+  end
+
+end
+
+describe "TimeStep#shift_origin" do
+  
+  example do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 years since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+
+      is_asserted_by { ts.shift_origin(1).origin == ts.time_at(1) }
+
+    end
+
+  end
+
+end
+
+describe "TimeStep#new_origin" do
+  
+  example do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 years since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+      d = ts.time_at(1)
+
+      is_asserted_by { ts.new_origin(d).origin == d }
+
+    end
+
+  end
+
+end
+
+describe "TimeStep#limit" do
+  
+  example do 
+
+    CALENDAR_NAMES.each do |calendar|
+
+      ts = TimeStep.new("1 hours since 2001-02-03 04:05:06 +07:00", calendar: calendar, count: 31)
+      is_asserted_by { ts.limit == ts.time_at(30) }
+    
+      ts = TimeStep.new("1 hours since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+      ts.count = 31
+      is_asserted_by { ts.limit == ts.time_at(30) }
+
+      ts = TimeStep.new("1 hours since 2001-02-03 04:05:06 +07:00", calendar: calendar)
+      ts.limit = ts.time_at(30)
+      is_asserted_by { ts.count == 31 }
+
+    end
+
+  end
+
+end
+

data/spec/timesteppair_spec.rb

@@ -0,0 +1,99 @@
+# rspec-power_assert
+require 'timesteps'
+require 'rspec-power_assert'
+
+describe "TimeStep::Pair.new" do
+
+  example "spec" do 
+    
+    spec1 = "1 days since 2001-02-03 04:05:06 +07:00"
+    spec2 = "1 hours since 2001-02-03 04:05:06 +07:00"
+
+    pair = TimeStep::Pair.new(spec1, spec2)
+
+    ts1 = TimeStep.new(spec1)
+    ts2 = TimeStep.new(spec2)
+
+    is_asserted_by { pair.from == ts1 }
+    is_asserted_by { pair.to == ts2 }
+    is_asserted_by { pair.difference == 0 }
+
+  end
+
+end
+
+describe "TimeStep::Pair#forward" do
+
+  example "different hours" do 
+    
+    spec1 = "1 hours since 2001-02-03 04:05:06 +07:00"
+    spec2 = "3 hours since 2001-02-02 04:05:06 +07:00"
+
+    pair = TimeStep::Pair.new(spec1, spec2)
+
+    is_asserted_by { pair.forward(0)  == 24.quo(3) }
+    is_asserted_by { pair.forward(1)  == 25.quo(3) }
+    is_asserted_by { pair.forward(24) == 48.quo(3) }
+    is_asserted_by { pair.forward(1.5) == (51.quo(2)).quo(3) }
+
+  end
+
+  example "different days" do 
+    
+    spec1 = "3 days since 2001-02-03 04:05:06 +07:00"
+    spec2 = "1 days since 2001-02-02 04:05:06 +07:00"
+
+    pair = TimeStep::Pair.new(spec1, spec2)
+
+    is_asserted_by { pair.forward(0)  == 1 }
+    is_asserted_by { pair.forward(1)  == 4 }
+    is_asserted_by { pair.forward(10)  == 31 }
+    is_asserted_by { pair.forward(1.5) == 11.quo(2) }
+
+  end
+
+  example "different months" do 
+    
+    spec1 = "3 months since 2001-02-03 04:05:06 +07:00"
+    spec2 = "1 months since 2001-01-03 04:05:06 +07:00"
+
+    pair = TimeStep::Pair.new(spec1, spec2)
+
+    is_asserted_by { pair.forward(0) == 1 }
+    is_asserted_by { pair.forward(1) == 4 }
+    is_asserted_by { pair.forward(10) == 31 }
+
+    expect { pair.forward(1.5) }.to raise_error(RuntimeError)
+  end
+
+  example "different years" do 
+    
+    spec1 = "3 years since 2001-02-03 04:05:06 +07:00"
+    spec2 = "1 years since 2000-02-03 04:05:06 +07:00"
+
+    pair = TimeStep::Pair.new(spec1, spec2)
+
+    is_asserted_by { pair.forward(0) == 1 }
+    is_asserted_by { pair.forward(1) == 4 }
+    is_asserted_by { pair.forward(10) == 31 }
+
+    expect { pair.forward(1.5) }.to raise_error(RuntimeError)
+
+  end
+
+  example "different offset" do 
+    
+    ts   = TimeStep.new("hour since 2001-01-01 00:00:00 +09:00")
+    unix = TimeStep.new("seconds since 1970-01-01 00:00:00")
+
+    pair = TimeStep::Pair.new(ts, unix)
+
+    is_asserted_by { pair.forward(0) == 978274800 }
+    is_asserted_by { pair.forward_time(0) == DateTime.new(2000,12,31,15,0,0,0) }
+    is_asserted_by { Time.at(pair.forward(0), in: "+00:00") == ts.origin.to_time }
+    
+  end
+
+
+end
+

data/timesteps.gemspec

@@ -0,0 +1,26 @@
+
+Gem::Specification::new do |s|
+  version = "0.9.3"
+
+  files = Dir.glob("**/*") - [ 
+                               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.description = <<-HERE
+  A library for handling discrete time series in constant increments.
+  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.licenses    = ['MIT']
+  s.author      = "Hiroki Motoyoshi"
+  s.email       = ""
+  s.homepage    = 'https://github.com/himotoyoshi/timesteps'
+  s.files       = files
+  s.required_ruby_version = ">= 2.5.1"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: timesteps
+version: !ruby/object:Gem::Version
+  version: 0.9.3
+platform: ruby
+authors:
+- Hiroki Motoyoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-04 00:00:00.000000000 Z
+dependencies: []
+description: "  A library for handling discrete time series in constant increments.\n
+  \ The main purpose of this library is to describe the time axis \n  when dealing
+  with time series of observational data and climate data.\n"
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSES
+- Note.ja.md
+- README.md
+- Rakefile
+- lib/timesteps.rb
+- lib/timesteps/calendar.rb
+- lib/timesteps/datetimelike.rb
+- lib/timesteps/format.rb
+- lib/timesteps/grads.rb
+- lib/timesteps/parse_timestamp.rb
+- lib/timesteps/timestep.rb
+- lib/timesteps/timestepconverter.rb
+- lib/timesteps/timestepdatetimeext.rb
+- lib/timesteps/timesteppair.rb
+- spec/allleap_spec.rb
+- spec/fixed360day_spec.rb
+- spec/noleap_spec.rb
+- spec/timestep_spec.rb
+- spec/timesteppair_spec.rb
+- timesteps.gemspec
+homepage: https://github.com/himotoyoshi/timesteps
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A library for handling discrete time series in constant increments
+test_files: []