validates_timeliness 3.0.0.beta.4 → 3.0.0.beta.5

data/CHANGELOG

@@ -2,7 +2,9 @@
 - Rails 3 and ActiveModel compatibility
 - Uses ActiveModel::EachValidator as validator base class.
 - Configuration settings stored in ValidatesTimeliness module only. ValidatesTimeliness.setup block to configure.
-- Plugin parser is off by default.
+- Parser extracted to the Timeliness gem http://github.com/adzap/timeliness
+- Parser is disabled by default. See initializer for enabling it.
+- Removed RSpec matcher. Encouraged poor specs by copy-pasting from spec to model, or worse, the other way round.
 - Method override for parsing and before type cast values is on validated attributes only. Old version handled all date/datetime columns, validates or not. Too intrusive.
 - Add validation helpers to classes using extend_orms config setting. e.g. conf.extend_orms = [ :active_record ]
 - Changed :between option so it is split into :on_or_after and :on_or_before option values. The error message for either failing check will be used instead of a between error message.  

data/README.rdoc

@@ -14,11 +14,13 @@ If you a looking for the old version for Rails 2.x go here[http://github.com/adz
 
 * Adds validation for dates, times and datetimes to ActiveModel
 
-* Adds extensions to fix Rails date/time select issues
+* Handles timezones and type casting of values for you
+
+* Only Rails date/time validation plugin offering complete validation (See ORM/ODM support)
 
-* Includes extensible date/time parser
+* Adds extensions to fix Rails date/time select issues
 
-* Supports timezone handling
+* Uses extensible date/time parser ({timeliness gem}[http://github.com/adzap/timeliness])
 
 * Supports I18n for the error messages
 
@@ -32,7 +34,7 @@ As plugin (from master)
 As gem (in beta)
 
   # in Gemfile
-  gem 'validates_timeliness', '>= 3.0.0.beta'
+  gem 'validates_timeliness', '>= 3.0.5.beta'
 
   # Run bundler
   $ bundle install
@@ -69,14 +71,14 @@ To validate a model with a date, time or datetime attribute you just use the
 validation method
 
   class Person < ActiveRecord::Base
-    validates_date :date_of_birth, :on_or_before => lambda { Date.today }
+    validates_date :date_of_birth, :on_or_before => lambda { Date.current }
     # or
-    validates :date_of_birth, :timeliness => {:on_or_before => lambda { Date.today }, :type => date}
+    validates :date_of_birth, :timeliness => {:on_or_before => lambda { Date.current }, :type => :date}
   end
 
   # or even on a specific record, per ActiveModel API.
 
-  @person.validates_date :date_of_birth, :on_or_before => lambda { Date.today }
+  @person.validates_date :date_of_birth, :on_or_before => lambda { Date.current }
 
 
 The list of validation methods available are as follows:
@@ -180,22 +182,23 @@ It is highly recommended you use the I18n system for error messages.
 
 === Plugin Parser
 
-The plugin comes with a customisable date and time parser. You can add or remove valid formats
-for dates, times, and datetimes. It is also more strict than the Ruby parser, which means it 
-won't accept day of the month if it's not a valid number for that month.
+The uses the {timeliness gem}[http://github.com/adzap/timeliness] as a fast, configurable and extensible date and time parser.
+You can add or remove valid formats for dates, times, and datetimes. It is also more strict than the
+Ruby parser, which means it won't accept day of the month if it's not a valid number for the month.
 
-By default the parser is switched off. To switch it on:
+By default the parser is disabled. To enable it:
 
   # in the setup block
   config.use_plugin_parser = true
 
-See the wiki[http://github.com/adzap/validates_timeliness/wiki/Plugin-Parser] for all the details about the parser.
+Enabling the parser will mean that strings assigned to attributes validated with the plugin will be parsed
+using the gem. See the wiki[http://github.com/adzap/validates_timeliness/wiki/Plugin-Parser] for more details about the parser configuration.
 
 
 === Restriction Shorthand
 
 It is common to restrict an attribute to being on or before the current time or current day. 
-To specify this you need to use a lambda as an option value e.g. <tt>lambda { Time.now }</tt>.
+To specify this you need to use a lambda as an option value e.g. <tt>lambda { Time.current }</tt>.
 This can be tedious noise amongst your validations for something so common. To combat this the
 plugin allows you to use shorthand symbols for often used relative times or dates.
 

data/Rakefile

@@ -22,6 +22,7 @@ spec = Gem::Specification.new do |s|
   s.homepage = "http://github.com/adzap/validates_timeliness"
   s.require_path = 'lib'
   s.files = %w(validates_timeliness.gemspec LICENSE CHANGELOG README.rdoc Rakefile) + Dir.glob("{lib,spec}/**/*")
+  s.add_runtime_dependency 'timeliness', '~> 0.1.1'
 end
 
 desc 'Default: run specs.'

data/lib/generators/validates_timeliness/templates/validates_timeliness.rb

@@ -2,8 +2,8 @@ ValidatesTimeliness.setup do |config|
   # Extend ORM/ODMs for full support (:active_record, :mongoid).
   # config.extend_orms = [ :active_record ]
   #
-  # User the plugin date/time parser which is stricter and extendable
-  # config.use_plugin_parser = false
+  # Default timezone
+  # config.default_timezone = :utc
   #
   # Set the dummy date part for a time type values.
   # config.dummy_date_for_time_type = [ 2000, 1, 1 ]
@@ -19,10 +19,13 @@ ValidatesTimeliness.setup do |config|
   #
   # Shorthand date and time symbols for restrictions
   # config.restriction_shorthand_symbols.update(
-  #   :now   => lambda { Time.now },
-  #   :today => lambda { Date.today }
+  #   :now   => lambda { Time.current },
+  #   :today => lambda { Date.current }
   # )
   #
+  # Use the plugin date/time parser which is stricter and extendable
+  # config.use_plugin_parser = false
+  #
   # Add one or more formats making them valid. e.g. add_formats(:date, 'd(st|rd|th) of mmm, yyyy')
   # config.parser.add_formats()
   #

data/lib/validates_timeliness.rb

@@ -1,4 +1,6 @@
 require 'date'
+require 'active_support/concern'
+require 'active_support/core_ext/module'
 require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/string/conversions'
 require 'active_support/core_ext/date/acts_like'
@@ -7,41 +9,42 @@ require 'active_support/core_ext/time/acts_like'
 require 'active_support/core_ext/time/conversions'
 require 'active_support/core_ext/date_time/acts_like'
 require 'active_support/core_ext/date_time/conversions'
+require 'timeliness'
 
 module ValidatesTimeliness
-  autoload :Parser,  'validates_timeliness/parser'
   autoload :VERSION, 'validates_timeliness/version'
 
+  class << self
+    delegate :parser, :default_timezone, :default_timezone=, :dummy_date_for_time_type, :to => Timeliness
+  end
+
   # Extend ORM/ODMs for full support (:active_record, :mongoid).
   mattr_accessor :extend_orms
-  @@extend_orms = [ defined?(ActiveRecord) && :active_record ].compact
-
-  # User the plugin date/time parser which is stricter and extendable
-  mattr_accessor :use_plugin_parser
-  @@use_plugin_parser = false
-
-  # Default timezone
-  mattr_accessor :default_timezone
-  @@default_timezone = defined?(ActiveRecord) ? ActiveRecord::Base.default_timezone : :utc
-
-  # Set the dummy date part for a time type values.
-  mattr_accessor :dummy_date_for_time_type
-  @@dummy_date_for_time_type = [ 2000, 1, 1 ]
+  @@extend_orms = []
 
   # Ignore errors when restriction options are evaluated
   mattr_accessor :ignore_restriction_errors
-  @@ignore_restriction_errors = defined?(Rails) ? !Rails.env.test? : false
+  @@ignore_restriction_errors = false
 
   # Shorthand time and date symbols for restrictions
   mattr_accessor :restriction_shorthand_symbols
   @@restriction_shorthand_symbols = {
-    :now   => lambda { Time.now },
-    :today => lambda { Date.today }
+    :now   => lambda { Time.current },
+    :today => lambda { Date.current }
   }
 
-  def self.parser
-    Parser
+  # Use the plugin date/time parser which is stricter and extensible
+  mattr_accessor :use_plugin_parser
+  @@use_plugin_parser = false
+
+  # Default timezone
+  self.default_timezone = :utc
+
+  # Set the dummy date part for a time type values.
+  def self.dummy_date_for_time_type=(array)
+    Timeliness.date_for_time_type = array
   end
+  self.dummy_date_for_time_type = [ 2000, 1, 1 ]
 
   # Setup method for plugin configuration
   def self.setup
@@ -55,3 +58,4 @@ require 'validates_timeliness/validator'
 require 'validates_timeliness/helper_methods'
 require 'validates_timeliness/attribute_methods'
 require 'validates_timeliness/extensions'
+require 'validates_timeliness/railtie' if defined?(Rails)

data/lib/validates_timeliness/attribute_methods.rb

@@ -38,7 +38,7 @@ module ValidatesTimeliness
           def #{attr_name}=(value)
             @timeliness_cache ||= {}
             @timeliness_cache["#{attr_name}"] = value
-            #{ "value = ValidatesTimeliness::Parser.parse(value, :#{type}, :timezone_aware => #{timezone_aware}) if value.is_a?(String)" if ValidatesTimeliness.use_plugin_parser }
+            #{ "value = Timeliness::Parser.parse(value, :#{type}, :zone => (:current if #{timezone_aware})) if value.is_a?(String)" if ValidatesTimeliness.use_plugin_parser }
             super
           end
         EOV

data/lib/validates_timeliness/conversion.rb

@@ -11,10 +11,10 @@ module ValidatesTimeliness
       when :date
         value.to_date
       when :datetime
-        value.to_time
+        value.is_a?(Time) ? value : value.to_time
       end
       if options[:ignore_usec] && value.is_a?(Time)
-        ValidatesTimeliness::Parser.make_time(Array(value).reverse[4..9], @timezone_aware)
+        Timeliness::Parser.make_time(Array(value).reverse[4..9], (:current if @timezone_aware))
       else
         value
       end
@@ -28,7 +28,7 @@ module ValidatesTimeliness
         [0,0,0]
       end
       values = ValidatesTimeliness.dummy_date_for_time_type + time
-      ValidatesTimeliness::Parser.make_time(values, @timezone_aware)
+      Timeliness::Parser.make_time(values, (:current if @timezone_aware))
     end
 
     def evaluate_option_value(value, record)
@@ -57,7 +57,7 @@ module ValidatesTimeliness
 
     def parse(value)
       if ValidatesTimeliness.use_plugin_parser
-        ValidatesTimeliness::Parser.parse(value, @type, :timezone_aware => @timezone_aware, :format => options[:format], :strict => false)
+        Timeliness::Parser.parse(value, @type, :zone => (:current if @timezone_aware), :format => options[:format], :strict => false)
       else
         @timezone_aware ? Time.zone.parse(value) : value.to_time(ValidatesTimeliness.default_timezone)
       end

data/lib/validates_timeliness/orm/mongoid.rb

@@ -22,7 +22,7 @@ module ValidatesTimeliness
             def #{attr_name}=(value)
               @timeliness_cache ||= {}
               @timeliness_cache["#{attr_name}"] = value
-              #{ "value = ValidatesTimeliness::Parser.parse(value, :#{type}) if value.is_a?(String)" if ValidatesTimeliness.use_plugin_parser }
+              #{ "value = Timeliness::Parser.parse(value, :#{type}) if value.is_a?(String)" if ValidatesTimeliness.use_plugin_parser }
               write_attribute(:#{attr_name}, value)
             end
           EOV

data/lib/validates_timeliness/railtie.rb

@@ -0,0 +1,14 @@
+module ValidatesTimeliness
+  class Railtie < Rails::Railtie
+    initializer "validates_timeliness.initialize_active_record", :after => 'active_record.initialize_timezone' do
+      ActiveSupport.on_load(:active_record) do
+        ValidatesTimeliness.default_timezone = ActiveRecord::Base.default_timezone
+        ValidatesTimeliness.extend_orms = [ :active_record ]
+      end
+    end
+
+    initializer "validates_timeliness.initialize_restriction_errors" do
+      ValidatesTimeliness.ignore_restriction_errors = !Rails.env.test?
+    end
+  end
+end

data/lib/validates_timeliness/validator.rb

@@ -44,23 +44,28 @@ module ValidatesTimeliness
       value = parse(raw_value) if value.is_a?(String) || options[:format]
       value = type_cast_value(value, @type)
 
-      return record.errors.add(attr_name, :"invalid_#{@type}") if value.blank?
+      return add_error(record, attr_name, :"invalid_#{@type}") if value.blank?
 
       @restrictions_to_check.each do |restriction|
         begin
           restriction_value = type_cast_value(evaluate_option_value(options[restriction], record), @type)
-
           unless value.send(RESTRICTIONS[restriction], restriction_value)
-            return record.errors.add(attr_name, restriction, :message => options[:"#{restriction}_message"], :restriction => format_error_value(restriction_value))
+            return add_error(record, attr_name, restriction, restriction_value)
           end
         rescue => e
           unless ValidatesTimeliness.ignore_restriction_errors
-            record.errors[attr_name] = "Error occurred validating #{attr_name} for #{restriction.inspect} restriction:\n#{e.message}" 
+            add_error(record, attr_name, "Error occurred validating #{attr_name} for #{restriction.inspect} restriction:\n#{e.message}")
           end
         end
       end
     end
 
+    def add_error(record, attr_name, message, value=nil)
+      value = format_error_value(value) if value
+      message_options = { :message => options[:"#{message}_message"], :restriction => value }
+      record.errors.add(attr_name, message, message_options)
+    end
+
     def format_error_value(value)
       format = I18n.t(@type, :default => DEFAULT_ERROR_VALUE_FORMATS[@type], :scope => 'validates_timeliness.error_value_formats')
       value.strftime(format)

data/lib/validates_timeliness/version.rb

@@ -1,3 +1,3 @@
 module ValidatesTimeliness
-  VERSION = '3.0.0.beta.4'
+  VERSION = '3.0.0.beta.5'
 end

data/spec/validates_timeliness/attribute_methods_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe ValidatesTimeliness::AttributeMethods do
   it 'should define _timeliness_raw_value_for instance method' do
-    PersonWithShim.instance_methods.should include('_timeliness_raw_value_for')
+    PersonWithShim.new.should respond_to(:_timeliness_raw_value_for)
   end
 
   describe ".timeliness_validated_attributes" do
@@ -51,7 +51,7 @@ describe ValidatesTimeliness::AttributeMethods do
       end
 
       it 'should parse a string value' do
-        ValidatesTimeliness::Parser.should_receive(:parse) 
+        Timeliness::Parser.should_receive(:parse)
         r = PersonWithParser.new
         r.birth_date = '2010-01-01'
       end
@@ -70,7 +70,7 @@ describe ValidatesTimeliness::AttributeMethods do
 
   context "before_type_cast method" do
     it 'should not be defined if ORM does not support it' do
-      PersonWithShim.instance_methods(false).should_not include("birth_datetime_before_type_cast")
+      PersonWithShim.new.should_not respond_to(:birth_datetime_before_type_cast)
     end
   end
 end

data/spec/validates_timeliness/conversion_spec.rb

@@ -102,8 +102,8 @@ describe ValidatesTimeliness::Conversion do
     end
 
     describe "with custom dummy date" do
-      before(:all) do
-        @@original_dummy_date = ValidatesTimeliness.dummy_date_for_time_type
+      before do
+        @original_dummy_date = ValidatesTimeliness.dummy_date_for_time_type
         ValidatesTimeliness.dummy_date_for_time_type = [2010, 1, 1] 
       end
 
@@ -111,8 +111,8 @@ describe ValidatesTimeliness::Conversion do
         dummy_time(Time.utc(1999, 11, 22, 12, 34, 56)).should == Time.utc(2010, 1, 1, 12, 34, 56)
       end
 
-      after(:all) do
-        ValidatesTimeliness.dummy_date_for_time_type = @@original_dummy_date
+      after do
+        ValidatesTimeliness.dummy_date_for_time_type = @original_dummy_date
       end
     end
   end

data/spec/validates_timeliness/helper_methods_spec.rb

@@ -8,9 +8,9 @@ describe ValidatesTimeliness, 'HelperMethods' do
   end
 
   it 'should define instance validation methods' do
-    Person.instance_methods.should include('validates_date')
-    Person.instance_methods.should include('validates_time')
-    Person.instance_methods.should include('validates_datetime')
+    Person.new.should respond_to(:validates_date)
+    Person.new.should respond_to(:validates_time)
+    Person.new.should respond_to(:validates_datetime)
   end
 
   it 'should validate instance when validation method called' do

data/spec/validates_timeliness/orm/active_record_spec.rb

@@ -10,9 +10,9 @@ describe ValidatesTimeliness, 'ActiveRecord' do
     end
 
     it 'should defines for the instance' do
-      ActiveRecord::Base.instance_methods.should include('validates_date')
-      ActiveRecord::Base.instance_methods.should include('validates_time')
-      ActiveRecord::Base.instance_methods.should include('validates_datetime')
+      Employee.new.should respond_to(:validates_date)
+      Employee.new.should respond_to(:validates_time)
+      Employee.new.should respond_to(:validates_datetime)
     end
   end
 
@@ -44,7 +44,7 @@ describe ValidatesTimeliness, 'ActiveRecord' do
       end
 
       it 'should parse a string value' do
-        ValidatesTimeliness::Parser.should_receive(:parse) 
+        Timeliness::Parser.should_receive(:parse)
         r = EmployeeWithParser.new
         r.birth_date = '2010-01-01'
       end
@@ -73,7 +73,7 @@ describe ValidatesTimeliness, 'ActiveRecord' do
 
   context "before_type_cast method" do
     it 'should be defined on class if ORM supports it' do
-      Employee.instance_methods(false).should include("birth_datetime_before_type_cast")
+      Employee.new.should respond_to(:birth_datetime_before_type_cast)
     end
 
     it 'should return original value' do

data/spec/validates_timeliness/orm/mongoid_spec.rb

@@ -1,8 +1,10 @@
 require 'spec_helper'
 
+# Try loading mongoid and connecting. Otherwise, abort and skip spec.
+begin
+
 require 'mongoid'
 require 'validates_timeliness/orm/mongoid'
-
 Mongoid.configure do |config|
   name = "validates_timeliness_test"
   host = "localhost"
@@ -32,9 +34,9 @@ describe ValidatesTimeliness, 'Mongoid' do
     end
 
     it 'should be defined on the instance' do
-      Article.instance_methods.should include('validates_date')
-      Article.instance_methods.should include('validates_time')
-      Article.instance_methods.should include('validates_datetime')
+      Article.new.should respond_to(:validates_date)
+      Article.new.should respond_to(:validates_time)
+      Article.new.should respond_to(:validates_datetime)
     end
   end
 
@@ -55,7 +57,7 @@ describe ValidatesTimeliness, 'Mongoid' do
       end
 
       it 'should parse a string value' do
-        ValidatesTimeliness::Parser.should_receive(:parse) 
+        Timeliness::Parser.should_receive(:parse)
         r = Article.new
         r.publish_date = '2010-01-01'
       end
@@ -83,7 +85,13 @@ describe ValidatesTimeliness, 'Mongoid' do
 
   context "before_type_cast method" do
     it 'should not be defined if ORM does not support it' do
-      Article.instance_methods(false).should_not include("birth_datetime_before_type_cast")
+      Article.new.should_not respond_to(:birth_datetime_before_type_cast)
     end
   end
 end
+
+rescue LoadError
+  puts "Mongoid specs skipped. Mongoid not installed"
+rescue StandardError
+  puts "Mongoid specs skipped. MongoDB connection failed."
+end

data/spec/validates_timeliness/validator_spec.rb

@@ -190,11 +190,14 @@ describe ValidatesTimeliness::Validator do
   end
 
   context "custom error message" do
+    it 'should be used for invalid type' do
+      Person.validates_date :birth_date, :invalid_date_message => 'custom invalid message'
+      invalid!(:birth_date, 'asdf', 'custom invalid message')
+    end
   
-    it 'should be used for failing restriction' do
+    it 'should be used for invalid restriction' do
       Person.validates_date :birth_date, :before => Time.now, :before_message => 'custom before message'
       invalid!(:birth_date, Time.now, 'custom before message')
     end
-
   end
 end