validates_timeliness 2.2.2 → 2.3.0

data/CHANGELOG

@@ -1,5 +1,14 @@
+= 2.3.0 [2010-02-04]
+- Backwards incompatible change to :equal_to option. Fixed error message clash with :equal_to option which exists in Rails already. Option is now :is_at.
+- Fixed I18n support so it returns missing translation message instead of error
+- Fixed attribute method bug. Write method was bypassed when method was first generated and used Rails default parser.
+- Fixed date/time selects when using enable_datetime_select_extension! when some values empty
+- Fixed ISO8601 datetime format which is now split into two formats
+- Changed I18n error value format to fallback to global default if missing in locale
+- Refactored date/time select invalid value extension to use param values. Functionality will be extracted from plugin for v3.
+
 = 2.2.2 [2009-09-19]
-- Fixed dummy_time using make_time to respect timezone. Fixes 1.9.1 bug. 
+- Fixed dummy_time using make_time to respect timezone. Fixes 1.9.1 bug.
 
 = 2.2.1 [2009-09-12]
 - Fixed dummy date part for time types in Validator.type_cast_value
@@ -8,7 +17,7 @@
 = 2.2.0 [2009-09-12]
 - Ruby 1.9 support!
 - Customise dummy date values for time types. See DUMMY DATE FOR TIME TYPES.
-- Fixed matcher conflict with Shoulda. Load plugin matcher manually now see matcher section in README 
+- Fixed matcher conflict with Shoulda. Load plugin matcher manually now see matcher section in README
 - Fixed :ignore_usec when used with :with_time or :with_date
 - Some clean up and refactoring
 
@@ -65,7 +74,7 @@
 - Added Rails 2.2 i18n support. Plugin error messages can specified in locale files. See README.
 - ignore_datetime_restriction_errors setting has been moved from AR to ValidatesTimeliness::Validator.ignore_restriction_errors
 - date_time_error_value_formats setting has been moved from AR to ValidatesTimeliness::Validator.error_value_formats
-- Namespaced modules and specs 
+- Namespaced modules and specs
 - Clean up of specs
 - fixed a few bugs
   - accessor methods not generating properly due method name stored as symbol in generated_attributes which fails on lookup

data/README.rdoc

@@ -5,10 +5,10 @@
 
 == DESCRIPTION:
 
-Validate dates, times and datetimes for Rails 2.x. Plays nicely with new Rails 2.1
-features such as automatic timezone handling and dirty attributes. Allows you to
-add custom formats or remove defaults easily. This allows you to control what you 
-think should be a valid date or time string.
+Validate dates, times and datetimes for Rails 2.x. Plays nicely with Rails
+automatic timezone handling. Allows you to add custom formats or remove defaults
+easily. This allows you to control what you think should be a valid date or
+time string.
 
 
 == FEATURES:
@@ -46,24 +46,24 @@ As gem
 
 == USAGE:
 
-To validate a model with a date, time or datetime attribute you just use the 
+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
 
   end
-  
+
 The list of validation methods available are as follows:
   validates_date     - validate value as date
   validates_time     - validate value as time only i.e. '12:20pm'
   validates_datetime - validate value as a full date and time
-  
+
 The validation methods take the usual options plus some specific ones to restrict
 the valid range of dates or times allowed
 
 Temporal options (or restrictions):
-  :equal_to     - Attribute must be equal to value to be valid
+  :is_at        - Attribute must be equal to value to be valid
   :before       - Attribute must be before this value to be valid
   :on_or_before - Attribute must be equal to or before this value to be valid
   :after        - Attribute must be after this value to be valid
@@ -78,15 +78,15 @@ Regular validation options:
 
 Special options:
   :with_time    - Validate a date attribute value combined with a time value against any temporal restrictions
-  :with_date    - Validate a time attribute value combined with a date value against any temporal restrictions 
+  :with_date    - Validate a time attribute value combined with a date value against any temporal restrictions
   :ignore_usec  - Ignores microsecond value on datetime restrictions
   :format       - Limit validation to a single format for special cases. Takes plugin format value.
