time_boots 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d915342173e04dfa56b06a071ce00895bfd1f7c
-  data.tar.gz: 224f704b9f2252a6d1915416972e935bb271ee0a
+  metadata.gz: bad3cf47e90daa9c45c5a0cae35d295cd0cf3100
+  data.tar.gz: c79c616cde97bc0e82e9517241ef30d311ce7135
 SHA512:
-  metadata.gz: 75392ebf3e012f77a133ac50cc79bb18e510289574148fc47279c89a8df64264000c1a47e532c212bd1d6b8962a4a3d58c9da270a869372285a715efdd424e04
-  data.tar.gz: 3ab029a28565166df7c4581f447e0a0a127d4eaec7e6024391bcd39374fff88398ef6f7dac61058b45e8d68674a762612867686405bf000b9c3ec4f01d47faf1
+  metadata.gz: 5d1eb2eb38316109d7c68219a2f9c4ef0701faa3b9bf3594edb1e539bf9b1a5573942760806339b553fff32d4c278004f4f307e032340f255a0e9bc470e77ccb
+  data.tar.gz: 2759571a3d4974b33f8e9a7a43aeb50505715f7ca04668e221b370da9020a1f7916ce2f9706f1e5b2233b5afecb7aba22a0ecba3b964ba304691d59e9c49c868

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# TimeBoots changelog
+
+# 0.0.2 (2016-05-27)
+
+* Add support for `DateTime`.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-15 Victor 'Zverok' Shepelev
+
+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/README.md

@@ -1,15 +1,28 @@
 # Time Boots
 
