validates_timeliness 7.0.0.beta1 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 284d18473a0007c273fc4608579b619afac6a3809dfdcd12864d6aeea30c6f17
-  data.tar.gz: 12d2db9663bb6c80a643d7c7365fc4d44218a64a9b69feacb6d060dc737ddd93
+  metadata.gz: fddd24dc1daff9d9c90db6d6cb477519ab77abcf5dc8c55c5c69af61504eba46
+  data.tar.gz: e16bbad97a83834a912610ff682fe2c93ef7204e0b19f070becd84e4e3ebaf18
 SHA512:
-  metadata.gz: 77eb167f597fe224c293b6a9e9143c0b5eb8b443ed54539dc89e34c28e5cb7c9517e826c25660641281d6b477451cb2ff4b1187f0332e33fd0d94d7618223204
-  data.tar.gz: de5c7cb989b1148acf4a7af524171c7eead44663b43088da99f79bb5af7c7b1c120f28ace62cb62bcfe533979fbe9975763e59aa463acccf7ed1a951496e1f39
+  metadata.gz: 443d66dd2feb66c01e77294236fbf7b197e358246dbd40b9014c5b888e23810219851d89dd320db9e0a256bc62a6402fdbcc326684941566dbdc331285faefce
+  data.tar.gz: 0d1f13688d2a26ffaa940b409c9f6139cd780b21ffffb1ef02470718bd63d3d1e86bf2bcf4e411b15de4cb7badb215cdd7df8088f59ff63f044f924fcbdf570d

data/.github/workflows/ci.yml

@@ -7,12 +7,10 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - gemfile: rails_7_0
-            ruby: 2.7
-          - gemfile: rails_7_0
-            ruby: 3.0
-          - gemfile: rails_7_0
-            ruby: 3.1
+          - gemfile: rails_8_0
+            ruby: 3.2
+          - gemfile: rails_8_0
+            ruby: 3.3
 
     name: ${{ matrix.gemfile }}, ruby ${{ matrix.ruby }}
     env:

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 8.0.0 [2024-12-31]
+*   Support Rails v8.x
+*   Support passing non-reserved validation options to errors
+
+# 7.0.0 [2024-11-30]
+*   Support Rails v7.x
+*   Removed all method overrides in ActiveModel now that the datetime type correctly stores before_type_cast values.
+
+# 6.0.1 [2023-01-12]
+*   TODO need to complete this
+
+# 6.0.0 [2022-10-20]
+*   TODO need to complete this
+
 # 5.0.0 [2021-04-03]
 *   Fix DateTimeSelect extension support (AquisTech)
 *   Relaxed Timeliness dependency version which allows for >= 0.4.0 with

data/README.md

@@ -6,13 +6,14 @@
 
 ## Description
 
