timerage 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 035b3a7c7620c538f07fb2fa9f9298e5a79979b5
-  data.tar.gz: 249150193ae3f75b8164c2dcdeb1bc13cc89b6db
+  metadata.gz: 5ceefa4559c94982a16c483de5def25fecf657c0
+  data.tar.gz: 90f35a70852bc552f75e78c4af721bdcb7297838
 SHA512:
-  metadata.gz: 47841e8cd22637790b469a331317ccfc3d030f8b1aac7637245ff7d3a905419395fa385d409a40c94395fad4e12b8d99cc0cfa09977438efc483a97b58b1fd64
-  data.tar.gz: 4fe79cb39bb708bd6264b49ba3ed46d84464f0a7b1ddd27792e6388f31df1d43981b7c93154c4433d2ed61cc098566996afa100a9c0e7c1d02308a058d911417
+  metadata.gz: 02599aeffd1a812a3b0404b0f101946bdbd6fa6815dec2aa2611ed1b02f2958a0468b0adb1d03333233e7d7922aa9cd9a4958e4746636f80f0a4295b3289bc7e
+  data.tar.gz: cb0c22a9074efbce775c0b50688121981727028ca1af332ec8c2b70980fe3ad515d5733251e1a1d3924d9b2be0faa1295f3905e18dca63e522a3f2de3f72ca7d

data/lib/timerage/time_interval.rb

@@ -0,0 +1,51 @@
+require "delegate"
+
+module Timerage
+  # A range of time. The exposes the Range like interface.
+  class TimeInterval < DelegateClass(Range)
+    def initialize(*args)
+      rng = if rangeish?(args.first)
+              args.first
+            else
+              Range.new(*args)
+            end
+
+      super rng
+    end
+
+    alias_method :to_time, :begin
+
+    def step(n, &blk)
+      if block_given?
+        time_enumerator(n).each(&blk)
+      else
+        time_enumerator(n)
+      end
+    end
+
+    protected
+
+    def rangeish?(an_obj)
+      an_obj.respond_to?(:begin) &&
+        an_obj.respond_to?(:end)
+    end
+
+    def time_enumerator(step)
+      not_done = if exclude_end?
+                   ->(nxt) { nxt < self.end }
+                 else
+                   ->(nxt) { nxt <= self.end }
+                 end
+
+      Enumerator.new do |y|
+        nxt = self.begin
+
+        while not_done.call(nxt) do
+          y << nxt
+
+          nxt += step
+        end
+      end
+    end
+  end
+end

data/lib/timerage/version.rb

@@ -1,3 +1,3 @@
 module Timerage
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/timerage.rb

@@ -1,29 +1,19 @@
 require "timerage/version"
 
 module Timerage
+  autoload :TimeInterval, "timerage/time_interval"
+
   refine Range do
     def step(n, &blk)
       if self.begin.kind_of?(Time) || self.begin.kind_of?(Date)
-        if block_given?
-          time_enumerator(n).each(&blk)
-        else
-          time_enumerator(n)
-        end
+        Timerage::TimeInterval.new(self).step(n, &blk)
       else
         super
       end
     end
 
-    def time_enumerator(step)
-      Enumerator.new do |y|
-        nxt = self.begin
-
-        while nxt <= self.end do
-          y << nxt
-
-          nxt += step
-        end
-      end
+    def to_time_interval
+      Timerage::TimeInterval.new(self)
     end
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+
+require 'timerage'

data/spec/timerage/time_interval_spec.rb

