activerecord_null_object 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+test.db
+pkg

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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

@@ -0,0 +1,5 @@
+= ActiveRecordWithNullObject
+
+Implements the Null Object Pattern for nil values in ActiveRecord associations.
+
+Copyright (c) 2009 West Arete Computing, Inc., released under the MIT license

data/Rakefile

@@ -0,0 +1,25 @@
+require 'spec'
+require 'spec/rake/spectask'
+require 'init'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = %q{activerecord_null_object}
+    s.summary = %q{Implements the Null Object Pattern for nil values in ActiveRecord associations.}
+    s.email = %q{info@westarete.com}
+    s.homepage = %q{http://github.com/westarete/activerecord_null_object/}
+    s.description = ""
+    s.authors = ["Scott Woods"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/activerecord_null_object.gemspec

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{activerecord_null_object}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Woods"]
+  s.date = %q{2009-09-02}
+  s.description = %q{}
+  s.email = %q{info@westarete.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "activerecord_null_object.gemspec",
+     "init.rb",
+     "lib/activerecord_null_object.rb",
+     "lib/null_object.rb",
+     "spec/belongs_to_spec.rb",
+     "spec/database.yml",
+     "spec/null_object_spec.rb",
+     "spec/schema.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/westarete/activerecord_null_object/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Implements the Null Object Pattern for nil values in ActiveRecord associations.}
+  s.test_files = [
+    "spec/belongs_to_spec.rb",
+     "spec/null_object_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'activerecord'
+ActiveRecord::ActiveRecordError   # Workaround for loading bug in AR 2.3.2.
+require File.dirname(__FILE__) + '/lib/activerecord_null_object'
+require File.dirname(__FILE__) + '/lib/null_object'

data/lib/activerecord_null_object.rb

@@ -0,0 +1,46 @@
+module ActiveRecord
+  module Associations
+    module ClassMethods
+      
+      # Add a boolean :null_object option to belongs_to.
+      def belongs_to_with_null_object(association_id, options = {}) #:nodoc:
+        # Extract our custom option.
+        use_null_object = options.delete(:null_object)
+        # Call the real belongs_to so that the association gets defined.
+        belongs_to_without_null_object(association_id, options)
+        # Modify the association if need be.
+        if use_null_object
+          
+          # Determine the class of the association.
+          association_class_name = options[:class_name] || association_id.to_s.classify
+          association_class = association_class_name.constantize
+
+          # Determine the null class for this association.
+          null_class_name = "Null" + association_class_name
+          if Object.const_defined?(null_class_name)
+            null_class = Object.const_get(null_class_name.to_sym)
+          else
+            # Define the null class as an ancestor of the association class.
+            null_class = Object.const_set(null_class_name, Class.new(association_class))
+            null_class.class_eval do
+              include Singleton
+              include ActiveRecordNullObject::NullObject
+            end
+          end
+
+          # Modify the "getter" of the belongs_to relationship to return an
+          # instance of the association's null object instead of returning nil.
+          class_eval do
+            define_method("#{association_id}_with_null_object".to_sym) do
+              send("#{association_id}_without_null_object".to_sym) || null_class.instance
+            end
+            alias_method_chain association_id, :null_object
+          end
+          
+        end
+      end
+      alias_method_chain :belongs_to, :null_object
+      
+    end
+  end
+end

data/lib/null_object.rb

@@ -0,0 +1,21 @@
+module ActiveRecordNullObject
+  module NullObject
+  
+    def id 
+      nil
+    end
+  
+    def nil?
+      true
+    end
+    
+    def empty?
+      true
+    end
+  
+    def validate
+      errors.add_to_base("is a null object and can't be saved")
+    end
+  
+  end
+end

data/spec/belongs_to_spec.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Comment do
+  before(:each) do
+    @comment = Comment.create!(:body => 'The body.')
+  end
+  
+  it "should contain a body" do
+    @comment.body.should == 'The body.'
+  end
+
+  describe "without an author" do
+    it "should return a null object for the author" do
+      @comment.author.kind_of?(NullAuthor).should be_true
+    end
+    
+    it "should be nil" do
+      @comment.author.should be_nil
+    end
+    
+    it "should return true for comment.author.nil?" do
+      @comment.author.nil?.should be_true
+    end
+    
+    it "should return false for comment.author.present?" do
+      @comment.author.present?.should be_false
+    end
+    
+    it "should return nil for the author's name" do
+      @comment.author.name.should be_nil
+    end
+  end
+  
+  describe "with an author" do
+    before(:each) do
+      @comment.author = Author.create!(:name => 'James Baker')
+    end
+    
+    it "should return the author object" do
+      @comment.author.kind_of?(Author).should be_true
+      @comment.author.kind_of?(NullAuthor).should_not be_true
+    end
+    
+    it "should return false for comment.author.nil?" do
+      @comment.author.nil?.should be_false
+    end
+    
+    it "should return true for comment.author.present?" do
+      @comment.author.present?.should be_true
+    end
+    
+    it "should return the author's name" do
+      @comment.author.name.should == 'James Baker'
+    end
+    
+    it "should revert to a null object if assigned nil" do
+      @comment.author = nil
+      @comment.author.name.should be_nil
+    end
+  end
+end
+
+describe Post do
+  before(:each) do
+    @post = Post.create!(:body => 'The body.')
+  end
+  
+  it "should contain a body" do
+    @post.body.should == 'The body.'
+  end
+  
+  it "should not have null object support for the author" do
+    @post.author.should be_nil
+    @post.author.kind_of?(Author).should be_false
+    @post.author.respond_to?(:name).should be_false
+  end
+end
+
+describe Session do
+  before(:each) do
+    @session = Session.create!(:description => 'The description.')
+  end
+  
+  it "should contain a description" do
+    @session.description.should == 'The description.'
+  end
+  
+  it "should not have null object support for the author" do
+    @session.author.should be_nil
+    @session.author.kind_of?(Author).should be_false
+    @session.author.respond_to?(:name).should be_false
+  end
+end

data/spec/database.yml

@@ -0,0 +1,3 @@
+test:
+  :adapter: sqlite3
+  :database: test.db

data/spec/null_object_spec.rb

@@ -0,0 +1,99 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe NullAuthor do
+  
+  before(:each) do
+    @null_author = Comment.new.author
+  end
+  
+  it "should be a kind of Author" do
+    @null_author.kind_of?(Author).should be_true
+  end
+
+  it "should be a singleton" do
+    lambda { NullAuthor.new }.should raise_error(NoMethodError)
+  end
+  
+  it "should be nil" do
+    @null_author.nil?.should be_true
+    @null_author.should be_nil
+  end
+  
+  it "should be empty" do
+    @null_author.empty?.should be_true
+  end
+  
+  it "should be blank" do
+    @null_author.blank?.should be_true
+  end
+  
+  it "should not be present" do
+    @null_author.present?.should be_false
+  end
+
+  describe "#id" do
+    it "should return nil" do
+      @null_author.id.should be_nil
+    end
+  end
+  
+  describe "#new_record?" do
+    it "should return true" do
+      @null_author.new_record?.should be_true
+    end
+  end
+  
+  describe "#save" do
+    it "should return false" do
+      @null_author.save.should be_false
+    end
+    
+    it "should not create a new record" do
+      lambda { @null_author.save }.should_not change { NullAuthor.count }
+    end
+    
+    it "should add an error" do
+      @null_author.errors.on(:base).should == "is a null object and can't be saved"
+    end
+  end
+  
+  describe "#save!" do
+    it "should raise an exception" do
+      lambda { @null_author.save! }.should raise_error(ActiveRecord::RecordInvalid)
+    end
+    
+    it "should not create a new record" do
+      lambda { 
+        begin
+          @null_author.save! 
+        rescue ActiveRecord::RecordInvalid
+        end
+      }.should_not change { NullAuthor.count }
+    end
+
+    it "should add an error" do
+      @null_author.errors.on(:base).should == "is a null object and can't be saved"
+    end
+  end
+
+  describe "#update_attributes" do
+    it "should return false" do
+      @null_author.update_attributes({}).should be_false
+    end
+    
+    it "should not create a new record" do
+      lambda { @null_author.update_attributes({}) }.should_not change { NullAuthor.count }
+    end
+
+    it "should add an error" do
+      @null_author.errors.on(:base).should == "is a null object and can't be saved"
+    end
+  end
+  
+  describe "#name" do
+    it "should return nil" do
+      @null_author.name.should be_nil
+    end
+  end
+  
+end

data/spec/schema.rb

@@ -0,0 +1,28 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table "authors", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+  
+  create_table "comments", :force => true do |t|
+    t.text     "body"
+    t.integer  "author_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "posts", :force => true do |t|
+    t.text     "body"
+    t.integer  "author_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "sessions", :force => true do |t|
+    t.text     "description"
+    t.integer  "author_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'activerecord'
+require 'yaml'
+require 'spec'
+require File.dirname(__FILE__) + '/../init.rb'
+
+# Establish database connection.
+config = YAML::load(File.open(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.establish_connection(config['test'])
+load(File.dirname(__FILE__) + "/schema.rb")
+
+# Define ActiveRecord classes to use while testing.
+class Author < ActiveRecord::Base
+  has_many :posts
+  has_many :comments
+  has_many :sessions
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :author, :null_object => true
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :author, :null_object => false
+end
+
+class Session < ActiveRecord::Base
+  belongs_to :author
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord_null_object
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Scott Woods
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-02 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: info@westarete.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- activerecord_null_object.gemspec
+- init.rb
+- lib/activerecord_null_object.rb
+- lib/null_object.rb
+- spec/belongs_to_spec.rb
+- spec/database.yml
+- spec/null_object_spec.rb
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/westarete/activerecord_null_object/
+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: 2
+summary: Implements the Null Object Pattern for nil values in ActiveRecord associations.
+test_files: 
+- spec/belongs_to_spec.rb
+- spec/null_object_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb