prefactory 0.2.0

data/prefactory.gemspec

@@ -0,0 +1,39 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prefactory/version'
+
+active_record_version = case ENV["ACTIVE_RECORD_VERSION"].to_s
+                        when 'master'
+                          { github: "rails/activerecord" }
+                        when ''
+                          "~> 4"
+                        else
+                          "~> #{ENV['ACTIVE_RECORD_VERSION']}"
+                        end
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prefactory'
+  spec.version       = Prefactory::VERSION
+  spec.authors       = ['developers@socialcast.com']
+  spec.email         = ['developers@socialcast.com']
+  spec.summary       = %q{Transaction-wrapped RSpec example groups with FactoryGirl integration}
+  spec.description   = %q{Create factory objects in before-all blocks for fixture-like performance}
+  spec.homepage      = 'https://github.socialcast.com/prefactory'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rspec_around_all', '~> 0'
+  spec.add_dependency 'activerecord', active_record_version
+  spec.add_dependency 'factory_girl_rails', '~> 4'
+
+  spec.add_development_dependency 'mysql2', '~> 0.3'
+  spec.add_development_dependency 'sqlite3', '~> 1'
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'socialcast-git-extensions', '~> 3'
+end

data/spec/database.yml

@@ -0,0 +1,10 @@
+sqlite3:
+  adapter: sqlite3
+  database: spec/<%= ENV['NO_PREFACTORY'] ? 'no_' : '' %>prefactory_test.sqlite3
+
+mysql2:
+  adapter: mysql2
+  database:  <%= ENV['NO_PREFACTORY'] ? 'no_' : '' %>prefactory_test
+  username: root
+  password:
+  host: localhost

data/spec/database_setup.rb

@@ -0,0 +1,73 @@
+# encoding: UTF-8
+
+# Copyright (c) 2014, VMware, Inc. All Rights Reserved.
+#
+# 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.
+
+require 'logger'
+require 'erb'
+config = YAML.load(ERB.new(File.read(File.dirname(__FILE__) + '/database.yml')).result)
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite3'])
+
+ActiveRecord::Schema.define(:version => 2) do
+  create_table :blogs, :force => true do |t|
+    t.column :title, :string
+    t.column :counter, :integer
+    t.timestamps
+  end
+  create_table :comments, :force => true do |t|
+    t.column :blog_id, :integer
+    t.column :counter, :integer
+    t.column :text, :string
+    t.timestamps
+  end
+  create_table :links, :force => true do |t|
+    t.column :blog_id, :integer
+    t.column :counter, :integer
+    t.column :name, :string
+    t.timestamps
+  end
+end
+
+class Blog < ActiveRecord::Base
+  has_many :comments, :dependent => :destroy
+  has_many :links, :dependent => :destroy
+  include CallbackMatcher::ActiveRecordHooks
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :blog
+  include CallbackMatcher::ActiveRecordHooks
+end
+
+class Link < ActiveRecord::Base
+  belongs_to :blog
+  include CallbackMatcher::ActiveRecordHooks
+end
+
+FactoryGirl.define do
+  factory :blog, :aliases => [:another_blog] do
+    sequence(:title) { |n| "Title #{n}" }
+  end
+
+  factory :comment, :aliases => [:another_comment] do
+    sequence(:text) { |n| "Comment #{n}" }
+  end
+end

data/spec/prefactory_spec.rb

