date_params 1.0.0

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Rust
+
+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,67 @@
+# DateParams
+
+Dates passed in by date-pickers or text-input fields need to be
+converted from their string format to a ruby Date to be able to be saved
+and manipulated. This gem provides a simple controller add-on to
+facilitate the conversion.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'date_params'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install date_params
+
+## Usage
+
+Include the controller additions in the controller that needs to parse
+date parameters and then specify dates to be formatted:
+```ruby
+class UsersController < ApplicationController
+  # e.g. parameters come in as: { sign_up_on: '01/05/2013' }
+  include DateParams::ControllerAdditions
+  date_params :sign_up_on
+  # and now params[:sign_up_on] is a Date object
+end
+```
+
+Any options that a `before_filter` accepts can be passed in:
+```ruby
+include DateParams::ControllerAdditions
+date_params :sign_up_on, only: [:index]
+```
+
+If date fields are namespaced in a model that can be specified with the
+`namespace` option:
+```ruby
+# will parse parameters in the format of: { user: { searched_on: '01/04/2013', sign_up_on: '04/03/2013' } }
+include DateParams::ControllerAdditions
+date_params :searched_on, :sign_up_on, namespace: :user
+```
+
+Or specify a namespace for each parameter individually:
+```ruby
+include DateParams::ControllerAdditions
+date_params [:user, :searched_on], [:company, :sign_up_on]
+```
+
+Date format can be passed as an option (default is `%m/%d/%Y`):
+```ruby
+include DateParams::ControllerAdditions
+date_params :search_on, :sign_up_on, date_format: '%d-%m-%Y'
+```
+
+## 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,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/date_params.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'date_params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'date_params'
+  spec.version       = DateParams::VERSION
+  spec.authors       = ['Jason Rust']
+  spec.email         = ['jason@lessonplanet.com']
+  spec.description   = %q{Dates passed in by date-pickers or text-input fields to a rails controller need to be converted to a ruby Date to be able to be saved and manipulated.  This gem provides a simple controller add-on to facilitate the conversion.}
+  spec.summary       = %q{Convert date string parameters in a rails controller into Date objects.}
+  spec.homepage      = 'https://github.com/LessonPlanet/date_params'
+  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 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/date_params.rb

@@ -0,0 +1,4 @@
+module DateParams
+  autoload :VERSION, 'date_params/version'
+  autoload :ControllerAdditions, 'date_params/controller_additions.rb'
+end

data/lib/date_params/controller_additions.rb

@@ -0,0 +1,61 @@
+require 'date'
+require 'active_support/concern'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/object/blank'
+
+module DateParams
+  module ControllerAdditions
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Usage:
+      #
+      # To convert only on specific actions use:
+      # date_params :param_name, [:namespaced, :param_name], only: :action_name
+      # If all variables are in a common namespace, use the namespace option:
+      # date_params :param_name1, :param_name2, namespace: :namespaced
+      # @see #parse_date_param!
+      def date_params(*args)
+        options = args.extract_options!
+        before_filter options do |controller|
+          controller.parse_date_params(args, options)
+        end
+      end
+    end
+
+    # Usage:
+    #
+    # To convert params[:my_date]
+    # date_params :my_date
+    #
+    # To convert params[:my_model][:my_date1] use one of the following:
+    # parse_date_param!([:my_model, :my_date1])
+    # parse_date_param!(:my_date1, namespace: :my_model)
+    #
+    # if the format of the data is not '%m/%d/%Y'
+    # parse_date_param!(:my_date1, date_format: '%m/%Y')
+    def parse_date_param!(param, options)
+      param_path = Array(param).dup
+      param_path.unshift options[:namespace] if options[:namespace] && param_path.length == 1
+      date_format =  options.fetch(:date_format, '%m/%d/%Y')
+      traversed_params = params
+
+      if param_path.length > 1
+        param_key = param_path.pop
+        param_path.each { |k| traversed_params = traversed_params.try :[], k }
+      else
+        param_key = param_path.first
+      end
+
+      value = traversed_params.try(:[], param_key)
+      return nil if value.blank?
+      date_format = value =~ /\d{4}-\d{2}-\d{2}/ ? '%Y-%m-%d' : date_format
+      date = Date.strptime(value, date_format)
+      traversed_params[param_key] = date if date
+    end
+
+    def parse_date_params(the_params, options)
+      the_params.each{ |param| parse_date_param! param, options }
+    end
+  end
+end

data/lib/date_params/version.rb

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

data/spec/date_picker/controller_additions_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe DateParams::ControllerAdditions do
+  let(:mock_controller) do
+    Class.new do
+      attr_accessor :params
+      include DateParams::ControllerAdditions
+    end.new
+  end
+  let(:custom_params) do
+    {
+        date: '08/10/2012',
+        paginated_date: '2012-08-10',
+        invalid_date: '000000',
+        model: {
+            date: '08/10/2012'
+        }
+    }
+  end
+  let(:date) { Date.parse '2012-08-10' }
+
+  context 'invalid format' do
+    let(:param_spec) { :invalid_date }
+    it 'should raise when unknown format' do
+      mock_controller.params = custom_params
+      expect { mock_controller.parse_date_param!(param_spec, {}) }.to raise_error ArgumentError, 'invalid date'
+    end
+  end
+
+  context 'valid format' do
+    before do
+      mock_controller.params = custom_params
+      mock_controller.parse_date_param!(param_spec, {})
+    end
+
+    context 'should update params' do
+      let(:param_spec) { :date }
+      subject { mock_controller.params[:date] }
+      it { should eq date }
+    end
+
+    context 'should update nested params' do
+      let(:param_spec) { [:model, :date] }
+      subject { mock_controller.params[:model][:date] }
+      it { should eq date }
+
+      it 'should not change the original' do
+        param_spec.should == [:model, :date]
+      end
+    end
+
+    context 'when date format is yyyy-mm-dd from pagination' do
+      let(:param_spec) { :paginated_date }
+      subject { mock_controller.params[:paginated_date] }
+      it { should eq date }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'date_params'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: date_params
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jason Rust
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dates passed in by date-pickers or text-input fields to a rails controller
+  need to be converted to a ruby Date to be able to be saved and manipulated.  This
+  gem provides a simple controller add-on to facilitate the conversion.
+email:
+- jason@lessonplanet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- date_params.gemspec
+- lib/date_params.rb
+- lib/date_params/controller_additions.rb
+- lib/date_params/version.rb
+- spec/date_picker/controller_additions_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/LessonPlanet/date_params
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Convert date string parameters in a rails controller into Date objects.
+test_files:
+- spec/date_picker/controller_additions_spec.rb
+- spec/spec_helper.rb