validation_scopes 0.4.1 → 0.5.1

data/CHANGELOG

@@ -1,3 +1,10 @@
+== Unreleased
+
+* Fix for memory leak described at http://siliconsenthil.in/blog/2013/01/19/validation-scopes-leaks-memory/
+* Cleaned up .gemspec and removed unnecessary files from distribution
+* Set up Gemfile for development
+* Simplified test suite to use pure minitest
+
 == 0.4.1 2012-04-15
 
 * Rails 3.1 and 3.2 compatibility

data/README.md

@@ -60,10 +60,20 @@ does not accept an `ActiveRecord::Errors` object directly.  Instead you need to
 
 ## Compatibility
 
-The current version should work for Rails 3 on Ruby 1.8 or 1.9; Battle-tested in the former.
+The current version should work for Rails >= 3.0 and Ruby >= 1.9.2.
+
+For Rails 3 and Ruby 1.8.x use version 0.4.x, however **beware there is a memory leak in this version** as described
+[here](http://siliconsenthil.in/blog/2013/01/19/validation-scopes-leaks-memory/)
 
 For Rails 2 see the 0.3.x version of the gem which is maintained on the [rails2
-branch](https://github.com/dasil003/validation_scopes/tree/rails2)
+branch](https://github.com/gtd/validation_scopes/tree/rails2)
+
+Why no Ruby 1.8.7 support?  Because fixing the memory leak was easy in Ruby 1.9 by removing the deferred proxy class
+definition, however this does not work in Ruby 1.8.7 because the ActiveRecord objects methods are not found.  The
+development of this was described in a [blog article about the design process](http://www.darwinweb.net/articles/80).
+I didn't take the time to figure out why this started working in Ruby 1.9.x (smells like something to do with
+`instance_eval`) but it does, and I have no inclination to fix issues in 1.8.x anymore.  If you happen to know why
+offhand though, I'd be glad to hear the reason.
 
 
 ## Installation
@@ -85,25 +95,12 @@ 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 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.
 
 
-## Implementation
-
-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
 
 * In Rails 3 validations are no longer coupled to ActiveRecord.  Although the current version of the gem uses
@@ -112,4 +109,4 @@ about the design process](http://www.darwinweb.net/articles/80) is on my blog.
 
 ## Copyright
 
-Copyright (c) 2010,2011 Gabe da Silveira. See LICENSE for details.
+Copyright (c) 2010-2013 Gabe da Silveira. See LICENSE for details.

data/lib/validation_scopes.rb

@@ -8,50 +8,38 @@ module ValidationScopes
 
   module ClassMethods
     def validation_scope(scope)
-      base_class = self
       @all_scopes ||= []
-      class << self
-        def all_scopes=(scope)
-          @all_scopes << scope
-        end
+      @all_scopes << scope
 
-        def all_scopes
-          @all_scopes
-        end
+      def self.all_scopes
+        @all_scopes
       end
-      self.all_scopes = scope
-      deferred_proxy_class_declaration = Proc.new do
-        proxy_class = Class.new(DelegateClass(base_class)) do
-          include ActiveModel::Validations
 
-          def initialize(record)
-            @base_record = record
-            super(record)
-          end
+      base_class = self
 
-          # Hack since DelegateClass doesn't seem to be making AR::Base class methods available.
-          define_method("errors") do
-            @errors ||= ActiveModel::Errors.new(@base_record)
-          end
+      proxy_class = Class.new(DelegateClass(base_class)) do
+        include ActiveModel::Validations
 
-          # Hacks to support dynamic_model helpers
-          def to_model
-            self
-          end
-
-          # Rails 3 default implementation of model_name blows up for anonymous classes
-          class << self; self; end.class_eval do
-            define_method(:model_name) do
-              base_class.model_name
-            end
-          end
+        def initialize(record)
+          @base_record = record
+          super(record)
         end
 
-        yield proxy_class
+        # Hacks to support dynamic_model helpers
+        def to_model
+          self
+        end
 
-        proxy_class
+        # Rails 3 default implementation of model_name blows up for anonymous classes
+        class << self; self; end.class_eval do
+          define_method(:model_name) do
+            base_class.model_name
+          end
+        end
       end
 
+      yield proxy_class
+
       define_method(scope) do
         send("validation_scope_proxy_for_#{scope}").errors
       end
@@ -66,8 +54,7 @@ module ValidationScopes
 
       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))
+          instance_variable_set("@#{scope}", proxy_class.new(self))
         end
       end
 

metadata

@@ -1,93 +1,102 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: validation_scopes
-version: !ruby/object:Gem::Version 
-  hash: 13
+version: !ruby/object:Gem::Version
+  version: 0.5.1
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
 platform: ruby
-authors: 
+authors:
 - Gabe da Silveira
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-15 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: shoulda
+date: 2013-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   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.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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: 
+extra_rdoc_files:
 - LICENSE
 - README.md
-files: 
-- .document
+files:
 - CHANGELOG
 - LICENSE
 - README.md
