jc-validates_timeliness 3.1.0

data/spec/validates_timeliness/extensions/date_time_select_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+
+describe ValidatesTimeliness::Extensions::DateTimeSelect do
+  include ActionView::Helpers::DateHelper
+  attr_reader :person, :params
+
+  with_config(:use_plugin_parser, true)
+
+  before do
+    @person = Person.new
+    @params = {}
+  end
+
+  describe "datetime_select" do
+    it "should use param values when attribute is nil" do
+      @params["person"] = {
+        "birth_datetime(1i)" => '2009',
+        "birth_datetime(2i)" => '2',
+        "birth_datetime(3i)" => '29',
+        "birth_datetime(4i)" => '12',
+        "birth_datetime(5i)" => '13',
+        "birth_datetime(6i)" => '14',
+      }
+      person.birth_datetime = nil
+      @output = datetime_select(:person, :birth_datetime, :include_blank => true, :include_seconds => true)
+      should_have_datetime_selected(:birth_datetime, :year => 2009, :month => 'February', :day => 29, :hour => 12, :min => 13, :sec => 14)
+    end
+
+    it "should override object values and use params if present" do
+      @params["person"] = {
+        "birth_datetime(1i)" => '2009',
+        "birth_datetime(2i)" => '2',
+        "birth_datetime(3i)" => '29',
+        "birth_datetime(4i)" => '12',
+        "birth_datetime(5i)" => '13',
+        "birth_datetime(6i)" => '14',
+      }
+      person.birth_datetime = "2010-01-01 15:16:17"
+      @output = datetime_select(:person, :birth_datetime, :include_blank => true, :include_seconds => true)
+      should_have_datetime_selected(:birth_datetime, :year => 2009, :month => 'February', :day => 29, :hour => 12, :min => 13, :sec => 14)
+    end
+
+    it "should use attribute values from object if no params" do
+      person.birth_datetime = "2009-01-02 12:13:14"
+      @output = datetime_select(:person, :birth_datetime, :include_blank => true, :include_seconds => true)
+      should_have_datetime_selected(:birth_datetime, :year => 2009, :month => 'January', :day => 2, :hour => 12, :min => 13, :sec => 14)
+    end
+
+    it "should use attribute values if params does not contain attribute params" do
+      person.birth_datetime = "2009-01-02 12:13:14"
+      @params["person"] = { }
+      @output = datetime_select(:person, :birth_datetime, :include_blank => true, :include_seconds => true)
+      should_have_datetime_selected(:birth_datetime, :year => 2009, :month => 'January', :day => 2, :hour => 12, :min => 13, :sec => 14)
+    end
+
+    it "should not select values when attribute value is nil and has no param values" do
+      person.birth_datetime = nil
+      @output = datetime_select(:person, :birth_datetime, :include_blank => true, :include_seconds => true)
+      should_not_have_datetime_selected(:birth_datetime, :year, :month, :day, :hour, :min, :sec)
+    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)
+      should_have_datetime_selected(:birth_date, :year => 2009, :month => 'February', :day => 29)
+    end
+
+    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)
+      should_have_datetime_selected(:birth_date, :year => 2009, :month => 'February', :day => 29)
+    end
+
+    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)
+      should_have_datetime_selected(:birth_date, :year => 2009, :month => 'January', :day => 2)
+    end
+
+    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)
+      should_have_datetime_selected(:birth_date, :year => 2009, :month => 'January', :day => 2)
+    end
+
+    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)
+      should_not_have_datetime_selected(:birth_time, :year, :month, :day)
+    end
+
+    it "should allow the day part to be discarded" do
+      @params["person"] = {
+        "birth_date(1i)" => '2009',
+        "birth_date(2i)" => '2',
+      }
+
+      @output = date_select(:person, :birth_date, :include_blank => true, :discard_day => true)
+      should_have_datetime_selected(:birth_date, :year => 2009, :month => 'February')
+      should_not_have_datetime_selected(:birth_time, :day)
+      expect(@output).to have_tag("input[id=person_birth_date_3i][type=hidden][value='1']")
+    end
+  end
+
+  describe "time_select" do
+    before do
+      Timecop.freeze 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)
+      should_have_datetime_selected(:birth_time, :hour => 12, :min => 13, :sec => 14)
+    end
+
+    it "should select attribute values from object if no params" do
+      person.birth_time = "2000-01-01 12:13:14"
+      @output = time_select(:person, :birth_time, :include_blank => true, :include_seconds => true)
+      should_have_datetime_selected(:birth_time, :hour => 12, :min => 13, :sec => 14)
+    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)
+      should_not_have_datetime_selected(:birth_time, :hour, :min, :sec)
+    end
+  end
+
+  def should_have_datetime_selected(field, datetime_hash)
+    datetime_hash.each do |key, value|
+      index = {:year => 1, :month => 2, :day => 3, :hour => 4, :min => 5, :sec => 6}[key]
+      expect(@output).to have_tag("select[id=person_#{field}_#{index}i] option[selected=selected]").with_inner_text(value.to_s)
+    end
+  end
+
+  def should_not_have_datetime_selected(field, *attributes)
+    attributes.each do |attribute|
+      index = {:year => 1, :month => 2, :day => 3, :hour => 4, :min => 5, :sec => 6}[attribute]
+      expect(@output).not_to have_tag("select[id=person_#{attribute}_#{index}i] option[selected=selected]")
+    end
+  end
+end

data/spec/validates_timeliness/extensions/multiparameter_handler_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe ValidatesTimeliness::Extensions::MultiparameterHandler do
+
+  context "time column" do
+    it 'should assign a string value for invalid date portion' do
+      employee = record_with_multiparameter_attribute(:birth_datetime, [2000, 2, 31, 12, 0, 0])
+      expect(employee.birth_datetime_before_type_cast).to eq '2000-02-31 12:00:00'
+    end
+     
+    it 'should assign a Time value for valid datetimes' do
+      employee = record_with_multiparameter_attribute(:birth_datetime, [2000, 2, 28, 12, 0, 0])
+      expect(employee.birth_datetime_before_type_cast).to eq Time.zone.local(2000, 2, 28, 12, 0, 0)
+    end
+
+    it 'should assign a string value for incomplete time' do
+      employee = record_with_multiparameter_attribute(:birth_datetime, [2000, nil, nil])
+      expect(employee.birth_datetime_before_type_cast).to eq '2000-00-00'
+    end
+  end
+
+  context "date column" do
+    it 'should assign a string value for invalid date' do
+      employee = record_with_multiparameter_attribute(:birth_date, [2000, 2, 31])
+      expect(employee.birth_date_before_type_cast).to eq '2000-02-31'
+    end
+
+    it 'should assign a Date value for valid date' do
+      employee = record_with_multiparameter_attribute(:birth_date, [2000, 2, 28])
+      expect(employee.birth_date_before_type_cast).to eq Date.new(2000, 2, 28)
+    end
+
+    it 'should assign a string value for incomplete date' do
+      employee = record_with_multiparameter_attribute(:birth_date, [2000, nil, nil])
+      expect(employee.birth_date_before_type_cast).to eq '2000-00-00'
+    end
+  end
+
+  def record_with_multiparameter_attribute(name, values)
+    hash = {}
+    values.each_with_index {|value, index| hash["#{name}(#{index+1}i)"] = value.to_s }
+    Employee.new(hash)
+  end
+end

data/spec/validates_timeliness/helper_methods_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ValidatesTimeliness, 'HelperMethods' do
+  let(:record) { Person.new }
+  
+  it 'should define class validation methods' do
+    expect(Person).to respond_to(:validates_date)
+    expect(Person).to respond_to(:validates_time)
+    expect(Person).to respond_to(:validates_datetime)
+  end
+
+  it 'should define instance validation methods' do
+    expect(record).to respond_to(:validates_date)
+    expect(record).to respond_to(:validates_time)
+    expect(record).to respond_to(:validates_datetime)
+  end
+
+  it 'should validate instance using class validation defined' do
+    Person.validates_date :birth_date
+    record.valid?
+
+    expect(record.errors[:birth_date]).not_to be_empty
+  end
+
+  it 'should validate instance using instance valiation method' do
+    record.validates_date :birth_date
+
+    expect(record.errors[:birth_date]).not_to be_empty
+  end
+end

data/spec/validates_timeliness/orm/active_record_spec.rb

@@ -0,0 +1,244 @@
+require 'spec_helper'
+
+describe ValidatesTimeliness, 'ActiveRecord' do
+
+  context "validation methods" do
+    let(:record) { Employee.new }
+
+    it 'should be defined for the class' do
+      expect(ActiveRecord::Base).to respond_to(:validates_date)
+      expect(ActiveRecord::Base).to respond_to(:validates_time)
+      expect(ActiveRecord::Base).to respond_to(:validates_datetime)
+    end
+
+    it 'should defines for the instance' do
+      expect(record).to respond_to(:validates_date)
+      expect(record).to respond_to(:validates_time)
+      expect(record).to respond_to(:validates_datetime)
+    end
+
+    it "should validate a valid value string" do
+      record.birth_date = '2012-01-01'
+
+      record.valid?
+      expect(record.errors[:birth_date]).to be_empty
+    end
+
+    it "should validate a invalid value string" do
+      record.birth_date = 'not a date'
+
+      record.valid?
+      expect(record.errors[:birth_date]).not_to be_empty
+    end
+
+    it "should validate a nil value" do
+      record.birth_date = nil
+
+      record.valid?
+      expect(record.errors[:birth_date]).to be_empty
+    end
+  end
+
+  it 'should determine type for attribute' do
+    expect(Employee.timeliness_attribute_type(:birth_date)).to eq :date
+  end
+
+  context 'attribute timezone awareness' do
+    let(:klass) {
+      Class.new(ActiveRecord::Base) do
+        self.table_name = 'employees'
+        attr_accessor :some_date
+        attr_accessor :some_time
+        attr_accessor :some_datetime
+        validates_date :some_date
+        validates_time :some_time
+        validates_datetime :some_datetime
+      end
+    }
+
+    context 'for column attribute' do
+      it 'should be detected from column type' do
+        expect(klass.timeliness_attribute_timezone_aware?(:birth_date)).to be_falsey
+        expect(klass.timeliness_attribute_timezone_aware?(:birth_time)).to be_falsey
+        expect(klass.timeliness_attribute_timezone_aware?(:birth_datetime)).to be_truthy
+      end
+    end
+
+    context 'for non-column attribute' do
+      it 'should be detected from the validation type' do
+        expect(klass.timeliness_attribute_timezone_aware?(:some_date)).to be_falsey
+        expect(klass.timeliness_attribute_timezone_aware?(:some_time)).to be_falsey
+        expect(klass.timeliness_attribute_timezone_aware?(:some_datetime)).to be_truthy
+      end
+    end
+  end
+
+  context "attribute write method" do
+    class EmployeeWithCache < ActiveRecord::Base
+      self.table_name = 'employees'
+      validates_date :birth_date, :allow_blank => true
+      validates_time :birth_time, :allow_blank => true
+      validates_datetime :birth_datetime, :allow_blank => true
+    end
+
+    context 'value cache' do
+      let(:record) { EmployeeWithCache.new }
+
+      context 'for datetime column' do
+        it 'should store raw value' do
+          record.birth_datetime = datetime_string = '2010-01-01 12:30'
+
+          expect(record._timeliness_raw_value_for('birth_datetime')).to eq datetime_string
+        end
+      end
+
+      context 'for date column' do
+        it 'should store raw value' do
+          record.birth_date = date_string = '2010-01-01'
+
+          expect(record._timeliness_raw_value_for('birth_date')).to eq date_string
+        end
+      end
+
+      context 'for time column' do
+        it 'should store raw value' do
+          record.birth_time = time_string = '12:12'
+
+          expect(record._timeliness_raw_value_for('birth_time')).to 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'
+        validates_date :birth_date, :allow_blank => true
+        validates_time :birth_time, :allow_blank => true
+        validates_datetime :birth_datetime, :allow_blank => true
+      end
+
+      context "for a date column" do
+        it 'should parse a string value' do
+          expect(Timeliness::Parser).to receive(:parse)
+
+          record.birth_date = '2010-01-01'
+        end
+
+        it 'should parse a invalid string value as nil' do
+          expect(Timeliness::Parser).to receive(:parse)
+
+          record.birth_date = 'not valid'
+        end
+
+        it 'should store a Date value after parsing string' do
+          record.birth_date = '2010-01-01'
+
+          expect(record.birth_date).to be_kind_of(Date)
+          expect(record.birth_date).to eq Date.new(2010, 1, 1)
+        end
+      end
+
+      context "for a time column" do
+        it 'should parse a string value' do
+          expect(Timeliness::Parser).to receive(:parse)
+
+          record.birth_time = '12:30'
+        end
+
+        it 'should parse a invalid string value as nil' do
+          expect(Timeliness::Parser).to receive(:parse)
+
+          record.birth_time = 'not valid'
+        end
+
+        it 'should store a Time value after parsing string' do
+          record.birth_time = '12:30'
+
+          expect(record.birth_time).to be_kind_of(Time)
+          expect(record.birth_time).to eq Time.utc(2000, 1, 1, 12, 30)
+        end
+      end
+
+      context "for a datetime column" do
+        with_config(:default_timezone, 'Australia/Melbourne')
+
+        it 'should parse a string value' do
+          expect(Timeliness::Parser).to receive(:parse)
+
+          record.birth_datetime = '2010-01-01 12:00'
+        end
+
+        it 'should parse a invalid string value as nil' do
+          expect(Timeliness::Parser).to receive(:parse)
+
+          record.birth_datetime = 'not valid'
+        end
+
+        it 'should parse string into Time value' do
+          record.birth_datetime = '2010-01-01 12:00'
+
+          expect(record.birth_datetime).to be_kind_of(Time)
+        end
+
+        it 'should parse string as current timezone' do
+          record.birth_datetime = '2010-06-01 12:00'
+
+          expect(record.birth_datetime.utc_offset).to eq Time.zone.utc_offset
+        end
+      end
+    end
+  end
+
+  context "reload" do
+    it 'should clear cache value' do
+      record = Employee.create!
+      record.birth_date = '2010-01-01'
+
+      record.reload
+
+      expect(record._timeliness_raw_value_for('birth_date')).to 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
+      expect(record).to respond_to(:birth_datetime_before_type_cast)
+    end
+
+    it 'should return original value' do
+      record.birth_datetime = date_string = '2010-01-01'
+
+      expect(record.birth_datetime_before_type_cast).to 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)
+
+      record = Employee.last
+      expect(record.birth_datetime_before_type_cast).to 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
+        record.birth_datetime = date_string = '2010-01-31'
+
+        expect(record.birth_datetime_before_type_cast).to eq date_string
+      end
+    end
+
+  end
+
+  context "define_attribute_methods" do
+    it "returns a falsy value if the attribute methods have already been generated" do
+      expect(Employee.define_attribute_methods).to be_falsey
+    end
+  end
+end