seedbank 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c3ba57609267657c1c16f55b5e2de397c104487
-  data.tar.gz: 0f2fde06d7f9288761c22607739677558065a1f4
+  metadata.gz: e92838099b21443451e9fd5a5bfecdf5f3874e65
+  data.tar.gz: 31061861c8211b79dd619fb2017527d748ea2291
 SHA512:
-  metadata.gz: a8e3cf1e8ace47e20bb827fd6f67a6037ec3c2f2b32a85b64dd3909b53e4c6640f32f2d9bbcb3c2e2227666dd25451eb85915d55309334b2cb46e6062572a933
-  data.tar.gz: 4d91e63092b1acceb133552a223f0669b94875710dec4639bca7ae67001de201491cd67521bb1941c42f29915cd8a074ee04433b79082209450e189137dd7eec
+  metadata.gz: 1f9258f988c7ac6f2438a6974057c8b09e5fd6692196af040f60dcbf36c3e24c0d6427a0677d1bd670e73f9c75bc449cfab51c8481f1321da2b2fa9fd95d1968
+  data.tar.gz: 5e65fa43aa95cca1612a970e1fd47f11a2f66eb3aafc4ee0ee5f60669aed750f3decf570c3dfc0fb1e0664f6b3122ebaae7cf0983c13c7b47386f94eaed0b637

data/.gitignore

@@ -27,4 +27,5 @@ test/dummy/log
 .ruby-version
 .ruby-gemset
 Gemfile.lock
-.bundle
+.bundle
+.byebug_history

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  config_file: .rubocop.yml
+

data/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_from: .rubocop_todo.yml
+Style/StringLiteral:
+  Enabled: true
+  EnforcedStyle: single_quotes
+Style/MutableConstant:
+  Exclude:
+    - 'lib/seedbank/version.rb'
+Lint/ScriptPermission:
+  Exclude:
+    - 'test/dummy/Rakefile'
+Metrics/LineLength:
+  Exclude:
+    - 'test/**/*'
+  Max: 132
+Style/ConditionalAssignment:
+  Enabled: false
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,29 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-02-12 18:38:59 +0700 using RuboCop version 0.47.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 124
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'test/test_helper.rb'
+
+# Offense count: 4
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/seedbank.rb'
+    - 'lib/seedbank/dsl.rb'
+    - 'lib/seedbank/railtie.rb'
+    - 'lib/seedbank/runner.rb'

data/.travis.yml

@@ -1,15 +1,16 @@
 language: ruby
 
 rvm:
-  - ree
-  - 1.8.7
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - jruby-18mode # JRuby in 1.8 mode
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-2
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
 
 gemfile:
-  - gemfiles/rake0.9.gemfile
   - gemfiles/rake10.gemfile
+  - gemfiles/rake11.gemfile
+  - gemfiles/rake12.gemfile
+
+before_install:
+  - gem install bundler -v '~> 1.11' --no-ri --no-rdoc

data/Gemfile

@@ -1,12 +1,13 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in seedbank.gemspec
 gemspec
 
-gem 'rake', :group => :test
+gem 'rubocop', group: :development
 
 # for CRuby, Rubinius, including Windows and RubyInstaller
-gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
+gem 'sqlite3', platform: %i[ruby mswin mingw]
 
 # for JRuby
-gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby

data/README.md

@@ -1,7 +1,7 @@
 Seedbank
 ========
 
-Seedbank allows you to structure your Rails seed data instead of having it all dumped into one large file. I find my seed data tended to fall into two categories:
+Seedbank allows you to structure your apps seed data instead of having it all dumped into one large file. I find my seed data tended to fall into two categories:
 
 1. Stuff that the entire application requires.
 2. Stuff to populate my development and staging environments.
@@ -14,6 +14,11 @@ The reason behind Seedbank is laziness. When I checkout or re-visit a project I
 
 To achieve this slothful aim, Seedbank renames the original db:seed rake task to db:seed:original, makes it a dependency for all the Seedbank seeds and adds a new db:seed task that loads all the common seeds in db/seeds plus all the seeds for the current Rails environment.
 
