fixture_builder 0.5.1.rc4 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ed3bdfdd32cd95b0878b2a7ea90eacdfa46cdf7
-  data.tar.gz: 56e24ea07566286466c783700a09ec9fa7943820
+  metadata.gz: 499d1a3d06e5d9732242c5ad93180428b5096c0f
+  data.tar.gz: 314a0687affb10304071948600b16be784b86522
 SHA512:
-  metadata.gz: b33ccb8d31f502d85944d020a24bbda7ce2333ac35d105ea54002e5956583072ac794eb9fec4fba46c5ec6fe7ea7bc8aface513b20d8ec30a838b93114a5745e
-  data.tar.gz: 314ada2063d1523ec3b055c9dc34d9c597a4e57e6757c3af3ebec2b1d356205ad2d5e727186b694349d20ad10fa235756dc7de6087901eecb43c9d84eb1e1655
+  metadata.gz: eb6dba58db8919c5505aab4e195dc1a9893f8694b5f890769f9181a3f2029b9445d49c903684f6b4e416db0dc628bdde78d8164b303c4353e9f26f739ed52324
+  data.tar.gz: 15bd4e3b6cb7a7500637ed77e0e5822be2d90b0207b13b21bd76a54127c089e282cd847ae50c857421fa6dd24faf3072341b9c6545a3123d4ebb23b4c57bbe29

data/README.markdown

@@ -9,23 +9,32 @@ 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
+* **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
+* **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
+* **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.
+* **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,
+* **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
 ==========
 
- 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. Install:
+   * Directly: `gem install fixture_builder`
+   * Bundler:
+   
+     ```ruby
+     # Gemfile
+     group :development, :test do
+       gem 'fixture_builder'
+
+     ```     
+ 1. Create a file which configures and declares your fixtures (see below for examples)
  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.:
@@ -52,10 +61,10 @@ 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 spec:fixture_builder:clean` to delete all existing fixture files
+* `rake spec:fixture_builder:rebuild` to force a rebuild of fixtures (just a clean + build)
 * `rake db:fixtures:load` to load built fixtures into your development environment (this is a standard Rails rake task)
 
-
 Configuration Example
 =====================
 
@@ -137,7 +146,7 @@ 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 }
+* record_name_fields: %w{ unique_name display_name name title username login }
 * skip_tables: %w{ schema_migrations }
 * select_sql: SELECT * FROM %{table}
 * delete_sql: DELETE FROM %{table}
@@ -150,7 +159,7 @@ 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.
 
-There's a couple of approaches for this.
+There's a couple of solutions 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)
@@ -168,7 +177,7 @@ end
 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))
+  seq.instance_variable_set(:@value, FactoryGirl::Sequence::EnumeratorAdapter.new(1000))
   
 end
 ```
@@ -186,8 +195,45 @@ end
 
 ```
 
-Advanced Usage
-==============
+It's probably a good idea to use both of these approaches together, especially if you are
+going to fall back to using FactoryGirl object mothers in addition to fixtures.
+
+Tips
+====
+
+* Don't use `seeds.rb` (just delete it).  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` on that environment, or
+  load fixtures into the dev with `rake db:fixtures:load`, dump the dev database, then load it on your environment.
+* 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).
+* Avoid referring to any fixtures by ID anywhere, unless you hardcode the ID when creating it.  They can change
+  if you add more fixtures in the future and cause tests to break.
+* To set up associations between different types of created fixture model objects, you can
+  use a couple of approaches:
+  1. When creating fixtures, keep a hash of all created models by type + name (not ID), and then look them up
+     out of the hash to use as an associated object when creating subsequent related objects.
+  1. Do a `MyModel.find_by_some_unique_field` to find a previously created instance that didn't have a name.   
+* If you delete a table, old fixture files for the deleted table can hang around and still get loaded
+  into the database, causing confusion or errors.  Use `rake spec:fixture_builder:clean` or 
+  `rake spec:fixture_builder:rebuild` to ensure they get cleaned up.
+* As you build more advanced fixture creation logic for your app's domain and try to DRY it up, you'll probably
+  end up having an easier time if:
+  1. You don't use any namespaced models
+  1. You keep your factory names consistent and exactly matching your model names
+* Modify `bin/setup` to run fixture builder and load your dev database:
+      ```ruby
+      puts "\n== Building fixtures =="
+      system! 'bin/rails spec:fixture_builder:rebuild'
+        
+      puts "\n== Loading fixtures into dev database =="
+      system! 'bin/rails db:fixtures:load'
+      ```
+
+More Complete Config Example
+============================
 
 As you get more fixtures, you may want to move the creation of fixtures to a separate file.  For example:  
 
@@ -208,6 +254,11 @@ FixtureBuilder.configure do |fbuilder|
     CreateFixtures.new(fbuilder).create_all
   end
 end
+
+# Have factory girl generate non-colliding sequences starting at 1000 for data created after the fixtures
+FactoryGirl.sequences.each do |seq|
+  seq.instance_variable_set(:@value, FactoryGirl::Sequence::EnumeratorAdapter.new(1000))
+end
 ```
 
 Then, you can do more extensive and advanced fixture creation in that class.  Here's
@@ -252,32 +303,11 @@ class CreateFixtures
   
   # 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
+  # * set up associations by storing created model records in a hash so you can retrieve them
   # 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/lib/fixture_builder/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fixture_builder
 version: !ruby/object:Gem::Version
-  version: 0.5.1.rc4
+  version: 0.5.1
 platform: ruby
 authors:
 - Ryan Dy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-24 00:00:00.000000000 Z
+date: 2018-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: fixture_builder
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Build Rails fixtures using object mother factories