can_has_validations 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.md

@@ -0,0 +1,146 @@
+# CanHasValidations #
+
+`can_has_validations` provides several additional validations for Rails and
+ActiveModel.
+
+Validations provided:
+
+* Email
+* Grandparent
+* Ordering
+* URL
+* Write Once
+
+All validators use the newer Rails 3 syntax:
+
+    validates :some_attribute, :email=>true
+
+(That is, there's not a validates_email_of :some_attribute helper.)
+
+
+## Email ##
+
+Ensures an attribute is generally formatted as an email. It uses a basic regex
+that's designed to match something that looks like an email. It allows for any
+TLD, so as to not fail as ICANN continues to add TLDs.
+
+    validates :user_email, :email=>true
+
+
+## Grandparent ##
+
+Ensures two (or more) associations share a common parent value. 
+
+`:allow_nil=>true` will not only allow the attribute/association to be nil, but
+also any of the `:scope` values.
+
+Consider a model tree like this:
+
+    class User < ActiveRecord::Base
+      has_many :addresses
+      has_many :phones
+    end
+    
+    class Address < ActiveRecord::Base
+      belongs_to :user
+      has_many :orders
+    end
+    
+    class Phone < ActiveRecord::Base
+      belongs_to :user
+      has_many :orders
+    end
+    
+    class Order < ActiveRecord::Base
+      belongs_to :address
+      belongs_to :phone
+      
+      validates :phone, :grandparent=>{:scope=>:address, :parent=>:user}
+    end
+
+For any `Order`, this ensures that both `:address` and `:phone` belong to the same
+`:user`, even though `Order` doesn't directly have an association to `:user`.
+
+Basically it starts with the attribute being validated (`:phone` in this case)
+and the scoped attributes (just `:address` in this case, but you can supply an
+array if needed, eg: `:scope=>[:billing_address, :mailing_address]` ). 
+
+Then, it looks for the attribute that is the common parent (`:user` in the above
+example). So, it's looking for `phone.user` and `address.user`. 
+
+Finally, it's comparing those values to make sure they match. In this case, if
+`phone.user` and `address.user` match, then the validation passes. If the phone and
+address belong to different users, then the validation fails.
+
+When the `:parent` value is an association, you can use the association (`:user`)
+or the database foreign key (`:user_id`). You can also use any other field. The
+test is merely that they match, not that they are associations.
+
+
+## Ordering ##
+
+Ensures two attribute values maintain a relative order to one another. This is
+often useful when two date or range values. Validations can be written using
+either `:before` or `:after` to make them readable.
+
+Always skips over nil values; use `:presence` to validate those.
+
+    # Short versions:
+    validates :start_at, :before => :finish_at
+    validates :finish_at, :after => [:start_at, :alt_start_at]
+    validates :start_at, :presence => true, :before => :finish_at
+    
+    # Long versions, if you need to add extra validation options:
+    validates :start_at, :before => {:value_of => :finish_at, :message=>"..." }
+    validates :finish_at, :after => {:values_of => [:start_at, :alt_start_at], :if=>... }
+
+
+## URL ##
+
+Ensure an attribute is generally formatted as a URL. If `addressable/uri` is
+already loaded, it will be used to parse IDN's.
+
+    validates :website, :url=>true
+
+    # With IDN parsing:
+    require 'addressable/uri'
+    validates :website, :url=>true
+
+
+## Write Once ##
+
+Ensure that once a value is written, it becomes readonly. There are two uses
+for this. 
+
+The first is as an equivalent to `attr_readonly :user_id` except that it also
+produces a validation error instead of silently ignoring the change as
+`attr_readonly` does.
+
+    validates :user_id, :presence=>true, :write_once=>true
+
+The second use is to allow an attribute to be nil when the record is first
+created and allow it to be set once at some arbitrary point in the future, but
+once set, still make it immutable. A WORM (write once, read many) attribute of
+sorts.
+
+    validates :user_id, :write_once=>true
+
+
+## Error messages
+
+Validation error messages are localized and can be added to your locale files.
+Default messages are as follows:
+
+    en:
+      errors:
+        messages:
+          invalid_email: "is an invalid email"
+          invalid_url: "is an invalid URL"
+          unchangeable: "cannot be changed"
+          before: "must be before %{attribute2}"
+          after: "must be after %{attribute2}"
+
+
+## Compatibility ##
+
+Tested with Ruby 1.9 and ActiveSupport and ActiveModel 3.2.8+.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CanHasValidations'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/can_has_validations/locale/en.yml

@@ -0,0 +1,9 @@
+en:
+  errors:
+    messages:
+      invalid_email: "is an invalid email"
+      invalid_url: "is an invalid URL"
+      unchangeable: "cannot be changed"
+      before: "must be before %{attribute2}"
+      after: "must be after %{attribute2}"
+      

data/lib/can_has_validations/validators/email_validator.rb

@@ -0,0 +1,12 @@
+# Ensure an attribute is generally formatted as an email.
+# eg: validates :user_email, :email=>true
+
+module ActiveModel::Validations
+  class EmailValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      unless value =~ /\A([a-z0-9._+-]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i
+        record.errors.add(attribute, :invalid_email, options)
+      end
+    end
+  end
+end

data/lib/can_has_validations/validators/grandparent_validator.rb

@@ -0,0 +1,23 @@
+# Ensure two (or more) associations share a common parent
+#   :allow_nil will not only allow the attribute/association to be nil, but
+#     also any of the :scope's.
+# eg: validates :user, :grandparent=>{:scope=>:org, :parent=>:realm}
+#     validates :user, :grandparent=>{:scope=>[:phone, :address], :parent=>:account_id}
+
+module ActiveModel::Validations
+  class GrandparentValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, association)
+      all_match = Array(options[:scope]).all? do |scope|
+        cousin = record.send(scope)
+        if cousin.nil?
+          options[:allow_nil]
+        else
+          association.send(options[:parent]) == cousin.send(options[:parent])
+        end
+      end
+      unless all_match
+        record.errors.add(attribute, :invalid, options.except(:allow_nil, :parent, :scope))
+      end
+    end
+  end
+end

data/lib/can_has_validations/validators/ordering_validator.rb

@@ -0,0 +1,36 @@
+# Attribute ordering
+#   Ensures one value is greater or lesser than another (set of) value(s).
+#   Always skips over nil values; use :presence to validate those.
+# eg: validates :start_at, :before=>:finish_at
+#     validates :start_at, :before=>{:value_of=>:finish_at, :if=>... }
+#     validates :finish_at, :after => [:start_at, :alt_start_at]
+#     validates :finish_at, :after=>{:values_of => [:start_at, :alt_start_at], :if=>... }
+
+module ActiveModel::Validations
+  class BeforeValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      compare_to = Array(options[:value_of] || options[:values_of] || options[:in] || options[:with])
+      compare_to.each do |attr_name|
+        greater = record.send attr_name
+        next unless value && greater
+        unless value < greater
+          attr2 = record.class.human_attribute_name attr_name
+          record.errors.add(attribute, :before, options.except(:before).merge!(:attribute2=>attr2))
+        end
+      end
+    end
+  end
+  class AfterValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      compare_to = Array(options[:value_of] || options[:values_of] || options[:in] || options[:with])
+      compare_to.each do |attr_name|
+        lesser = record.send attr_name
+        next unless value && lesser
+        unless value > lesser
+          attr2 = record.class.human_attribute_name attr_name
+          record.errors.add(attribute, :after, options.except(:after).merge!(:attribute2=>attr2))
+        end
+      end
+    end
+  end
+end

data/lib/can_has_validations/validators/url_validator.rb

@@ -0,0 +1,18 @@
+# Ensure an attribute is generally formatted as a URL. If addressable/uri is
+#   already loaded, will use it to parse IDN's.
+# eg: validates :website, :url=>true
+
+module ActiveModel::Validations
+  class UrlValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      if defined?(Addressable::URI)
+        u = Addressable::URI.parse(value) rescue nil
+      else
+        u = URI.parse(value) rescue nil
+      end
+      if !u || u.relative? || %w(http https).exclude?(u.scheme)
+        record.errors.add(attribute, :invalid_url, options)
+      end
+    end
+  end
+end

data/lib/can_has_validations/validators/write_once_validator.rb

@@ -0,0 +1,15 @@
+# write-once, read-many
+#   Allows a value to be set to a non-nil value once, and then makes it immutable.
+#   Combine with :presence=>true to accomplish the same thing as attr_readonly,
+#   except with error messages (instead of silently refusing to save the change).
+# eg: validates :user_id, :write_once=>true
+
+module ActiveModel::Validations
+  class WriteOnceValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      if record.persisted? && record.send("#{attribute}_changed?") && !record.send("#{attribute}_was").nil?
+        record.errors.add(attribute, :unchangeable, options)
+      end
+    end
+  end
+end

data/lib/can_has_validations/version.rb

@@ -0,0 +1,3 @@
+module CanHasValidations
+  VERSION = "0.2.0"
+end

data/lib/can_has_validations.rb

@@ -0,0 +1,7 @@
+%w(email grandparent ordering url write_once).each do |validator|
+  require "can_has_validations/validators/#{validator}_validator"
+end
+
+
+require 'active_support/i18n'
+I18n.load_path << File.dirname(__FILE__) + '/can_has_validations/locale/en.yml'

data/lib/tasks/can_has_validations_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :can_has_validations do
+#   # Task goes here
+# end

data/test/can_has_validations_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CanHasValidationsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, CanHasValidations
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>