-- Rakefile
-- VERSION
 - lib/validation_scopes.rb
-- test/db/schema.rb
-- test/fixtures/books.yml
-- test/fixtures/users.yml
-- test/helper.rb
-- test/models/book.rb
-- test/models/user.rb
-- test/test_validation_scopes.rb
-- validation_scopes.gemspec
-homepage: http://github.com/dasil003/validation_scopes
+homepage: http://github.com/gtd/validation_scopes
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.22
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Create sets of validations independent of the life-cycle of an ActiveRecord object
+summary: Create sets of validations independent of the life-cycle of an ActiveRecord
+  object
 test_files: []
-

data/.document

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

data/Rakefile

@@ -1,26 +0,0 @@
-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"
-  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 << %w(lib test)
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :test => :check_dependencies
-
-task :default => :test

data/VERSION

@@ -1 +0,0 @@
-0.4.1

data/test/db/schema.rb

@@ -1,16 +0,0 @@
-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
-
-  create_table "books" do |t|
-    t.column "title",      :string
-    t.column "author",     :string
-    t.column "isbn",       :integer
-    t.column "user_id",    :integer
-  end
-end

data/test/fixtures/books.yml

@@ -1,12 +0,0 @@
-one:
-  id: 1
-  title: Feature Selection for Knowledge Discovery and Data Mining
-  author: Huan Liu
-  isbn: 9780792381983
-  user_id: 1
-two:
-  id: 2
-  title: SSL and TLS - theory and practice
-  author: Rolf Oppliger
-  isbn: 9781596934474
-  user_id: 1

data/test/fixtures/users.yml

@@ -1,13 +0,0 @@
-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

@@ -1,21 +0,0 @@
-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_constant = defined?(ActiveRecord::Fixtures) ? ActiveRecord::Fixtures : Fixtures
-
-fixtures_constant.create_fixtures('test/fixtures/', ActiveRecord::Base.connection.tables)

data/test/models/book.rb

@@ -1,13 +0,0 @@
-class Book < ActiveRecord::Base
-  belongs_to :user
-
-  validates_presence_of :title
-
-  validation_scope :warnings_book do |s|
-    s.validates_presence_of  :author
-  end
-
-  validation_scope :alerts_book do |s|
-    s.validates_presence_of :isbn
-  end
-end

data/test/models/user.rb

@@ -1,26 +0,0 @@
-class User < ActiveRecord::Base
-  belongs_to :sponsor, :class_name => 'User'
-  has_many :books
-
-  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(:base, "We have a centenarian on our hands") if age && age >= 100
-  end
-end

data/test/test_validation_scopes.rb

@@ -1,93 +0,0 @@
-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[:age].any?
-    end
-
-    should "raise warning for inline validation" do
-      @user.sponsor_id = 12345
-      assert @user.has_warnings?
-      assert @user.warnings[:sponsor_id].any?
-    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[:base], "centenarian alert not raised"
-        assert @user.alerts[:email], "hotmail alert not raised"
-        assert @user.valid?, "user not valid"
-        assert @user.errors.empty?, "user errors not empty"
-      end
-    end
-  end
-
-  context "proxy class" do
-    setup do
-      @user = User.find(1)
-    end
-
-    # Because error_messages_for in dynamic_model gem calls this and delegation
-    # causes base object to be returned, thus losing scoped errors.
-    should "return self for to_model" do
-      assert_equal @user.validation_scope_proxy_for_warnings.class,
-                   @user.validation_scope_proxy_for_warnings.to_model.class
-    end
-
-    should "return model_name of base_class" do
-      assert_equal 'User',
-                   @user.validation_scope_proxy_for_warnings.class.model_name
-    end
-  end
-
-  context "scopes per model" do
-    setup do
-      @user = User.find(1)
-      @book = Book.find(1)
-      @book2 = Book.find(2)
-    end
-
-    should "return all the scopes declared in User model" do
-      assert_equal [:warnings, :alerts], @user.class.all_scopes 
-    end
-
-    should "return all the scopes declared in Book model" do
-      assert_equal [:warnings_book, :alerts_book], @book.class.all_scopes 
-      assert_equal [:warnings_book, :alerts_book], @book2.class.all_scopes 
-    end
-  end
-end

data/validation_scopes.gemspec

@@ -1,53 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = "validation_scopes"
-  s.version = "0.4.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Gabe da Silveira"]
-  s.date = "2012-04-15"
-  s.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."
-  s.email = "gabe@websaviour.com"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    "CHANGELOG",
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "lib/validation_scopes.rb",
-    "test/db/schema.rb",
-    "test/fixtures/books.yml",
-    "test/fixtures/users.yml",
-    "test/helper.rb",
-    "test/models/book.rb",
-    "test/models/user.rb",
-    "test/test_validation_scopes.rb",
-    "validation_scopes.gemspec"
-  ]
-  s.homepage = "http://github.com/dasil003/validation_scopes"
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.22"
-  s.summary = "Create sets of validations independent of the life-cycle of an ActiveRecord object"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    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"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-  end
-end
-