mockumentary 0.2.0

data/mockumentary.gemspec

@@ -0,0 +1,92 @@
+# 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 = "mockumentary"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kane Baccigalupi"]
+  s.date = "2011-10-28"
+  s.description = "    With the happy proliferation of TDD, test suites are getting massive, and developer efficiency is dwindling\n    as we wait for our tests to pass. There is a big tradeoff between making unit test more integrationish (and therefore more reliable) vs.\n    making them very mocky, unity and fast. Mockumentary is a library for the later. It inspects the ActiveRecord universe and\n    makes a series of AR mockeries that approximate model without hitting the database, or making any assertions. The assertions,\n    they are still part of the developers job.\n    \n    Mocumentary has two types of AR mockeries: One is used within the Rails universe. It uses introspection to derive association\n    and field information. The second is a static copy built from the first. This static version can be used outside the Rails\n    test universe in a suite faster than the speed of Rails environment load time.\n    \n    Mocking isn't for everyone, so test-drive responsibly.\n"
+  s.email = "baccigalupi@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/mockumentary.rb",
+    "lib/mockumentary/active_record.rb",
+    "lib/mockumentary/collection.rb",
+    "lib/mockumentary/data.rb",
+    "lib/mockumentary/mockery.rb",
+    "lib/mockumentary/mocksimile.rb",
+    "lib/mockumentary/model.rb",
+    "mockumentary.gemspec",
+    "spec/fixtures/app/models/event.rb",
+    "spec/fixtures/app/models/event/follow.rb",
+    "spec/fixtures/app/models/event_resource.rb",
+    "spec/fixtures/app/models/task.rb",
+    "spec/fixtures/app/models/user.rb",
+    "spec/fixtures/config/.gitkeep",
+    "spec/fixtures/db/schema.rb",
+    "spec/mockery/active_record_spec.rb",
+    "spec/mockery/collection_spec.rb",
+    "spec/mockery/data_spec.rb",
+    "spec/mockery/mockery_spec.rb",
+    "spec/mockery/mockumentary_spec.rb",
+    "spec/mockery/spec_helper.rb",
+    "spec/mocksimile/mocksimile_spec.rb",
+    "spec/mocksimile/mockumentary_spec.rb",
+    "spec/mocksimile/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/baccigalupi/mockumentary"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "An ActiveRecord mocking framework, for making your copius BDD rails tests not quite so slow"
+
+  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_runtime_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_runtime_dependency(%q<faker>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, ["~> 3.1.1"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<faker>, [">= 0"])
+      s.add_dependency(%q<activerecord>, ["~> 3.1.1"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<faker>, [">= 0"])
+    s.add_dependency(%q<activerecord>, ["~> 3.1.1"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+  end
+end
+

data/spec/fixtures/app/models/event/follow.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + "/../event"
+class Event::Follow < Event
+end

data/spec/fixtures/app/models/event.rb

@@ -0,0 +1,4 @@
+class Event < ActiveRecord::Base
+  belongs_to :actor, :class_name => 'User', :foreign_key => :user_id
+  has_many :event_resources
+end

data/spec/fixtures/app/models/event_resource.rb

@@ -0,0 +1,27 @@
+class EventResource < ActiveRecord::Base
+  belongs_to :event
+  belongs_to :user_resource, :class_name => 'User', :foreign_key => :resource_id
+  belongs_to :task_resource, :class_name => 'Task', :foreign_key => :resource_id
+
+  def user
+    user_resource if resource_type == 'User'
+  end
+
+  def task
+    task_resource if resource_type == 'Task'
+  end
+
+  def resource=(r)
+    if r.is_a?(User)
+      self.user_resource = r 
+    else
+      self.task_resource = r
+    end
+    self.resource_type = r.class.to_s
+    r
+  end
+
+  def resource
+    user || task
+  end
+end

data/spec/fixtures/app/models/task.rb

@@ -0,0 +1,2 @@
+class Task < ActiveRecord::Base
+end

data/spec/fixtures/app/models/user.rb

@@ -0,0 +1,9 @@
+class User < ActiveRecord::Base
+  has_many :tasks
+  has_many :activities, :class_name => 'Event'
+  has_many :activity_references, 
+    :class_name => 'EventResource', 
+    :foreign_key => :resource_id, 
+    :conditions => ['resource_type = ?', 'User']
+  has_many :events, :through => :activity_references, :source => :event
+end

data/spec/fixtures/db/schema.rb

@@ -0,0 +1,33 @@
+ActiveRecord::Schema.define(:version => 20111020063332) do
+  create_table "event_resources", :force => true do |t|
+    t.integer  "event_id"
+    t.string   "type"
+    t.string   "resource_type"
+    t.integer  "resource_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "events", :force => true do |t|
+    t.integer  "user_id"
+    t.string   "type"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "tasks", :force => true do |t|
+    t.string   "name"
+    t.datetime "due_at"
+    t.integer  "priority"
+    t.integer  "user_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+end
+

data/spec/mockery/active_record_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class ActiveRecord::Base
+  extend Mockumentary::ActiveRecord
+end
+
+describe Mockumentary::ActiveRecord do
+  describe '.discover_mock_class' do
+    it 'is called by mock_class if no mock class is set' do
+      User.should_receive(:discover_mock_class!)
+      User.mock_class
+    end
+
+    it 'calls Mockumentary.generate if there are no matching mock classes' do
+      Mockery.should_receive(:generate).with(User)
+      Mockery.stub(:classes).and_return([])
+      User.instance_eval("@mock_class = nil")
+      User.mock_class
+    end
+
+    it 'finds the Mockery related to itself' do
+      User.mock_class.should == Mockery::User
+    end
+  end
+
+  describe 'mock methods' do
+    it '#mock calls #mock on the related AR class' do
+      mock_user = User.mock(:foo => 'bar')
+      mock_user.id.should be_nil
+      mock_user.new_record.should == true
+      mock_user.foo.should == 'bar'
+      mock_user.name.should be_a(String)
+    end
+
+    it '#mock! calls #mock! on the related AR class' do
+      mock_user = User.mock!(:bar => 'baz')
+      mock_user.id.should be_a(Fixnum)
+      mock_user.bar.should == 'baz'
+      mock_user.new_record.should be_false
+      mock_user.name.should be_a(String)
+    end
+
+    it '#mew calls #new on the related AR class' do
+      mock_user = User.mew(:baz => 'zardoz')
+      mock_user.baz.should == 'zardoz'
+      mock_user.new_record.should be_true
+      mock_user.name.should be_nil
+    end
+  end
+end
+

data/spec/mockery/collection_spec.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Mockumentary::Collection do
+  describe '::Collection' do
+    before do
+      Mockery.generate(User)
+      @collection = Mockumentary::Collection.new(Mockery::User)
+    end
+
+    it 'is enumerable' do
+      @collection.should be_a(Enumerable)
+    end
+
+    it 'starts out empty' do
+      @collection.should_not be_nil
+      @collection.should be_empty
+    end
+
+    it 'mock a collection of new objects of a particular type' do
+      @collection.mock(4).map(&:class).uniq.should == [Mockery::User]
+      @collection.size.should == 4
+      @collection.first.new_record?.should == true
+      @collection.first.name.should be_a(String)
+    end
+
+    it 'mock! will do the same but mock the saving too' do
+      @collection.mock!(2).map(&:new_record?).uniq.should == [false]
+    end
+
+    it '#build will mock an object into the collection' do
+      @collection.build(:name => 'proto awesomeness')
+      @collection.size.should == 1
+      @collection.first.name.should == 'proto awesomeness'
+      @collection.first.new_record?.should == true
+    end
+
+    it '#create will mock a saved object into the collection' do
+      @collection.create(:name => 'awesome saviness')
+      @collection.size.should == 1
+      @collection.first.name.should == 'awesome saviness'
+      @collection.first.new_record?.should == false
+    end
+
+    it '#create! will do the same as #create' do
+      @collection.create!(:name => 'awesome saviness')
+      @collection.size.should == 1
+      @collection.first.name.should == 'awesome saviness'
+      @collection.first.new_record?.should == false
+    end
+
+    it 'overrides the enum #delete to take in multiple records' do
+      @collection.mock(4)
+      first_two = @collection[0..1]
+      @collection.delete(*(first_two))
+      @collection.size.should == 2
+      @collection.map(&:id).should_not include(first_two.map(&:id))
+    end
+
+    it '#delete_all, #destroy_all, #reset all clear the collection' do
+      @collection.mock(2)
+      @collection.size.should == 2
+      @collection.delete_all
+      @collection.size.should == 0
+
+      @collection.mock(2)
+      @collection.size.should == 2
+      @collection.destroy_all
+      @collection.size.should == 0
+
+
+      @collection.mock(2)
+      @collection.size.should == 2
+      @collection.reset
+      @collection.size.should == 0
+    end
+
+    it '#exist? compares by id (which doesn\'t make sense if you aren\'t using mock!)' do
+      @collection.mock!(3)
+      @collection.exist?(@collection.first).should be_true
+      @collection.exist?(Mockery::User.mock!).should be_false
+    end
+  end  
+end
+
+describe Mockery, 'collection mocking' do
+  before do
+    Mockery.generate(User)
+    @user = Mockery::User.mock
+  end
+
+  it 'should default to empty collections' do
+    user_tasks = @user.tasks
+    user_tasks.should be_a(Mockumentary::Collection)
+    user_tasks.should be_empty
+  end
+end

data/spec/mockery/data_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Mockumentary::Data do
+  it 'should generate data via methods' do
+    Mockumentary::Data.datetime.should be_a(Time)
+    Mockumentary::Data.full_name.should be_a(String)
+    Mockumentary::Data.full_name.split.size.should == 2
+  end
+
+  it 'should generate from the correct class given a key' do
+    name = Mockumentary::Data.generate(:full_name)
+    name.should be_a(String)
+    name.split.size.should == 2
+  end
+end 

data/spec/mockery/mockery_spec.rb

@@ -0,0 +1,302 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Mockery do
+  describe 'basic behavior' do
+    before do
+      @model = Mockery.new
+    end
+
+    it 'will respond to any method without raising an error' do
+      @model.fooey_bar.should be_nil
+    end
+
+    it 'can be loaded with a hash of options' do
+      model = Mockery.new(:fooey_bar => 'zardoz')
+      model.fooey_bar.should == 'zardoz'
+    end
+
+    it 'attributes can be set on individual items' do
+      @model.fooey_bar = 'funktastic'
+      @model.fooey_bar.should == 'funktastic'
+    end
+  end
+
+  describe '.generate' do
+    before do
+      Mockery.generate(User)
+    end
+
+    it 'creates a class in the Mockery namespace' do
+      defined?(Mockery::User).should == 'constant'
+    end
+
+    it 'created class is a Mockery subclass' do
+      Mockery::User.ancestors.should include(Mockery)
+    end
+
+    it "should not re-evaluate the class desclaration if the class already exists" do
+      Mockumentary.should_not_receive(:class_eval)
+      Mockery.generate(User)
+    end
+
+    it 'should introspect on the created class' do
+      Mockery::User.mock_defaults.should == {:name => :string}
+    end
+  end
+
+  describe 'mocking' do
+    before do
+      Mockery.generate(Event)
+      Mockery.generate(User)
+    end
+
+    describe '.ar_class' do
+      it 'should be the AR class that it was constructed with' do
+        Mockery::User.ar_class.should == User
+      end
+
+      it 'setting it will cause introspection to occur' do
+        Mockery::User.ar_class = Event
+        Mockery::User.mock_defaults.should == Mockery::Event.mock_defaults
+      end
+
+      it 'can be inferred when it is nil' do
+        Mockery::User.ar_class = nil
+        Mockery::User.ar_class.should == User
+      end
+    end
+
+    describe '.new' do
+      it 'should not add any real attributes' do
+        user = Mockery::User.new
+        user.name.should be_nil
+        user.created_at.should be_nil
+        user.updated_at.should be_nil
+        user.id.should be_nil
+      end
+
+      it 'should be a new record' do
+        user = Mockery::User.new
+        user.new_record?.should be_true
+      end
+
+      it 'can receive options that it will set on the instance' do
+        user = Mockery::User.new(:name => 'foo bar')
+        user.name.should == 'foo bar'
+      end
+
+      it 'should have relationships' do
+        user = Mockery::User.new
+        user.event_resources.mock
+        user.event_resources.size.should == 1
+        user.event_resources.first.should be_a(Mockery::EventResource)
+      end
+    end
+
+    describe '.mock' do 
+      before do
+        Mockery::User.ar_class = User
+      end
+
+      it 'should add faked attributes' do
+        user = Mockery::User.mock
+        user.name.should be_a(String)
+        user.name.split.size.should == 3
+      end
+
+      it 'should not add an id, or other save attributes' do
+        user = Mockery::User.mock
+        user.id.should be_nil
+        user.created_at.should be_nil
+        user.updated_at.should be_nil
+      end
+
+      it 'should be a new record' do
+        user = Mockery::User.mock
+        user.new_record?.should be_true
+      end
+
+      it 'should accept initialization options' do
+        user = Mockery::User.mock(:foo => 'bar')
+        user.foo.should == 'bar'
+      end
+    end
+
+    describe '.mock!' do
+      it 'should add faked attributes' do
+        user = Mockery::User.mock!
+        user.name.should be_a(String)
+      end
+
+      it 'should create an incrementing id' do
+        user = Mockery::User.mock!
+        user.id.should be_a(Fixnum)
+        Mockery::User.mock!.id.should == user.id + 1
+      end
+
+      it 'should build updated_at and created_at attributes' do
+        user = Mockery::User.mock!
+        user.created_at.should be_a(Time)
+        user.updated_at.should be_a(Time)
+      end
+
+      it 'should not be a new record' do
+        user = Mockery::User.mock!
+        user.new_record?.should be_false
+      end
+
+      it 'should allow overrides with initialization options' do
+        user = Mockery::User.mock!(:name => 'footy barf')
+        user.name.should == 'footy barf'
+      end
+    end
+  end
+
+  describe 'overriding defaults' do
+    before do
+      Mockery.generate(User)
+    end
+
+    describe 'with mock options' do
+      before do
+        class Mockery::User
+          def self.overrides
+            { :mock => 
+              { 
+                :name => :full_name,
+                :foo => 'not bar'
+              } 
+            }
+          end
+        end
+      
+        @user = Mockery::User.mock(:foo => 'bar') 
+      end
+
+      it 'should use the overrides instead of the defaults' do
+        @user.name.split.size.should == 2 
+      end
+      
+      it 'should not override initializaiton options' do
+        @user.foo.should == 'bar' 
+      end
+    end
+
+    describe 'with init options' do
+      before do
+        class Mockery::User
+          def self.overrides
+            { :init => 
+              { 
+                :state => 'new',
+                :new_record => 'yup'
+              } 
+            }
+          end
+        end
+      
+        @user = Mockery::User.new(:state => 'jaded') 
+      end
+
+      it 'should use the overrieds instead of the defaults' do
+        @user.new_record.should == 'yup'
+      end
+
+      it 'should options passed into new over those on the class' do
+        @user.state.should == 'jaded'
+      end
+    end
+
+    describe 'save options' do 
+      before do
+        class Mockery::User
+          def self.overrides
+            { :save => 
+              { 
+                :state => 'saved',
+                :created_at => Time.now + 3.years
+              } 
+            }
+          end
+        end
+      
+        @user = Mockery::User.mock!(:state => 'jaded') 
+      end
+
+      it 'should use the overrides instead of the defaults' do
+        @user.created_at.should > Time.now + 61.days
+      end
+
+      it 'should options passed into new over those on the class' do
+        @user.state.should == 'jaded'
+      end
+
+      it 'should override the initalization options' do
+        @user.new_record.should == false
+      end
+    end
+  end
+
+  describe '.dump' do
+    before do
+      Rails.stub(:root).and_return(FIXTURE_ROOT)
+      Mockumentary.introspect
+      @dir = "#{FIXTURE_ROOT}/config"
+      @path = @dir + "/mockumentary.yml"
+      File.delete(@path) if File.exist?(@path)
+
+      class Mockery::User
+        def self.overrides
+          {
+            :init => {:state => 'new'},
+            :mock => {:full_name => :full_name},
+            :save => {:state => 'saved'}
+          }
+        end
+      end
+
+      Mockery.dump
+      @hash = YAML.load(File.read(@path))
+    end
+
+    it 'will create a new file to the Rails.root config path' do
+      File.exist?(@path).should be_true
+    end
+
+    it 'will have an entry for each class' do
+      @hash.keys.should include 'User', 'Event', 'EventResource', 'Task', 'Event::Follow'
+    end
+
+    it 'each class will have an init hash that combines that classes overrides with init_defaults' do
+      @hash['User'][:init].should == {
+        :state => 'new',
+        :new_record => true
+      }
+    end
+
+    it 'each class will have a mock hash that combines overrieds with defaults' do
+      @hash['User'][:mock].should == {
+        :name => :string,
+        :full_name => :full_name
+      }
+    end
+
+    it 'each class will have a save hash that combines overrides with defaults' do
+      save_hash = @hash['User'][:save]
+      save_hash[:state].should == 'saved'
+      save_hash[:created_at].should == :datetime
+      save_hash[:updated_at].should == :datetime
+      save_hash[:new_record].should == false
+      save_hash[:id].should == :uid
+    end
+
+    it 'stores the relationships' do
+      @hash['User'][:relationships].should == {
+        :tasks => 'Task',
+        :activities => 'Event',
+        :activity_references => 'EventResource',
+        :events => 'Event'
+      }
+    end
+  end
+end

data/spec/mockery/mockumentary_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Mockumentary do
+  describe '.introspect' do
+    before do
+      Rails.stub(:root).and_return(FIXTURE_ROOT)
+
+      @classes = []
+      Mockery.stub(:generate) do |args|
+        @classes << args
+      end
+    end
+
+    it 'calls Mockery.generate for each of the first level active record objects found' do
+      Mockumentary.introspect
+      @classes.should include User, Event, EventResource, Task
+    end
+
+    it 'calls Mockery.generate on nested models' do
+      Mockumentary.introspect
+      @classes.should include Event::Follow
+    end
+  end
+end