factory_girl 4.5.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b66b3ff9ce2ea6a436ba4beb95761498dd26152
-  data.tar.gz: ce844f3fb80089bf0f88fed59de2b5a00aef949d
+  metadata.gz: fa9eb22350ba005f4e5f9a78f10e5dd825035c21
+  data.tar.gz: 2dcd957723bd03f85b6dbc4a674f031873a29a90
 SHA512:
-  metadata.gz: 4ae8b04a6f0c57e39b6361e48d098b5f91f8f12f01f8ad78e82467f7c6d664fb075ec8f3002ca42815d5d9a3460a70ac7c168dd9afc654d7385d4a705b6a4ae0
-  data.tar.gz: 8dd8a73ad04e9fbc5725959108366f6e9970204f24f0f81e66c65387a09a32c22a094ffde3ff75504c62ca2a9f8efb327d84f81cf954afa75a3026750a6cb10e
+  metadata.gz: c3b3e8264c3284d727289be55a71a8f641b801e5610f9261e3caa5d35894fba887d8d23e518e61562751ea25d4d2fcb4a704a0d2132d18e7a0f5fadfedc474df
+  data.tar.gz: 2bab54b8012900039840a4259c4c5cb98378a312f899530825b4743de4bb1c9d344920cb1073a63e057b7e99b19e06c75c001d1f53fb7ba3c559310b48f9b42b

data/.travis.yml

@@ -2,18 +2,38 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.2
+  - 2.3.0
   - jruby-19mode
+  - rbx-2
 before_install:
   - gem update --system
-install: "bundle install"
-script: "bundle exec rake spec:unit spec:acceptance features"
-jdk:
-  - openjdk6
+  - gem update bundler
+  - gem cleanup bundler
+install: "bundle install --jobs 8"
+script: "bundle exec rake"
 gemfile:
-  - gemfiles/3.1.gemfile
   - gemfiles/3.2.gemfile
   - gemfiles/4.0.gemfile
   - gemfiles/4.1.gemfile
+  - gemfiles/4.2.gemfile
+  - gemfiles/5.0.gemfile
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: jruby-19mode
+      gemfile: gemfiles/5.0.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/5.0.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/5.0.gemfile
+    - rvm: 2.1.0
+      gemfile: gemfiles/5.0.gemfile
+    - rvm: rbx-2
+      gemfile: gemfiles/5.0.gemfile
 branches:
   only:
     - master
+
+sudo: false
+cache: bundler

data/Appraisals

@@ -1,15 +1,19 @@
-appraise "3.1" do
-  gem "activerecord", "~> 3.1.12"
-end
-
 appraise "3.2" do
-  gem "activerecord", "~> 3.2.15"
+  gem "activerecord", git: 'https://github.com/rails/rails.git', branch: '3-2-stable'
 end
 
 appraise '4.0' do
-  gem 'activerecord', "~> 4.0.1"
+  gem 'activerecord', "~> 4.0.13"
 end
 
 appraise '4.1' do
-  gem 'activerecord', "~> 4.1.1"
+  gem 'activerecord', "~> 4.1.14"
+end
+
+appraise '4.2' do
+  gem 'activerecord', "~> 4.2.5.1"
+end
+
+appraise '5.0' do
+  gem 'activerecord', "~> 5.0.0.beta2"
 end

data/CONTRIBUTING.md

@@ -1,10 +1,48 @@
-Contributing to factory\_girl:
+# Contributing to Factory Girl
 
