3scale_time_range 0.0.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f44bc184306146b1182c2b1453a8598193c52e8
-  data.tar.gz: 26b347ae284d20377a83dd6082f9ac2f1008518a
+  metadata.gz: f48ca9ad688668fe899b7be2cec2a53294890ace
+  data.tar.gz: 349ebce201722a0c4de5a298ef38d2a27effd07f
 SHA512:
-  metadata.gz: b55a7dba0dd5cfd701845de8b9ff69f29644b2184bc2822c72ab358ebaf5612be0afb1f150aab8150829b95632952d820aaf2fd401d2fc1a6be08aa18aa6ad1d
-  data.tar.gz: 5e44d1e22c17163c856de2468fe97bce1841195cd7c7ae918dbaf7ce68a0ec3ac76bde81de7ba36f48096d546038e575553067b4d576c0648342c06309020322
+  metadata.gz: b463ef4d67758bc596de440019620ba8d6eeaa0bb36d74a9451e03f1d215c7b6c339b6d1303b8699cc85673ec8b65ed745f0d4e7359df718ba4339cfedb787a6
+  data.tar.gz: 868c4fdd292f83014593d3550bbaff2b0d4eef14e6236251385eefaadae5d885dfffc0e78e4ac27205997837b80134d53bbb131edb4db4dd54875e675668963b

data/README.md

@@ -27,3 +27,18 @@ Enumerate by custom period
 Supports all Enumerable interface: find, select, reject, inject, etc.
 
 
+Version compatibility
+--------
+0.3.0: Public repository along with the very first RubyGems gem
+
+0.2.0: The Granulate class has been converted to a class method that returns a
+hash. Granulate was not easy to use because it returned an instance of
+'Granulate'. This prevented clients from iterating through the result.
+
+0.1.0: breaks compatibility with previous versions because it adds hours to the
+Granulate class. This means that in previous versions Granulate.rest contained
+time ranges that cannot be separated into days when granulating, but now it
+just contains ranges that cannot be separated into hours.
+
+
+

data/lib/3scale_time_range/granulate.rb

@@ -1,55 +1,58 @@
-class TimeRange
-  class Granulate
-    attr_accessor :days, :months, :years, :rest
+module Granulate
+  def self.included(base)
+    base.extend ClassMethods
+  end
 
-    def initialize(range)
-      raise 'Supports only TimeRange objects' unless range.is_a? TimeRange
+  module ClassMethods
+    GRANULARITIES = [:year, :month, :day, :hour]
 
-      @days = []
-      @years = []
-      @months = []
-      @rest = []
-      extract(range, :year)
+    def granulate(range)
+      result = { rest: [] }
+      GRANULARITIES.each do |granularity|
+        result[(granularity.to_s + 's').to_sym] = []
+      end
+      time_range = TimeRange.new(range.begin, range.end, range.exclude_end?)
+      extract(time_range, GRANULARITIES.first, result)
+      result
     end
 
     private
 
-    def extract(range, cycle)
+    def extract(range, cycle, result)
       if cycle.nil?
-        rest << range unless empty_range?(range)
+        result[:rest] << range unless empty_range?(range)
         return
       end
 
       cycle_start, cycle_end = extract_boundaries(range, cycle)
       if cycle_start && cycle_end
-        send("#{cycle}s") << TimeRange.new(cycle_start, cycle_end)
+        result[(cycle.to_s + 's').to_sym] << TimeRange.new(cycle_start, cycle_end)
 
         if range.begin < cycle_start
-          extract(
-            TimeRange.new(range.begin, (cycle_start - 1.hour).end_of_day, false),
-            next_cycle(cycle)
-          )
+          # Getting the last hour is enough because is the smallest resolution
+          # that we support. If we supported minutes, we would need to get the
+          # last minute non included.
+          last_hour_not_treated = (cycle_start - 1.hour).end_of_hour
+          extract(TimeRange.new(range.begin, last_hour_not_treated, false),
+                  next_cycle(cycle),
+                  result)
         end
