Compare commits

..

30 Commits

Author SHA1 Message Date
Viktor Fonic
af3e6ff774 Convert README to markdown
Also:
- Highlight syntax
- Change http to https
- Update License
- Fix default value of today (Date.current)
2021-02-12 09:50:36 +01:00
Geremia Taglialatela
f25ab5671c Add Ruby 3.0 compatibility
- Double splat `values` parameter when calling DateTimeValue
2021-02-12 09:50:21 +01:00
Geremia Taglialatela
a0adda3eb2 Improve Travis CI matrix
- Test against latest Ubuntu LTS (20.04)
- Test against latest Ruby versions
- Test against Rails Edge and Ruby Head to discover failures in advance
2021-02-12 09:48:30 +01:00
Pedro Paiva
709d2c87e2 Add Rails 6.1 compatibility
Rails 6.1 needs the following changes:
- Add `owner: nil` to `define_method_attribute` calls
- Pass `options` to error `add` method as keyword argument

Ref:
- https://api.rubyonrails.org/v6.0.0/classes/ActiveModel/Errors.html#method-i-add
- https://api.rubyonrails.org/v6.1.0/classes/ActiveModel/Errors.html#method-i-add

Fix: #193
2021-01-10 10:28:52 +01:00
Adam Meehan
16221ac092 Merge pull request #190 from AleBL/patch-1
Update README.rdoc
2020-08-19 10:18:45 +10:00
Alessandro Barros
c0c42edd3f Update README.rdoc
change to new syntax for keys
2020-08-18 17:56:15 -03:00
Adam Meehan
f8b91e9cea v5.0.0.beta2 2020-07-12 16:26:54 +10:00
Adam Meehan
7fa4d85ee3 Change load_config_initializers to sym in Railtie 2020-07-04 17:07:28 +10:00
Adam Meehan
70307293c6 defaults Rails to 5.2.x 2020-07-04 17:06:39 +10:00
Adam Meehan
f42e905cd1 Merge pull request #189 from VSPPedro/update-readme
readme version bump
2020-06-30 09:33:37 +10:00
Pedro Paiva
35eb50aa40 readme version bump 2020-06-29 19:44:40 -03:00
Adam Meehan
3134072f01 v5.0.0.beta1 2020-01-06 15:48:51 +11:00
Adam Meehan
797ba48036 default rails to 5.1.x 2020-01-06 15:47:34 +11:00
Adam Meehan
f8e6480f58 use ActiveSupport Array.wrap 2019-08-20 10:38:38 -10:00
Adam Meehan
3835b2b161 v5.0.0.alpha5 2019-08-08 10:34:27 +10:00
Adam Meehan
00d038bc6f Merge branch 'master' of github.com:adzap/validates_timeliness 2019-08-06 15:17:34 +10:00
Adam Meehan
a3d0182b5e Merge pull request #186 from timdiggins/patch-1
Add in v4.1.0 details into Changelog
2019-08-06 14:55:45 +10:00
Adam Meehan
46296f914f ensure timeliness initializer is after initializer files 2019-08-03 12:56:08 +10:00
Adam Meehan
4447361743 hash syntax 2019-08-03 12:38:47 +10:00
Adam Meehan
4523138c3c Add Rails initializer to set Timeliness.ambiguous_date_format for Timeliness v0.4+ 2019-08-03 12:38:39 +10:00
Tim Diggins
72807b87a7 Add in v4.1.0 details into Changelog
v4.1.0 details were only available on the v4.1.0 tag. this brings those back in.
2019-08-01 15:30:42 +01:00
Adam Meehan
9daf12c4a1 README typo of Rails version support 2019-06-14 09:59:39 +10:00
Adam Meehan
2a80683683 Merge pull request #183 from kamille-gz/use_AS_on_load_hook
use ActiveSupport.on_load hook for extend ActiveRecord
2019-03-09 17:16:11 +11:00
kamille-321
3a2882be75 use ActiveSupport on_load hook for extend ActiveRecord 2019-03-09 01:14:08 +09:00
Adam Meehan
bf1c808846 fix appraisals 2019-02-09 12:23:57 +11:00
Adam Meehan
d0fcf754ec Update build to ruby 2.5.3 and fix sqlite 2019-02-09 12:15:58 +11:00
Adam Meehan
7233ff66dd v5.0.0.alpha4 2019-02-09 12:00:31 +11:00
Adam Meehan
f0ba09f278 relax timeliness dependency, assuming semver 2019-02-09 11:57:31 +11:00
Adam Meehan
80ee285b3a bump minimum timeliness version 2019-02-03 11:58:11 +11:00
Adam Meehan
cf20576253 readme version bump 2018-07-31 09:08:42 +10:00
25 changed files with 511 additions and 332 deletions

