model_mocker 1.1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Matt Patterson
+
+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.rdoc

@@ -0,0 +1,38 @@
+= ModelMocker
+
+This plugin gives you an easy way of generating partially mocked ActiveRecord model objects. This is a useful way of simulating some aspects of a model (like the persistence layer) but leaving the domain logic parts intact, so that you test those in isolation, without worry about database reads and writes.
+
+It's similar to RSpec's mock_model method, but gives you a slightly more declarative way of going about things. I found myself wanting something along these lines a long time ago, and created something very simple that I've used in several projects. More recently I've found myself wanting to easily control certain kinds of behaviour in controller specs, like wanting to ensure that a model instance is valid to allow easy and declarative speccing of the controller.
+
+The plugin adds a <tt>mock</tt> method to <tt>ActiveRecord::Base</tt> when <tt>mock_models</tt> is required, which behaves a lot like <tt>AR::Base.new</tt> or <tt>AR::Base.create</tt>, except that you can specify an ID too. Special behaviour is added by passing a block to <tt>mock</tt> and calling methods on the object it yields.
+
+== Installation
+
+For Rails 2, add <tt>model_mocker</tt> to your <tt>config.gem</tt> for the test evironment.
+
+For Rails 3, add <tt>model_mocker</tt> to your +Gemfile+ in the <tt>:test</tt> group.
+
+== Requirements
+
+ModelMocker uses the Mocha[http://mocha.rubyforge.org/] Gem.
+
+== Examples
+
+To create a mocked model instance which behaves as it's been fetched from the DB:
+
+    ModelClass.mock(:id => 1)
+
+To create one which behaves as if it's a new record
+
+    ModelClass.mock { |m| m.as_new_record }
+
+One which is new and will always report that is invalid, whether or not ActiveRecord validations have been met or not.
+
+    ModelClass.mock do |m|
+      m.as_new_record
+      m.invalid
+    end
+
+The RDoc for the instance methods on ModelMocker gives a complete rundown of what's possible.
+
+Copyright (c) 2008 Matt Patterson, released under the MIT license

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rake'
+require 'rake/rdoctask'
+rspec_base = File.expand_path(File.dirname(__FILE__) + '/../rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Generate documentation for the model_mocker plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = 'ModelMocker'
+  rdoc.options << '--line-numbers' << '--inline-source' #<< '--main' << 'ModelMocker'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "spec/spec.opts"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = lambda do
+      IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+    end
+  end
+  
+  desc "Print Specdoc for all specs (excluding plugin specs)"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+  
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(All\ specs spec)
+    ::CodeStatistics::TEST_TYPES << "All specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+end

data/lib/model_mocker.rb

@@ -0,0 +1,120 @@
+require 'mocha'
+
+# class ActiveRecord::Base
+#   # Create a new instance of the class, pass in creation params and then 
+#   # yield the ModelMocker instance so that methods can be called on it
+#   def self.mock(params = {})
+#     mock_model = ModelMocker.new(self, params)
+#     yield(mock_model) if block_given?
+#     mock_model.instance
+#   end
+# end
+
+# An easy way of generating partially mocked <tt>ActiveRecord</tt> model objects. 
+# This is a useful way of simulating some aspects of a model (like the 
+# persistence layer) but leaving the domain logic parts intact, so that 
+# you can test those in isolation, without worrying about database reads 
+# and writes.
+class ModelMocker
+  # Provides instance method replacements for the <tt>ActiveRecord::Base</tt> instances created by <tt>#mock</tt> 
+  module Helpers
+    def connection
+      raise StandardError, "mock model instances are not allowed to access the database"
+    end
+    
+    def new_record?
+      id.nil?
+    end
+  end
+  
+  module ActiveRecordHook
+    # Create a new instance of the class, pass in creation params and then 
+    # yield the ModelMocker instance so that methods can be called on it
+    def self.mock(params = {})
+      mock_model = ModelMocker.new(self, params)
+      yield(mock_model) if block_given?
+      mock_model.instance
+    end
+  end
+  
+  # ModelMocker.new is called with the AR::Base subclass a mock object is for,
+  # with any creation params in stub_params. Methods on the ModelMocker instance 
+  # determine how the mock AR::Base subclass object will behave
+  def initialize(klass, stub_params = {})
+    @klass = klass
+    @stub_params = stub_params
+  end
+  
+  def instance # :nodoc:
+    return @instance unless @instance.nil?
+    id = @stub_params[:id]
+    @instance = @klass.new
+    attributes.each do |k, v|
+      @instance.send(:write_attribute, k, v)
+    end
+    @instance.stubs(:id).returns(id)
+    stub_instance_methods!
+    @instance.extend(ModelMocker::Helpers)
+    @instance
+  end
+  
+  # The model instance will report that it's a new record
+  def as_new_record
+    instance.stubs(:new_record?).returns(true)
+  end
+  
+  # Validity-related methods will always report that the instance is valid, 
+  # and <tt>#save</tt> and <tt>#save!</tt> will return true (without actually saving anything)
+  def valid
+    instance.stubs(:valid?).returns(true)
+    instance.stubs(:save).returns(true)
+    instance.stubs(:save!).returns(true)
+  end
+  
+  # Validity-related methods will always report that the instance is invalid, 
+  # <tt>#save</tt> will return false, and <tt>#save!</tt> will raise <tt>ActiveRecord::RecordNotSaved</tt>
+  def invalid
+    instance.stubs(:valid?).returns(false)
+    instance.stubs(:save).returns(false)
+    instance.stubs(:save!).raises(ActiveRecord::RecordNotSaved)
+  end
+  
+  # The model instance cannot be updated: <tt>#update_attributes</tt> will always return false
+  def cannot_be_updated
+    instance.stubs(:update_attributes).returns(false)
+  end
+  
+  # The model instance will return true if <tt>#destroy</tt> is called
+  def can_be_destroyed
+    instance.stubs(:destroy).returns(true)
+  end
+  
+  # The model instance will return false if <tt>#destroy</tt> is called
+  def cannot_be_destroyed
+    instance.stubs(:destroy).returns(false)
+  end
+  
+  protected
+  
+  def valid_columns # :nodoc:
+    @valid_columns ||= @klass.columns_hash.collect { |k,v| k }
+  end
+  
+  def attributes # :nodoc:
+    Hash[*(@stub_params.select { |attr_name, value| valid_columns.include?(attr_name.to_s) }.flatten)].reject {|k, v| k.to_s == 'id'}
+  end
+  
+  def method_stubs # :nodoc:
+    Hash[*(@stub_params.reject { |attr_name, value| valid_columns.include?(attr_name.to_s) }.collect { |k, v| [k.to_sym, v] }).flatten]
+  end
+  
+  def stub_instance_methods! # :nodoc:
+    method_stubs.each do |meth, value|
+      instance.stubs(meth).returns(value)
+    end
+  end
+end
+
+if defined?(Rails::Railtie)
+  require 'model_mocker/railtie' 
+end

data/lib/model_mocker/railtie.rb

@@ -0,0 +1,10 @@
+require 'rails'
+require 'model_mocker'
+
+module UrlKeyedObject
+  class Railtie < Rails::Railtie
+    initializer 'model_mocker.active_record_hook', :after => :preload_frameworks do
+      ::ActiveRecord::Base.extend ModelMocker::ActiveRecordHook
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require 'model_mocker'
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend ModelMocker::ActiveRecordHook
+end

data/spec/model_mocker_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
+
+class FakeARClass
+  class << self
+    def columns_hash
+      {'id' => :id, 'thing' => :thing, 'wotsit' => :wotsit}
+    end
+  end
+end
+
+describe ModelMocker do
+  describe "working out which args are attributes and which are method stubs" do
+    before(:each) do
+      @mm = ModelMocker.new(FakeARClass, {:id => 1, :thing => 'value', :wotsit => 'value', :gubbins => 'value'})
+    end
+    
+    it "should figure out that :gubbins is not an attribute" do
+      ModelMocker.publicize_methods do
+        @mm.attributes.should == {:thing => 'value', :wotsit => 'value'}
+      end
+    end
+    
+    it "should figure that :gubbins should be a method stub" do
+      ModelMocker.publicize_methods do
+        @mm.method_stubs.should == {:gubbins => 'value'}
+      end
+    end
+  end
+  
+  describe "working out which args are attributes and which are method stubs when the keys are strings not symbols" do
+    before(:each) do
+      @mm = ModelMocker.new(FakeARClass, {'id' => 1, 'thing' => 'value', 'wotsit' => 'value', 'gubbins' => 'value'})
+    end
+    
+    it "should figure out that 'gubbins' is not an attribute" do
+      ModelMocker.publicize_methods do
+        @mm.attributes.should == {'thing' => 'value', 'wotsit' => 'value'}
+      end
+    end
+    
+    it "should figure that 'gubbins' should be a method stub, and called :gubbins" do
+      ModelMocker.publicize_methods do
+        @mm.method_stubs.should == { :gubbins => 'value' }
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+lib_path = File.expand_path(File.dirname(__FILE__) + "/../lib")
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+
+require 'rubygems'
+gem 'rspec'
+require 'spec'
+
+gem 'activerecord'
+require 'active_record'
+require 'model_mocker'
+
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+class Class
+  def publicize_methods
+    saved_private_instance_methods = self.private_instance_methods
+    saved_protected_instance_methods = self.protected_instance_methods
+    self.class_eval do
+      public *saved_private_instance_methods
+      public *saved_protected_instance_methods
+    end
+    
+    yield
+    
+    self.class_eval do
+      private *saved_private_instance_methods
+      protected *saved_protected_instance_methods
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: model_mocker
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 1
+  version: 1.1.1
+platform: ruby
+authors: 
+- Matt Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-02 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :runtime
+  version_requirements: *id003
+description: Declarative partial mocking for ActiveRecord
+email: matt@reprocessed.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.rdoc
+files: 
+- README.rdoc
+- MIT-LICENSE
+- Rakefile
+- lib/model_mocker/railtie.rb
+- lib/model_mocker.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/fidothe/model_mocker
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Declarative partial mocking for ActiveRecord
+test_files: 
+- spec/spec.opts
+- spec/model_mocker_spec.rb
+- spec/spec_helper.rb