span 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzVhYjA4MDBjNmExMDRmODlkNzU4MjAwMjRiMmYyMzZlZWVkODkxYQ==
+  data.tar.gz: !binary |-
+    YmEyMDhhNjk2YTMyYjlmMTNjMDI1MmU5MDIyYmU2OGUxYWQyMDU3NQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    M2NkZTgyZjM2NTg1Y2U5NjI5Mzc5ZGIzOWEyN2UyMDY0YzczY2IzMzMzYWZi
+    NWYxMDM2ODczZWVjZGQ5MGI1MWY3NDUwN2Y4ODcxYzhkZGQxY2E4NmQ3MjI5
+    MDBkNTgwMGExNTdjZWM0MDZmZmQwMGRkMTRiYWZjNGY2YmE0MjY=
+  data.tar.gz: !binary |-
+    MjdmMTYwZTBjMzQ4ZmZjNmNhMGU1YzUyYzgzYjY3ODU5MzMwNmEyYTFjOTE0
+    ZjIzY2EyOWQ5MmU5ZGU2YmYzNDFmNzllMjdjNmUyYjZiODJmNDY2ZWU1ZjNj
+    YmI5MzkyYWEwMDU1ZDViODEyYzliODQwOTU3YzJkNGU1Yjg3YjM=

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in span.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan Cook <cookrn@gmail.com>
+
+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,55 @@
+# Span
+
+Calculate the differences between two dates. A few notes:
+
+* It is calendar-correct, meaning that it respects non-30-day months
+* It currently only calculates the composite span, meaning that each
+  quantity in the result hash contributes to the total span.
+* No external dependencies except the standard library
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'span'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install span
+
+## Usage
+
+`Span` ships with a single entry point for its API currently: `compute`.
+
+```ruby
+require 'span'
+end_date = Date.parse '25/03/2013'
+start_date = Date.parse '01/01/2012'
+result = Span.compute end_date , start_date
+puts result[ :year ].inspect  # => 1
+puts result[ :month ].inspect # => 2
+puts result[ :week ].inspect  # => 3
+puts result[ :day ].inspect   # => 4
+```
+
+It returns a `Hash` that has four `Symbol` keys: `:year`, `:month`, `:week`,
+and `:day`.
+
+## TODOs
+
+* Reconsider `end_date` before `start_date` in `compute` API arguments
+* Add more API options
+* Better tests?
+* Clean up code to make it easier to contribute
+
+## Contributing
+
+1. Fork it ( http://github.com/cookrn/span/fork )
+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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new( :test ) do | t |
+  t.libs    << [ 'test' ]
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/lib/span.rb

@@ -0,0 +1,126 @@
+require 'date'
+
+require 'span/version'
+
+module Span
+  def self.compute( *args , &block )
+    TimeDiff.compute *args , &block
+  end
+
+  class TimeDiff
+    attr_reader \
+      :end_date,
+      :start_date
+
+    def self.compute( *args , &block )
+      new( *args , &block ).to_hash
+    end
+
+    def initialize( end_date_input , start_date_input )
+      @end_date   = end_date_input.to_date
+      @start_date = start_date_input.to_date
+    end
+
+    def build_diff_hash
+      check_from = start_date
+
+      [ :years , :months , :weeks , :days ].reduce Hash.new do | memo , part |
+        check_from , num_of_part , part_singular =
+          send \
+            :"diff_#{ part }",
+            check_from,
+            part
+
+        memo[ part_singular ] = num_of_part
+        memo
+      end
+    end
+
+    def default_diff( check_from , part , part_singular )
+      num_of_part      = 0
+      part_next_method = :"next_#{ part_singular }"
+
+      loop do
+        check = check_from.send part_next_method
+
+        break if check > end_date
+
+        check_from = check
+        num_of_part += 1
+      end
+
+      [ check_from , num_of_part , part_singular ]
+    end
+
+    def diff_days( *args )
+      default_diff *args , :day
+    end
+
+    def diff_months( check_from , * )
+      num_of_part = 0
+      part_singular = :month
+      part_next_method = :"next_#{ part_singular }"
+
+      loop do
+        check = check_from.send part_next_method
+
+        if check > end_date
+          if start_date.day != check_from.day
+            day   = start_date.strftime '%d'
+            month = check_from.strftime '%m'
+            year  = check_from.strftime '%Y'
+
+            date_to_try =
+              begin
+                Date.parse "#{ day }/#{ month }/#{ year }"
+              rescue ArgumentError
+                false
+              end
+
+            check_from =
+              if date_to_try
+                date_to_try
+              else
+                next_month = check_from.next_month.strftime '%m'
+                Date.parse( "01/#{ next_month }/#{ year }" ).prev_day
+              end
+          end
+
+          break
+        end
+
+        check_from = check
+        num_of_part += 1
+      end
+
+      [ check_from , num_of_part , part_singular ]
+    end
+
+    def diff_weeks( check_from , * )
+      num_of_part = 0
+      part_singular = :week
+      part_next_method = :next_day
+      check_from = check_from.prev_day
+
+      loop do
+        check = check_from.send part_next_method
+        6.times { check = check.send part_next_method }
+
+        break if check > end_date
+
+        check_from = check
+        num_of_part += 1
+      end
+
+      [ check_from , num_of_part , part_singular ]
+    end
+
+    def diff_years( *args )
+      default_diff *args , :year
+    end
+
+    def to_hash
+      @_hash ||= build_diff_hash
+    end
+  end
+end

data/lib/span/version.rb

@@ -0,0 +1,3 @@
+module Span
+  VERSION = "0.0.1"
+end

data/span.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'span/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'span'
+  spec.version       = Span::VERSION
+  spec.authors       = ['Ryan Cook']
+  spec.email         = ['cookrn@gmail.com']
+  spec.summary       = %q{Calculate the difference between two dates.}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = 'https://github.com/cookrn/span'
+  spec.license       = 'MIT'
+
+  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_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+end

data/test/span_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+describe Span do
+  [
+    [
+      '06/01/2014', # January 6th
+      '31/01/2012', # January 31st
+      {
+        :year  => 1,
+        :month => 11,
+        :week  => 1,
+        :day   => 0
+      }
+    ],
+    [
+      '06/01/2014', # January 6th
+      '22/02/2013', # February 22nd
+      {
+        :year  => 0,
+        :month => 10,
+        :week  => 2,
+        :day   => 2
+      }
+    ],
+    [
+      '06/01/2014', # January 6th
+      '24/02/2013', # February 24th
+      {
+        :year  => 0,
+        :month => 10,
+        :week  => 2,
+        :day   => 0
+      }
+    ],
+    [
+      '07/01/2014', # January 7th
+      '11/05/2013', # May 11th
+      {
+        :year  => 0,
+        :month => 7,
+        :week  => 4,
+        :day   => 0
+      }
+    ],
+    [
+      '25/03/2013', # March 25th
+      '01/01/2012', # January 1st
+      {
+        :year  => 1,
+        :month => 2,
+        :week  => 3,
+        :day   => 4
+      }
+    ]
+  ].each do | example |
+    it "expected returns #{ example[ 1 ] }" do
+      check_date = Date.parse example[ 0 ]
+      birth_date = Date.parse example[ 1 ]
+      expected   = example[ 2 ]
+
+      computed =
+        Span.compute \
+          check_date,
+          birth_date
+
+      computed.delete_if do | key , _ |
+        !expected.keys.include?( key )
+      end
+
+      computed.must_equal expected
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+gem 'minitest'
+
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'span'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: span
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Cook
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: 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'
+description: 
+email:
+- cookrn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/span.rb
+- lib/span/version.rb
+- span.gemspec
+- test/span_test.rb
+- test/test_helper.rb
+homepage: https://github.com/cookrn/span
+licenses:
+- MIT
+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.0.4
+signing_key: 
+specification_version: 4
+summary: Calculate the difference between two dates.
+test_files:
+- test/span_test.rb
+- test/test_helper.rb