3scale_time_range 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f44bc184306146b1182c2b1453a8598193c52e8
+  data.tar.gz: 26b347ae284d20377a83dd6082f9ac2f1008518a
+SHA512:
+  metadata.gz: b55a7dba0dd5cfd701845de8b9ff69f29644b2184bc2822c72ab358ebaf5612be0afb1f150aab8150829b95632952d820aaf2fd401d2fc1a6be08aa18aa6ad1d
+  data.tar.gz: 5e44d1e22c17163c856de2468fe97bce1841195cd7c7ae918dbaf7ce68a0ec3ac76bde81de7ba36f48096d546038e575553067b4d576c0648342c06309020322

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/3scale_time_range.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require '3scale_time_range/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "3scale_time_range"
+  spec.version       = TimeRange::VERSION
+  spec.authors       = ["Wojciech Ogrodowczyk", "Alejandro Martinez Ruiz", "Michal Macejko", "Michal Cichra", "David Ortiz Lopez"]
+  spec.email         = ["wojciech@haikuco.de", "amr@redhat.com", "mmacejko@redhat.com", "mcichra@redhat.com", "dortiz@redhat.com"]
+  spec.summary       = %q{Utility class for ranges of times (time periods).}
+  spec.description   = %q{Utility class for ranges of times (time periods). It's like Range, but has additional enumeration capabilities.}
+  spec.homepage      = "https://github.com/3scale/3scale_time_range"
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", ">= 3.2.19"
+
+  spec.add_development_dependency "bundler", ">= 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4.0"
+  spec.add_development_dependency "geminabox", "~> 0.12.4"
+end

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'pry'
+  gem 'pry-doc'
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,14 @@
+   3scale time range
+   Copyright (c) 2017 Red Hat Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,29 @@
+Utility class for ranges of times (time periods). It's like Range, but has
+additional enumeration capabilities. See examples for the tasty stuff.
+
+Examples
+--------
+
+    period = TimeRange.new(1.year.ago, Time.now)
+
+Enumerate by days
+
+    period.each(:day) { |time| puts time }
+
+Enumerate by weeks
+
+    period.each(:week) { |time| puts time }
+
+(also years, months, hours, minutes and seconds)
+
+Enumerate by custom period
+
+    period.each(42.seconds) { |time| puts time }
+
++each+ Returns Enumerator object, so this is also possible (extra yummy):
+
+    period.each(:month).map { |time| time.strftime('%B') }
+
+Supports all Enumerable interface: find, select, reject, inject, etc.
+
+

data/Rakefile

@@ -0,0 +1,15 @@
+ENV['gem_push'] = 'false'
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+desc 'Release and push the gem to geminabox'
+task 'geminabox' do
+  Rake::Task['build'].invoke
+  Rake::Task['release'].invoke
+  system('gem inabox')
+end

data/lib/3scale_time_range/granulate.rb

@@ -0,0 +1,85 @@
+class TimeRange
+  class Granulate
+    attr_accessor :days, :months, :years, :rest
+
+    def initialize(range)
+      raise 'Supports only TimeRange objects' unless range.is_a? TimeRange
+
+      @days = []
+      @years = []
+      @months = []
+      @rest = []
+      extract(range, :year)
+    end
+
+    private
+
+    def extract(range, cycle)
+      if cycle.nil?
+        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)
+
+        if range.begin < cycle_start
+          extract(
+            TimeRange.new(range.begin, (cycle_start - 1.hour).end_of_day, false),
+            next_cycle(cycle)
+          )
+        end
+        if range.end > cycle_end
+          extract(
+            TimeRange.new(
+              (cycle_end + 1.hour).beginning_of_day, range.end, range.exclude_end?
+            ),
+            next_cycle(cycle)
+          )
+        end
+      else
+        extract(range, next_cycle(cycle))
+      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
+    end
+
+    def extract_boundaries(range, cycle)
+      result = []
+      range.each(cycle) do |date|
+        if included_in_range?(range, date.send("beginning_of_#{cycle}")) &&
+            included_in_range?(range, date.send("end_of_#{cycle}"))
+          result << date
+        end
+      end
+      if result.empty?
+        return nil, nil
+      else
+        return result.first.send("beginning_of_#{cycle}"),
+          result.last.send("end_of_#{cycle}")
+      end
+    end
+
+    # TODO: Can be refactored to TimeRange#include?
+    # Refactoring requires investigation into TimeRange use in System.
+    def included_in_range?(range, value)
+      (range.begin <= value) &&
+        (value < range.end || (value.to_i == range.end.to_i && !range.exclude_end?))
+    end
+
+    # TODO: Can be refactored to TimeRange#empty?
+    # Refactoring requires investigation into TimeRange use in System.
+    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

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

