time_frame 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45120e4f1dda9a59b63972c578060e6e94863907
-  data.tar.gz: 60bea2d8848eeb0fd283bd8b7d484341944cae63
+  metadata.gz: 4b1557a07374e6920452eb537ce6fdaccfcc803e
+  data.tar.gz: 21f70e14bd56943add7fc321025cc23c0c662d2d
 SHA512:
-  metadata.gz: 40e9e0a39e8a81cfe6b0c31c7d0124c7f5e8eb99a741af5d1ab1dd808e123b91afdac459801fa8de1ceb69c5c88f8e7eeea0b12a74f84e100510a0de8167914d
-  data.tar.gz: 270624b7fdde20d0f3a37cc4be3b72a4189313554fc00d851fa56f0394d675849c2d60c0817a0ccdb4cddf89cd8f0f70c8c796f4dc59c10caf4e05e1728aaa9e
+  metadata.gz: 25975d48bc929e8d07a5a93bbc3f17c1eab3067b3c7b3a36d15a978f0df7baae5506f8d94b3dddd7060e4acf52accdf7974aa15f3632f688758d34bae7d95fbe
+  data.tar.gz: b2dfd3edaa44eec8a63a08b50befe96f11906b5bd8b4248ec333a4499f3312538f4ec4f65ab9f41ee515891d52ef938b7794262941f2d6fdf08c2842e15454b2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    time_frame (0.0.0)
+    time_frame (0.0.2)
       activesupport (~> 4.0)
 
 GEM
@@ -28,7 +28,7 @@ GEM
     httpclient (2.3.4.1)
     i18n (0.6.9)
     json (1.8.1)
-    minitest (5.3.3)
+    minitest (5.3.4)
     multi_json (1.10.0)
     multipart-post (2.0.0)
     nesty (1.0.2)
@@ -40,7 +40,7 @@ GEM
     rack-protection (1.5.3)
       rack
     rainbow (2.0.0)
-    rake (10.3.1)
+    rake (10.3.2)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -55,7 +55,7 @@ GEM
       powerpack (~> 0.0.6)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.5.0)
+    ruby-progressbar (1.5.1)
     simplecov (0.8.2)
       docile (~> 1.1.0)
       multi_json

data/README.md

@@ -1,8 +1,8 @@
 # TimeFrame
 
