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

a little README cleanup

Browse Source
This commit is contained in:
Adam Meehan 2008-11-23 16:58:48 +11:00
parent a425555de6
commit 6a0cece4d7
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README
View File

@ -27,12 +27,8 @@ think should be a valid date or time string.
== INSTALLATION: == INSTALLATION:
Rails 2.1
./script/plugin git://github.com/adzap/validates_timeliness ./script/plugin git://github.com/adzap/validates_timeliness
Rails 2.0
# TODO: best practice for git with Rails 2.0?
== USAGE: == USAGE:
@ -84,8 +80,8 @@ The temporal options can take 4 different value types:
* A symbol matching the method name in the model * A symbol matching the method name in the model
When an attribute value is compared to temporal options, they are compared as When an attribute value is compared to temporal options, they are compared as
the same type as the validation method type. So validates_date means all values the same type as the validation method type. So using validates_date means all
are compared as dates. values are compared as dates.
== EXAMPLES: == EXAMPLES:
@ -93,8 +89,8 @@ are compared as dates.
:before_message => "must be at least 18 years old" :before_message => "must be at least 18 years old"
validates_time :breakfast_time, :on_or_after => '6:00am', validates_time :breakfast_time, :on_or_after => '6:00am',
:on_or_after_message => 'must be after opening time',
:before => :second_breakfast_time, :before => :second_breakfast_time,
:on_or_after_message => 'must after opening time',
:allow_nil => true :allow_nil => true
validates_datetime :appointment_date, :before => Proc.new { 1.week.from_now } validates_datetime :appointment_date, :before => Proc.new { 1.week.from_now }
@ -108,7 +104,8 @@ removed without hacking the plugin at all.
Below are the default formats. If you think they are easy to read then you will Below are the default formats. If you think they are easy to read then you will
be happy to know that is exactly the format you can use to define your own if be happy to know that is exactly the format you can use to define your own if
you want. No regular expressions or duck punching (monkey patching) the plugin. you want. No complex regular expressions or duck punching (monkey patching) the
plugin is needed.
Time formats: Time formats:
hh:nn:ss hh:nn:ss
@ -200,14 +197,14 @@ Now '01/02/2000' will be parsed as 1st February 2000, instead of 2nd January 200
=== CUSTOMISING FORMATS: === CUSTOMISING FORMATS:
I hear you say "Thats greats but I don't want X format to be valid". Well to I hear you say "Thats greats but I don't want X format to be valid". Well to
remove a format stick this in an initializer file or environment.rb remove a format stick this in an initializer file
ValidatesTimeliness::Formats.remove_formats(:date, 'm\d\yy') ValidatesTimeliness::Formats.remove_formats(:date, 'm\d\yy')
Done! That format is no longer considered valid. Easy! Done! That format is no longer considered valid. Easy!
Ok, now I hear you say "Well I have format that I want to use but you don't have it". Ok, now I hear you say "Well I have format that I want to use but you don't have it".
Ahh, then add it yourself. Again stick this in an initializer file or environment.rb. Ahh, then add it yourself. Again stick this in an initializer file
ValidatesTimeliness::Formats.add_formats(:time, "d o'clock") ValidatesTimeliness::Formats.add_formats(:time, "d o'clock")
@ -217,7 +214,7 @@ You can embed regular expressions in the format but no gurantees that it will
remain intact. If you avoid the use of any token characters and regexp dots or remain intact. If you avoid the use of any token characters and regexp dots or
backslashes as special characters in the regexp, it may well work as expected. backslashes as special characters in the regexp, it may well work as expected.
For special characters use POSIX character classes for safety. See the ISO 8601 For special characters use POSIX character classes for safety. See the ISO 8601
datetime for an example of of an embedded regular expression. datetime for an example of an embedded regular expression.
Because formats are evaluated in order, adding a format which may be ambiguous Because formats are evaluated in order, adding a format which may be ambiguous
with an existing format, will mean your format is ignored. If you need to make with an existing format, will mean your format is ignored. If you need to make