factory_girl 3.3.0 → 3.4.0

data/GETTING_STARTED.md

@@ -762,6 +762,25 @@ factory :user do
 end
 ```
 
+You can also access all public attributes within the `initialize_with` block
+by calling `attributes`:
+
+```ruby
+factory :user do
+  ignore do
+    comments_count 5
+  end
+
+  name { Faker::Name.name }
+
+  initialize_with { new(attributes) }
+end
+```
+
+This will build a hash of all attributes to be passed to `new`. It won't
+include ignored attributes, but everything else defined in the factory will be
+passed (associations, evalued sequences, etc.)
+
 You can define `initialize_with` for all factories by including it in the
 `FactoryGirl.define` block:
 
@@ -771,6 +790,15 @@ FactoryGirl.define do
 end
 ```
 
+When using `initialize_with`, attributes accessed from the `initialize_with`
+block are assigned a second time to the instance. Duplicate assignment can be
+disabled by configuring FactoryGirl as such:
+
+    FactoryGirl.duplicate_attribute_assignment_from_initialize_with = false
+
+This would allow for attributes declared as ignored to not be ignored, since
+it won't assign them for a second time.
+
 Custom Strategies
 -----------------
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    factory_girl (3.3.0)
+    factory_girl (3.4.0)
       activesupport (>= 3.0.0)
 
 GEM

data/NEWS

@@ -1,3 +1,9 @@
+3.4.0 (June 11, 2012)
+  Sequences support Enumerators
+  Optionally disable duplicate assignment of attributes in initialize_with
+  Make hash of public attributes available in initialize_with
+  Support referring to a factory based on class name
+
 3.3.0 (May 13, 2012)
   Allow to_create, skip_create, and initialize_with to be defined globally
   Allow to_create, skip_create, and initialize_with to be defined within traits

data/gemfiles/3.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (3.3.0)
+    factory_girl (3.4.0)
       activesupport (>= 3.0.0)
 
 GEM

data/gemfiles/3.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (3.3.0)
+    factory_girl (3.4.0)
       activesupport (>= 3.0.0)
 
 GEM

data/gemfiles/3.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (3.3.0)
+    factory_girl (3.4.0)
       activesupport (>= 3.0.0)
 
 GEM

data/lib/factory_girl.rb

@@ -12,7 +12,6 @@ require 'factory_girl/strategy/create'
 require 'factory_girl/strategy/attributes_for'
 require 'factory_girl/strategy/stub'
 require 'factory_girl/strategy/null'
-require 'factory_girl/disallows_duplicates_registry'
 require 'factory_girl/registry'
 require 'factory_girl/null_factory'
 require 'factory_girl/null_object'
@@ -37,6 +36,12 @@ require 'factory_girl/syntax'
 require 'factory_girl/syntax_runner'
 require 'factory_girl/find_definitions'
 require 'factory_girl/reload'
+require 'factory_girl/decorator'
+require 'factory_girl/decorator/attribute_hash'
+require 'factory_girl/decorator/class_key_hash'
+require 'factory_girl/decorator/disallows_duplicates_registry'
+require 'factory_girl/decorator/invocation_tracker'
+require 'factory_girl/decorator/invocation_ignorer'
 require 'factory_girl/version'
 
 module FactoryGirl
@@ -50,7 +55,8 @@ module FactoryGirl
 
   class << self
     delegate :factories, :sequences, :traits, :strategies, :callback_names,
-      :to_create, :skip_create, :initialize_with, :constructor, to: :configuration
+      :to_create, :skip_create, :initialize_with, :constructor, :duplicate_attribute_assignment_from_initialize_with,
+      :duplicate_attribute_assignment_from_initialize_with=, to: :configuration
   end
 
   def self.register_factory(factory)

data/lib/factory_girl/attribute_assigner.rb

@@ -30,8 +30,28 @@ module FactoryGirl
 
     private
 
+    def method_tracking_evaluator
+      @method_tracking_evaluator ||= Decorator::AttributeHash.new(invocation_decorator.new(@evaluator), attribute_names_to_assign)
+    end
+
+    def invocation_decorator
+      if FactoryGirl.duplicate_attribute_assignment_from_initialize_with
+        Decorator::InvocationIgnorer
+      else
+        Decorator::InvocationTracker
+      end
+    end
+
+    def methods_invoked_on_evaluator
+      method_tracking_evaluator.__invoked_methods__
+    end
+
     def build_class_instance
-      @build_class_instance ||= @evaluator.instance_exec(&@instance_builder)
+      @build_class_instance ||= method_tracking_evaluator.instance_exec(&@instance_builder).tap do
+        if @instance_builder != FactoryGirl.constructor && FactoryGirl.duplicate_attribute_assignment_from_initialize_with
+          ActiveSupport::Deprecation.warn 'Accessing attributes from initialize_with when duplicate assignment is enabled is deprecated; use FactoryGirl.duplicate_attribute_assignment_from_initialize_with = false.', caller
+        end
+      end
     end
 
     def build_hash
@@ -43,7 +63,7 @@ module FactoryGirl
     end
 
     def attributes_to_set_on_instance
-      (attribute_names_to_assign - @attribute_names_assigned).uniq
+      (attribute_names_to_assign - @attribute_names_assigned - methods_invoked_on_evaluator).uniq
     end
 
     def attributes_to_set_on_hash

data/lib/factory_girl/configuration.rb

@@ -3,14 +3,18 @@ module FactoryGirl
   class Configuration
     attr_reader :factories, :sequences, :traits, :strategies, :callback_names
 
+    attr_accessor :duplicate_attribute_assignment_from_initialize_with
+
     def initialize
-      @factories      = DisallowsDuplicatesRegistry.new(Registry.new('Factory'))
-      @sequences      = DisallowsDuplicatesRegistry.new(Registry.new('Sequence'))
-      @traits         = DisallowsDuplicatesRegistry.new(Registry.new('Trait'))
+      @factories      = Decorator::DisallowsDuplicatesRegistry.new(Registry.new('Factory'))
+      @sequences      = Decorator::DisallowsDuplicatesRegistry.new(Registry.new('Sequence'))
+      @traits         = Decorator::DisallowsDuplicatesRegistry.new(Registry.new('Trait'))
       @strategies     = Registry.new('Strategy')
       @callback_names = Set.new
       @definition     = Definition.new
 
+      @duplicate_attribute_assignment_from_initialize_with = true
+
       to_create {|instance| instance.save! }
       initialize_with { new }
     end

data/lib/factory_girl/decorator.rb

@@ -0,0 +1,21 @@
+module FactoryGirl
+  class Decorator < BasicObject
+    undef_method :==
+
+    def initialize(component)
+      @component = component
+    end
+
+    def method_missing(name, *args, &block)
+      @component.send(name, *args, &block)
+    end
+
+    def send(symbol, *args)
+      __send__(symbol, *args)
+    end
+
+    def self.const_missing(name)
+      ::Object.const_get(name)
+    end
+  end
+end

data/lib/factory_girl/decorator/attribute_hash.rb

@@ -0,0 +1,17 @@
+module FactoryGirl
+  class Decorator
+    class AttributeHash < Decorator
+      def initialize(component, attributes = [])
+        super(component)
+        @attributes = attributes
+      end
+
+      def attributes
+        @attributes.inject({}) do |result, attribute_name|
+          result[attribute_name] = send(attribute_name)
+          result
+        end
+      end
+    end
+  end
+end

data/lib/factory_girl/decorator/class_key_hash.rb

@@ -0,0 +1,27 @@
+module FactoryGirl
+  class Decorator
+    class ClassKeyHash < Decorator
+      def [](key)
+        @component[symbolized_key key]
+      end
+
+      def []=(key, value)
+        @component[symbolized_key key] = value
+      end
+
+      def key?(key)
+        @component.key? symbolized_key(key)
+      end
+
+      private
+
+      def symbolized_key(key)
+        if key.respond_to?(:to_sym)
+          key.to_sym
+        else
+          key.to_s.underscore.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/factory_girl/decorator/disallows_duplicates_registry.rb

@@ -0,0 +1,13 @@
+module FactoryGirl
+  class Decorator
+    class DisallowsDuplicatesRegistry < Decorator
+      def register(name, item)
+        if registered?(name)
+          raise DuplicateDefinitionError, "#{@component.name} already registered: #{name}"
+        else
+          @component.register(name, item)
+        end
+      end
+    end
+  end
+end

data/lib/factory_girl/decorator/invocation_ignorer.rb

@@ -0,0 +1,9 @@
+module FactoryGirl
+  class Decorator
+    class InvocationIgnorer < Decorator
+      def __invoked_methods__
+        []
+      end
+    end
+  end
+end