+
         if range.end > cycle_end
-          extract(
-            TimeRange.new(
-              (cycle_end + 1.hour).beginning_of_day, range.end, range.exclude_end?
-            ),
-            next_cycle(cycle)
-          )
+          first_hour_not_treated = (cycle_end + 1.hour).beginning_of_hour
+          extract(TimeRange.new(first_hour_not_treated, range.end, range.exclude_end?),
+                  next_cycle(cycle),
+                  result)
         end
       else
-        extract(range, next_cycle(cycle))
+        extract(range, next_cycle(cycle), result)
       end
     end
 
     def next_cycle(current_cycle)
-      case current_cycle
-        when :year then :month
-        when :month then :day
-        when :day then nil
-        else raise "Unknown cycle: #{current_cycle.inspect}"
-      end
+      current_cycle_index = GRANULARITIES.find_index(current_cycle)
+      raise "Unknown cycle: #{current_cycle.inspect}" unless current_cycle_index
+      GRANULARITIES[current_cycle_index + 1]
     end
 
     def extract_boundaries(range, cycle)
@@ -80,6 +83,5 @@ class TimeRange
     def empty_range?(range)
       (range.begin.to_i == range.end.to_i) && range.exclude_end?
     end
-
   end
 end

data/lib/3scale_time_range/version.rb

@@ -1,3 +1,3 @@
 class TimeRange < Range
-  VERSION = "0.0.6"
+  VERSION = '0.3.0'
 end

data/lib/3scale_time_range.rb

@@ -4,6 +4,8 @@ require '3scale_time_range/granulate'
 
 class TimeRange < Range
 
+  include Granulate
+
   def initialize(start_time, end_time, exclusive = false)
     raise ArgumentError, 'start and end must act like Time' unless start_time.acts_like?(:time) && end_time.acts_like?(:time)
 
@@ -114,10 +116,6 @@ class TimeRange < Range
     "#{self.class.name}(#{super})"
   end
 
-  def granulate
-    @granulate ||= Granulate.new(self)
-  end
-
   class SimpleEnumerator
     include Enumerable
 

data/test/granulate_test.rb

@@ -4,133 +4,133 @@ require_relative '../lib/3scale_time_range'
 class GranulateTest < Minitest::Test
 
   def setup
-    @gran = TimeRange.new(
-      DateTime.parse("2012-10-09 07:23"), DateTime.parse("2014-02-05 13:45")
-    ).granulate
+    range = DateTime.parse('2012-10-09 07:23')..DateTime.parse('2014-02-05 13:45')
+    @granulated_range = TimeRange.granulate(range)
   end
 
   def test_granulates_by_year
-    assert_equal @gran.years, [
-      TimeRange.new(
-        DateTime.parse("2013-01-01").beginning_of_year,
-        DateTime.parse("2013-12-31").end_of_year)
-    ]
+    assert_equal @granulated_range[:years],
+                 [TimeRange.new(
+                     DateTime.parse('2013-01-01').beginning_of_year,
+                     DateTime.parse('2013-12-31').end_of_year)]
   end
 
   def test_granulates_by_month
-    assert_equal @gran.months, [
-        TimeRange.new(
-          DateTime.parse("2012-11-01").beginning_of_month,
-          DateTime.parse("2012-12-31").end_of_month),
-
-        TimeRange.new(
-          DateTime.parse("2014-01-01").beginning_of_month,
-          DateTime.parse("2014-01-31").end_of_month)
-      ]
+    assert_equal @granulated_range[:months],
+                 [TimeRange.new(
+                     DateTime.parse('2012-11-01').beginning_of_month,
+                     DateTime.parse('2012-12-31').end_of_month),
+                  TimeRange.new(
+                      DateTime.parse('2014-01-01').beginning_of_month,
+                      DateTime.parse('2014-01-31').end_of_month)]
   end
 
+
   def test_granulates_by_day
