validates_timeliness 3.0.15 → 4.0.0

data/lib/validates_timeliness/helper_methods.rb

@@ -14,8 +14,14 @@ module ActiveModel
         timeliness_validation_for attr_names, :datetime
       end
 
-      def timeliness_validation_for(attr_names, type)
-        validates_with TimelinessValidator, _merge_attributes(attr_names).merge(:type => type)
+      def validates_timeliness_of(*attr_names)
+        timeliness_validation_for attr_names
+      end
+
+      def timeliness_validation_for(attr_names, type=nil)
+        options = _merge_attributes(attr_names)
+        options.update(:type => type) if type
+        validates_with TimelinessValidator, options
       end
     end
 

data/lib/validates_timeliness/orm/active_record.rb

@@ -14,28 +14,74 @@ module ValidatesTimeliness
           timeliness_column_for_attribute(attr_name).type
         end
 
-        def timeliness_column_for_attribute(attr_name)
-          columns_hash.fetch(attr_name.to_s) do |attr_name|
-            validation_type = _validators[attr_name.to_sym].find {|v| v.kind == :timeliness }.type
-            ::ActiveRecord::ConnectionAdapters::Column.new(attr_name, nil, validation_type.to_s)
+        if ActiveModel.version >= Gem::Version.new('4.2')
+          def timeliness_column_for_attribute(attr_name)
+            columns_hash.fetch(attr_name.to_s) do |attr_name|
+              validation_type = _validators[attr_name.to_sym].find {|v| v.kind == :timeliness }.type.to_s
+              ::ActiveRecord::ConnectionAdapters::Column.new(attr_name, nil, lookup_cast_type(validation_type), validation_type)
+            end
+          end
+          
+          def lookup_cast_type(sql_type)
+            case sql_type
+            when 'datetime' then ::ActiveRecord::Type::DateTime.new 
+            when 'date' then ::ActiveRecord::Type::Date.new 
+            when 'time' then ::ActiveRecord::Type::Time.new 
+            end
+          end
+        else
+          def timeliness_column_for_attribute(attr_name)
+            columns_hash.fetch(attr_name.to_s) do |attr_name|
+              validation_type = _validators[attr_name.to_sym].find {|v| v.kind == :timeliness }.type.to_s
+              ::ActiveRecord::ConnectionAdapters::Column.new(attr_name, nil, validation_type)
+            end
           end
         end
 
         def define_attribute_methods
-          super.tap do |attribute_methods_generated|
-            define_timeliness_methods true
-          end
+          super.tap { 
+            generated_timeliness_methods.synchronize do
+              return if @timeliness_methods_generated
+              define_timeliness_methods true
+              @timeliness_methods_generated = true
+            end
+          }
         end
 
-        protected
+        def undefine_attribute_methods
+          super.tap { 
+            generated_timeliness_methods.synchronize do
+              return unless @timeliness_methods_generated
+              undefine_timeliness_attribute_methods 
+              @timeliness_methods_generated = true
+            end
+          }
+        end
+        # Override to overwrite methods in ActiveRecord attribute method module because in AR 4+
+        # there is curious code which calls the method directly from the generated methods module
+        # via bind inside method_missing. This means our method in the formerly custom timeliness
+        # methods module was never reached.
+        def generated_timeliness_methods
+          generated_attribute_methods
+        end
+      end
 
-        def timeliness_type_cast_code(attr_name, var_name)
-          type = timeliness_attribute_type(attr_name)
+      def write_timeliness_attribute(attr_name, value)
+        @timeliness_cache ||= {}
+        @timeliness_cache[attr_name] = value
 
-          method_body = super
-          method_body << "\n#{var_name} = #{var_name}.to_date if #{var_name}" if type == :date
-          method_body
+        if ValidatesTimeliness.use_plugin_parser
+          type = self.class.timeliness_attribute_type(attr_name)
+          timezone = :current if self.class.timeliness_attribute_timezone_aware?(attr_name)
+          value = Timeliness::Parser.parse(value, type, :zone => timezone)
+          value = value.to_date if value && type == :date
         end
+
+        write_attribute(attr_name, value)
+      end
+      
+      def read_timeliness_attribute_before_type_cast(attr_name)
+        @timeliness_cache && @timeliness_cache[attr_name] || read_attribute_before_type_cast(attr_name)
       end
 
       def reload(*args)

data/lib/validates_timeliness/validator.rb

@@ -5,7 +5,7 @@ module ValidatesTimeliness
   class Validator < ActiveModel::EachValidator
     include Conversion
 
-    attr_reader :type
+    attr_reader :type, :attributes
 
     RESTRICTIONS = {
       :is_at        => :==,
@@ -42,16 +42,24 @@ module ValidatesTimeliness
       end
 
       @restrictions_to_check = RESTRICTIONS.keys & options.keys
+
       super
+
+      setup_timeliness_validated_attributes(options[:class]) if options[:class]
     end
 
-    def setup(model)
+    def setup_timeliness_validated_attributes(model)
       if model.respond_to?(:timeliness_validated_attributes)
         model.timeliness_validated_attributes ||= []
-        model.timeliness_validated_attributes |= @attributes
+        model.timeliness_validated_attributes |= attributes
       end
     end
 
+    # Rails 4.0 compatibility for old #setup method with class as arg
+    if ActiveModel.version <= Gem::Version.new('4.1')
+      alias_method(:setup, :setup_timeliness_validated_attributes) 
+    end
+
     def validate_each(record, attr_name, value)
       raw_value = attribute_raw_value(record, attr_name) || value
       return if (@allow_nil && raw_value.nil?) || (@allow_blank && raw_value.blank?)
@@ -93,8 +101,8 @@ module ValidatesTimeliness
     end
 
     def attribute_raw_value(record, attr_name)
-      record.respond_to?(:_timeliness_raw_value_for) &&
-        record._timeliness_raw_value_for(attr_name.to_s)
+      record.respond_to?(:read_timeliness_attribute_before_type_cast) &&
+        record.read_timeliness_attribute_before_type_cast(attr_name.to_s)
     end
 
     def timezone_aware?(record, attr_name)

data/lib/validates_timeliness/version.rb

@@ -1,3 +1,3 @@
 module ValidatesTimeliness
-  VERSION = '3.0.15'
+  VERSION = '4.0.0'
 end

data/spec/spec_helper.rb

@@ -5,13 +5,13 @@ require 'active_model/validations'
 require 'active_record'
 require 'action_view'
 require 'timecop'
-require 'rspec_tag_matchers'
 
 require 'validates_timeliness'
 
 require 'support/test_model'
 require 'support/model_helpers'
 require 'support/config_helper'
+require 'support/tag_matcher'
 
 ValidatesTimeliness.setup do |c|
   c.extend_orms = [ :active_record ]
@@ -24,6 +24,7 @@ Time.zone = 'Australia/Melbourne'
 
 LOCALE_PATH = File.expand_path(File.dirname(__FILE__) + '/../lib/generators/validates_timeliness/templates/en.yml')
 I18n.load_path.unshift(LOCALE_PATH)
+I18n.available_locales = ['en', 'es']
 
 # Extend TestModel as you would another ORM/ODM module
 module TestModelShim
@@ -85,7 +86,7 @@ end
 
 RSpec.configure do |c|
   c.mock_with :rspec
-  c.include(RspecTagMatchers)
+  c.include(TagMatcher)
   c.include(ModelHelpers)
   c.include(ConfigHelper)
   c.before do

data/spec/support/model_helpers.rb

@@ -3,15 +3,15 @@ module ModelHelpers
   # Some test helpers from Rails source 
   def invalid!(attr_name, values, error = nil)
     with_each_person_value(attr_name, values) do |record, value|
-      record.should be_invalid
-      record.errors[attr_name].size.should >= 1
-      record.errors[attr_name].first.should == error if error
+      expect(record).to be_invalid
+      expect(record.errors[attr_name].size).to be >= 1
+      expect(record.errors[attr_name].first).to eq(error) if error
     end
   end
 
   def valid!(attr_name, values)
     with_each_person_value(attr_name, values) do |record, value|
-      record.should be_valid
+      expect(record).to be_valid
     end
   end
 

data/spec/support/tag_matcher.rb

@@ -0,0 +1,35 @@
+require 'nokogiri'
+
+module TagMatcher
+  extend RSpec::Matchers::DSL
+
+  matcher :have_tag do |selector|
+    match do |subject|
+      matches = doc(subject).search(selector)
+
+      if @inner_text
+        matches = matches.select { |element| element.inner_text == @inner_text }
+      end
+
+      matches.any?
+    end
+
+    chain :with_inner_text do |inner_text|
+      @inner_text = inner_text
+    end
+
+    private
+
+    def body(subject)
+      if subject.respond_to?(:body)
+        subject.body
+      else
+        subject.to_s
+      end
+    end
+
+    def doc(subject)
+      @doc ||= Nokogiri::HTML(body(subject))
+    end
+  end
+end

data/spec/support/test_model.rb

@@ -5,7 +5,6 @@ module TestModel
   include ActiveModel::AttributeMethods
 
   included do
-    attribute_method_suffix ""
     attribute_method_suffix "="
     cattr_accessor :model_attributes
   end

data/spec/validates_timeliness/attribute_methods_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 describe ValidatesTimeliness::AttributeMethods do
-  it 'should define _timeliness_raw_value_for instance method' do
-    PersonWithShim.new.should respond_to(:_timeliness_raw_value_for)
+  it 'should define read_timeliness_attribute_before_type_cast instance method' do
+    expect(PersonWithShim.new).to respond_to(:read_timeliness_attribute_before_type_cast)
   end
 
   describe ".timeliness_validated_attributes" do
@@ -12,7 +12,7 @@ describe ValidatesTimeliness::AttributeMethods do
       PersonWithShim.validates_time :birth_time
       PersonWithShim.validates_datetime :birth_datetime
 
-      PersonWithShim.timeliness_validated_attributes.should == [ :birth_date, :birth_time, :birth_datetime ]
+      expect(PersonWithShim.timeliness_validated_attributes).to eq([ :birth_date, :birth_time, :birth_datetime ])
     end
   end
   
@@ -31,13 +31,13 @@ describe ValidatesTimeliness::AttributeMethods do
     it 'should cache attribute raw value' do
       r = PersonWithCache.new
       r.birth_datetime = date_string = '2010-01-01'
-      r._timeliness_raw_value_for('birth_datetime').should == date_string
+      expect(r.read_timeliness_attribute_before_type_cast('birth_datetime')).to eq(date_string)
     end
 
     it 'should not overwrite user defined methods' do
       e = Employee.new
       e.birth_date = '2010-01-01'
-      e.redefined_birth_date_called.should be_true
+      expect(e.redefined_birth_date_called).to be_truthy
     end
 
     it 'should be undefined if model class has dynamic attribute methods reset' do
@@ -46,13 +46,13 @@ describe ValidatesTimeliness::AttributeMethods do
       r = PersonWithShim.new
       r.birth_date = Time.now
 
-      write_method = RUBY_VERSION < '1.9' ? 'birth_date=' : :birth_date=
+      write_method = :birth_date=
 
-      PersonWithShim.send(:generated_timeliness_methods).instance_methods.should include(write_method)
+      expect(PersonWithShim.send(:generated_timeliness_methods).instance_methods).to include(write_method)
 
       PersonWithShim.undefine_attribute_methods 
 
-      PersonWithShim.send(:generated_timeliness_methods).instance_methods.should_not include(write_method)
+      expect(PersonWithShim.send(:generated_timeliness_methods).instance_methods).not_to include(write_method)
     end
 
     context "with plugin parser" do
@@ -70,7 +70,7 @@ describe ValidatesTimeliness::AttributeMethods do
       end
 
       it 'should parse a string value' do
-        Timeliness::Parser.should_receive(:parse)
+        expect(Timeliness::Parser).to receive(:parse)
         r = PersonWithParser.new
         r.birth_date = '2010-01-01'
       end
@@ -80,7 +80,7 @@ describe ValidatesTimeliness::AttributeMethods do
 
   context "before_type_cast method" do
     it 'should not be defined if ORM does not support it' do
-      PersonWithShim.new.should_not respond_to(:birth_datetime_before_type_cast)
+      expect(PersonWithShim.new).not_to respond_to(:birth_datetime_before_type_cast)
     end
   end
 end

data/spec/validates_timeliness/conversion_spec.rb

@@ -12,68 +12,68 @@ describe ValidatesTimeliness::Conversion do
   describe "#type_cast_value" do
     describe "for date type" do
       it "should return same value for date value" do
-        type_cast_value(Date.new(2010, 1, 1), :date).should == Date.new(2010, 1, 1)
+        expect(type_cast_value(Date.new(2010, 1, 1), :date)).to eq(Date.new(2010, 1, 1))
       end
 
       it "should return date part of time value" do
-        type_cast_value(Time.mktime(2010, 1, 1, 0, 0, 0), :date).should == Date.new(2010, 1, 1)
+        expect(type_cast_value(Time.mktime(2010, 1, 1, 0, 0, 0), :date)).to eq(Date.new(2010, 1, 1))
       end
 
       it "should return date part of datetime value" do
-        type_cast_value(DateTime.new(2010, 1, 1, 0, 0, 0), :date).should == Date.new(2010, 1, 1)
+        expect(type_cast_value(DateTime.new(2010, 1, 1, 0, 0, 0), :date)).to eq(Date.new(2010, 1, 1))
       end
 
       it 'should return nil for invalid value types' do
-        type_cast_value(12, :date).should == nil
+        expect(type_cast_value(12, :date)).to eq(nil)
       end
     end
 
     describe "for time type" do
       it "should return same value for time value matching dummy date part" do
-        type_cast_value(Time.utc(2000, 1, 1, 0, 0, 0), :time).should == Time.utc(2000, 1, 1, 0, 0, 0)
+        expect(type_cast_value(Time.utc(2000, 1, 1, 0, 0, 0), :time)).to eq(Time.utc(2000, 1, 1, 0, 0, 0))
       end
 
       it "should return dummy time value with same time part for time value with different date" do
-        type_cast_value(Time.utc(2010, 1, 1, 0, 0, 0), :time).should == Time.utc(2000, 1, 1, 0, 0, 0)
+        expect(type_cast_value(Time.utc(2010, 1, 1, 0, 0, 0), :time)).to eq(Time.utc(2000, 1, 1, 0, 0, 0))
       end
 
       it "should return dummy time only for date value" do
-        type_cast_value(Date.new(2010, 1, 1), :time).should == Time.utc(2000, 1, 1, 0, 0, 0)
+        expect(type_cast_value(Date.new(2010, 1, 1), :time)).to eq(Time.utc(2000, 1, 1, 0, 0, 0))
       end
 
       it "should return dummy date with time part for datetime value" do
-        type_cast_value(DateTime.civil_from_format(:utc, 2010, 1, 1, 12, 34, 56), :time).should == Time.utc(2000, 1, 1, 12, 34, 56)
+        expect(type_cast_value(DateTime.civil_from_format(:utc, 2010, 1, 1, 12, 34, 56), :time)).to eq(Time.utc(2000, 1, 1, 12, 34, 56))
       end
 
       it 'should return nil for invalid value types' do
-        type_cast_value(12, :time).should == nil
+        expect(type_cast_value(12, :time)).to eq(nil)
       end
     end
 
     describe "for datetime type" do
       it "should return Date as Time value" do
-        type_cast_value(Date.new(2010, 1, 1), :datetime).should == Time.local_time(2010, 1, 1, 0, 0, 0)
+        expect(type_cast_value(Date.new(2010, 1, 1), :datetime)).to eq(Time.local(2010, 1, 1, 0, 0, 0))
       end
 
       it "should return same Time value" do
         value = Time.utc(2010, 1, 1, 12, 34, 56)
-        type_cast_value(Time.utc(2010, 1, 1, 12, 34, 56), :datetime).should == value
+        expect(type_cast_value(Time.utc(2010, 1, 1, 12, 34, 56), :datetime)).to eq(value)
       end
 
       it "should return as Time with same component values" do
-        type_cast_value(DateTime.civil_from_format(:utc, 2010, 1, 1, 12, 34, 56), :datetime).should == Time.utc(2010, 1, 1, 12, 34, 56)
+        expect(type_cast_value(DateTime.civil_from_format(:utc, 2010, 1, 1, 12, 34, 56), :datetime)).to eq(Time.utc(2010, 1, 1, 12, 34, 56))
       end
 
       it "should return same Time in correct zone if timezone aware" do
         @timezone_aware = true
         value = Time.utc(2010, 1, 1, 12, 34, 56)
         result = type_cast_value(value, :datetime)
-        result.should == Time.zone.local(2010, 1, 1, 23, 34, 56)
-        result.zone.should == 'EST'
+        expect(result).to eq(Time.zone.local(2010, 1, 1, 23, 34, 56))
+        expect(result.zone).to eq('AEDT')
       end
 
       it 'should return nil for invalid value types' do
-        type_cast_value(12, :datetime).should == nil
+        expect(type_cast_value(12, :datetime)).to eq(nil)
       end
     end
 
@@ -82,41 +82,41 @@ describe ValidatesTimeliness::Conversion do
 
       it "should ignore usec on time values when evaluated" do
         value = Time.utc(2010, 1, 1, 12, 34, 56, 10000)
-        type_cast_value(value, :datetime).should == Time.utc(2010, 1, 1, 12, 34, 56)
+        expect(type_cast_value(value, :datetime)).to eq(Time.utc(2010, 1, 1, 12, 34, 56))
       end
 
       it "should ignore usec and return time in correct zone if timezone aware" do
         @timezone_aware = true
         value = Time.utc(2010, 1, 1, 12, 34, 56, 10000)
         result = type_cast_value(value, :datetime)
-        result.should == Time.zone.local(2010, 1, 1, 23, 34, 56)
-        result.zone.should == 'EST'
+        expect(result).to eq(Time.zone.local(2010, 1, 1, 23, 34, 56))
+        expect(result.zone).to eq('AEDT')
       end
     end
   end
 
   describe "#dummy_time" do
     it 'should return Time with dummy date values but same time components' do
-      dummy_time(Time.utc(2010, 11, 22, 12, 34, 56)).should == Time.utc(2000, 1, 1, 12, 34, 56)
+      expect(dummy_time(Time.utc(2010, 11, 22, 12, 34, 56))).to eq(Time.utc(2000, 1, 1, 12, 34, 56))
     end
 
     it 'should return same value for Time which already has dummy date values' do
-      dummy_time(Time.utc(2000, 1, 1, 12, 34, 56)).should == Time.utc(2000, 1, 1, 12, 34, 56)
+      expect(dummy_time(Time.utc(2000, 1, 1, 12, 34, 56))).to eq(Time.utc(2000, 1, 1, 12, 34, 56))
     end
 
     it 'should return time component values shifted to current zone if timezone aware' do
       @timezone_aware = true
-      dummy_time(Time.utc(2000, 1, 1, 12, 34, 56)).should == Time.zone.local(2000, 1, 1, 23, 34, 56)
+      expect(dummy_time(Time.utc(2000, 1, 1, 12, 34, 56))).to eq(Time.zone.local(2000, 1, 1, 23, 34, 56))
     end
 
     it 'should return base dummy time value for Date value' do
-      dummy_time(Date.new(2010, 11, 22)).should == Time.utc(2000, 1, 1, 0, 0, 0)
+      expect(dummy_time(Date.new(2010, 11, 22))).to eq(Time.utc(2000, 1, 1, 0, 0, 0))
     end
 
     describe "with custom dummy date" do
       it 'should return dummy time with custom dummy date' do
         with_config(:dummy_date_for_time_type, [2010, 1, 1] ) do
-          dummy_time(Time.utc(1999, 11, 22, 12, 34, 56)).should == Time.utc(2010, 1, 1, 12, 34, 56)
+          expect(dummy_time(Time.utc(1999, 11, 22, 12, 34, 56))).to eq(Time.utc(2010, 1, 1, 12, 34, 56))
         end
       end
     end
@@ -127,56 +127,56 @@ describe ValidatesTimeliness::Conversion do
 
     it 'should return Date object as is' do
       value = Date.new(2010,1,1)
-      evaluate_option_value(value, person).should == value
+      expect(evaluate_option_value(value, person)).to eq(value)
     end
 
     it 'should return Time object as is' do
       value = Time.mktime(2010,1,1)
-      evaluate_option_value(value, person).should == value
+      expect(evaluate_option_value(value, person)).to eq(value)
     end
 
     it 'should return DateTime object as is' do
       value = DateTime.new(2010,1,1,0,0,0)
-      evaluate_option_value(value, person).should == value
+      expect(evaluate_option_value(value, person)).to eq(value)
     end
 
     it 'should return Time value returned from proc with 0 arity' do
       value = Time.mktime(2010,1,1)
-      evaluate_option_value(lambda { value }, person).should == value
+      expect(evaluate_option_value(lambda { value }, person)).to eq(value)
     end
 
     it 'should return Time value returned by record attribute call in proc arity of 1' do
       value = Time.mktime(2010,1,1)
       person.birth_time = value
-      evaluate_option_value(lambda {|r| r.birth_time }, person).should == value
+      expect(evaluate_option_value(lambda {|r| r.birth_time }, person)).to eq(value)
     end
 
     it 'should return Time value for attribute method symbol which returns Time' do
       value = Time.mktime(2010,1,1)
       person.birth_time = value
-      evaluate_option_value(:birth_time, person).should == value
+      expect(evaluate_option_value(:birth_time, person)).to eq(value)
     end
 
     it 'should return Time value is default zone from string time value' do
       value = '2010-01-01 12:00:00'
-      evaluate_option_value(value, person).should == Time.utc(2010,1,1,12,0,0)
+      expect(evaluate_option_value(value, person)).to eq(Time.utc(2010,1,1,12,0,0))
     end
 
     it 'should return Time value is current zone from string time value if timezone aware' do
       @timezone_aware = true
       value = '2010-01-01 12:00:00'
-      evaluate_option_value(value, person).should == Time.zone.local(2010,1,1,12,0,0)
+      expect(evaluate_option_value(value, person)).to eq(Time.zone.local(2010,1,1,12,0,0))
     end
 
     it 'should return Time value in default zone from proc which returns string time' do
       value = '2010-01-01 12:00:00'
-      evaluate_option_value(lambda { value }, person).should == Time.utc(2010,1,1,12,0,0)
+      expect(evaluate_option_value(lambda { value }, person)).to eq(Time.utc(2010,1,1,12,0,0))
     end
 
     it 'should return Time value for attribute method symbol which returns string time value' do
       value = '2010-01-01 12:00:00'
       person.birth_time = value
-      evaluate_option_value(:birth_time, person).should == Time.utc(2010,1,1,12,0,0)
+      expect(evaluate_option_value(:birth_time, person)).to eq(Time.zone.local(2010,1,1,12,0,0))
     end
 
     context "restriction shorthand" do
@@ -185,17 +185,17 @@ describe ValidatesTimeliness::Conversion do
       end
 
       it 'should evaluate :now as current time' do
-        evaluate_option_value(:now, person).should == Time.now
+        expect(evaluate_option_value(:now, person)).to eq(Time.now)
       end
 
       it 'should evaluate :today as current time' do
-        evaluate_option_value(:today, person).should == Date.today
+        expect(evaluate_option_value(:today, person)).to eq(Date.today)
       end
 
       it 'should not use shorthand if symbol if is record method' do
         time = 1.day.from_now
-        person.stub!(:now).and_return(time)
-        evaluate_option_value(:now, person).should == time
+        allow(person).to receive(:now).and_return(time)
+        expect(evaluate_option_value(:now, person)).to eq(time)
       end
     end
   end
@@ -205,7 +205,7 @@ describe ValidatesTimeliness::Conversion do
       with_config(:use_plugin_parser, true)
 
       it 'should use timeliness' do
-        Timeliness::Parser.should_receive(:parse)
+        expect(Timeliness::Parser).to receive(:parse)
         parse('2000-01-01')
       end
     end
@@ -215,20 +215,20 @@ describe ValidatesTimeliness::Conversion do
 
       it 'should use Time.zone.parse attribute is timezone aware' do
         @timezone_aware = true
-        Time.zone.should_receive(:parse)
+        expect(Time.zone).to receive(:parse)
         parse('2000-01-01')
       end
 
       it 'should use value#to_time if use_plugin_parser setting is false and attribute is not timezone aware' do
         @timezone_aware = false
         value = '2000-01-01'
-        value.should_receive(:to_time)
+        expect(value).to receive(:to_time)
         parse(value)
       end
     end
 
     it 'should return nil if value is nil' do
-      parse(nil).should be_nil
+      expect(parse(nil)).to be_nil
     end
   end
 end