data/lib/3scale_time_range.rb

@@ -0,0 +1,190 @@
+require 'active_support/time'
+require '3scale_time_range/version'
+require '3scale_time_range/granulate'
+
+class TimeRange < Range
+
+  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)
+
+    super
+  end
+
+  WEEKDAYS = {:monday    => 0,
+              :tuesday   => 1,
+              :wednesday => 2,
+              :thursday  => 3,
+              :friday    => 4,
+              :saturday  => 5,
+              :sunday    => 6}
+
+  def each(step = nil, &block)
+    if step
+      enumerator = if WEEKDAYS[step]
+                     WeekdayEnumerator
+                   elsif step == :end_of_month # the simple enumerator already works for the beginning, every month has a 1st
+                     MonthEnumerator
+                   else
+                     SimpleEnumerator
+                   end.new(self, step)
+
+      enumerator.each(&block) if block_given?
+      enumerator
+    else
+      super(&block)
+    end
+  end
+
+  # Shifts the time range to given timezone via Time#in_time_zone method.
+  def in_time_zone(timezone)
+    TimeRange.new(self.begin.in_time_zone(timezone), self.end.in_time_zone(timezone))
+  end
+
+  def +(interval)
+    # TODO - check it
+    # raise ArgumentError.new('Only Fixnum is allowed') unless Fixnum === interval
+    TimeRange.new(self.begin + interval, self.end + interval)
+  end
+
+  def -(interval)
+    self + (-interval)
+  end
+
+  def utc
+    self.in_time_zone('UTC')
+  end
+
+  # TODO: TimeRange should check if both 'begin' and 'end' are in
+  # the same timezone?
+  def zone
+    assert_time_with_zone
+    self.begin.zone
+  end
+
+  def utc_offset
+    assert_time_with_zone
+    self.begin.utc_offset
+  end
+
+  def shift_in_hours
+    self.utc_offset / 3600
+  end
+
+
+  def assert_time_with_zone
+    raise TypeError.new('Has to be TimeWithZone') unless ActiveSupport::TimeWithZone === self.begin
+  end
+
+  private :assert_time_with_zone
+
+  def length
+    self.end - self.begin
+  end
+
+  # "round" range, so it starts at the beginning of the cycle and end at it's end.
+  # TODO: maybe round is not the best name for this method.
+  def round(cycle)
+    self.class.new(self.begin.beginning_of_cycle(cycle),
+                   self.end.end_of_cycle(cycle))
+  end
+
+  # Previous time range, that is, a range with the same length as this range, but which
+  # ends when this range starts. Excludes the last element.
+  def previous
+    self.class.new(self.begin - length, self.begin, true)
+  end
+
+  def to_time_range
+    self
+  end
+
+  def to_s
+    "#{self.begin.strftime("%B %e, %Y (%k:%M)")} - #{self.end.strftime("%B %e, %Y (%k:%M)")}"
+  end
+
+ # Does this range cover a whole month?
+  def month?
+    self.begin.year == self.end.year &&
+    self.begin.month == self.end.month &&
+    self.begin == self.begin.beginning_of_month &&
+    self.end == self.end.end_of_month
+  end
+
+  def inspect
+    "#{self.class.name}(#{super})"
+  end
+
+  def granulate
+    @granulate ||= Granulate.new(self)
+  end
+
+  class SimpleEnumerator
+    include Enumerable
+
+    def initialize(range, step)
+      @range, @step = range, step.is_a?(Symbol) ? 1.send(step) : step
+    end
+
+    def each
+      current = @range.begin
+      last = @range.end
+      last -= @step if @range.exclude_end?
+
+      while current.to_i <= last.to_i
+        yield(current)
+        current += @step
+      end
+
+      self
+    end
+  end
+
+  class WeekdayEnumerator
+    include Enumerable
+
+    def initialize(range, weekday)
+      @range, @offset = range, WEEKDAYS[weekday].days
+    end
+
+    def each
+      current = @range.begin.beginning_of_week + @offset
+      current = current + 1.week if current < @range.begin
+      last    = @range.end
+
+      while current <= last
+        yield(current)
+        current += 1.week
+      end
+
+      self
+    end
+  end
+
+  class MonthEnumerator
+    include Enumerable
+
+    def initialize(range, step)
+      @range = range
+    end
+
+    def each
+      current = @range.begin
+      last = @range.end
+      last -= 1.month if @range.exclude_end?
+
+      while current <= last
+        yield(current)
+        current = (current + 1.month).end_of_month
+      end
+
+      self
+    end
+  end
+end
+
+class Range
+  def to_time_range
+    TimeRange.new(self.begin, self.end, self.exclude_end?)
+  end
+end
+

