factory_girl 3.1.1 → 3.2.0

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/tmp/"
+end

data/GETTING_STARTED.md

@@ -130,6 +130,24 @@ factory :user do
 end
 ```
 
+In addition to running other methods dynamically, you can use FactoryGirl's
+syntax methods (like `build`, `create`, and `generate`) within dynamic
+attributes without having to prefix the call with `FactoryGirl.`. This allows
+you to do:
+
+```ruby
+sequence(:random_string) {|n| LoremIpsum.generate }
+
+factory :post do
+  title { generate(:random_string) } # instead of FactoryGirl.generate(:random_string)
+end
+
+factory :comment do
+  post
+  body { generate(:random_string) }  # instead of FactoryGirl.generate(:random_string)
+end
+```
+
 Aliases
 -------
 
@@ -372,7 +390,7 @@ Or in lazy attributes:
 
 ```ruby
 factory :invite do
-  invitee { FactoryGirl.generate(:email) }
+  invitee { generate(:email) }
 end
 ```
 
@@ -684,7 +702,7 @@ Custom Construction
 If you want to use factory_girl to construct an object where some attributes
 are passed to `initialize` or if you want to do something other than simply
 calling `new` on your build class, you can override the default behavior by
-defining `to_initialize` on your factory. Example:
+defining `initialize_with` on your factory. Example:
 
 ```ruby
 # user.rb
@@ -705,7 +723,7 @@ factory :user do
   end
 
   email
-  initialize_with { User.new(name) }
+  initialize_with { new(name) }
 end
 
 FactoryGirl.build(:user).name # Bob Hope
@@ -727,6 +745,132 @@ You can override the initializer in order to:
 * Use a method other than `new` to instantiate the instance
 * Do crazy things like decorate the instance after it's built
 
+When using `initialize_with`, you don't have to declare the class itself when
+calling `new`; however, any other class methods you want to call will have to
+be called on the class explicitly.
+
+For example:
+
+```ruby
+factory :user do
+  ignore do
+    name { Faker::Name.name }
+  end
+
+  initialize_with { User.build_with_name(name) }
+end
+```
+
+Custom Strategies
+-----------------
+
+There are times where you may want to extend behavior of factory\_girl by
+adding a custom build strategy.
+
+Strategies define two methods: `association` and `result`. `association`
+receives a `FactoryGirl::FactoryRunner` instance, upon which you can call
+`run`, overriding the strategy if you want. The second method, `result`,
+receives a `FactoryGirl::Evaluation` instance. It provides a way to trigger
+callbacks (with `notify`), `object` or `hash` (to get the result instance or a
+hash based on the attributes defined in the factory), and `create`, which
+executes the `to_create` callback defined on the factory.
+
+To understand how factory\_girl uses strategies internally, it's probably
+easiest to just view the source for each of the four default strategies.
+
+Inheritance can occasionally be useful; here's an example of inheriting from
+`FactoryGirl::Strategy::Create` to build a JSON representation of your model.
+
+```ruby
+class JsonStrategy
+  def initialize
+    @strategy = FactoryGirl.strategy_by_name(:create).new
+  end
+
+  delegate :association, to: :@strategy
+
+  def result(evaluation)
+    @strategy.result(evaluation).to_json
+  end
+end
+```
+
+For factory\_girl to recognize the new strategy, you can register it:
+
+```ruby
+FactoryGirl.register_strategy(:json, JsonStrategy)
+```
+
+This allows you to call
+
+```ruby
+FactoryGirl.json(:user)
+```
+
+Finally, you can override factory\_girl's own strategies if you'd like by
+registering a new object in place of the strategies.
+
+Custom Methods to Persist Objects
+---------------------------------
+
+By default, creating a record will call `save!` on the instance; since this
+may not always be ideal, you can override that behavior by defining
+`to_create` on the factory:
+
+```ruby
+factory :different_orm_model do
+  to_create {|instance| instance.persist! }
+end
+```
+
+To disable the persistence method altogether on create, you can `skip_create`
+for that factory:
+
+```ruby
+factory :user_without_database do
+  skip_create
+end
+```
+
+ActiveSupport Instrumentation
+-----------------------------
+
+In order to track what factories are created (and with what build strategy),
+`ActiveSupport::Notifications` are included to provide a way to subscribe to
+factories being run. One example would be to track factories based on a
+threshold of execution time.
+
+```ruby
+ActiveSupport::Notifications.subscribe("factory_girl.run_factory") do |name, start, finish, id, payload|
+  execution_time_in_seconds = finish - start
+
+  if execution_time_in_seconds >= 0.5
+    $stderr.puts "Slow factory: #{payload[:name]} using strategy #{payload[:strategy]}"
+  end
+end
+```
+
+Another example would be tracking all factories and how they're used
+throughout your test suite. If you're using RSpec, it's as simple as adding a
+`before(:suite)` and `after(:suite)`:
+
+```ruby
+config.before(:suite) do
+  @factory_girl_results = {}
+  ActiveSupport::Notifications.subscribe("factory_girl.run_factory") do |name, start, finish, id, payload|
+    factory_name = payload[:name]
+    strategy_name = payload[:strategy]
+    @factory_girl_results[factory_name] ||= {}
+    @factory_girl_results[factory_name][strategy_name] ||= 0
+    @factory_girl_results[factory_name][strategy_name] += 1
+  end
+end
+
+config.after(:suite) do
+  puts @factory_girl_results
+end
+```
+
 Cucumber Integration
 --------------------
 

