time_math2 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35d2a3523dac20994a38d19862500ce1eae98854
-  data.tar.gz: 82b7664f95fb1879a4911886cd257c41282f9327
+  metadata.gz: f2e42b79bda1365a78f8c74b1b2d41af59f4c5c0
+  data.tar.gz: b2dcd6572c88be32bfbff1f9a3f15cda929551b9
 SHA512:
-  metadata.gz: 99dc9701481d961e93e9d803e4b943ce390bd03e55e8b23a779456094051d1fce129c5bb2a3900cf7f1d8c64f20be684839e2f1f80234c6a6c79912e78eb7954
-  data.tar.gz: 22dcc1315f78bd1d323ae9faed9b5e8ef6b39267ddd65b7c3be40cfe33b4f4ec217c79eecfc89c49c14b37ce60c92497ac49d5b5fa7b5d69a6afbd947687da8b
+  metadata.gz: 987ddc51e856db1f2f9baa77d68beb189b7a2f6193a82d5839cf11b3e4b9f989d8fe676d4539087a60bbda75e4779f90a7c8d0b706a5d2cef1c85123c8fd9f6b
+  data.tar.gz: 0d5a36c6e120c1244ae40a768b13f499455e855890a46013674464e9d6939b7797ef14aed268a05491e29e98be4249467bb112d5b29381611606be7346f4632e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # TimeMath Changelog
 