data/test/granulate_test.rb

@@ -0,0 +1,137 @@
+require 'minitest/autorun'
+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
+  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)
+    ]
+  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)
+      ]
+  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)
+      ]
+  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"))
+      ]
+  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"))
+      ]
+  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")
+    )
+
+    assert_equal range.granulate.object_id, range.granulate.object_id
+  end
+
+  def test_properly_parses_open_ended_ranges_1
+    gran = (DateTime.parse("2011-01-01")...DateTime.parse("2012-01-01")).
+      to_time_range.granulate
+
+    assert_equal 1, gran.years.size
+    assert_equal 0, gran.months.size
+    assert_equal 0, gran.days.size
+    assert_equal 0, gran.rest.size
+
+    refute gran.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?
+  end
+
+  def test_properly_parses_close_ended_ranges_1
+    gran = (DateTime.parse("2011-01-01")..DateTime.parse("2012-01-01")).
+      to_time_range.granulate
+
+    assert_equal 1, gran.years.size
+    assert_equal 0, gran.months.size
+    assert_equal 0, gran.days.size
+    assert_equal 1, gran.rest.size
+
+    refute gran.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
+
+    assert_equal 1, gran.years.size
+    assert_equal 0, gran.months.size
+    assert_equal 0, gran.days.size
+    assert_equal 0, gran.rest.size
+
+    refute gran.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
+  end
+
+end
+

data/test/time_range_test.rb