-    assert_equal @gran.days, [
-        TimeRange.new(
-          DateTime.parse("2012-10-10").beginning_of_day,
-          DateTime.parse("2012-10-31").end_of_day),
-
-        TimeRange.new(
-          DateTime.parse("2014-02-01").beginning_of_day,
-          DateTime.parse("2014-02-04").end_of_day)
-      ]
+    assert_equal @granulated_range[:days],
+                 [TimeRange.new(
+                     DateTime.parse('2012-10-10').beginning_of_day,
+                     DateTime.parse('2012-10-31').end_of_day),
+                  TimeRange.new(
+                      DateTime.parse('2014-02-01').beginning_of_day,
+                      DateTime.parse('2014-02-04').end_of_day)]
   end
 
-  def test_exposes_information_on_not_granulated_ranges
-    assert_equal @gran.rest, [
-        TimeRange.new(
-          DateTime.parse("2012-10-09 07:23"),
-          DateTime.parse("2012-10-09").end_of_day),
-
-        TimeRange.new(
-          DateTime.parse("2014-02-05").beginning_of_day,
-          DateTime.parse("2014-02-05 13:45"))
-      ]
+  def test_granulates_by_hour
+    assert_equal @granulated_range[:hours],
+                 [TimeRange.new(
+                     DateTime.parse('2012-10-09 08:00').beginning_of_hour,
+                     DateTime.parse('2012-10-09 23:00').end_of_hour),
+                  TimeRange.new(
+                      DateTime.parse('2014-02-05 00:00').beginning_of_hour,
+                      DateTime.parse('2014-02-05 12:00').end_of_hour)]
   end
 
-  def test_works_also_for_short_ranges
-    @gran = TimeRange.new(
-      DateTime.parse("2012-10-09 07:23"), DateTime.parse("2012-10-09 13:45")
-    ).granulate
-
-    assert_equal @gran.rest, [
-        TimeRange.new(
-          DateTime.parse("2012-10-09 07:23"),
-          DateTime.parse("2012-10-09 13:45"))
-      ]
+  def test_exposes_information_on_not_granulated_ranges
+    assert_equal @granulated_range[:rest],
+                 [TimeRange.new(
+                     DateTime.parse('2012-10-09 07:23'),
+                     DateTime.parse('2012-10-09 07:00').end_of_hour),
+                  TimeRange.new(
+                      DateTime.parse('2014-02-05 13:45').beginning_of_hour,
+                      DateTime.parse('2014-02-05 13:45'))]
   end
 
-  def test_granulation_is_cached_in_time_range
-    range = TimeRange.new(
-      DateTime.parse("2012-10-09 07:23"), DateTime.parse("2012-10-09 13:45")
-    )
+  def test_range_that_cannot_be_granulated
+    granulated_range = TimeRange.granulate(
+        DateTime.parse('2012-10-09 07:23')..DateTime.parse('2012-10-09 07:45'))
 
-    assert_equal range.granulate.object_id, range.granulate.object_id
+    assert_equal granulated_range[:rest],
+                 [TimeRange.new(
+                     DateTime.parse('2012-10-09 07:23'),
+                     DateTime.parse('2012-10-09 07:45'))]
   end
 
   def test_properly_parses_open_ended_ranges_1
-    gran = (DateTime.parse("2011-01-01")...DateTime.parse("2012-01-01")).
-      to_time_range.granulate
+    granulated_range = TimeRange.granulate(
+        DateTime.parse('2011-01-01')...DateTime.parse('2012-01-01'))
 
-    assert_equal 1, gran.years.size
-    assert_equal 0, gran.months.size
-    assert_equal 0, gran.days.size
-    assert_equal 0, gran.rest.size
+    assert_equal 1, granulated_range[:years].size
+    assert_equal 0, granulated_range[:months].size
+    assert_equal 0, granulated_range[:days].size
+    assert_equal 0, granulated_range[:hours].size
+    assert_equal 0, granulated_range[:rest].size
 
