shuber-validates_existence 1.0.0

data/CHANGELOG

@@ -0,0 +1,8 @@
+2009-01-17 - Sean Huber (shuber@huberry.com)
+  * Add shoulda_macros
+  * Update shoulda_macros
+  * Add gemspec
+
+2008-08-18 - Sean Huber (shuber@huberry.com)
+	* Added tests
+	* Removed evaluate_condition calls and used validates_each like syntax (could't just use validates_each because we needed to overwrite the :allow_nil and :allow_blank logic to check if the foreign_key was nil/blank, NOT the association)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2008 Josh Susser (http://www.hasmanythrough.com)
+
+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.markdown

@@ -0,0 +1,21 @@
+# ValidatesExistence
+
+This plugin adds a new `validates_existence_of` method to `ActiveRecord::Base`.
+
+The `validates_existence_of` validator checks that a foreign key in a `belongs_to`
+association points to an existing record. If `:allow_nil => true`, then the key
+itself may be nil. A non-nil key requires that the foreign object must exist.
+Works with polymorphic `belongs_to`.
+
+The default error message is "does not exist".
+
+## Example
+
+    class Person < ActiveRecord::Base
+      belongs_to :address
+      validates_existence_of :address
+    end
+
+Note that this validation performs a query to see if the record in question exists.
+
+*Copyright (c) 2007-2008 Josh Susser. Released under the MIT license.*

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the validates_existence plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the validates_existence plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ValidatesExistence'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'validates_existence'

data/lib/validates_existence.rb

@@ -0,0 +1,46 @@
+module ActiveRecord
+  module Validations
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      
+      # The validates_existence_of validator checks that a foreign key in a belongs_to
+      # association points to an exisiting record. If :allow_nil => true, then the key
+      # itself may be nil. A non-nil key requires that the foreign object must exist.
+      # Works with polymorphic belongs_to.
+      def validates_existence_of(*attr_names)
+        configuration = { :message => "does not exist", :on => :save }
+        configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
+      
+        send(validation_method(configuration[:on]), configuration) do |record|
+          attr_names.each do |attr_name|
+            attr_name = attr_name.to_s.sub(/_id$/, '').to_sym
+            unless (assoc = reflect_on_association(attr_name)) && assoc.macro == :belongs_to
+              raise ArgumentError, "Cannot validate existence of :#{attr_name} because it is not a belongs_to association."
+            end
+            fk_value = record.send assoc.primary_key_name.to_sym
+            unless fk_value.nil? && configuration[:allow_nil] || fk_value.blank? && configuration[:allow_blank]
+              if (foreign_type = assoc.options[:foreign_type]) # polymorphic
+                foreign_type_value = record[assoc.options[:foreign_type]]
+                if !foreign_type_value.blank?
+                  assoc_class = foreign_type_value.constantize
+                else
+                  record.errors.add(attr_name, configuration[:message])
+                  next
+                end
+              else # not polymorphic
+                assoc_class = assoc.klass
+              end
+              record.errors.add(attr_name, configuration[:message]) unless assoc_class && assoc_class.exists?(fk_value)
+            end
+          end
+        end
+      end
+
+    end # ClassMethods
+
+  end
+end

data/shoulda_macros/validates_existence.rb

@@ -0,0 +1,29 @@
+class Test::Unit::TestCase
+
+  def self.should_require_existence_of(*attributes)
+    options = attributes.extract_options!
+    klass = model_class
+    
+    attributes.each do |attribute|
+      should "require #{attribute} exists" do
+        object = get_instance_of(klass)
+        object.send("#{attribute}_id=", 0)
+        assert !object.valid?, "#{object.class} was saved with a non-existent #{attribute}"
+        assert object.errors.on(attribute), "There are no errors on #{attribute} after being set to a non-existent record"
+        assert_contains(object.errors.on(attribute), 'does not exist', "when set to 0")
+      end
+    end
+    
+    if options[:allow_nil]
+      attributes.each do |attribute|
+        should "allow #{attribute} to be nil" do
+          object = get_instance_of(klass)
+          object.send("#{attribute}_id=", nil)
+          object.valid?
+          assert !object.errors.on(attribute), "There were errors on #{attribute} after being set to nil"
+        end
+      end
+    end
+  end
+  
+end

data/test/helpers/table_test_helper.rb

@@ -0,0 +1,49 @@
+module TableTestHelper
+  
+  def create_all_tables
+    create_blogs_table
+    create_posts_table
+    create_comments_table
+  end
+  
+  def create_blogs_table
+    silence_stream(STDOUT) do
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :blogs do |t|
+        end
+      end
+    end
+  end
+  
+  def create_posts_table
+    silence_stream(STDOUT) do
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :posts do |t|
+          t.integer  :blog_id
+        end
+      end
+    end
+  end
+  
+  def create_comments_table
+    silence_stream(STDOUT) do
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :comments do |t|
+          t.integer  :commentable_id
+          t.string   :commentable_type
+        end
+      end
+    end
+  end
+  
+  def drop_all_tables
+    ActiveRecord::Base.connection.tables.each do |table|
+      drop_table(table)
+    end
+  end
+  
+  def drop_table(table)
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+  
+end

data/test/init.rb

@@ -0,0 +1,22 @@
+# $:.reject! { |path| path.include? 'TextMate' }
+require 'test/unit'
+
+# Require and include test helpers
+#
+Dir[File.join(File.dirname(__FILE__), 'helpers', '*_test_helper.rb')].each do |helper|
+  require helper
+  /(.*?)_test_helper\.rb/.match File.basename(helper)
+  class_name = $1.split('_').collect{ |name| name.downcase.capitalize }.join('') + 'TestHelper'
+  Test::Unit::TestCase.send :include, Object.const_get(class_name) if Object.const_defined?(class_name)
+end
+
+# Load ActiveRecord
+#
+require 'rubygems'
+gem 'activerecord'
+require 'active_record'
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :dbfile => ':memory:'
+
+# Require the main init.rb for the plugin
+#
+require File.join(File.dirname(File.dirname(__FILE__)), 'init')

data/test/validates_existence_test.rb

@@ -0,0 +1,164 @@
+require File.dirname(__FILE__) + '/init'
+
+
+# Blog
+
+  class Blog < ActiveRecord::Base
+    has_many :posts
+  end
+
+# Post
+
+  class Post < ActiveRecord::Base
+    belongs_to :blog
+    has_many :comments, :as => :commentable
+  end
+
+  class PostWithRequiredBlog < Post
+    validates_existence_of :blog
+  end
+
+  class PostWithoutRequiredBlog < Post
+    validates_existence_of :blog, :allow_nil => true
+  end
+  
+  class PostWithRequiredBlogIf < Post
+    validates_existence_of :blog, :if => :condition
+    attr_accessor :condition
+  end
+  
+  class PostWithRequiredBlogUnless < Post
+    validates_existence_of :blog, :unless => :condition
+    attr_accessor :condition
+  end
+
+# Comment
+
+  class Comment < ActiveRecord::Base
+    belongs_to :commentable, :polymorphic => true
+  end
+
+  class CommentWithRequiredCommentable < Comment
+    validates_existence_of :commentable
+  end
+
+  class CommentWithoutRequiredCommentable < Comment
+    validates_existence_of :commentable, :allow_nil => true
+  end
+
+
+class ValidatesExistenceTest < Test::Unit::TestCase
+  
+  def setup
+    create_all_tables
+    @default_blog = Blog.create
+    @default_post = PostWithoutRequiredBlog.create
+  end
+  
+  def teardown
+    drop_all_tables
+  end
+  
+  # PostWithRequiredBlog
+  
+    def test_should_create_post_with_required_blog_with_valid_blog
+      @post = PostWithRequiredBlog.new :blog_id => @default_blog.id
+      assert @post.save
+    end
+  
+    def test_should_not_create_post_with_required_blog_when_blog_is_nil
+      @post = PostWithRequiredBlog.new
+      assert !@post.save
+      assert @post.errors.on(:blog)
+    end
+  
+    def test_should_not_create_post_with_required_blog_when_blog_does_not_exist
+      @post = PostWithRequiredBlog.new :blog_id => '2'
+      assert !@post.save
+      assert @post.errors.on(:blog)
+    end
+  
+  # PostWithoutRequiredBlog
+  
+    def test_should_create_post_without_required_blog_with_valid_blog
+      @post = PostWithoutRequiredBlog.new :blog_id => @default_blog.id
+      assert @post.save
+    end
+  
+    def test_should_create_post_without_required_blog_when_blog_is_nil
+      @post = PostWithoutRequiredBlog.new
+      assert @post.save
+    end
+  
+    def test_should_not_create_post_without_required_blog_when_blog_does_not_exist
+      @post = PostWithoutRequiredBlog.new :blog_id => '2'
+      assert !@post.save
+      assert @post.errors.on(:blog)
+    end
+    
+  # Polymorphic CommentWithRequiredCommentable
+  
+    def test_should_create_comment_with_required_commentable_with_valid_commentable
+      @comment = CommentWithRequiredCommentable.new :commentable_id => @default_post.id, :commentable_type => 'Post'
+      assert @comment.save
+    end
+  
+    def test_should_not_create_comment_with_required_commentable_when_commentable_is_nil
+      @comment = CommentWithRequiredCommentable.new
+      assert !@comment.save
+      assert @comment.errors.on(:commentable)
+    end
+  
+    def test_should_not_create_comment_with_required_commentable_when_commentable_does_not_exist
+      @comment = CommentWithRequiredCommentable.new :commentable_id => '2', :commentable_type => 'Post'
+      assert !@comment.save
+      assert @comment.errors.on(:commentable)
+    end
+    
+  # Polymorphic CommentWithoutRequiredCommentable
+  
+    def test_should_create_comment_without_required_commentable_with_valid_commentable
+      @comment = CommentWithoutRequiredCommentable.new :commentable_id => @default_post.id, :commentable_type => 'Post'
+      assert @comment.save
+    end
+  
+    def test_should_create_comment_without_required_commentable_when_commentable_is_nil
+      @comment = CommentWithoutRequiredCommentable.new
+      assert @comment.save
+    end
+  
+    def test_should_not_create_comment_without_required_commentable_when_commentable_does_not_exist
+      @comment = CommentWithoutRequiredCommentable.new :commentable_id => '2', :commentable_type => 'Post'
+      assert !@comment.save
+      assert @comment.errors.on(:commentable)
+    end
+    
+  # PostWithRequiredBlogIf (:if => :condition)
+  
+    def test_post_should_require_blog_when_if_condition_is_true
+      @post = PostWithRequiredBlogIf.new
+      @post.condition = true
+      assert !@post.save
+    end
+    
+    def test_post_should_not_require_blog_when_if_condition_is_false
+      @post = PostWithRequiredBlogIf.new
+      @post.condition = false
+      assert @post.save
+    end
+    
+  # PostWithRequiredBlogUnless (:unless => :condition)
+
+    def test_post_should_require_blog_when_unless_condition_is_false
+      @post = PostWithRequiredBlogUnless.new
+      @post.condition = false
+      assert !@post.save
+    end
+    
+    def test_post_should_not_require_blog_when_unless_condition_is_true
+      @post = PostWithRequiredBlogUnless.new
+      @post.condition = true
+      assert @post.save
+    end
+  
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: shuber-validates_existence
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Josh Susser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-17 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Provides a validates_existence_of method for ActiveRecord models to check existence of records referenced by belongs_to associations
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- init.rb
+- lib/validates_existence.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- shoulda_macros/validates_existence.rb
+- test/helpers/table_test_helper.rb
+- test/init.rb
+has_rdoc: false
+homepage: http://github.com/shuber/validates_existence
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Provides a validates_existence_of method for ActiveRecord models to check existence of records referenced by belongs_to associations
+test_files: 
+- test/validates_existence_test.rb