masa-iwasaki-factory_girl 1.2.3.1 → 1.2.3.2

data/Changelog

@@ -1,29 +1,7 @@
-1.1.4 (November 28, 2008)
-  Factory.build now uses Factory.create for associations of the built object
-  Factory definitions are now detected in subdirectories, such as
-		factories/person_factory.rb (thanks to Josh Nichols)
-  Factory definitions are now loaded after the environment in a Rails project
-		(fixes some issues with dependencies being loaded too early) (thanks to
-		Josh Nichols)
-  Factory names ending in 's' no longer cause problems (thanks to Alex Sharp
-		and Josh Owens)
-  
-1.1.3 (September 12, 2008)
-  Automatically pull in definitions from factories.rb, test/factories.rb, or
-	spec/factories.rb
-1.1.2 (July 30, 2008)
-  Improved error handling for invalid and undefined factories/attributes
-	Improved handling of strings vs symbols vs classes
-	Added a prettier syntax for handling associations
-  Updated documentation and fixed compatibility with Rails 2.1
+1.2.3.2 (January 6, 2010)
+  Bug fix for Factory.assert_valid_options.
 
-1.1.1 (June 23, 2008)
-  The attribute "name" no longer requires using #add_attribute
-
-1.1.0 (June 3, 2008)
-	Added support for dependent attributes
-	Fixed the attributes_for build strategy to not build associations
-  Added support for sequences
-
-1.0.0 (May 31, 208)
-  First version
+1.2.3.1 (January 6, 2010)
+  Rebase to 1.2.3 of an original repositry.
+  Remove disable_caches.
+	Cache definitions only :singleton option has set.

data/README.rdoc

@@ -1,5 +1,4 @@
-= What this fork added to original factory_girl
-== Caching 
+= Singleton support 
 By default, the association created by factory_girl is based on Factory#create. This means there would be twice creation for project_1 in the code shown below.
 
   # Factory definitions
@@ -26,283 +25,70 @@ By default, the association created by factory_girl is based on Factory#create.
     end
   end
 
-This fork added @@instances to Factory::Proxy::Create. @@instances keeps instances which has already created. This means you would not have the creation of a same factory and the code shown above turns green. 
+This fork added @@instances to Factory::Proxy::Create. @@instances keeps singleton instances. In this example, you can use singleton options like below.
 
