interpret_date 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b03eb126b4b4f727346a4d23a576a2015adba70d
+  data.tar.gz: 933639b6e8e3db12d063238426140d98a1eb2f4b
+SHA512:
+  metadata.gz: fe687df6723b8592ff8620e960e864b8cb52196c95272f81352d58446c84434b0a3011957de19c32ad51b37f38bc9e74f4d6de24b07e4d565a5b0faf7e46f26d
+  data.tar.gz: d8d47e84dd941bc979ab43f16a391c84ec714193333a2eb8e76fe233f4f7b427c22e93be9187a952d255ff94703b16e1b03b0e33313b66d6bcea0d0e72f04e50

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Keith Thompson
+
+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,51 @@
+# InterpretDate
+
+[![Build
+status](https://travis-ci.org/sqm/interpret_date.svg?branch=master)](https://travis-ci.org/sqm/interpret_date)
+
+Module to provide helper methods for interpreting American formatted date strings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'interpret_date'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interpret_date
+
+## Usage
+
+To utilize `interpret_date`, mix in the `InterpretDate` module into a
+class that needs to interpret American formatted dates into ruby Date
+objects and pass the date string into the `interpret_date` or
+`interpret_dob_date`.
+
+Example (setting attributes for an example `ActiveRecord` model):
+
+```ruby
+class Parcel < ActiveRecord::Base
+  include InterpretDate
+
+  def shipping_date=(value)
+    super(interpret_date(value))
+  end
+
+  def birthdate=(value)
+    super(interpret_dob_date(value))
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/sqm/interpret_date/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'interpret_date'
+  ARGV.clear
+  IRB.start
+end

data/interpret_date.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interpret_date/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interpret_date"
+  spec.version       = InterpretDate::VERSION
+  spec.authors       = ["Squaremouth"]
+  spec.email         = ["developers@squaremouth.com"]
+  spec.summary       = %q{Mixin for easily parsing American formatted date strings into Date objects.}
+  spec.description   = %q{Module to provide helper methods for interpreting American formatted date strings.}
+  spec.homepage      = "https://github.com/sqm/interpret_date"
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/lib/interpret_date/version.rb

@@ -0,0 +1,3 @@
+module InterpretDate
+  VERSION = "1.0.0"
+end

data/lib/interpret_date.rb

@@ -0,0 +1,78 @@
+require "interpret_date/version"
+
+module InterpretDate
+  def interpret_date(date_input, buffer = 10)
+    # the number of years previous turn of the century + buffer number of years
+    @century_divider = Date.today.year + buffer - current_century
+    convert_date(date_input)
+  end
+
+  def interpret_dob_date(date_input)
+    # the number of years since previous turn of the century
+    @century_divider = Date.today.year - current_century
+    convert_date(date_input)
+  end
+
+  private
+
+  def current_century
+    "#{Date.today.to_s[0..1]}00".to_i
+  end
+
+  def contains_only_six_digits(value)
+    /^\d{6}$/ =~ value
+  end
+
+  def convert_date(date_input)
+    # Only run the interpret_date code if we have a non-nil string,
+    # otherwise, use #to_date to strip any time or timezone info
+    return date_input.to_date unless date_input.is_a?(String) || date_input.nil?
+
+    if contains_only_six_digits(date_input)
+      # The date_input only contains digits, and must
+      # be in the form MMDDYY
+      month = date_input[0,2].to_i
+      day   = date_input[2,2].to_i
+      year  = date_input[4,2].to_i
+    elsif slash_based_date(date_input)
+      # Break the string apart using the delimiters '-', '/', and '.', making each element an integer
+      month, day, year = date_input.split(/[-\.\/]+/).collect { |element| element.to_i }
+    else
+      return nil
+    end
+
+    # Do not allow a three-digit year
+    return nil if year.to_s.size == 3
+
+    # Modify two-digit years
+    if year < 100
+      # @century_divider represents the year where we
+      # divide 2 digit years from the last century or the current one
+      if year > @century_divider
+        year += current_century - 100
+      else
+        year += current_century
+      end
+    end
+
+    begin
+      Date.new(year, month, day)
+    rescue
+      nil
+    end
+  end
+
+  # -----------------------------------------
+  # Does the input string match this pattern
+  # and associated variations?
+  #  * m/d/yy
+  #  * mm/dd/yy
+  #  * mm/dd/yyyy
+  #  * m-d-yy
+  #  * mm-dd-yy
+  #  * mm-dd-yyyy
+  # -----------------------------------------
+  def slash_based_date(value)
+    /^\d{1,2}([-\.\/]+)\d{1,2}\1\d{2,4}$/ =~ value
+  end
+end

data/spec/interpret_date_spec.rb

@@ -0,0 +1,70 @@
+RSpec.describe InterpretDate do
+  include InterpretDate
+
+  describe "#interpret_date" do
+    let(:test_date) { Date.new(1990, 2, 6) }
+
+    {
+      "mmddyy" => "020690",
+      "m/d/yy" => "2/6/90",
+      "m/d/yyyy" => "2/6/1990",
+      "mm/dd/yy" => "02/06/90",
+      "mm/dd/yyyy" => "02/06/1990",
+      "m-d-yy" => "2-6-90",
+      "m-d-yyyy" => "2-6-1990",
+      "mm-dd-yy" => "02-06-90",
+      "mm-dd-yyyy" => "02-06-1990",
+      "m.d.yy" => "2.6.90",
+      "m.d.yyyy" => "2.6.1990",
+      "mm.dd.yy" => "02.06.90",
+      "mm.dd.yyyy" => "02.06.1990",
+    }.each do |format, value|
+      it "interprets dates in the form of #{format} properly" do
+        expect(interpret_date(value)).to eq(test_date)
+      end
+    end
+
+    context "with two digit year" do
+      it "interprets the years based on the century break + default 10 year buffer" do
+        buffer = 10
+        century_break = (Date.today.year + buffer).to_s[2..3].to_i
+        expect(interpret_date("01/01/#{century_break}")).to eq(Date.new(2000 + century_break, 1, 1))
+        century_break += 1
+        expect(interpret_date("01/01/#{century_break}")).to eq(Date.new(1900 + century_break, 1, 1))
+      end
+
+      it "interprets the years based on the century break + assigned buffer" do
+        buffer = 1
+        century_break = (Date.today.year + buffer).to_s[2..3].to_i
+        expect(interpret_date("01/01/#{century_break}", buffer)).to eq(Date.new(2000 + century_break, 1, 1))
+        century_break += 1
+        expect(interpret_date("01/01/#{century_break}", buffer)).to eq(Date.new(1900 + century_break, 1, 1))
+      end
+    end
+
+    it "returns the date if passed a Time object" do
+      expect(interpret_date(Time.now)).to eq(Date.today)
+    end
+
+    it "returns the date if passed a Date object" do
+      expect(interpret_date(Date.today)).to eq(Date.today)
+    end
+
+    it "returns nil if the input passed in cannot be parsed into a date" do
+      expect(interpret_date("Kevin Bacon")).to eq(nil)
+    end
+  end
+
+  describe "#interpret_dob_date" do
+    context "with two digit year" do
+      it "interprets the years based on the century break" do
+        century_break = (Date.today.year).to_s[2..3].to_i
+        # Person with dob of 01/01/15 would yield 01/01/2015
+        expect(interpret_dob_date("01/01/#{century_break}")).to eq(Date.new(2000 + century_break, 1, 1))
+        century_break += 1
+        # Person with dob of 01/01/16 would yield 01/01/1916 since 2016 hasn't occured yet.
+        expect(interpret_dob_date("01/01/#{century_break}")).to eq(Date.new(1900 + century_break, 1, 1))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,86 @@
+require "bundler/setup"
+Bundler.setup
+
+require "interpret_date"
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: interpret_date
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Squaremouth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Module to provide helper methods for interpreting American formatted
+  date strings.
+email:
+- developers@squaremouth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- interpret_date.gemspec
+- lib/interpret_date.rb
+- lib/interpret_date/version.rb
+- spec/interpret_date_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sqm/interpret_date
+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.2
+signing_key: 
+specification_version: 4
+summary: Mixin for easily parsing American formatted date strings into Date objects.
+test_files:
+- spec/interpret_date_spec.rb
+- spec/spec_helper.rb