ditkrg/validates_timeliness
4
0
Fork 0
mirror of https://github.com/ditkrg/validates_timeliness.git synced 2026-01-23 06:16:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

more options in readme and fixes

Browse Source
This commit is contained in:
Adam Meehan 2010-09-17 14:10:33 +10:00
parent fa2736feb3
commit a78700d192
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.rdoc
View File

@ -51,7 +51,7 @@ This creates configuration initializer and locale files. In the initializer, you
end end
By default the plugin extends ActiveRecord if present. Currently ActiveRecord is the only ORM included for extension. If you wish to extend By default the plugin extends ActiveRecord if present. Currently ActiveRecord is the only ORM included for extension. If you wish to extend
another ORM then look at the wiki for more information[http://github.com/adzap/validates_timeliness/wiki/ORM-Support]. another ORM then look at the {wiki page}[http://github.com/adzap/validates_timeliness/wiki/ORM-Support] for more information.
To extend other ORMs is pretty straight forward. It's matter of hooking into a couple of methods, being the attribute method generation and To extend other ORMs is pretty straight forward. It's matter of hooking into a couple of methods, being the attribute method generation and
timezone handling of validated attributes. However, the plugin must support the ActiveModel validations system. If you extend an ORM timezone handling of validated attributes. However, the plugin must support the ActiveModel validations system. If you extend an ORM
@ -98,12 +98,16 @@ Regular validation options:
:if - Execute validation when :if evaluates true :if - Execute validation when :if evaluates true
:unless - Execute validation when :unless evaluates false :unless - Execute validation when :unless evaluates false
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: The temporal restrictions can take 4 different value types:
* String value
* Date, Time, or DateTime object value * Date, Time, or DateTime object value
* Proc or lambda object which may take an optional parameter, being the record object * Proc or lambda object which may take an optional parameter, being the record object
* A symbol matching a method name in the model * A symbol matching a method name in the model
* String value
When an attribute value is compared to temporal restrictions, they are compared as 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 the same type as the validation method type. So using validates_date means all
@ -157,7 +161,7 @@ By default the parser is switched off. To switch it on:
# in the setup block # in the setup block
config.use_plugin_parser = true config.use_plugin_parser = true
See the wiki:http://github.com/adzap/validates_timeliness/wiki/Plugin-Parser for all the details about the parser. See the wiki[http://github.com/adzap/validates_timeliness/wiki/Plugin-Parser] for all the details about the parser.
=== Restriction Option Shorthand === Restriction Option Shorthand