-Complete validation of dates, times and datetimes for Rails 7.x and ActiveModel.
+Complete validation of dates, times and datetimes for Rails 8.x and ActiveModel.
 
 Older Rails versions:
 
 - Rails 4.x: [https://github.com/adzap/validates_timeliness/tree/4-0-stable]
 - Rails 5.x: [https://github.com/adzap/validates_timeliness/tree/5-0-stable]
 - Rails 6.x: [https://github.com/adzap/validates_timeliness/tree/6-0-stable]
+- Rails 7.x: [https://github.com/adzap/validates_timeliness/tree/7-0-stable]
 
 
 ## Features
@@ -30,7 +31,7 @@ Older Rails versions:
 
 In Gemfile
 ```ruby
-gem 'validates_timeliness', '~> 7.0.0.beta1'
+gem 'validates_timeliness', '~> 8.0.0.beta1'
 ```
 
 Run bundler:

data/gemfiles/{rails_7_0.gemfile → rails_8_0.gemfile}

@@ -1,13 +1,13 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-gem "rails", "~> 7.0.0"
+gem "rails", "~> 8.0.0"
 gem "rspec"
 gem "rspec-rails", "~> 6.0"
-gem "sqlite3"
+gem "sqlite3", "~> 2.0"
 gem "byebug"
 gem "appraisal"
-gem "nokogiri", "~> 1.8"
+gem "nokogiri"
 
 gemspec path: "../"

data/lib/validates_timeliness/extensions/date_time_select.rb

@@ -1,6 +1,6 @@
 module ValidatesTimeliness
   module Extensions
-    module TimelinessDateTimeSelect
+    module DateTimeSelect
       # Intercepts the date and time select helpers to reuse the values from
       # 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.

data/lib/validates_timeliness/extensions.rb

@@ -1,10 +1,11 @@
 module ValidatesTimeliness
   module Extensions
-    autoload :TimelinessDateTimeSelect, 'validates_timeliness/extensions/date_time_select'
+    autoload :DateTimeSelect, 'validates_timeliness/extensions/date_time_select'
   end
 
   def self.enable_date_time_select_extension!
-    ::ActionView::Helpers::Tags::DateSelect.send(:prepend, ValidatesTimeliness::Extensions::TimelinessDateTimeSelect)
+    require 'uri' # Do we need this? No, but the test suite fails without it.
+    ::ActionView::Helpers::Tags::DateSelect.send(:prepend, ValidatesTimeliness::Extensions::DateTimeSelect)
   end
 
   def self.enable_multiparameter_extension!

data/lib/validates_timeliness/helper_methods.rb

@@ -3,25 +3,19 @@ module ActiveModel
 
     module HelperMethods
       def validates_date(*attr_names)
-        timeliness_validation_for attr_names, :date
+        validates_with TimelinessValidator, _merge_attributes(attr_names).merge(type: :date)
       end
 
       def validates_time(*attr_names)
-        timeliness_validation_for attr_names, :time
+        validates_with TimelinessValidator, _merge_attributes(attr_names).merge(type: :time)
       end
 
       def validates_datetime(*attr_names)
-        timeliness_validation_for attr_names, :datetime
+        validates_with TimelinessValidator, _merge_attributes(attr_names).merge(type: :datetime)
       end
 
       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
+        validates_with TimelinessValidator, _merge_attributes(attr_names)
       end
     end
 

data/lib/validates_timeliness/orm/active_model.rb

@@ -3,67 +3,8 @@ module ValidatesTimeliness
     module ActiveModel
       extend ActiveSupport::Concern
 
-      module ClassMethods
-        public
-
-        def define_attribute_methods(*attr_names)
-          super.tap { define_timeliness_methods }
-        end
-
-        def undefine_attribute_methods
-          super.tap { undefine_timeliness_attribute_methods }
-        end
-
-        def define_timeliness_methods(before_type_cast=false)
-          return if timeliness_validated_attributes.blank?
-          timeliness_validated_attributes.each do |attr_name|
-            define_attribute_timeliness_methods(attr_name, before_type_cast)
-          end
-        end
-
-        def generated_timeliness_methods
-          @generated_timeliness_methods ||= Module.new { |m|
-            extend Mutex_m
-          }.tap { |mod| include mod }
-        end
-
-        def undefine_timeliness_attribute_methods
-          generated_timeliness_methods.module_eval do
-            instance_methods.each { |m| undef_method(m) }
-          end
-        end
-
-        def define_attribute_timeliness_methods(attr_name, before_type_cast=false)
-          define_timeliness_write_method(attr_name)
-          define_timeliness_before_type_cast_method(attr_name) if before_type_cast
-        end
-
-        def define_timeliness_write_method(attr_name)
-          generated_timeliness_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
-            def #{attr_name}=(value)
-              @timeliness_cache ||= {}
-              @timeliness_cache['#{attr_name}'] = value
-
-              @attributes['#{attr_name}'] = super
-            end
-          STR
-        end
-
-        def define_timeliness_before_type_cast_method(attr_name)
-          generated_timeliness_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
-            def #{attr_name}_before_type_cast
-              read_timeliness_attribute_before_type_cast('#{attr_name}')
-            end
-          STR
-        end
-      end
-
       def read_timeliness_attribute_before_type_cast(attr_name)
-        @timeliness_cache && @timeliness_cache[attr_name] || @attributes[attr_name]
-      end
-
-      def _clear_timeliness_cache
-        @timeliness_cache = {}
+        @attributes[attr_name].value_before_type_cast
       end
 
     end

data/lib/validates_timeliness/validator.rb

@@ -21,6 +21,8 @@ module ValidatesTimeliness
 
     RESTRICTION_ERROR_MESSAGE = "Error occurred validating %s for %s restriction:\n%s"
 
+    RESERVED_OPTIONS = (RESTRICTIONS.keys + RESTRICTIONS.keys.map { |option| :"#{option}_message" }).freeze
+
     def self.kind
       :timeliness
     end
@@ -72,7 +74,7 @@ module ValidatesTimeliness
         begin
           restriction_value = @converter.type_cast_value(@converter.evaluate(options[restriction], record))
           unless value.send(RESTRICTIONS[restriction], restriction_value)
-            add_error(record, attr_name, restriction, restriction_value) and break
+            add_error(record, attr_name, restriction, value: value, restriction_value: restriction_value) and break
           end
         rescue => e
           unless ValidatesTimeliness.ignore_restriction_errors
@@ -83,20 +85,28 @@ module ValidatesTimeliness
       end
     end
 
-    def add_error(record, attr_name, message, value=nil)
-      value = format_error_value(value) if value
-      message_options = { message: options.fetch(:"#{message}_message", options[:message]), restriction: value }
-      record.errors.add(attr_name, message, **message_options)
+    def add_error(record, attr_name, message, restriction_value: nil, value: nil)
+      error_options = options.except(*RESERVED_OPTIONS).merge!(
+        restriction: format_error_value(restriction_value),
+        value: value
+      )
+
+      message_text = options[:"#{message}_message"]
+      error_options[:message] = message_text if message_text.present?
+
+      record.errors.add(attr_name, message, **error_options)
     end
 
     def format_error_value(value)
+      return unless value
       format = I18n.t(@type, default: DEFAULT_ERROR_VALUE_FORMATS[@type], scope: 'validates_timeliness.error_value_formats')
       value.strftime(format)
     end
 
     def attribute_raw_value(record, attr_name)
-      record.respond_to?(:read_timeliness_attribute_before_type_cast) &&
+      if record.respond_to?(:read_timeliness_attribute_before_type_cast)
         record.read_timeliness_attribute_before_type_cast(attr_name.to_s)
+      end
     end
 
     def time_zone_aware?(record, attr_name)

data/lib/validates_timeliness/version.rb

@@ -1,3 +1,3 @@
 module ValidatesTimeliness
-  VERSION = '7.0.0.beta1'
+  VERSION = '8.0.0'
 end

data/spec/spec_helper.rb

@@ -33,8 +33,6 @@ I18n.available_locales = ['en', 'es']
 # Extend TestModel as you would another ORM/ODM module
 module TestModelShim
   extend ActiveSupport::Concern
-  include ValidatesTimeliness::AttributeMethods
-  include ValidatesTimeliness::ORM::ActiveModel
 
   module ClassMethods
     # Hook into native time zone handling check, if any
@@ -46,11 +44,10 @@ end
 
 class Person
   include TestModel
+
   attribute :birth_date, :date
   attribute :birth_time, :time
   attribute :birth_datetime, :datetime
-
-  define_attribute_methods model_attributes.keys
 end
 
 class PersonWithShim < Person

data/spec/support/model_helpers.rb

@@ -1,22 +1,29 @@
 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|
-      expect(record).to be_invalid
+  def invalid!(attr_name, values, error = nil, model_class = Person)
+    with_each_model_value(attr_name, values, model_class) do |record, value|
+      expect(record).to_not be_valid
       expect(record.errors[attr_name].size).to be >= 1
-      expect(record.errors[attr_name].first).to eq(error) if error
+
+      return unless error
+
+      if error.is_a?(Regexp)
+        expect(record.errors[attr_name].first).to match(error)
+      else
+        expect(record.errors[attr_name].first).to eq(error)
+      end
     end
   end
 
-  def valid!(attr_name, values)
-    with_each_person_value(attr_name, values) do |record, value|
+  def valid!(attr_name, values, model_class = Person)
+    with_each_model_value(attr_name, values, model_class) do |record, value|
       expect(record).to be_valid
     end
   end
 
-  def with_each_person_value(attr_name, values)
-    record = Person.new
+  def with_each_model_value(attr_name, values, model_class)
+    record = model_class.new
     Array.wrap(values).each do |value|
       record.send("#{attr_name}=", value)
       yield record, value

data/spec/support/test_model.rb

@@ -1,61 +1,13 @@
 module TestModel
   extend ActiveSupport::Concern
-  extend ActiveModel::Translation
+  include ActiveModel::Model
+  include ActiveModel::Attributes
   include ActiveModel::Validations
-  include ActiveModel::AttributeMethods
+  include ValidatesTimeliness::AttributeMethods
+  include ValidatesTimeliness::ORM::ActiveModel
 
   included do
     attribute_method_suffix "="
-    cattr_accessor :model_attributes
-  end
-
-  module ClassMethods
-    def attribute(name, type)
-      self.model_attributes ||= {}
-      self.model_attributes[name] = type
-    end
-
-    def define_method_attribute=(attr_name, owner: nil)
-      generated_attribute_methods.module_eval("def #{attr_name}=(new_value); @attributes['#{attr_name}']=self.class.type_cast('#{attr_name}', new_value); end", __FILE__, __LINE__)
-    end
-
-    def define_method_attribute(attr_name, owner: nil)
-      generated_attribute_methods.module_eval("def #{attr_name}; @attributes['#{attr_name}']; end", __FILE__, __LINE__)
-    end
-
-    def type_cast(attr_name, value)
-      return value unless value.is_a?(String)
-      type_name = model_attributes[attr_name.to_sym]
-      type = ActiveModel::Type.lookup(type_name)
-      type.cast(value)
-    end
-  end
-
-  def initialize(attributes = nil)
-    @attributes = self.class.model_attributes.keys.inject({}) do |hash, column|
-      hash[column.to_s] = nil
-      hash
-    end
-    self.attributes = attributes unless attributes.nil?
-  end
-
-  def attributes
-    @attributes
-  end
-
-  def attributes=(new_attributes={})
-    new_attributes.each do |key, value|
-      send "#{key}=", value
-    end
-  end
-
-  def method_missing(method_id, *args, &block)
-    if !matched_attribute_method(method_id.to_s).nil?
-      self.class.define_attribute_methods self.class.model_attributes.keys
-      send(method_id, *args, &block)
-    else
-      super
-    end
   end
 end
 

data/spec/validates_timeliness/attribute_methods_spec.rb

@@ -44,9 +44,11 @@ RSpec.describe ValidatesTimeliness::AttributeMethods do
       class PersonWithParser
         include TestModel
         include TestModelShim
+
         attribute :birth_date, :date
         attribute :birth_time, :time
         attribute :birth_datetime, :datetime
+
         validates_date :birth_date
         validates_time :birth_time
         validates_datetime :birth_datetime
@@ -54,8 +56,10 @@ RSpec.describe ValidatesTimeliness::AttributeMethods do
 
       it 'should parse a string value' do
         expect(Timeliness::Parser).to receive(:parse)
+
         r = PersonWithParser.new
         r.birth_date = '2010-01-01'
+        r.birth_date # parsing happens on read not write
       end
 
     end

data/spec/validates_timeliness/validator/format_spec.rb

@@ -0,0 +1,57 @@
+RSpec.describe ValidatesTimeliness::Validator, ":format option" do
+  with_config(:use_plugin_parser, true)
+
+  describe "for date type" do
+    before do
+      Person.validates_date :birth_date, format: "yyyy-mm-dd"
+    end
+
+    it "should not be valid for string given in the wrong format" do
+      invalid!(:birth_date, '23/12/2023', /is not a valid date/)
+    end
+
+    it "should be valid for string given in the right format" do
+      valid!(:birth_date, '2023-12-23')
+    end
+
+    it "should be valid for date instance" do
+      valid!(:birth_date, Date.new(2022,12,23))
+    end
+  end
+
+  describe "for time type" do
+    before do
+      Person.validates_time :birth_time, format: "hh:nn:ss"
+    end
+
+    it "should not be valid for string given in the wrong format" do
+      invalid!(:birth_time, "00-00-00", /is not a valid time/)
+    end
+
+    it "should be valid for string given in the right format" do
+      valid!(:birth_time, "00:00:00")
+    end
+
+    it "should be valid for date instance" do
+      valid!(:birth_time, Time.new(2010, 1, 1, 0, 0, 0))
+    end
+  end
+
+  describe "for datetime type" do
+    before do
+      Person.validates_datetime :birth_datetime, format: "yyyy-mm-dd hh:nn:ss"
+    end
+
+    it "should not be valid for string given in the wrong format" do
+      invalid!(:birth_datetime, "01-01-2010 00-00-00", /is not a valid datetime/)
+    end
+
+    it "should be valid for string given in the right format" do
+      valid!(:birth_datetime, "2010-01-01 00:00:00")
+    end
+
+    it "should be valid for date instance" do
+      valid!(:birth_datetime, DateTime.new(2010, 1, 1, 0, 0, 0))
+    end
+  end
+end

data/spec/validates_timeliness/validator_spec.rb

@@ -185,6 +185,26 @@ RSpec.describe ValidatesTimeliness::Validator do
     end
   end
 
+  describe "custom option" do
+    it "should pass custom options to the error" do
+      Person.validates_datetime :birth_datetime, :on_or_before => Time.utc(2010,1,2,3,4,5), :custom => 'option'
+
+      with_each_model_value(:birth_datetime, Time.utc(2010,1,2,3,4,5,10000), Person) do |record, value|
+        expect(record).to_not be_valid
+        expect(record.errors.where(:birth_datetime).first.options).to include(custom: 'option')
+      end
+    end
+
+    it "should not pass config options to the error" do
+      Person.validates_datetime :birth_datetime, :on_or_before => Time.utc(2010,1,2,3,4,5), :custom => 'option'
+
+      with_each_model_value(:birth_datetime, Time.utc(2010,1,2,3,4,5,10000), Person) do |record, value|
+        expect(record).to_not be_valid
+        expect(record.errors.where(:birth_datetime).first.options.keys).to_not include(:on_or_before)
+      end
+    end
+  end
+
   describe "restriction value errors" do
     let(:person) { Person.new(:birth_date => Date.today) }
 

data/validates_timeliness.gemspec

@@ -21,12 +21,13 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ["README.md", "CHANGELOG.md", "LICENSE"]
 
   s.metadata = {
+    "rubygems_mfa_required" => "true",
     "bug_tracker_uri" => "#{github_url}/issues",
     "changelog_uri"   => "#{github_url}/blob/master/CHANGELOG.md",
     "source_code_uri" => "#{github_url}",
     "wiki_uri"        => "#{github_url}/wiki",
   }
 
-  s.add_runtime_dependency("activemodel", [">= 7.0.0", "< 8"])
+  s.add_runtime_dependency("activemodel", [">= 8.0.0", "< 9"])
   s.add_runtime_dependency("timeliness", [">= 0.3.10", "< 1"])
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validates_timeliness
 version: !ruby/object:Gem::Version
-  version: 7.0.0.beta1
+  version: 8.0.0
 platform: ruby
 authors:
 - Adam Meehan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 8.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 8.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: timeliness
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +66,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/rails_7_0.gemfile
-- gemfiles/rails_edge.gemfile
+- gemfiles/rails_8_0.gemfile
 - init.rb
 - lib/generators/validates_timeliness/install_generator.rb
 - lib/generators/validates_timeliness/templates/en.yml
@@ -99,6 +98,7 @@ files:
 - spec/validates_timeliness/railtie_spec.rb
 - spec/validates_timeliness/validator/after_spec.rb
 - spec/validates_timeliness/validator/before_spec.rb
+- spec/validates_timeliness/validator/format_spec.rb
 - spec/validates_timeliness/validator/is_at_spec.rb
 - spec/validates_timeliness/validator/on_or_after_spec.rb
 - spec/validates_timeliness/validator/on_or_before_spec.rb
@@ -109,6 +109,7 @@ homepage: https://github.com/adzap/validates_timeliness
 licenses:
 - MIT
 metadata:
+  rubygems_mfa_required: 'true'
   bug_tracker_uri: https://github.com/adzap/validates_timeliness/issues
   changelog_uri: https://github.com/adzap/validates_timeliness/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/adzap/validates_timeliness
@@ -124,11 +125,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Date and time validation plugin for Rails which allows custom formats
@@ -148,6 +149,7 @@ test_files:
 - spec/validates_timeliness/railtie_spec.rb
 - spec/validates_timeliness/validator/after_spec.rb
 - spec/validates_timeliness/validator/before_spec.rb
+- spec/validates_timeliness/validator/format_spec.rb
 - spec/validates_timeliness/validator/is_at_spec.rb
 - spec/validates_timeliness/validator/on_or_after_spec.rb
 - spec/validates_timeliness/validator/on_or_before_spec.rb

data/gemfiles/rails_edge.gemfile

@@ -1,13 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rails", git: "https://github.com/rails/rails.git", branch: "main"
-gem "rspec"
-gem "rspec-rails", "~> 3.7"
-gem "sqlite3"
-gem "byebug"
-gem "appraisal"
-gem "nokogiri", "~> 1.8"
-
-gemspec path: "../"