+[![Gem Version](https://badge.fury.io/rb/time_boots.svg)](http://badge.fury.io/rb/time_boots)
 [![Dependency Status](https://gemnasium.com/zverok/time_boots.svg)](https://gemnasium.com/zverok/time_boots)
 [![Code Climate](https://codeclimate.com/github/zverok/time_boots/badges/gpa.svg)](https://codeclimate.com/github/zverok/time_boots)
 [![Build Status](https://travis-ci.org/zverok/time_boots.svg?branch=master)](https://travis-ci.org/zverok/time_boots)
 [![Coverage Status](https://coveralls.io/repos/zverok/time_boots/badge.svg?branch=master)](https://coveralls.io/r/zverok/time_boots?branch=master)
 
-**TimeBoots** is a small, no-dependencies library attemting to make time
+**TimeBoots** is a small, no-dependencies library attempting to make time
 steps easier. It provides you with simple, easy-to-remember API, without
 any monkey-patching of core Ruby classes, so it can be used alongside
 Rails or without it, for any purpose.
 
+Install it like always:
+
+```
+gem install time_boots
+```
+
+or add to your Gemfile
+
+```
+gem 'time_boots'
+```
+
 ## Simple time math
 
 ### Floor, ceil and round:
@@ -33,7 +46,7 @@ TimeBoots.month.floor(tm)
 
 TimeBoots.month.ceil(tm)
 # => 2015-04-01 00:00:00 +0300
-# Note the timezone change: our (Ukraine) DST was in March,
+# Note the UTC offset change: our (Ukraine) DST was in March,
 # and TimeBoots plays perfectly well with it.
 
 TimeBoots.month.round(tm)
@@ -81,9 +94,9 @@ jump.after(tm)
 
 ```ruby
 TimeBoots.hour.range(tm, 5)
-# => 2015-03-05 10:08:00 +0200...2015-03-05 15:08:00 +0200 
+# => 2015-03-05 10:08:00 +0200...2015-03-05 15:08:00 +0200
 TimeBoots.hour.range_back(tm, 5)
-# => 2015-03-05 05:08:00 +0200...2015-03-05 10:08:00 +0200 
+# => 2015-03-05 05:08:00 +0200...2015-03-05 10:08:00 +0200
 ```
 
 ## Measuring time periods
@@ -111,7 +124,7 @@ puts "%{years}y %{months}m %{weeks}w %{days}d %{hours}h %{minutes}m %{seconds}s"
 
 # Option: measure without weeks
 TimeBoots.measure(birthday, Time.now, weeks: false)
-# => {:years=>32, :months=>2, :days=>17, :hours=>7, :minutes=>5, :seconds=>11} 
+# => {:years=>32, :months=>2, :days=>17, :hours=>7, :minutes=>5, :seconds=>11}
 
 # My full age in days, hours, minutes
 TimeBoots.measure(birthday, Time.now, max_step: :day)
@@ -212,3 +225,9 @@ And there are some plans for the future:
 * optional `core_ext`, providing methods like `4.months.ago` for the
   (Rails-less) rest of us;
 * your ideas?..
+
+## Alternatives
+
+There's pretty small and useful [AS::Duration](https://github.com/janko-m/as-duration)
+by Janko Marohnić, which is time durations, extracted from ActiveSupport,
+but without any ActiveSupport bloat.

data/lib/time_boots.rb

@@ -5,7 +5,7 @@ module TimeBoots
   # rubocop:disable Style/ModuleFunction
   extend self
   # rubocop:enable Style/ModuleFunction
-  
+
   def steps
     Boot.steps
   end
@@ -13,7 +13,7 @@ module TimeBoots
   # NB: no fancy meta-programming here: we want YARD to be happy
 
   # Boot shortcuts
-  
+
   def sec
     Boot.get(:sec)
   end
@@ -43,7 +43,7 @@ module TimeBoots
   end
 
   # Boot-less method shortcuts
-
+  # :nocov:
   def floor(step, tm)
     Boot.get(step).floor(tm)
   end
@@ -87,6 +87,7 @@ module TimeBoots
   def lace(step, from, to, options = {})
     Boot.get(step).lace(from, to, options)
   end
+  # :nocov:
 end
 
 require_relative './time_boots/boot'

data/lib/time_boots/boot.rb

@@ -14,8 +14,8 @@ module TimeBoots
                     tm.hour,
                     tm.min,
                     tm.sec].first(step_idx + 1)
-        
-      Time.new(*components)
+
+      new_from_components(tm, *components)
     end
 
     def ceil(tm)
@@ -53,7 +53,7 @@ module TimeBoots
     end
 
     def measure(_from, _to)
-      fail NotImplementedError, '#measure should be implemented in subclasses'
+      raise NotImplementedError, '#measure should be implemented in subclasses'
     end
 
     def measure_rem(from, to)
@@ -70,25 +70,38 @@ module TimeBoots
     end
 
     protected
-    
-    NATURAL_STEPS = [:year, :month, :day, :hour, :min, :sec]
+
+    NATURAL_STEPS = [:year, :month, :day, :hour, :min, :sec].freeze
+    DEFAULT_STEP_VALUES = [nil, 1, 1, 0, 0, 0].freeze
 
     def step_idx
       NATURAL_STEPS.index(step) or
-        fail(NotImplementedError, "Can not be used for step #{step}")
+        raise NotImplementedError, "Can not be used for step #{step}"
     end
 
     def generate(tm, replacements = {})
-      hash_to_tm(tm_to_hash(tm).merge(replacements))
+      hash_to_tm(tm, tm_to_hash(tm).merge(replacements))
     end
 
     def tm_to_hash(tm)
-      Hash[*NATURAL_STEPS.flat_map{|s| [s, tm.send(s)]}]
+      Hash[*NATURAL_STEPS.flat_map { |s| [s, tm.send(s)] }]
     end
 
-    def hash_to_tm(hash)
-      components = NATURAL_STEPS.map{|s| hash[s] || 0}
-      Time.new(*components)
+    def hash_to_tm(origin, hash)
+      components = NATURAL_STEPS.map { |s| hash[s] || 0 }
+      new_from_components(origin, *components)
+    end
+
+    def new_from_components(origin, *components)
+      components = DEFAULT_STEP_VALUES.zip(components).map { |d, c| c || d }
+      case origin
+      when Time
+        Time.mktime(*components.reverse, nil, nil, nil, origin.zone)
+      when DateTime
+        DateTime.new(*components, origin.zone)
+      else
+        raise ArgumentError, "Expected Time or DateTime, got #{origin.class}"
+      end
     end
 
     include TimeBoots # now we can use something like #day inside boots
@@ -98,21 +111,21 @@ module TimeBoots
     require_relative 'boot/week'
     require_relative 'boot/month'
     require_relative 'boot/year'
-  
+
     BOOTS = {
       sec: SecBoot.new, min: MinBoot.new, hour: HourBoot.new,
       day: DayBoot.new, week: WeekBoot.new, month: MonthBoot.new,
       year: YearBoot.new
-    }
+    }.freeze
 
     class << self
       def steps
         BOOTS.keys
       end
-      
+
       def get(step)
         BOOTS[step] or
-          fail(ArgumentError, "Unsupported step: #{step}")
+          raise ArgumentError, "Unsupported step: #{step}"
       end
     end
   end

data/lib/time_boots/boot/day.rb

@@ -16,6 +16,8 @@ module TimeBoots
     end
 
     def fix_dst(res, src)
+      return res unless res.is_a?(Time)
+
       if res.dst? && !src.dst?
         hour.decrease(res)
       elsif !res.dst? && src.dst?

data/lib/time_boots/boot/month.rb

@@ -29,11 +29,11 @@ module TimeBoots
     end
 
     def _advance(tm, steps)
-      steps.times.inject(tm){|t| succ(t)}
+      steps.times.inject(tm) { |t| succ(t) }
     end
 
     def _decrease(tm, steps)
-      steps.times.inject(tm){|t| prev(t)}
+      steps.times.inject(tm) { |t| prev(t) }
     end
 
     # fix for too far advance/insufficient decrease:

data/lib/time_boots/boot/simple.rb

@@ -6,20 +6,31 @@ module TimeBoots
     end
 
     def measure(from, to)
-      ((to - from) / to_seconds).to_i
+      ((to.to_time - from.to_time) / to_seconds).to_i
     end
 
     protected
 
     def _advance(tm, steps)
-      tm + to_seconds(steps)
+      _shift(tm, to_seconds(steps))
     end
 
     def _decrease(tm, steps)
-      tm - to_seconds(steps)
+      _shift(tm, -to_seconds(steps))
     end
 
-    MULTIPLIERS = [12, 30, 24, 60, 60, 1]
+    def _shift(tm, seconds)
+      case tm
+      when Time
+        tm + seconds
+      when DateTime
+        tm + Rational(seconds, 86_400)
+      else
+        raise ArgumentError, "Expected Time or DateTime, got #{origin.class}"
+      end
+    end
+
+    MULTIPLIERS = [12, 30, 24, 60, 60, 1].freeze
   end
 
   class SecBoot < SimpleBoot

data/lib/time_boots/boot/year.rb

@@ -14,7 +14,7 @@ module TimeBoots
     end
 
     protected
-    
+
     def _advance(tm, steps)
       generate(tm, year: tm.year + steps)
     end

data/lib/time_boots/jump.rb

@@ -16,8 +16,8 @@ module TimeBoots
       @boot.advance(tm, amount)
     end
 
-    alias_method :ago, :before 
-    alias_method :from, :after
+    alias ago before
+    alias from after
 
     def ==(other)
       step == other.step && amount == other.amount

data/lib/time_boots/lace.rb

@@ -14,7 +14,7 @@ module TimeBoots
     def expand!
       @from = boot.floor(from)
       @to = boot.ceil(to)
-      
+
       self
     end
 
@@ -31,7 +31,7 @@ module TimeBoots
 
         iter = cond_floor(boot.advance(iter), beginnings)
       end
-      
+
       seq
     end
 
@@ -41,7 +41,7 @@ module TimeBoots
     end
 
     def pull_ranges(beginnings = false)
-      pull_pairs(beginnings).map{|b, e| (b...e)}
+      pull_pairs(beginnings).map { |b, e| (b...e) }
     end
 
     def inspect
@@ -53,7 +53,7 @@ module TimeBoots
     def cond_floor(tm, should_floor)
       should_floor ? boot.floor(tm) : tm
     end
-    
+
     attr_reader :boot
   end
 end

data/lib/time_boots/measure.rb

@@ -9,8 +9,8 @@ module TimeBoots
       hour: :hours,
       min: :minutes,
       sec: :seconds
-    }
-    
+    }.freeze
+
     def self.measure(from, to, options = {})
       select_steps(options).reverse.inject({}) do |res, step|
         span, from = Boot.get(step).measure_rem(from, to)

data/lib/time_boots/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module TimeBoots
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'.freeze
 end

data/time_boots.gemspec

@@ -29,8 +29,10 @@ Gem::Specification.new do |s|
   end
   s.require_paths = ["lib"]
 
-  s.add_development_dependency 'rubocop', '~> 0.30'
-  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'rubocop', '>= 0.30'
+  s.add_development_dependency 'rspec', '>= 3'
   s.add_development_dependency 'rspec-its', '~> 1'
   s.add_development_dependency 'simplecov', '~> 0.9'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubygems-tasks'
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: time_boots
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2016-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.30'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
       TimeBoots is small, no-dependencies library attemting to make time
       steps easier. It provides you with simple, easy remembered API, without
@@ -76,6 +104,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
 - README.md
 - lib/time_boots.rb
 - lib/time_boots/boot.rb
@@ -109,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Easy time steps math