years 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: acf6659537b23e76f768d32bc8cb5b326f0afc01
+  data.tar.gz: 35b5b8c9f1b5ae6cfe0bf302aba33728cc5092ce
+SHA512:
+  metadata.gz: 7315f4470add7978de59f7d2c4fbd570f863066345056fdcd288adb332b575e8907506a701e83756a60dd3aa0cab17f44cb18cb0f312ed91cf8ead598777b7d0
+  data.tar.gz: 97cfcb2715fb97ee058037a3a7a20370925f1cbdf8b3d1c59a194e2af4bef51ebfb6d94c2bc2fcace35d58a6a6dcb99e6870e4cf3431f2e7e7cdfc49b1bb9f7a

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+years

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p353

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nigel Lowry
+
+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,36 @@
+# Years
+
+Small gem for year related methods. Includes a method for calculating a person's age and another for helping create
+a year range (say for a Web site's copyright statement). Two methods exist for calculating the age for when the
+legal leapling birthday is 28 Feb (NZ) or 1 Mar (UK). Please check your country's rules.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'years'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install years
+
+## Usage
+
+```ruby
+require 'years'
+
+Years.age_where_leapling_legal_birthday_is_1_mar('22 Sep 1976'.to_date) # == 37 when the current date is 26 Jan 14
+Years.range(2012) # == '2012–2014' when the current year is 2014
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/nigel-lowry/years/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 @@
+require "bundler/gem_tasks"

data/lib/years.rb

@@ -0,0 +1,55 @@
+require 'years/version'
+
+# Provides some year-related methods.
+module Years
+  @@EN_DASH = '–'
+
+  # tells the age of someone, with truncation, where the leapling legal birthday is 28 February
+  # @param [Date] date_of_birth the person's date of birth
+  # @param [Date] today the day that you want to know their date of birth for, defaults to today
+  # @return [Fixnum]
+  def self.age_where_leapling_legal_birthday_is_28_feb date_of_birth, today=Date.current
+    age date_of_birth, today, :feb28
+  end
+
+  # tells the age of someone, with truncation, where the leapling legal birthday is 1 March
+  # @param (see Years.age_where_leapling_legal_birthday_is_28_feb)
+  # @param (see Years.age_where_leapling_legal_birthday_is_28_feb)
+  # @return (see Years.age_where_leapling_legal_birthday_is_28_feb)
+  def self.age_where_leapling_legal_birthday_is_1_mar date_of_birth, today=Date.current
+    age date_of_birth, today, :mar1
+  end
+
+  # tells the age of someone, with truncation, where the leapling legal birthday is 28 February
+  # @param [Fixnum] first_year the first year of the range, say the year of company creation
+  # @param [Fixnum] last_year the last year of the range, defaults to this year
+  # @return [String]
+  def self.range first_year, last_year=Date.current.year
+    raise if first_year > last_year
+
+    (first_year == last_year) ? first_year.to_s : first_year.to_s + @@EN_DASH + last_year.to_s
+  end
+
+private
+
+  def self.age date_of_birth, today, legal_leapling_birthday
+    raise if today < date_of_birth
+
+    years = today.year - date_of_birth.year
+    (birthday(date_of_birth, years, legal_leapling_birthday) > today) ? years - 1 : years
+  end
+
+  def self.birthday date_of_birth, years, legal_leapling_birthday
+    bday = date_of_birth.years_since years
+    (leapling?(date_of_birth) and legal_leapling_birthday == :mar1) ? bday.tomorrow : bday
+  end
+
+  def self.leapling? date
+    february_29th? date
+  end
+
+  def self.february_29th? date
+    date.mday == 29 and date.mon == 2
+  end
+
+end

data/lib/years/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/years_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'timecop'
+require 'active_support/all'
+require 'years'
+
+describe Years do
+  describe ".age_where_leapling_legal_birthday_is_1_mar" do
+    context "regular birthday" do
+      let(:date_of_birth) { '22 Sep 1976'.to_date }
+
+      it "raises error if not born yet" do
+        expect { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '21 Sep 1976'.to_date) }.to raise_error
+      end
+
+      specify { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '22 Sep 1976'.to_date).should == 0 }
+      specify { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '23 Sep 1976'.to_date).should == 0 }
+
+      specify { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '21 Sep 1977'.to_date).should == 0 }
+      specify { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '22 Sep 1977'.to_date).should == 1 }
+      specify { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '23 Sep 1977'.to_date).should == 1 }
+
+      specify { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '21 Sep 1978'.to_date).should == 1 }
+      specify { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '22 Sep 1978'.to_date).should == 2 }
+      specify { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '23 Sep 1978'.to_date).should == 2 }
+
+      it "uses current date when second argument missing" do
+        Timecop.freeze '22 Sep 2006'.to_date do
+          Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth).should == 30
+        end
+      end
+    end
+
+    context "leap year birthday" do
+      let(:date_of_birth) { '29 Feb 2004'.to_date }
+
+      specify { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '1 Mar 2004'.to_date).should == 0 }
+      specify { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '28 Feb 2005'.to_date).should == 0 }
+      specify { Years.age_where_leapling_legal_birthday_is_1_mar(date_of_birth, '1 Mar 2005'.to_date).should == 1 }
+    end
+  end
+
+  describe ".age_where_leapling_legal_birthday_is_28_feb" do
+    let(:date_of_birth) { '29 Feb 2004'.to_date }
+    specify { Years.age_where_leapling_legal_birthday_is_28_feb(date_of_birth, '28 Feb 2005'.to_date).should == 1 }
+  end
+
+  describe ".range" do
+    before do
+      Timecop.freeze '26 Jan 2012'.to_date
+    end
+
+    after do
+      Timecop.return
+    end
+
+    specify { Years.range(2010).should == '2010–2012' }
+    specify { Years.range(2011).should == '2011–2012' }
+    specify { Years.range(2012).should == '2012' }
+
+    it "raises error if range would be in future" do
+      expect { Years.range(2013) }.to raise_error
+    end
+
+    specify { Years.range(2011, 2011).should == '2011' }
+    specify { Years.range(2011, 2012).should == '2011–2012' }
+    specify { Years.range(2011, 2013).should == '2011–2013' }
+    specify { Years.range(2011, 2014).should == '2011–2014' }
+
+    it "raises error if range is wrong way round" do
+      expect { Years.range(2013, 2011) }.to raise_error
+    end
+  end
+end

data/years.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'years/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "years"
+  spec.version       = Years::VERSION
+  spec.authors       = ["Nigel Lowry"]
+  spec.email         = ["nigel-lowry@ultra.eclipse.co.uk"]
+  spec.summary       = %q{Small gem for showing year ranges.}
+  spec.description   = %q{Small gem to create year ranges for copyright statements in Web pages.}
+  spec.homepage      = ""
+  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 "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: years
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nigel Lowry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-26 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: 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: rspec
+  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: timecop
+  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: activesupport
+  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: yard
+  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: Small gem to create year ranges for copyright statements in Web pages.
+email:
+- nigel-lowry@ultra.eclipse.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/years.rb
+- lib/years/version.rb
+- spec/spec_helper.rb
+- spec/years_spec.rb
+- years.gemspec
+homepage: ''
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Small gem for showing year ranges.
+test_files:
+- spec/spec_helper.rb
+- spec/years_spec.rb
+has_rdoc: