Update changelog

Update to Mongoid 3

CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+= 3.0.15 [2015-12-29]
+* Fixes mongoid 3 support and removes mongoid 2 support(johnnyshields)
+* Some documentation/comments tidying
+* Some general tidying up
+
 = 3.0.14 [2012-08-23]
 * Fix for using validates :timeliness => {} form to correctly add attributes to timeliness validated attributes.
 

Gemfile

@@ -13,7 +13,7 @@ gem 'appraisal'
 gem 'sqlite3'
 
 group :mongoid do
-  gem 'mongoid', '~> 2.3.0'
+  gem 'mongoid', '>= 3.0'
   gem 'bson_ext'
   gem 'system_timer', :platforms => [:ruby_18]
 end

README.rdoc

@@ -39,7 +39,7 @@ Then run
   
   $ rails generate validates_timeliness:install
 
-This creates configuration initializer and locale files. In the initializer, you there are a number of config
+This creates configuration initializer and locale files. In the initializer, there are a number of config
 options to customize the plugin.
 
 NOTE: You may wish to enable the plugin parser and the extensions to start. Please read those sections first.
@@ -55,7 +55,10 @@ NOTE: You may wish to enable the plugin parser and the extensions to start. Plea
   validates_datetime :finish_time, :after => :start_time # Method symbol
 
   validates_date :booked_at, :on => :create, :on_or_after => :today # See Restriction Shorthand.
-  validates_time :booked_at, :between => ['9.00am', '5:00pm']
+
+  validates_time :booked_at, :between => ['9:00am', '5:00pm'] # On or after 9:00AM and on or before 5:00PM
+  validates_time :booked_at, :between => '9:00am'..'5:00pm' # The same as previous example
+  validates_time :booked_at, :between => '9:00am'...'5:00pm' # On or after 9:00AM and strictly before 5:00PM
 
   validates_time :breakfast_time, :on_or_after => '6:00am',
                                   :on_or_after_message => 'must be after opening time',
@@ -173,8 +176,8 @@ You can also use validation options for custom error messages. The following opt
     :after_message
     :on_or_after_message
 
-Note: There is no :between_message option. The between error message should be defined using the 
+Note: There is no :between_message option. The between error message should be defined using the :on_or_after and :on_or_before
-:on_or_before and :on_or_after messages.
+(:before in case when :between argument is a Range with excluded high value, see Examples) messages.
 
 It is highly recommended you use the I18n system for error messages.
 

Rakefile

@@ -5,7 +5,7 @@ require 'appraisal'
 
 Bundler::GemHelper.install_tasks
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 require 'rspec/core/rake_task'
 
 desc "Run specs"

lib/generators/validates_timeliness/templates/validates_timeliness.rb

@@ -32,7 +32,7 @@ ValidatesTimeliness.setup do |config|
   # Remove one or more formats making them invalid. e.g. remove_formats(:date, 'dd/mm/yyy')
   # config.parser.remove_formats()
   #
-  # Change the amiguous year threshold when parsing a 2 digit year
+  # Change the ambiguous year threshold when parsing a 2 digit year
   # config.parser.ambiguous_year_threshold =  30
   #
   # Treat ambiguous dates, such as 01/02/1950, as a Non-US date.

lib/validates_timeliness.rb

@@ -24,26 +24,24 @@ module ValidatesTimeliness
 
   class << self
     delegate :default_timezone, :default_timezone=, :dummy_date_for_time_type, :dummy_date_for_time_type=, :to => Timeliness
+
+    attr_accessor :extend_orms, :ignore_restriction_errors, :restriction_shorthand_symbols, :use_plugin_parser
   end
 
   # Extend ORM/ODMs for full support (:active_record, :mongoid).
-  mattr_accessor :extend_orms
+  self.extend_orms = []
-  @@extend_orms = []
 
   # Ignore errors when restriction options are evaluated
-  mattr_accessor :ignore_restriction_errors
+  self.ignore_restriction_errors = false
-  @@ignore_restriction_errors = false
 
   # Shorthand time and date symbols for restrictions
