validation_scopes 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/CHANGELOG

@@ -0,0 +1,11 @@
+== 0.3.0 2009-01-04
+
+* Fixed problem with DelegateClass not picking up method definitions that come after the validation_scope block.
+
+== 0.2.0 2009-01-04
+
+* Added basic unit tests using in-memory sqlite3
+
+== 0.1.0 2009-01-03
+
+* Initial release.  Only tested within an app.  Probably has lots of bugs.  Test suite forthcoming.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Gabe da Silveira
+
+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,43 @@
+# Validation Scopes
+
+This gem adds a simple class method `validation_scope` to `ActiveRecord::Base`.  Inside the block you can define validations that don't apply to the life-cycle of the object (ie. they aren't implicitly checked when the object is saved).
+
+    class Film < ActiveRecord::Base
+      validation_scope :warnings do |s|
+        s.validates_presence_of :title
+      end
+    end
+
+The generated scope produces 3 helper methods based on the symbol passed to the validation_scope method.  Continuing the previous example:
+
+    film.warnings      # analagous to film.errors
+    => #<ActiveRecord::Errors>
+
+    film.no_warnings?  # analagous to film.valid?
+    => true
+
+    film.has_warnings?  # analagous to film.invalid?
+    => false
+
+All standard `ActiveRecord::Validations` should work.
+
+
+## Caveats
+
+Due to the use of a proxy DelegateClass to store each additional set of validations, and some heavy meta-programming to tie it all together with a clean API, there are likely to be some unexpected and confusing edge cases.  Please let me know if you discover anything wonky.  I believe the opacity of the solution is worth the convenience it provides in exposing the entirety of the Validations API.
+
+### Don't use private methods
+
+Because the any validation method supplied as a symbol (eg. `validate :verify_something`) is actually running in the context of a delegate class, private methods won't work as they would in standard validations.
+
+
+## Implementation
+
+The implementation of this gem is meta-programming heavy and very dependent on the internal structure of ActiveRecord as of Rails 2.3.5.  The goal was to be able to utilize the entire functionality of ActiveRecord validations with a minimum of code.  The resulting code is a bit more magic than I would have liked, but it seems to be working for me so far.  I plan on forward porting to Rails 3 and maybe it will be nicer.
+
+The core of the implemention is a dynamically created proxy_class that has ActiveRecord::Validations included in order to isolate its own copy of @errors.  The proxy class is a DelegateClass which gets initialized to the base ActiveRecord object so that validations can use any of the methods of the base object.  Although the use of DelegateClass raises a few issues, it seemed like the cleanest way to do the integration so that all of the ActiveRecord::Validations concerns just work without too much regard to the specifics of the method implementations.
+
+
+## Copyright
+
+Copyright (c) 2010 Gabe da Silveira. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "validation_scopes"
+    gem.summary = %Q{Create sets of validations independent of the life-cycle of an ActiveRecord object}
+    gem.description = %Q{Define additional sets of validations beyond the standard "errors" that is tied to the ActiveRecord life-cycle.  These additional sets can be defined with all the standard ActiveRecord::Validation macros, and the resulting collection is a standard ActiveRecord::Errors object.}
+    gem.email = "gabe@websaviour.com"
+    gem.homepage = "http://github.com/dasil003/validation_scopes"
+    gem.authors = ["Gabe da Silveira"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "validation_scopes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/validation_scopes.rb

@@ -0,0 +1,59 @@
+require 'delegate'
+require 'active_record'
+
+module ValidationScopes
+  def self.included(base) # :nodoc:
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def validation_scope(scope)
+      base_class = self
+      deferred_proxy_class_declaration = Proc.new do
+        proxy_class = Class.new(DelegateClass(base_class)) do
+          include ActiveRecord::Validations
+
+          def initialize(record)
+            @base_record = record
+            super(record)
+          end
+
+          # Hack since DelegateClass doesn't seem to be making AR::Base class methods available.
+          def errors
+            @errors ||= ActiveRecord::Errors.new(@base_record)
+          end
+        end
+
+        yield proxy_class
+
+        proxy_class
+      end
+
+      define_method(scope) do
+        send("validation_scope_proxy_for_#{scope}").errors
+      end
+
+      define_method("no_#{scope}?") do
+        send("validation_scope_proxy_for_#{scope}").valid?
+      end
+
+      define_method("has_#{scope}?") do
+        send("validation_scope_proxy_for_#{scope}").invalid?
+      end
+
+      define_method("init_validation_scope_for_#{scope}") do
+        unless instance_variable_defined?("@#{scope}")
+          klass = deferred_proxy_class_declaration.call
+          instance_variable_set("@#{scope}", klass.new(self))
+        end
+      end
+
+      define_method("validation_scope_proxy_for_#{scope}") do
+        send "init_validation_scope_for_#{scope}"
+        instance_variable_get("@#{scope}")
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ValidationScopes)

data/test/db/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define do
+  create_table "users" do |t|
+    t.column "name",       :string
+    t.column "email",      :string
+    t.column "age",        :integer
+    t.column "bio",        :text
+    t.column "sponsor_id", :integer
+  end
+end

data/test/fixtures/users.yml