data/Gemfile.lock

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

data/NEWS

@@ -1,3 +1,11 @@
+3.2.0 (April 24, 2012)
+  Use AS::Notifications for pub/sub to track running factories
+  Call new within initialize_with implicitly on the build class
+  Skip to_create with skip_create
+  Allow registration of custom strategies
+  Deprecate alternate syntaxes
+  Implicitly call factory_girl's syntax methods from dynamic attributes
+
 3.1.0 (April 6, 2012)
   Sequences support aliases, which reference the same block
   Update documentation

data/features/support/env.rb

@@ -1,7 +1,6 @@
 PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
 
 require "simplecov"
-SimpleCov.start
 
 $: << File.join(PROJECT_ROOT, 'lib')
 

data/gemfiles/3.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (3.1.1)
+    factory_girl (3.2.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.1.1)
+    factory_girl (3.2.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.1.1)
+    factory_girl (3.2.0)
       activesupport (>= 3.0.0)
 
 GEM

data/lib/factory_girl.rb

@@ -1,4 +1,5 @@
 require "active_support/core_ext/module/delegation"
+require "active_support/notifications"
 
 require 'factory_girl/errors'
 require 'factory_girl/factory_runner'
@@ -8,6 +9,7 @@ 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'
@@ -18,7 +20,7 @@ require 'factory_girl/evaluator'
 require 'factory_girl/evaluator_class_definer'
 require 'factory_girl/attribute'
 require 'factory_girl/callback'
-require 'factory_girl/callback_runner'
+require 'factory_girl/callbacks_observer'
 require 'factory_girl/declaration_list'
 require 'factory_girl/declaration'
 require 'factory_girl/sequence'
@@ -28,17 +30,21 @@ require 'factory_girl/aliases'
 require 'factory_girl/definition'
 require 'factory_girl/definition_proxy'
 require 'factory_girl/syntax'
+require 'factory_girl/syntax_runner'
 require 'factory_girl/find_definitions'
 require 'factory_girl/reload'
 require 'factory_girl/version'
 
 module FactoryGirl
   def self.factories
-    @factories ||= Registry.new("Factory")
+    @factories ||= DisallowsDuplicatesRegistry.new(Registry.new("Factory"))
   end
 
   def self.register_factory(factory)
-    factories.add(factory)
+    factory.names.each do |name|
+      factories.register(name, factory)
+    end
+    factory
   end
 
   def self.factory_by_name(name)
@@ -46,11 +52,14 @@ module FactoryGirl
   end
 
   def self.sequences
-    @sequences ||= Registry.new("Sequence")
+    @sequences ||= DisallowsDuplicatesRegistry.new(Registry.new("Sequence"))
   end
 
   def self.register_sequence(sequence)
-    sequences.add(sequence)
+    sequence.names.each do |name|
+      sequences.register(name, sequence)
+    end
+    sequence
   end
 
   def self.sequence_by_name(name)
@@ -58,18 +67,52 @@ module FactoryGirl
   end
 
   def self.traits
-    @traits ||= Registry.new("Trait")
+    @traits ||= DisallowsDuplicatesRegistry.new(Registry.new("Trait"))
   end
 
   def self.register_trait(trait)