data/lib/factory_girl/decorator/invocation_tracker.rb

@@ -0,0 +1,19 @@
+module FactoryGirl
+  class Decorator
+    class InvocationTracker < Decorator
+      def initialize(component)
+        super
+        @invoked_methods = []
+      end
+
+      def method_missing(name, *args, &block)
+        @invoked_methods << name
+        super
+      end
+
+      def __invoked_methods__
+        @invoked_methods.uniq
+      end
+    end
+  end
+end

data/lib/factory_girl/evaluator.rb

@@ -35,14 +35,10 @@ module FactoryGirl
     end
 
     def method_missing(method_name, *args, &block)
-      if @cached_attributes.key?(method_name)
-        @cached_attributes[method_name]
+      if @instance.respond_to?(method_name)
+        @instance.send(method_name, *args, &block)
       else
-        if @instance.respond_to?(method_name)
-          @instance.send(method_name, *args, &block)
-        else
-          SyntaxRunner.new.send(method_name, *args, &block)
-        end
+        SyntaxRunner.new.send(method_name, *args, &block)
       end
     end
 

data/lib/factory_girl/registry.rb

@@ -6,7 +6,7 @@ module FactoryGirl
 
     def initialize(name)
       @name  = name
-      @items = {}
+      @items = Decorator::ClassKeyHash.new({})
     end
 
     def clear
@@ -19,7 +19,7 @@ module FactoryGirl
 
     def find(name)
       if registered?(name)
-        @items[name.to_sym]
+        @items[name]
       else
         raise ArgumentError, "#{@name} not registered: #{name}"
       end
@@ -28,11 +28,11 @@ module FactoryGirl
     alias :[] :find
 
     def register(name, item)
-      @items[name.to_sym] = item
+      @items[name] = item
     end
 
     def registered?(name)
-      @items.key?(name.to_sym)
+      @items.key?(name)
     end
   end
 end

data/lib/factory_girl/sequence.rb

@@ -13,16 +13,36 @@ module FactoryGirl
       options  = args.extract_options!
       @value   = args.first || 1
       @aliases = options.fetch(:aliases) { [] }
+
+      if !@value.respond_to?(:peek)
+        @value = EnumeratorAdapter.new(@value)
+      end
     end
 
     def next
-      @proc ? @proc.call(@value) : @value
+      @proc ? @proc.call(@value.peek) : @value.peek
     ensure
-      @value = @value.next
+      @value.next
     end
 
     def names
       [@name] + @aliases
     end
+
+    private
+
+    class EnumeratorAdapter
+      def initialize(value)
+        @value = value
+      end
+
+      def peek
+        @value
+      end
+
+      def next
+        @value = @value.next
+      end
+    end
   end
 end

data/lib/factory_girl/version.rb

@@ -1,3 +1,3 @@
 module FactoryGirl
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'
 end

data/spec/acceptance/global_initialize_with_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 
 describe 'global initialize_with' do
   before do
+    ActiveSupport::Deprecation.silenced = true
+
     define_class('User') do
       attr_accessor:name
 

data/spec/acceptance/initialize_with_spec.rb

@@ -4,6 +4,8 @@ describe "initialize_with with non-FG attributes" do
   include FactoryGirl::Syntax::Methods
 
   before do
+    ActiveSupport::Deprecation.silenced = true
+
     define_model("User", name: :string, age: :integer) do
       def self.construct(name, age)
         new(name: name, age: age)
@@ -26,6 +28,8 @@ describe "initialize_with with FG attributes that are ignored" do
   include FactoryGirl::Syntax::Methods
 
   before do
+    ActiveSupport::Deprecation.silenced = true
+
     define_model("User", name: :string) do
       def self.construct(name)
         new(name: "#{name} from .construct")
@@ -51,6 +55,8 @@ describe "initialize_with with FG attributes that are not ignored" do
   include FactoryGirl::Syntax::Methods
 
   before do
+    ActiveSupport::Deprecation.silenced = true
+
     define_model("User", name: :string) do
       def self.construct(name)
         new(name: "#{name} from .construct")
@@ -75,6 +81,8 @@ describe "initialize_with non-ORM-backed objects" do
   include FactoryGirl::Syntax::Methods
 
   before do
+    ActiveSupport::Deprecation.silenced = true
+
     define_class("ReportGenerator") do
       attr_reader :name, :data
 
@@ -108,6 +116,8 @@ end
 
 describe "initialize_with parent and child factories" do
   before do
+    ActiveSupport::Deprecation.silenced = true
+
     define_class("Awesome") do
       attr_reader :name
 
@@ -148,6 +158,8 @@ end
 
 describe "initialize_with implicit constructor" do
   before do
+    ActiveSupport::Deprecation.silenced = true
+
     define_class("Awesome") do
       attr_reader :name
 
@@ -171,3 +183,79 @@ describe "initialize_with implicit constructor" do
     FactoryGirl.build(:awesome, name: "Awesome name").name.should == "Awesome name"
   end
 end
+
+describe "initialize_with doesn't duplicate assignment on attributes accessed from initialize_with" do
+  before do
+    ActiveSupport::Deprecation.silenced = true
+
+    define_class("User") do
+      attr_reader :name
+      attr_accessor :email
+
+      def initialize(name)
+        @name = name
+      end
+    end
+
+    FactoryGirl.define do
+      sequence(:email) {|n| "person#{n}@example.com" }
+
+      factory :user do
+        email
+
+        name { email.gsub(/\@.+/, "") }
+
+        initialize_with { new(name) }
+      end
+    end
+  end
+
+  it "instantiates the correct object" do
+    FactoryGirl.duplicate_attribute_assignment_from_initialize_with = false
+
+    built_user = FactoryGirl.build(:user)
+    built_user.name.should == "person1"
+    built_user.email.should == "person1@example.com"
+  end
+end
+
+describe "initialize_with has access to all attributes for construction" do
+  before do
+    ActiveSupport::Deprecation.silenced = true
+
+    define_class("User") do
+      attr_reader :name, :email, :ignored
+
+      def initialize(attributes = {})
+        @name = attributes[:name]
+        @email = attributes[:email]
+        @ignored = attributes[:ignored]
+      end
+    end
+
+    FactoryGirl.define do
+      sequence(:email) {|n| "person#{n}@example.com" }
+
+      factory :user do
+        ignore do
+          ignored "of course!"
+        end
+
+        email
+
+        name { email.gsub(/\@.+/, "") }
+
+        initialize_with { new(attributes) }
+      end
+    end
+  end
+
+  it "assigns attributes correctly" do
+    FactoryGirl.duplicate_attribute_assignment_from_initialize_with = false
+
+    user_with_attributes = FactoryGirl.build(:user)
+    user_with_attributes.email.should == "person1@example.com"
+    user_with_attributes.name.should  == "person1"
+    user_with_attributes.ignored.should be_nil
+  end
+end

data/spec/acceptance/keyed_by_class_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'finding factories keyed by class instead of symbol' do
+  before do
+    define_model("User") do
+      attr_accessor :name, :email
+    end
+
+    FactoryGirl.define do
+      factory :user do
+        name 'John Doe'
+        sequence(:email) {|n| "person#{n}@example.com" }
+      end
+    end
+  end
+
+  it 'allows interaction based on class name' do
+    user = FactoryGirl.create User, email: 'person@example.com'
+    user.email.should == 'person@example.com'
+    user.name.should == 'John Doe'
+  end
+end

data/spec/acceptance/traits_spec.rb

@@ -490,6 +490,8 @@ end
 
 describe "traits with initialize_with" do
   before do
+    ActiveSupport::Deprecation.silenced = true
+
     define_class("User") do
       attr_reader :name
 

data/spec/factory_girl/disallows_duplicates_registry_spec.rb

@@ -1,35 +1,9 @@
 require "spec_helper"
 
-describe FactoryGirl::DisallowsDuplicatesRegistry do
-  let(:registry) { stub("registry", name: "Great thing", register: true, find: true, each: true, clear: true, registered?: true, :[] => true) }
+describe FactoryGirl::Decorator::DisallowsDuplicatesRegistry do
+  let(:registry) { stub("registry", name: 'Great thing', register: true) }
 