@@ -0,0 +1,267 @@
+# encoding: UTF-8
+
+# Copyright (c) 2014, VMware, Inc. All Rights Reserved.
+#
+# 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.
+
+require 'spec_helper'
+
+describe Prefactory do
+
+  describe "#in_before_all?" do
+    before(:all) do
+      @in_before_all = in_before_all?
+    end
+    before(:each) do
+      @in_before_each = in_before_all?
+    end
+    it "is only true when called inside a before(:all)" do
+      @in_before_all.should be_true
+      @in_before_each.should be_false
+      in_before_all?.should be_false # in this it-block context
+    end
+    after(:each) do
+      flunk if in_before_all?
+    end
+    after(:all) do
+      flunk if in_before_all?
+    end
+  end
+
+  describe "#prefactory_add" do
+
+    context "when passing a block with no FactoryGirl activity" do
+      before :all do
+        prefactory_add(:my_blog) do
+          Blog.create! :title => 'My Blog'
+        end
+      end
+      it "creates an object using the provided name" do
+        my_blog.should be_present
+        my_blog.title.should == 'My Blog'
+        my_blog.id.should be_present
+        Blog.where(:id => my_blog.id).should exist
+        prefactory(:my_blog).should == my_blog
+        my_blog.counter.should be_nil
+      end
+    end
+
+    context "when passing just a FactoryGirl factory name" do
+      before :all do
+        prefactory_add :blog
+      end
+      it "creates an object based on the factory name, via FactoryGirl::Syntax::Methods" do
+        blog.should be_present
+        blog.title.should =~ /\ATitle [0-9]+\z/
+        blog.id.should be_present
+        Blog.where(:id => blog.id).should exist
+        prefactory(:blog).should == blog
+        blog.counter.should be_nil
+      end
+    end
+    context "when passing a factory name and additional attributes" do
+      before :all do
+        prefactory_add :blog, :counter => 12
+      end
+      it "uses the additional attributes" do
+        blog.should be_present
+        blog.title.should =~ /\ATitle [0-9]+\z/
+        blog.id.should be_present
+        Blog.where(:id => blog.id).should exist
+        prefactory(:blog).should == blog
+        blog.counter.should == 12
+      end
+    end
+    context "when using a different name and an explicit create call in a block" do
+      before :all do
+        prefactory_add(:some_other_blog) { create :blog, :counter => 24 }
+      end
+      it "uses the other name" do
+        some_other_blog.should be_present
+        some_other_blog.title.should =~ /\ATitle [0-9]+\z/
+        some_other_blog.id.should be_present
+        Blog.where(:id => some_other_blog.id).should exist
+        prefactory(:some_other_blog).should == some_other_blog
+        some_other_blog.counter.should == 24
+      end
+    end
+    context "when referencing the object within the before-all block" do
+      before :all do
+        prefactory_add :blog
+        blog.update_attributes! :counter => 42
+      end
+      it "works" do
+        blog.counter.should == 42
+      end
+    end
+    context "nesting a before-all with a prefactory_add" do
+      before :all do
+        prefactory_add :blog, :title => 'the big book of trains'
+      end
+      it { blog.should be_present }
+      context "and another before-all prefactory_add" do
+        before :all do
+          prefactory_add :comment, :blog => blog, :text => 'old text'
+        end
+        it do
+          comment.should be_present
+          comment.blog.should == blog
+        end
+        it do
+          blog.should be_present
+          blog.title.should == 'the big book of trains'
+        end
+        context "when modifying the object in a before-each" do
+          before do
+            comment.update_attributes! :text => 'new text'
+            blog.update_attributes! :title => 'the little book of calm'
+          end
+          it do
+            comment.text.should == 'new text'
+          end
+          it do
+            blog.title.should == 'the little book of calm'
+          end
+        end
+        context "when modifying the object in a before-all" do
+          before :all do
+            comment.update_attributes! :text => 'new text'
+            blog.update_attributes! :title => 'the little book of calm'
+          end
+          it do
+            comment.text.should == 'new text'
+          end
+          it do
+            blog.title.should == 'the little book of calm'
+          end
+        end
+        context "when not modifying the object" do
+          it do
+            comment.text.should == 'old text'
+          end
+          it do
+            blog.title.should == 'the big book of trains'
+          end
+        end
+      end
+      it "preserves the title" do
+        blog.title.should == 'the big book of trains'
+      end
+    end
+
+    context "when called in a context which is not a before-all context" do
+      before :all do
+        prefactory_add :blog
+      end
+      before do
+        @before_each_exception = nil
+        begin
+          prefactory_add(:another_blog)
+        rescue => e
+          @before_each_exception = e
+        end
+      end
+      it "raises an error in a before-each context" do
+        @before_each_exception.should be_present
+      end
+      it "raises an error in an it-context" do
+        expect { prefactory_add(:comment) }.to raise_error
+      end
+      it "works in a before-all context" do
+        prefactory(:blog).should be_present
+      end
+    end
+  end
+
+  describe "#prefactory and its method_missing :key fallback" do
+    before :all do
+      prefactory_add :blog
+    end
+    subject { prefactory(key) }
+    context "when passed a key associated with a prefactory_add'ed object" do
+      let(:key) { :blog }
+      it do
+        should be_present
+        should == blog
+        should be_a Blog
+      end
+      context "that has since been destroyed in a before-each" do
+        before { blog.destroy }
+        it do
+          should be_present
+          should be_destroyed
+          blog.should be_present
+          Blog.where(:id => blog.id).should_not exist
+        end
+      end
+      context "that has since been destroyed in a before-all" do
+        before(:all) { blog.destroy }
+        it { should be_nil }
+        it "does not raise an error when calling the key name as a method" do
+          blog.should be_nil
+        end
+      end
+    end
+    context "when passed a nonexistent key" do
+      let(:key) { :frog }
+      it do
+        should be_nil
+        expect { frog }.to raise_error(NameError)
+      end
+    end
+
+    context "with multiple before(:all) blocks" do
+      before(:all) { prefactory_add :blog }
+      before(:all) { prefactory_add :comment }
+      before(:all) { prefactory_add :another_blog, :title => blog.id.to_s }
+      it do
+        blog.should be_present
+        Blog.where(:id => blog.id).should exist
+      end
+      it do
+        comment.should be_present
+        Comment.where(:id => comment.id).should exist
+      end
+      it do
+        another_blog.title.should == blog.id.to_s
+      end
+    end
+  end
+
+  describe ".set!" do
+    set!(:blog)
+    set! :comment, :counter => 12
+    set!(:some_other_comment) do
+      FactoryGirl.create :comment, :text => blog.title
+    end
+    it do
+      blog.should be_present
+      Blog.where(:id => blog.id).should exist
+    end
+    it do
+      comment.should be_present
+      comment.counter.should == 12
+      Comment.where(:id => comment.id).should exist
+    end
+    it do
+      some_other_comment.text.should be_present
+      some_other_comment.text.should == blog.title
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+
+# Copyright (c) 2014, VMware, Inc. All Rights Reserved.
+#
+# 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.
+
+require 'rubygems'
+require 'bundler'
+require 'yaml'
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rspec/matchers'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'factory_girl_rails'
+require 'support/callback_matcher'
+require 'active_record'
+require 'database_setup'
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end
+
+unless ENV['NO_PREFACTORY']
+  require 'prefactory'
+
+  RSpec.configure do |config|
+    config.include Prefactory
+  end
+end
+

data/spec/support/callback_matcher.rb

@@ -0,0 +1,109 @@
+# encoding: UTF-8
+
+# Copyright (c) 2014, VMware, Inc. All Rights Reserved.
+#
+# 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.
+
+class CallbackMatcher
+  CALLBACK_EVENTS = [:before, :after]
+  CALLBACK_TYPES = [:create, :update, :destroy, :save, :commit]
+
+  module ActiveRecordHooks
+
+    def self.included(base)
+      base.class_eval do
+        class_attribute :callback_tester_attrs
+        self.callback_tester_attrs = []
+
+        CALLBACK_EVENTS.each do |ce|
+          CALLBACK_TYPES.each do |ct|
+            next if ce == :before && ct == :commit
+            callback_name = :"#{ce}_#{ct}"
+            callback_attr = :"called_#{callback_name}"
+
+            callback_tester_attrs << callback_attr
+            attr_accessor callback_attr
+
+            send( callback_name ) {
+              send(:"#{callback_attr}=", send(:"#{callback_attr}").to_i + 1)
+            }
+          end
+        end
+        alias_method_chain :initialize, :callback_init
+      end
+    end
+
+    def initialize_with_callback_init(*args)
+      reset_callback_flags!
+      initialize_without_callback_init(*args)
+    end
+
+    def reset_callback_flags!
+      self.class.callback_tester_attrs.each do |attr|
+        send("#{attr}=", 0)
+      end
+    end
+
+  end
+
+end
+
+require 'rspec/matchers'
+
+RSpec::Matchers.define :trigger_callbacks_for do |types|
+
+  check_for_match = ->(model_instance, types) {
+    @called = []
+    @not_called = []
+    Array.wrap(types).each do |ct|
+      CallbackMatcher::CALLBACK_EVENTS.each do |ce|
+        callback_name = "#{ce}_#{ct}"
+        result = model_instance.send("called_#{callback_name}".to_sym)
+        @called << callback_name if result
+        @not_called << callback_name unless result
+      end
+    end
+  }
+
+  match_for_should do |model_instance|
+    check_for_match.call(model_instance, types)
+    result = true
+    result = false unless @called.present?
+    result = false if @not_called.present?
+    result
+  end
+
+  match_for_should_not do |model_instance|
+    check_for_match.call(model_instance, types)
+    result = true
+    result = false unless @not_called.present?
+    result = false if @called.present?
+    result
+  end
+
+  failure_message_for_should do |actual|
+    ["Called:\t#{@called.join("\n\t")}", "Not called:\t#{@called.join("\n\t")}"].join("\n")
+  end
+
+  failure_message_for_should_not do |actual|
+    ["Called:\t#{@called.join("\n\t")}", "Not called:\t#{@called.join("\n\t")}"].join("\n")
+  end
+
+end
+