@@ -0,0 +1,13 @@
+one:
+  id: 1
+  name: Gabe da Silveira
+  email: gabe@websaviour.com
+  age: 31
+  bio: Technical web creative
+sponsored:
+  id: 2
+  name: Sven Pulpello
+  email: sven@funk.com
+  age: 3
+  bio: Alter-ego extraordinaire
+  sponsor_id: 1

data/test/helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'validation_scopes'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => ":memory:"
+)
+
+require 'db/schema.rb'
+
+Dir['test/models/*.rb'].each { |f| require f }
+
+require 'active_record/fixtures'
+Fixtures.create_fixtures('test/fixtures/', ActiveRecord::Base.connection.tables)

data/test/models/user.rb

@@ -0,0 +1,25 @@
+class User < ActiveRecord::Base
+  belongs_to :sponsor, :class_name => 'User'
+
+  validates_presence_of :name
+
+  validation_scope :warnings do |s|
+    s.validates_presence_of  :email
+    s.validates_format_of    :email, :with => %r{\A.+@.+\Z}
+    s.validates_inclusion_of :age, :in => 0..99
+    s.validate do |r|
+      if r.sponsor_id.present? && r.sponsor.nil?
+        r.warnings.add(:sponsor_id, "Sponsor ID was defined but record not present")
+      end
+    end
+  end
+
+  validation_scope :alerts do |s|
+    s.validate :age_under_100
+    s.validate { |r| r.alerts.add(:email, "We have a hotmail user.") if r.email =~ %r{@hotmail\.com\Z} }
+  end
+
+  def age_under_100
+    alerts.add_to_base("We have a centenarian on our hands") if age && age >= 100
+  end
+end

data/test/test_validation_scopes.rb

@@ -0,0 +1,59 @@
+require 'helper'
+
+class TestValidationScopes < Test::Unit::TestCase
+  context "A model with warnings and alerts" do
+    setup do
+      @user = User.find(1)
+    end
+
+    should "have warnings defined" do
+      assert_nothing_raised { @user.warnings }
+    end
+
+    should "check for warnings and find none" do
+      assert ! @user.has_warnings?
+      assert @user.no_warnings?
+    end
+
+    should "raise warning if age set negative" do
+      @user.age = -1
+      assert @user.has_warnings?
+      assert @user.warnings.on(:age)
+    end
+
+    should "raise warning for inline validation" do
+      @user.sponsor_id = 12345
+      assert @user.has_warnings?
+      assert @user.warnings.on(:sponsor_id)
+    end
+
+    should "not add warning to main errors instance" do
+      @user.email = ''
+      assert @user.has_warnings?
+      assert @user.valid?
+      assert @user.errors.empty?
+    end
+
+    should "not add errors to the warnings instance" do
+      @user.name = ''
+      assert @user.invalid?
+      assert @user.warnings.empty?
+    end
+
+    context "validating alerts with a private method" do
+      setup do
+        @user.age = 100
+        @user.email = "zappa@hotmail.com"
+      end
+
+      should "set alerts but not errors" do
+        assert @user.has_alerts?, "no alerts raised"
+        assert @user.alerts.on(:base), "centenarian alert not raised"
+        assert @user.alerts.on(:email), "hotmail alert not raised"
+        assert @user.valid?, "user not valid"
+        assert @user.errors.empty?, "user errors not empty"
+      end
+    end
+  end
+
+end

data/validation_scopes.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{validation_scopes}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gabe da Silveira"]
+  s.date = %q{2010-01-04}
+  s.description = %q{Define additional sets of validations beyond the standard "errors" that is tied to the ActiveRecord life-cycle.  These additional sets can be defined with all the standard ActiveRecord::Validation macros, and the resulting collection is a standard ActiveRecord::Errors object.}
+  s.email = %q{gabe@websaviour.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/validation_scopes.rb",
+     "test/db/schema.rb",
+     "test/fixtures/users.yml",
+     "test/helper.rb",
+     "test/models/user.rb",
+     "test/test_validation_scopes.rb",
+     "validation_scopes.gemspec"
+  ]
+  s.homepage = %q{http://github.com/dasil003/validation_scopes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Create sets of validations independent of the life-cycle of an ActiveRecord object}
+  s.test_files = [
+    "test/db/schema.rb",
+     "test/helper.rb",
+     "test/models/user.rb",
+     "test/test_validation_scopes.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: validation_scopes
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Gabe da Silveira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Define additional sets of validations beyond the standard "errors" that is tied to the ActiveRecord life-cycle.  These additional sets can be defined with all the standard ActiveRecord::Validation macros, and the resulting collection is a standard ActiveRecord::Errors object.
+email: gabe@websaviour.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- CHANGELOG
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/validation_scopes.rb
+- test/db/schema.rb
+- test/fixtures/users.yml
+- test/helper.rb
+- test/models/user.rb
+- test/test_validation_scopes.rb
+- validation_scopes.gemspec
+has_rdoc: true
+homepage: http://github.com/dasil003/validation_scopes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Create sets of validations independent of the life-cycle of an ActiveRecord object
+test_files: 
+- test/db/schema.rb
+- test/helper.rb
+- test/models/user.rb
+- test/test_validation_scopes.rb