time_spanner 1.0.0

data/test/time_spanner/time_spanner_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+module TimeSpanner
+  class TimeSpannerTest < TestCase
+    include Errors
+
+    it 'creates a span instance' do
+      from    = Time.now
+      to      = from + 1
+      span    = TimeSpan.new(from, to)
+
+      assert span.is_a?(TimeSpan)
+      assert span.kind_of?(Hash)
+    end
+
+    it 'ensures converting to Time' do
+      InvalidClass = Class.new do
+        def to_time; false end
+      end
+
+      assert_raises InvalidClassError do
+        TimeSpan.new(InvalidClass.new, InvalidClass.new)
+      end
+    end
+
+  end
+end

data/test/time_spanner/time_unit_collector_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+module TimeSpanner
+
+  class TimeUnitCollectorTest < TestCase
+    include TimeUnits
+    include Errors
+
+    before do
+      @now = Time.now
+    end
+
+    it 'initializes' do
+      collector = TimeUnitCollector.new [:hours]
+
+      assert_equal [:hours], collector.unit_names
+    end
+
+    it 'validates time units' do
+      assert_raises InvalidUnitError do
+        TimeUnitCollector.new [:days, :something]
+      end
+    end
+
+    describe "collecting unit names" do
+
+      it 'should use all unit names when if no units are given (no parameter given)' do
+        collector = TimeUnitCollector.new
+
+        assert_equal TimeUnitCollector::AVAILABLE_UNITS, collector.unit_names
+      end
+
+      it 'should use all unit names when if no units are given (nil given)' do
+        collector = TimeUnitCollector.new nil
+
+        assert_equal TimeUnitCollector::AVAILABLE_UNITS, collector.unit_names
+      end
+
+      it 'should use all unit names when if no units are given (empty Array given)' do
+        collector = TimeUnitCollector.new []
+
+        assert_equal TimeUnitCollector::AVAILABLE_UNITS, collector.unit_names
+      end
+
+    end
+
+    describe "mapping units" do
+
+      it 'should map all units' do
+        collector = TimeUnitCollector.new
+
+        expected = [Millennium, Century, Decade, Year, Month, Week, Day, Hour, Minute, Second, Millisecond, Microsecond, Nanosecond]
+        assert_equal expected, collector.units
+      end
+
+      it 'should map some units' do
+        collector = TimeUnitCollector.new [:days, :hours, :minutes]
+
+        assert_equal [Day, Hour, Minute], collector.units
+      end
+
+    end
+
+  end
+
+end

data/test/time_spanner/time_units/base/calendar_unit_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+module TimeSpanner
+  module TimeUnits
+
+    class CalendarUnitTest < TestCase
+
+      it 'initializes' do
+        time_unit = CalendarUnit.new(1)
+
+        assert time_unit.is_a?(CalendarUnit)
+        assert_equal 1, time_unit.position
+      end
+
+    end
+  end
+end

data/test/time_spanner/time_units/base/time_unit_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+module TimeSpanner
+  module TimeUnits
+
+    class TimeUnitTest < TestCase
+
+      it 'initializes' do
+        time_unit = TimeUnit.new(1, 1)
+
+        assert time_unit.is_a?(TimeUnit)
+        assert_equal 1, time_unit.position
+        assert_equal 1, time_unit.multiplier
+      end
+
+    end
+  end
+end

data/test/time_spanner/time_units/base/unit_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+module TimeSpanner
+  module TimeUnits
+
+    class UnitTest < TestCase
+
+      it 'initializes' do
+        time_unit = Unit.new(1)
+
+        assert time_unit.is_a?(Unit)
+        assert_equal 1, time_unit.position
+        assert_equal 0, time_unit.amount
+        assert_equal 0, time_unit.rest
+      end
+
+      it "compares: Day should be in front of Hour" do
+        day  = Day.new
+        hour = Hour.new
+
+        assert_equal -1, day.<=>(hour)
+      end
+
+      it "reverses!" do
+        second = Second.new
+        second.calculate 1
+
+        assert_equal 1, second.amount
+
+        second.reverse!
+
+        assert_equal -1, second.amount
+      end
+
+    end
+  end
+end

