date_params 1.0.0 → 2.0.0

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.idea/
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/HISTORY.md

@@ -0,0 +1,10 @@
+# 2.0.0 / 2013-05-03
+
+* Removed support for specifying the namespace as an array in preference of the the `:namespace` option.
+* Added `datetime_parser` controller method for parsing date and time input fields to a DateTimeobject.
+* Added travis support
+* Removed the need to include DateParams::ControllerAdditions into the controller
+
+# 1.0.0 / 2013-04-23
+
+* Initial release

data/README.md

@@ -1,12 +1,14 @@
 # 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
+Dates and times passed in as strings date-pickers or time-pickers need to be
+converted from their string format to a ruby Date or DateTime to be able to be saved
+and manipulated. This gem provides two simple controller add-ons to
 facilitate the conversion.
 
 ## Installation
 
+Rails 3.x and Ruby 1.9.3 or 2.x required.
+
 Add this line to your application's Gemfile:
 
     gem 'date_params'
@@ -21,12 +23,12 @@ Or install it yourself as:
 
 ## Usage
 
-Include the controller additions in the controller that needs to parse
-date parameters and then specify dates to be formatted:
+### date_params
+
+Specify the dates to be parsed:
 ```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
@@ -34,7 +36,6 @@ end
 
 Any options that a `before_filter` accepts can be passed in:
 ```ruby
-include DateParams::ControllerAdditions
 date_params :sign_up_on, only: [:index]
 ```
 
@@ -42,20 +43,34 @@ 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:
+Date format can be passed as an option (default is `%m/%d/%Y`):
 ```ruby
-include DateParams::ControllerAdditions
-date_params [:user, :searched_on], [:company, :sign_up_on]
+date_params :search_on, :sign_up_on, date_format: '%d-%m-%Y'
 ```
 
-Date format can be passed as an option (default is `%m/%d/%Y`):
+### datetime_params
+
+Specify the datetime fields that need to be parsed:
 ```ruby
