time_spanner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e2463079adde3dea23bf0f4ec07643d7f7b8287
+  data.tar.gz: 03b8c9c82c323a7c13a6da91e2fb08c6154ee798
+SHA512:
+  metadata.gz: 5714eae36ccaa238f3b2b4fcde65fb0032e4b1dcb3fb0cc7ff2683ad76fd6a9bd9a84ac189905642b37b8e0c442e11da34b11a5552f8bef9a912391691e8b53d
+  data.tar.gz: 691f5e479c64690ba0e102d72b6569e68dce4ecacd60430b55533dc313d67312414e7f1a2234f8657e3ed4af2428661c1145774b5a2c766f37a4caf57797019b

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/.ruby-gemset

@@ -0,0 +1 @@
+time_spanner

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in time_spanner.gemspec
+gemspec
+
+group :test do
+  platforms :mswin, :mingw do
+    gem 'win32console', '1.3.0'
+  end
+
+  gem 'minitest'
+  gem 'minitest-reporters'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+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

@@ -0,0 +1,60 @@
+time_spanner
+============
+
+Returns a time span splitted in desired units given two timestamps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'time_spanner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install time_spanner
+
+## Usage
+
+```ruby
+ TimeSpan.new Time.parse('2012-04-05 07:05:05'), Time.parse('3024-11-14 12:06:49')
+```
+returns:
+
+```ruby
+ {:millenniums=>1, :centuries=>0, :decades=>1, :years=>2, :months=>7, :weeks=>1, :days=>2, :hours=>6, :minutes=>1, :seconds=>44, :milliseconds=>0, :microseconds=>0, :nanoseconds=>0}
+```
+
+## Specifying units
+
+Define which time units should be calculated.
+Pass them within an Array as a third parameter.
+
+Available units are:
+<pre>:millenniums, :centuries, :decades, :years, :months, :weeks, :days, :hours, :minutes, :seconds, :milliseconds, :microseconds, :nanoseconds</pre>
+
+If no units are supplied it defaults to all units.
+
+
+### Example
+
+```ruby
+ TimeSpan.new Time.parse('2012-04-05 07:05:05'), Time.at(Time.parse(2012-04-05 07:10:12', 1243.345), [:seconds, :milliseconds, :microseconds, :nanoseconds])
+```
+returns:
+
+```ruby
+ {:seconds=>307, :milliseconds=>1, :microseconds=>243, :nanoseconds=>345}
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+desc 'Run tests'
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/lib/time_spanner.rb

@@ -0,0 +1,8 @@
+require 'date'
+require 'time'
+require 'forwardable'
+require 'time_spanner/errors'
+require 'time_spanner/time_units'
+require 'time_spanner/time_unit_collector'
+require 'time_spanner/duration_chain'
+require 'time_spanner/time_span'

data/lib/time_spanner/duration_chain.rb

@@ -0,0 +1,55 @@
+module TimeSpanner
+
+  class DurationChain
+    extend Forwardable
+    include Enumerable
+    include TimeUnits
+
+    attr_accessor :remaining, :reverse, :units
+    attr_reader   :to
+    alias         :reverse? :reverse
+
+    def_delegator :units, :each
+
+    def initialize from, to, units
+      @from, @to = setup_times from, to
+      @remaining = to.to_r - from.to_r
+      @units     = units.map &:new
+
+      calculate!
+    end
+
+    private
+
+    # Perform duration calculations for units in chain.
+    def calculate!
+      sort!
+
+      each do |unit|
+        calculate_unit unit
+      end
+    end
+
+    def calculate_unit unit
+      unit.calculate remaining, to
+      unit.reverse! if reverse?
+
+      @remaining = unit.rest
+    end
+
+    # Units must be sorted to perform a correct calculation chain.
+    def sort!
+      @units = units.sort
+    end
+
+    def setup_times from, to
+      @reverse = to < from
+      new_from = reverse? ? to : from
+      new_to   = reverse? ? from : to
+
+      [ new_from, new_to ]
+    end
+
+  end
+
+end

data/lib/time_spanner/errors.rb

@@ -0,0 +1,8 @@
+module TimeSpanner
+  module Errors
+
+    class InvalidClassError < StandardError; end
+    class InvalidUnitError < StandardError; end
+
+  end
+end

data/lib/time_spanner/time_span.rb

@@ -0,0 +1,34 @@
+module TimeSpanner
+
+  class TimeSpan < Hash
+    include Errors
+
+    attr_reader :unit_chain
+
+    def initialize from, to, unit_names = []
+      validate! from, to
+
+      units       = TimeUnitCollector.new( unit_names ).units
+      @unit_chain = DurationChain.new from.to_time, to.to_time, units
+
+      build!
+    end
+
+
+    private
+
+    def build!
+      unit_chain.each do |unit|
+        self[ unit.plural_name ] = unit.amount
+      end
+    end
+
+    def validate! from, to
+      unless [ from, to ].all? { |obj| obj.is_a?( Time ) || ( obj.respond_to?( :to_time ) && obj.to_time.is_a?( Time ) ) }
+        raise InvalidClassError, "Must convert to Time object!"
+      end
+    end
+
+  end
+
+end

data/lib/time_spanner/time_unit_collector.rb

@@ -0,0 +1,59 @@
+module TimeSpanner
+
+  class TimeUnitCollector
+    include TimeUnits
+    include Errors
+
+    AVAILABLE_UNITS = [ :millenniums, :centuries, :decades, :years, :months, :weeks, :days, :hours, :minutes, :seconds, :milliseconds, :microseconds, :nanoseconds ]
+
+    attr_reader   :unit_names
+    attr_accessor :units
+
+    def initialize unit_names = []
+      @unit_names = collect_unit_names unit_names
+      @units      = []
+
+      validate_unit_names!
+      collect!
+    end
+
+
+    private
+
+    def collect!
+      unit_names.each do |name|
+        units << ( unit_by_name name )
+      end
+    end
+
+    def unit_by_name name
+      case name
+        when :millenniums  then Millennium
+        when :centuries    then Century
+        when :decades      then Decade
+        when :years        then Year
+        when :months       then Month
+        when :weeks        then Week
+        when :days         then Day
+        when :hours        then Hour
+        when :minutes      then Minute
+        when :seconds      then Second
+        when :milliseconds then Millisecond
+        when :microseconds then Microsecond
+        when :nanoseconds  then Nanosecond
+      end
+    end
+
+    def collect_unit_names unit_names
+      !unit_names || unit_names.compact.empty? ? AVAILABLE_UNITS : unit_names
+    end
+
+    def validate_unit_names!
+      unit_names.each do |unit_name|
+        raise InvalidUnitError, "Unit '#{unit_name}' is not a valid time unit." unless AVAILABLE_UNITS.include? unit_name
+      end
+    end
+
+  end
+
+end

data/lib/time_spanner/time_units.rb

@@ -0,0 +1,17 @@
+require 'time_spanner/time_units/base/unit'
+require 'time_spanner/time_units/base/calendar_unit'
+require 'time_spanner/time_units/base/time_unit'
+
+require 'time_spanner/time_units/nanosecond'
+require 'time_spanner/time_units/microsecond'
+require 'time_spanner/time_units/millisecond'
+require 'time_spanner/time_units/second'
+require 'time_spanner/time_units/minute'
+require 'time_spanner/time_units/hour'
+require 'time_spanner/time_units/day'
+require 'time_spanner/time_units/week'
+require 'time_spanner/time_units/month'
+require 'time_spanner/time_units/year'
+require 'time_spanner/time_units/decade'
+require 'time_spanner/time_units/century'
+require 'time_spanner/time_units/millennium'

data/lib/time_spanner/time_units/base/calendar_unit.rb

@@ -0,0 +1,30 @@
+module TimeSpanner
+  module TimeUnits
+
+    class CalendarUnit < Unit
+
+      attr_reader :from, :to
+
+      def initialize position
+        super position
+      end
+
+      def calculate duration, to
+        @to       = to
+        @from     = @to - duration.to_r
+
+        calculate_amount
+        calculate_rest at_amount( amount )
+      end
+
+
+      private
+
+      def calculate_rest from
+        @rest = to.to_r - from.to_r
+      end
+
+    end
+  end
+
+end

data/lib/time_spanner/time_units/base/time_unit.rb

@@ -0,0 +1,39 @@
+module TimeSpanner
+  module TimeUnits
+
+    class TimeUnit < Unit
+
+      attr_reader :multiplier
+
+      def initialize position, multiplier
+        super position
+
+        @multiplier = multiplier
+      end
+
+      def calculate duration, to = nil
+        @duration = duration
+
+        calculate_amount
+        calculate_rest
+      end
+
+
+      private
+
+      def calculate_amount
+        @amount = ( ( duration * multiplier ).round 13 ).to_i
+      end
+
+      def calculate_rest
+        @rest = duration - amount_in_seconds
+      end
+
+      def amount_in_seconds
+        amount.to_r / multiplier
+      end
+
+    end
+
+  end
+end

data/lib/time_spanner/time_units/base/unit.rb

@@ -0,0 +1,31 @@
+module TimeSpanner
+  module TimeUnits
+
+    class Unit
+      include Comparable
+
+      attr_reader   :position
+      attr_accessor :duration, :amount, :rest
+
+      def initialize position
+        @position = position
+        @amount   = 0
+        @rest     = 0
+      end
+
+      def reverse!
+        @amount = -amount
+      end
+
+      def <=> other
+        position <=> other.position
+      end
+
+      def plural_name
+        "#{self.class.name.split('::').last.downcase}s".to_sym
+      end
+
+    end
+  end
+
+end

data/lib/time_spanner/time_units/century.rb

@@ -0,0 +1,30 @@
+module TimeSpanner
+  module TimeUnits
+
+    class Century < CalendarUnit
+
+      def initialize
+        super 2
+      end
+
+      # Override!
+      def plural_name
+        :centuries
+      end
+
+
+      private
+
+      def calculate_amount
+        amount  = ( to.year - from.year ) / 100
+        @amount = at_amount( amount ) > to ? amount - 1 : amount
+      end
+
+      def at_amount amount
+        ( from.to_datetime >> amount * 1200 ).to_time
+      end
+
+    end
+
+  end
+end