fixture_builder 0.5.0 → 0.5.1.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71fa7f68a5bc5f9babc68b31a4e6c87f4d96685d
-  data.tar.gz: 2e81aeeb3ea05673da66001b9138c80975f3558d
+  metadata.gz: 0ed3bdfdd32cd95b0878b2a7ea90eacdfa46cdf7
+  data.tar.gz: 56e24ea07566286466c783700a09ec9fa7943820
 SHA512:
-  metadata.gz: 5676814164f235e2623c35ce49f132f5d3fcd7e7bce1e370678e48bb23def80f474f76161f5b64c24c270623174b79f2ecb8dbbbdb7e35f434812c4f6b1462df
-  data.tar.gz: f813494f8680709c4cae1f253d3e04f3a807798c6c987f8cab13ea3bca9e8d9642aab8c69c3896e6e8e4a356eb920f6a67a9002eac548b36138a9b597c630a0f
+  metadata.gz: b33ccb8d31f502d85944d020a24bbda7ce2333ac35d105ea54002e5956583072ac794eb9fec4fba46c5ec6fe7ea7bc8aface513b20d8ec30a838b93114a5745e
+  data.tar.gz: 314ada2063d1523ec3b055c9dc34d9c597a4e57e6757c3af3ebec2b1d356205ad2d5e727186b694349d20ad10fa235756dc7de6087901eecb43c9d84eb1e1655

data/README.markdown