-include DateParams::ControllerAdditions
-date_params :search_on, :sign_up_on, date_format: '%d-%m-%Y'
+class UsersController < ApplicationController
+  # e.g. parameters come in as: { sign_up_at_date: '01/05/2013', sign_up_at_time: '7:30 pm' }
+  datetime_params :sign_up_at
+  # and now params[:sign_up_at] is a timezone-aware DateTime object
+end
+```
+
+In addition to the `:namespace` and `:date_format` options, the time format can be specified
+(default is `%I:%M %p`):
+```ruby
+date_params :sign_up_at, time_format: '%H:%M:%S'
+```
+
+To specify exactly which fields should be parsed:
+```ruby
+date_params { date: :sign_up_on, time: :sign_up_time, field: :sign_up_at }, only: :create
 ```
 
 ## Contributing

data/date_params.gemspec

@@ -19,8 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport'
+  spec.add_dependency 'tzinfo'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry-debugger'
 end

data/lib/date_params/controller_additions.rb

@@ -1,61 +1,32 @@
-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!
+      # Converts a text field with a date, in a specified format, into a Date object
       def date_params(*args)
         options = args.extract_options!
         before_filter options do |controller|
-          controller.parse_date_params(args, options)
+          args.each { |param| DateParams::Parser.new(param, options, controller.params).parse_date_param! }
         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
+      # Similar to #date_params, but parses a date input field and a time input field
+      # and combines them into a new timezone-aware datetime field.
+      def datetime_params(*args)
+        options = args.extract_options!
+        before_filter options do |controller|
+          args.each { |param| DateParams::Parser.new(param, options, controller.params).parse_datetime_param! }
+        end
       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
+  end
+end
 
-    def parse_date_params(the_params, options)
-      the_params.each{ |param| parse_date_param! param, options }
-    end
+if defined? ActionController::Base
+  ActionController::Base.class_eval do
+    include DateParams::ControllerAdditions
   end
 end

data/lib/date_params/parser.rb

@@ -0,0 +1,60 @@
+require 'time'
+require 'date'
+require 'tzinfo'
+require 'active_support/core_ext/time/zones'
+require 'active_support/core_ext/time/calculations'
+require 'active_support/time_with_zone'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/keys'
+
+class DateParams::Parser
+  attr_reader :param, :options, :params, :date_format, :time_format
+  def initialize(param, options, params)
+    @param = param
+    @options = options
+    @params = params
+    @date_format =  options.fetch :date_format, '%m/%d/%Y'
+    @time_format =  options.fetch :time_format, '%I:%M %p'
+  end
+
+  def parse_date_param!(field = param)
+    date_string = traversed_params.try(:[], field)
+    return if date_string.blank?
+    inferred_date_format = date_string =~ /\d{4}-\d{2}-\d{2}/ ? '%Y-%m-%d' : date_format
+    date = Date.strptime(date_string, inferred_date_format)
+    traversed_params[field] = date if date
+  end
+
+  def parse_datetime_param!
+    if param.is_a? Hash
+      fields = param
+      fields.assert_valid_keys :date, :time, :field
+    else
+      fields = {
+          date: "#{param}_date".to_sym,
+          time: "#{param}_time".to_sym,
+          field: param
+      }
+    end
+
+    date = parse_date_param! fields[:date]
+    return if date.blank?
+    time_string = traversed_params.try(:[], fields[:time])
+    return if time_string.blank?
+    datetime_format = "%Y-%m-%dT#{time_format}%z"
+    datetime_string = "#{date.iso8601}T#{time_string}#{Time.zone.name}"
+    datetime = Time.strptime(datetime_string, datetime_format).in_time_zone(Time.zone)
+    traversed_params[fields[:field]] = datetime if datetime
+  end
+
+  private
+
+  def traversed_params
+    traversed_params = params
+    if options[:namespace].present?
+      traversed_params = traversed_params.try :[], options[:namespace]
+    end
+    traversed_params
+  end
+end

data/lib/date_params/version.rb

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

data/lib/date_params.rb

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

data/spec/date_params/parser_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe DateParams::Parser do
+  let(:options) { {} }
+  let(:parser) { described_class.new param, options, params }
+
+  describe '#parse_date_param!' do
+    let(:params) do
+      {
+          date: '08/10/2012',
+          paginated_date: '2012-08-10',
+          invalid_date: '000000',
+          user: {
+              notified_on: '08/10/2012'
+          }
+      }
+    end
+    let(:date) { Date.parse '2012-08-10' }
+
+    context 'invalid format' do
+      let(:param) { :invalid_date }
+      it 'should raise when unknown format' do
+        expect { expect parser.parse_date_param! }.to raise_error ArgumentError
+      end
+    end
+
+    context 'valid format' do
+      before { parser.parse_date_param! }
+
+      describe 'param field is updated' do
+        let(:param) { :date }
+        subject { params[:date] }
+        it { should eq date }
+      end
+
+      context 'namespace option is present' do
+        let(:param) { :notified_on }
+        let(:options) { { namespace: :user } }
+        subject { params[:user][:notified_on] }
+        it { should eq date }
+      end
+
+      context 'date format is yyyy-mm-dd from pagination' do
+        let(:param) { :paginated_date }
+        subject { params[:paginated_date] }
+        it { should eq date }
+      end
+    end
+  end
+
+  describe '#parse_datetime_param!' do
+    before { Time.zone = 'EST' }
+    let(:params) do
+      {
+          created_at_date: '08/10/2012',
+          created_at_time: '12:30 am',
+          invalid_time: '1111',
+          empty_time: '',
+          user: {
+              notified_at_date: '08/10/2012',
+              notified_at_time: '12:30 am'
+          }
+      }
+    end
+    let(:datetime) { Time.zone.parse '2012-08-10 00:30' }
+
+    context 'invalid format' do
+      let(:param) { { date: :created_at_date, time: :invalid_time, field: :created_at } }
+      it 'should raise when unknown format' do
+        expect { expect parser.parse_datetime_param! }.to raise_error ArgumentError
+      end
+    end
+
+    context 'valid format' do
+      before { parser.parse_datetime_param! }
+
+      describe 'param field is updated' do
+        let(:param) { :created_at }
+        subject { params[:created_at] }
+        it { should eq datetime }
+      end
+
+      context 'namespace option is present' do
+        let(:param) { :notified_at }
+        let(:options) { { namespace: :user } }
+        subject { params[:user][:notified_at] }
+        it { should eq datetime }
+      end
+
+      context 'time is empty' do
+        let(:param) { { date: :created_at_date, time: :empty_time, field: :created_at } }
+        it 'parses the date but not the time' do
+          params[:created_at_date].should eq datetime.to_date
+          params[:created_at].should be_nil
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'bundler/setup'
+require 'pry-debugger'
 
 require 'date_params'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: date_params
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  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
@@ -75,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  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.
@@ -85,15 +117,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
+- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - date_params.gemspec
 - lib/date_params.rb
 - lib/date_params/controller_additions.rb
+- lib/date_params/parser.rb
 - lib/date_params/version.rb
-- spec/date_picker/controller_additions_spec.rb
+- spec/date_params/parser_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/LessonPlanet/date_params
 licenses:
@@ -121,5 +156,6 @@ 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/date_params/parser_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/spec/date_picker/controller_additions_spec.rb

@@ -1,58 +0,0 @@
-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