-  mattr_accessor :restriction_shorthand_symbols
+  self.restriction_shorthand_symbols = {
-  @@restriction_shorthand_symbols = {
     :now   => lambda { Time.current },
     :today => lambda { Date.current }
   }
 
   # Use the plugin date/time parser which is stricter and extensible
-  mattr_accessor :use_plugin_parser
+  self.use_plugin_parser = false
-  @@use_plugin_parser = false
 
   # Default timezone
   self.default_timezone = :utc
@@ -51,10 +49,6 @@ module ValidatesTimeliness
   # Set the dummy date part for a time type values.
   self.dummy_date_for_time_type = [ 2000, 1, 1 ]
 
-  def self.parser
-    Timeliness
-  end
-
   # Setup method for plugin configuration
   def self.setup
     yield self
@@ -64,6 +58,8 @@ module ValidatesTimeliness
   def self.load_orms
     extend_orms.each {|orm| require "validates_timeliness/orm/#{orm}" }
   end
+
+  def self.parser; Timeliness end
 end
 
 require 'validates_timeliness/conversion'

lib/validates_timeliness/orm/mongoid.rb

@@ -6,7 +6,7 @@ module ValidatesTimeliness
       # It is best to use the plugin parser to avoid errors on a bad
       # field value in Mongoid. Parser will return nil rather than error.
 
-      module ClassMethods 
+      module ClassMethods
         public
 
         # Mongoid has no bulk attribute method definition hook. It defines
@@ -23,7 +23,7 @@ module ValidatesTimeliness
             Date => :date,
             Time => :time,
             DateTime => :datetime
-          }[fields[attr_name.to_s].type] || :datetime
+          }[fields[database_field_name(attr_name)].type] || :datetime
         end
 
         protected
@@ -33,31 +33,17 @@ module ValidatesTimeliness
 
           "#{var_name} = Timeliness::Parser.parse(value, :#{type})"
         end
-
       end
 
-      module Reload
+      def reload(*args)
-        def reload(*args)
+        _clear_timeliness_cache
-          _clear_timeliness_cache
+        super
-          super
-        end
       end
     end
   end
 end
- 
+
 module Mongoid::Document
   include ValidatesTimeliness::AttributeMethods
   include ValidatesTimeliness::ORM::Mongoid
-
-  # Pre-2.3 reload
-  if (instance_methods & ['reload', :reload]).present?
-    def reload_with_timeliness
-      _clear_timeliness_cache
-      reload_without_timeliness
-    end
-    alias_method_chain :reload, :timeliness
-  else
-    include ValidatesTimeliness::ORM::Mongoid::Reload
-  end
 end

lib/validates_timeliness/validator.rb

@@ -1,3 +1,4 @@
+require 'active_model'
 require 'active_model/validator'
 
 module ValidatesTimeliness
@@ -32,7 +33,12 @@ module ValidatesTimeliness
 
       if range = options.delete(:between)
         raise ArgumentError, ":between must be a Range or an Array" unless range.is_a?(Range) || range.is_a?(Array)
-        options[:on_or_after], options[:on_or_before] = range.first, range.last
+        options[:on_or_after] = range.first
+        if range.is_a?(Range) && range.exclude_end?
+          options[:before] = range.last
+        else
+          options[:on_or_before] = range.last
+        end
       end
 
       @restrictions_to_check = RESTRICTIONS.keys & options.keys

lib/validates_timeliness/version.rb

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

spec/spec_helper.rb

@@ -57,6 +57,7 @@ class PersonWithShim < Person
   include TestModelShim
 end
 
+ActiveRecord::Base.default_timezone = :utc
 ActiveRecord::Base.time_zone_aware_attributes = true
 ActiveRecord::Base.establish_connection({:adapter => 'sqlite3', :database => ':memory:'})
 ActiveRecord::Migration.verbose = false

spec/validates_timeliness/extensions/multiparameter_handler_spec.rb

@@ -10,7 +10,7 @@ describe ValidatesTimeliness::Extensions::MultiparameterHandler do
      
     it 'should assign a Time value for valid datetimes' do
       employee = record_with_multiparameter_attribute(:birth_datetime, [2000, 2, 28, 12, 0, 0])