data/test/time_spanner/time_units/century_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+module TimeSpanner
+  module TimeUnits
+
+    class CenturyTest < TestCase
+
+      it 'initializes' do
+        century = Century.new
+
+        assert century.kind_of?(CalendarUnit)
+        assert_equal 2, century.position
+        assert_equal :centuries, century.plural_name
+      end
+
+      it 'calculates without rest' do
+        from     = Time.parse('2013-04-01 00:00:00')
+        to       = Time.parse('2213-04-01 00:00:00')
+        duration = to.to_r - from.to_r
+        century  = Century.new
+
+        century.calculate duration, to
+
+        assert_equal 2, century.amount
+        assert_equal 0, century.rest
+      end
+
+      it 'calculates with rest (1 day in seconds)' do
+        from     = Time.parse('2013-01-01 00:00:00')
+        to       = Time.parse('2213-01-02 00:00:00')
+        duration = to.to_r - from.to_r
+        century  = Century.new
+
+        century.calculate duration, to
+
+        assert_equal 2, century.amount
+        assert_equal 86400, century.rest
+      end
+
+      it 'should not calculate amount of 2 although units equal' do
+        from              = Time.parse '2012-06-12 00:00:00'
+        time_at_centuries = Time.parse '2212-06-12 00:00:00'
+        to                = Time.at time_at_centuries.to_r, -0.001
+        duration          = to.to_r - from.to_r
+        century           = Century.new
+
+        century.calculate duration, to
+
+        assert_equal 1, century.amount
+        assert century.rest > 0
+      end
+
+    end
+  end
+end

data/test/time_spanner/time_units/day_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+module TimeSpanner
+  module TimeUnits
+
+    class DayTest < TestCase
+
+      it 'initializes' do
+        day = Day.new
+
+        assert day.kind_of?(CalendarUnit)
+        assert_equal 7, day.position
+        assert_equal :days, day.plural_name
+      end
+
+      it 'calculates without rest' do
+        from     = Time.parse('2013-04-03 00:00:00')
+        to       = Time.parse('2013-04-05 00:00:00')
+        duration = to.to_r - from.to_r
+        day      = Day.new
+
+        day.calculate duration, to
+
+        assert_equal 2, day.amount
+        assert_equal 0, day.rest
+      end
+
+      it 'calculates with rest' do
+        from        = Time.parse('2013-04-03 00:00:00')
+        target_days = Time.parse('2013-04-05 00:00:00')
+        to          = Time.at(target_days.to_time.to_r, 0.999)
+        duration    = to.to_r - from.to_r
+        day         = Day.new
+
+        day.calculate duration, to
+
+        assert_equal 2, day.amount
+        assert_equal Rational(8998192055486251, 9007199254740992000000), day.rest
+      end
+
+      it 'should not calculate amount of 2 although units equal' do
+        from         = Time.parse '2012-06-12 23:00:00'
+        time_at_days = Time.parse '2012-06-14 23:00:00'
+        to           = Time.at time_at_days.to_r, -0.001
+        duration     = to.to_r - from.to_r
+        day          = Day.new
+
+        day.calculate duration, to
+
+        assert_equal 1, day.amount
+        assert day.rest > 0
+      end
+
+      describe 'leap days' do
+
+        it 'calculates correctly without leap day' do
+          from     = Time.parse('2013-01-01 00:00:00')
+          to       = Time.parse('2014-01-01 00:00:00')
+          duration = to.to_r - from.to_r
+          day      = Day.new
+
+          day.calculate duration, to
+
+          assert_equal 365, day.amount
+          assert_equal 0, day.rest
+        end
+
+        it 'calculates correctly on leap day' do
+          from     = Time.parse('2012-01-01 00:00:00') # leap year
+          to       = Time.parse('2013-01-01 00:00:00')
+          duration = to.to_r - from.to_r
+          day      = Day.new
+
+          day.calculate duration, to
+
+          assert_equal 366, day.amount
+          assert_equal 0, day.rest
+        end
+
+      end
+
+    end
+  end
+end