-## Description
-
-The time frame class provides an specialized and enhanced frame for time values.
+[![Gem Version](https://badge.fury.io/rb/time_frame.svg)](http://badge.fury.io/rb/time_frame)
+[![Dependency Status](https://gemnasium.com/injixo/time_frame.svg)](https://gemnasium.com/injixo/time_frame)
+[![Code Climate](https://codeclimate.com/github/injixo/time_frame.png)](https://codeclimate.com/github/injixo/time_frame)
 
 ## Installation
 
@@ -25,6 +25,10 @@ time_frame = TimeFrame.new(min: Time.now, duration: 1.day)
 Let's play around a bit:
 
 ```ruby
+# Using pp in some samples to beautify output:
+require 'pp'
+# => true
+
 # Create a time frame instance from today with duration of 1 day
 time_frame = TimeFrame.new(min: Time.now, duration: 1.day)
 # => 2014-05-07 14:58:47 +0200..2014-05-08 14:58:47 +0200
@@ -72,22 +76,21 @@ time_frame.overlaps?(other_frame)
 
 # Time frame without another time frame:
 time_frame = TimeFrame.new(min: Time.new(2014, 5, 12), duration: 1.day)
-# => 2014-05-12 00:00:00 +0200..2014-05-13 00:00:00 +0200
 other = TimeFrame.new(min: Time.new(2014, 5, 12, 19), duration: 10.minutes)
-# => 2014-05-12 19:00:00 +0200..2014-05-12 19:10:00 +0200
-time_frame.without(other)
-# => [2014-05-12 00:00:00 +0200..2014-05-12 19:00:00 +0200, 2014-05-12 19:10:00 +0200..2014-05-13 00:00:00 +0200]
+pp time_frame.without(other)
+# [2014-05-12 00:00:00 +0200..2014-05-12 19:00:00 +0200,
+#  2014-05-12 19:10:00 +0200..2014-05-13 00:00:00 +0200]
+
+# You can also use without with many TimeFrame's:
 another = other.shift_by(15.minutes)
-# => 2014-05-12 19:15:00 +0200..2014-05-12 19:25:00 +0200
-# You can also use an array for substraction:
-time_frame.without(*[other, another])
-# => [2014-05-12 00:00:00 +0200..2014-05-12 19:00:00 +0200, 2014-05-12 19:10:00 +0200..2014-05-12 19:15:00 +0200, 2014-05-12 19:25:00 +0200..2014-05-13 00:00:00 +0200]
+pp time_frame.without(other, another)
+# [2014-05-12 00:00:00 +0200..2014-05-12 19:00:00 +0200,
+#  2014-05-12 19:10:00 +0200..2014-05-12 19:15:00 +0200,
+#  2014-05-12 19:25:00 +0200..2014-05-13 00:00:00 +0200]
 
 # Use of the mathematical &. The intersection is returned:
 time_frame = TimeFrame.new(min: Time.new(2014), duration: 1.day)
-# => 2014-01-01 00:00:00 +0100..2014-01-02 00:00:00 +0100
 other_time_frame = time_frame.shift_by(12.hours)
-# => 2014-01-01 12:00:00 +0100..2014-01-02 12:00:00 +0100
 time_frame & other_time_frame
 # => 2014-01-01 12:00:00 +0100..2014-01-02 00:00:00 +0100
 
@@ -118,3 +121,28 @@ end
 
 ## Does `TimeFrame` inherit from `Range`?
 No. Ruby's `Range` class is multi-purpose, it can hold contiuous values (like floats), as well as discrete values (like integers) and behaves differently according to their type. Instance methods like `#each` or `#size` just don't make sense for time values, the same is true for all methods provided by the `Enumerable` mixin.
+
+
+## License
+
+The [MIT License](http://opensource.org/licenses/MIT) (MIT)
+
+Copyright (c) 2014 [InVision](http://www.invision.de)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/time_frame.rb

@@ -1,6 +1,6 @@
 require 'active_support/core_ext'
 
-# avoid i18n deprecation warning
+# Avoid i18n deprecation warning
 I18n.enforce_available_locales = false
 
 require 'time_frame/time_frame_splitter'

data/lib/time_frame/time_frame.rb

@@ -1,6 +1,6 @@
-# class that models a time frame
+# The time frame class provides an specialized and enhanced range for time
+# values.
 class TimeFrame
-  include Splitter
   attr_reader :min, :max
 
   def initialize(args)
@@ -84,6 +84,10 @@ class TimeFrame
     end
   end
 
+  def split_by_interval(interval)
+    Splitter.new(self).split_by interval
+  end
+
   def self.covering_time_frame_for(time_frames)
     CoveredFrame.new(time_frames).frame
   end

data/lib/time_frame/time_frame_splitter.rb

@@ -1,10 +1,14 @@
 class TimeFrame
   # Provides a method to split a time frame by a given interval. It returns
   # an array which contains the intervals as TimeFrame instances.
-  module Splitter
-    def split_by_interval(interval)
-      time = @min
-      max = @max
+  class Splitter
+    def initialize(time_frame)
+      @time_frame = time_frame
+    end
+
+    def split_by(interval)
+      time = @time_frame.min
+      max = @time_frame.max
       time_frames = []
       until time >= max
         time_old = time

data/lib/time_frame/version.rb

@@ -1,4 +1,4 @@
 # gem version
 class TimeFrame
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_frame
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Patrick Derichs
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport