factory_girl 3.2.0 → 3.3.0

data/lib/factory_girl/syntax/sham.rb

@@ -22,11 +22,12 @@ module FactoryGirl
     # value does not provide any tangible benefits over an ascending sequence.
     #
     # This syntax was derived from Pete Yandell's machinist.
+    # @api private
     module Sham
-      module Sham #:nodoc:
+      module Sham
         def self.method_missing(name, *args, &block)
           if block_given?
-            ActiveSupport::Deprecation.warn "Sham.sequence is deprecated; use the FactoryGirl.define syntax instead", caller
+            ActiveSupport::Deprecation.warn 'Sham.sequence is deprecated; use the FactoryGirl.define syntax instead', caller
             start_value = args.first
             FactoryGirl.register_sequence(Sequence.new(name, start_value || 1, &block))
           else

data/lib/factory_girl/syntax/vintage.rb

@@ -21,7 +21,7 @@ module FactoryGirl
         # Yields: +Factory+
         # The newly created factory.
         def self.define(name, options = {})
-          ActiveSupport::Deprecation.warn "Factory.define is deprecated; use the FactoryGirl.define block syntax to declare your factory.", caller
+          ActiveSupport::Deprecation.warn 'Factory.define is deprecated; use the FactoryGirl.define block syntax to declare your factory.', caller
           factory = FactoryGirl::Factory.new(name, options)
           proxy = FactoryGirl::DefinitionProxy.new(factory)
           yield(proxy)
@@ -44,7 +44,7 @@ module FactoryGirl
         #
         #   Factory.sequence(:email) {|n| "somebody_#{n}@example.com" }
         def self.sequence(name, start_value = 1, &block)
-          ActiveSupport::Deprecation.warn "Factory.sequence is deprecated; use the FactoryGirl.define block syntax to declare your sequence.", caller
+          ActiveSupport::Deprecation.warn 'Factory.sequence is deprecated; use the FactoryGirl.define block syntax to declare your sequence.', caller
           FactoryGirl.register_sequence(Sequence.new(name, start_value, &block))
         end
 
@@ -57,7 +57,7 @@ module FactoryGirl
         # Returns:
         #   The next value in the sequence. (Object)
         def self.next(name)
-          ActiveSupport::Deprecation.warn "Factory.next is deprecated; use FactoryGirl.generate instead.", caller
+          ActiveSupport::Deprecation.warn 'Factory.next is deprecated; use FactoryGirl.generate instead.', caller
           FactoryGirl.generate(name)
         end
 
@@ -86,31 +86,31 @@ module FactoryGirl
         #   # will be used instead.
         #   Factory(:post, user_id: 1)
         def self.alias(pattern, replace)
-          ActiveSupport::Deprecation.warn "Factory.alias is deprecated; use FactoryGirl.aliases << [pattern, replace] instead.", caller
+          ActiveSupport::Deprecation.warn 'Factory.alias is deprecated; use FactoryGirl.aliases << [pattern, replace] instead.', caller
           FactoryGirl.aliases << [pattern, replace]
         end
 
         # Alias for FactoryGirl.attributes_for
         def self.attributes_for(name, overrides = {})
-          ActiveSupport::Deprecation.warn "Factory.attributes_for is deprecated; use FactoryGirl.attributes_for instead.", caller
+          ActiveSupport::Deprecation.warn 'Factory.attributes_for is deprecated; use FactoryGirl.attributes_for instead.', caller
           FactoryGirl.attributes_for(name, overrides)
         end
 
         # Alias for FactoryGirl.build
         def self.build(name, overrides = {})
-          ActiveSupport::Deprecation.warn "Factory.build is deprecated; use FactoryGirl.build instead.", caller
+          ActiveSupport::Deprecation.warn 'Factory.build is deprecated; use FactoryGirl.build instead.', caller
           FactoryGirl.build(name, overrides)
         end
 
         # Alias for FactoryGirl.create
         def self.create(name, overrides = {})
-          ActiveSupport::Deprecation.warn "Factory.create is deprecated; use FactoryGirl.create instead.", caller
+          ActiveSupport::Deprecation.warn 'Factory.create is deprecated; use FactoryGirl.create instead.', caller
           FactoryGirl.create(name, overrides)
         end
 
         # Alias for FactoryGirl.build_stubbed.
         def self.stub(name, overrides = {})
-          ActiveSupport::Deprecation.warn "Factory.stub is deprecated; use FactoryGirl.build_stubbed instead.", caller
+          ActiveSupport::Deprecation.warn 'Factory.stub is deprecated; use FactoryGirl.build_stubbed instead.', caller
           FactoryGirl.build_stubbed(name, overrides)
         end
       end
@@ -120,7 +120,7 @@ module FactoryGirl
       # Example:
       #   Factory(:user, name: 'Joe')
       def Factory(name, attrs = {})
-        ActiveSupport::Deprecation.warn "Factory(:name) is deprecated; use FactoryGirl.create(:name) instead.", caller
+        ActiveSupport::Deprecation.warn 'Factory(:name) is deprecated; use FactoryGirl.create(:name) instead.', caller
         FactoryGirl.create(name, attrs)
       end
     end

data/lib/factory_girl/syntax_runner.rb

@@ -1,4 +1,5 @@
 module FactoryGirl
+  # @api private
   class SyntaxRunner
     include Syntax::Methods
   end

data/lib/factory_girl/trait.rb

@@ -1,17 +1,18 @@
 module FactoryGirl
+  # @api private
   class Trait
-    attr_reader :name
+    attr_reader :name, :definition
 
-    def initialize(name, &block) #:nodoc:
+    def initialize(name, &block)
       @name = name
       @block = block
-      @definition = Definition.new
+      @definition = Definition.new(@name)
 
       proxy = FactoryGirl::DefinitionProxy.new(@definition)
       proxy.instance_eval(&@block) if block_given?
     end
 
-    delegate :add_callback, :declare_attribute, :to_create, :define_trait,
+    delegate :add_callback, :declare_attribute, :to_create, :define_trait, :constructor,
              :callbacks, :attributes, to: :@definition
 
     def names

data/lib/factory_girl/version.rb

@@ -1,4 +1,3 @@
 module FactoryGirl
-  VERSION = "3.2.0"
+  VERSION = '3.3.0'
 end
-

data/spec/acceptance/activesupport_instrumentation_spec.rb

@@ -1,5 +1,18 @@
 require "spec_helper"
 
+unless ActiveSupport::Notifications.respond_to?(:subscribed)
+  module SubscribedBehavior
+    def subscribed(callback, *args, &block)
+      subscriber = subscribe(*args, &callback)
+      yield
+    ensure
+      unsubscribe(subscriber)
+    end
+  end
+
+  ActiveSupport::Notifications.extend SubscribedBehavior
+end
+
 describe "using ActiveSupport::Instrumentation to track factory interaction" do
   before do
     define_model("User", email: :string)
@@ -8,7 +21,7 @@ describe "using ActiveSupport::Instrumentation to track factory interaction" do
         email "john@example.com"
 
         factory :slow_user do
-          after_build { Kernel.sleep(0.1) }
+          after(:build) { Kernel.sleep(0.1) }
         end
       end
 
@@ -22,7 +35,7 @@ describe "using ActiveSupport::Instrumentation to track factory interaction" do
       FactoryGirl.build(:slow_user)
     end
 
-    time_to_execute.should be_within(0.01).of(0.1)
+    time_to_execute.should >= 0.1
   end
 
   it "builds the correct payload" do

data/spec/acceptance/callbacks_spec.rb

@@ -6,35 +6,35 @@ describe "callbacks" do
 
     FactoryGirl.define do
       factory :user_with_callbacks, class: :user do
-        after_stub   { |user| user.first_name = 'Stubby' }
-        after_build  { |user| user.first_name = 'Buildy' }
-        after_create { |user| user.last_name  = 'Createy' }
+        after(:stub)   { |user| user.first_name = 'Stubby' }
+        after(:build)  { |user| user.first_name = 'Buildy' }
+        after(:create) { |user| user.last_name  = 'Createy' }
       end
 
       factory :user_with_inherited_callbacks, parent: :user_with_callbacks do
-        after_stub  { |user| user.last_name  = 'Double-Stubby' }
-        after_build { |user| user.first_name = 'Child-Buildy' }
+        after(:stub)  { |user| user.last_name  = 'Double-Stubby' }
+        after(:build) { |user| user.first_name = 'Child-Buildy' }
       end
     end
   end
 
-  it "runs the after_stub callback when stubbing" do
+  it "runs the after(:stub) callback when stubbing" do
     user = FactoryGirl.build_stubbed(:user_with_callbacks)
     user.first_name.should == 'Stubby'
   end
 
-  it "runs the after_build callback when building" do
+  it "runs the after(:build) callback when building" do
     user = FactoryGirl.build(:user_with_callbacks)
     user.first_name.should == 'Buildy'
   end
 
-  it "runs both the after_build and after_create callbacks when creating" do
+  it "runs both the after(:build) and after(:create) callbacks when creating" do
     user = FactoryGirl.create(:user_with_callbacks)
     user.first_name.should == 'Buildy'
     user.last_name.should == 'Createy'
   end
 
-  it "runs both the after_stub callback on the factory and the inherited after_stub callback" do
+  it "runs both the after(:stub) callback on the factory and the inherited after(:stub) callback" do
     user = FactoryGirl.build_stubbed(:user_with_inherited_callbacks)
     user.first_name.should == 'Stubby'
     user.last_name.should == 'Double-Stubby'
@@ -45,3 +45,107 @@ describe "callbacks" do
     user.first_name.should == 'Child-Buildy'
   end
 end
+
+describe "callbacks using syntax methods without referencing FactoryGirl explicitly" do
+  before do
+    define_model("User", first_name: :string, last_name: :string)
+
+    FactoryGirl.define do
+      sequence(:sequence_1)
+      sequence(:sequence_2)
+      sequence(:sequence_3)
+
+      factory :user do
+        after(:stub)   { generate(:sequence_3) }
+        after(:build)  {|user| user.first_name = generate(:sequence_1) }
+        after(:create) {|user, evaluator| user.last_name = generate(:sequence_2) }
+      end
+    end
+  end
+
+  it "works when the callback has no variables" do
+    FactoryGirl.build_stubbed(:user)
+    FactoryGirl.generate(:sequence_3).should == 2
+  end
+
+  it "works when the callback has one variable" do
+    FactoryGirl.build(:user).first_name.should == 1
+  end
+
+  it "works when the callback has two variables" do
+    FactoryGirl.create(:user).last_name.should == 1
+  end
+end
+
+describe "custom callbacks" do
+  let(:custom_before) do
+    Class.new do
+      def result(evaluation)
+        evaluation.object.tap do |instance|
+          evaluation.notify(:before_custom, instance)
+        end
+      end
+    end
+  end
+
+  let(:custom_after) do
+    Class.new do
+      def result(evaluation)
+        evaluation.object.tap do |instance|
+          evaluation.notify(:after_custom, instance)
+        end
+      end
+    end
+  end
+
+  let(:totally_custom) do
+    Class.new do
+      def result(evaluation)
+        evaluation.object.tap do |instance|
+          evaluation.notify(:totally_custom, instance)
+        end
+      end
+    end
+  end
+
+  before do
+    define_model("User", first_name: :string, last_name: :string) do
+      def name
+        [first_name, last_name].join(" ")
+      end
+    end
+
+    FactoryGirl.register_strategy(:custom_before, custom_before)
+    FactoryGirl.register_strategy(:custom_after, custom_after)
+    FactoryGirl.register_strategy(:totally_custom, totally_custom)
+
+    FactoryGirl.define do
+      factory :user do
+        first_name "John"
+        last_name  "Doe"
+
+        before(:custom) {|instance| instance.first_name = "Overridden First" }
+        after(:custom)  {|instance| instance.last_name  = "Overridden Last" }
+        callback(:totally_custom) do |instance|
+          instance.first_name = "Totally"
+          instance.last_name  = "Custom"
+        end
+      end
+    end
+  end
+
+  it "runs a custom before callback when the proper strategy executes" do
+    FactoryGirl.build(:user).name.should == "John Doe"
+    FactoryGirl.custom_before(:user).name.should == "Overridden First Doe"
+  end
+
+  it "runs a custom after callback when the proper strategy executes" do
+    FactoryGirl.build(:user).name.should == "John Doe"
+    FactoryGirl.custom_after(:user).name.should == "John Overridden Last"
+  end
+
+  it "runs a custom callback without prepending before or after when the proper strategy executes" do
+    FactoryGirl.build(:user).name.should == "John Doe"
+    FactoryGirl.totally_custom(:user).name.should == "Totally Custom"
+  end
+end

data/spec/acceptance/create_list_spec.rb

@@ -64,7 +64,7 @@ describe "multiple creates and ignored attributes to dynamically build attribute
             posts_count 5
           end
 
-          after_create do |user, evaluator|
+          after(:create) do |user, evaluator|
             FactoryGirl.create_list(:post, evaluator.posts_count, user: user)
           end
         end

data/spec/acceptance/global_initialize_with_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe 'global initialize_with' do
+  before do
+    define_class('User') do
+      attr_accessor:name
+
+      def initialize(name)
+        @name = name
+      end
+    end
+
+    define_class('Post') do
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+    end
+
+    FactoryGirl.define do
+      initialize_with { new("initialize_with") }
+
+      trait :with_initialize_with do
+        initialize_with { new("trait initialize_with") }
+      end
+
+      factory :user do
+        factory :child_user
+
+        factory :child_user_with_trait do
+          with_initialize_with
+        end
+      end
+
+      factory :post do
+        factory :child_post
+
+        factory :child_post_with_trait do
+          with_initialize_with
+        end
+      end
+    end
+  end
+
+  it 'handles base initialize_with' do
+    FactoryGirl.build(:user).name.should == 'initialize_with'
+    FactoryGirl.build(:post).name.should == 'initialize_with'
+  end
+
+  it 'handles child initialize_with' do
+    FactoryGirl.build(:child_user).name.should == 'initialize_with'
+    FactoryGirl.build(:child_post).name.should == 'initialize_with'
+  end
+
+  it 'handles child initialize_with with trait' do
+    FactoryGirl.build(:child_user_with_trait).name.should == 'trait initialize_with'
+    FactoryGirl.build(:child_post_with_trait).name.should == 'trait initialize_with'
+  end
+
+  it 'handles inline trait override' do
+    FactoryGirl.build(:child_user, :with_initialize_with).name.should == 'trait initialize_with'
+    FactoryGirl.build(:child_post, :with_initialize_with).name.should == 'trait initialize_with'
+  end
+
+  it 'uses initialize_with globally across FactoryGirl.define' do
+    define_class('Company') do
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+    end
+
+    FactoryGirl.define do
+      factory :company
+    end
+
+    FactoryGirl.build(:company).name.should == 'initialize_with'
+    FactoryGirl.build(:company, :with_initialize_with).name.should == 'trait initialize_with'
+  end
+end

data/spec/acceptance/global_to_create_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe 'global to_create' do
+  before do
+    define_model('User', name: :string)
+    define_model('Post', name: :string)
+
+    FactoryGirl.define do
+      to_create {|instance| instance.name = 'persisted!' }
+
+      trait :override_to_create do
+        to_create {|instance| instance.name = 'override' }
+      end
+
+      factory :user do
+        name 'John Doe'
+
+        factory :child_user
+
+        factory :child_user_with_trait do
+          override_to_create
+        end
+      end
+
+      factory :post do
+        name 'Great title'
+
+        factory :child_post
+
+        factory :child_post_with_trait do
+          override_to_create
+        end
+      end
+    end
+  end
+
+  it 'handles base to_create' do
+    FactoryGirl.create(:user).name.should == 'persisted!'
+    FactoryGirl.create(:post).name.should == 'persisted!'
+  end
+
+  it 'handles child to_create' do
+    FactoryGirl.create(:child_user).name.should == 'persisted!'
+    FactoryGirl.create(:child_post).name.should == 'persisted!'
+  end
+
+  it 'handles child to_create with trait' do
+    FactoryGirl.create(:child_user_with_trait).name.should == 'override'
+    FactoryGirl.create(:child_post_with_trait).name.should == 'override'
+  end
+
+  it 'handles inline trait override' do
+    FactoryGirl.create(:child_user, :override_to_create).name.should == 'override'
+    FactoryGirl.create(:child_post, :override_to_create).name.should == 'override'
+  end
+
+  it 'uses to_create globally across FactoryGirl.define' do
+    define_model('Company', name: :string)
+
+    FactoryGirl.define do
+      factory :company
+    end
+
+    FactoryGirl.create(:company).name.should == 'persisted!'
+    FactoryGirl.create(:company, :override_to_create).name.should == 'override'
+  end
+end
+
+describe 'global skip_create' do
+  before do
+    define_model('User', name: :string)
+    define_model('Post', name: :string)
+
+    FactoryGirl.define do
+      skip_create
+
+      trait :override_to_create do
+        to_create {|instance| instance.name = 'override' }
+      end
+
+      factory :user do
+        name 'John Doe'
+
+        factory :child_user
+
+        factory :child_user_with_trait do
+          override_to_create
+        end
+      end
+
+      factory :post do
+        name 'Great title'
+
+        factory :child_post
+
+        factory :child_post_with_trait do
+          override_to_create
+        end
+      end
+    end
+  end
+
+  it 'does not persist any record' do
+    FactoryGirl.create(:user).should be_new_record
+    FactoryGirl.create(:post).should be_new_record
+  end
+
+  it 'does not persist child records' do
+    FactoryGirl.create(:child_user).should be_new_record
+    FactoryGirl.create(:child_post).should be_new_record
+  end
+
+  it 'honors overridden to_create' do
+    FactoryGirl.create(:child_user_with_trait).name.should == 'override'
+    FactoryGirl.create(:child_post_with_trait).name.should == 'override'
+  end
+
+  it 'honors inline trait to_create' do
+    FactoryGirl.create(:child_user, :override_to_create).name.should == 'override'
+    FactoryGirl.create(:child_post, :override_to_create).name.should == 'override'
+  end
+end