@@ -3,7 +3,23 @@ FixtureBuilder
 
 [![Build Status](https://secure.travis-ci.org/rdy/fixture_builder.png)](http://travis-ci.org/rdy/fixture_builder)
 
-Based on the code from fixture_scenarios, by Chris Wanstrath. Allows you to build file fixtures from an object mother factory.
+Based on the code from fixture_scenarios, by Chris Wanstrath.  Allows you to build file fixtures from
+existing object mother factories, like FactoryGirl, to generate high performance fixtures that can be
+shared across all your tests and development environment.
+
+The best of all worlds!
+
+* Speed: Leverage the high-performance speed of Rails' transactional tests/fixtures to avoid test suite slowdown
+  as your app's number of tests grows, because [creating and persisting data is slow!](https://robots.thoughtbot.com/speed-up-tests-by-selectively-avoiding-factory-girl)
+* Maintainability/reuse/abstraction: Use object mother factories to generate fixtures via
+  FactoryGirl or your favorite tool
+* Flexibility: You can always fall back to object mothers in tests if needed, or load a fixture
+  and modify only an attribute or two without the overhead of creating an entire object dependency graph.
+* Consistency: Use the exact same fixture data in all environments: test, development, and demo/staging servers.
+  Makes reproduction and acceptance testing of bugs/features faster and easier!
+* Simplicity: Avoid having to maintain and generate `seeds.rb` sample data set separately from your test fixture/factory data set,
+  or [pick which of the myriad seeds helper gems to use](https://rubygems.org/search?query=seed).  *Just delete
+  `seeds.rb` and forget about it!*
 
 Installing
 ==========
@@ -11,93 +27,257 @@ Installing
  1. Install as a plugin or gem:  `gem install fixture_builder`
  1. Create a file which configures and declares your fixtures (see below for example)
  1. Require the above file in your `spec_helper.rb` or `test_helper.rb`
+ 1. If you are using rspec, ensure you have
+    * Set the `FIXTURES_PATH` in `config/application.rb` (not test.rb, or you can't use `rake db:fixtures:load`). E.g.:
+
+      ```ruby
+      module MyApp
+       class Application < Rails::Application
+         #...
+         ENV['FIXTURES_PATH'] = 'spec/fixtures'
+         #...
+      ```
+    * Set `config.fixture_path = Rails.root.join('spec/fixtures')` in `spec/rails_helper.rb`
+    * Set `config.global_fixtures = :all` if you don't want to specify fixtures in every spec file.
+ 1. You probably also want to use [**config.use_transactional_fixtures**](https://www.relishapp.com/rspec/rspec-rails/docs/transactions)
+    (if you are using rspec)
+    or [**use_transactional_fixtures/use_transactional_tests**](http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html) (if you are not using rspec),
+ 1. If you are using fixtures in Selenium-based Capybara/Cucumber specs that runs the tests and server in separate processes,
+    you probably want to consider setting transactional fixtures to false, and instead using
+    [Database Cleaner](https://github.com/DatabaseCleaner/database_cleaner) 
+    with `DatabaseCleaner.strategy = :truncation` or `DatabaseCleaner.strategy = :deletion`.
+
+Usage
+=====
+
+* When running tests/specs, fixtures will build/rebuild automatically as needed
+* `rake spec:fixture_builder:build` to force a build of fixtures
+* `rake spec:fixture_builder:rebuild` to force a rebuild of fixtures
+* `rake db:fixtures:load` to load built fixtures into your development environment (this is a standard Rails rake task)
 
 
-Example
-=======
+Configuration Example
+=====================
+
+`spec/rails_helper.rb` or `test/test_helper.rb`:
+
+```ruby
+require_relative 'support/fixture_builder'
+```
 
 When using an object mother such as factory_girl it can be setup like the following:
 
-    # I usually put this file in spec/support/fixture_builder.rb
-    FixtureBuilder.configure do |fbuilder|
-      # rebuild fixtures automatically when these files change:
-      fbuilder.files_to_check += Dir["spec/factories/*.rb", "spec/support/fixture_builder.rb"]
-
-      # now declare objects
-      fbuilder.factory do
-        david = Factory(:user, :unique_name => "david")
-        ipod = Factory(:product, :name => "iPod")
-        Factory(:purchase, :user => david, :product => ipod)
-      end
-    end
+```ruby
+# spec/support/fixture_builder.rb 
+FixtureBuilder.configure do |fbuilder|
+  # rebuild fixtures automatically when these files change:
+  fbuilder.files_to_check += Dir["spec/factories/*.rb", "spec/support/fixture_builder.rb"]
 
-The block passed to the factory method initiates the creation of the fixture files.  Before yielding to the block, FixtureBuilder cleans out the test database completely.  When the block finishes, it dumps the state of the database into fixtures, like this:
+  # now declare objects
+  fbuilder.factory do
+    david = Factory(:user, :unique_name => "david")
+    ipod = Factory(:product, :name => "iPod")
+    Factory(:purchase, :user => david, :product => ipod)
+  end
+end
+```    
 
-    # users.yml
-    david:
-      created_at: 2010-09-18 17:21:23.926511 Z
-      unique_name: david
-      id: 1
+The block passed to the factory method initiates the creation of the fixture files.
+Before yielding to the block, FixtureBuilder cleans out the test database completely.
+When the block finishes, it dumps the state of the database into fixtures, like this:
 
-    # products.yml
-    i_pod:
-      name: iPod
-      id: 1
+```yaml
+# users.yml
+david:
+  created_at: 2010-09-18 17:21:23.926511 Z
+  unique_name: david
+  id: 1
 
-    # purchases.yml
-    purchase_001:
-      product_id: 1
-      user_id: 1
+# products.yml
+i_pod:
+  name: iPod
+  id: 1
 
-FixtureBuilder guesses about how to name fixtures based on a prioritized list of attribute names.  You can also hint at a name or manually name an object.  Both of the following lines would work to rename `purchase_001` to `davids_ipod`:
+# purchases.yml
+purchase_001:
+  product_id: 1
+  user_id: 1
+```
 
-    fbuilder.name(:davids_ipod, Factory(:purchase, :user => david, :product => ipod))
-    @davids_ipod = Factory(:purchase, :user => david, :product => ipod)
+FixtureBuilder guesses about how to name fixtures based on a prioritized list of attribute names.
+You can also hint at a name or manually name an object.  Both of the following lines would
+work to rename `purchase_001` to `davids_ipod`:
 
-Another way to name fixtures is to use the name_model_with. To use it you create a block that returns how you want a certain model name based on the record field.
+```ruby
+fbuilder.name(:davids_ipod, Factory(:purchase, :user => david, :product => ipod))
+@davids_ipod = Factory(:purchase, :user => david, :product => ipod)
+```
 
-    fbuilder.name_model_with(User) do |record|
-      [record['first_name'], record['last_name']].join('_')
-    end
+Another way to name fixtures is to use the name_model_with. To use it you create a block that
+returns how you want a certain model name based on the record field.
+
+```ruby
+fbuilder.name_model_with(User) do |record|
+  [record['first_name'], record['last_name']].join('_')
+end
+```
 
 For all User fixture {first_name: 'foo', last_name: 'bar'} it would generate `foo_bar` as the fixture name.
 
 There are also additional configuration options that can be changed to override the defaults:
 
- * files_to_check: array of filenames that when changed cause fixtures to be rebuilt
- * fixture_builder_file: the pathname of the file used to store file changes.
- * record_name_fields: array of field names to use as a fixture's name prefix, it will use the first matching field it finds
- * skip_tables: array of table names to skip building fixtures
- * select_sql: sql string to use for select
- * delete_sql: sql string to use for deletes
+* files_to_check: array of filenames that when changed cause fixtures to be rebuilt
+* fixture_builder_file: the pathname of the file used to store file changes.
+* record_name_fields: array of field names to use as a fixture's name prefix, it will use the first matching field it finds
+* skip_tables: array of table names to skip building fixtures
+* select_sql: sql string to use for select
+* delete_sql: sql string to use for deletes
 
 By default these are set as:
 
- * files_to_check: %w{ db/schema.rb }
- * fixture_builder_file: RAILS_ROOT/tmp/fixture_builder.yml
- * record_name_fields: %w{ schema_migrations }
- * skip_tables: %w{ schema_migrations }
- * select_sql: SELECT * FROM %{table}
- * delete_sql: DELETE FROM %{table}
+* files_to_check: %w{ db/schema.rb }
+* fixture_builder_file: RAILS_ROOT/tmp/fixture_builder.yml
+* record_name_fields: %w{ schema_migrations }
+* skip_tables: %w{ schema_migrations }
+* select_sql: SELECT * FROM %{table}
+* delete_sql: DELETE FROM %{table}
 
 Sequence Collisions
 ===================
 
-One problem with generating your fixtures is that sequences can collide.  When the fixtures are generated only as needed, sometimes the process that generates the fixtures will be different than the process that runs the tests.  This results in collisions when you still use factories in your tests.  Here's a solution for FactoryGirl which resets sequences numbers to 1000 (to avoid conflicts with fixture data which should e sequenced < 1000) before the tests run:
+One problem with generating your fixtures is that sequences can collide.
+When the fixtures are generated only as needed, sometimes the process that
+generates the fixtures will be different than the process that runs the tests.
+This results in collisions when you still use factories in your tests.
 
-    FixtureBuilder.configure do |fbuilder|
-      ...
-    end
+There's a couple of approaches for this.
+
+Here's a solution for FactoryGirl which resets sequences numbers to 1000
+(to avoid conflicts with fixture data which should be sequenced < 1000)
+before the tests run:
+
+```ruby
+FixtureBuilder.configure do |fbuilder|
+  # ...
+end
+
+# Have factory girl generate non-colliding sequences starting at 1000 for data created after the fixtures
 
-    # Have factory girl generate non-colliding sequences starting at 1000 for data created after the fixtures
+# Factory Girl <2 yields name & seq
+# Factory Girl >2 yeilds only seq
+FactoryGirl.sequences.each do |seq|
  
-    # Factory Girl <2 yields name & seq
-    # Factory Girl >2 yeilds only seq
-    FactoryGirl.sequences.each do |seq|
-     
-      # Factory Girl 4 uses an Enumerator Adapter, otherwise simply set a Fixnum
-      seq.instance_variable_set(:@value, FactoryGirl::Sequence::EnumeratorAdapter.new(2000))
-      
+  # Factory Girl 4 uses an Enumerator Adapter, otherwise simply set a Fixnum
+  seq.instance_variable_set(:@value, FactoryGirl::Sequence::EnumeratorAdapter.new(2000))
+  
+end
+```
+
+Another solution is to explicitly reset the database primary key sequence via ActiveRecord.
+You could call this method before you run your factories in the `fixture_builder.rb` block:
+
+```ruby
+def reset_pk_sequences
+  puts 'Resetting Primary Key sequences'
+  ActiveRecord::Base.connection.tables.each do |t|
+    ActiveRecord::Base.connection.reset_pk_sequence!(t)
+  end
+end
+
+```
+
+Advanced Usage
+==============
+
+As you get more fixtures, you may want to move the creation of fixtures to a separate file.  For example:  
+
+```ruby
+# spec/support/fixture_builder.rb 
+require_relative 'create_fixtures'
+
+FixtureBuilder.configure do |fbuilder|
+  # rebuild fixtures automatically when these files change:
+  fbuilder.files_to_check += Dir[
+    "spec/factories/*.rb",
+    "spec/support/fixture_builder.rb",
+    "spec/support/create_fixtures.rb",
+  ]
+
+  # now declare objects
+  fbuilder.factory do
+    CreateFixtures.new(fbuilder).create_all
+  end
+end
+```
+
+Then, you can do more extensive and advanced fixture creation in that class.  Here's
+a partial example:
+
+```ruby
+# spec/support/create_fixtures.rb 
+
+require 'factory_girl_rails'
+
+class CreateFixtures
+  include FactoryGirl::Syntax::Methods
+
+  attr_accessor :fbuilder, :models, :fixed_time
+
+  def initialize(fbuilder)
+    @fbuilder = fbuilder
+    @models = {}
+    @fixed_time = Time.utc(2015, 3, 14, 9, 2, 6)
+  end
+
+  def create_all
+    reset_pk_sequences
+    create_users
+    create_products
+    create_purchases
+    reset_pk_sequences
+  end
+
+  private
+
+  def reset_pk_sequences
+    puts 'Resetting Primary Key sequences'
+    ActiveRecord::Base.connection.tables.each do |t|
+      ActiveRecord::Base.connection.reset_pk_sequence!(t)
     end
+  end
+  
+  def create_users
+    # etc...
+  end 
+  
+  # other creation and helper methods to abstract common logic, e.g. 
+  # * custom naming rules via #name_model_with
+  # * set up associations by storing created model records in a hash: models[model_class_name][model_name.to_sym] = record
+  # etc... (hopefully some of these helper patterns can be standardized and included in the gem in the future)
+ end 
+```
+
+Tips
+====
+
+* Don't use `seeds.rb`.  Instead, just use `rake db:fixtures:load` to get fixtures into dev.  If you
+  want fixture data on a staging/demo environment, either run `db:fixtures:load`, or
+  dump the database and load it there.
+* Always use fixtures instead of object mothers in tests when possible - this will keep your test suite fast!
+  [Even FactoryGirl says to avoid using factories when you can, because creating and persisting data is slow](https://robots.thoughtbot.com/speed-up-tests-by-selectively-avoiding-factory-girl)
+* If you only need to tweak an attribute or two to test an edge case, load the fixture object,
+  then just set the attribute on the object (if you don't need it persisted, this is fastest), or
+  set it via `#update_attributes!` (only if you need it persisted, this is slower).
+* Modify `bin/setup` to run fixture builder and load your dev database:
+      ```ruby
+      puts "\n== Building fixtures =="
+      system! 'bin/rails spec:fixture_builder:build'
+        
+      puts "\n== Loading fixtures into dev database =="
+      system! 'bin/rails db:fixtures:load'
+      ```
+
 
 Copyright (c) 2009 Ryan Dy & David Stevenson, released under the MIT license
+
+Currently maintained by [Chad Woolley](thewoolleyman@gmail.com)

data/fixture_builder.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.version     = FixtureBuilder::VERSION
   s.platform    = Gem::Platform::RUBY
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
-  s.authors = ['Ryan Dy', 'David Stevenson']
-  s.description = %q{FixtureBuilder allows testers to use their existing factories, like FactoryGirl, to generate high performance fixtures that can be shared across all your tests}
+  s.authors = ['Ryan Dy', 'David Stevenson', 'Chad Woolley']
+  s.description = %q{FixtureBuilder allows testers to use their existing factories, like FactoryGirl, to generate high performance fixtures that can be shared across all your tests and development environment.  The best of all worlds!  Speed, Maintainability, Flexibility, Consistency, and Simplicity!}
   s.email = %q{mail@ryandy.com}
   s.licenses = ['MIT']
   s.extra_rdoc_files = [
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
 
   s.homepage = %q{http://github.com/rdy/fixture_builder}
   s.rubyforge_project = %q{fixture_builder}
-  s.summary = %q{Build YAML fixtures using object factories}
+  s.summary = %q{Build Rails fixtures using object mother factories}
 
   s.add_dependency %q{activerecord}, '>= 2'
   s.add_dependency %q{activesupport}, '>= 2'

data/lib/fixture_builder/builder.rb

@@ -78,7 +78,7 @@ module FixtureBuilder
     end
 
     def delete_yml_files
-      FileUtils.rm(Dir.glob(fixtures_dir('*.yml'))) rescue nil
+      FileUtils.rm(*tables.map { |t| fixture_file(t) }) rescue nil
     end
 
     def say(*messages)
@@ -129,10 +129,14 @@ module FixtureBuilder
 
     def serialized_value_if_needed(table_klass, attr_name, value)
       if table_klass.respond_to?(:type_for_attribute)
-        if table_klass.type_for_attribute(attr_name).respond_to?(:serialize)
+        if table_klass.type_for_attribute(attr_name).type == :jsonb || table_klass.type_for_attribute(attr_name).type == :json
+          value
+        elsif table_klass.type_for_attribute(attr_name).respond_to?(:serialize)
           table_klass.type_for_attribute(attr_name).serialize(value)
-        else
+        elsif table_klass.type_for_attribute(attr_name).respond_to?(:type_cast_for_database)
           table_klass.type_for_attribute(attr_name).type_cast_for_database(value)
+        else
+          table_klass.type_for_attribute(attr_name).type_cast_for_schema(value)
         end
       else
         if table_klass.serialized_attributes.has_key? attr_name

data/lib/fixture_builder/configuration.rb

@@ -97,7 +97,7 @@ module FixtureBuilder
     end
 
     def fixture_directory
-      @fixture_directory ||= File.expand_path(File.join(::Rails.root, spec_or_test_dir, 'fixtures'))
+      @fixture_directory ||= FixturesPath.absolute_rails_fixtures_path
     end
 
     def fixtures_dir(path = '')
@@ -106,10 +106,6 @@ module FixtureBuilder
 
     private
 
-    def spec_or_test_dir
-      File.exists?(File.join(::Rails.root, 'spec')) ? 'spec' : 'test'
-    end
-
     def file_hashes
       files_to_check.inject({}) do |hash, filename|
         hash[filename] = Digest::MD5.hexdigest(File.read(filename))

data/lib/fixture_builder/fixtures_path.rb

@@ -0,0 +1,15 @@
+module FixtureBuilder
+  class FixturesPath
+    def self.absolute_rails_fixtures_path
+      File.expand_path(ActiveRecord::Tasks::DatabaseTasks.fixtures_path)
+    rescue
+      if ENV["FIXTURES_PATH"]
+        ENV["FIXTURES_PATH"]
+      elsif File.exists?(File.expand_path("spec/fixtures",::Rails.root))
+        File.expand_path("spec/fixtures",::Rails.root)
+      else
+        File.expand_path("test/fixtures",::Rails.root)
+      end
+    end
+  end
+end

data/lib/fixture_builder/version.rb

@@ -1,3 +1,3 @@
 module FixtureBuilder
-  VERSION = '0.5.0'
+  VERSION = '0.5.1.rc4'
 end

data/lib/fixture_builder.rb

@@ -2,6 +2,7 @@ require 'fixture_builder/delegations'
 require 'fixture_builder/configuration'
 require 'fixture_builder/namer'
 require 'fixture_builder/builder'
+require 'fixture_builder/fixtures_path'
 
 module FixtureBuilder
   class << self

data/lib/tasks/fixture_builder.rake

@@ -3,14 +3,14 @@ namespace :spec do
     desc "Deletes the generated fixtures in spec/fixtures"
     task :clean do
       FileUtils.rm_f("tmp/fixture_builder.yml")
-      FileUtils.rm_f(Dir.glob('spec/fixtures/*.yml'))
+      FileUtils.rm_f(Dir.glob("#{FixtureBuilder::FixturesPath.absolute_rails_fixtures_path}/*.yml"))
       puts "Automatically generated fixtures removed"
     end
 
     desc "Build the generated fixtures to spec/fixtures if dirty"
     task :build => :environment do
       ActiveRecord::Base.establish_connection(:test)
-      Dir.glob(File.join(Rails.root, '{spec,test}', '**', 'fixture_builder.rb')).each{|file| require(file)}
+      Dir.glob(File.join(::Rails.root, '{spec,test}', '**', 'fixture_builder.rb')).each{|file| require(file)}
     end
 
     desc "Clean and rebuild the generated fixtures to spec/fixtures"

data/test/fixture_builder_test.rb

@@ -62,8 +62,8 @@ class FixtureBuilderTest < Test::Unit::TestCase
     assert @called
   end
 
-  def test_spec_or_test_dir
-    assert_equal 'test', FixtureBuilder.configuration.send(:spec_or_test_dir)
+  def test_absolute_rails_fixtures_path
+    assert_equal File.expand_path('../../test/fixtures', __FILE__), FixtureBuilder::FixturesPath.absolute_rails_fixtures_path
   end
 
   def test_fixtures_dir

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: fixture_builder
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1.rc4
 platform: ruby
 authors:
 - Ryan Dy
 - David Stevenson
+- Chad Woolley
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -96,7 +97,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: FixtureBuilder allows testers to use their existing factories, like FactoryGirl,
-  to generate high performance fixtures that can be shared across all your tests
+  to generate high performance fixtures that can be shared across all your tests and
+  development environment.  The best of all worlds!  Speed, Maintainability, Flexibility,
+  Consistency, and Simplicity!
 email: mail@ryandy.com
 executables: []
 extensions: []
@@ -116,6 +119,7 @@ files:
 - lib/fixture_builder/builder.rb
 - lib/fixture_builder/configuration.rb
 - lib/fixture_builder/delegations.rb
+- lib/fixture_builder/fixtures_path.rb
 - lib/fixture_builder/namer.rb
 - lib/fixture_builder/version.rb
 - lib/tasks/fixture_builder.rake
@@ -150,7 +154,7 @@ rubyforge_project: fixture_builder
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Build YAML fixtures using object factories
+summary: Build Rails fixtures using object mother factories
 test_files:
 - test/fixture_builder_test.rb
 - test/fixtures/.gitkeep