-      employee.birth_datetime_before_type_cast.should eq Time.local(2000, 2, 28, 12, 0, 0)
+      employee.birth_datetime_before_type_cast.should eq Time.zone.local(2000, 2, 28, 12, 0, 0)
     end
 
     it 'should assign a string value for incomplete time' do

spec/validates_timeliness/helper_methods_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe ValidatesTimeliness, 'HelperMethods' do
+  let(:record) { Person.new }
+  
   it 'should define class validation methods' do
     Person.should respond_to(:validates_date)
     Person.should respond_to(:validates_time)
@@ -8,23 +10,21 @@ describe ValidatesTimeliness, 'HelperMethods' do
   end
 
   it 'should define instance validation methods' do
-    Person.new.should respond_to(:validates_date)
+    record.should respond_to(:validates_date)
-    Person.new.should respond_to(:validates_time)
+    record.should respond_to(:validates_time)
-    Person.new.should respond_to(:validates_datetime)
+    record.should respond_to(:validates_datetime)
   end
 
   it 'should validate instance using class validation defined' do
     Person.validates_date :birth_date
-    r = Person.new
+    record.valid?
-    r.valid?
 
-    r.errors[:birth_date].should_not be_empty
+    record.errors[:birth_date].should_not be_empty
   end
 
   it 'should validate instance using instance valiation method' do
-    r = Person.new
+    record.validates_date :birth_date
-    r.validates_date :birth_date
 
-    r.errors[:birth_date].should_not be_empty
+    record.errors[:birth_date].should_not be_empty
   end
 end

spec/validates_timeliness/orm/active_record_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe ValidatesTimeliness, 'ActiveRecord' do
 
   context "validation methods" do
+    let(:record) { Employee.new }
+
     it 'should be defined for the class' do
       ActiveRecord::Base.should respond_to(:validates_date)
       ActiveRecord::Base.should respond_to(:validates_time)
@@ -10,33 +12,30 @@ describe ValidatesTimeliness, 'ActiveRecord' do
     end
 
     it 'should defines for the instance' do
-      Employee.new.should respond_to(:validates_date)
+      record.should respond_to(:validates_date)
-      Employee.new.should respond_to(:validates_time)
+      record.should respond_to(:validates_time)
-      Employee.new.should respond_to(:validates_datetime)
+      record.should respond_to(:validates_datetime)
     end
 
     it "should validate a valid value string" do
-      r = Employee.new
+      record.birth_date = '2012-01-01'
-      r.birth_date = '2012-01-01'
 
-      r.valid?
+      record.valid?
-      r.errors[:birth_date].should be_empty
+      record.errors[:birth_date].should be_empty
     end
 
     it "should validate a invalid value string" do
-      r = Employee.new
+      record.birth_date = 'not a date'
-      r.birth_date = 'not a date'
 
-      r.valid?
+      record.valid?
-      r.errors[:birth_date].should_not be_empty
+      record.errors[:birth_date].should_not be_empty
     end
 
     it "should validate a nil value" do
-      r = Employee.new
+      record.birth_date = nil
-      r.birth_date = nil
 
-      r.valid?
+      record.valid?
-      r.errors[:birth_date].should be_empty
+      record.errors[:birth_date].should be_empty
     end
   end
 
@@ -83,36 +82,36 @@ describe ValidatesTimeliness, 'ActiveRecord' do
     end
 
     context 'value cache' do
+      let(:record) { EmployeeWithCache.new }
+
       context 'for datetime column' do
         it 'should store raw value' do
-          r = EmployeeWithCache.new
+          record.birth_datetime = datetime_string = '2010-01-01 12:30'
-          r.birth_datetime = datetime_string = '2010-01-01 12:30'
 
-          r._timeliness_raw_value_for('birth_datetime').should eq datetime_string
+          record._timeliness_raw_value_for('birth_datetime').should eq datetime_string
         end
       end
 
       context 'for date column' do
         it 'should store raw value' do
-          r = EmployeeWithCache.new
+          record.birth_date = date_string = '2010-01-01'
-          r.birth_date = date_string = '2010-01-01'
 