-    traits.add(trait)
+    trait.names.each do |name|
+      traits.register(name, trait)
+    end
+    trait
   end
 
   def self.trait_by_name(name)
     traits.find(name)
   end
 
+  def self.strategies
+    @strategies ||= Registry.new("Strategy")
+  end
+
+  def self.register_strategy(strategy_name, strategy_class)
+    strategies.register(strategy_name, strategy_class)
+
+    FactoryGirl::Syntax::Methods.module_exec do
+      define_method(strategy_name) do |name, *traits_and_overrides, &block|
+        instrumentation_payload = { name: name, strategy: strategy_name }
+
+        ActiveSupport::Notifications.instrument("factory_girl.run_factory", instrumentation_payload) do
+          FactoryRunner.new(name, strategy_class, traits_and_overrides).run(&block)
+        end
+      end
+    end
+  end
+
+  def self.strategy_by_name(name)
+    strategies.find(name)
+  end
+
+  def self.register_default_strategies
+    FactoryGirl.register_strategy(:build,          FactoryGirl::Strategy::Build)
+    FactoryGirl.register_strategy(:create,         FactoryGirl::Strategy::Create)
+    FactoryGirl.register_strategy(:attributes_for, FactoryGirl::Strategy::AttributesFor)
+    FactoryGirl.register_strategy(:build_stubbed,  FactoryGirl::Strategy::Stub)
+  end
+
   def self.callback_names
     [:after_build, :after_create, :after_stub, :before_create].freeze
   end
 end
+
+FactoryGirl.register_default_strategies

data/lib/factory_girl/attribute.rb

@@ -15,7 +15,7 @@ module FactoryGirl
     end
 
     def to_proc
-      lambda { }
+      -> { }
     end
 
     def association?

data/lib/factory_girl/attribute/association.rb

@@ -12,7 +12,7 @@ module FactoryGirl
       def to_proc
         factory   = @factory
         overrides = @overrides
-        lambda { association(factory, overrides) }
+        -> { association(factory, overrides) }
       end
 
       def association?

data/lib/factory_girl/attribute/dynamic.rb

@@ -9,7 +9,7 @@ module FactoryGirl
       def to_proc
         block = @block
 
-        lambda {
+        -> {
           value = block.arity == 1 ? block.call(self) : instance_exec(&block)
           raise SequenceAbuseError if FactoryGirl::Sequence === value
           value

data/lib/factory_girl/attribute/sequence.rb

@@ -9,7 +9,7 @@ module FactoryGirl
 
       def to_proc
         sequence = @sequence
-        lambda { FactoryGirl.generate(sequence) }
+        -> { FactoryGirl.generate(sequence) }
       end
     end
 

data/lib/factory_girl/attribute/static.rb

@@ -8,7 +8,7 @@ module FactoryGirl
 
       def to_proc
         value = @value
-        lambda { value }
+        -> { value }
       end
     end
   end

data/lib/factory_girl/attribute_assigner.rb

@@ -1,6 +1,7 @@
 module FactoryGirl
   class AttributeAssigner
-    def initialize(evaluator, &instance_builder)
+    def initialize(evaluator, build_class, &instance_builder)
+      @build_class = build_class
       @instance_builder         = instance_builder
       @evaluator                = evaluator
       @attribute_list           = evaluator.class.attribute_list
@@ -18,7 +19,7 @@ module FactoryGirl
     end
 
     def hash
-      @evaluator.instance = NullObject.new
+      @evaluator.instance = build_hash
 
       attributes_to_set_on_hash.inject({}) do |result, attribute|
         result[attribute] = get(attribute)
@@ -32,6 +33,10 @@ module FactoryGirl
       @build_class_instance ||= @evaluator.instance_exec(&@instance_builder)
     end
 
+    def build_hash
+      @build_hash ||= NullObject.new(hash_instance_methods_to_respond_to)
+    end
+
     def get(attribute_name)
       @evaluator.send(attribute_name)
     end
@@ -61,7 +66,11 @@ module FactoryGirl
     end
 
     def override_names
-      @evaluator.__overrides.keys
+      @evaluator.__override_names__
+    end
+
+    def hash_instance_methods_to_respond_to
+      @attribute_list.map(&:name) + override_names + @build_class.instance_methods
     end
 
     def alias_names_to_ignore