View File

@@ -1,3 +1,5 @@
dist: focal
os: linux
language: ruby
before_install: gem install bundler
cache: bundler
@@ -6,9 +8,45 @@ gemfile:
- gemfiles/rails_5_0.gemfile
- gemfiles/rails_5_1.gemfile
- gemfiles/rails_5_2.gemfile
- gemfiles/rails_6_0.gemfile
- gemfiles/rails_6_1.gemfile
- gemfiles/rails_edge.gemfile
rvm:
- "2.5.1"
- "2.5.8"
- "2.6.6"
- "2.7.2"
- "3.0.0"
- ruby-head
jobs:
allow_failures:
- rvm: ruby-head
- gemfile: gemfiles/rails_edge.gemfile
exclude:
- rvm: 2.5.8
gemfile: gemfiles/rails_edge.gemfile
- rvm: 2.6.6
gemfile: gemfiles/rails_edge.gemfile
- rvm: 2.7.2
gemfile: gemfiles/rails_5_0.gemfile
- rvm: 2.7.2
gemfile: gemfiles/rails_5_1.gemfile
- rvm: 2.7.2
gemfile: gemfiles/rails_5_2.gemfile
- rvm: 3.0.0
gemfile: gemfiles/rails_5_0.gemfile
- rvm: 3.0.0
gemfile: gemfiles/rails_5_1.gemfile
- rvm: 3.0.0
gemfile: gemfiles/rails_5_2.gemfile
- rvm: ruby-head
gemfile: gemfiles/rails_5_0.gemfile
- rvm: ruby-head
gemfile: gemfiles/rails_5_1.gemfile
- rvm: ruby-head
gemfile: gemfiles/rails_5_2.gemfile
fast_finish: true
script: 'bundle exec rspec'

View File

@@ -1,5 +1,6 @@
appraise "rails_5_0" do
gem "rails", "~> 5.0.0"
gem 'sqlite3', '~> 1.3.6'
end
appraise "rails_5_1" do
@@ -8,4 +9,16 @@ end
appraise "rails_5_2" do
gem "rails", "~> 5.2.0"
end
end
appraise "rails_6_0" do
gem "rails", "~> 6.0.0"
end
appraise "rails_6_1" do
gem "rails", "~> 6.1.0"
end
appraise "rails_edge" do
gem "rails", git: "https://github.com/rails/rails.git", branch: "main"
end

View File

@@ -1,11 +1,23 @@
= [UNRELEASED]
* 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
version 0.4 with threadsafety fix for use_us_formats and use_euro_formats
hot switching in a request.
= 4.0.2 [2016-01-07]
* Fix undefine_generated_methods ivar guard setting to false

View File

@@ -2,11 +2,11 @@ source 'http://rubygems.org'
gemspec
gem 'rails', '~> 5.0.0'
gem 'rails', '~> 6.1.0'
gem 'rspec'
gem 'rspec-rails', '~> 3.7'
gem 'sqlite3'
gem 'timecop'
gem 'byebug'
gem 'appraisal'
gem 'sqlite3'
gem 'nokogiri', '~> 1.8'

View File

@@ -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

353
README.md Normal file
View File

