time_math2 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fe3eec624d634487ddc4b74d08a3d39ec3f34d5
-  data.tar.gz: 87c691b0990e5e4a03f7bad4602e8bf100d1d526
+  metadata.gz: 51045d4f122c5237a82ef69caa42a16680a61e53
+  data.tar.gz: 3efbc480f4aa87b64b07219746f647101b706372
 SHA512:
-  metadata.gz: 8a7e17f5d2f9768c734649768b95c8ad63f168ca3c8686f2d52440caa952f8c7a20bc1af223cb5238eacfdec7e5924e814c0d8385887e83a5623da0024d15a55
-  data.tar.gz: a39344389ba42191d780257d97e4c53e6e2e84a5512e7deac17ba731a543e5decab9e01e833b266dc6f93efbbdec1d11135deff8cb78110071535ef382c713a7
+  metadata.gz: 3a607d28b91d01cb76d1764564cd7e4cb04a57f994ed4931402b1d6625348ce4042e75fb60c9dd9043f0b5bda5a2b81a15149c9d6668d68be7ed97724d136acc
+  data.tar.gz: e6f66d0e085b1dd0ac4bb1fc57e94dd949a403a6f09a6242da4444285af99eefd158f0229a03d26e3b31714b208c65dfc11e59ee1a89d46012dbdad03fa9c9d3

data/CHANGELOG.md

@@ -1,7 +1,15 @@
 # TimeMath Changelog
 
+# 0.0.6 (2016-12-14)
+
+* Fix approach to timezone info preservation (previously, it was clear bug, emerging from
+  false believing of how `Time.mktime` works). Thanks, @wojtha, for pointing to the problem.
+* Add `#each` and `Enumerable` to `Sequence` (no idea why it wasn't done from the very
+  beginning). Again: thanks, @wojtha!
+
 # 0.0.5 (2016-06-25)
 
+* Add support for `Date`;
 * Add optional second argument to rounding functions (`floor`, `ceil` and
   so on), for "floor to 3-hour mark";
 * Allow this argument, as well as in `advance`/`decrease`, to be non-integer;

data/README.md

@@ -35,7 +35,7 @@ Rails or without it, for any purpose.
 * No monkey-patching of core classes (now **strict**; previously existing opt-in
   core ext removed in 0.0.5);
 * Works with Time, Date and DateTime;