+Although originally built for Rails, Seedbank can work stand alone thanks to Aleksey Ivanov.
+
+[![Build Status](https://travis-ci.org/james2m/seedbank.svg?branch=master)](https://travis-ci.org/james2m/seedbank)
+[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
+
 Example
 =======
 
@@ -46,12 +51,16 @@ will load the seeds in `db/seeds.rb`, `db/seeds/bar.seeds.rb` and `db/seeds/foo.
 
 Installation
 ============
+
+Seedbank > 0.5.0 uses refinements and no longer supports rubies below 2.x. If you are using an older Ruby you'll have to stick with 0.4.0 and below.
+
+I have also dropped support for Rubinius and JRuby. I'm happy to accept pull requests for them, but don't have the time to hack together the test environment. If you want to contribute, please ensure that he travis.yml is in line as it's the only way I will test these two environments.
+
 ### Rails 5.x
 
-Seedbank has not been updated to work with Rails 5. I've not tested it with 5.x and am working on a new version specifically for 5.x. That said, I believe some
-people are using it with no problems.
+Seedbank has not been updated to work with Rails 5. I've used it with 5.x apps and am working on a new version specifically for 5.x. Other people are also reporting using it with no problems.
 
-### Rails 3.x and 4.x
+### Rails 4.x and above
 
 Add the seedbank gem to your Gemfile.  In Gemfile:
 
@@ -61,21 +70,22 @@ gem "seedbank"
 
 That's it!
 
-### Rails 2.x
+### Non Rails apps
 
-Add to your config/environment.rb
+Although originally built for Rails, Seedbank should work fine in other environments such as Padrino, Grape or the new new hotness. please let us know how you get on.
 
-```ruby
-config.gem 'seedbank'
-```
+### Rails 3.x
 
-Install the gem:
+Seedbank 0.5.0 onwards is no longer tested against Rails 3.x, that isn't to say it will not work. I
+will not fix issues against Rails 3.x, but will accept tested pull requests.
 
-    $ rake gems:install
+### Rails 2.x
 
-Or, if you're using Bundler:
+Seedbank hasn't supported Rails 2.x for some time. You'll need to use the 0.2.1 version. In your Gemfile:
 
-    $ bundle install
+```ruby
+gem "seedbank", '~> 0.2.1'
+```
 
 Then in the bottom of your application's Rakefile:
 
@@ -89,7 +99,7 @@ If you vendor the gem you'll need to change the require to the specific path.
 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. Seeds files have to be named with the '.seeds.rb' extension.
+Seeds files are just plain old Ruby executed in your application environment so anything you could type into the console will work in your seeds. Seeds files have to be named with the '.seeds.rb' extension.
 
 db/seeds/companies.seeds.rb
 ```ruby
@@ -134,24 +144,39 @@ after "development:companies" do
 end
 ```
 
+*Note* - If you experience any errors like `Don't know how to build task 'db:seed:users'`. Ensure you are specifying `after 'development:companies'` like the above example. This is the usual culprit (YMMV).
+
 ### Defining and using methods
 
-As seed files are evaluated within blocks, methods need to be defined and used as per below:
+As seed files are evaluated within a single runner in dependency order, any methods defined earlier in the run will be available across dependent tasks. I
+recommend keeping method definitions in the seed file that uses them. Alternatively if you have many common methods, put them into a module and extend the
+runner with the module.
 
+db/seeds/support.rb
 ```ruby
-class << self
-  def create_user name
-    user = User.where(name: name).first_or_create
-    # ...
+module Support
+  def notify(filename)
+    puts "Seeding: #{filename}"
   end
 end
+```
 
-['Greg', 'Daniel'].each do |name|
-  create_user name
-end
+db/seeds/common.seeds.rb
+```ruby
+require_relative 'support'
+extend Support
+
+notify(__FILE__)
 ```
 
-*Note* - If you experience any errors like `Don't know how to build task 'db:seed:users'`. Ensure your specifying `after 'development:companies'` like the above example. This is the usual culprit (YMMV).
+To keep this dry you could make the seeds dependent on a support seed that extends the runner.
+
+db/seeds/users.seeds.rb
+```ruby
+after :common do
+  notify(__FILE__)
+end
+```
 
 Contributors
 ============
@@ -171,7 +196,7 @@ git log | grep Author | sort | uniq
 * lulalala
 * pivotal-cloudplanner
 * vkill
-
+* Aleksey Ivanov
 
 Note on Patches/Pull Request
 ============================
@@ -185,4 +210,4 @@ Note on Patches/Pull Request
 
 Copyright
 =========
-Copyright (c) 2011-2015 James McCarthy, released under the MIT license
+Copyright (c) 2011-2017 James McCarthy, released under the MIT license

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 require 'rake'
 require 'rake/testtask'
@@ -19,4 +20,4 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-task :default => ["test"]
+task default: ['test']

data/TODO.txt

@@ -1,4 +1,4 @@
 * Add generator for seeds directories
-* Add generator for seeds data
-* Add ability to add or update records in place
-* Make framework agnostic
+* Add platform independent test environment
+* Add generator for seeds data?
+* Add ability to add or update records in place?

data/gemfiles/rake10.gemfile

@@ -9,7 +9,4 @@ gem 'rake', '~>10.0', :group => :test
 gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
 
 # for JRuby
-gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
-
-gem 'seedbank', :path => '../'
-
+gem 'activerecord-jdbcsqlite3-adapter', '~>1.3.25', :platform => :jruby

data/gemfiles/rake11.gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in seedbank.gemspec
+gemspec :path=>"../"
+
+gem 'rake', '~>11.0', :group => :test
+
+# for CRuby, Rubinius, including Windows and RubyInstaller
+gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
+
+# for JRuby
+gem 'activerecord-jdbcsqlite3-adapter', '~>1.3.25', :platform => :jruby

data/gemfiles/{rake0.9.gemfile → rake12.gemfile}

@@ -1,14 +1,13 @@
 source "http://rubygems.org"
 
 # Specify your gem's dependencies in seedbank.gemspec
-gemspec :path => "../"
+gemspec :path=>"../"
 
-gem 'rake', '~>0.9.0', :group => :test
+gem 'rake', '~>12.0', :group => :test
 
 # for CRuby, Rubinius, including Windows and RubyInstaller
 gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
 
 # for JRuby
-gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+gem 'activerecord-jdbcsqlite3-adapter', '~>1.3.25', :platform => :jruby
 
-gem 'seedbank', :path => '../'

data/lib/seedbank/dsl.rb

@@ -1,64 +1,86 @@
+# frozen_string_literal: true
 module Seedbank
   module DSL
+    refine Object do
+      def override_seed_task(*args)
+        task_name, _, deps = Rake.application.resolve_args(args)
+        seed_task = Rake::Task.task_defined?(task_name) ? Rake::Task[task_name].clear : Rake::Task.define_task(task_name)
+        add_comment_to(seed_task, Rake.application.last_description)
+        add_environment_dependency(seed_task)
+        seed_task.enhance deps
+      end
 
-    def override_seed_task(*args)
-      task_name, arg_names, deps = Rake.application.resolve_args(args)
-      seed_task = Rake::Task.task_defined?(task_name) ? Rake::Task[task_name].clear : Rake::Task.define_task(task_name)
-      add_comment_to(seed_task, Rake.application.last_description)
-      seed_task.enhance deps
-    end
+      def seed_tasks_matching(*pattern)
+        glob_seed_files_matching(*pattern)
+          .sort
+          .map { |seed_file| seed_task_from_file(seed_file) }
+      end
 
-    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(':')
+      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(':')
 
-      define_seed_task(seed_file, fq_name)
-    end
+        define_seed_task(seed_file, fq_name)
+      end
 
-    def glob_seed_files_matching(*args, &block)
-      Dir.glob(File.join(seeds_root, *args), &block)
-    end
+      def glob_seed_files_matching(*args, &block)
+        Dir.glob(File.join(seeds_root, *args), &block)
+      end
 
-    def runner
-      @_seedbank_runner ||= Seedbank::Runner.new
-    end
+      def define_seed_task(seed_file, *args)
+        task = Rake::Task.define_task(*args) do |seed_task|
+          runner.evaluate(seed_task, seed_file) if File.exist?(seed_file)
+        end
 
-    def define_seed_task(seed_file, *args)
-      task = Rake::Task.define_task(*args) do |seed_task|
-        runner.evaluate(seed_task, seed_file) if File.exist?(seed_file)
+        relative_file = Pathname.new(seed_file).relative_path_from(Seedbank.application_root)
+
+        task.add_description "Load the seed data from #{relative_file}"
+        add_environment_dependency(task)
+        task.name
       end
 
-      task.add_description "Load the seed data from #{seed_file}"
+      def original_seeds_file
+        @_seedbank_original ||= existent(Pathname.new('../seeds.rb').expand_path(seeds_root))
+      end
 
-      if Rake::Task.task_defined?('db:abort_if_pending_migrations')
-        task.enhance(['db:abort_if_pending_migrations'])
-      elsif Rake::Task.task_defined?(':environment')
-        task.enhance([':environment'])
+      def seeds_root
+        Pathname.new Seedbank.seeds_root
       end
 
-      task.name
-    end
+      private
 
-    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 existent(path)
+        String(path) if path.exist?
+      end
 
-    def seeds_root
-      Pathname.new Seedbank.seeds_root
-    end
+      def scope_from_seed_file(seed_file)
+        dirname = Pathname.new(seed_file).dirname
+        return [] if dirname == seeds_root
+        dirname
+          .relative_path_from(seeds_root)
+          .to_s
+          .split(File::Separator)
+      end
 
-    private
+      def add_environment_dependency(task)
+        if Rake::Task.task_defined?('db:abort_if_pending_migrations')
+          task.enhance(['db:abort_if_pending_migrations'])
+        elsif defined?(Rails)
+          task.enhance([:environment])
+        end
+      end
 
-    def add_comment_to(seed_task, comment)
-      if seed_task.respond_to?(:clear_comments)
-        seed_task.comment = comment
-      else
-        seed_task.send :instance_variable_set, '@full_comment', comment
+      def runner
+        @_seedbank_runner ||= Seedbank::Runner.new
       end
-    end
 
+      def add_comment_to(seed_task, comment)
+        if seed_task.respond_to?(:clear_comments)
+          seed_task.comment = comment
+        else
+          seed_task.send :instance_variable_set, '@full_comment', comment
+        end
+      end
+    end
   end
 end

data/lib/seedbank/railtie.rb

@@ -1,13 +1,8 @@
-require 'seedbank'
-require 'rails'
-
+# frozen_string_literal: true
 module Seedbank
   class Railtie < Rails::Railtie
-
     rake_tasks do
-      Seedbank.seeds_root = File.expand_path('db/seeds', Rails.root)
       Seedbank.load_tasks
     end
-
   end
-end
+end

data/lib/seedbank/runner.rb

@@ -1,33 +1,10 @@
+# frozen_string_literal: true
 module Seedbank
   class Runner
-
     def initialize
       @_memoized = {}
     end
 
-    def let(name, &block)
-      name = String(name)
-
-      raise ArgumentError.new("#{name} is already defined") if respond_to?(name, true)
-
-      __eigenclass.instance_exec(name) do |name|
-        define_method(name) do
-          @_memoized.fetch(name) { |key| @_memoized[key] = instance_eval(&block) }
-        end
-      end
-
-    end
-
-    def let!(name, &block)
-      let(name, &block)
-      send name
-    end
-
-    def evaluate(seed_task, seed_file)
-      @_seed_task = seed_task
-      instance_eval(File.read(seed_file), seed_file)
-    end
-
     # Run this seed after the specified dependencies have run
     # @param dependencies [Array] seeds to run before the block is executed
     #
@@ -42,26 +19,36 @@ module Seedbank
     #
     # Would look for a db/seeds/shared/users.seeds.rb seed and execute it.
     def after(*dependencies, &block)
-      dependencies.flatten!
-      dependencies.map! { |dep| "db:seed:#{dep}"}
-      dependent_task_name =  @_seed_task.name + ':body'
+      depends_on = dependencies.flat_map { |dep| "db:seed:#{dep}" }
+      dependent_task_name = @_seed_task.name + ':body'
 
       if Rake::Task.task_defined?(dependent_task_name)
         dependent_task = Rake::Task[dependent_task_name]
       else
-        dependent_task = Rake::Task.define_task(dependent_task_name => dependencies, &block)
+        dependent_task = Rake::Task.define_task(dependent_task_name => depends_on, &block)
       end
 
       dependent_task.invoke
     end
 
-    private
+    def let(name, &block)
+      name = String(name)
+
+      raise ArgumentError, "#{name} is already defined" if respond_to?(name, true)
 
-    def __eigenclass
-      class << self
-        self
+      define_singleton_method(name) do
+        @_memoized.fetch(name) { |key| @_memoized[key] = instance_exec(&block) }
       end
     end
 
+    def let!(name, &block)
+      let(name, &block)
+      public_send name
+    end
+
+    def evaluate(seed_task, seed_file)
+      @_seed_task = seed_task
+      instance_eval(File.read(seed_file), seed_file)
+    end
   end
 end

data/lib/seedbank/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Seedbank
-  VERSION = "0.4.0"
+  VERSION = '0.5.0'
 end

data/lib/seedbank.rb

@@ -1,22 +1,31 @@
+# frozen_string_literal: true
 require 'seedbank/dsl'
 require 'seedbank/runner'
 
 module Seedbank
-
   class << self
+    attr_writer :application_root, :seeds_root, :nesting, :matcher
 
-    attr_writer :seeds_root
+    def application_root
+      @application_root ||= Pathname.new(Rake.application.original_dir)
+    end
 
     def seeds_root
-      @seeds_root ||= 'db/seeds'
+      @seeds_root ||= File.join(application_root, 'db', 'seeds')
+    end
+
+    def nesting
+      @nesting ||= 2
     end
 
+    def matcher
+      @matcher ||= '*.seeds.rb'
+    end
   end
 
   def self.load_tasks
-    Dir[File.expand_path("tasks/*.rake", File.dirname(__FILE__))].each { |ext| load ext }
+    Dir[File.expand_path('../tasks/*.rake', __FILE__)].each { |ext| load ext }
   end
 
   require 'seedbank/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
-
-end
+end

data/lib/tasks/seed.rake

@@ -1,42 +1,38 @@
+# frozen_string_literal: true
 namespace :db do
-
-  include Seedbank::DSL
-
-  base_dependencies   = ['db:seed:original']
+  using Seedbank::DSL
   override_dependency = ['db:seed:common']
 
   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').sort.map { |seed_file| seed_task_from_file(seed_file) }
+    common_dependencies = seed_tasks_matching(Seedbank.matcher)
+
+    # Only add the original seeds if db/seeds.rb exists.
+    if original_seeds_file
+      define_seed_task original_seeds_file, :original
+      common_dependencies.unshift('db:seed:original')
+    end
 
-    desc "Load the seed data from db/seeds.rb and db/seeds/*.seeds.rb."
-    task 'common' => base_dependencies + common_dependencies
+    desc "Load the seed data from db/seeds.rb and db/seeds/#{Seedbank.matcher}."
+    task 'common' => common_dependencies
 
     # 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 = glob_seed_files_matching(environment, '*.seeds.rb').sort.map { |seed_file| seed_task_from_file(seed_file) }
+      environment_dependencies = seed_tasks_matching(environment, Seedbank.matcher)
 
-      desc "Load the seed data from db/seeds.rb, db/seeds/*.seeds.rb and db/seeds/#{environment}/*.seeds.rb."
+      desc "Load the seed data from db/seeds.rb, db/seeds/#{Seedbank.matcher} and db/seeds/#{environment}/#{Seedbank.matcher}."
       task environment => ['db:seed:common'] + environment_dependencies
 
       override_dependency << "db:seed:#{environment}" if defined?(Rails) && Rails.env == environment
     end
-
-    if Rails.version > '4'
-      original_seeds_file = Rails.application.paths["db/seeds.rb"].existent.first
-    elsif Rails.version > '3.1'
-      original_seeds_file = Rails.application.paths["db/seeds"].existent.first
-    else
-      original_seeds_file = Rails.root.join("db","seeds").children.first.to_s
-    end
-    define_seed_task original_seeds_file, :original if original_seeds_file
   end
 
   # 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
+  desc %(Load the seed data from db/seeds.rb, db/seeds/#{Seedbank.matcher} and db/seeds/ENVIRONMENT/#{Seedbank.matcher}.
+  ENVIRONMENT is the current Rails.env.)
+  override_seed_task seed: override_dependency
 end