-    refute gran.years.first.exclude_end?
+    refute granulated_range[:years].first.exclude_end?
   end
 
   def test_properly_parses_open_ended_ranges_2
-    gran = (DateTime.parse("2011-01-01")...DateTime.parse("2011-12-31").end_of_year).
-      to_time_range.granulate
-
-    assert_equal 0, gran.years.size
-    assert_equal 1, gran.months.size
-    assert_equal 1, gran.days.size
-    assert_equal 1, gran.rest.size
-
-    refute gran.months.first.exclude_end?
-    refute gran.days.first.exclude_end?
-    assert gran.rest.first.exclude_end?
+    granulated_range = TimeRange.granulate(
+        DateTime.parse('2011-01-01')...DateTime.parse('2011-12-31').end_of_year)
+
+    assert_equal 0, granulated_range[:years].size
+    assert_equal 1, granulated_range[:months].size
+    assert_equal 1, granulated_range[:days].size
+    assert_equal 1, granulated_range[:hours].size
+    assert_equal 1, granulated_range[:rest].size
+
+    refute granulated_range[:hours].first.exclude_end?
+    refute granulated_range[:months].first.exclude_end?
+    refute granulated_range[:days].first.exclude_end?
+    assert granulated_range[:rest].first.exclude_end?
   end
 
   def test_properly_parses_close_ended_ranges_1
-    gran = (DateTime.parse("2011-01-01")..DateTime.parse("2012-01-01")).
-      to_time_range.granulate
+    granulated_range = TimeRange.granulate(
+        DateTime.parse('2011-01-01')..DateTime.parse('2012-01-01'))
 
-    assert_equal 1, gran.years.size
-    assert_equal 0, gran.months.size
-    assert_equal 0, gran.days.size
-    assert_equal 1, gran.rest.size
+    assert_equal 1, granulated_range[:years].size
+    assert_equal 0, granulated_range[:months].size
+    assert_equal 0, granulated_range[:days].size
+    assert_equal 0, granulated_range[:hours].size
+    assert_equal 1, granulated_range[:rest].size
 
-    refute gran.rest.first.exclude_end?
+    refute granulated_range[:rest].first.exclude_end?
   end
 
   def test_properly_parses_close_ended_ranges_2
-    gran = (DateTime.parse("2011-01-01")..DateTime.parse("2011-12-31").end_of_year).
-      to_time_range.granulate
+    granulated_range = TimeRange.granulate(
+        DateTime.parse('2011-01-01')..DateTime.parse('2011-12-31').end_of_year)
 
-    assert_equal 1, gran.years.size
-    assert_equal 0, gran.months.size
-    assert_equal 0, gran.days.size
-    assert_equal 0, gran.rest.size
+    assert_equal 1, granulated_range[:years].size
+    assert_equal 0, granulated_range[:months].size
+    assert_equal 0, granulated_range[:days].size
+    assert_equal 0, granulated_range[:hours].size
+    assert_equal 0, granulated_range[:rest].size
 
-    refute gran.years.first.exclude_end?
+    refute granulated_range[:years].first.exclude_end?
   end
 
   def test_properly_handles_Time_UTC_ends_of_months
     d = DateTime.parse('2010-01-01')
-    gran = (d.beginning_of_month.to_time.utc..d.end_of_month.to_time.utc).to_time_range.granulate
-
-    assert_equal 0, gran.years.size
-    assert_equal 1, gran.months.size
-    assert_equal 0, gran.days.size
-    assert_equal 0, gran.rest.size
+    granulated_range = TimeRange.granulate(
+        d.beginning_of_month.to_time.utc..d.end_of_month.to_time.utc)
+
+    assert_equal 0, granulated_range[:years].size
+    assert_equal 1, granulated_range[:months].size
+    assert_equal 0, granulated_range[:days].size
+    assert_equal 0, granulated_range[:hours].size
+    assert_equal 0, granulated_range[:rest].size
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_time_range
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Wojciech Ogrodowczyk