-* Accurately preserves timezone info;
+* Accurately preserves timezone offset;
 * Simple arithmetics: floor/ceil/round to any time unit (second, hour, year
   or whatnot), advance/decrease by any unit;
 * Chainable [operations](#set-of-operations-as-a-value-object), including
@@ -306,12 +306,7 @@ it means:
 
 ## Compatibility notes
 
-TimeMath is known to work on MRI Ruby >= 1.9.
-
-On JRuby it works, too, though there could be _slightly_ unexpected results,
-when JRuby fails to create time by timezone name (see [bug](https://github.com/jruby/jruby/issues/3978)).
-TimeMath in this case fallbacks to the same solution that used for `DateTime`,
-and at least preserves utc offset.
+TimeMath is known to work on MRI Ruby >= 2.0 and JRuby >= 9.0.0.0.
 
 On Rubinius, some of tests fail and I haven't time to investigate it. If
 somebody still uses Rubinius and wants TimeMath to be working properly

data/lib/time_math/resamplers.rb

@@ -62,7 +62,7 @@ module TimeMath
 
       sequence.ranges.map do |r|
         values = @hash.select { |k, _| r.cover?(k) }.map(&:last)
-        values = block.call(values) if block # rubocop:disable Performance/RedundantBlockCall
+        values = block.call(values) if block
         [r.begin, values]
       end.to_h
     end

data/lib/time_math/sequence.rb

@@ -230,26 +230,25 @@ module TimeMath
       end
     end
 
-    # Creates an array of time unit starts between from and to. They will
-    # have same granularity as from (e.g. if unit is day and from is
-    # 2016-05-01 13:30, each of return values will be next day at 13:30),
-    # unless sequence is not set to floor values.
+    # Enumerates time unit between `from` and `to`. They will have same granularity as from
+    # (e.g. if `unit` is day and from is 2016-05-01 13:30, each of return values will be next
+    # day at 13:30), unless sequence is not set to floor values.
     #
-    # @return [Array<Time or DateTime>]
-    def to_a
-      seq = []
+    # @return [Enumerator<Time, or Date, or DateTime>]
+    def each
+      return to_enum(:each) unless block_given?
 
       iter = from
       while iter < to
-        seq << iter
+        yield(op.call(iter))
 
         iter = unit.advance(iter)
       end
-      seq << to unless exclude_end?
-
-      op.call(seq)
+      yield(op.call(to)) unless exclude_end?
     end
 
+    include Enumerable
+
     # Creates an array of pairs (time unit start, time unit end) between
     # from and to.
     #

data/lib/time_math/units/base.rb

@@ -46,8 +46,8 @@ module TimeMath
       # @param tm [Time,Date,DateTime] time value to floor.
       # @param span [Numeric] how many units to floor to. For units
       #   less than week supports float/rational values.
-      # @return [Time,Date,DateTime] floored time value; class and timezone
-      #   info of origin would be preserved.
+      # @return [Time,Date,DateTime] floored time value; class and timezone offset of origin
+      #   would be preserved.
       def floor(tm, span = 1)
         int_floor = advance(floor_1(tm), (tm.send(name) / span.to_f).floor * span - tm.send(name))
         float_fix(tm, int_floor, span % 1)
@@ -61,7 +61,7 @@ module TimeMath
       # @param tm [Time,Date,DateTime] time value to ceil.
       # @param span [Numeric] how many units to ceil to. For units
       #   less than week supports float/rational values.
-      # @return [Time,Date,DateTime] ceiled time value; class and timezone info
+      # @return [Time,Date,DateTime] ceiled time value; class and timezone offset
       #   of origin would be preserved.
       def ceil(tm, span = 1)
         f = floor(tm, span)
@@ -78,7 +78,7 @@ module TimeMath
       # @param tm [Time,Date,DateTime] time value to round.
       # @param span [Numeric] how many units to round to. For units
       #   less than week supports float/rational values.
-      # @return [Time,Date,DateTime] rounded time value; class and timezone info
+      # @return [Time,Date,DateTime] rounded time value; class and timezone offset
       #   of origin would be preserved.
       def round(tm, span = 1)
         f, c = floor(tm, span), ceil(tm, span)
@@ -95,7 +95,7 @@ module TimeMath
       # @param tm [Time,Date,DateTime] time value to calculate prev on.
       # @param span [Numeric] how many units to floor to. For units
       #   less than week supports float/rational values.
-      # @return [Time,Date,DateTime] prev time value; class and timezone info
+      # @return [Time,Date,DateTime] prev time value; class and timezone offset
       #   of origin would be preserved.
       def prev(tm, span = 1)
         f = floor(tm, span)
@@ -111,7 +111,7 @@ module TimeMath
       # @param tm [Time,Date,DateTime] time value to calculate next on.
       # @param span [Numeric] how many units to ceil to. For units
       #   less than week supports float/rational values.
-      # @return [Time,Date,DateTime] next time value; class and timezone info
+      # @return [Time,Date,DateTime] next time value; class and timezone offset
       #   of origin would be preserved.
       def next(tm, span = 1)
         c = ceil(tm, span)
@@ -134,7 +134,7 @@ module TimeMath
       # @param amount [Numeric] how many units forward to go. For units
       #   less than week supports float/rational values.
       #
-      # @return [Time,Date,DateTime] advanced time value; class and timezone info
+      # @return [Time,Date,DateTime] advanced time value; class and timezone offset
       #   of origin would be preserved.
       def advance(tm, amount = 1)
         return decrease(tm, -amount) if amount < 0
@@ -147,7 +147,7 @@ module TimeMath
       # @param amount [Integer] how many units forward to go. For units
       #   less than week supports float/rational values.
       #
-      # @return [Time,Date,DateTime] decrease time value; class and timezone info
+      # @return [Time,Date,DateTime] decrease time value; class and timezone offset
       #   of origin would be preserved.
       def decrease(tm, amount = 1)
         return advance(tm, -amount) if amount < 0
@@ -300,59 +300,16 @@ module TimeMath
         "#<#{self.class}>"
       end
 
-      protected
-
-      # all except :week
-      NATURAL_UNITS = [:year, :month, :day, :hour, :min, :sec].freeze
-      EMPTY_VALUES = [nil, 1, 1, 0, 0, 0].freeze
+      private
 
       def index
-        NATURAL_UNITS.index(name) or
+        Util::NATURAL_UNITS.index(name) or
           raise NotImplementedError, "Can not be used for #{name}"
       end
 
-      def generate(tm, replacements = {})
-        hash_to_tm(tm, tm_to_hash(tm).merge(replacements))
-      end
-
-      def tm_to_hash(tm)
-        Hash[*NATURAL_UNITS.flat_map { |s| [s, tm.send(s)] }]
-      end
-
-      def hash_to_tm(origin, hash)
-        components = NATURAL_UNITS.map { |s| hash[s] || 0 }
-        new_from_components(origin, *components)
-      end
-
-      def new_from_components(origin, *components)
-        components = EMPTY_VALUES.zip(components).map { |d, c| c || d }
-        case origin
-        when Time
-          res = Time.mktime(*components.reverse, nil, nil, nil, origin.zone)
-          fix_no_zone(res, origin, *components)
-        when DateTime
-          DateTime.new(*components, origin.zone)
-        when Date
-          Date.new(*components.first(3))
-        else
-          raise ArgumentError, "Expected Time, Date or DateTime, got #{origin.class}"
-        end
-      end
-
-      def to_components(tm)
-        case tm
-        when Time, DateTime
-          [tm.year, tm.month, tm.day, tm.hour, tm.min, tm.sec]
-        when Date
-          [tm.year, tm.month, tm.day]
-        else
-          raise ArgumentError, "Expected Time, Date or DateTime, got #{tm.class}"
-        end
-      end
-
       def floor_1(tm)
-        components = to_components(tm).first(index + 1)
-        new_from_components(tm, *components)
+        components = Util.tm_to_array(tm).first(index + 1)
+        Util.array_to_tm(tm, *components)
       end
 
       def float_fix(tm, floored, float_span_part)
@@ -363,16 +320,6 @@ module TimeMath
           float_floored > tm ? floored : float_floored
         end
       end
-
-      def fix_no_zone(tm, origin, *components)
-        if origin.zone != 'UTC' && tm.zone == 'UTC'
-          # Fixes things like this one: https://github.com/jruby/jruby/issues/3978
-          # ...by falling back to use of UTC offset instead of timezone abbr
-          Time.new(*components, origin.utc_offset)
-        else
-          tm
-        end
-      end
     end
   end
 end

data/lib/time_math/units/month.rb

@@ -17,16 +17,16 @@ module TimeMath
       protected
 
       def _succ(tm)
-        return generate(tm, year: tm.year + 1, month: 1) if tm.month == 12
+        return Util.merge(tm, year: tm.year + 1, month: 1) if tm.month == 12
 
-        t = generate(tm, month: tm.month + 1)
+        t = Util.merge(tm, month: tm.month + 1)
         fix_month(t, t.month + 1)
       end
 
       def _prev(tm)
-        return generate(tm, year: tm.year - 1, month: 12) if tm.month == 1
+        return Util.merge(tm, year: tm.year - 1, month: 12) if tm.month == 1
 
-        t = generate(tm, month: tm.month - 1)
+        t = Util.merge(tm, month: tm.month - 1)
         fix_month(t, t.month - 1)
       end
 

data/lib/time_math/units/week.rb

@@ -11,7 +11,7 @@ module TimeMath
           raise NotImplementedError, 'For now, week only can floor to one'
 
         f = TimeMath.day.floor(tm)
-        extra_days = tm.wday == 0 ? 6 : tm.wday - 1
+        extra_days = tm.wday.zero? ? 6 : tm.wday - 1
         TimeMath.day.decrease(f, extra_days)
       end
 

data/lib/time_math/units/year.rb

@@ -7,7 +7,7 @@ module TimeMath
       end
 
       def measure(from, to)
-        if generate(from, year: to.year) < to
+        if Util.merge(from, year: to.year) < to
           to.year - from.year
         else
           to.year - from.year - 1
@@ -17,11 +17,11 @@ module TimeMath
       protected
 
       def _advance(tm, steps)
-        generate(tm, year: tm.year + steps.to_i)
+        Util.merge(tm, year: tm.year + steps.to_i)
       end
 
       def _decrease(tm, steps)
-        generate(tm, year: tm.year - steps.to_i)
+        Util.merge(tm, year: tm.year - steps.to_i)
       end
     end
   end

data/lib/time_math/util.rb

@@ -1,10 +1,53 @@
 module TimeMath
   # @private
   module Util
+    # all except :week
+    NATURAL_UNITS = [:year, :month, :day, :hour, :min, :sec].freeze
+    EMPTY_VALUES = [nil, 1, 1, 0, 0, 0].freeze
+
     module_function
 
     def timey?(val)
       [Time, DateTime, Date].any? { |cls| val.is_a?(cls) }
     end
+
+    def merge(tm, attrs = {})
+      hash_to_tm(tm, tm_to_hash(tm).merge(attrs))
+    end
+
+    def array_to_tm(origin, *components)
+      components = EMPTY_VALUES.zip(components).map { |d, c| c || d }
+
+      case origin
+      when Time
+        Time.new(*components, origin.utc_offset)
+      when DateTime
+        DateTime.new(*components, origin.zone)
+      when Date
+        Date.new(*components.first(3))
+      else
+        raise ArgumentError, "Expected Time, Date or DateTime, got #{origin.class}"
+      end
+    end
+
+    def tm_to_array(tm)
+      case tm
+      when Time, DateTime
+        [tm.year, tm.month, tm.day, tm.hour, tm.min, tm.sec]
+      when Date
+        [tm.year, tm.month, tm.day]
+      else
+        raise ArgumentError, "Expected Time, Date or DateTime, got #{tm.class}"
+      end
+    end
+
+    def tm_to_hash(tm)
+      Hash[*NATURAL_UNITS.flat_map { |s| [s, tm.send(s)] }]
+    end
+
+    def hash_to_tm(origin, hash)
+      components = NATURAL_UNITS.map { |s| hash[s] || 0 }
+      array_to_tm(origin, *components)
+    end
   end
 end

data/lib/time_math/version.rb

@@ -1,4 +1,4 @@
 module TimeMath
   # @private
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_math2
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-25 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Easy time math