-1. Fork the [official repository](https://github.com/thoughtbot/factory_girl/tree/master).
-2. Make your changes in a topic branch.
-3. Send a pull request.
+We love pull requests from everyone. By participating in this project, you
+agree to abide by the thoughtbot [code of conduct].
 
-Notes:
+[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
 
-* Contributions without tests won't be accepted.
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/thoughtbot/factory_girl/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork][fork] the [official repository][repo].
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Add, commit, and push your changes.
+5. [Submit a pull request.][pr]
+
+## Notes
+* Please add tests if you changed code. Contributions without tests won't be accepted.
 * Please don't update the Gem version.
+
+[repo]: https://github.com/thoughtbot/factory_girl/tree/master
+[fork]: https://help.github.com/articles/fork-a-repo/
+[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
+[pr]: https://help.github.com/articles/using-pull-requests/
+
+Inspired by https://github.com/middleman/middleman-heroku/blob/master/CONTRIBUTING.md

data/GETTING_STARTED.md

@@ -35,12 +35,28 @@ RSpec.configure do |config|
   config.include FactoryGirl::Syntax::Methods
 end
 
+# RSpec without Rails
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  config.before(:suite) do
+    FactoryGirl.find_definitions
+  end
+end
+
+Remember to require the above file in your spec_helper since the support folder isn't eagerly loaded
+
+```ruby
+require 'support/factory_girl'
+```
+
 # Test::Unit
 class Test::Unit::TestCase
   include FactoryGirl::Syntax::Methods
 end
 
 # Cucumber
+# env.rb (Rails example location - RAILS_ROOT/features/support/env.rb)
 World(FactoryGirl::Syntax::Methods)
 
 # Spinach
@@ -48,74 +64,24 @@ class Spinach::FeatureSteps
   include FactoryGirl::Syntax::Methods
 end
 
-# MiniTest
-class MiniTest::Unit::TestCase
+# Minitest
+class Minitest::Unit::TestCase
   include FactoryGirl::Syntax::Methods
 end
 
-# MiniTest::Spec
-class MiniTest::Spec
+# Minitest::Spec
+class Minitest::Spec
   include FactoryGirl::Syntax::Methods
 end
 
 # minitest-rails
-class MiniTest::Rails::ActiveSupport::TestCase
+class ActiveSupport::TestCase
   include FactoryGirl::Syntax::Methods
 end
 ```
 
 If you do not include `FactoryGirl::Syntax::Methods` in your test suite, then all factory_girl methods will need to be prefaced with `FactoryGirl`.
 
-Linting Factories
------------------
-
-factory_girl allows for linting known factories:
-
-```ruby
-FactoryGirl.lint
-```
-
-`FactoryGirl.lint` builds each factory and subsequently calls `#valid?` on it
-(if `#valid?` is defined); if any calls to `#valid?` return `false`,
-`FactoryGirl::InvalidFactoryError` is raised with a list of the offending
-factories. Recommended usage of `FactoryGirl.lint` is to invoke this once
-before the test suite is run.
-
-With RSpec:
-
-```ruby
-# spec/support/factory_girl.rb
-RSpec.configure do |config|
-  # additional factory_girl configuration
-
-  config.before(:suite) do
-    begin
-      DatabaseCleaner.start
-      FactoryGirl.lint
-    ensure
-      DatabaseCleaner.clean
-    end
-  end
-end
-```
-
-After calling `FactoryGirl.lint`, you'll likely want to clear out the
-database, as built factories will create associated records. The provided
-example above uses the database_cleaner gem to clear out the database; be sure
-to add the gem to your Gemfile under the appropriate groups.
-
-You can lint factories selectively by passing only factories you want linted:
-
-```ruby
-factories_to_lint = FactoryGirl.factories.reject do |factory|
-  factory.name =~ /^old_/
-end
-
-FactoryGirl.lint factories_to_lint
-```
-
-This would lint all factories that aren't prefixed with `old_`.
-
 Defining factories
 ------------------
 
@@ -143,8 +109,9 @@ It is highly recommended that you have one factory for each class that provides
 
 Attempting to define multiple factories with the same name will raise an error.
 
-Factories can be defined anywhere, but will be automatically loaded if they
-are defined in files at the following locations:
+Factories can be defined anywhere, but will be automatically loaded after
+calling `FactoryGirl.find_definitions` if factories are defined in files at the
+following locations:
 
     test/factories.rb
     spec/factories.rb
@@ -201,10 +168,18 @@ factory :user do
 end
 ```
 
+Because of the block syntax in Ruby, defining attributes as `Hash`es (for
+serialized/JSON columns, for example) requires two sets of curly brackets:
+
+```ruby
+factory :program do
+  configuration { { auto_resolve: false, auto_define: true } }
+end
+```
+
 Aliases
 -------
-
-Aliases allow you to use named associations more easily.
+FactoryGirl allows you to define aliases to existing factories to make them easier to re-use. This could come in handy when, for example, your Post object has a author attribute that actually refers to an instance of a User class. While normally FactoryGirl can infer the factory name from the association name, in this case it will look for a author factory in vain. So, alias your user factory so it can be used under alias names.
 
 ```ruby
 factory :user, aliases: [:author, :commenter] do
@@ -278,6 +253,22 @@ you would expect. If you need to access the evaluator in a factory_girl callback
 you'll need to declare a second block argument (for the evaluator) and access
 transient attributes from there.
 
+Method Name / Reserved Word Attributes
+-------------------------------
+
+If your attributes conflict with existing methods or reserved words you can define them with `add_attribute`.
+
+```ruby
+factory :dna do
+  add_attribute(:sequence) { 'GATTACA' }
+end
+
+factory :payment do
+  add_attribute(:method) { 'paypal' }
+end
+
+```
+
 Associations
 ------------
 
@@ -381,6 +372,57 @@ create(:user_with_posts).posts.length # 5
 create(:user_with_posts, posts_count: 15).posts.length # 15
 ```
 
+Generating data for a `has_and_belongs_to_many` relationship is very similar 
+to the above `has_many` relationship, with a small change, you need to pass an 
+array of objects to the model's pluralized attribute name rather than a single 
+object to the singular version of the attribute name.
+
+Here's an example with two models that are related via
+ `has_and_belongs_to_many`: 
+
+```ruby
+FactoryGirl.define do
+
+  # language factory with a `belongs_to` association for the profile
+  factory :language do
+    title "Through the Looking Glass"
+    profile
+  end
+
+  # profile factory without associated languages
+  factory :profile do
+    name "John Doe"
+
+    # profile_with_languages will create language data after the profile has 
+    # been created
+    factory :profile_with_languages do
+      # languages_count is declared as an ignored attribute and available in
+      # attributes on the factory, as well as the callback via the evaluator
+      transient do
+        languages_count 5
+      end
+
+      # the after(:create) yields two values; the profile instance itself and 
+      # the evaluator, which stores all values from the factory, including 
+      # ignored attributes; `create_list`'s second argument is the number of 
+      # records to create and we make sure the profile is associated properly 
+      # to the language
+      after(:create) do |profile, evaluator|
+        create_list(:language, evaluator.languages_count, profiles: [profile])
+      end
+    end
+  end
+end
+```
+
+This allows us to do:
+
+```ruby
+create(:profile).languages.length # 0
+create(:profile_with_languages).languages.length # 5
+create(:profile_with_languages, languages_count: 15).languages.length # 15
+```
+
 Inheritance
 -----------
 
@@ -866,6 +908,80 @@ built_users   = build_pair(:user) # array of two built users
 created_users = create_pair(:user) # array of two created users
 ```
 
+Linting Factories
+-----------------
+
+factory_girl allows for linting known factories:
+
+```ruby
+FactoryGirl.lint
+```
+
+`FactoryGirl.lint` creates each factory and catches any exceptions raised
+during the creation process. `FactoryGirl::InvalidFactoryError` is raised with
+a list of factories (and corresponding exceptions) for factories which could
+not be created.
+
+Recommended usage of `FactoryGirl.lint`
+is to run this in a task
+before your test suite is executed.
+Running it in a `before(:suite)`,
+will negatively impact the performance
+of your tests
+when running single tests.
+
+Example Rake task:
+
+```ruby
+# lib/tasks/factory_girl.rake
+namespace :factory_girl do
+  desc "Verify that all FactoryGirl factories are valid"
+  task lint: :environment do
+    if Rails.env.test?
+      begin
+        DatabaseCleaner.start
+        FactoryGirl.lint
+      ensure
+        DatabaseCleaner.clean
+      end
+    else
+      system("bundle exec rake factory_girl:lint RAILS_ENV='test'")
+    end
+  end
+end
+```
+
+After calling `FactoryGirl.lint`, you'll likely want to clear out the
+database, as records will most likely be created. The provided example above
+uses the database_cleaner gem to clear out the database; be sure to add the
+gem to your Gemfile under the appropriate groups.
+
+You can lint factories selectively by passing only factories you want linted:
+
+```ruby
+factories_to_lint = FactoryGirl.factories.reject do |factory|
+  factory.name =~ /^old_/
+end
+
+FactoryGirl.lint factories_to_lint
+```
+
+This would lint all factories that aren't prefixed with `old_`.
+
+Traits can also be linted. This option verifies that each  
+and every trait of a factory generates a valid object on its own. 
+This is turned on by passing `traits: true` to the `lint` method:
+
+```ruby
+FactoryGirl.lint traits:true
+```
+
+This can also be combined with other arguments:
+
+```ruby
+FactoryGirl.lint factories_to_lint, traits: true
+```
+
 Custom Construction
 -------------------
 

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+gem 'jdbc-sqlite3', platforms: :jruby
+
+gem 'sqlite3', '~> 1.3.10', platforms: :ruby