-  
+
 Message options: - Use these to override the default error messages
   :invalid_date_message
   :invalid_time_message
   :invalid_datetime_message
-  :equal_to_message
+  :is_at_message
   :before_message
   :on_or_before_message
   :after_message
@@ -99,7 +99,7 @@ The temporal restrictions, with_date and with_time can take 4 different value ty
 * Proc or lambda object which may take an optional parameter being the record object
 * A symbol matching the method name in the model
 
-When an attribute value is compared to temporal restrictions, they are compared as 
+When an attribute value is compared to temporal restrictions, they are compared as
 the same type as the validation method type. So using validates_date means all
 values are compared as dates. This is except in the case of with_time and with_date
 options which effectively force the value to validated as a datetime against the
@@ -109,7 +109,7 @@ temporal options.
 
   validates_date :date_of_birth :before => lambda { 18.years.ago },
                                 :before_message => "must be at least 18 years old"
-  
+
   validates_time :breakfast_time, :on_or_after => '6:00am',
                                   :on_or_after_message => 'must be after opening time',
                                   :before => :second_breakfast_time,
@@ -118,16 +118,16 @@ temporal options.
   validates_datetime :appointment_date, :before => lambda { 1.week.from_now }
 
   validates_date :entry_date, :with_time => '17:00', :on_or_before => :competition_closing
- 
+
 
 === DATE/TIME FORMATS:
 
-So what formats does the plugin allow. Well there are default formats which can 
-be added to easily using the plugins format rules. Also formats can be easily 
-removed without hacking the plugin at all. 
+So what formats does the plugin allow. Well there are default formats which can
+be added to easily using the plugins format rules. Also formats can be easily
+removed without hacking the plugin at all.
 
-Below are the default formats. If you think they are easy to read then you will 
-be happy to know that is exactly the format you can use to define your own if 
+Below are the default formats. If you think they are easy to read then you will
+be happy to know that is exactly the format you can use to define your own if
 you want. No complex regular expressions or duck punching (monkey patching) the
 plugin is needed.
 
@@ -165,13 +165,14 @@ NOTE: To use non-US date formats see US/EURO FORMATS section
   yyyy-mm-dd hh:nn:ss
   yyyy-mm-dd h:nn
   ddd mmm d hh:nn:ss zo yyyy # Ruby time string
-  yyyy-mm-ddThh:nn:ss(?:Z|zo) # ISO 8601
+  yyyy-mm-ddThh:nn:ssZ  # ISO 8601 without zone offset
+  yyyy-mm-ddThh:nn:sszo # ISO 8601 with zone offset
 
 NOTE: To use non-US date formats see US/EURO FORMATS section
 
 Here is what each format token means:
 
-  Format tokens:   
+  Format tokens:
        y = year
        m = month
        d = day
@@ -184,10 +185,10 @@ Here is what each format token means:
       tz = Timezone abbreviation (e.g. UTC, GMT, PST, EST)
       zo = Timezone offset (e.g. +10:00, -08:00, +1000)
 
-  Repeating tokens:        
+  Repeating tokens:
        x = 1 or 2 digits for unit (e.g. 'h' means an hour can be '9' or '09')
       xx = 2 digits exactly for unit (e.g. 'hh' means an hour can only be '09')
-      
+
   Special Cases:
       yy = 2 or 4 digit year
     yyyy = exactly 4 digit year
@@ -195,9 +196,9 @@ Here is what each format token means:
      ddd = Day name of 3 to 9 letters (e.g. Wed or Wednesday)
        u = microseconds matches 1 to 3 digits
 
-All other characters are considered literal. For the technically minded 
-(well you are developers), these formats are compiled into regular expressions 
-at runtime so don't add any extra overhead than using regular expressions 
+All other characters are considered literal. For the technically minded
+(well you are developers), these formats are compiled into regular expressions
+at runtime so don't add any extra overhead than using regular expressions
 directly. So, no, it won't make your app slow!
 
 To see all defined formats look in lib/validates_timeliness/formats.rb.
