validates_timeliness 6.0.0.beta2 → 7.0.0.beta1

data/README.md

@@ -1,130 +1,126 @@
 # 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
+- 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.
+Complete validation of dates, times and datetimes for Rails 7.x and ActiveModel.
 
-Old Rails versions:
+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 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]
 
 
 ## 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).
+- 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'
+In Gemfile
+```ruby
+gem 'validates_timeliness', '~> 7.0.0.beta1'
+```
 
-    # Run bundler
-    $ bundle install
+Run bundler:
+```bash
+$ bundle install
+```
 
 Then run
+```bash
+$ rails generate validates_timeliness:install
+```
 
-    $ 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.
 
-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.
+**NOTE**: You may wish to enable the plugin parser and the extensions to start.
 Please read those sections first.
 
 ## Examples
 
-    validates_datetime :occurred_at
+```ruby
+validates_datetime :occurred_at
 
-    validates_date :date_of_birth, before: lambda { 18.years.ago },
-                                   before_message: "must be at least 18 years old"
+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_datetime :finish_time, after: :start_time # Method symbol
 
-    validates_date :booked_at, on: :create, on_or_after: :today # See Restriction Shorthand.
+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 :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'
+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
+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
+```ruby
+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 }
+```ruby
+@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.
+- `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.
+- `: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.
+- `: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.
+- `: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
+- 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
@@ -146,17 +142,15 @@ 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
+```ruby
+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
+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
@@ -165,52 +159,54 @@ 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.
+```yml
+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.
+```ruby
+: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
+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
+```ruby
+# 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
@@ -226,16 +222,16 @@ 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:
+```ruby
+validates_date :birth_date, on_or_before: :today
+```
 
-    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 }
-    )
+The `:today` symbol is evaluated as `lambda { Date.current }`. The `:now` and
+`:today` symbols are pre-configured. Configure your own like so:
+```ruby
+# in the setup block
+config.restriction_shorthand_symbols.update(yesterday: lambda { 1.day.ago })
+```
 
 ### Default Timezone
 
@@ -243,11 +239,12 @@ 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.
+```ruby
+# in the setup block
+config.default_timezone = :utc
+```
 
-    # in the setup block
-    config.default_timezone = :utc
-
-By default it will be UTC if ActiveRecord is not loaded.
+By default it will be `UTC` if ActiveRecord is not loaded.
 
 ### Dummy Date For Time Types
 
@@ -255,13 +252,13 @@ 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]
+reason you can do so as follows:
+```ruby
+# 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.
+The value should be an array of 3 values being year, month and day in that order.
 
 ### Temporal Restriction Errors
 
@@ -273,9 +270,10 @@ 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
+```ruby
+# in the setup block
+config.ignore_restriction_errors = true
+```
 
 ## Extensions
 
@@ -288,9 +286,10 @@ 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!
+```ruby
+# in the setup block
+config.enable_multiparameter_extension!
+```
 
 ### Display Invalid Values in Select Helpers
 