-== How to enable caching of instances
-At default, all instances will be cached.  But you can toggle this option by calling these methods:
-
-- Factory::Proxy::Create.disable_cache
-- Factory::Proxy::Create.enable_cache
-
-== Other changes
-These modification affects the definitions written in some syntax. 
-
-- If you are using bluprint or sham syntax, you might need to use "Factory.create(factory_name)" explicityly instead of "Facotry(factory_name)"
-- With generate syntas, Factory.generate will raise an exception as same as Factory.generate!
-
-= factory_girl
-
-factory_girl is a fixtures replacement with a straightforward definition syntax, support for multiple build strategies (saved instances, unsaved instances, attribute hashes, and stubbed objects), and support for multiple factories for the same class (user, admin_user, and so on), including factory inheritance.
-
-== Download
-
-Github: http://github.com/thoughtbot/factory_girl/tree/master
-
-Gem:
-  gem install factory_girl --source http://gemcutter.org
-
-Note: if you install factory_girl using the gem from Gemcutter, you'll need this
-in your environment.rb if you want to use Rails 2.1+'s dependency manager:
-
-  config.gem "factory_girl", 
-			 :source => "http://gemcutter.org"
-
-== Defining factories
-
-Each factory has a name and a set of attributes. The name is used to guess the class of the object by default, but it's possible to explicitly specify it:
-
-  # This will guess the User class
-  Factory.define :user do |u|
-    u.first_name 'John'
-    u.last_name  'Doe'
-    u.admin false
-  end
-
-  # This will use the User class (Admin would have been guessed)
-  Factory.define :admin, :class => User do |u|
-    u.first_name 'Admin'
-    u.last_name  'User'
-    u.admin true
-  end
-
-  # The same, but using a string instead of class constant
-  Factory.define :admin, :class => 'user' do |u|
-    u.first_name 'Admin'
-    u.last_name  'User'
-    u.admin true
-  end
-
-It is highly recommended that you have one factory for each class that provides the simplest set of attributes necessary to create an instance of that class. If you're creating ActiveRecord objects, that means that you should only provide attributes that are required through validations and that do not have defaults. Other factories can be created through inheritance to cover common scenarios for each class.
-
-Attempting to define multiple factories with the same name will raise an error.
-
-Factories can either be defined anywhere, but will automatically be loaded if they are defined in files at the following locations:
-
-  test/factories.rb
-  spec/factories.rb
-  test/factories/*.rb
-  spec/factories/*.rb
-
-== Using factories
-
-factory_girl supports several different build strategies: build, create, attributes_for and stub:
-
-  # Returns a User instance that's not saved
-  user = Factory.build(:user)
-
-  # Returns a saved User instance
-  user = Factory.create(:user)
-
-  # Returns a hash of attributes that can be used to build a User instance:
-  attrs = Factory.attributes_for(:user)
-
-  # Returns an object with all defined attributes stubbed out:
-  stub = Factory.stub(:user)
-
-You can use the Factory method as a shortcut for the default build strategy:
-
-  # Same as Factory.create :user:
-  user = Factory(:user)
-
-The default strategy can be overriden:
-
-  # Now same as Factory.build(:user)
-  Factory.define :user, :default_strategy => :build do |u|
+  # Factory definitions
+  Factory.define :user_john, :class => User, :singleton => true do |r|
     ...
   end
 
-  user = Factory(:user)
-
-No matter which strategy is used, it's possible to override the defined attributes by passing a hash:
-
-  # Build a User instance and override the first_name property
-  user = Factory.build(:user, :first_name => 'Joe')
-  user.first_name
-  # => "Joe"
-
-== Lazy Attributes
-
-Most factory attributes can be added using static values that are evaluated when the factory is defined, but some attributes (such as associations and other attributes that must be dynamically generated) will need values assigned each time an instance is generated. These "lazy" attributes can be added by passing a block instead of a parameter:
-
-  Factory.define :user do |u|
-    # ...
-    u.activation_code { User.generate_activation_code }
-  end
-
-== Dependent Attributes
-
-Attributes can be based on the values of other attributes using the proxy that is yieled to lazy attribute blocks:
-
-  Factory.define :user do |u|
-    u.first_name 'Joe'
-    u.last_name  'Blow'
-    u.email {|a| "#{a.first_name}.#{a.last_name}@example.com".downcase }
-  end
-
-  Factory(:user, :last_name => 'Doe').email
-  # => "joe.doe@example.com"
-
-== Associations
-
-Associated instances can be generated by using the association method when
-defining a lazy attribute:
-
-  Factory.define :post do |p|
-    # ...
-    p.author {|author| author.association(:user, :last_name => 'Writely') }
-  end
-
-The behavior of the association method varies depending on the build strategy used for the parent object.
-
-  # Builds and saves a User and a Post
-  post = Factory(:post)
-  post.new_record?       # => false
-  post.author.new_record # => false
-
-  # Builds and saves a User, and then builds but does not save a Post
-  Factory.build(:post)
-  post.new_record?       # => true
-  post.author.new_record # => false
-
-Because this pattern is so common, a prettier syntax is available for defining
-associations:
-
-  # The following definitions are equivilent:
-  Factory.define :post do |p|
-    p.author {|a| a.association(:user) }
-  end
-
-  Factory.define :post do |p|
-    p.association :author, :factory => :user
-  end
-
-If the factory name is the same as the association name, the factory name can
-be left out.
-
-
-== Inheritance
-
-You can easily create multiple factories for the same class without repeating common attributes by using inheritance:
-
-  Factory.define :post do |p|
-    # the 'title' attribute is required for all posts
-    p.title 'A title'
-  end
-
-  Factory.define :approved_post, :parent => :post do |p|
-    p.approved true
-    # the 'approver' association is required for an approved post
-    p.association :approver, :factory => :user
+  Factory.define :user_bob, :class => User, :singleton => true do |r|
+    ...
   end
 
-== Sequences
+This means you would not have the creation of a same factory and the code shown above turns green. 
 
-Unique values in a specific format (for example, e-mail addresses) can be
-generated using sequences. Sequences are defined by calling Factory.sequence,
-and values in a sequence are generated by calling Factory.next:
+== Install
 
-  # Defines a new sequence
-  Factory.sequence :email do |n|
-    "person#{n}@example.com"
-  end
-
-  Factory.next :email
-  # => "person1@example.com"
-
-  Factory.next :email
-  # => "person2@example.com"
+Use a gem package at gemucutter.org
 
-Sequences can be used in lazy attributes:
+  config.gem "masa-iwasaki-factory_girl", 
+    :lib => 'factory_girl', :source => "http://gemcutter.org"
 
-  Factory.define :user do |f|
-    f.email { Factory.next(:email) }
-  end
+== Clearing caches
 
-And it's also possible to define an in-line sequence that is only used in
-a particular factory:
+You can clear cached instances anytime.
 
-  Factory.define :user do |f|
-    f.sequence(:email) {|n| "person#{n}@example.com" }
-  end
+  Factory::clear_caches
 
-== Callbacks
 
-Factory_girl makes available three callbacks for injecting some code:
+== Clear caches on every test with RSpec.
 
-* after_build  - called after a factory is built   (via Factory.build)
-* after_create - called after a factory is saved   (via Factory.create)
-* after_stub   - called after a factory is stubbed (via Factory.stub)  
+You may want to clear caches on every iteration of test. With RSpec, you can set global before 
+filter in spec/spec_helper.rb
+  Spec::Runner.configure do |config|
+    ...
 
-Examples:
+    config.before(:each) {
+      ::Factory.clear_caches
+    }
 
-  # Define a factory that calls the generate_hashed_password method after it is built 
-  Factory.define :user do |u|
-    u.after_build { |user| do_something_to(user) } 
+    ...
   end
 
-Note that you'll have an instance of the user in the block.  This can be useful.
-
-You can also define multiple types of callbacks on the same factory:
+== Clear caches on every scenario with Cucumber
 
-  Factory.define :user do |u|
-    u.after_build  { |user| do_something_to(user) } 
-    u.after_create { |user| do_something_else_to(user) }
+You can define step definition to clear caches like this.
+ 
+  Given /^I have no factory instances$/ do
+    ::Factory.clear_caches
   end
 
-Factories can also define any number of the same kind of callback.  These callbacks will be executed in the order they are specified:
+= Other modifications
+== Show model name on validation error
+For easy debugging,  this fork overwrites validation error messages of an instance in factory_girl/proxy/create.rb.
 
-  Factory.define :user do |u|
-    u.after_create { this_runs_first } 
-    u.after_create { then_this } 
+  begin
+    @instance.save!
+    run_callbacks(:after_create)
+  rescue => e 
+    n = Exception.new("#{@instance.class.to_s} #{e.message}")
+    n.set_backtrace(e.backtrace)
+    raise n
   end
 
-Calling Factory.create will invoke both after_build and after_create callbacks.  
-
-Also, like standard attributes, child factories will inherit (and can define additional) callbacks from their parent factory.
-
-== Alternate Syntaxes
-
-Users' tastes for syntax vary dramatically, but most users are looking for a common feature set. Because of this, factory_girl supports "syntax layers" which provide alternate interfaces. See Factory::Syntax for information about the various layers available.
-
-== More Information
-
-Our blog: http://giantrobots.thoughtbot.com
-
-factory_girl rdoc: http://rdoc.info/projects/thoughtbot/factory_girl
-
-Mailing list: http://groups.google.com/group/factory_girl
-
-factory_girl issues: http://github.com/thoughtbot/factory_girl/issues
-
-== Contributing
-
-Please read the contribution guidelines before submitting patches or pull requests.
-
-== Author
-
-factory_girl was written by Joe Ferris with contributions from several authors, including:
-* Alex Sharp
-* Eugene Bolshakov
-* Jon Yurek
-* Josh Nichols
-* Josh Owens
-* Nate Sutton
-
-The syntax layers are derived from software written by the following authors:
-* Pete Yandell
-* Rick Bradley
-* Yossef Mendelssohn
+= Original repositry
 
-Thanks to all members of thoughtbot for inspiration, ideas, and funding.
+http://github.com/thoughtbot/factory_girl[http://github.com/thoughtbot/factory_girl]
 
 Copyright 2008-2009 Joe Ferris and thoughtbot[http://www.thoughtbot.com], inc.

data/Rakefile

@@ -38,7 +38,7 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name        = %q{masa-iwasaki-factory_girl}
-  s.version     = "1.2.3.1"
+  s.version     = "1.2.3.2"
   s.summary     = %q{factory_girl with singleton support}
   s.description = %q{This forked factory_girl has been added a singleton 
                      support. You can specify ':singleton => true' option

data/lib/factory_girl/factory.rb

@@ -3,7 +3,7 @@ class Factory
   # Raised when a factory is defined that attempts to instantiate itself.
   class AssociationDefinitionError < RuntimeError
   end
-  
+
   # Raised when a callback is defined that has an invalid name
   class InvalidCallbackNameError < RuntimeError
   end
@@ -26,7 +26,7 @@ class Factory
   self.definition_file_paths = %w(factories test/factories spec/factories)
 
   attr_reader :factory_name #:nodoc:
-  attr_reader :singleton #:nodoc:
+  attr_reader :is_singleton #:nodoc:
   attr_reader :attributes #:nodoc:
 
   # Defines a new factory that can be used by the build strategies (create and
@@ -56,13 +56,13 @@ class Factory
     if parent = options.delete(:parent)
       instance.inherit_from(Factory.factory_by_name(parent))
     end    
-    if singleton = options.delete(:singleton)
-      instance.singleton = true
+    if options.delete(:singleton)
+      instance.singleton(true)
     end
     if self.factories[instance.factory_name] 
       raise DuplicateDefinitionError, "Factory already defined: #{name}"
     end
-    
+
     self.factories[instance.factory_name] = instance
   end
 
@@ -70,7 +70,11 @@ class Factory
   def self.clear_caches
     ::Factory::Proxy::Create.clear_caches
   end
-  
+
+  def singleton(bool) #:nodoc:
+    @is_singleton = bool
+  end 
+
   def class_name #:nodoc:
     @options[:class] || factory_name
   end
@@ -78,7 +82,7 @@ class Factory
   def build_class #:nodoc:
     @build_class ||= class_for(class_name)
   end
-  
+
   def default_strategy #:nodoc:
     @options[:default_strategy] || :create
   end
@@ -87,10 +91,10 @@ class Factory
     assert_valid_options(options)
     @factory_name = factory_name_for(name)
     @options      = options      
-    @singleton    = false
+    @is_singleton = false
     @attributes   = []
   end
-  
+
   def inherit_from(parent) #:nodoc:
     @options[:class] ||= parent.class_name
     parent.attributes.each do |attribute|
@@ -205,26 +209,26 @@ class Factory
     s = Sequence.new(&block)
     add_attribute(name) { s.next }
   end
-  
+
   def after_build(&block)
     callback(:after_build, &block)
   end
-  
+
   def after_create(&block)
     callback(:after_create, &block)
   end
-  
+
   def after_stub(&block)
     callback(:after_stub, &block)
   end
-  
+
   def callback(name, &block)
     unless [:after_build, :after_create, :after_stub].include?(name.to_sym)
       raise InvalidCallbackNameError, "#{name} is not a valid callback name. Valid callback names are :after_build, :after_create, and :after_stub"
     end
     @attributes << Attribute::Callback.new(name.to_sym, block)
   end
-  
+
   # Generates and returns a Hash of attributes from this factory. Attributes
   # can be individually overridden by passing in a Hash of attribute => value
   # pairs.
@@ -277,7 +281,7 @@ class Factory
   def self.create (name, overrides = {})
     factory_by_name(name).run(Proxy::Create, overrides)
   end
-  
+
   # Generates and returns an object with all attributes from this factory
   # stubbed out. Attributes can be individually overridden by passing in a Hash
   # of attribute => value pairs.
@@ -293,7 +297,7 @@ class Factory
   def self.stub (name, overrides = {})
     factory_by_name(name).run(Proxy::Stub, overrides)
   end
-  
+
   # Executes the default strategy for the given factory. This is usually create,
   # but it can be overridden for each factory.
   #
@@ -332,7 +336,7 @@ class Factory
       end
     end
     proxy.factory_name = factory_name
-    proxy.singleton = singleton
+    proxy.is_singleton = is_singleton
     proxy.result
   end
 
@@ -375,13 +379,13 @@ class Factory
   end
 
   def assert_valid_options(options)
-    invalid_keys = options.keys - [:class, :parent, :default_strategy] 
+    invalid_keys = options.keys - [:class, :parent, :default_strategy, :singleton] 
     unless invalid_keys == []
       raise ArgumentError, "Unknown arguments: #{invalid_keys.inspect}"
     end
     assert_valid_strategy(options[:default_strategy]) if options[:default_strategy]
   end
-  
+
   def assert_valid_strategy(strategy)
     unless Factory::Proxy.const_defined? variable_name_to_class_name(strategy)
       raise ArgumentError, "Unknown strategy: #{strategy}"
@@ -401,14 +405,14 @@ class Factory
   def variable_name_to_class_name(name)
     name.to_s.
       gsub(/\/(.?)/) { "::#{$1.upcase}" }.
-      gsub(/(?:^|_)(.)/) { $1.upcase }
+    gsub(/(?:^|_)(.)/) { $1.upcase }
   end
 
   # From ActiveSupport
   def symbolize_keys(hash)
     hash.inject({}) do |options, (key, value)|
       options[(key.to_sym rescue key) || key] = value
-      options
+    options
     end
   end
 

data/lib/factory_girl/proxy.rb

@@ -4,7 +4,7 @@ class Factory
 
     attr_reader :callbacks
     attr_accessor :factory_name
-    attr_accessor :singleton
+    attr_accessor :is_singleton
 
     def initialize(klass)
     end

data/lib/factory_girl/proxy/create.rb

@@ -46,7 +46,7 @@ class Factory
       # Try to use a cache. Instances to be cached is set :singleton
       # option when you call Factory.define .
       def try
-        if singleton
+        if is_singleton
           if @@instances[factory_name].nil? 
             @@instances[factory_name] = save_instance
           else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: masa-iwasaki-factory_girl
 version: !ruby/object:Gem::Version 
-  version: 1.2.3.1
+  version: 1.2.3.2
 platform: ruby
 authors: 
 - Masatoshi Iwasaki