@@ -0,0 +1,58 @@
+require_relative "../spec_helper"
+
+describe Timerage::TimeInterval do
+  describe "creation" do
+    specify { expect(described_class.new(now-1..now)).to be_kind_of described_class }
+    specify { expect(described_class.new(now-1, now)).to be_kind_of described_class }
+    specify { expect(described_class.new(now-1, now, true)).to be_kind_of described_class }
+    specify { expect(described_class.new(now-1, now, false )).to be_kind_of described_class }
+  end
+
+  subject(:interval) { described_class.new(now-duration, now) }
+
+  it { is_expected.to behave_like_a Range }
+  specify { expect(interval.begin).to eq now - duration }
+  specify { expect(interval.end).to eq now }
+  specify { expect(interval.to_time).to behave_like_a Time }
+  specify { expect(interval.to_time).to (be >= interval.begin)
+      .and (be <= interval.end) }
+  specify { expect{|b| interval.step(1200, &b) }
+      .to yield_control.at_least(:once) }
+
+  context "interval include end" do
+    specify { expect(interval.exclude_end?).to be false }
+    specify { expect(interval.cover? now).to be true }
+    specify { expect(interval.cover? now - duration).to be true }
+    specify { expect(interval.cover? now - (duration/2)).to be true }
+    specify { expect(interval.cover? now + 1).to be false }
+    specify { expect(interval.cover? now - (duration + 1)).to be false }
+
+    specify { expect{|b| interval.step(1200, &b) }
+        .to yield_successive_args now-duration, now-(duration-1200), now-(duration-2400), now }
+
+  end
+
+  context "interval exclude end" do
+    subject(:interval) { described_class.new(now-duration...now) }
+
+    specify { expect(interval.exclude_end?).to be true }
+    specify { expect(interval.cover? now).to be false }
+    specify { expect(interval.cover? now - duration).to be true }
+    specify { expect(interval.cover? now - (duration/2)).to be true }
+    specify { expect(interval.cover? now + 1).to be false }
+    specify { expect(interval.cover? now - (duration + 1)).to be false }
+
+    specify { expect{|b| interval.step(1200, &b) }
+        .to yield_successive_args now-duration, now-(duration-1200), now-(duration-2400) }
+
+  end
+
+  let(:now) { Time.now }
+  let(:duration) { 3600 }
+
+  matcher :behave_like_a do |expected|
+    match do |actual|
+      Set[*expected.instance_methods].subset? Set[*actual.methods]
+    end
+  end
+end

data/spec/timerage_spec.rb

@@ -0,0 +1,28 @@
+require_relative "spec_helper"
+
+describe Timerage do
+  begin
+    using Timerage
+
+    subject(:range) { Range.new(now-duration, now) }
+
+    specify { expect(range.to_time_interval).to be_kind_of Timerage::TimeInterval }
+    specify { expect{|b| range.step(1200, &b) }.to yield_control.at_least(:once) }
+
+    context "interval include end" do
+      specify { expect{|b| range.step(1200, &b) }
+          .to yield_successive_args now-duration, now-(duration-1200), now-(duration-2400), now }
+
+  end
+
+    context "interval exclude end" do
+      subject (:range) { Range.new(now-duration, now, true) }
+
+      specify { expect{|b| range.step(1200, &b) }
+          .to yield_successive_args now-duration, now-(duration-1200), now-(duration-2400) }
+    end
+
+    let(:now) { Time.now }
+    let(:duration) { 3600 }
+  end
+end

data/timerage.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ["> 3.0.0.a", "< 4"]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timerage
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Williams
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-07 00:00:00.000000000 Z
+date: 2014-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,6 +39,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.a
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.a
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 description: Simple refinement to Range to allow Time or Date as arguments
 email:
 - cschneider@comverge.com
@@ -52,7 +72,11 @@ files:
 - README.md
 - Rakefile
 - lib/timerage.rb
+- lib/timerage/time_interval.rb
 - lib/timerage/version.rb
+- spec/spec_helper.rb
+- spec/timerage/time_interval_spec.rb
+- spec/timerage_spec.rb
 - timerage.gemspec
 homepage: ''
 licenses:
@@ -78,4 +102,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Simple refinement to Range to allow Time or Date as arguments
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/timerage/time_interval_spec.rb
+- spec/timerage_spec.rb