jc-validates_timeliness 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bd9fd235f62881b5d9268a0557c312dea1e71da
+  data.tar.gz: 4acf1e727c71b48f63f8fe756f93a0fb0ee65763
+SHA512:
+  metadata.gz: 2999e43fbe2481299924f3c567aa4778f39688fc49d846138a60fa55535f33b667d6df2f02a24df739b9f9b9135a59bb6219547341bce6892babc411a5294f86
+  data.tar.gz: 8437ea8c718ec239d07a897b5355c27663b70c5625d70ac084d3917642ef169b8dd198cda1059ca887353c6a86d797332e3f29bcae657d2785aa3ab283777178

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 1.9.3
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - john+timeliness@carney.id.au
+    on_failure: change
+    on_success: never

data/CHANGELOG.rdoc

@@ -0,0 +1,183 @@
+= 3.0.14 [2012-08-23]
+* Fix for using validates :timeliness => {} form to correctly add attributes to timeliness validated attributes.
+
+= 3.0.13 [2012-08-21]
+* Fix ActiveRecord issues with using plugin parser by using old way of caching values.
+* Allow any ActiveRecord non-column attribute to be validated
+
+= 3.0.12 [2012-06-23]
+* Fix load order issue when relying on Railtie to load ActiveRecord extension
+
+= 3.0.11 [2012-04-01]
+* Change dependency on Timeliness version due to a broken release
+
+= 3.0.10 [2012-03-26]
+* Fix for ActiveRecord shim and validation with :allow_blank => true in AR 3.1+. Fixes issue#52.
+
+= 3.0.9 [2012-03-26]
+* ActiveRecord 3.1+ suport
+* Fixes for multiparameter extension with empty date values (thanks @mogox, @Sharagoz)
+
+= 3.0.8 [2011-12-24]
+* Remove deprecated InstanceMethods module when using AS::Concern (carlosantoniodasilva)
+* Update Mongoid shim for v2.3 compatability.
+
+= 3.0.7 [2011-09-21]
+* Fix ActiveRecord before_type_cast extension for non-dirty attributes.
+* Don't override AR before_type_cast for >= 3.1.0 which now has it's own implementation for date/time attributes.
+* Fix DateTimeSelect extension to convert params to integers (#45)
+* Add #change method to DateTimeSelect extension (@trusche, #45)
+* Cleanup Mongoid shim.
+
+= 3.0.6 [2011-05-09]
+* Fix for AR type conversion for date columns when using plugin parser.
+* Add timeliness_type_cast_code for ORM specific type casting after parsing.
+
+= 3.0.5 [2011-01-29]
+* Fix for Conversion#parse when given nil value (closes issue #34)
+
+= 3.0.4 [2011-01-22]
+* Fix :between option which was being ignored (ebeigarts)
+* Use class_attribute to remove deprecated class_inheritable_accessor
+* Namespace copied validator class to ActiveModel::Validations::Timeliness for :timeliness option
+
+= 3.0.3 [2010-12-11]
+* Fix validation of values which don't respond to to_date or to_time (renatoelias)
+
+= 3.0.2 [2010-12-04]
+* Fix AR multiparameter extension for Date columns
+* Update to Timeliness 0.3.2 for zone abbreviation and offset support
+
+= 3.0.1 [2010-11-02]
+* Generate timeliness write methods in an included module to allow overriding in model class (josevalim)
+
+= 3.0.0 [2010-10-18]
+* Rails 3 and ActiveModel compatibility
+* Uses ActiveModel::EachValidator as validator base class.
+* Configuration settings stored in ValidatesTimeliness module only. ValidatesTimeliness.setup block to configure.
+* Parser extracted to the Timeliness gem http://github.com/adzap/timeliness
+* Parser is disabled by default. See initializer for enabling it.
+* Removed RSpec matcher. Encouraged poor specs by copy-pasting from spec to model, or worse, the other way round.
+* Method override for parsing and before type cast values is on validated attributes only. Old version handled all date/datetime columns, validates or not. Too intrusive.
+* Add validation helpers to classes using extend_orms config setting. e.g. conf.extend_orms = [ :active_record ]
+* Changed :between option so it is split into :on_or_after and :on_or_before option values. The error message for either failing check will be used instead of a between error message.
+* Provides :timeliness option key for validates class method. Be sure to pass :type option as well e.g. :type => :date.
+* Allows validation methods to be called on record instances as per ActiveModel API.
+* Performs parsing (optional) and raw value caching (before_type_cast) on validated attributes only. It used to be all date, time and datetime attributes.
+
+= 2.3.1 [2010-03-19]
+* Fixed bug where custom attribute writer method for date/times were being overriden
+
+= 2.3.0 [2010-02-04]
+* Backwards incompatible change to :equal_to option. Fixed error message clash with :equal_to option which exists in Rails already. Option is now :is_at.
+* Fixed I18n support so it returns missing translation message instead of error
+* Fixed attribute method bug. Write method was bypassed when method was first generated and used Rails default parser.
+* Fixed date/time selects when using enable_datetime_select_extension! when some values empty
+* Fixed ISO8601 datetime format which is now split into two formats
+* Changed I18n error value format to fallback to global default if missing in locale
+* Refactored date/time select invalid value extension to use param values. Functionality will be extracted from plugin for v3.
+
+= 2.2.2 [2009-09-19]
+* Fixed dummy_time using make_time to respect timezone. Fixes 1.9.1 bug.
+
+= 2.2.1 [2009-09-12]
+* Fixed dummy date part for time types in Validator.type_cast_value
+* No more core extensions! Removed dummy_time methods.
+
+= 2.2.0 [2009-09-12]
+* Ruby 1.9 support!
+* Customise dummy date values for time types. See DUMMY DATE FOR TIME TYPES.
+* Fixed matcher conflict with Shoulda. Load plugin matcher manually now see matcher section in README
+* Fixed :ignore_usec when used with :with_time or :with_date
+* Some clean up and refactoring
+
+= 2.1.0 [2009-06-20]
+* Added ambiguous year threshold setting in Formats class to customize the threshold for 2 digit years (See README)
+* Fixed interpolation values in custom error message for Rails 2.2+
+* Fixed custom I18n local override of en locale
+* Dramatically simplified ActiveRecord monkey patching and hackery
+
+= 2.0.0 [2009-04-12]
+* Error value formats are now specified in the i18n locale file instead of updating plugin hash. See OTHER CUSTOMISATION section in README.
+* Date/time select helper extension is disabled by default. To enable see DISPLAY INVALID VALUES IN DATE HELPERS section in README to enable.
+* Added :format option to limit validation to a single format if desired
+* Matcher now supports :equal_to option
+* Formats.parse can take :include_offset option to include offset value from string in seconds, if string contains an offset. Offset not used in rest of plugin yet.
+* Refactored to remove as much plugin code from ActiveRecord as possible.
+
+= 1.1.7 [2009-03-26]
+* Minor change to multiparameter attributes which I had not properly implemented for chaining
+
+= 1.1.6 [2009-03-19]
+* Rail 2.3 support
+* Added :with_date and :with_time options. They allow an attribute to be combined with another attribute or value to make a datetime value for validation against the temporal restrictions
+* Added :equal_to option
+* Option key validation
+* Better behaviour with other plugins using alias_method_chain on read_attribute and define_attribute_methods
+* Added option to enable datetime_select extension for future use to optionally enable. Enabled by default until version 2.
+* Added :ignore_usec option for datetime restrictions to be compared without microsecond
+* some refactoring
+
+= 1.1.5 [2009-01-21]
+* Fixed regex for 'yy' format token which wasn't greedy enough for date formats ending with year when a datetime string parsed as date with a 4 digit year
+
+= 1.1.4 [2009-01-13]
+* Make months names respect i18n in Formats
+
+= 1.1.3 [2009-01-13]
+* Fixed bug where time and date attributes still being parsed on read using Rails default parser [reported by Brad (pvjq)]
+
+= 1.1.2 [2009-01-12]
+* Fixed bugs
+  * matcher failing for custom error message without interpolation keys using I18n
+  * validator custom error messages not being extracted
+
+= 1.1.1 [2009-01-03]
+* Fixed bug in matcher for options local variable
+
+= 1.1.0 [2009-01-01]
+* Added between option
+
+= 1.0.0 [2008-12-06]
+* Gemified!
+* Refactor of plugin into a Data Mapper style validator class which makes for a cleaner implementation and possible future Merb\Data Mapper support
+* Added Rails 2.2 i18n support. Plugin error messages can specified in locale files. See README.
+* ignore_datetime_restriction_errors setting has been moved from AR to ValidatesTimeliness::Validator.ignore_restriction_errors
+* date_time_error_value_formats setting has been moved from AR to ValidatesTimeliness::Validator.error_value_formats
+* Namespaced modules and specs
+* Clean up of specs
+* fixed a few bugs
+  * accessor methods not generating properly due method name stored as symbol in generated_attributes which fails on lookup
+  * force value assigned to time/datetime attributes to time objects
+
+= 0.1.0 [2008-12-06]
+* Tagged plugin as version 0.1.0
+
+= 2008-11-13
+* allow uppercase meridian to be valid [reported by Alex (http://alex.digns.com/)]
+
+= 2008-10-28
+* fixed bug when dirty attributes not reflecting change when attribute changed from time value to nil [reported by Brad (pvjq)]
+* fixes for Rails 2.2 compatibility. Will refactor in to Rails version specific branches in the future.
+
+= 2008-09-24
+* refactored attribute write method definitions
+
+= 2008-08-25
+* fixed bug for non-timezone write method not updating changed attributes hash [reported by Sylvestre Mergulhão]
+
+= 2008-08-22
+* fixed bug with attribute cache not clearing on write for date and time columns [reported by Sylvestre Mergulhão]
+* parse method returns Date object for date column assigned string as per normal Rails behaviour
+* parse method returns same object type when assigned Date or Time object as per normal Rails behaviour
+
+= 2008-08-07
+* modified matcher option value parsing to allow same value types as validation method
+* fixed matcher message
+
+= 2008-08-02
+* refactored validation
+* refactored matcher
+
+= 2008-07-30
+* removed setting values to nil when validation fails to preserve before_type_cast value

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2010 Adam Meehan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,301 @@
+= ValidatesTimeliness
+
+* Source:  http://github.com/johncarney/validates_timeliness
+* Issues:  http://github.com/johncarney/validates_timeliness/issues
+
+== Description
+
+Complete validation of dates, times and datetimes for Rails 3.x and ActiveModel.
+
+If you a looking for the old version for Rails 2.x go here[http://github.com/adzap/validates_timeliness/tree/v2.3].
+
+
+== 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
+
+* Supports all the Rubies (that any sane person would be using in production).
+
+
+== Installation
+
+  # in Gemfile
+  gem 'jc-validates_timeliness', '~> 3.1'
+
+  # 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, :mongoid).
+    config.extend_orms = [ :mongoid ]
+
+  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
+
+This is a fork of the original validates_timeliness gem by {Adam Meehan}[http://github.com/adzap].
+
+To see the generous people who have contributed code, take a look at the {contributors list}[http://github.com/johncarney/validates_timeliness/contributors].
+
+
+== Maintainers
+
+* {John Carney}[http://github.com/johncarney]
+
+
+== License
+
+Copyright (c) 2008 Adam Meehan, released under the MIT license