@@ -301,21 +300,20 @@ 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!
+```ruby
+# 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).
+[contributors list](https://github.com/adzap/validates_timeliness/contributors).
 
 ## Maintainers
 
-*   [Adam Meehan](https://github.com/adzap)
-
+* [Adam Meehan](https://github.com/adzap)
 
 ## License
 
-Copyright (c) 2008 Adam Meehan, released under the MIT license
+Copyright (c) 2021 Adam Meehan, released under the MIT license.

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

@@ -2,11 +2,10 @@
 
 source "http://rubygems.org"
 
-gem "rails", "~> 6.0.0"
+gem "rails", "~> 7.0.0"
 gem "rspec"
-gem "rspec-rails", "~> 3.7"
+gem "rspec-rails", "~> 6.0"
 gem "sqlite3"
-gem "timecop"
 gem "byebug"
 gem "appraisal"
 gem "nokogiri", "~> 1.8"

data/gemfiles/rails_edge.gemfile

@@ -6,7 +6,6 @@ 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"

data/lib/validates_timeliness/railtie.rb

@@ -2,7 +2,7 @@ module ValidatesTimeliness
   class Railtie < Rails::Railtie
     initializer "validates_timeliness.initialize_active_record", :after => 'active_record.initialize_timezone' do
       ActiveSupport.on_load(:active_record) do
-        ValidatesTimeliness.default_timezone = ActiveRecord::Base.default_timezone
+        ValidatesTimeliness.default_timezone = ActiveRecord.default_timezone
         ValidatesTimeliness.extend_orms << :active_record
         ValidatesTimeliness.load_orms
       end

data/lib/validates_timeliness/version.rb

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

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ require 'active_model'
 require 'active_model/validations'
 require 'active_record'
 require 'action_view'
-require 'timecop'
+require 'active_support/testing/time_helpers'
 
 require 'validates_timeliness'
 require 'validates_timeliness/orm/active_model'
@@ -57,7 +57,7 @@ class PersonWithShim < Person
   include TestModelShim
 end
 
-ActiveRecord::Base.default_timezone = :utc
+ActiveRecord.default_timezone = :utc
 ActiveRecord::Base.time_zone_aware_attributes = true
 ActiveRecord::Base.establish_connection({:adapter => 'sqlite3', :database => ':memory:'})
 ActiveRecord::Base.time_zone_aware_types = [:datetime, :time]
@@ -89,6 +89,7 @@ RSpec.configure do |c|
   c.include(TagMatcher)
   c.include(ModelHelpers)
   c.include(ConfigHelper)
+  c.include(ActiveSupport::Testing::TimeHelpers)
   c.before do
     reset_validation_setup_for(Person)
     reset_validation_setup_for(PersonWithShim)

data/spec/validates_timeliness/converter_spec.rb

@@ -7,7 +7,11 @@ RSpec.describe ValidatesTimeliness::Converter do
   let(:ignore_usec) { false }
 
   before do
-    Timecop.freeze(Time.mktime(2010, 1, 1, 0, 0, 0))
+    travel_to Time.mktime(2010, 1, 1, 0, 0, 0)
+  end
+
+  after do
+    travel_back
   end
 
   delegate :type_cast_value, :evaluate, :parse, :dummy_time, to: :converter
@@ -195,10 +199,6 @@ RSpec.describe ValidatesTimeliness::Converter do
     end
 
     context "restriction shorthand" do
-      before do
-        Timecop.freeze(Time.mktime(2010, 1, 1, 0, 0, 0))
-      end
-
       it 'should evaluate :now as current time' do
         expect(evaluate(:now, person)).to eq(Time.now)
       end

data/spec/validates_timeliness/extensions/date_time_select_spec.rb

@@ -115,7 +115,11 @@ RSpec.describe 'ValidatesTimeliness::Extensions::DateTimeSelect' do
 
   describe "time_select" do
     before do
-      Timecop.freeze Time.mktime(2009,1,1)
+      travel_to Time.mktime(2009,1,1)
+    end
+
+    after do
+      travel_back
     end
 
     it "should use param values when attribute is nil" do
@@ -158,5 +162,5 @@ RSpec.describe 'ValidatesTimeliness::Extensions::DateTimeSelect' do
       expect(@output).not_to have_tag("select[id=person_#{attribute}_#{index}i] option[selected=selected]")
     end
   end
-  
+
 end

data/spec/validates_timeliness/validator/is_at_spec.rb

@@ -1,6 +1,10 @@
 RSpec.describe ValidatesTimeliness::Validator, ":is_at option" do
   before do
-    Timecop.freeze(Time.local(2010, 1, 1, 0, 0, 0))
+    travel_to Time.local(2010, 1, 1, 0, 0, 0)
+  end
+
+  after do
+    travel_back
   end
 
   describe "for date type" do

data/spec/validates_timeliness/validator_spec.rb

@@ -1,6 +1,10 @@
 RSpec.describe ValidatesTimeliness::Validator do
   before do
-    Timecop.freeze(Time.local(2010, 1, 1, 0, 0, 0))
+    travel_to Time.local(2010, 1, 1, 0, 0, 0)
+  end
+
+  after do
+    travel_back
   end
 
   describe "Model.validates with :timeliness option" do

data/validates_timeliness.gemspec

@@ -3,20 +3,30 @@ $:.push File.expand_path("../lib", __FILE__)
 require "validates_timeliness/version"
 
 Gem::Specification.new do |s|
+
+  github_url    = 'https://github.com/adzap/validates_timeliness'
+
   s.name        = "validates_timeliness"
   s.version     = ValidatesTimeliness::VERSION
   s.authors     = ["Adam Meehan"]
   s.summary     = %q{Date and time validation plugin for Rails which allows custom formats}
   s.description = %q{Adds validation methods to ActiveModel for validating dates and times. Works with multiple ORMS.}
   s.email       = %q{adam.meehan@gmail.com}
-  s.homepage    = %q{http://github.com/adzap/validates_timeliness}
+  s.homepage    = github_url
   s.license     = "MIT"
 
   s.require_paths    = ["lib"]
   s.files            = `git ls-files`.split("\n") - %w{ .gitignore .rspec Gemfile Gemfile.lock autotest/discover.rb Appraisals } - Dir['gemsfiles/*']
   s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.extra_rdoc_files = ["README.md", "CHANGELOG.rdoc", "LICENSE"]
+  s.extra_rdoc_files = ["README.md", "CHANGELOG.md", "LICENSE"]
+
+  s.metadata = {
+    "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", [">= 6.0.0", "< 7"])
+  s.add_runtime_dependency("activemodel", [">= 7.0.0", "< 8"])
   s.add_runtime_dependency("timeliness", [">= 0.3.10", "< 1"])
 end