validates_timeliness 2.2.2 → 2.3.0

data/lib/validates_timeliness/validator.rb

@@ -1,33 +1,37 @@
+#TODO remove deprecated option :equal_to
 module ValidatesTimeliness
 
   class Validator
+    cattr_accessor :error_value_formats
     cattr_accessor :ignore_restriction_errors
     self.ignore_restriction_errors = false
 
     RESTRICTION_METHODS = {
+      :is_at        => :==,
       :equal_to     => :==,
-      :before       => :<, 
-      :after        => :>, 
+      :before       => :<,
+      :after        => :>,
       :on_or_before => :<=,
       :on_or_after  => :>=,
-      :between      => lambda {|v, r| (r.first..r.last).include?(v) } 
+      :between      => lambda {|v, r| (r.first..r.last).include?(v) }
     }
 
-    VALID_OPTIONS = [
+    VALID_OPTION_KEYS = [
       :on, :if, :unless, :allow_nil, :empty, :allow_blank,
       :with_time, :with_date, :ignore_usec, :format,
       :invalid_time_message, :invalid_date_message, :invalid_datetime_message
     ] + RESTRICTION_METHODS.keys.map {|option| [option, "#{option}_message".to_sym] }.flatten
 
+    DEFAULT_OPTIONS = { :on => :save, :type => :datetime, :allow_nil => false, :allow_blank => false, :ignore_usec => false }
+
     attr_reader :configuration, :type
 
     def initialize(configuration)
-      defaults = { :on => :save, :type => :datetime, :allow_nil => false, :allow_blank => false, :ignore_usec => false }
-      @configuration = defaults.merge(configuration)
+      @configuration = DEFAULT_OPTIONS.merge(configuration)
       @type = @configuration.delete(:type)
       validate_options(@configuration)
     end
-      
+
     def call(record, attr_name, value)
       raw_value = raw_value(record, attr_name) || value
 
@@ -44,7 +48,7 @@ module ValidatesTimeliness
     end
 
     def error_messages
-      @error_messages ||= self.class.default_error_messages.merge(custom_error_messages)
+      @error_messages ||= ::ActiveRecord::Errors.default_error_messages.merge(custom_error_messages)
     end
 
    private
@@ -52,7 +56,7 @@ module ValidatesTimeliness
     def raw_value(record, attr_name)
       record.send("#{attr_name}_before_type_cast") rescue nil
     end
-   
+
     def validate_restrictions(record, attr_name, value)
       if configuration[:with_time] || configuration[:with_date]
         value = combine_date_and_time(value, record)
@@ -81,14 +85,13 @@ module ValidatesTimeliness
     end
 
     def interpolation_values(option, restriction)
-      format = self.class.error_value_formats[type]
+      format = self.class.error_value_format_for(type)
       restriction = [restriction] unless restriction.is_a?(Array)
 
       if defined?(I18n)
-        message = I18n.t('activerecord.errors.messages')[option]
-        subs = message.scan(/\{\{([^\}]*)\}\}/)
         interpolations = {}
-        subs.each_with_index {|s, i| interpolations[s[0].to_sym] = restriction[i].strftime(format) }
+        keys = restriction.size == 1 ? [:restriction] : [:earliest, :latest]
+        keys.each_with_index {|key, i| interpolations[key] = restriction[i].strftime(format) }
         interpolations
       else
         restriction.map {|r| r.strftime(format) }
@@ -105,21 +108,20 @@ module ValidatesTimeliness
         comparator.call(value, restriction)
       end
     end
-    
+
     def add_error(record, attr_name, message, interpolate=nil)
       if defined?(I18n)
         custom = custom_error_messages[message]
         record.errors.add(attr_name, message, { :default => custom }.merge(interpolate || {}))
       else
         message = error_messages[message] if message.is_a?(Symbol)