-  subject { FactoryGirl::DisallowsDuplicatesRegistry.new(registry) }
-
-  it "delegates #each to the registry" do
-    block = -> {}
-    subject.each(block)
-    registry.should have_received(:each).with(block)
-  end
-
-  it "delegates #registered? to the registry" do
-    subject.registered?(:great_name)
-    registry.should have_received(:registered?).with(:great_name)
-  end
-
-  it "delegates #clear to the registry" do
-    subject.clear
-    registry.should have_received(:clear)
-  end
-
-  it "delegates #find to the registry" do
-    subject.find(:awesome)
-    registry.should have_received(:find).with(:awesome)
-  end
-
-  it "delegates #[] to the registry" do
-    subject[:awesome]
-    registry.should have_received(:[]).with(:awesome)
-  end
+  subject { described_class.new(registry) }
 
   it "delegates #register to the registry when not registered" do
     registry.stubs(registered?: false)
@@ -38,6 +12,7 @@ describe FactoryGirl::DisallowsDuplicatesRegistry do
   end
 
   it "raises when attempting to #register a previously registered strategy" do
+    registry.stubs(registered?: true)
     expect { subject.register(:same_name, {}) }.
       to raise_error(FactoryGirl::DuplicateDefinitionError, "Great thing already registered: same_name")
   end

data/spec/factory_girl/registry_spec.rb

@@ -57,4 +57,12 @@ describe FactoryGirl::Registry do
     subject.clear
     subject.count.should be_zero
   end
+
+  it "registers classes" do
+    define_class("User")
+    subject.register(User, registered_object)
+    subject.to_a.should == [registered_object]
+    subject.find(:user).should == registered_object
+    subject.find(User).should == registered_object
+  end
 end

data/spec/factory_girl/sequence_spec.rb

@@ -65,4 +65,14 @@ describe FactoryGirl::Sequence do
       its(:next) { should == "B" }
     end
   end
+
+  describe "iterating over items in an enumerator" do
+    subject { FactoryGirl::Sequence.new(:name, %w[foo bar].to_enum) {|n| "=#{n}" } }
+
+    it "navigates to the next items until no items remain" do
+      subject.next.should == "=foo"
+      subject.next.should == "=bar"
+      expect { subject.next }.to raise_error(StopIteration)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factory_girl
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-13 00:00:00.000000000 Z
+date: 2012-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -261,10 +261,15 @@ files:
 - lib/factory_girl/declaration/implicit.rb
 - lib/factory_girl/declaration/static.rb
 - lib/factory_girl/declaration_list.rb
+- lib/factory_girl/decorator.rb
+- lib/factory_girl/decorator/attribute_hash.rb
+- lib/factory_girl/decorator/class_key_hash.rb
+- lib/factory_girl/decorator/disallows_duplicates_registry.rb
+- lib/factory_girl/decorator/invocation_ignorer.rb
+- lib/factory_girl/decorator/invocation_tracker.rb
 - lib/factory_girl/definition.rb
 - lib/factory_girl/definition_list.rb
 - lib/factory_girl/definition_proxy.rb
-- lib/factory_girl/disallows_duplicates_registry.rb
 - lib/factory_girl/errors.rb
 - lib/factory_girl/evaluation.rb
 - lib/factory_girl/evaluator.rb
@@ -315,6 +320,7 @@ files:
 - spec/acceptance/global_initialize_with_spec.rb
 - spec/acceptance/global_to_create_spec.rb
 - spec/acceptance/initialize_with_spec.rb
+- spec/acceptance/keyed_by_class_spec.rb
 - spec/acceptance/modify_factories_spec.rb
 - spec/acceptance/modify_inherited_spec.rb
 - spec/acceptance/nested_attributes_spec.rb
@@ -423,6 +429,7 @@ test_files:
 - spec/acceptance/global_initialize_with_spec.rb
 - spec/acceptance/global_to_create_spec.rb
 - spec/acceptance/initialize_with_spec.rb
+- spec/acceptance/keyed_by_class_spec.rb
 - spec/acceptance/modify_factories_spec.rb
 - spec/acceptance/modify_inherited_spec.rb
 - spec/acceptance/nested_attributes_spec.rb

data/lib/factory_girl/disallows_duplicates_registry.rb

@@ -1,17 +0,0 @@
-module FactoryGirl
-  class DisallowsDuplicatesRegistry
-    def initialize(component)
-      @component = component
-    end
-
-    delegate :clear, :each, :find, :[], :registered?, to: :@component
-
-    def register(name, item)
-      if registered?(name)
-        raise DuplicateDefinitionError, "#{@component.name} already registered: #{name}"
-      else
-        @component.register(name, item)
-      end
-    end
-  end
-end