@@ -208,18 +209,18 @@ The perenial problem for non-US developers or applications not primarily for the
 US, is the US date format of m/d/yy. This is ambiguous with the European format
 of d/m/yy. By default the plugin uses the US formats as this is the Ruby default
 when it does date interpretation, and is in keeping PoLS (principle of least
-surprise). 
+surprise).
 
 To switch to using the European (or Rest of The World) formats put this in an
 initializer or environment.rb
 
-  ValidatesTimeliness::Formats.remove_us_formats  
+  ValidatesTimeliness::Formats.remove_us_formats
 
 Now '01/02/2000' will be parsed as 1st February 2000, instead of 2nd January 2000.
 
 === CUSTOMISING FORMATS:
 
-I hear you say "Thats greats but I don't want X format to be valid". Well to 
+I hear you say "Thats greats but I don't want X format to be valid". Well to
 remove a format stick this in an initializer file
 
   ValidatesTimeliness::Formats.remove_formats(:date, 'm\d\yy')
@@ -233,15 +234,15 @@ Ahh, then add it yourself. Again stick this in an initializer file
 
 Now "10 o'clock" will be a valid value. So easy, no more whingeing!
 
-You can embed regular expressions in the format but no gurantees that it will 
-remain intact. If you avoid the use of any token characters and regexp dots or 
-backslashes as special characters in the regexp, it may well work as expected. 
-For special characters use POSIX character classes for safety. See the ISO 8601 
+You can embed regular expressions in the format but no gurantees that it will
+remain intact. If you avoid the use of any token characters and regexp dots or
+backslashes as special characters in the regexp, it may well work as expected.
+For special characters use POSIX character classes for safety. See the ISO 8601
 datetime for an example of an embedded regular expression.
 
-Because formats are evaluated in order, adding a format which may be ambiguous 
+Because formats are evaluated in order, adding a format which may be ambiguous
 with an existing format, will mean your format is ignored. If you need to make
-your new format higher precedence than an existing format, you can include the 
+your new format higher precedence than an existing format, you can include the
 before option like so
 
   ValidatesTimeliness::Formats.add_formats(:time, 'ss:nn:hh', :before => 'hh:nn:ss')
@@ -279,7 +280,7 @@ The value should be an array of 3 values being year, month and day in that order
 
 When using the validation temporal restrictions there are times when the restriction
 value itself may be invalid. Normally this will add an error to the model such as
-'restriction :before value was invalid'. These can be annoying if you are using 
+'restriction :before value was invalid'. These can be annoying if you are using
 procs or methods as restrictions and don't care if they don't evaluate properly
 and you want the validation to complete. In these situations you turn them off.
 
@@ -288,8 +289,8 @@ To turn them off:
   ValidatesTimeliness::Validator.ignore_restriction_errors = true
 
 A word of warning though, as this may hide issues with the model and make those
-corner cases a little harder to test. In general if you are using procs or 
-model methods and you only care when they return  a value, then they should 
+corner cases a little harder to test. In general if you are using procs or
+model methods and you only care when they return  a value, then they should
 return nil in all other situations. Restrictions are skipped if they are nil.
 
 
@@ -305,10 +306,11 @@ To activate it, put this in an initializer:
 
   ValidatesTimeliness.enable_datetime_select_extension!
 
+This will be removed from v3 as it adds too little to maintain.
 
 === OTHER CUSTOMISATION:
 
-The error messages for each temporal restrictions can also be globally overridden by 
+The error messages for each temporal restrictions can also be globally overridden by
 updating the default AR error messages like so
 
 For Rails 2.0/2.1:
@@ -317,6 +319,7 @@ For Rails 2.0/2.1:
     :invalid_date     => "is not a valid date",
     :invalid_time     => "is not a valid time",
     :invalid_datetime => "is not a valid datetime",
+    :is_at            => "must be at %s",
     :before           => "must be before %s",
     :on_or_before     => "must be on or before %s",
     :after            => "must be after %s",
@@ -332,8 +335,14 @@ Rails 2.2+ using the I18n system to define new defaults:
     activerecord:
       errors:
         messages:
-          on_or_before: "must be equal to or before {{restriction}}"
-          on_or_after:  "must be equal to or after {{restriction}}"
+          invalid_date: "is not a valid date"
+          invalid_time: "is not a valid time"
+          invalid_datetime: "is not a valid datetime"
+          is_at: "must be at {{restriction}}"
+          before: "must be before {{restriction}}"
+          on_or_before: "must be on or before {{restriction}}"
+          after: "must be after {{restriction}}"
+          on_or_after: "must be on or after {{restriction}}"
           between: "must be between {{earliest}} and {{latest}}"
 
 The {{restriction}} signifies where the interpolation value for the restriction
@@ -364,9 +373,9 @@ Those are Ruby strftime formats not the plugin formats.
 === RSPEC MATCHER:
 
 To sweeten the deal that little bit more, you have an Rspec matcher available for
-you model specs. Now you can easily test the validations you have just written 
-with the plugin or better yet *before* you write them! You just use the 
-validation options you want as you would with the validation method. Those 
+you model specs. Now you can easily test the validations you have just written
+with the plugin or better yet *before* you write them! You just use the
+validation options you want as you would with the validation method. Those
 options are then verified and reported if they fail.
 
 First require it in your spec_helper.rb
@@ -391,4 +400,4 @@ The matcher names are just the singular of the validation methods.
 
 == LICENSE:
 
-Copyright (c) 2008 Adam Meehan, released under the MIT license
+Copyright (c) 2008-2010 Adam Meehan, released under the MIT license

data/Rakefile

@@ -7,10 +7,6 @@ require 'lib/validates_timeliness/version'
 
 GEM = "validates_timeliness"
 GEM_VERSION = ValidatesTimeliness::VERSION
-AUTHOR = "Adam Meehan"
-EMAIL = "adam.meehan@gmail.com"
-HOMEPAGE = "http://github.com/adzap/validates_timeliness"
-SUMMARY = "Date and time validation plugin for Rails 2.x which allows custom formats"
 
 spec = Gem::Specification.new do |s|
   s.name = GEM
@@ -19,12 +15,12 @@ spec = Gem::Specification.new do |s|
   s.rubyforge_project = "validatestime"
   s.has_rdoc = true
   s.extra_rdoc_files = ["README.rdoc", "LICENSE", "TODO", "CHANGELOG"]
-  s.summary = SUMMARY
+  s.summary = "Date and time validation plugin for Rails 2.x which allows custom formats"
   s.description = s.summary
-  s.author = AUTHOR
-  s.email = EMAIL
-  s.homepage = HOMEPAGE
-  
+  s.author = "Adam Meehan"
+  s.email = "adam.meehan@gmail.com"
+  s.homepage = "http://github.com/adzap/validates_timeliness"
+
   s.require_path = 'lib'
   s.autorequire = GEM
   s.files = %w(LICENSE README.rdoc Rakefile TODO CHANGELOG) + Dir.glob("{lib,spec}/**/*")

data/TODO

@@ -3,3 +3,6 @@
 - array of values for all temporal options
 - use tz and zo value from time string?
 - filter valid formats rather than remove for hot swapping without recompilation
+- config generator
+- move all config into top namespace
+- remove action_view stuff

data/lib/validates_timeliness.rb

@@ -8,9 +8,9 @@ require 'validates_timeliness/active_record/multiparameter_attributes'
 require 'validates_timeliness/action_view/instance_tag'
 
 module ValidatesTimeliness
-  
+
   mattr_accessor :default_timezone
-  self.default_timezone = :utc 
+  self.default_timezone = :utc
 
   mattr_accessor :use_time_zones
   self.use_time_zones = false
@@ -25,18 +25,18 @@ module ValidatesTimeliness
     end
 
     def load_error_messages
+      defaults = YAML::load(IO.read(LOCALE_PATH))['en']
+      ValidatesTimeliness::Validator.error_value_formats = defaults['validates_timeliness']['error_value_formats'].symbolize_keys
+
       if defined?(I18n)
         I18n.load_path.unshift(LOCALE_PATH)
         I18n.reload!
       else
-        defaults = YAML::load(IO.read(LOCALE_PATH))['en']
         errors = defaults['activerecord']['errors']['messages'].inject({}) {|h,(k,v)| h[k.to_sym] = v.gsub(/\{\{\w*\}\}/, '%s');h }
         ::ActiveRecord::Errors.default_error_messages.update(errors)
