validates_timeliness 7.0.0.beta2 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 291ec2c50666a8ce39654fb9c065ca22a27cc91413039a41faa1045e5143ee7e
-  data.tar.gz: 8ec042268f1524503c5daf4e0038769d64b0be9b0329281137a569579a5d991a
+  metadata.gz: d882843a354b86918dd2709809168d5dcbaf024319eeb424b1e0ff56f7731512
+  data.tar.gz: 0d5c06701e489c7332b59032055a25bcd4c2887f68c95b49a2d4192ecf313d71
 SHA512:
-  metadata.gz: 0f7fd09d93f725dcbda325d6d681f1f68fd765ea75a5ae8d3206fe369fd9647f1ae6cb1be36d353c790482e310bd4f8cd4cc749fbb75a8aafc8b4653f7e76025
-  data.tar.gz: 433b16c8be0034ca7e9d8f6349ee9423a1437df4183e47efd623116b634287833f7b57f7f7a456bff06a1bbb9eb19df14c5cf73a0a6bb1e46d52f3ff112522df
+  metadata.gz: dc46ee39a4f707078094de96dd795c75f6287343c3a020be49a8455c76a07aad0cd4d26d46b143ca4149c81a8d54c273a32575ef7f0bc23fa63317ccaffc1851
+  data.tar.gz: 68a0b32a966d7c1a3df5d33c7642eac1c92efa276059b543b8240e73535fa5538e51c580be3362c4011b8f1838bc03817e7b7cc07d7219e68a18b2299cacf6a3

data/.github/workflows/ci.yml

@@ -14,6 +14,22 @@ jobs:
           - gemfile: rails_7_0
             ruby: 3.1
 
+          - gemfile: rails_7_1
+            ruby: 2.7
+          - gemfile: rails_7_1
+            ruby: 3.0
+          - gemfile: rails_7_1
+            ruby: 3.1
+          - gemfile: rails_7_1
+            ruby: 3.2
+
+          - gemfile: rails_7_2
+            ruby: 3.1
+          - gemfile: rails_7_2
+            ruby: 3.2
+          - gemfile: rails_7_2
+            ruby: 3.3
+
     name: ${{ matrix.gemfile }}, ruby ${{ matrix.ruby }}
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 7.1.0 [2024-12-31]
+*   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

@@ -30,7 +30,7 @@ Older Rails versions:
 
 In Gemfile
 ```ruby
-gem 'validates_timeliness', '~> 7.0.0.beta1'
+gem 'validates_timeliness', '~> 7.0.0'
 ```
 
 Run bundler:

data/gemfiles/rails_7_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 "rspec"
 gem "rspec-rails", "~> 6.0"
-gem "sqlite3"
+gem "sqlite3", "~> 1.4"
 gem "byebug"
 gem "appraisal"
-gem "nokogiri", "~> 1.8"
+gem "nokogiri"
 
 gemspec path: "../"

data/gemfiles/rails_7_1.gemfile

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

data/gemfiles/rails_7_2.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.2.0"
+gem "rspec"
+gem "rspec-rails", "~> 6.0"
+gem "sqlite3", "~> 1.4"
+gem "byebug"
+gem "appraisal"
+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,91 +3,8 @@ module ValidatesTimeliness
     module ActiveModel
       extend ActiveSupport::Concern
 
-      module ClassMethods
-        public
-
-        # Hook into bulk method definitions for non-attribute based methods validated.
-        def define_attribute_methods(*attr_names)
-          super.tap {
-            define_timeliness_methods
-          }
-        end
-
-        # Called when `attribute` methods is called and the timeliness overrides are defined here
-        def define_attribute_method(attr_name)
-          super.tap {
-            define_attribute_timeliness_methods(attr_name)
-          }
-        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|
-            unless timeliness_method_already_implemented?(attr_name)
-              define_attribute_timeliness_methods(attr_name, before_type_cast)
-            end
-          end
-        end
-
-        def define_timeliness_method(attr_name, before_type_cast=false)
-          define_attribute_timeliness_methods(attr_name, before_type_cast)
-        end
-
-        # Lazy instantiate module as container of timeliness methods included in the model
-        def generated_timeliness_methods
-          @generated_timeliness_methods ||= Module.new { |m|
-            extend Mutex_m
-          }.tap { |mod| include mod }
-        end
-
-        def timeliness_method_already_implemented?(method_name)
-          generated_timeliness_methods.method_defined?(method_name)
-        end
-
-        def undefine_timeliness_attribute_methods
-          generated_timeliness_methods.module_eval do
-            undef_method(*instance_methods)
-          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
-
-              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].value_before_type_cast
-      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" }
+
     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.beta2'
+  VERSION = '7.1.0'
 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) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validates_timeliness
 version: !ruby/object:Gem::Version
-  version: 7.0.0.beta2
+  version: 7.1.0
 platform: ruby
 authors:
 - Adam Meehan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-24 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -67,7 +67,8 @@ files:
 - README.md
 - Rakefile
 - gemfiles/rails_7_0.gemfile
-- gemfiles/rails_edge.gemfile
+- gemfiles/rails_7_1.gemfile
+- gemfiles/rails_7_2.gemfile
 - init.rb
 - lib/generators/validates_timeliness/install_generator.rb
 - lib/generators/validates_timeliness/templates/en.yml
@@ -126,11 +127,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

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: "../"