named_seeds 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ken Collins
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# NamedSeeds
+
+**Make you tests fast by augmenting them with transactional fixtures powered by your favorite factory library!**
+
+We all know that ActiveRecord::Fixtures suck because they are authored in YAML files. But Rails did get something right, 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!
+
+The idea is to leverage your tests' existing factories to generate fixtures that will be populated before testing starts and to use a database transaction strategy around each test. In this way you have a populated story that can be accessed via convienient helper methods like `users(:admin)` which inturn yields much faster test runs. Database fixtures, even those seeded by factories, are not a pancea and we highly suggested that you continue to use factories in your tests when it makes sense to do so. For those that think this is mad or have FUD to share, please see my blog articles..
+
+* Inprogress...
+* Inprogress...
+
+
+## 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.
+
+```ruby
+group :development, :test do
+  gem 'named_seeds'
+end
+```
+
+## 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 some factory library like FactoryGirl or Machinist.
+
+```ruby
+require 'factory_girl'
+require "#{Rails.root}/test/factories"
+
+@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.
+
+
+#### 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
+```
+
+Now you can use both the `users` and `posts` helper methods to find any named identity from your seed file.
+
+```ruby
+require 'test_helper'
+class UserTest < ActiveSupport::TestCase
+  setup { @user = users(:bob) }
+  tests "should work" do
+    assert_equal 'bob@test.com', @user.posts
+  end
+end
+```
+
+
+#### RSpec
+
+Coming soon...
+
+#### Cucumber
+
+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/test.rb` and use the `config.named_seeds` options below.
+
+* *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.
+* *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.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
+```
+
+
+
+## Todo
+
+Show Rails implementation using ActiveSupport::TestCase or RSpec.
+
+Show examples with these 3 factory libraries.
+
+* https://github.com/thoughtbot/factory_girl
+* https://github.com/paulelliott/fabrication
+* https://github.com/notahat/machinist
+
+Setup a dummy_application in test.
+
+How are we different from:
+
+* https://github.com/mbleigh/seed-fu
+* https://github.com/sevenwire/bootstrapper/
+* https://github.com/franciscotufro/environmental_seeder
+
+Talk about http://railscasts.com/episodes/179-seed-data

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc 'Test the NamedSeeds gem.'
+Rake::TestTask.new do |t|
+  t.libs = ['lib','test']
+  t.test_files = Dir.glob("test/**/*_test.rb").sort
+  t.verbose = true
+end
+
+task :default => [:test]

data/lib/named_seeds/active_support.rb

@@ -0,0 +1,4 @@
+require 'active_support/test_case'
+
+ActiveSupport::TestCase.send :include, NamedSeeds::Read
+

data/lib/named_seeds/identity.rb

@@ -0,0 +1,11 @@
+require 'zlib'
+
+module NamedSeeds
+  
+  # A direct copy of ActiveRecord::Fixtures.identify.
+  # Returns a consistent, platform-independent identifier for +label+ that are positive integers less than 2^32.
+  def self.identify(label)
+    Zlib.crc32(label.to_s) % (2 ** 30 - 1)
+  end
+
+end  

data/lib/named_seeds/railtie.rb

@@ -0,0 +1,57 @@
+module NamedSeeds
+  class Railtie < Rails::Railtie
+    
+    config.named_seeds = ActiveSupport::OrderedOptions.new
+    config.named_seeds.app_load_seed          = false
+    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'
+    end
+
+    rake_tasks do
+      load "named_seeds/railties/databases.rake"
+    end
+    
+    def load_seed
+      setup_test_environment
+      clean_test_database
+      load_all_seeds
+    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
+    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
+    end
+    
+    def load_all_seeds
+      Rails.application.load_seed if config.named_seeds.app_load_seed
+      config.named_seeds.engines_with_load_seed.each { |engine| engine.load_seed }
+      seed_file = Rails.application.paths["db/test/seeds"].existent.first
+      load(seed_file) if seed_file
+    end
+    
+  end
+end

data/lib/named_seeds/railties/databases.rake

@@ -0,0 +1,13 @@
+namespace :db do  
+  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
+
+  end
+end
+
+task 'test:prepare' => 'db:test:seed'

data/lib/named_seeds/read.rb

@@ -0,0 +1,50 @@
+require 'active_support/concern'
+
+module NamedSeeds
+  module Read
+    
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+
+      def named_seeds(name, options = {})
+        klass = options[:klass] || name.to_s.classify.constantize
+        identities = options[:identities]
+        case identities
+        when Hash
+          define_method(name) do |*fixnames|
+            objs = fixnames.map do |fixname|
+              id = identities[fixname.to_sym]
+              find_named_seed name, klass, id, fixname
+            end
+            fixnames.one? ? objs.first : objs
+          end
+        else
+          define_method(name) do |*fixnames|
+            objs = fixnames.map do |fixname|
+              id = NamedSeeds.identify(fixname)
+              find_named_seed name, klass, id, fixname
+            end
+            fixnames.one? ? objs.first : objs
+          end
+        end
+      end
+        
+    end
+
+    protected
+    
+    def find_named_seed(name, klass, id, fixname)
+      begin
+        klass.find(id)
+      rescue ActiveRecord::RecordNotFound => e
+        nsfinder = :"#{name}_#{fixname}"
+        raise e unless respond_to?(nsfinder)
+        send(nsfinder)
+      end
+    end
+    
+  
+  end
+end
+

data/lib/named_seeds/version.rb

@@ -0,0 +1,3 @@
+module NamedSeeds
+  VERSION = "1.0.0"
+end

data/lib/named_seeds.rb

@@ -0,0 +1,7 @@
+require 'rails'
+require 'active_record'
+require 'named_seeds/version'
+require 'named_seeds/identity'
+require 'named_seeds/read'
+require 'named_seeds/railtie'
+require 'named_seeds/active_support'

data/named_seeds.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "named_seeds/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "named_seeds"
+  gem.version       = NamedSeeds::VERSION
+  gem.authors       = ["Ken Collins"]
+  gem.email         = ["ken@metaskills.net"]
+  gem.summary       = %q|Replace ActiveRecord::Fixtures With #{your_factory_lib}.|
+  gem.description   = %q|Make you tests fast by augmenting them with transactional fixtures powered by your favorite factory library!|
+  gem.homepage      = "http://github.com/metaskills/named_seeds"
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  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'
+  gem.add_runtime_dependency     'database_cleaner'
+  gem.add_development_dependency 'sqlite3',           '~> 1.3'
+  gem.add_development_dependency 'rake',              '~> 0.9.2'
+  gem.add_development_dependency 'minitest',          '~> 2.8.1'
+end

data/test/cases/base_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class BaseTest < NamedSeeds::Spec
+  
+  describe 'identifiy' do
+    
+    it 'works on strings' do
+      NamedSeeds.identify('foo').must_equal NamedSeeds.identify('foo')
+      NamedSeeds.identify('foo').wont_equal NamedSeeds.identify('FOO')
+    end
+    
+    it 'works on symbols' do
+      NamedSeeds.identify(:foo).must_equal NamedSeeds.identify(:foo)
+    end
+    
+    it 'identifies consistently' do
+      NamedSeeds.identify(:ruby).must_equal 207281424
+      NamedSeeds.identify(:sapphire_2).must_equal 1066363776
+    end
+    
+  end
+  
+end

data/test/support/models.rb

@@ -0,0 +1,4 @@
+
+class User < ActiveRecord::Base
+  
+end

data/test/support/schema.rb

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

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: named_seeds
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ken Collins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 45
+        segments: 
+        - 2
+        - 8
+        - 1
+        version: 2.8.1
+  type: :development
+  version_requirements: *id005
+description: Make you tests fast by augmenting them with transactional fixtures powered by your favorite factory library!
+email: 
+- ken@metaskills.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/named_seeds.rb
+- lib/named_seeds/active_support.rb
+- lib/named_seeds/identity.rb
+- lib/named_seeds/railtie.rb
+- lib/named_seeds/railties/databases.rake
+- lib/named_seeds/read.rb
+- lib/named_seeds/version.rb
+- named_seeds.gemspec
+- test/cases/base_test.rb
+- test/support/models.rb
+- test/support/schema.rb
+- test/test_helper.rb
+homepage: http://github.com/metaskills/named_seeds
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: "Replace ActiveRecord::Fixtures With #{your_factory_lib}."
+test_files: 
+- test/cases/base_test.rb
+- test/support/models.rb
+- test/support/schema.rb
+- test/test_helper.rb