+# 0.1.0 (2017-07-30)
+
+* Update sequences logic to be, well... More logical (Thanks @kenn again for meaningful discussion!);
+* Various code cleanups.
+
 # 0.0.8 (2017-06-02)
 
 * Fix `Units::Base#measure` to correctly measure negative distances (e.g. from > to, thanks @kenn for

data/lib/time_math/resamplers.rb

@@ -2,14 +2,13 @@ module TimeMath
   # @private
   class Resampler
     class << self
-      def call(name, array_or_hash, symbol = nil, &block)
-        if array_or_hash.is_a?(Array) && array_or_hash.all?(&Util.method(:timey?))
-          ArrayResampler.new(name, array_or_hash).call
-        elsif array_or_hash.is_a?(Hash) && array_or_hash.keys.all?(&Util.method(:timey?))
-          HashResampler.new(name, array_or_hash).call(symbol, &block)
-        else
-          raise ArgumentError, "Array of timestamps or hash with timestamp keys, #{array_or_hash} got"
-        end
+      def call(unit, array_or_hash, symbol = nil, &block)
+        resampler =
+          ArrayResampler.try(unit, array_or_hash) ||
+          HashResampler.try(unit, array_or_hash) or
+          raise ArgumentError, "Expected array of timestamps or hash with timestamp keys, #{array_or_hash} got"
+
+        resampler.call(symbol, &block)
       end
     end
 
@@ -17,29 +16,30 @@ module TimeMath
       @unit = Units.get(unit)
     end
 
-    private
-
-    def sequence
-      @sequence ||= @unit.sequence(from...to, expand: true)
+    def call
+      raise NotImplementedError
     end
 
-    def from
-      timestamps.min
-    end
+    private
 
-    def to
-      @unit.next(timestamps.max)
+    def sequence
+      @sequence ||= @unit.sequence(timestamps.min..timestamps.max)
     end
   end
 
   # @private
   class ArrayResampler < Resampler
+    def self.try(unit, array)
+      return nil unless array.is_a?(Array) && array.all?(&Util.method(:timey?))
+      new(unit, array)
+    end
+
     def initialize(unit, array)
       super(unit)
       @array = array
     end
 
-    def call
+    def call(*)
       sequence.to_a
     end
 
@@ -52,6 +52,11 @@ module TimeMath
 
   # @private
   class HashResampler < Resampler
+    def self.try(unit, hash)
+      return nil unless hash.is_a?(Hash) && hash.keys.all?(&Util.method(:timey?))
+      new(unit, hash)
+    end
+
     def initialize(unit, hash)
       super(unit)
       @hash = hash

data/lib/time_math/sequence.rb

@@ -9,63 +9,49 @@ module TimeMath
   # from = Time.parse('2016-05-01 13:30')
   # to = Time.parse('2016-05-04 18:20')
   # seq = TimeMath.day.sequence(from...to)
-  # # => #<TimeMath::Sequence(2016-05-01 13:30:00 +0300...2016-05-04 18:20:00 +0300)>
+  # # => #<TimeMath::Sequence day (2016-05-01 00:00:00 +0300-2016 - 2016-05-04 00:00:00 +0300)>
   # ```
   #
   # Now, you can use it:
   #
   # ```ruby
   # seq.to_a
-  # # => [2016-05-01 13:30:00 +0300, 2016-05-02 13:30:00 +0300, 2016-05-03 13:30:00 +0300, 2016-05-04 13:30:00 +0300]
+  # # => [2016-05-01 00:00:00 +0300, 2016-05-02 00:00:00 +0300, 2016-05-03 00:00:00 +0300]
   # ```
-  # -- it's an "each day start between from and to". As you can see,
-  # the period start is the same as in `from`.
+  # -- it's an "each day start between from and to".
   #
-  # You can expand from and to to nearest round unit by {#expand} method
-  # or `:expand` option:
+  # Depending of including/excluding of range, you will, or will not receive period that includes `to`:
   #
   # ```ruby
-  # seq.expand.to_a
+  # TimeMath.day.sequence(from..to).to_a
   # # => [2016-05-01 00:00:00 +0300, 2016-05-02 00:00:00 +0300, 2016-05-03 00:00:00 +0300, 2016-05-04 00:00:00 +0300]
-  # # or:
-  # seq = TimeMath.day.sequence(from...to, expand: true)
-  # # => #<TimeMath::Sequence(2016-05-01 00:00:00 +0300...2016-05-05 00:00:00 +0300)>
-  # seq.to_a
-  # # => [2016-05-01 00:00:00 +0300, 2016-05-02 00:00:00 +0300, 2016-05-03 00:00:00 +0300, 2016-05-04 00:00:00 +0300]
-  # # ^ note that `to` is excluded.
-  # # You can include it by creating sequence from including-end range:
-  # seq = TimeMath.day.sequence(from..to, expand: true)
-  # # => #<TimeMath::Sequence(:day, 2016-05-01 00:00:00 +0300..2016-05-05 00:00:00 +0300)>
-  # seq.to_a
-  # # => [2016-05-01 00:00:00 +0300, 2016-05-02 00:00:00 +0300, 2016-05-03 00:00:00 +0300, 2016-05-04 00:00:00 +0300, 2016-05-05 00:00:00 +0300]
   # ```
   #
   # Besides each period beginning, you can also request pairs of begin/end
   # of a period, either as an array of arrays, or array of ranges:
   #
   # ```ruby
-  # seq = TimeMath.day.sequence(from...to)
   # seq.pairs
-  # # => [[2016-05-01 13:30:00 +0300, 2016-05-02 13:30:00 +0300], [2016-05-02 13:30:00 +0300, 2016-05-03 13:30:00 +0300], [2016-05-03 13:30:00 +0300, 2016-05-04 13:30:00 +0300], [2016-05-04 13:30:00 +0300, 2016-05-04 18:20:00 +0300]]
+  # # => [[2016-05-01 00:00:00 +0300, 2016-05-02 00:00:00 +0300], [2016-05-02 00:00:00 +0300, 2016-05-03 00:00:00 +0300], [2016-05-03 00:00:00 +0300, 2016-05-04 00:00:00 +0300]]
   # seq.ranges
-  # # => [2016-05-01 13:30:00 +0300...2016-05-02 13:30:00 +0300, 2016-05-02 13:30:00 +0300...2016-05-03 13:30:00 +0300, 2016-05-03 13:30:00 +0300...2016-05-04 13:30:00 +0300, 2016-05-04 13:30:00 +0300...2016-05-04 18:20:00 +0300]
+  # # => [2016-05-01 00:00:00 +0300...2016-05-02 00:00:00 +0300, 2016-05-02 00:00:00 +0300...2016-05-03 00:00:00 +0300, 2016-05-03 00:00:00 +0300...2016-05-04 00:00:00 +0300]
   # ```
   #
-  # It is pretty convenient for filtering data from databases or APIs,
-  # TimeMath creates list of filtering ranges in a blink.
+  # It is pretty convenient for filtering data from databases or APIs: TimeMath creates list of
+  # filtering ranges in a blink.
   #
   # Sequence also supports any item-updating operations in the same fashion
   # {Op} does:
   #
   # ```ruby
-  # seq = TimeMath.day.sequence(from...to, expand: true).advance(:hour, 5).decrease(:min, 20)
-  # # => #<TimeMath::Sequence(:day, 2016-05-01 00:00:00 +0300...2016-05-05 00:00:00 +0300).advance(:hour, 5).decrease(:min, 20)>
+  # seq = TimeMath.day.sequence(from...to).advance(:hour, 5).decrease(:min, 20)
+  # # => #<TimeMath::Sequence day (2016-05-01 00:00:00 +0300 - 2016-05-03 00:00:00 +0300).advance(:hour, 5).decrease(:min, 20)>
   # seq.to_a
-  # # => [2016-05-01 04:40:00 +0300, 2016-05-02 04:40:00 +0300, 2016-05-03 04:40:00 +0300, 2016-05-04 04:40:00 +0300]
+  # # => [2016-05-01 04:40:00 +0300, 2016-05-02 04:40:00 +0300, 2016-05-03 04:40:00 +0300]
   # ```
   #
   class Sequence
-    # Creates a sequence. Typically, it is easier to to it with {Units::Base#sequence},
+    # Creates a sequence. Typically, it is easier to do it with {Units::Base#sequence},
     # like this:
     #
     # ```ruby
@@ -76,23 +62,17 @@ module TimeMath
     # @param range [Range] range of time-y values (Time, Date, DateTime);
     #   note that range with inclusive and exclusive and will produce
     #   different sequences.
-    # @param options [Hash]
-    # @option options [Boolean] :expand round sequence ends on creation
-    #   (`from` is floored and `to` is ceiled);
     #
-    def initialize(unit, range, options = {})
+    def initialize(unit, range)
       @unit = Units.get(unit)
-      @from, @to, @exclude_end = process_range(range)
-      @options = options.dup
-
-      expand! if options[:expand]
+      @from, @to = process_range(range)
       @op = Op.new
     end
 
     # @private
     def initialize_copy(other)
       @unit = other.unit
-      @from, @to, @exclude_end = other.from, other.to, other.exclude_end?
+      @from, @to = other.from, other.to
       @op = other.op.dup
     end
 
@@ -106,33 +86,9 @@ module TimeMath
     def ==(other) # rubocop:disable Metrics/AbcSize
       self.class == other.class && unit == other.unit &&
         from == other.from && to == other.to &&
-        exclude_end? == other.exclude_end? &&
         op == other.op
     end
 
-    # Whether sequence was created from exclude-end range (and, therefore,
-    # will exclude `to` when converted to array).
-    def exclude_end?
-      @exclude_end
-    end
-
-    # Expand sequence ends to nearest round unit.
-    #
-    # @return [self]
-    def expand!
-      @from = unit.floor(from)
-      @to = unit.ceil(to)
-
-      self
-    end
-
-    # Creates new sequence with ends rounded to nearest unit.
-    #
-    # @return [Sequence]
-    def expand
-      dup.expand!
-    end
-
     # @method floor!(unit, span = 1)
     #   Adds {Units::Base#floor} to list of operations to apply to sequence items.
     #
@@ -239,12 +195,11 @@ module TimeMath
       return to_enum(:each) unless block_given?
 
       iter = from
-      while iter < to
+      while iter <= to
         yield(op.call(iter))
 
         iter = unit.advance(iter)
       end
-      yield(op.call(to)) unless exclude_end?
     end
 
     include Enumerable
@@ -255,7 +210,7 @@ module TimeMath
     # @return [Array<Array>]
     def pairs
       seq = to_a
-      seq.zip(seq[1..-1] + [to])
+      seq.zip([*seq[1..-1], unit.advance(to)])
     end
 
     # Creates an array of Ranges (time unit start...time unit end) between
@@ -269,16 +224,21 @@ module TimeMath
     def inspect
       ops = op.inspect_operations
       ops = '.' + ops unless ops.empty?
-      "#<#{self.class}(#{unit.name.inspect}, #{from}#{exclude_end? ? '...' : '..'}#{to})#{ops}>"
+      "#<#{self.class} #{unit.name} (#{from} - #{to})#{ops}>"
     end
 
     private
 
+    def valid_time_range?(range)
+      range.is_a?(Range) && Util.timey?(range.begin) && Util.timey?(range.end)
+    end
+
     def process_range(range)
-      range.is_a?(Range) && Util.timey?(range.begin) && Util.timey?(range.end) or
+      valid_time_range?(range) or
         raise ArgumentError, "Range of time-y values expected, #{range} got"
 
-      [range.begin, range.end, range.exclude_end?]
+      range_end = unit.floor(range.end)
+      [unit.floor(range.begin), range.exclude_end? ? unit.decrease(range_end) : range_end]
     end
   end
 end

data/lib/time_math/units/base.rb

@@ -223,20 +223,13 @@ module TimeMath
       end
 
       # Creates {Sequence} instance for producing all time units between
-      # from and too. See {Sequence} class documentation for available
-      # options and functionality.
+      # from and too. See {Sequence} class documentation for detailed functionality description.
       #
-      # @param from [Time,Date,DateTime] start of sequence;
-      # @param to [Time,Date,DateTime] upper limit of sequence;
-      # @param options [Hash]
-      # @option options [Boolean] :expand round sequence ends on creation
-      #   (from is floored and to is ceiled);
-      # @option options [Boolean] :floor sequence will be rounding'ing all
-      #   the intermediate values.
+      # @param range [Range<Time,Date,DateTime>] start and end of sequence.
       #
       # @return [Sequence]
-      def sequence(range, options = {})
-        TimeMath::Sequence.new(name, range, options)
+      def sequence(range)
+        TimeMath::Sequence.new(name, range)
       end
 
       # Converts input timestamps list to regular list of timestamps

data/lib/time_math/version.rb

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

data/time_math2.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |s|
   EOF
   s.licenses = ['MIT']
 
+  s.required_ruby_version = '>= 2.1.0'
+
   s.files = `git ls-files`.split($RS).reject do |file|
     file =~ /^(?:
     spec\/.*

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_math2
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-02 00:00:00.000000000 Z
+date: 2017-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -165,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="