american_date_parsing 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGQxMjM3N2VjYzczYTFmOGNhMjUxOTQ4ZGZmZWMyMjg2OTQ5YzNhZg==
+  data.tar.gz: !binary |-
+    ZTRiY2FkYWFjYzVhOWQyY2EzNTdhMzAzMGE1NDFlNmFjMjdjNjVkYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OWU0ODM0ZDE1Y2IxMjI0YmU1NTE4M2JiZTY2ZTZlZTlhMjZhZTc1MmU2Njkw
+    YzJlYmE1MThkMGIzYjhkYzg0NWRkYjA2ZDdiMWZlNjY0Yzk5MWZjMDlmYWIz
+    YmJkZjY1NzM4OTUxMTIyNDc1NTkxNTM4ZGZhMTE3NWI0YWIxMjY=
+  data.tar.gz: !binary |-
+    N2NiNzNiMzg5ZmVkOWJiODk1YTY4Njg3MTU3NGZlMTkxNDY5NjE5M2E3NDBl
+    MzVkYmYyZTYyNjRhYjNlZWFlZmNkNmQ3MTVjMTQ0OWM0OTUzYWJmMjFlMzlk
+    NDZiM2FjNTIwMjVjMjE4MGU2OGY1YzQwNDFjMDczZjQ5N2Q4OGY=

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 american_date_parsing.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Eddy
+
+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,107 @@
+# AmericanDateParsing
+
+American-style (e.g 12/25/2014) date parsing for ActiveRecord and ActiveModel.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'american_date_parsing'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Invoke `parse_as_americanized_date` in a model.
+
+```Ruby
+class MyModel < ActiveRecord::Base
+  parse_as_americanized_date :activates_on, :expires_on
+end
+
+instance = MyModel.new
+
+instance.activates_on = "12/25/2012"
+instance.activates_on
+# => Tue, 25 Dec 2012
+
+instance.expires_on = Date.new(2012, 12, 25)
+instance.expires_on
+# => Tue, 25 Dec 2012
+```
+
+## Validation
+
+Presence and format validations are added by passing options to `parse_as_americanized_date`. Note: make sure to `include ActiveModel::Validations` for `ActiveModel` subclasses.
+
+```Ruby
+class MyModel < ActiveRecord::Base
+  parse_as_americanized_date :activates_on, validate: {
+    presence: true,
+    format: true
+  }
+end
+
+instance = MyModel.new
+
+instance.valid?
+instance.errors[:activates_on]
+# => ["can't be blank"]
+
+instance.activates_on = "1225-2012"
+instance.valid?
+instance.errors[:activates_on]
+# => ["is invalid"]
+
+instance.activates_on = "12-25-2012"
+instance.valid?
+instance.errors[:activates_on]
+# => []
+```
+
+### Custom validation messages
+
+Just as with standard validations, `:validate` accepts a `:message` option.
+
+```Ruby
+class MyModel < ActiveRecord::Base
+  parse_as_americanized_date :activates_on, validate: {
+    presence: {message: "is required"},
+    format: {message: "needs to be formatted as MM/DD/YYYY"}
+  }
+end
+
+instance = MyModel.new
+
+instance.valid?
+instance.errors[:activates_on]
+# => ["is required"]
+
+instance.activates_on = "1225-2012"
+instance.valid?
+instance.errors[:activates_on]
+# => ["needs to be formatted as MM/DD/YYYY"]
+```
+
+Alternatively, custom messaging can be acheived via i18n.
+
+
+```YAML
+en:
+  errors:
+    attributes:
+      activates_on:
+        blank: is required
+        invalid: needs to be formatted as MM/DD/YYYY
+```
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/american_date_parsing.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'american_date_parsing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "american_date_parsing"
+  spec.version       = AmericanDateParsing::VERSION
+  spec.authors       = ["Ben Eddy"]
+  spec.email         = ["bae@foraker.com"]
+  spec.description   = %q{American date parsing for ActiveRecord and ActiveModel}
+  spec.summary       = %q{American date parsing for ActiveRecord and ActiveModel}
+  spec.homepage      = "https://github.com/foraker/american_date_parsing"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "chronic"
+  spec.add_dependency "activemodel"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/american_date_parsing.rb