@@ -0,0 +1,353 @@
# ValidatesTimeliness [![Build Status](https://travis-ci.org/adzap/validates_timeliness.svg?branch=master)](https://travis-ci.org/adzap/validates_timeliness)
* 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 5.x, 6.x, and
ActiveModel.
If you a looking for the old version for Rails 4.x go here
[https://github.com/adzap/validates_timeliness/tree/4-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', '~> 5.0.0.beta1'
# Run bundler
$ bundle install
```
Then run
```sh
$ 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
```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_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
```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.
```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.
```
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
```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
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:
```yaml
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:
```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
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:
```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
[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:
```ruby
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:
```ruby
# 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.
```ruby
# 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
```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.
### 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:
```ruby
# 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:
```ruby
# 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:
```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).
## Maintainers
* [Adam Meehan](https://github.com/adzap)
## License
Copyright (c) 2008 Adam Meehan, released under the MIT license

View File

@@ -1,299 +0,0 @@
= ValidatesTimeliness {<img src="https://travis-ci.org/adzap/validates_timeliness.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/adzap/validates_timeliness]
* Source: http://github.com/adzap/validates_timeliness
* Issues: http://github.com/adzap/validates_timeliness/issues
== Description
Complete validation of dates, times and datetimes for Rails 5.0.x and ActiveModel.
If you a looking for the old version for Rails 4.x go here [https://github.com/adzap/validates_timeliness/tree/4-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}[http://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', '~> 5.0.0.alpha2'
# 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}[http://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}[http://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[http://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. <tt>lambda { Time.current }</tt>.
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 <tt>lambda { Date.today }</tt>. 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}[http://github.com/adzap/validates_timeliness/contributors].
== Maintainers
* {Adam Meehan}[http://github.com/adzap]
== License
Copyright (c) 2008 Adam Meehan, released under the MIT license

View File

@@ -19,10 +19,11 @@ end
desc 'Generate documentation for plugin.'
Rake::RDocTask.new(:rdoc) do |rdoc|
rdoc.main = 'README.md'
rdoc.rdoc_dir = 'rdoc'
rdoc.title = 'ValidatesTimeliness'
rdoc.options << '--line-numbers' << '--inline-source'
rdoc.rdoc_files.include('README')
rdoc.rdoc_files.include('README.md')
rdoc.rdoc_files.include('lib/**/*.rb')
end

View File

@@ -5,14 +5,10 @@ source "http://rubygems.org"
gem "rails", "~> 5.0.0"
gem "rspec"
gem "rspec-rails", "~> 3.7"
gem "sqlite3", "~> 1.3.6"
gem "timecop"
gem "byebug"
gem "appraisal"
gem "sqlite3"
gem "nokogiri", "~> 1.8"
group :active_record do
gem "sqlite3-ruby", require: "sqlite3"
end
gemspec path: "../"

View File

@@ -5,14 +5,10 @@ source "http://rubygems.org"
gem "rails", "~> 5.1.0"
gem "rspec"
gem "rspec-rails", "~> 3.7"
gem "sqlite3"
gem "timecop"
gem "byebug"
gem "appraisal"
gem "sqlite3"
gem "nokogiri", "~> 1.8"
group :active_record do
gem "sqlite3-ruby", require: "sqlite3"
end
gemspec path: "../"

View File

@@ -5,14 +5,10 @@ source "http://rubygems.org"
gem "rails", "~> 5.2.0"
gem "rspec"
gem "rspec-rails", "~> 3.7"
gem "sqlite3"
gem "timecop"
gem "byebug"
gem "appraisal"
gem "sqlite3"
gem "nokogiri", "~> 1.8"
group :active_record do
gem "sqlite3-ruby", require: "sqlite3"
end
gemspec path: "../"

View File

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

View File

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

View File

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

View File

@@ -36,8 +36,8 @@ module ValidatesTimeliness
# Shorthand time and date symbols for restrictions
self.restriction_shorthand_symbols = {
:now => lambda { Time.current },
:today => lambda { Date.current }
now: proc { Time.current },
today: proc { Date.current }
}
# Use the plugin date/time parser which is stricter and extensible

View File

@@ -43,7 +43,7 @@ module ValidatesTimeliness
values[POSITION.key(position.to_i)] = value.to_i
end
DateTimeValue.new(values)
DateTimeValue.new(**values)
end
end
end

View File

@@ -11,7 +11,7 @@ module ValidatesTimeliness
end
end
class ActiveRecord::Base
ActiveSupport.on_load(:active_record) do
include ValidatesTimeliness::AttributeMethods
include ValidatesTimeliness::ORM::ActiveRecord
end

View File

@@ -11,5 +11,13 @@ module ValidatesTimeliness
initializer "validates_timeliness.initialize_restriction_errors" do
ValidatesTimeliness.ignore_restriction_errors = !Rails.env.test?
end
initializer "validates_timeliness.initialize_timeliness_ambiguous_date_format", :after => :load_config_initializers do
if Timeliness.respond_to?(:ambiguous_date_format) # i.e. v0.4+
# Set default for each new thread if you have changed the default using
# the format switching methods.
Timeliness.configuration.ambiguous_date_format = Timeliness::Definitions.current_date_format
end
end
end
end

View File

@@ -86,7 +86,7 @@ module ValidatesTimeliness
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)
record.errors.add(attr_name, message, **message_options)
end
def format_error_value(value)

View File

@@ -1,3 +1,3 @@
module ValidatesTimeliness
VERSION = '5.0.0.alpha3'
VERSION = '5.0.0.beta2'
end

View File

@@ -10,6 +10,8 @@ require 'timecop'
require 'validates_timeliness'
require 'validates_timeliness/orm/active_model'
require 'rails/railtie'
require 'support/test_model'
require 'support/model_helpers'
require 'support/config_helper'

View File

@@ -17,8 +17,7 @@ module ModelHelpers
def with_each_person_value(attr_name, values)
record = Person.new
values = [values] unless values.is_a?(Array)
values.each do |value|
Array.wrap(values).each do |value|
record.send("#{attr_name}=", value)
yield record, value
end

View File

@@ -15,11 +15,11 @@ module TestModel
self.model_attributes[name] = type
end
def define_method_attribute=(attr_name)
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)
def define_method_attribute(attr_name, owner: nil)
generated_attribute_methods.module_eval("def #{attr_name}; @attributes['#{attr_name}']; end", __FILE__, __LINE__)
end

View File

@@ -0,0 +1,22 @@
require 'validates_timeliness/railtie'
RSpec.describe ValidatesTimeliness::Railtie do
context "intializers" do
context "validates_timeliness.initialize_timeliness_ambiguous_date_format" do
it 'should set the timeliness default ambiguous date format from the current format' do
expect(Timeliness.configuration.ambiguous_date_format).to eq :us
ValidatesTimeliness.parser.use_euro_formats
initializer("validates_timeliness.initialize_timeliness_ambiguous_date_format").run
expect(Timeliness.configuration.ambiguous_date_format).to eq :euro
end
end if Timeliness.respond_to?(:ambiguous_date_format)
def initializer(name)
ValidatesTimeliness::Railtie.initializers.find { |i|
i.name == name
} || raise("Initializer #{name} not found")
end
end
end

View File

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
s.require_paths = ["lib"]
s.files = `git ls-files`.split("\n") - %w{ .gitignore .rspec Gemfile Gemfile.lock autotest/discover.rb Appraisals Travis.yml } - Dir['gemsfiles/*']
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.extra_rdoc_files = ["README.rdoc", "CHANGELOG.rdoc", "LICENSE"]
s.extra_rdoc_files = ["README.md", "CHANGELOG.rdoc", "LICENSE"]
s.add_runtime_dependency(%q<timeliness>, ["~> 0.3.8"])
s.add_runtime_dependency(%q<timeliness>, [">= 0.3.10", "< 1"])
end