-          r._timeliness_raw_value_for('birth_date').should eq date_string
+          record._timeliness_raw_value_for('birth_date').should eq date_string
         end
       end
 
       context 'for time column' do
         it 'should store raw value' do
-          r = EmployeeWithCache.new
+          record.birth_time = time_string = '12:12'
-          r.birth_time = time_string = '12:12'
 
-          r._timeliness_raw_value_for('birth_time').should eq time_string
+          record._timeliness_raw_value_for('birth_time').should eq time_string
         end
       end
     end
 
     context "with plugin parser" do
       with_config(:use_plugin_parser, true)
+      let(:record) { EmployeeWithParser.new }
 
       class EmployeeWithParser < ActiveRecord::Base
         self.table_name = 'employees'
@@ -125,22 +124,20 @@ describe ValidatesTimeliness, 'ActiveRecord' do
         it 'should parse a string value' do
           Timeliness::Parser.should_receive(:parse)
 
-          r = EmployeeWithParser.new
+          record.birth_date = '2010-01-01'
-          r.birth_date = '2010-01-01'
         end
 
         it 'should parse a invalid string value as nil' do
           Timeliness::Parser.should_receive(:parse)
-          r = EmployeeWithParser.new
+
-          r.birth_date = 'not valid'
+          record.birth_date = 'not valid'
         end
 
         it 'should store a Date value after parsing string' do
-          r = EmployeeWithParser.new
+          record.birth_date = '2010-01-01'
-          r.birth_date = '2010-01-01'
 
-          r.birth_date.should be_kind_of(Date)
+          record.birth_date.should be_kind_of(Date)
-          r.birth_date.should eq Date.new(2010, 1, 1)
+          record.birth_date.should eq Date.new(2010, 1, 1)
         end
       end
 
@@ -148,23 +145,20 @@ describe ValidatesTimeliness, 'ActiveRecord' do
         it 'should parse a string value' do
           Timeliness::Parser.should_receive(:parse)
 
-          r = EmployeeWithParser.new
+          record.birth_time = '12:30'
-          r.birth_time = '12:30'
         end
 
         it 'should parse a invalid string value as nil' do
           Timeliness::Parser.should_receive(:parse)
 
-          r = EmployeeWithParser.new
+          record.birth_time = 'not valid'
-          r.birth_time = 'not valid'
         end
 
         it 'should store a Time value after parsing string' do
-          r = EmployeeWithParser.new
+          record.birth_time = '12:30'
-          r.birth_time = '12:30'
 
-          r.birth_time.should be_kind_of(Time)
+          record.birth_time.should be_kind_of(Time)
-          r.birth_time.should eq Time.utc(2000, 1, 1, 12, 30)
+          record.birth_time.should eq Time.utc(2000, 1, 1, 12, 30)
         end
       end
 
@@ -174,29 +168,25 @@ describe ValidatesTimeliness, 'ActiveRecord' do
         it 'should parse a string value' do
           Timeliness::Parser.should_receive(:parse)
 
-          r = EmployeeWithParser.new
+          record.birth_datetime = '2010-01-01 12:00'
-          r.birth_datetime = '2010-01-01 12:00'
         end
 
         it 'should parse a invalid string value as nil' do
           Timeliness::Parser.should_receive(:parse)
 
-          r = EmployeeWithParser.new
+          record.birth_datetime = 'not valid'
-          r.birth_datetime = 'not valid'
         end
 
         it 'should parse string into Time value' do
-          r = EmployeeWithParser.new
+          record.birth_datetime = '2010-01-01 12:00'
-          r.birth_datetime = '2010-01-01 12:00'
 
-          r.birth_datetime.should be_kind_of(Time)
+          record.birth_datetime.should be_kind_of(Time)
         end
 
         it 'should parse string as current timezone' do
-          r = EmployeeWithParser.new
+          record.birth_datetime = '2010-06-01 12:00'
-          r.birth_datetime = '2010-06-01 12:00'
 
-          r.birth_datetime.utc_offset.should eq Time.zone.utc_offset
+          record.birth_datetime.utc_offset.should eq Time.zone.utc_offset
         end
       end
     end