@@ -0,0 +1,109 @@
+require "active_model"
+require "active_support/core_ext"
+require "chronic"
+
+module AmericanDateParsing
+  mattr_writer :delimiter, :date_format
+
+  DEFAULT_DELIMITER = "/|-"
+
+  def self.delimiter
+    DEFAULT_DELIMITER
+  end
+
+  def self.date_format
+    @date_format ||= %r{\d{1,2}#{delimiter}\d{1,2}#{delimiter}\d{2,4}}
+  end
+
+  def parse_as_americanized_date(*attributes)
+    options = attributes.extract_options!
+
+    if !defined?(ActiveRecord::Base) || !(self < ActiveRecord::Base)
+      send(:include, AmericanDateParsing::Accessors)
+    end
+
+    attributes.each do |attribute|
+      attr_accessor :"_raw_#{attribute}"
+
+      if options[:validate].present?
+        validates attribute, 'american_date_parsing/american_date' => options[:validate]
+      end
+
+      define_method "#{attribute}=" do |date_string|
+        parsed = if date_string.respond_to?(:strftime)
+          date_string.to_date
+        else
+          Chronic.parse(date_string.to_s).try(:to_date)
+        end
+
+        send(:"_raw_#{attribute}=", date_string)
+        write_attribute(attribute, parsed)
+      end
+    end
+  end
+
+  module Accessors
+    def write_attribute(attribute, value)
+      instance_variable_set("@#{attribute}", value)
+    end
+
+    def read_attribute(attribute)
+      instance_variable_get("@#{attribute}")
+    end
+  end
+
+  class AmericanDateValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      Validation.new({
+        value:   record.read_attribute(attribute),
+        raw:     record.send(:"_raw_#{attribute}"),
+        options: options
+      }).errors.each do |error, opts|
+        opts = opts.respond_to?(:keys) ? opts : {}
+        record.errors.add(attribute, error, opts)
+      end
+    end
+
+    class Validation
+      def initialize(options)
+        @value   = options[:value]
+        @raw     = options[:raw]
+        @options = options[:options]
+      end
+
+      def errors
+        [format_error, presence_error].compact
+      end
+
+      private
+
+      attr_reader :value, :raw, :options
+
+      def presence_error
+        [:blank, options[:presence]] if validate_presence? && blank?
+      end
+
+      def format_error
+        [:invalid, options[:format]] if validate_format? && format_mismatch?
+      end
+
+      def blank?
+        value.blank? && raw.blank?
+      end
+
+      def format_mismatch?
+        raw.present? &&
+        value.blank? &&
+        raw !~ AmericanDateParsing.date_format
+      end
+
+      def validate_format?
+        options[:format]
+      end
+
+      def validate_presence?
+        options[:presence]
+      end
+    end
+  end
+end

data/lib/american_date_parsing/version.rb

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

data/test/american_date_parsing_spec.rb

@@ -0,0 +1,88 @@
+require 'minitest'
+require 'minitest/autorun'
+
+require File.expand_path("../../lib/american_date_parsing", __FILE__)
+
+describe AmericanDateParsing do
+  class TestModel
+    include ActiveModel
+    include ActiveModel::Validations
+    extend AmericanDateParsing
+
+    attr_accessor :date
+
+    parse_as_americanized_date :date, validate: {
+      format: true,
+      presence: true
+    }
+  end
+
+  def with_date(string)
+    instance = TestModel.new
+    instance.date = string
+    instance.date
+  end
+
+  def errors(string)
+    instance = TestModel.new
+    instance.date = string
+    instance.valid?
+    instance.errors[:date]
+  end
+
+  describe "validations" do
+    it "accepts a valid american date" do
+      errors("12/25/2012").wont_include('is invalid')
+    end
+
+    it "accepts hyphen delimiters" do
+      errors("12-25-2012").wont_include('is invalid')
+    end
+
+    it "accepts abbreviated delimiters" do
+      errors("12-25-2012").wont_include('is invalid')
+    end
+
+    it "rejects non-delimited dates" do
+      errors("12252012").must_include('is invalid')
+    end
+
+    it "rejects nonsense dates" do
+      errors("cats").must_include('is invalid')
+    end
+
+    it "rejects missing dates" do
+      errors("").must_include('can\'t be blank')
+    end
+  end
+
+  describe "setting" do
+    it "accepts American style dates" do
+      with_date("12/25/2012").must_equal Date.new(2012, 12, 25)
+    end
+
+    it "accepts hyphen delimiters" do
+      with_date("12-25-2012").must_equal Date.new(2012, 12, 25)
+    end
+
+    it "accepts abberviated years" do
+      with_date("12/25/12").must_equal Date.new(2012, 12, 25)
+    end
+
+    it "accepts dates" do
+      with_date(Date.today).must_equal Date.today
+    end
+
+    it "accepts times" do
+      with_date(Date.today.to_time).must_equal Date.today
+    end
+
+    it "accepts nil" do
+      with_date(nil).must_equal nil
+    end
+
+    it "sets nonsense dates to nil" do
+      with_date("cats").must_equal nil
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: american_date_parsing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Eddy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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'
+description: American date parsing for ActiveRecord and ActiveModel
+email:
+- bae@foraker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- american_date_parsing.gemspec
+- lib/american_date_parsing.rb
+- lib/american_date_parsing/version.rb
+- test/american_date_parsing_spec.rb
+homepage: https://github.com/foraker/american_date_parsing
+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.3
+signing_key: 
+specification_version: 4
+summary: American date parsing for ActiveRecord and ActiveModel
+test_files:
+- test/american_date_parsing_spec.rb
+has_rdoc: