seedbank 0.1.3 → 0.2.0

data/README.md

@@ -81,14 +81,14 @@ Usage
 
 Seeds files are just plain old Ruby executed in your rails application environment so anything you could type into the rails console will work in your seeds.
 
-The seed files under db/seeds are run first in alphanumeric order followed by the ones in the db/seeds/RAILS_ENV. You can add dependencies to your seed files
-to enforce the run order. for example;
-
 db/seeds/companies.seeds.rb
 ```ruby
-Company.find_or_create_by_name('Hatch', :url => 'http://thisishatch.co.uk' ) 
+Company.find_or_create_by_name('Hatch', :url => 'http://thisishatch.co.uk' )
 ```
 
+The seed files under db/seeds are run first in alphanumeric order followed by the ones in the db/seeds/RAILS_ENV. You can add dependencies to your seed files
+to enforce the run order. for example;
+
 db/seeds/users.seeds.rb
 ```ruby
 after :companies do
@@ -114,6 +114,16 @@ after :projects, :users do
 end
 ```
 
+If the dependencies are in one of the environment folders, you need to namespace the parent task:
+
+db/seeds/development/users.seeds.rb
+```ruby
+after "development:companies" do
+  company = Company.find_by_name('Hatch')
+  company.users.create(:first_name => 'James', :last_name => 'McCarthy')
+end
+```
+
 Contributors
 ============
 ```shell
@@ -123,6 +133,8 @@ git log | grep Author | sort | uniq
 * James McCarthy
 * Andy Triggs
 * Philip Arndt
+* Peter Suschlik
+* Joost Baaij
 
 Note on Patches/Pull Request
 ============================

data/Rakefile

@@ -7,7 +7,7 @@ desc 'Test the seedbank gem.'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
-  t.pattern = 'test/seedbank/**/*_test.rb'
+  t.pattern = 'test/lib/**/*_test.rb'
   t.verbose = true
 end
 

data/TODO.txt

@@ -1,4 +1,4 @@
 * Add generator for seeds directories
 * Add generator for seeds data
-* Include methods into the seed.rake file directly so they aren't bleeding into the rest of rake
-* Checkout the circular dependency caused by re-naming the original db:seed task.
+* Add ability to add or update records in place
+* Make framework agnostic

data/lib/seedbank/dsl.rb

@@ -2,35 +2,44 @@ module Seedbank
   module DSL
 
     def self.included(base)
-      Rake::Task.extend(Seedbank::RenameTask)
+      Rake::Task.send(:include, Seedbank::RenameTask)
       Rake::Application.send(:include, Seedbank::TaskManager)
     end
 
-    def override_task(*args, &block)
-      name, params, deps = Rake.application.resolve_args(args.dup)
-      fq_name = Rake.application.instance_variable_get(:@scope).dup.push(name).join(':')
-      new_name = "#{fq_name}:original"
-      Rake::Task.rename_task(fq_name, new_name)
-      Rake::Task.define_task(*args, &block)
+    def override_seed_task(*args, &block)
+      Rake.application.override_task(*args, &block)
     end
 
-    # Creates a task namespaced in @seeds_path
-    def define_seed_task(seed_file)
-      relative_root = seed_file.sub(seeds_root + '/', '')
-      scopes = File.dirname(relative_root).gsub(/^\./, '').split('/').unshift('seed')
+    def seed_task_from_file(seed_file)
+      scopes  = scope_from_seed_file(seed_file)
       fq_name = scopes.push(File.basename(seed_file, '.seeds.rb')).join(':')
+      args    = Rake::Task.task_defined?('db:abort_if_pending_migrations') ? { fq_name => 'db:abort_if_pending_migrations' } : fq_name
 
-      args = Rake::Task.task_defined?('db:abort_if_pending_migrations') ? { fq_name => 'db:abort_if_pending_migrations' } : fq_name
-      task = Rake::Task.define_task(args) do |seed_task|
+      define_seed_task(seed_file, args)
+    end
+
+    def glob_seed_files_matching(*args, &block)
+      Dir.glob(File.join(seeds_root, *args), &block)
+    end
+
+    def define_seed_task(seed_file, *args)
+      task = Rake::Task.define_task(*args) do |seed_task|
         Seedbank::Runner.new(seed_task).module_eval(File.read(seed_file)) if File.exist?(seed_file)
       end
       task.add_description "Load the seed data from #{seed_file}"
-      fq_name
+      task.name
+    end
+
+    def scope_from_seed_file(seed_file)
+      dirname = Pathname.new(seed_file).dirname
+      return [] if dirname == seeds_root
+      relative = dirname.relative_path_from(seeds_root)
+      relative.to_s.split(File::Separator)
     end
 
     def seeds_root
-      Seedbank.seeds_root
+      Pathname.new Seedbank.seeds_root
     end
 
   end
-end
+end

data/lib/seedbank/rename_task.rb

@@ -1,8 +1,8 @@
 module Seedbank
   module RenameTask
 
-    def rename_task(fq_name, new_name)
-      Rake.application.rename_task(fq_name, new_name)
+    def rename(new_name)
+      @name = new_name
     end
 
   end

data/lib/seedbank/task_manager.rb

@@ -1,9 +1,20 @@
 module Seedbank
   module TaskManager
 
+    def override_task(*args, &block)
+      name, params, deps = resolve_args(args.dup)
+      fq_name = current_scope.push(name).join(':')
+      new_name = "#{fq_name}:original"
+      unless Rake::Task.task_defined?(new_name)
+        rename_task(fq_name, new_name)
+        define_task(Rake::Task, *args, &block)
+      end
+    end
+
     def rename_task(fq_name, new_name)
-      @tasks[new_name] = @tasks.delete(fq_name)
-      @tasks[new_name].instance_variable_set('@name', new_name)
+      task = @tasks.delete(fq_name)
+      task.rename(new_name)
+      @tasks[new_name] = task
     end
 
   end

data/lib/seedbank/version.rb

@@ -1,3 +1,3 @@
 module Seedbank
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/tasks/seed.rake

@@ -3,42 +3,32 @@ namespace :db do
   include Seedbank::DSL
 
   base_dependencies   = ['db:seed:original']
-  override_dependency = []
-  common_dependencies = []
+  override_dependency = ['db:seed:common']
 
-  # Create seed tasks for all the seeds in seeds_path and add them to the dependency
-  # list along with the original db/seeds.rb.
-  Dir.glob(File.join(seeds_root, '*.seeds.rb')).each do |seed_file|
-    common_dependencies << define_seed_task(seed_file)
-  end
+  namespace :seed do
+    # Create seed tasks for all the seeds in seeds_path and add them to the dependency
+    # list along with the original db/seeds.rb.
+    common_dependencies = glob_seed_files_matching('*.seeds.rb').map { |seed_file| seed_task_from_file(seed_file) }
 
-  desc "Load the seed data from db/seeds.rb and db/seeds/*.seeds.rb."
-  task ['seed', 'common'] => base_dependencies + common_dependencies
+    desc "Load the seed data from db/seeds.rb and db/seeds/*.seeds.rb."
+    task 'common' => base_dependencies + common_dependencies
 
-  # Glob through the directories under seeds_path assuming they are all environments
-  # and create a task for each and add it to the dependency list. Then create a task
-  # for the environment
-  Dir[seeds_root + '/*/'].each do |e|
-    environment = File.basename(e)
+    # Glob through the directories under seeds_path and create a task for each adding it to the dependency list.
+    # Then create a task for the environment
+    glob_seed_files_matching('/*/').each do |directory|
+      environment = File.basename(directory)
 
-    environment_dependencies = []
-    Dir.glob(File.join(seeds_root, environment, '*.seeds.rb')).sort.each do |seed_file|
-      environment_dependencies << define_seed_task(seed_file)
-    end
+      environment_dependencies = glob_seed_files_matching(environment, '*.seeds.rb').sort.map { |seed_file| seed_task_from_file(seed_file) }
 
-    desc <<-EOT
-      Load the seed data from db/seeds.rb, db/seeds/*.seeds.rb and db/seeds/#{environment}/*.seeds.rb.
-    EOT
-    task ['seed', environment] => ['db:seed:common'] + environment_dependencies
+      desc "Load the seed data from db/seeds.rb, db/seeds/*.seeds.rb and db/seeds/#{environment}/*.seeds.rb."
+      task environment => ['db:seed:common'] + environment_dependencies
 
-    override_dependency << "db:seed:#{environment}" if Rails.env == environment
+      override_dependency << "db:seed:#{environment}" if defined?(Rails) && Rails.env == environment
+    end
   end
 
-  # Change db:seed task to run all the base seeds tasks defined above.
-  desc <<-EOT
-    Load the seed data from db/seeds.rb, db/seeds/*.seeds.rb and db/seeds/ENVIRONMENT/*.seeds.rb.
-    ENVIRONMENT is the current environment in Rails.env.
-  EOT
-  override_task :seed => ['db:seed:common'] + override_dependency
+  # Override db:seed to run all the common and environments seeds plus the original db:seed.
+  desc "Load the seed data from db/seeds.rb, db/seeds/*.seeds.rb and db/seeds/ENVIRONMENT/*.seeds.rb. ENVIRONMENT is the current environment in Rails.env."
+  override_seed_task :seed => override_dependency
 
 end

data/test/dummy/db/seeds/development/users.seeds.rb

@@ -0,0 +1 @@
+FakeModel.seed('development:users')

data/test/dummy/lib/tasks/dsl.rake

@@ -0,0 +1,4 @@
+namespace :seedy do
+  include Seedbank::DSL
+  task :users
+end

data/test/lib/seedbank/dsl_test.rb

@@ -0,0 +1,146 @@
+require 'test_helper'
+
+describe Seedbank::DSL do
+
+  describe "scope_from_seed_file" do
+
+    it "is added to the namesapce" do
+      ns = Rake.application.in_namespace(:seedy) { self }
+
+      ns.must_respond_to :scope_from_seed_file
+    end
+
+    describe "in an environment directory" do
+
+      let(:seed_file) { File.expand_path('development/users.seeds.rb', Seedbank.seeds_root) }
+      let(:seed_namespace) { %w(development) }
+
+      subject { Seedbank::DSL.scope_from_seed_file seed_file }
+
+      it "returns the enviroment scope" do
+        subject.must_equal seed_namespace
+      end
+    end
+
+    describe "in a nested directory" do
+
+      let(:seed_file) { File.expand_path('development/shared/accounts.seeds.rb', Seedbank.seeds_root) }
+      let(:seed_namespace) { %w(development shared) }
+
+      subject { Seedbank::DSL.scope_from_seed_file seed_file }
+
+      it "returns the nested scope" do
+        subject.must_equal seed_namespace
+      end
+    end
+
+    describe "in seeds root" do
+
+      let(:seed_file) { File.expand_path('no_block.seeds.rb', Seedbank.seeds_root) }
+
+      subject { Seedbank::DSL.scope_from_seed_file seed_file }
+
+      it "returns an array" do
+        subject.must_be_instance_of Array
+      end
+
+      it "must be empty" do
+        subject.must_be_empty
+      end
+    end
+  end
+
+  describe "seeds_root" do
+
+    let(:seeds_root) { '/my/seeds/directory' }
+
+    subject { Seedbank::DSL.seeds_root }
+
+    it "returns a Pathname" do
+      flexmock(Seedbank).should_receive(:seeds_root).and_return(seeds_root).by_default
+
+      subject.must_equal Pathname.new(seeds_root)
+    end
+
+  end
+
+  describe "glob_seed_files_matching" do
+
+    describe "with no namespace" do
+
+      let(:pattern) { '*.seeds.rb' }
+
+      it "returns all the files matching the pattern in seeds_root" do
+        expected_files = Dir.glob(File.join(Seedbank.seeds_root, pattern))
+
+        Seedbank::DSL.glob_seed_files_matching(pattern).must_equal expected_files
+      end
+
+    end
+
+    describe "with a namespace" do
+
+      let(:pattern) { '*.seeds.rb' }
+      let(:namespace) { 'development' }
+
+      it "returns all the files matching the pattern in seeds_root" do
+        expected_files = Dir.glob(File.join(Seedbank.seeds_root, namespace, pattern))
+
+        Seedbank::DSL.glob_seed_files_matching(namespace, pattern).must_equal expected_files
+      end
+
+    end
+
+  end
+
+  describe "define_seed_task" do
+
+    let(:name) { 'scoped:my_seed' }
+    let(:dependencies) { ['environment'] }
+    let(:seed_file) { File.expand_path('development/users.seeds.rb', Seedbank.seeds_root) }
+
+    it "returns a fully qualified task name" do
+      returned_name = Seedbank::DSL.define_seed_task(seed_file, name => dependencies)
+
+      returned_name.must_equal name
+    end
+
+    it "creates a Rake Task" do
+      Seedbank::DSL.define_seed_task(seed_file, name => dependencies)
+
+      Rake::Task[name].wont_be_nil
+    end
+
+    it "sets Rake Task dependencies" do
+      Seedbank::DSL.define_seed_task(seed_file, name => dependencies)
+
+      Rake::Task[name].prerequisite_tasks.must_equal dependencies.map { |dependency| Rake::Task[dependency] }
+    end
+
+    it "sets Rake Task description" do
+      Seedbank::DSL.define_seed_task(seed_file, name => dependencies)
+
+      Rake::Task[name].comment.must_equal "Load the seed data from #{seed_file}"
+    end
+
+    it "sets Rake Task action to the seed_file contents" do
+      Seedbank::DSL.define_seed_task(seed_file, name => dependencies)
+
+      flexmock(FakeModel).should_receive(:seed).with('development:users').once.ordered
+
+      Rake::Task[name].invoke
+    end
+  end
+
+  describe "override_seed_task" do
+
+    let(:arguments) { 'my_task' }
+
+    it "calls Rake::TaskManager#override_task" do
+      block = proc {}
+      flexmock(Rake.application).should_receive(:override_task).with(arguments, block).once
+
+      Seedbank::DSL.override_seed_task(arguments, &block)
+    end
+  end
+end

data/test/lib/seedbank/rename_task_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+describe Seedbank::RenameTask do
+
+  describe "rename" do
+
+    let(:original_name) { 'original_name' }
+    let(:new_name) { 'new_name' }
+
+    subject { Rake::Task.define_task(original_name) }
+
+    before { subject.rename(new_name) }
+
+    it "changes the tasks name" do
+      subject.name.must_equal new_name
+    end
+
+  end
+end

data/test/lib/seedbank/task_manager_test.rb

@@ -0,0 +1,104 @@
+require 'test_helper'
+
+describe Seedbank::TaskManager do
+
+  describe "override_task" do
+
+    let(:task_name) { 'my_task' }
+
+    describe "with no original version of the task exists" do
+
+      it "appends :original to the task name" do
+        task = Rake::Task.define_task(task_name)
+
+        Rake.application.override_task(task_name)
+
+        task.must_equal Rake.application.lookup('original', [task_name])
+      end
+
+      it "creates a new task in place of the original" do
+        Rake::Task.define_task(task_name)
+        task = Rake.application.override_task(task_name => [:dependency])
+
+        task.must_be_instance_of Rake::Task
+      end
+
+      it "adds the supplied dependencies to the new task" do
+        dependency = ['db:seed:dependency']
+
+        Rake::Task.define_task(task_name)
+        task = Rake.application.override_task(task_name => dependency)
+
+        task.prerequisites.must_equal dependency
+      end
+
+      it "adds the supplied action to the new task" do
+        action = proc {}
+        Rake::Task.define_task(task_name)
+        task = Rake.application.override_task(task_name, &action)
+
+        task.actions.must_equal [action]
+      end
+    end
+
+    describe "when the original version of the task exists" do
+
+      let(:original_name) { [task_name, 'original'].join(':') }
+
+      it "leaves the original task in place" do
+        task     = Rake::Task.define_task(task_name)
+        original = Rake::Task.define_task(original_name)
+        new_task = Rake.application.override_task(task_name)
+
+        Rake::Task[task_name].must_equal task
+      end
+
+      it "leaves the task:original task in place" do
+        task     = Rake::Task.define_task(task_name)
+        original = Rake::Task.define_task(original_name)
+        new_task = Rake.application.override_task(task_name)
+
+        Rake::Task[original].must_equal original
+      end
+
+      it "does not create a new task" do
+        task     = Rake::Task.define_task(task_name)
+        original = Rake::Task.define_task(original_name)
+        new_task = Rake.application.override_task(task_name)
+
+        new_task.must_be_nil
+      end
+    end
+  end
+
+  describe "rename_task" do
+
+    let(:original_name) { 'original_name' }
+    let(:new_name) { 'new_name' }
+
+    before do
+      Rake::Task.define_task(original_name)
+    end
+
+    it "changes the tasks name" do
+      task = Rake::Task[original_name]
+      flexmock(task).should_receive(:rename).with(new_name).once
+
+      Rake.application.rename_task(original_name, new_name)
+    end
+
+    it "removes the original task name" do
+      Rake.application.rename_task(original_name, new_name)
+
+      Rake.application.lookup(original_name).must_be_nil
+    end
+
+    it "give the original task the new name" do
+      original_task = Rake::Task[original_name]
+
+      Rake.application.rename_task(original_name, new_name)
+
+      Rake.application.lookup(new_name).must_equal original_task
+    end
+  end
+end

data/test/lib/tasks/seed_rake_test.rb

@@ -0,0 +1,126 @@
+require 'test_helper'
+
+describe 'Seedbank rake.task' do
+
+  describe "seeds with dependency" do
+
+    subject { Rake.application.tasks_in_scope %w[db seed] }
+
+    it "creates all the seed tasks" do
+      seeds = %w(db:seed:circular1 db:seed:circular2 db:seed:common db:seed:dependency db:seed:dependency2
+        db:seed:dependent db:seed:dependent_on_nested db:seed:dependent_on_several db:seed:development
+        db:seed:development:users db:seed:no_block db:seed:original)
+
+      subject.map(&:to_s).must_equal seeds
+    end
+  end
+
+  describe "common seeds in the root directory" do
+
+    Dir[File.expand_path('../../../dummy/db/seeds/*.seeds.rb', __FILE__)].each do |seed_file|
+      seed = File.basename(seed_file, '.seeds.rb')
+
+      describe seed do
+
+        subject { Rake.application.lookup(seed, %w[db seed]) }
+
+        it "is dependent on db:abort_if_pending_migrations" do
+          subject.prerequisites.must_equal %w[db:abort_if_pending_migrations]
+        end
+      end
+    end
+  end
+
+  describe "db:seed:common" do
+
+    subject { Rake::Task['db:seed:common'] }
+
+    it "is dependent on the common seeds and db:seed:original" do
+      prerequisite_seeds = Dir[File.expand_path('../../../dummy/db/seeds/*.seeds.rb', __FILE__)].map do |seed_file|
+        ['db', 'seed', File.basename(seed_file, '.seeds.rb')].join(':')
+      end.unshift('db:seed:original')
+
+      subject.prerequisites.must_equal prerequisite_seeds
+    end
+  end
+
+  describe "db:seed:original" do
+
+    subject { Rake::Task['db:seed:original'] }
+
+    it "has no dependencies" do
+      subject.prerequisites.must_be_empty
+    end
+
+    describe "when seeds are reloaded" do
+
+      before do
+        Dummy::Application.load_tasks
+      end
+
+      it "still has no dependencies" do
+        subject.prerequisites.must_be_empty
+      end
+    end
+  end
+
+  describe "environment seeds" do
+
+    Dir[File.expand_path('../../../dummy/db/seeds', __FILE__) + '/*/'].each do |environment_directory|
+      environment = File.basename(environment_directory)
+
+      describe "seeds in the #{environment} environment" do
+
+        Dir[File.expand_path("../../../dummy/db/seeds/#{environment}/*.seeds.rb", __FILE__)].each do |seed_file|
+          seed = File.basename(seed_file, '.seeds.rb')
+
+          describe seed do
+
+            subject { Rake.application.lookup(seed, ['db', 'seed', environment]) }
+
+            it "is dependent on db:abort_if_pending_migrations" do
+              subject.prerequisites.must_equal %w[db:abort_if_pending_migrations]
+            end
+          end
+        end
+      end
+
+      describe "db:seed:#{environment}" do
+
+        subject { Rake.application.lookup(environment, %w[db seed]) }
+
+        it "is dependent on the seeds in the environment directory" do
+          prerequisite_seeds = Dir[File.expand_path("../../../dummy/db/seeds/#{environment}/*.seeds.rb", __FILE__)].map do |seed_file|
+            ['db', 'seed', environment, File.basename(seed_file, '.seeds.rb')].join(':')
+          end.unshift('db:seed:common')
+
+          subject.prerequisites.must_equal prerequisite_seeds
+        end
+      end
+    end
+  end
+
+  describe "db:seed task" do
+
+    subject { Rake::Task['db:seed'] }
+
+    describe "when no environment seeds are defined" do
+
+      it "is dependent on db:seed:common" do
+        subject.prerequisites.must_equal %w[db:seed:common]
+      end
+    end
+
+    describe "when environment seeds are defined" do
+
+      it "is dependent on db:seed:common" do
+        flexmock(Rails).should_receive(:env).and_return('development').once
+
+        Rake.application.clear
+        Dummy::Application.load_tasks
+
+        subject.prerequisites.must_equal %w[db:seed:common db:seed:development]
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require "flexmock"
-require 'minitest/autorun'
+require 'minitest/spec'
 
 # Configure Rails Environment
 environment  = ENV["RAILS_ENV"] = 'test'
@@ -24,4 +24,5 @@ class Seedbank::Spec < MiniTest::Spec
 
 end
 
-MiniTest::Spec.register_spec_type(/^Seedbank::/, Seedbank::Spec)
+MiniTest::Spec.register_spec_type(/^Seedbank/i, Seedbank::Spec)
+MiniTest::Unit.autorun

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seedbank
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000 Z
+date: 2012-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -107,9 +107,16 @@ files:
 - test/dummy/db/seeds/dependent.seeds.rb
 - test/dummy/db/seeds/dependent_on_nested.seeds.rb
 - test/dummy/db/seeds/dependent_on_several.seeds.rb
+- test/dummy/db/seeds/development/shared/accounts.seeds.rb
+- test/dummy/db/seeds/development/users.seeds.rb
 - test/dummy/db/seeds/no_block.seeds.rb
+- test/dummy/lib/tasks/dsl.rake
 - test/dummy/script/rails
-- test/seedbank/runner_test.rb
+- test/lib/seedbank/dsl_test.rb
+- test/lib/seedbank/rename_task_test.rb
+- test/lib/seedbank/runner_test.rb
+- test/lib/seedbank/task_manager_test.rb
+- test/lib/tasks/seed_rake_test.rb
 - test/test_helper.rb
 homepage: http://github.com/james2m/seedbank
 licenses: []
@@ -166,7 +173,14 @@ test_files:
 - test/dummy/db/seeds/dependent.seeds.rb
 - test/dummy/db/seeds/dependent_on_nested.seeds.rb
 - test/dummy/db/seeds/dependent_on_several.seeds.rb
+- test/dummy/db/seeds/development/shared/accounts.seeds.rb
+- test/dummy/db/seeds/development/users.seeds.rb
 - test/dummy/db/seeds/no_block.seeds.rb
+- test/dummy/lib/tasks/dsl.rake
 - test/dummy/script/rails
-- test/seedbank/runner_test.rb
+- test/lib/seedbank/dsl_test.rb
+- test/lib/seedbank/rename_task_test.rb
+- test/lib/seedbank/runner_test.rb
+- test/lib/seedbank/task_manager_test.rb
+- test/lib/tasks/seed_rake_test.rb
 - test/test_helper.rb