mutle-smartmock 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Mutwin Kraus
+
+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.txt

@@ -0,0 +1,69 @@
+= Smartmock
+
+== What is Smartmock?
+
+Don't you hate how dumb your Model Mocks are sometimes? Little changes to your implementation can break your specs, as mocking forces you to test your implementation and not the results.
+
+Well, no more.
+
+Smartmock lets you focus on the results of your code instead of the implementation.
+
+Plus it works with ActiveRecord as well as DataMapper.
+
+== Status
+
+Development of Smartmock just got started, and a lot is still missing. If you want to contribute, feel free to fork Smartmock on GitHub (<http://gitub.com/mutle/smartmock>) and send a pull request.
+
+== Examples
+
+To demonstrate, here is some code that shows the usage of Smartmock in a Merb Controller spec.
+
+With Smartmock:
+  
+  describe Users, "create action" do
+    before(:each) do
+      smartmock_next User
+    end
+  
+    it "should create a user and save the attributes" do
+      controller = dispatch_to(Users, :create, {:user => {:login => "test"}})
+      User.last_smartmock.login.should == "test" # Verifies that the attributes get assigned
+      User.last_smartmock.should_not be_dirty # Verifies that the object was saved
+    end
+  end
+  
+Without Smartmock:
+
+  describe Users, "show action" do
+    before(:each) do
+      @user = mock("User", :to_xml => "XML")
+    end
+    
+    it "should create a user and save the attributes" do
+      User.should_receive(:new).with("login" => "test').and_return(@user)
+      @user.should_receive!(:save).and_return(true)
+      controller = dispatch_to(Users, :create, {:user => {:login => "test"}})
+    end
+  end
+
+
+== How to use
+
+  require 'rubygems'
+  gem 'mutle-smartmock'
+  require 'smartmock'
+  
+  user = Smartmock[User].new(:login => 'mutle')
+  user.name = 'Mutwin Kraus' # Smartmock adds methods for all attributes of the mocked model
+  user.dirty? # => true
+  user.save # This doesn't write anything to the database
+  user.dirty? # => false
+
+== Installation
+
+  gem source --add http://gems.github.com/
+  gem install mutle-smartmock
+
+== Authors
+
+Smartmock is written by Mutwin Kraus (<http://gitub.com/mutle>).

data/lib/smartmock.rb

@@ -0,0 +1,4 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'smartmock/mock'
+require 'smartmock/helpers'

data/lib/smartmock/helpers.rb

@@ -0,0 +1,120 @@
+module Smartmock
+  
+  module Next
+    module ClassMethods
+      def smartmock_new(attribs={})
+        @last_mock = Mock.new(self, attribs)
+        if @smartmock_stubs
+          @last_mock.stubs = @smartmock_stubs
+        end
+        revert_smartmock_next
+        @last_mock
+      end
+      
+      def last_smartmock
+        @last_mock
+      end
+      
+      def smartmock_next_stub(stubs)
+        @smartmock_stubs = stubs
+      end
+      
+      
+      def revert_smartmock_next
+        class << self
+          alias new orig_new
+        end
+      end
+      
+      def setup_smartmock_next
+        class << self
+          alias orig_new new
+          alias new smartmock_new
+        end
+      end
+    end
+
+    module InstanceMethods
+      
+    end
+
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+  end
+  
+  module Find
+    module ClassMethods
+      def smartmock_find_id(id, *args)
+        revert_smartmock_find
+        (@smartmocks and @smartmocks[id]) ? @smartmocks[id] : nil
+      end
+      
+      def smartmock_find_id!(id, *args)
+        revert_smartmock_find
+        return @smartmocks[id] if @smartmocks and @smartmocks[id]
+        raise DataMapper::ObjectNotFoundError
+      end
+      
+      def insert_smartmock(id, mock)
+        @smartmocks ||= {}
+        @smartmocks[id] = mock
+      end
+      
+      def revert_smartmock_find
+        klass = @msmartmock_klass
+        if Smartmock.active_record?(klass)
+          class << klass
+          end
+        elsif Smartmock.data_mapper?(klass)
+          class << klass
+            alias get orig_find_id
+            alias get! orig_find_id!
+          end
+        end
+      end
+      
+      def setup_smartmock_find(klass)
+        @msmartmock_klass = klass
+        if Smartmock.active_record?(klass)
+          class << klass
+          end
+        elsif Smartmock.data_mapper?(klass)
+          class << klass
+            alias orig_find_id get
+            alias orig_find_id! get!
+            alias get smartmock_find_id
+            alias get! smartmock_find_id!
+          end
+        end
+      end
+    end
+    
+    module InstanceMethods
+      
+    end
+    
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+  end  
+  
+end
+
+
+class Object
+  def smartmock_next(klass, stubs={})
+    klass.send :include, Smartmock::Next
+    klass.setup_smartmock_next
+    klass.smartmock_next_stub(stubs)
+  end
+  
+  def smartmock_insert(mock, conditions={})
+    klass = mock.klass
+    klass.send :include, Smartmock::Find
+    klass.setup_smartmock_find(mock.klass)
+    klass.insert_smartmock(mock.id, mock)
+  end
+end

data/lib/smartmock/mock.rb

@@ -0,0 +1,93 @@
+module Smartmock
+  
+  def self.mock(klass)
+    MockProxy.new(klass)
+  end
+  
+  def self.[](klass)
+    mock(klass)
+  end
+  
+  def self.active_record?(klass)
+    defined?(ActiveRecord) and klass.superclass == ActiveRecord::Base
+  end
+  
+  def self.data_mapper?(klass)
+    defined?(DataMapper) and klass.respond_to?(:properties)
+  end
+  
+  class MockProxy
+    def initialize(klass)
+      @klass = klass
+    end
+    
+    def new(attribs={})
+      Mock.new(@klass, attribs)
+    end
+    
+    def create(attribs={})
+      mock = Mock.new(@klass, attribs)
+      mock.save
+      mock
+    end
+  end
+  
+  class Mock
+    attr_accessor :klass
+    
+    def initialize(klass, attribs={})
+      @attributes = {}
+      @stubs = {}
+      @dirty = false
+      @columns = if Smartmock.active_record?(klass)
+        klass.columns.map { |col| col.name.to_s }
+      elsif Smartmock.data_mapper?(klass)
+        klass.properties.map { |prop| prop.name.to_s }
+      else
+        []
+      end
+      @columns << "id"
+      attribs.each do |key, val|
+        @columns << key.to_s unless @columns.include?(key.to_s)
+        self.send("#{key}=".to_sym, val)
+      end
+      @klass = klass
+    end
+    
+    def id
+      @attributes["id"]
+    end
+    
+    def stubs=(stubs)
+      @stubs = stubs
+    end
+    
+    def method_missing(meth, *args)
+      @columns.each do |col|
+        if meth.to_s == col
+          return @attributes[col]
+        elsif meth.to_s == "#{col}="
+          @dirty = true
+          @attributes[col] = args.first
+          return
+        end
+      end
+      @stubs.each do |stub,value|
+        if stub.to_s == meth.to_s
+          return value
+        end
+      end
+      raise NameError, "Method #{meth.to_s} is not defined"
+    end
+    
+    def dirty?
+      @dirty
+    end
+    
+    def save
+      @dirty = false
+    end
+    alias_method :save!, :save
+  end
+  
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: mutle-smartmock
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mutwin Kraus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-27 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Model Mocking done right
+email: 
+- mkraus@engineyard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- MIT-LICENSE
+- lib/smartmock.rb
+- lib/smartmock/mock.rb
+- lib/smartmock/helpers.rb
+- README.txt
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: Model Mocking done right
+test_files: []
+