public
Fork of cainlevy/semantic-attributes
Description: object-oriented activerecord validations and machine/human formatting
Homepage:
Clone URL: git://github.com/edwinmoss/semantic-attributes.git
Edwin Moss (author)
Fri Aug 07 20:09:59 -0700 2009
commit  b8fd861d178c7d81e73b3b291b2945e4d48de745
tree    4ae27ca4e9b045800d4206056d82cefd838ae999
parent  5e002297868a65f360b6e1d4456f6e975dc947ee
name age message
file .gitignore Thu May 15 20:47:06 -0700 2008 updating README [cainlevy]
file README Tue Oct 07 18:12:00 -0700 2008 condensing predicates into a gist for easy refe... [cainlevy]
file Rakefile Tue Oct 07 18:12:00 -0700 2008 condensing predicates into a gist for easy refe... [cainlevy]
file gist.rdoc Fri Feb 06 20:11:43 -0800 2009 making the Time predicate useful via a :distanc... [cainlevy]
file init.rb Loading commit data...
directory lib/
directory test/
README
SemanticAttributes
==================
-by Lance Ivy, 2007

http://github.com/cainlevy/semantic-attributes

http://code.google.com/p/semanticattributes/

==Summary

A validation library that allows introspection (User.name_is_required?) and supports database normalization (aka "form 
input cleaning").

==Philosophy

The method-chained validation routine built into ActiveRecord must die! It's time for an object-oriented approach to 
attribute validations. The Semantic Attributes plugin provides this approach by letting you attach predicates to your 
attributes with a tasty DSL. These predicates package up some really sweet behavior, where validations are really only 
the beginning. I've also discovered that it can be really useful to use these predicates to convert between human and 
machine formats: for example, with the phone number predicate you can let your users enter phone numbers with whatever 
formatting they want, always save the values to the database as numeric strings, and then present the values back to the 
user with standard formatting.

I've also found other nifty uses for object-oriented predicates that package up validation. For example, it becomes easy 
to run a quick validation check on a field with a sample value and report true/false. This is exactly what the 
<tt>expected_error_for(:field, value)</tt> method does, and it lets you build a validation routine that listens to form 
data as it's being typed and report problems without duplicating your validation code client-side. In a similar vein, 
the <tt>_valid?</tt> attribute suffix lets you do single-attribute validation on a record anytime you want.

==Example

  class User < ActiveRecord::Base
    email_is_an_email
    home_page_is_a_url :domains => ['com', 'net', 'org'], :allow_ip_address => false
    mobile_is_a_phone_number
  end

Now imagine a sample script/console session:

  >> User.name_is_required?
  => true
  >> User.mobile_is_required?
  => false

Ok, we have a DSL for introspection. What if we want to retrieve configuration details?

  >> User.semantic_attributes[:home_page].get(:url).domains
  => ['com', 'net', 'org']

Let's create a user and play around with some instance methods:

  >> user = User.new
  >> user.mobile = '222 333.4444'
  >> user.mobile_valid?
  => true
  >> user.mobile
  => '+12223334444'
  >> user.mobile_for_human
  => '(222) 333-4444'

==See Also
* gist.rdoc
* Predicates
* ActiveRecord::Predicates::ClassMethods (see #method_missing)
* ActiveRecord::AttributeFormats