-        message = message % interpolate
-        record.errors.add(attr_name, message)
+        record.errors.add(attr_name, message % interpolate)
       end
     end
 
     def custom_error_messages
       @custom_error_messages ||= configuration.inject({}) {|msgs, (k, v)|
-        if md = /(.*)_message$/.match(k.to_s) 
+        if md = /(.*)_message$/.match(k.to_s)
           msgs[md[1].to_sym] = v
         end
         msgs
@@ -140,39 +142,34 @@ module ValidatesTimeliness
     end
 
     def validate_options(options)
+      if options.key?(:equal_to)
+        ::ActiveSupport::Deprecation.warn("ValidatesTimeliness :equal_to option is deprecated due to clash with a default Rails option. Use :is_at instead. You will need to fix any I18n error message references to this option date/time attributes now.")
+        options[:is_at] = options.delete(:equal_to)
+        options[:is_at_message] = options.delete(:equal_to_message)
+      end
+
       invalid_for_type = ([:time, :date, :datetime] - [type]).map {|k| "invalid_#{k}_message".to_sym }
       invalid_for_type << :with_date unless type == :time
       invalid_for_type << :with_time unless type == :date
-      options.assert_valid_keys(VALID_OPTIONS - invalid_for_type)
+      options.assert_valid_keys(VALID_OPTION_KEYS - invalid_for_type)
     end
 
     def implied_type
-      @implied_type ||= configuration[:with_date] || configuration[:with_time] ? :datetime : type 
+      @implied_type ||= configuration[:with_date] || configuration[:with_time] ? :datetime : type
     end
 
     # class methods
     class << self
 
-      def default_error_messages
+      def error_value_format_for(type)
         if defined?(I18n)
-          I18n.t('activerecord.errors.messages')
+          # work around for syntax check in vendored I18n for Rails <= 2.3.3
+          I18n.t('validates_timeliness.error_value_formats')[type] || error_value_formats[type]
         else
-          ::ActiveRecord::Errors.default_error_messages
+          error_value_formats[type]
         end
       end
 
-      def error_value_formats
-        if defined?(I18n)
-          I18n.t('validates_timeliness.error_value_formats')
-        else
-          @@error_value_formats
-        end
-      end
-
-      def error_value_formats=(formats)
-        @@error_value_formats = formats
-      end
-
       def evaluate_option_value(value, type, record)
         case value
         when Time, Date

data/lib/validates_timeliness/version.rb

@@ -1,3 +1,3 @@
 module ValidatesTimeliness
-  VERSION = "2.2.2"
+  VERSION = "2.3.0"
 end

data/spec/action_view/instance_tag_spec.rb

@@ -1,42 +1,194 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-ValidatesTimeliness.enable_datetime_select_extension!
-
 describe 'ValidatesTimeliness::ActionView::InstanceTag' do
   include ActionView::Helpers::DateHelper
   include ActionController::Assertions::SelectorAssertions
-  
+
   before do
     @person = Person.new
   end
-  
-  it "should display invalid datetime as datetime_select values" do
-    @person.birth_date_and_time = "2008-02-30 12:00:22"
-    output = datetime_select(:person, :birth_date_and_time, :include_blank => true, :include_seconds => true)
-   
-    output.should have_tag('select[id=person_birth_date_and_time_1i]') do
-      with_tag('option[selected=selected]', '2008')
+
+  def params
+    @params ||= {}
+  end
+
+  describe "datetime_select" do
+    it "should use param values when attribute is nil" do
+      params["person"] = {
+        "birth_date_and_time(1i)" => 2009,
+        "birth_date_and_time(2i)" => 2,
+        "birth_date_and_time(3i)" => 29,
+        "birth_date_and_time(4i)" => 12,
+        "birth_date_and_time(5i)" => 13,
+        "birth_date_and_time(6i)" => 14,
+      }
+      @person.birth_date_and_time = nil
+      output = datetime_select(:person, :birth_date_and_time, :include_blank => true, :include_seconds => true)
+      output.should have_tag('select[id=person_birth_date_and_time_1i] option[selected=selected]', '2009')
+      output.should have_tag('select[id=person_birth_date_and_time_2i] option[selected=selected]', 'February')
+      output.should have_tag('select[id=person_birth_date_and_time_3i] option[selected=selected]', '29')
+      output.should have_tag('select[id=person_birth_date_and_time_4i] option[selected=selected]', '12')
+      output.should have_tag('select[id=person_birth_date_and_time_5i] option[selected=selected]', '13')
+      output.should have_tag('select[id=person_birth_date_and_time_6i] option[selected=selected]', '14')
+    end
+
+    it "should override object values and use params if present" do
+      params["person"] = {
+        "birth_date_and_time(1i)" => 2009,
+        "birth_date_and_time(2i)" => 2,
+        "birth_date_and_time(3i)" => 29,
+        "birth_date_and_time(4i)" => 13,
+        "birth_date_and_time(5i)" => 14,
+        "birth_date_and_time(6i)" => 15,
+      }
+      @person.birth_date_and_time = "2009-03-01 13:14:15"
+      output = datetime_select(:person, :birth_date_and_time, :include_blank => true, :include_seconds => true)
+      output.should have_tag('select[id=person_birth_date_and_time_1i] option[selected=selected]', '2009')
+      output.should have_tag('select[id=person_birth_date_and_time_2i] option[selected=selected]', 'February')
+      output.should have_tag('select[id=person_birth_date_and_time_3i] option[selected=selected]', '29')
+      output.should have_tag('select[id=person_birth_date_and_time_4i] option[selected=selected]', '13')
+      output.should have_tag('select[id=person_birth_date_and_time_5i] option[selected=selected]', '14')
+      output.should have_tag('select[id=person_birth_date_and_time_6i] option[selected=selected]', '15')
     end
-    output.should have_tag('select[id=person_birth_date_and_time_2i]') do
-      with_tag('option[selected=selected]', 'February')
+
+    it "should select attribute values from object if no params" do
+      @person.birth_date_and_time = "2009-01-02 13:14:15"
+      output = datetime_select(:person, :birth_date_and_time, :include_blank => true, :include_seconds => true)
+      output.should have_tag('select[id=person_birth_date_and_time_1i] option[selected=selected]', '2009')
+      output.should have_tag('select[id=person_birth_date_and_time_2i] option[selected=selected]', 'January')
+      output.should have_tag('select[id=person_birth_date_and_time_3i] option[selected=selected]', '2')
+      output.should have_tag('select[id=person_birth_date_and_time_4i] option[selected=selected]', '13')
+      output.should have_tag('select[id=person_birth_date_and_time_5i] option[selected=selected]', '14')
+      output.should have_tag('select[id=person_birth_date_and_time_6i] option[selected=selected]', '15')
+    end
+
+    it "should select attribute values if params does not contain attribute params" do
+      @person.birth_date_and_time = "2009-01-02 13:14:15"
+      params["person"] = { }
+      output = datetime_select(:person, :birth_date_and_time, :include_blank => true, :include_seconds => true)
+      output.should have_tag('select[id=person_birth_date_and_time_1i] option[selected=selected]', '2009')
+      output.should have_tag('select[id=person_birth_date_and_time_2i] option[selected=selected]', 'January')
+      output.should have_tag('select[id=person_birth_date_and_time_3i] option[selected=selected]', '2')
+      output.should have_tag('select[id=person_birth_date_and_time_4i] option[selected=selected]', '13')
+      output.should have_tag('select[id=person_birth_date_and_time_5i] option[selected=selected]', '14')
+      output.should have_tag('select[id=person_birth_date_and_time_6i] option[selected=selected]', '15')
+    end
+
+    it "should not select values when attribute value is nil and has no param values" do
+      @person.birth_date_and_time = nil
+      output = datetime_select(:person, :birth_date_and_time, :include_blank => true, :include_seconds => true)
+      output.should_not have_tag('select[id=person_birth_date_and_time_1i] option[selected=selected]')
+      output.should_not have_tag('select[id=person_birth_date_and_time_2i] option[selected=selected]')
+      output.should_not have_tag('select[id=person_birth_date_and_time_3i] option[selected=selected]')
+      output.should_not have_tag('select[id=person_birth_date_and_time_4i] option[selected=selected]')
+      output.should_not have_tag('select[id=person_birth_date_and_time_5i] option[selected=selected]')
+      output.should_not have_tag('select[id=person_birth_date_and_time_6i] option[selected=selected]')
+    end
+  end
+
+  describe "date_select" do
+    it "should use param values when attribute is nil" do
+      params["person"] = {
+        "birth_date(1i)" => 2009,
+        "birth_date(2i)" => 2,
+        "birth_date(3i)" => 29,
+      }
+      @person.birth_date = nil
+      output = date_select(:person, :birth_date, :include_blank => true, :include_seconds => true)
+      output.should have_tag('select[id=person_birth_date_1i] option[selected=selected]', '2009')
+      output.should have_tag('select[id=person_birth_date_2i] option[selected=selected]', 'February')
+      output.should have_tag('select[id=person_birth_date_3i] option[selected=selected]', '29')
     end
-    output.should have_tag('select[id=person_birth_date_and_time_3i]') do
-      with_tag('option[selected=selected]', '30')
+
+    it "should override object values and use params if present" do
+      params["person"] = {
+        "birth_date(1i)" => 2009,
+        "birth_date(2i)" => 2,
+        "birth_date(3i)" => 29,
+      }
+      @person.birth_date = "2009-03-01"
+      output = date_select(:person, :birth_date, :include_blank => true, :include_seconds => true)
+      output.should have_tag('select[id=person_birth_date_1i] option[selected=selected]', '2009')
+      output.should have_tag('select[id=person_birth_date_2i] option[selected=selected]', 'February')
+      output.should have_tag('select[id=person_birth_date_3i] option[selected=selected]', '29')
     end
-    output.should have_tag('select[id=person_birth_date_and_time_4i]') do
-      with_tag('option[selected=selected]', '12')
+
+    it "should select attribute values from object if no params" do
+      @person.birth_date = "2009-01-02"
+      output = date_select(:person, :birth_date, :include_blank => true, :include_seconds => true)
+      output.should have_tag('select[id=person_birth_date_1i] option[selected=selected]', '2009')
+      output.should have_tag('select[id=person_birth_date_2i] option[selected=selected]', 'January')
+      output.should have_tag('select[id=person_birth_date_3i] option[selected=selected]', '2')
     end
-    output.should have_tag('select[id=person_birth_date_and_time_5i]') do
-      with_tag('option[selected=selected]', '00')
+
+    it "should select attribute values if params does not contain attribute params" do
+      @person.birth_date = "2009-01-02"
+      params["person"] = { }
+      output = date_select(:person, :birth_date, :include_blank => true, :include_seconds => true)
+      output.should have_tag('select[id=person_birth_date_1i] option[selected=selected]', '2009')
+      output.should have_tag('select[id=person_birth_date_2i] option[selected=selected]', 'January')
+      output.should have_tag('select[id=person_birth_date_3i] option[selected=selected]', '2')
     end
-    output.should have_tag('select[id=person_birth_date_and_time_6i]') do
-      with_tag('option[selected=selected]', '22')
+
+    it "should not select values when attribute value is nil and has no param values" do
+      @person.birth_date = nil
+      output = date_select(:person, :birth_date, :include_blank => true, :include_seconds => true)
+      output.should_not have_tag('select[id=person_birth_date_1i] option[selected=selected]')
+      output.should_not have_tag('select[id=person_birth_date_2i] option[selected=selected]')
+      output.should_not have_tag('select[id=person_birth_date_3i] option[selected=selected]')
     end
   end
-  
-  it "should display datetime_select when datetime value is nil" do
-    @person.birth_date_and_time = nil
-    output = datetime_select(:person, :birth_date_and_time, :include_blank => true, :include_seconds => true)
-    output.should have_tag('select', 6)
+
+  describe "time_select" do
+    before :all do
+      Time.now = Time.mktime(2009,1,1)
+    end
+
+    it "should use param values when attribute is nil" do
+      params["person"] = {
+        "birth_time(1i)" => 2000,
+        "birth_time(2i)" => 1,
+        "birth_time(3i)" => 1,
+        "birth_time(4i)" => 12,
+        "birth_time(5i)" => 13,
+        "birth_time(6i)" => 14,
+      }
+      @person.birth_time = nil
+      output = time_select(:person, :birth_time, :include_blank => true, :include_seconds => true)
+      output.should have_tag('input[id=person_birth_time_1i][value=2000]')
+      output.should have_tag('input[id=person_birth_time_2i][value=1]')
+      output.should have_tag('input[id=person_birth_time_3i][value=1]')
+      output.should have_tag('select[id=person_birth_time_4i] option[selected=selected]', '12')
+      output.should have_tag('select[id=person_birth_time_5i] option[selected=selected]', '13')
+      output.should have_tag('select[id=person_birth_time_6i] option[selected=selected]', '14')
+    end
+
+    it "should select attribute values from object if no params" do
+      @person.birth_time = "13:14:15"
+      output = time_select(:person, :birth_time, :include_blank => true, :include_seconds => true)
+      output.should have_tag('input[id=person_birth_time_1i][value=2000]')
+      output.should have_tag('input[id=person_birth_time_2i][value=1]')
+      output.should have_tag('input[id=person_birth_time_3i][value=1]')
+      output.should have_tag('select[id=person_birth_time_4i] option[selected=selected]', '13')
+      output.should have_tag('select[id=person_birth_time_5i] option[selected=selected]', '14')
+      output.should have_tag('select[id=person_birth_time_6i] option[selected=selected]', '15')
+    end
+
+    it "should not select values when attribute value is nil and has no param values" do
+      @person.birth_time = nil
+      output = time_select(:person, :birth_time, :include_blank => true, :include_seconds => true)
+      output.should have_tag('input[id=person_birth_time_1i][value=""]')
+      # Annoyingly these may or not have value attribute depending on rails version.
+      # output.should have_tag('input[id=person_birth_time_2i][value=""]')
+      # output.should have_tag('input[id=person_birth_time_3i][value=""]')
+      output.should_not have_tag('select[id=person_birth_time_4i] option[selected=selected]')
+      output.should_not have_tag('select[id=person_birth_time_5i] option[selected=selected]')
+      output.should_not have_tag('select[id=person_birth_time_6i] option[selected=selected]')
+    end
+
+    after :all do
+      Time.now = nil
+    end
   end
+
 end

data/spec/active_record/attribute_methods_spec.rb

@@ -5,7 +5,9 @@ describe ValidatesTimeliness::ActiveRecord::AttributeMethods do
     @person = Person.new
   end
 
-  it "should call write_date_time_attribute when date attribute assigned value" do
+  it "should define and call write method on first assign" do
+    Person.class_eval { @generated_methods = Set.new }
+    Person.send(:undef_method, :birth_date=)
     @person.should_receive(:write_date_time_attribute)
     @person.birth_date = "2000-01-01"
   end
@@ -40,7 +42,7 @@ describe ValidatesTimeliness::ActiveRecord::AttributeMethods do
     @person.birth_date_and_time = time_string
     @person.birth_date_and_time_before_type_cast.should == time_string
   end
-  
+
   it "should return Time object for attribute_before_type_cast when written as Time" do
     @person.birth_date_and_time = Time.mktime(2000, 1, 1, 2, 3, 4)
     @person.birth_date_and_time_before_type_cast.should be_kind_of(Time)
@@ -59,24 +61,24 @@ describe ValidatesTimeliness::ActiveRecord::AttributeMethods do
   it "should return Time object for datetime attribute read method when assigned string" do
     @person.birth_date_and_time = "2000-01-01 02:03:04"
     @person.birth_date_and_time.should be_kind_of(Time)
-  end    
- 
+  end
+
   it "should return Date object for date attribute read method when assigned Date object" do
     @person.birth_date = Date.today
     @person.birth_date.should be_kind_of(Date)
-  end  
- 
+  end
+
   it "should return Date object for date attribute read method when assigned string" do
     @person.birth_date = '2000-01-01'
     @person.birth_date.should be_kind_of(Date)
-  end 
- 
+  end
+
   it "should return nil when time is invalid" do
     @person.birth_date_and_time = "2000-01-32 02:03:04"
     @person.birth_date_and_time.should be_nil
   end
 
-  it "should not save invalid date value to database" do        
+  it "should not save invalid date value to database" do
     time_string = "2000-01-32 02:03:04"
     @person = Person.new
     @person.birth_date_and_time = time_string
@@ -84,7 +86,7 @@ describe ValidatesTimeliness::ActiveRecord::AttributeMethods do
     @person.reload
     @person.birth_date_and_time_before_type_cast.should be_nil
   end
-  
+
   if RAILS_VER < '2.1'
 
     it "should return time object from database in default timezone" do
@@ -94,7 +96,7 @@ describe ValidatesTimeliness::ActiveRecord::AttributeMethods do
       @person.birth_date_and_time = time_string
       @person.save
       @person.reload
-      @person.birth_date_and_time.strftime('%Y-%m-%d %H:%M:%S %Z').should == time_string + ' GMT'
+      @person.birth_date_and_time.strftime('%Y-%m-%d %H:%M:%S %Z').should == time_string + ' UTC'
     end
 
   else
@@ -106,7 +108,7 @@ describe ValidatesTimeliness::ActiveRecord::AttributeMethods do
       @person.birth_date_and_time.strftime('%Y-%m-%d %H:%M:%S %Z %z').should == time_string + ' EST +1000'
     end
 
-    it "should return time object from database in correct timezone" do        
+    it "should return time object from database in correct timezone" do
       Time.zone = 'Melbourne'
       time_string = "2000-06-01 09:00:00"
       @person = Person.new
@@ -115,19 +117,19 @@ describe ValidatesTimeliness::ActiveRecord::AttributeMethods do
       @person.reload
       @person.birth_date_and_time.strftime('%Y-%m-%d %H:%M:%S %Z %z').should == time_string + ' EST +1000'
     end
-    
+
   end
-  
+
   it "should return correct date value after new value assigned" do
     today = Date.today
-    tomorrow = Date.today + 1.day    
+    tomorrow = Date.today + 1.day
     @person = Person.new
     @person.birth_date = today
     @person.birth_date.should == today
     @person.birth_date = tomorrow
     @person.birth_date.should == tomorrow
   end
- 
+
   it "should update date attribute on existing object" do
     today = Date.today
     tomorrow = Date.today + 1.day