validates_timeliness 4.1.1 → 6.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 942eb4506928d381dae7a7356206a045a57d8085cc9ef8ea6e96801186274bea
-  data.tar.gz: 6991d619ce2c4872c16e1c757f6de78c8f1761c6b5194f10b0312158431aba15
+  metadata.gz: dc002013bf4a78cba246d4a99133e7cf50a4728125f6472621f2b8a563ea0857
+  data.tar.gz: fd59680e5636166eeff6848fb3a2560878c583a5fc60dbea9aba9d52fa53e0de
 SHA512:
-  metadata.gz: abf74b01270b55f495fd10ca1e5abcdfe899742499dcb8c7af17b11f68aa04143b843d3b65c9cbafbd6eae1f56a4a9d4959b9bd8af6ec42a1c7bcc65055689d1
-  data.tar.gz: afb9c7e4657292e244749548a8669222da167410d7a28831c665f6a86fa88e0415e3daecbd4580f8c2eec24e754c59cfe7ba2a232256c7a769b0ff2805aea6a5
+  metadata.gz: b80b655d4df7e324fc42bdd2b3006e7c5cf8a0fb4fd6d0d27155a94a4ce4e9b93e7ffa1e9eb0f79fb7635a6a0bc75d34112d25a425cd553b0be2a641fb93b626
+  data.tar.gz: 1ad906a88d910f0dae8ef4f0d09431776b43c9db85ab587b8f35ea18fd8cdb75a6dcbea666b745b7cc17dbc998f6e3274429ecc1e8fb5c47c5beabfb4ac42d23

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10

