germinator 2.1.0

data/lib/germinator/seeder.rb

@@ -0,0 +1,307 @@
+require 'germinator/version'
+require 'germinator/base'
+require 'germinator/errors'
+
+module Germinator
+  ##
+  # A class to manage the seeding process.
+  #
+  class Seeder < Germinator::Base
+
+    ##
+    # Germinates the database by finding unseeded files in the germinate/
+    # directory and attempting to execute their germinate method.
+    #
+    # ==== Parameters:
+    #
+    # *step:* => A maximum number of seeds to germinate.  nil or 0 will execute all unseeded files in the germinate directory. (default: nil)
+    #
+    def germinate p={}
+      Base::confirm_database_table
+
+      step = p.has_key?(:step) ? p[:step].to_i : nil
+      step = nil if step==0
+
+      i = 0
+      _seeds = unseeded
+
+      _seeds.keys.sort.each do |seed_name|
+        germinate_by_seed_name seed_name
+        i += 1
+        break if step and i >= step
+      end
+    end
+
+    ##
+    # Executes a seed file's germinate method using the name of the seed file.
+    # The germinate method is only executed if it has not been executed previously.
+    #
+    def germinate_by_name name
+      Base::confirm_database_table
+      include_seeds
+      _seeds = seeds.select{ |seed_name, seed| seed.name == name }
+      return if _seeds.size == 0
+      seed_name, seed = _seeds.first
+      germinate_by_seed_name seed_name
+    end
+
+    ##
+    # Executes a seed file's germinate method using the version of the seed file.
+    # The germinate method is only executed if it has not been executed previously.
+    #
+    def germinate_by_version version
+      _seeds = seeds.select{ |seed_name, seed| seed.version == version }
+      return if _seeds.size == 0
+      seed_name, seed = _seeds.first
+      germinate_by_seed_name seed_name
+    end
+
+
+    ##
+    # Executes a seed file's germinate method using the seed_name (version_name) of
+    # the seed file. The germinate method is only executed if it has not been executed
+    # previously.
+    #
+    def germinate_by_seed_name seed_name
+      Base::confirm_database_table
+      include_seeds
+      _seeds = unseeded
+      return unless _seeds.has_key?(seed_name)
+
+      seed = _seeds[seed_name]
+
+      puts "== #{seed}: GERMINATE ==========", 0
+      begin
+
+        seed_object = get_seed_object seed
+        output_config seed_object
+        seed_object.migrate :up
+
+        add_seeded_version seed.version, seed.name, seed_object.response, seed_object.message, seed_object.config.to_hash
+      rescue Germinator::Errors::InvalidSeedEnvironment => e
+        puts e.message
+        add_seeded_version seed.version, seed.name, seed_object.response, seed_object.message, seed_object.config.to_hash
+      rescue Germinator::Errors::InvalidSeedModel => e
+        puts e.message
+        return if seed_object.config.stop_on_invalid_model
+        add_seeded_version seed.version, seed.name, seed_object.response, seed_object.message, seed_object.config.to_hash
+        puts "Moving on..."
+      rescue Exception => e
+        puts ""
+        puts_error e
+        puts ""
+        puts "There was an error while executing the seeds.  Germination stopped!", 0
+        puts ""
+        raise e if !seed_object || seed_object.config.stop_on_error
+        add_seeded_version seed.version, seed.name, seed_object.response, seed_object.message, seed_object.config.to_hash
+      ensure
+        puts "== #{seed}: END       ==========", 0
+      end
+    end
+
+    ##
+    # Shrivels the database by finding seeded files in the germinate/
+    # directory and attempting to execute their shrivel method.
+    #
+    # ==== Parameters:
+    #
+    # *step:* => A maximum number of seeds to shrivel.  nil or 0 will execute all unseeded files in the germinate directory. (default: 1)
+    #
+    def shrivel p={}
+      Base::confirm_database_table
+
+      step = p.has_key?(:step) ? p[:step].to_i : 1
+      step = nil if step==0
+
+      i = 0
+      _seeds = seeded
+
+      _seeds.keys.sort.reverse.each do |seed_name|
+        shrivel_by_seed_name seed_name
+        i += 1
+        break if step and i >= step
+      end
+    end
+
+
+    ##
+    # Executes a seed file's germinate method using the name of the seed file.
+    # The germinate method is only executed if it has not been executed previously.
+    #
+    def shrivel_by_name name
+      _seeds = seeds.select{ |seed_name, seed| seed.name == name }
+      return if _seeds.size == 0
+      seed_name, seed = _seeds.first
+      shrivel_by_seed_name seed_name
+    end
+
+
+    ##
+    # Executes a seed file's germinate method using the version of the seed file.
+    # The germinate method is only executed if it has not been executed previously.
+    #
+    def shrivel_by_version version
+      _seeds = seeds.select{ |seed_name, seed| seed.version == version }
+      return if _seeds.size == 0
+      seed_name, seed = _seeds.first
+      shrivel_by_seed_name seed_name
+    end
+
+
+    ##
+    # Executes a seed file's germinate method using the seed_name (version_name) of
+    # the seed file. The germinate method is only executed if it has not been executed
+    # previously.
+    #
+    def shrivel_by_seed_name seed_name
+      Base::confirm_database_table
+      include_seeds
+
+      _seeds = seeded
+      return unless _seeds.has_key?(seed_name)
+
+      seed = _seeds[seed_name]
+
+      begin
+        puts "== #{seed}: SHRIVEL ==========", 0
+        seed_object = get_seed_object seed
+        output_config seed_object
+        seed_object.migrate :down
+        puts "== #{seed}: END     ==========", 0
+
+        remove_seeded_version seed.version
+      rescue Germinator::Errors::InvalidSeedEnvironment => e
+        puts e.message
+        remove_seeded_version seed.version
+      rescue Germinator::Errors::InvalidSeedModel => e
+        puts e.message
+        return if seed_object && seed_object.config.stop_on_invalid_model
+        remove_seeded_version seed.version
+        puts "Moving on..."
+      rescue Exception => e
+        puts ""
+        puts_error e
+        puts ""
+        puts "There was an error while executing the seeds.", 0
+        puts ""
+        raise e if !seed_object || seed_object.config.stop_on_error
+        puts "Moving on..."
+        remove_seeded_version seed.version
+      ensure
+        puts "== #{seed}: END       ==========", 0
+      end
+    end
+
+
+    ##
+    # Shrivels and then germinates the database by finding seeded files in the germinate/
+    # directory and attempting to execute their shrivel and germinate methods.  The germinate
+    # methods get called in order after all of the shrivel methods have been call.
+    #
+    # ==== Parameters:
+    #
+    # *step:* => A maximum number of seeds to reseed.  nil or 0 will execute all unseeded files in the germinate directory. (default: nil)
+    #
+    def reseed p={}
+      step = p.has_key?(:step) ? p[:step].to_i : 1
+      step = nil if step==0
+
+      puts "Reseeding the database...", 0
+      puts ""
+
+      shrivel step: step
+      germinate step: step
+    end
+
+    private
+    ##
+    # A helper method to include the seed classes into the code so they can be instantiated.
+    #
+    def include_seeds
+      Dir["#{Rails.root}/#{Germinator::SEED_PATH}/*.rb"].each {|file| require file.gsub(/\.rb/, "") }
+    end
+
+
+    private
+    ##
+    # A helper method to instantiate a seed object by class name.
+    #
+    def get_seed_object seed
+      seed_class = "#{seed.class_name}Seeder".constantize
+      seed_object = seed_class.new
+      return seed_object
+    end
+
+
+    private
+    ##
+    # Returns a hash of all germinator files as SeedFile objects keyed by seed name.
+    #
+    def seeds
+      hash = {}
+
+      germinate_directory = "#{Rails.root}/#{SEED_PATH}/*.rb"
+      files = Dir[germinate_directory]
+
+      files.each do |file|
+        seed_file = SeedFile.new(file)
+        hash[seed_file.seed_name] = seed_file
+      end
+
+      hash
+    end
+
+
+    private
+    ##
+    # Returns a hash of seeded germinator files as SeedFile objects keyed by seed name.
+    #
+    def seeded
+      versions = seeded_versions
+      seeds.select{ |key, seed| versions.include?(seed.version.to_s) }
+    end
+
+
+    private
+    ##
+    # Returns a hash of unseeded germinator files as SeedFile objects keyed by seed name.
+    def unseeded
+      versions = seeded_versions
+      seeds.select{ |key, seed| !versions.include?(seed.version.to_s) }
+    end
+
+
+    private
+    ##
+    # Requests a list of all of the seeded versions from the database. Returns an array of the
+    # verison numbers.
+    #
+    def seeded_versions
+      #ActiveRecord::Base.establish_connection
+      version_records = ActiveRecord::Base.connection.execute("SELECT * FROM `#{Germinator::VERSION_2_TABLE_NAME}` ORDER BY `version`")
+
+      versions = version_records.map{ |vr| vr[0] }
+
+      versions.sort
+    end
+
+
+    private
+    ##
+    # Inserts a seeded version number into the database.
+    #
+    def add_seeded_version version, name, response, message, configuration={}
+      return unless version and (version.to_i > 0)
+      ActiveRecord::Base.connection.execute("INSERT INTO `#{Germinator::VERSION_2_TABLE_NAME}` (version, name, response, message, configuration) VALUES ('#{version.to_s}', '#{name.to_s}', '#{response.to_s.truncate(40, omission: "...#{response.to_s.last(25)}")}', '#{message.to_s}', '#{configuration.to_json}')")
+    end
+
+
+    ##
+    # Deletes a seeded version number from the database
+    #
+    def remove_seeded_version version
+      return unless version and (version.to_i > 0)
+      ActiveRecord::Base.connection.execute("DELETE FROM `#{Germinator::VERSION_2_TABLE_NAME}` WHERE `version`='#{version.to_s}'")
+    end
+  end
+end

data/lib/germinator/version.rb

@@ -0,0 +1,7 @@
+module Germinator
+  VERSION="2.1.0"
+
+  # Default table name in the database.
+  VERSION_1_TABLE_NAME = "germinator_migrations"
+  VERSION_2_TABLE_NAME = "germinator_seeds"
+end

data/lib/germinator.rb

@@ -0,0 +1,23 @@
+module Germinator
+  require 'germinator/railtie' if defined?(Rails)
+
+  require 'germinator/base'
+  require 'germinator/seeder'
+  require 'germinator/seed_config'
+  require 'germinator/seed'
+  require 'germinator/seed_file'
+
+  # Default seed path for the germinate files.
+  SEED_PATH = "db/germinate"
+
+  def Germinator.germinate name
+    seeder = Germinator::Seeder.new
+    seeder.germinate_by_name name
+  end
+
+  def Germinator.shrivel name
+    seeder = Germinator::Seeder.new
+    seeder.shrivel_by_name name
+  end
+
+end

data/lib/tasks/germinator_tasks.rake

@@ -0,0 +1,67 @@
+# desc "Explaining what the task does"
+# task :germinator do
+#   # Task goes here
+# end
+
+namespace :db do
+
+  # desc "Executes all available germination files since the last germinate call."
+  task :germinate, [:step] => [:environment] do |t,args|
+    args.with_defaults(:step => nil)
+    seeder = Germinator::Seeder.new
+    seeder.germinate step: args.step
+  end
+
+
+  # desc "Rollback the germination files one step at a time, unless otherwise specified with STEP= parameter."
+  task :shrivel, [:step] => [:environment] do |t,args|
+    args.with_defaults(:step => 1)
+    seeder = Germinator::Seeder.new
+    seeder.shrivel step: args.step
+  end
+
+
+  # desc "Rolls back the database "
+  task :reseed, [:step] => [:environment] do |t,args|
+    args.with_defaults(:step => nil, :force => false)
+    if Rails.env.production? and not args.force
+      puts "This is the production environment.  Reseeding can be very dangerous.  Are you sure you want to reseed? (Yes/No)"
+      input = STDIN.gets.chomp
+      return unless input.downcase === 'yes'
+    end
+
+    seeder = Germinator::Seeder.new
+    seeder.reseed step: args.step
+  end
+
+  task :germinate_by_name, [:seed_name] => [:environment] do |t,args|
+    args.with_defaults(:seed_name => nil)
+    unless seed_name.nil?
+      puts "You need to specify a seed_name (without timestamp)."
+      puts ""
+      puts 'Usage: rake db:germinate_by_name["name_of_seed_file"]'
+      puts ""
+    end
+    Germinator.germinate(seed_name)
+  end
+
+  task :shrivel_by_name, [:seed_name] => [:environment] do |t,args|
+    args.with_defaults(:seed_name => nil)
+    unless seed_name.nil?
+      puts "You need to specify a seed_name (without timestamp)."
+      puts ""
+      puts 'Usage: rake db:shrivel_by_name["name_of_seed_file"]'
+      puts ""
+    end
+    Germinator.shrivel(seed_name)
+  end
+
+
+  # desc "DEPRECATED: Execute the plant method of a specific germination file, regardless of whether it's been run previously. (No longer available)"
+  task :plant, [:seed_name] => [:environment] do |t,args|
+    puts ""
+    puts "!! The plant rake task has been removed.  Please create a rake task for repeatable database manipulations."
+    puts ""
+  end
+
+end

data/lib/templates/seed.rb

@@ -0,0 +1,55 @@
+class %{class_name}Seeder < Germinator::Seed
+
+  #
+  # Set the configuration for the seed to use during execution.
+  #
+  def configure config
+    # stop_on_error determines if the germination process should stop when a
+    # seed file encounters an error during execution. FALSE = Germinator records
+    # the error and continues.  TRUE = Germinator stops at the error and halts
+    # all future germinator execution.
+
+        config.stop_on_error = false                                            # Default: Continue on all errors.
+        # config.stop_on_error = true                                           # Stop on any error.
+
+
+    # valid_models identifies which models and/or methods need to be present to
+    # properly execute this seed file.
+
+        config.valid_models = true                                              # Default: Don't engage model validation.
+        # config.valid_models = { model1: true, model2: true }                  # Validate that model1 and model2 exist before executing.
+        # config.valid_models = { model1: [ :field1, :field2 ]}                 # Validate that model1 exists and that it has field1 and field2 accessible.
+
+
+    # stop_on_bad_model determines if the germination process should stop when a
+    # seed file fails the model validation.
+
+        config.stop_on_invalid_model = false                                    # Default: Continue on to the next germinator if the models fail the validation.
+        # config.stop_on_invalid_model = false                                  # Stop the germinators if the models fail the validation.
+
+
+    # environments identifies which environments it is safe to execute this seed
+    # file in.
+
+        config.environments = true                                              # Default: Execute this seed in all evnironments.
+        # config.environments = false                                           # Disable this seed file and prevent it from executing.
+        # config.environments = "development"                                   # Only execute this seed file in the development environment.
+        # config.environments = ["development", "production"]                   # Only execute this seed file in the development and production environments.
+        # config.environments = "test"                                          # Only execute this seed file in the test environment.
+
+  end
+
+
+  # Code to execute during the germinate process (up).
+  #
+  def germinate
+  end
+
+
+  ##
+  # Code to execute during the shrivel process (down).
+  #
+  # def shrivel
+  # end
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "germinator"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,23 @@
+# SQLite version 3.x
+#   gem 'activerecord-jdbcsqlite3-adapter'
+#
+# Configure Using Gemfile
+# gem 'activerecord-jdbcsqlite3-adapter'
+#
+default: &default
+  adapter: sqlite3
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end