data/test/time_spanner/time_units/decade_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+module TimeSpanner
+  module TimeUnits
+
+    class DecadeTest < TestCase
+
+      it 'initializes' do
+        decade = Decade.new
+
+        assert decade.kind_of?(CalendarUnit)
+        assert_equal 3, decade.position
+        assert_equal :decades, decade.plural_name
+      end
+
+      it 'calculates without rest' do
+        from     = Time.parse('2023-04-01 00:00:00')
+        to       = Time.parse('2043-04-01 00:00:00')
+        duration = to.to_r - from.to_r
+        decade   = Decade.new
+
+        decade.calculate duration, to
+
+        assert_equal 2, decade.amount
+        assert_equal 0, decade.rest
+      end
+
+      it 'calculates with rest (1 second)' do
+        from     = Time.parse('2013-01-01 00:00:00')
+        to       = Time.parse('2033-01-01 00:00:01')
+        duration = to.to_r - from.to_r
+        decade   = Decade.new
+
+        decade.calculate duration, to
+
+        assert_equal 2, decade.amount
+        assert_equal 1, decade.rest
+      end
+
+      it 'should not calculate amount of 2 although units equal' do
+        from            = Time.parse '2012-06-12 00:00:00'
+        time_at_decades = Time.parse '2032-06-12 00:00:00'
+        to              = Time.at time_at_decades.to_r, -0.001
+        duration        = to.to_r - from.to_r
+        decade          = Decade.new
+
+        decade.calculate duration, to
+
+        assert_equal 1, decade.amount
+        assert decade.rest > 0
+      end
+
+      it 'calculates correctly on exact leap day' do
+        from     = Time.parse('2012-02-29 00:00:00') # leap year
+        to       = Time.parse('2022-02-28 00:00:00')
+        duration = to.to_r - from.to_r
+        decade   = Decade.new
+
+        decade.calculate duration, to
+
+        assert_equal 1, decade.amount
+        assert_equal 0, decade.rest
+      end
+
+    end
+  end
+end

data/test/time_spanner/time_units/hour_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+module TimeSpanner
+  module TimeUnits
+
+    class HourTest < TestCase
+
+      it 'initializes' do
+        hour = Hour.new
+
+        assert hour.kind_of?(TimeUnit)
+        assert_equal 8, hour.position
+        assert_equal :hours, hour.plural_name
+      end
+
+      it 'calculates without rest' do
+        from     = Time.parse('2013-04-03 00:00:00')
+        to       = Time.parse('2013-04-03 02:00:00')
+        duration = to.to_r - from.to_r
+        hour     = Hour.new
+
+        hour.calculate duration
+
+        assert_equal 2, hour.amount
+        assert_equal 0, hour.rest
+      end
+
+      it 'calculates with rest (999 Nanoseconds in seconds)' do
+        from         = Time.parse('2013-04-03 00:00:00')
+        target_hours = Time.parse('2013-04-03 02:00:00')
+        to           = Time.at(target_hours.to_r, 0.999)
+        duration     = to.to_r - from.to_r
+        hour         = Hour.new
+
+        hour.calculate duration
+
+        assert_equal 2, hour.amount
+        assert_equal Rational(8998192055486251, 9007199254740992000000), hour.rest
+      end
+
+      it 'should not calculate amount of 2 although units equal' do
+        from          = Time.parse '2012-06-12 02:22:00'
+        time_at_hours = Time.parse '2012-06-12 04:22:00'
+        to            = Time.at time_at_hours.to_r, -0.001
+        duration      = to.to_r - from.to_r
+        hour          = Hour.new
+
+        hour.calculate duration, to
+
+        assert_equal 1, hour.amount
+        assert hour.rest > 0
+      end
+
+    end
+  end
+end

data/test/time_spanner/time_units/microsecond_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+module TimeSpanner
+  module TimeUnits
+
+    class MicrosecondTest < TestCase
+
+      it 'initializes' do
+        microsecond = Microsecond.new
+
+        assert microsecond.kind_of?(TimeUnit)
+        assert_equal 12, microsecond.position
+        assert_equal :microseconds, microsecond.plural_name
+      end
+
+      it 'calculates' do
+        from        = Time.now
+        to          = Time.at(from.to_r, 2.0)
+        duration    = to.to_r - from.to_r
+        microsecond = Microsecond.new
+
+        microsecond.calculate duration
+
+        assert_equal 2, microsecond.amount
+        assert_equal 0, microsecond.rest
+      end
+
+      it 'calculates with rest (999 nanoseconds in seconds)' do
+        from          = Time.now
+        target_micros = Time.at(from.to_r, 2.0)
+        to            = Time.at(target_micros.to_r, 0.999)
+        duration      = to.to_r - from.to_r
+        microsecond   = Microsecond.new
+
+        microsecond.calculate duration
+
+        assert_equal 2, microsecond.amount
+        assert_equal Rational(8998192055486251, 9007199254740992000000), microsecond.rest
+      end
+
+      it 'should not calculate amount of 2 although units equal' do
+        from                 = Time.parse '2012-06-12 02:22:00'
+        time_at_microseconds = Time.at(from.to_r, 2.0)
+        to                   = Time.at time_at_microseconds.to_r, -0.001
+        duration             = to.to_r - from.to_r
+        microsecond          = Microsecond.new
+
+        microsecond.calculate duration, to
+
+        assert_equal 1, microsecond.amount
+        assert microsecond.rest > 0
+      end
+
+    end
+  end
+end