data/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - gemfile: rails_6_0
+            ruby: 2.6
+          - gemfile: rails_6_0
+            ruby: 2.7
+          - gemfile: rails_6_0
+            ruby: 3.0
+          - gemfile: rails_6_1
+            ruby: 2.6
+          - gemfile: rails_6_1
+            ruby: 2.7
+          - gemfile: rails_6_1
+            ruby: 3.0
+
+    name: ${{ matrix.gemfile }}, ruby ${{ matrix.ruby }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: false
+
+    - name: Bundle install
+      run: |
+        bundle config set gemfile "${GITHUB_WORKSPACE}/gemfiles/${{ matrix.gemfile }}.gemfile"
+        bundle install --jobs 4 --retry 3
+
+    - name: Run specs
+      run: |
+        bundle exec rspec

data/CHANGELOG.rdoc

@@ -1,9 +1,17 @@
-= 4.1.1 [2019-08-06]
-* Add initializer to ensure Timeliness default ambigiuous date handling config
-  in Timeliness v0.4.1+ is set correctly when using `use_us_formats` or
-  `use_euro_formats` switcher to set default.
-* Removed build support for Ruby 2.3 and Rails 4.0 and 4.1 to EOL official
-  support for those.
+= 5.0.0 [2021-04-03]
+* Fix DateTimeSelect extension support (AquisTech)
+* Relaxed Timeliness dependency version which allows for >= 0.4.0 with
+  threadsafety fix for use_us_formats and use_euro_formats for hot switching
+	in a request.
+* Add initializer to ensure Timeliness v0.4+ ambiguous date config is set
+  correctly when using `use_euro_formats` or `remove_use_formats'.
+* Add Ruby 3 compatibility
+* Add Rails 6.1 compatibility
+
+Breaking Changes
+* Update Multiparameter extension to use ActiveRecord type classes with multiparameter handling
+  which stores a hash of multiparamter values as the value before type cast, no longer a mushed datetime string
+* Removed all custom plugin attribute methods and method overrides in favour using ActiveModel type system
 
 = 4.1.0 [2019-06-11]
 * Relaxed Timeliness dependency version to >= 0.3.10 and < 1, which allows

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2010 Adam Meehan
+Copyright (c) 2008-2021 Adam Meehan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,321 @@
+# ValidatesTimeliness [![build](https://github.com/adzap/validates_timeliness/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/adzap/validates_timeliness/actions/workflows/ci.yml)
+
+*   Source:  https://github.com/adzap/validates_timeliness
+*   Issues:  https://github.com/adzap/validates_timeliness/issues
+
+
+## Description
+
+Complete validation of dates, times and datetimes for Rails 6.x and
+ActiveModel.
+
+Old 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]
+
+
+## Features
+
+*   Adds validation for dates, times and datetimes to ActiveModel
+
+*   Handles timezones and type casting of values for you
+
+*   Only Rails date/time validation plugin offering complete validation (See
+    ORM/ODM support)
+
+*   Uses extensible date/time parser (Using [timeliness
+    gem](https://github.com/adzap/timeliness). See Plugin Parser)
+
+*   Adds extensions to fix Rails date/time select issues (See Extensions)
+
+*   Supports I18n for the error messages. For multi-language support try
+    [timeliness-i18n gem](https://github.com/pedrofurtado/timeliness-i18n).
+
+*   Supports all the Rubies (that any sane person would be using in
+    production).
+
+
+## Installation
+
+    # in Gemfile
+    gem 'validates_timeliness', '~> 6.0.0.alpha1'
+
+    # Run bundler
+    $ bundle install
+
+Then run
+
+    $ rails generate validates_timeliness:install
+
+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.
+
+## Examples
+
+    validates_datetime :occurred_at
+
+    validates_date :date_of_birth, before: lambda { 18.years.ago },
+                                   before_message: "must be at least 18 years old"
+
+    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'] # 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',
+                                    before: :lunchtime,
+                                    before_message: 'must be before lunch time'
+
+## Usage
+
+To validate a model with a date, time or datetime attribute you just use the
+validation method
+
+    class Person < ActiveRecord::Base
+      validates_date :date_of_birth, on_or_before: lambda { Date.current }
+      # or
+      validates :date_of_birth, timeliness: {on_or_before: lambda { Date.current }, type: :date}
+    end
+
+or even on a specific record, per ActiveModel API.
+
+    @person.validates_date :date_of_birth, on_or_before: lambda { Date.current }
+
+The list of validation methods available are as follows:
+    validates_date     - validate value as date
+    validates_time     - validate value as time only i.e. '12:20pm'
+    validates_datetime - validate value as a full date and time
+    validates          - use the :timeliness key and set the type in the hash.
+
+The validation methods take the usual options plus some specific ones to
+restrict the valid range of dates or times allowed
+
+Temporal options (or restrictions):
+    :is_at        - Attribute must be equal to value to be valid
+    :before       - Attribute must be before this value to be valid
+    :on_or_before - Attribute must be equal to or before this value to be valid
+    :after        - Attribute must be after this value to be valid
+    :on_or_after  - Attribute must be equal to or after this value to be valid
+    :between      - Attribute must be between the values to be valid. Range or Array of 2 values.
+
+Regular validation options:
+    :allow_nil    - Allow a nil value to be valid
+    :allow_blank  - Allows a nil or empty string value to be valid
+    :if           - Execute validation when :if evaluates true
+    :unless       - Execute validation when :unless evaluates false
+    :on           - Specify validation context e.g :save, :create or :update. Default is :save.
+
+Special options:
+    :ignore_usec  - Ignores microsecond value on datetime restrictions
+    :format       - Limit validation to a single format for special cases. Requires plugin parser.
+
+The temporal restrictions can take 4 different value types:
+
+*   Date, Time, or DateTime object value
+*   Proc or lambda object which may take an optional parameter, being the
+    record object
+*   A symbol matching a method name in the model
+*   String value
+
+
+When an attribute value is compared to temporal restrictions, they are
+compared as the same type as the validation method type. So using
+validates_date means all values are compared as dates.
+
+## Configuration
+
+### ORM/ODM Support
+
+The plugin adds date/time validation to ActiveModel for any ORM/ODM that
+supports the ActiveModel validations component. However, there is an issue
+with most ORM/ODMs which does not allow 100% date/time validation by default.
+Specifically, when you assign an invalid date/time value to an attribute, most
+ORM/ODMs will only store a nil value for the attribute. This causes an issue
+for date/time validation, since we need to know that a value was assigned but
+was invalid. To fix this, we need to cache the original invalid value to know
+that the attribute is not just nil.
+
+Each ORM/ODM requires a specific shim to fix it. The plugin includes a shim
+for ActiveRecord and Mongoid. You can activate them like so
+
+    ValidatesTimeliness.setup do |config|
+
+      # Extend ORM/ODMs for full support (:active_record).
+      config.extend_orms = [ :active_record ]
+
+    end
+
+By default the plugin extends ActiveRecord if loaded. If you wish to extend
+another ORM then look at the [wiki
+page](https://github.com/adzap/validates_timeliness/wiki/ORM-Support) for more
+information.
+
+It is not required that you use a shim, but you will not catch errors when the
+attribute value is invalid and evaluated to nil.
+
+### Error Messages
+
+Using the I18n system to define new defaults:
+
+    en:
+      errors:
+        messages:
+          invalid_date: "is not a valid date"
+          invalid_time: "is not a valid time"
+          invalid_datetime: "is not a valid datetime"
+          is_at: "must be at %{restriction}"
+          before: "must be before %{restriction}"
+          on_or_before: "must be on or before %{restriction}"
+          after: "must be after %{restriction}"
+          on_or_after: "must be on or after %{restriction}"
+
+The %{restriction} signifies where the interpolation value for the restriction
+will be inserted.
+
+You can also use validation options for custom error messages. The following
+option keys are available:
+
+    :invalid_date_message
+    :invalid_time_message
+    :invalid_datetime_message
+    :is_at_message
+    :before_message
+    :on_or_before_message
+    :after_message
+    :on_or_after_message
+
+Note: There is no :between_message option. The between error message should be
+defined using the :on_or_after and :on_or_before (: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.
+
+### Plugin Parser
+
+The plugin uses the [timeliness gem](https://github.com/adzap/timeliness) as a
+fast, configurable and extensible date and time parser. You can add or remove
+valid formats for dates, times, and datetimes. It is also more strict than the
+Ruby parser, which means it won't accept day of the month if it's not a valid
+number for the month.
+
+By default the parser is disabled. To enable it:
+
+    # in the setup block
+    config.use_plugin_parser = true
+
+Enabling the parser will mean that strings assigned to attributes validated
+with the plugin will be parsed using the gem. See the
+[wiki](https://github.com/adzap/validates_timeliness/wiki/Plugin-Parser) for
+more details about the parser configuration.
+
+### Restriction Shorthand
+
+It is common to restrict an attribute to being on or before the current time
+or current day. To specify this you need to use a lambda as an option value
+e.g. `lambda { Time.current }`. This can be tedious noise amongst your
+validations for something so common. To combat this the plugin allows you to
+use shorthand symbols for often used relative times or dates.
+
+Just provide the symbol as the option value like so:
+
+    validates_date :birth_date, on_or_before: :today
+
+The :today symbol is evaluated as `lambda { Date.current }`. The :now and
+:today symbols are pre-configured. Configure your own like so:
+
+    # in the setup block
+    config.restriction_shorthand_symbols.update(
+      yesterday: lambda { 1.day.ago }
+    )
+
+### Default Timezone
+
+The plugin needs to know the default timezone you are using when parsing or
+type casting values. If you are using ActiveRecord then the default is
+automatically set to the same default zone as ActiveRecord. If you are using
+another ORM you may need to change this setting.
+
+    # in the setup block
+    config.default_timezone = :utc
+
+By default it will be UTC if ActiveRecord is not loaded.
+
+### Dummy Date For Time Types
+
+Given that Ruby has no support for a time-only type, all time type columns are
+evaluated as a regular Time class objects with a dummy date value set. Rails
+defines the dummy date as 2000-01-01. So a time of '12:30' is evaluated as a
+Time value of '2000-01-01 12:30'. If you need to customize this for some
+reason you can do so as follows
+
+    # in the setup block
+    config.dummy_date_for_time_type = [2009, 1, 1]
+
+The value should be an array of 3 values being year, month and day in that
+order.
+
+### Temporal Restriction Errors
+
+When using the validation temporal restrictions there are times when the
+restriction option value itself may be invalid. This will add an error to the
+model such as 'Error occurred validating birth_date for :before restriction'.
+These can be annoying in development or production as you most likely just
+want to skip the option if no valid value was returned. By default these
+errors are displayed in Rails test mode.
+
+To turn them on/off:
+
+    # in the setup block
+    config.ignore_restriction_errors = true
+
+## Extensions
+
+### Strict Parsing for Select Helpers
+
+When using date/time select helpers, the component values are handled by
+ActiveRecord using the Time class to instantiate them into a time value. This
+means that some invalid dates, such as 31st June, are shifted forward and
+treated as valid. To handle these cases in a strict way, you can enable the
+plugin extension to treat them as invalid dates.
+
+To activate it, uncomment this line in the initializer:
+
+    # in the setup block
+    config.enable_multiparameter_extension!
+
+### Display Invalid Values in Select Helpers
+
+The plugin offers an extension for ActionView to allowing invalid date and
+time values to be redisplayed to the user as feedback, instead of a blank
+field which happens by default in Rails. Though the date helpers make this a
+pretty rare occurrence, given the select dropdowns for each date/time
+component, but it may be something of interest.
+
+To activate it, uncomment this line in the initializer:
+
+    # in the setup block
+    config.enable_date_time_select_extension!
+
+## Contributors
+
+To see the generous people who have contributed code, take a look at the
+[contributors
+list](https://github.com/adzap/validates_timeliness/contributors).
+
+## Maintainers
+
+*   [Adam Meehan](https://github.com/adzap)
+
+
+## License
+
+Copyright (c) 2008 Adam Meehan, released under the MIT license

data/Rakefile

@@ -5,7 +5,6 @@ require 'appraisal'
 
 Bundler::GemHelper.install_tasks
 
-require 'rdoc/task'
 require 'rspec/core/rake_task'
 
 desc "Run specs"
@@ -17,14 +16,5 @@ RSpec::Core::RakeTask.new(:coverage) do |t|
   t.rcov_opts = ['--exclude', 'spec']
 end
 
-desc 'Generate documentation for plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ValidatesTimeliness'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
 desc 'Default: run specs.'
 task :default => :spec

data/gemfiles/rails_6_0.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 6.0.0"
+gem "rspec"
+gem "rspec-rails", "~> 3.7"
+gem "sqlite3"
+gem "timecop"
+gem "byebug"
+gem "appraisal"
+gem "nokogiri", "~> 1.8"
+
+gemspec path: "../"

data/gemfiles/rails_6_1.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 6.1.0"
+gem "rspec"
+gem "rspec-rails", "~> 3.7"
+gem "sqlite3"
+gem "timecop"
+gem "byebug"
+gem "appraisal"
+gem "nokogiri", "~> 1.8"
+
+gemspec path: "../"

data/gemfiles/rails_edge.gemfile

@@ -0,0 +1,14 @@
+# 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 "timecop"
+gem "byebug"
+gem "appraisal"
+gem "nokogiri", "~> 1.8"
+
+gemspec path: "../"

data/lib/validates_timeliness/attribute_methods.rb

@@ -6,83 +6,44 @@ module ValidatesTimeliness
       class_attribute :timeliness_validated_attributes
       self.timeliness_validated_attributes = []
     end
+  end
+end
 
-    module ClassMethods
-
-      public
-      # Override in ORM shim
-      def timeliness_attribute_timezone_aware?(attr_name)
-        false
-      end
-
-      # Override in ORM shim
-      def timeliness_attribute_type(attr_name)
-        :datetime
-      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
-
-      protected
-
-      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)
-            write_timeliness_attribute('#{attr_name}', value)
-          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
+ActiveModel::Type::Date.prepend Module.new {
+  def cast_value(value)
+    return super unless ValidatesTimeliness.use_plugin_parser
+
+    if value.is_a?(::String)
+      return if value.empty?
+      value = Timeliness::Parser.parse(value, :date)
+      value.to_date if value
+    elsif value.respond_to?(:to_date)
+      value.to_date
+    else
+      value
     end
+  end
+}
 
-    def write_timeliness_attribute(attr_name, value)
-      @timeliness_cache ||= {}
-      @timeliness_cache[attr_name] = value
-
-      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
+ActiveModel::Type::Time.prepend Module.new {
+  def user_input_in_time_zone(value)
+    return super unless ValidatesTimeliness.use_plugin_parser
 
-      @attributes[attr_name] = value
+    if value.is_a?(String)
+      dummy_time_value = value.sub(/\A(\d\d\d\d-\d\d-\d\d |)/, Date.current.to_s + ' ')
+      Timeliness::Parser.parse(dummy_time_value, :datetime, zone: :current)
+    else
+      value.in_time_zone
     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 = {}
+  end
+}
+
+ActiveModel::Type::DateTime.prepend Module.new {
+  def user_input_in_time_zone(value)
+    if value.is_a?(String) && ValidatesTimeliness.use_plugin_parser
+      Timeliness::Parser.parse(value, :datetime, zone: :current)
+    else
+      value.in_time_zone
     end
   end
-end
+}