@@ -204,43 +194,43 @@ describe ValidatesTimeliness, 'ActiveRecord' do
 
   context "reload" do
     it 'should clear cache value' do
-      r = Employee.create!
+      record = Employee.create!
-      r.birth_date = '2010-01-01'
+      record.birth_date = '2010-01-01'
       
-      r.reload
+      record.reload
 
-      r._timeliness_raw_value_for('birth_date').should be_nil
+      record._timeliness_raw_value_for('birth_date').should be_nil
     end
   end
 
   context "before_type_cast method" do
+    let(:record) { Employee.new }
+
     it 'should be defined on class if ORM supports it' do
-      Employee.new.should respond_to(:birth_datetime_before_type_cast)
+      record.should respond_to(:birth_datetime_before_type_cast)
     end
 
     it 'should return original value' do
-      r = Employee.new
+      record.birth_datetime = date_string = '2010-01-01'
-      r.birth_datetime = date_string = '2010-01-01'
 
-      r.birth_datetime_before_type_cast.should eq date_string
+      record.birth_datetime_before_type_cast.should eq date_string
     end
 
     it 'should return attribute if no attribute assignment has been made' do
       datetime = Time.zone.local(2010,01,01)
       Employee.create(:birth_datetime => datetime)
 
-      r = Employee.last
+      record = Employee.last
-      r.birth_datetime_before_type_cast.should match(/2010-01-01 00:00:00/)
+      record.birth_datetime_before_type_cast.should match(/#{datetime.utc.to_s[0...-4]}/)
     end
 
     context "with plugin parser" do
       with_config(:use_plugin_parser, true)
 
       it 'should return original value' do
-        r = Employee.new
+        record.birth_datetime = date_string = '2010-01-31'
-        r.birth_datetime = date_string = '2010-01-31'
 
-        r.birth_datetime_before_type_cast.should eq date_string
+        record.birth_datetime_before_type_cast.should eq date_string
       end
     end
 

spec/validates_timeliness/orm/mongoid_spec.rb

@@ -7,13 +7,13 @@ require 'mongoid'
 require 'validates_timeliness/orm/mongoid'
 
 Mongoid.configure do |config|
-  name = "validates_timeliness_test"
+  config.connect_to('validates_timeliness_test')
-  host = "localhost"
-  config.master = Mongo::Connection.new.db(name)
-  config.persist_in_safe_mode = false
 end
 
 describe ValidatesTimeliness, 'Mongoid' do
+  after(:each) do
+    Mongoid.purge!
+  end
 
   class Article
     include Mongoid::Document
@@ -47,16 +47,6 @@ describe ValidatesTimeliness, 'Mongoid' do
       record.errors[:publish_date].should be_empty
     end
 
-    it "should validate a invalid value string" do
-      begin
-        record.publish_date = 'not a date' 
-      rescue
-      end
-
-      record.valid?
-      record.errors[:publish_date].should_not be_empty
-    end
-
     it "should validate a nil value" do
       record.publish_date = nil
 
@@ -67,6 +57,8 @@ describe ValidatesTimeliness, 'Mongoid' do
 
   it 'should determine type for attribute' do
     Article.timeliness_attribute_type(:publish_date).should == :date
+    Article.timeliness_attribute_type(:publish_time).should == :time
+    Article.timeliness_attribute_type(:publish_datetime).should == :datetime
   end
   
   context "attribute write method" do
@@ -157,7 +149,7 @@ describe ValidatesTimeliness, 'Mongoid' do
           record.publish_datetime.should be_kind_of(DateTime)
         end
 
-        pending 'should parse string as current timezone' do
+        it 'should parse string as current timezone' do
           record.publish_datetime = '2010-06-01 12:00'
 
           record.publish_datetime.utc_offset.should eq Time.zone.utc_offset
@@ -176,8 +168,50 @@ describe ValidatesTimeliness, 'Mongoid' do
   end
 
   context "before_type_cast method" do
-    it 'should not be defined if ORM does not support it' do
+    let(:record){ Article.new }
-      Article.new.should_not respond_to(:publish_datetime_before_type_cast)
+
+    it 'should be defined on class if ORM supports it' do
+      record.should respond_to(:publish_datetime_before_type_cast)
+    end
+
+    it 'should return original value' do
+      record.publish_datetime = date_string = '2010-01-01'
+
+      record.publish_datetime_before_type_cast.should eq date_string
+    end
+
+    it 'should return attribute if no attribute assignment has been made' do
+      time = Time.zone.local(2010,01,01)
+      Article.create(:publish_datetime => time)
+      record = Article.last
+      record.publish_datetime_before_type_cast.should eq time.to_datetime
+    end
+
+    context "with plugin parser" do
+      with_config(:use_plugin_parser, true)
+
+      it 'should return original value' do
+        record.publish_datetime = date_string = '2010-01-31'
+        record.publish_datetime_before_type_cast.should eq date_string
+      end
+    end
+  end
+
+  context "with aliased fields" do
+    class ArticleWithAliasedFields
+      include Mongoid::Document
+      field :pd, as: :publish_date, :type => Date
+      field :pt, as: :publish_time, :type => Time
+      field :pdt, as: :publish_datetime, :type => DateTime
+      validates_date :publish_date, :allow_nil => true
+      validates_time :publish_time, :allow_nil => true
+      validates_datetime :publish_datetime, :allow_nil => true
+    end
+
+    it 'should determine type for attribute' do
+      ArticleWithAliasedFields.timeliness_attribute_type(:publish_date).should == :date
+      ArticleWithAliasedFields.timeliness_attribute_type(:publish_time).should == :time
+      ArticleWithAliasedFields.timeliness_attribute_type(:publish_datetime).should == :datetime
     end
   end
 end

spec/validates_timeliness/validator_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
 describe ValidatesTimeliness::Validator do
-  NIL = [nil]
-
   before do
     Timecop.freeze(Time.local_time(2010, 1, 1, 0, 0, 0))
   end
@@ -46,13 +44,13 @@ describe ValidatesTimeliness::Validator do
   describe ":allow_nil option" do
     it 'should not allow nil by default' do
       Person.validates_date :birth_date
-      invalid!(:birth_date, NIL, 'is not a valid date')
+      invalid!(:birth_date, [nil], 'is not a valid date')
       valid!(:birth_date, Date.today)
     end
 
     it 'should allow nil when true' do
       Person.validates_date :birth_date, :allow_nil => true
-      valid!(:birth_date, NIL)
+      valid!(:birth_date, [nil])
     end
 
     context "with raw value cache" do
@@ -117,6 +115,19 @@ describe ValidatesTimeliness::Validator do
         valid!(:birth_date, on_or_before)
       end
     end
+
+    describe "range with excluded end value" do
+      it 'should be split option into :on_or_after and :before values' do
+        on_or_after, before = Date.new(2010,1,1), Date.new(2010,1,3)
+        Person.validates_date :birth_date, :between => on_or_after...before
+        Person.validators.first.options[:on_or_after].should == on_or_after
+        Person.validators.first.options[:before].should == before
+        invalid!(:birth_date, on_or_after - 1, "must be on or after 2010-01-01")
+        invalid!(:birth_date, before, "must be before 2010-01-03")
+        valid!(:birth_date, on_or_after)
+        valid!(:birth_date, before - 1)
+      end
+    end
   end
 
   describe ":ignore_usec option" do
@@ -226,7 +237,7 @@ describe ValidatesTimeliness::Validator 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 invalid restriction' do
       Person.validates_date :birth_date, :before => Time.now, :before_message => 'custom before message'
       invalid!(:birth_date, Time.now, 'custom before message')

validates_timeliness.gemspec

@@ -16,5 +16,5 @@ Gem::Specification.new do |s|
   s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.extra_rdoc_files = ["README.rdoc", "CHANGELOG.rdoc", "LICENSE"]
 
-  s.add_runtime_dependency(%q<timeliness>, ["~> 0.3.6"])
+  s.add_runtime_dependency(%q<timeliness>, ["~> 0.3.7"])
 end