named_seeds 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faba2937d0e01b1c4fe753d384443646f6a646fa
-  data.tar.gz: 834e8f40a54ddfd993cd06fa185e19bc0aad1dd4
+  metadata.gz: 2dd15c25329b3392795fb29d32abaac3a1066b4c
+  data.tar.gz: f8ccffe2fe567906116a45ec4f7c1cf1235b7f62
 SHA512:
-  metadata.gz: 05516f577aff9af4ea8fa809410bdd0274096632b9e7a4270acffec2083163fb6789b5abf897b39b3f3968102d96d460a139344c4d4b4331801e547f5cd8b4e8
-  data.tar.gz: 4053bcc81a480683425c944c71c391a7a005e59f62b717949e28b631df468e84333435fcc748bdccf7ad22a6cfbe58c5cd5862303ebf81e9ec9096f00975dff2
+  metadata.gz: 35a1cb0ee44477f9c052fc64c7808a08a1c2f2c349ec561e41a4c616b6c6175cb52015288d297daecb6b8538c83d937400059fcb84d4fc6587b1ce81f0020768
+  data.tar.gz: 8c8e10690ce1ff0f79dec55754a19b6e1e3212de56854b207dac944a84ac786d0180cbcd155c7ef7cf2284dff90d19d8506028fe388df5094e22108f36a8e756

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 
+### v1.1.0
+
+* Many changes to support new Rails 4.2 sync test schema strategy.
+  - The `test:prepare` Task Might Be Useless Now? - http://git.io/mu2F2Q
+  - Bring back `db:test:prepare` - http://git.io/VKEwhg
+
+
 ### v1.0.4
 
 * Make `db:development:seed` automatic based on Rails `db:setup` convention.
@@ -22,4 +29,4 @@
 
 ### v1.0.0
 
-* Initial release
+* Initial release

data/README.md

@@ -1,5 +1,10 @@
 # NamedSeeds
 
+**Almost Ready for Rails 4.2.0.beta2**
+
+* [Various Issues With 4.2.0.beta2 DB Setup/Testing](https://github.com/rails/rails/issues/17170)
+* [The `test:prepare` Task Might Be Useless Now?](https://github.com/rails/rails/issues/17171)
+
 **Make your tests fast by augmenting them with transactional fixtures powered by your favorite factory library!**
 
 We all know that ActiveRecord::Fixtures are hard to maintain and are disconnected from the models that save your data. But Rails did get something right with transactional tests and easy helper methods to access fixtures by name. NamedSeeds aims to be a drop-in replacement for Rails fixtures or an enhancement to RSpec and Cucumber while using any object generator of your choice!
@@ -10,6 +15,11 @@ The idea is to leverage your tests' existing factories to generate fixtures that
 * Inprogress...
 
 
+## Versions
+
+The current master branch is for Rails v4.2.0 and up and follows v1.1 major version. Please use our `1-0-stable` branch for Rails v3.1 to v4.1.
+
+
 ## Installation
 
 Add the named_seeds gem to your Rails' Gemfile in both the development and test group as shown below. This is needed as the NamedSeeds gem exposes rake tasks needed in both environments.
@@ -20,47 +30,49 @@ group :development, :test do
 end
 ```
 
+That's it! The NamedSeeds gem will hook into the Rails test cycle to make sure your factoried fixtures (and any engine seeds) are populated after your test schema is created and before your test suite runs.
+
 ## Usage
 
 NamedSeeds requires that you create a `db/test/seeds.rb` file. The contents of this file can be anything you want. We recommend using a factory library like [FactoryGirl](https://github.com/thoughtbot/factory_girl) or [Machinist](https://github.com/notahat/machinist).
 
 ```ruby
 require 'factory_girl'
-FactoryGirl.reload
+FactoryGirl.find_definitions rescue false
 
-@bob = FactoryGirl.create :user, :id => NamedSeeds.identify(:bob), :email => 'bob@test.com'
+@bob = FactoryGirl.create :user, id: NamedSeeds.identify(:bob), email: 'bob@test.com'
 ```
 
 Use the `NamedSeeds.identify` method to give a name to the identity used for this record. You will be able to find this record using that name later on.
 
 
-### Rake Files
-
-**Using these tasks manually should not be needed as both are hooked into the proper `test:prepare` and `db:setup` process for you.**
+#### Integration Notes
 
-NamedSeeds includes two rake tasks. The `db:test:seeds` is the one that does all the work and is automatically called after Rails' `test:prepare` for you. So running your rake test tasks will create your test database and seed it for you automatically before your tests run. Remember, ActiveRecords `db:test:prepare` is not a proper hook, read [my comment](https://github.com/rspec/rspec-rails/issues/663#issuecomment-11831559) on this rspec issue for more details.
+The NamedSeeds gem will hook into ActiveRecord's `db:setup` task. This means that new developers can checkout your code and run the normal Rails setup process and see a fully populated development database that has the same seed/fixtures story used by your tests. For example:
 
-The other task is `db:development:seed`. This task invokes the normal Rails `db:seed` task, then loads the db/test/seeds.rb file while still in development mode. We automatically call this task after `db:setup` for you. This task provides a way for a developer to populate their development database with the same fixture story used for testing. This makes it easy for developers to learn your application as the test story is a 1 to 1 mapping of data in local development.
+```
+$ bundle
+$ rake db:create:all
+$ rake db:setup
+```
 
-```shell
-$ rake db:test:seed          # Run the seed data from db/test/seeds.rb and 
-                             # optionally your Rails db/seeds.rb if you have 
-                             # configured `app_load_seed` below.
+If you need to force a reload of your development environment's data, just use Rails conventions. For example, the `db:reset` task calls setup, so NamedSeeds will hook in at the right place.
 
-$ rake db:development:seed   # Runs the normal Rails `db:seed` task then 
-                             # loads the db/test/seeds.rb file.
+```
+$ rake db:reset
 ```
 
+Likewise, if you wanted to reset your test database and pre-populate it with named seeds/fixtures you can run the following:
+
+```
+$ spring stop && rake db:test:prepare
+```
 
 #### Rails
 
 By default, Rails' ActiveSupport::TestCase has set the `use_transactional_fixtures` to true. So all you need to do is declare which tables have NamedSeeds keys.
 
 ```ruby
-ENV["RAILS_ENV"] = "test"
-require File.expand_path('../../config/environment', __FILE__)
-require 'rails/test_help'
-
 class ActiveSupport::TestCase
   named_seeds :users, :posts
 end
@@ -78,7 +90,6 @@ class UserTest < ActiveSupport::TestCase
 end
 ```
 
-
 #### RSpec
 
 Coming soon...
@@ -88,42 +99,22 @@ Coming soon...
 Coming soon...
 
 
-## Advanced Usage
-
-Review how helper methods may map to custom table names. Like Rails did with #fixture_table_names...
-
 
 ## Configurations
 
-NamedSeeds is a `Rails::Railtie` that exposes a few `config` options. So open up the `config/environments/development.rb` **(yes in development.rb)** and use the `config.named_seeds` options below. NOTE: I have found that sometimes I need to add some configurations to `config/environments/test.rb` too. Mainly when using [spring](https://github.com/jonleighton/spring). So adding `config.named_seeds.app_load_seed = true` is what I needed.
-
+NamedSeeds is a `Rails::Railtie` that exposes a few `config` options. So open up the `config/environments/development.rb` **(yes in development.rb)** and use the `config.named_seeds` options below. NOTE: I have found that sometimes I need to add some configurations to `config/environments/test.rb` too.
 
-* *app_load_seed* - Load your Rails application's db/seeds.rb file into the test database. This is done before db/test/seeds.rb is loaded. Default is false.
+* *app_load_seed* - Load your Rails application's db/seeds.rb file into the test database. This is done before db/test/seeds.rb is loaded. Default is `true` but may people use this file incorrectly vs standard lookup tables.
 * *engines_with_load_seed* - Some Rails engines provide a load seed hook. If you want NamedSeed to call the engine's seed method into your tests database, push the engine constant to this array. Any object responding to `load_seed` sould work here too. Default is an empty array.
 
 ```ruby
 My::Application.configure do
-  config.named_seeds.app_load_seed = true
+  config.named_seeds.app_load_seed = false
   config.named_seeds.engines_with_load_seed += [GeoData::Engine, OurLookupTables]
 end
 ```
 
-NamedSeeds uses DatabaseCleaner to clean the database before seeding it. Use the `config.named_seeds.db_cleaner` options below to configure its behavior. Please see the DatabaseCleaner documentation for full details.
-
-* *orm* - The ORM module to use. Default is `:active_record`.
-* *connection* - The connection name to use. Default is `:test`.
-* *strategy* - Strategy to clean the database with. Default is `:truncation`.
-* *strategy_args* - Args to be passed to the strategy. Default is an empty hash.
-
-```ruby
-My::Application.configure do
-  config.named_seeds.db_cleaner.orm           = :active_record
-  config.named_seeds.db_cleaner.connection    = :test
-  config.named_seeds.db_cleaner.strategy      = :truncation
-  config.named_seeds.db_cleaner.strategy_args = {:except => ['geodata', 'lookuptable']}
-end
-```
-
+NamedSeeds relies on ActiveRecord's `ActiveRecord::Migration.maintain_test_schema!` setting. We do not want to get into the business of coupling too much with the internals of Rails and hance assume this is true.
 
 
 ## Todo

data/lib/named_seeds/railtie.rb

@@ -1,62 +1,44 @@
 module NamedSeeds
   class Railtie < Rails::Railtie
-    
+
     config.named_seeds = ActiveSupport::OrderedOptions.new
-    config.named_seeds.app_load_seed          = false
+    config.named_seeds.app_load_seed          = true
     config.named_seeds.engines_with_load_seed = []
-    
-    config.named_seeds.db_cleaner = ActiveSupport::OrderedOptions.new
-    config.named_seeds.db_cleaner.orm           = :active_record
-    config.named_seeds.db_cleaner.connection    = :test
-    config.named_seeds.db_cleaner.strategy      = :truncation
-    config.named_seeds.db_cleaner.strategy_args = {}
 
     config.before_initialize do |app|
-      Rails.application.paths.add 'db/test/seeds', :with => 'db/test/seeds.rb'
+      Rails.application.paths.add 'db/test/seeds', with: 'db/test/seeds.rb'
     end
 
     rake_tasks do
       load "named_seeds/railties/databases.rake"
     end
-    
-    def load_seed
-      if seed_file
-        setup_test_environment
-        clean_test_database
-        load_all_seeds
-      end
-    end
-    
-    
-    protected
-    
-    def setup_test_environment
-      unless Rails.env.test?
-        ActiveRecord::Base.clear_all_connections!
-        ActiveRecord::Base.configurations.clear
-        silence_warnings { Object.const_set :RAILS_ENV, 'test' ; ENV['RAILS_ENV'] = 'test' ; Rails.instance_variable_set :@_env, nil }
-        ActiveRecord::Base.configurations = Rails.configuration.database_configuration
-        ActiveRecord::Base.establish_connection
-      end
+
+    def setup
+      load test_seed_file if test_seed_file
     end
-    
-    def clean_test_database
-      require 'database_cleaner'
-      DatabaseCleaner.logger = Rails.logger
-      cleaner_opts = config.named_seeds.db_cleaner
-      cleaner = DatabaseCleaner[cleaner_opts.orm, {:connection => cleaner_opts.connection}]
-      cleaner.clean_with cleaner_opts.strategy, cleaner_opts.strategy_args
+
+    def prepare
+      return unless test_seed_file
+      load_all_seeds
+      setup
     end
-    
+
+
+    protected
+
     def load_all_seeds
-      Rails.application.load_seed if config.named_seeds.app_load_seed
+      ActiveRecord::Tasks::DatabaseTasks.load_seed if config.named_seeds.app_load_seed
       config.named_seeds.engines_with_load_seed.each { |engine| engine.load_seed }
-      load seed_file
     end
-    
-    def seed_file
+
+    def test_seed_file
       Rails.application.paths["db/test/seeds"].existent.first
     end
-    
+
   end
+
+  def self.prepare
+    NamedSeeds::Railtie.prepare
+  end
+
 end

data/lib/named_seeds/railties/databases.rake

@@ -1,27 +1,14 @@
-namespace :db do
-
-  namespace :development do
-    
-    desc "Run all seeds for development"
-    task :seed => :environment do
-      Rake::Task["db:abort_if_pending_migrations"].invoke
-      Rake::Task["db:seed"].invoke
-      load NamedSeeds::Railtie.send(:seed_file)
-    end
+namespace :named_seeds do
 
+  task :setup => :environment do
+    NamedSeeds::Railtie.setup
   end
 
-  namespace :test do
-    
-    desc "Run the seed data from db/test/seeds.rb"
-    task :seed => :environment do
-      Rake::Task["db:abort_if_pending_migrations"].invoke
-      NamedSeeds::Railtie.load_seed
-    end
-
+  task :prepare do
+    NamedSeeds::Railtie.prepare
   end
 
 end
 
-task 'db:setup'     => 'db:development:seed'
-task 'test:prepare' => 'db:test:seed'
+Rake::Task['db:setup'].enhance { Rake::Task['named_seeds:setup'].invoke }
+Rake::Task['db:test:prepare'].enhance { Rake::Task['named_seeds:prepare'].invoke }

data/lib/named_seeds/version.rb

@@ -1,3 +1,3 @@
 module NamedSeeds
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/named_seeds.gemspec

@@ -14,8 +14,7 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.require_paths = ["lib"]
-  gem.add_runtime_dependency     'rails', '>= 3.1', '< 4.2'
-  gem.add_runtime_dependency     'database_cleaner'
+  gem.add_runtime_dependency     'rails', '~> 4.2.0.beta2'
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest'

data/test/support/active_record.rb

@@ -0,0 +1,14 @@
+require 'active_record/base'
+
+ActiveRecord::Base.logger = nil
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+ActiveRecord::Base.class_eval do
+  silence(:stdout) do
+
+    connection.create_table :users, force: true do |t|
+      t.string :name, :email
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -2,17 +2,14 @@ require 'rubygems'
 require "bundler/setup"
 Bundler.require
 require 'named_seeds'
-require 'active_record/base'
 require 'minitest/autorun'
+require 'support/active_record'
 
-ActiveRecord::Base.logger = nil
-ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
-
-require 'support/schema'
+ActiveSupport.test_order = :random
 
 module NamedSeeds
   class Spec < MiniTest::Spec
-    
-    
+
+
   end
 end

metadata

@@ -1,49 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: named_seeds
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Ken Collins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-03 00:00:00.000000000 Z
+date: 2014-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 4.2.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.0.beta2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -109,8 +89,8 @@ files:
 - lib/named_seeds/version.rb
 - named_seeds.gemspec
 - test/cases/base_test.rb
+- test/support/active_record.rb
 - test/support/models.rb
-- test/support/schema.rb
 - test/test_helper.rb
 homepage: http://github.com/metaskills/named_seeds
 licenses: []
@@ -131,12 +111,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: 'Replace ActiveRecord::Fixtures With #{your_factory_lib}.'
 test_files:
 - test/cases/base_test.rb
+- test/support/active_record.rb
 - test/support/models.rb
-- test/support/schema.rb
 - test/test_helper.rb

data/test/support/schema.rb

@@ -1,9 +0,0 @@
-ActiveRecord::Base.class_eval do
-  silence(:stdout) do
-
-    connection.create_table :users, :force => true do |t|
-      t.string :name, :email
-    end
-
-  end
-end