-
-        ValidatesTimeliness::Validator.error_value_formats = defaults['validates_timeliness']['error_value_formats'].symbolize_keys
       end
     end
-    
+
     def setup_for_rails
       self.default_timezone = ::ActiveRecord::Base.default_timezone
       self.use_time_zones = ::ActiveRecord::Base.time_zone_aware_attributes rescue false

data/lib/validates_timeliness/action_view/instance_tag.rb

@@ -1,3 +1,4 @@
+# TODO remove this from the plugin for v3.
 module ValidatesTimeliness
 
   def self.enable_datetime_select_invalid_value_extension!
@@ -6,43 +7,46 @@ module ValidatesTimeliness
 
   module ActionView
 
-    # Intercepts the date and time select helpers to allow the 
-    # attribute value before type cast to be used as in the select helpers.
-    # This means that an invalid date or time will be redisplayed rather than the
-    # type cast value which would be nil if invalid.
-    module InstanceTag    
-    
+    # Intercepts the date and time select helpers to reuse the values from the
+    # the params rather than the parsed value. This allows invalid date/time
+    # values to be redisplayed instead of blanks to aid correction by the user.
+    # Its a minor usability improvement which is rarely an issue for the user.
+    #
+    module InstanceTag
+
       def self.included(base)
-        selector_method = Rails::VERSION::STRING < '2.2' ? :date_or_time_select : :datetime_selector
+        selector_method = Rails::VERSION::STRING.to_f < 2.2 ? :date_or_time_select : :datetime_selector
         base.class_eval do
           alias_method :datetime_selector_without_timeliness, selector_method
           alias_method selector_method, :datetime_selector_with_timeliness
         end
         base.alias_method_chain :value, :timeliness
       end
-      
-      TimelinessDateTime = Struct.new(:year, :month, :day, :hour, :min, :sec)      
-        
+
+      TimelinessDateTime = Struct.new(:year, :month, :day, :hour, :min, :sec)
+
       def datetime_selector_with_timeliness(*args)
         @timeliness_date_or_time_tag = true
         datetime_selector_without_timeliness(*args)
       end
-    
+
       def value_with_timeliness(object)
-        return value_without_timeliness(object) unless @timeliness_date_or_time_tag
-        
-        raw_value = value_before_type_cast(object)
-        
-        if raw_value.nil? || raw_value.acts_like?(:time) || raw_value.is_a?(Date)
+        unless @timeliness_date_or_time_tag && @template_object.params[@object_name]
           return value_without_timeliness(object)
         end
-        
-        time_array = ValidatesTimeliness::Formats.parse(raw_value, :datetime)
-        
-        TimelinessDateTime.new(*time_array[0..5])
-      end      
-       
+
+        pairs = @template_object.params[@object_name].select {|k,v| k =~ /^#{@method_name}\(/ }
+        return value_without_timeliness(object) if pairs.empty?
+
+        values = pairs.map do |(param, value)|
+          position = param.scan(/\(([0-9]*).*\)/).first.first
+          [position, value]
+        end.sort {|a,b| a[0] <=> b[0] }.map {|v| v[1] }
+
+        TimelinessDateTime.new(*values)
+      end
+
     end
 
-  end   
+  end
 end

data/lib/validates_timeliness/active_record/attribute_methods.rb

@@ -51,15 +51,17 @@ module ValidatesTimeliness
             if [:date, :time, :datetime].include?(column.type)
               time_zone_aware = create_time_zone_conversion_attribute?(name, column) rescue false
 
-              define_method("#{name}=") do |value|
+              method_name = "#{name}="
+              define_method(method_name) do |value|
                 write_date_time_attribute(name, value, column.type, time_zone_aware)
               end
-              timeliness_methods << name
+              timeliness_methods << method_name
             end
           end
 
           define_attribute_methods_without_timeliness
-          @generated_methods += timeliness_methods
+          # add generated methods which is a Set object hence no += method
+          timeliness_methods.each {|attr| generated_methods << attr }
         end
 
       end