validation_scopes 0.3.0 → 0.3.1

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.3.1 2011-02-24
+
+* Added Rails3 compatibility
+
 == 0.3.0 2009-01-04
 
 * Fixed problem with DelegateClass not picking up method definitions that come after the validation_scope block.
@@ -8,4 +12,4 @@
 
 == 0.1.0 2009-01-03
 
-* Initial release.  Only tested within an app.  Probably has lots of bugs.  Test suite forthcoming.
+* Initial release.  Only tested within an app.  Probably has lots of bugs.  Test suite forthcoming.

data/README.md

@@ -1,43 +1,108 @@
 # 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).
+This gem adds a simple class method `validation_scope` to ActiveRecord.  This generates a new collection of
+`ActiveRecord::Errors` that can be manipulated independently of the standard `errors`, `valid?` and `save` methods.  The
+full power of ActiveRecord validations are preserved in these distinct error collections, including all the macros.
+
+For example, in addition to standard errors that prevent an object from being saved to the database, you may want
+a second collection of warnings that you display to the user or otherwise shape the control flow:
 
     class Film < ActiveRecord::Base
+      validates_presence_of :title # Standard errors
+
       validation_scope :warnings do |s|
-        s.validates_presence_of :title
+        s.validate :ensure_title_is_capitalized
+        s.validate { |r| r.warnings.add_to_base("Inline warning") }
+        s.validates_presence_of…
+        s.validates_inclusion_of…
+        s.validates_each…
+        s.validates_on_create…
+      end
+
+      def ensure_title_is_capitalized
+        warnings.add(:title, "should be capitalized") unless title =~ %r{\A[A-Z]}
       end
     end
 
-The generated scope produces 3 helper methods based on the symbol passed to the validation_scope method.  Continuing the previous example:
+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
+    film = Film.new(:title => 'lowercase title')
+    film.valid?
+    => true
+
+    film.no_warnings?   # analagous to valid?
+    => false
+
+    film.has_warnings?  # analagous to invalid?
+    => true
+
+    film.warnings       # analagous to film.errors
     => #<ActiveRecord::Errors>
 
-    film.no_warnings?  # analagous to film.valid?
+    film.warnings.full_messages
+    => ["Title should be capitalized", "Inline warning"]
+
+    film.errors.full_messages
+    => []
+
+    film.save
     => true
 
-    film.has_warnings?  # analagous to film.invalid?
-    => false
+One rough edge at the moment is when you want to use the builtin `error_messages_for` helper in your views.  That helper
+does not accept an `ActiveRecord::Errors` object directly.  Instead you need to pass it the proxy object that
+`ValidationScopes` creates to encapsulate the generated error set:
 
-All standard `ActiveRecord::Validations` should work.
+    error_messages_for :object => film.validation_scope_proxy_for_warnings
+
+## Compatibility
+
+Should work for Ruby 1.8 and 1.9, as well as Rails 2.x and 3.x; Battle-tested in the formers.
+
+## Installation
+
+The usual:
+
+    gem install validation_scopes
+
+In your Gemfile:
+
+    gem 'validation_scopes'
+
+Or old-school Rails-style, in your environment.rb:
+
+    config.gem 'validation_scopes'
+
+Outside of Rails:
+
+    require 'validation_scopes'
 
 
 ## 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.
+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 weird 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.
+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.
+I had a lot of fun writing this gem even though the result isn't exactly a shining example elegant code.  An [article
+about the design process](http://www.darwinweb.net/articles/80) is on my blog.
+
+
+## TODO
 
-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.
+* In Rails 3 validations are no longer coupled to ActiveRecord.  As part of of ActiveModel, validations can be included
+  in any object.  It shouldn't be too much work to make validation_scopes work with arbitrary models as well.
 
 
 ## Copyright
 
-Copyright (c) 2010 Gabe da Silveira. See LICENSE for details.
+Copyright (c) 2010,2011 Gabe da Silveira. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/validation_scopes.rb

@@ -11,7 +11,10 @@ module ValidationScopes
       base_class = self
       deferred_proxy_class_declaration = Proc.new do
         proxy_class = Class.new(DelegateClass(base_class)) do
-          include ActiveRecord::Validations
+          validations_module = defined?(ActiveModel) ? ActiveModel::Validations : ActiveRecord::Validations
+          errors_class = defined?(ActiveModel) ? ActiveModel::Errors : ActiveRecord::Errors
+
+          include validations_module
 
           def initialize(record)
             @base_record = record
@@ -19,8 +22,8 @@ module ValidationScopes
           end
 
           # Hack since DelegateClass doesn't seem to be making AR::Base class methods available.
-          def errors
-            @errors ||= ActiveRecord::Errors.new(@base_record)
+          define_method("errors") do
+            @errors ||= errors_class.new(@base_record)
           end
         end
 
@@ -56,4 +59,4 @@ module ValidationScopes
   end
 end
 
-ActiveRecord::Base.send(:include, ValidationScopes)
+ActiveRecord::Base.send(:include, ValidationScopes)

data/validation_scopes.gemspec

@@ -1,54 +1,52 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{validation_scopes}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   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.date = %q{2011-02-24}
   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"
+    "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"
+    "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.rubygems_version = %q{1.3.7}
   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"
+    "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
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<shoulda>, [">= 0"])
     else
       s.add_dependency(%q<shoulda>, [">= 0"])

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: validation_scopes
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Gabe da Silveira
@@ -9,19 +14,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-04 00:00:00 -08:00
+date: 2011-02-24 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 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: []
@@ -33,7 +41,6 @@ extra_rdoc_files:
 - README.md
 files: 
 - .document
-- .gitignore
 - CHANGELOG
 - LICENSE
 - README.md
@@ -51,26 +58,30 @@ homepage: http://github.com/dasil003/validation_scopes
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Create sets of validations independent of the life-cycle of an ActiveRecord object

data/.gitignore

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