@@ -0,0 +1,103 @@
+require 'minitest/autorun'
+require_relative '../lib/3scale_time_range'
+
+class TimeRangeTest < Minitest::Test
+
+  def test_is_creatable_only_from_Times
+    assert_raises(ArgumentError) { TimeRange.new(:foo, :bar) }
+    assert_raises(ArgumentError) { TimeRange.new(400, 700) }
+  end
+
+  def test_converts_from_Range_only_if_extremes_are_Time_instances
+    assert_raises(ArgumentError) { (100..300).to_time_range }
+    assert_instance_of TimeRange, (Time.local(2009, 3, 2)..Time.local(2009, 3, 11)).to_time_range
+  end
+
+  def test_enumerates_with_symbol
+    stuff = []
+    period = (Time.local(2009, 3, 2)..Time.local(2009, 3, 4)).to_time_range
+
+    period.each(:day) { |time| stuff << time }
+
+    assert_equal [Time.local(2009, 3, 2), Time.local(2009, 3, 3), Time.local(2009, 3, 4)],
+                 stuff
+  end
+
+  def test_enumerates_with_custom_step
+    stuff = []
+    period = (Time.local(2009, 3, 2)..Time.local(2009, 3, 3)).to_time_range
+
+    period.each(12.hours) { |time| stuff << time }
+
+    assert_equal [Time.local(2009, 3, 2, 00, 00), Time.local(2009, 3, 2, 12, 00), Time.local(2009, 3, 3, 00, 00)], stuff
+  end
+
+  def test_returns_enumerator_on_each
+    period = (Time.local(2009, 3, 2)..Time.local(2009, 3, 3)).to_time_range
+    days = period.each(:day).map { |time| time }
+
+    assert_equal [Time.local(2009, 3, 2), Time.local(2009, 3, 3)], days
+  end
+
+  def test_excludes_end_if_exclusive
+    period = TimeRange.new(Time.local(2009, 3, 2), Time.local(2009, 3, 4), true)
+    days = period.each(:day).map { |time| time }
+
+    assert_equal [Time.local(2009, 3, 2), Time.local(2009, 3, 3)], days
+  end
+
+  def test_enumerates_with_weekday
+    period = (Time.local(2009, 11, 1)..Time.local(2009, 11, 30)).to_time_range
+
+    assert_equal [Time.local(2009, 11,  2),
+                  Time.local(2009, 11,  9),
+                  Time.local(2009, 11, 16),
+                  Time.local(2009, 11, 23),
+                  Time.local(2009, 11, 30)], period.each(:monday).to_a
+
+    assert_equal [Time.local(2009, 11,  3),
+                  Time.local(2009, 11, 10),
+                  Time.local(2009, 11, 17),
+                  Time.local(2009, 11, 24)], period.each(:tuesday).to_a
+  end
+
+  def test_previous
+    range    = TimeRange.new(Time.local(2009, 3, 2, 11, 33), Time.local(2009, 3, 2, 12, 33))
+    expected = TimeRange.new(Time.local(2009, 3, 2, 10, 33), Time.local(2009, 3, 2, 11, 33), true)
+
+    assert_equal expected, range.previous
+  end
+
+  def test_add_and_or_substract_interval
+    range    = TimeRange.new(Time.local(2009, 3, 2, 11, 00), Time.local(2009, 3, 2, 12, 00))
+    expected = TimeRange.new(Time.local(2009, 3, 2, 13, 00), Time.local(2009, 3, 2, 14, 00))
+    assert_equal expected, range + 2.hours
+    assert_equal range, (range + 2.hours) - 2.hours
+  end
+
+  def test_month_returns_true_if_the_range_is_whole_month
+    time  = Time.local(2010, 11, 1)
+    range = TimeRange.new(time.beginning_of_month, time.end_of_month)
+
+    assert range.month?
+  end
+
+  def test_month_return_fals_if_the_range_is_not_whole_month
+    range = TimeRange.new(Time.local(2010, 11, 6), Time.local(2010, 11, 17))
+
+    assert !range.month?
+  end
+
+  def test_month_returns_false_if_the_begin_and_end_are_in_different_months
+    range = TimeRange.new(Time.local(2010, 10, 1), Time.local(2010, 11, 30).end_of_month)
+
+    assert !range.month?
+  end
+
+  def test_month_returns_false_if_the_begin_and_end_are_in_the_same_month_but_different_years
+    range = TimeRange.new(Time.local(2010, 11, 1), Time.local(2011, 11, 30).end_of_month)
+
+    assert !range.month?
+  end
+end
+

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: 3scale_time_range
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Wojciech Ogrodowczyk
+- Alejandro Martinez Ruiz
+- Michal Macejko
+- Michal Cichra
+- David Ortiz Lopez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.19
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.19
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+- !ruby/object:Gem::Dependency
+  name: geminabox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.4
+description: Utility class for ranges of times (time periods). It's like Range, but
+  has additional enumeration capabilities.
+email:
+- wojciech@haikuco.de
+- amr@redhat.com
+- mmacejko@redhat.com
+- mcichra@redhat.com
+- dortiz@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- 3scale_time_range.gemspec
+- Gemfile
+- LICENSE
+- NOTICE
+- README.md
+- Rakefile
+- lib/3scale_time_range.rb
+- lib/3scale_time_range/granulate.rb
+- lib/3scale_time_range/version.rb
+- test/granulate_test.rb
+- test/time_range_test.rb
+homepage: https://github.com/3scale/3scale_time_range
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Utility class for ranges of times (time periods).
+test_files:
+- test/granulate_test.rb
+- test/time_range_test.rb
+has_rdoc: