germinator 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c77e37d8984e4bd117b9aeee7ce37ff6489a893a6555fd9bdb693651f3d9f52
+  data.tar.gz: 1315177e453cb595934962910f474d2afe1e0e7f00f1f0735b8e8394578a58fc
+SHA512:
+  metadata.gz: d6fd1783842c26f8fa48dafd6e630ac56e37184187f4cc1ec80604443911a20b761c0f28ebb52e5c957121bb527a9e195c89064262e519a73ac16223b956b7d3
+  data.tar.gz: 216ba005a4b57b2a9ec1898316e66e512a6d4ee68c83a07c08a4c6d12f3e17689f1949ad035cd10f39afa393e471aff9787ee3b4398db9a3d7f178d0897e82dd

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Wowza Media Systems, Inc.
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Germinator
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Germinator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/germination_generator.rb

@@ -0,0 +1,5 @@
+require_relative "germinator_generator"
+
+class GerminationGenerator < GerminatorGenerator
+  source_root File.expand_path('../../templates', __FILE__)
+end

data/lib/generators/germinator_generator.rb

@@ -0,0 +1,28 @@
+class GerminatorGenerator < Rails::Generators::Base
+  source_root File.expand_path('../../templates', __FILE__)
+  argument :seed_name, :type => :string, :default => nil
+
+  def build_seed_file
+    if seed_name.nil?
+      puts "You must provide a germinator seed name."
+      return
+    end
+
+    puts "Seed name: #{seed_name.underscore}"
+    name = seed_name.underscore
+
+    if Dir["#{Rails.root}/#{Germinator::SEED_PATH}/*_#{name}.rb"].length > 0
+      puts "The germinator seed name provided already exists. Please select another name."
+      return
+    end
+
+    timestamp = Time.now.strftime("%Y%m%d%H%M%S")
+    source_seed_file = "seed.rb"
+    destination_seed_file = "#{Rails.root}/#{Germinator::SEED_PATH}/#{timestamp}_#{name}.rb"
+    
+    copy_file source_seed_file, destination_seed_file do |content|
+      content.gsub('%{class_name}', seed_name)
+    end
+  end
+
+end

data/lib/generators/install_germinator_generator.rb

@@ -0,0 +1,21 @@
+require 'germinator/base'
+
+class InstallGerminatorGenerator < Rails::Generators::Base
+  source_root File.expand_path('../../..', __FILE__)
+
+  def add_germinator_version_table
+    Germinator::Base.confirm_database_table
+  end
+
+  def add_germinator_file_directory
+    file_directory = "#{Rails.root}/#{Germinator::SEED_PATH}"
+    puts "Building directory structure..."
+    unless File.directory?(file_directory)
+      empty_directory(file_directory)
+      puts "  Added: #{file_directory}"
+    else
+      puts "  Directory already exists: #{file_directory}"
+    end
+  end
+
+end

data/lib/germinator/base.rb

@@ -0,0 +1,58 @@
+require 'germinator/version'
+
+module Germinator
+  class Base
+    protected
+    ##
+    # Override the puts method to add the ability to indent content in the output.  This is a way of making it prettier for the
+    # console.
+    #
+    def puts content, indent=3
+      STDOUT.puts "#{(" "*indent)}#{content}"
+    end
+
+    ##
+    # Helper to standardize the output for an error.
+    #
+    def puts_error e
+      puts "-"*80
+      puts e.message
+      e.backtrace.each do |trace|
+        puts trace
+      end
+      puts "-"*80
+    end
+
+    ##
+    # Displays the configuration object values in the terminal.
+    #
+    def output_config seed
+      puts "Configuration: #{seed.config.to_hash}"
+    end
+
+    ##
+    #
+    def self.confirm_database_table
+      ActiveRecord::Base.establish_connection
+      unless ActiveRecord::Base.connection.data_source_exists? Germinator::VERSION_2_TABLE_NAME
+
+        # Create the germinator_seeds table because it doesn't exist.
+        ActiveRecord::Base.connection.execute("CREATE TABLE `#{Germinator::VERSION_2_TABLE_NAME}` (`version` VARCHAR(20) NOT NULL, `name` VARCHAR(300) NOT NULL, `response` VARCHAR(40) NOT NULL, `message` VARCHAR(300))")
+
+        # Migrate the Version 1 Table to Version 2.
+        if ActiveRecord::Base.connection.data_source_exists? Germinator::VERSION_1_TABLE_NAME
+          # If the Version 1 germinator_migrations table still exists, copy its contents to the germinator_seeds table to keep the seeds in sync.
+          ActiveRecord::Base.connection.execute("INSERT INTO `#{Germinator::VERSION_2_TABLE_NAME}` (`version`, `name`, `response`, `message`) (SELECT version, '', 'Success', 'This entry was upgraded from Version 1' FROM `#{Germinator::VERSION_1_TABLE_NAME}` ORDER BY `version`)")
+
+          # Drop the old Version 1 table since it will no longer be used.
+          ActiveRecord::Base.connection.execute("DROP TABLE `#{Germinator::VERSION_1_TABLE_NAME}`")
+        end
+      end
+
+      unless ActiveRecord::Base.connection.column_exists?(Germinator::VERSION_2_TABLE_NAME.to_sym, :configuration)
+        ActiveRecord::Base.connection.execute("ALTER TABLE `#{Germinator::VERSION_2_TABLE_NAME}` ADD `configuration` TEXT")
+      end
+    end
+
+  end
+end

data/lib/germinator/errors.rb

@@ -0,0 +1,19 @@
+
+module Germinator
+  module Errors
+    
+    class Standard < StandardError; end
+
+    class InvalidSeedEnvironment < Standard
+      def message
+        "The current environment (#{Rails.env}) is not permitted to execute this seed."
+      end
+    end
+
+    class InvalidSeedModel < Standard
+      def message
+        "The models designated in the seed configuration are not valid."
+      end
+    end
+  end
+end

data/lib/germinator/railtie.rb

@@ -0,0 +1,11 @@
+require 'germinator'
+require 'rails'
+module Germinator
+  class Railtie < Rails::Railtie
+    railtie_name :germinator
+
+    rake_tasks do
+      load "tasks/germinator_tasks.rake"
+    end
+  end
+end

data/lib/germinator/seed.rb

@@ -0,0 +1,168 @@
+require 'germinator/base'
+require 'germinator/seed_config'
+require 'germinator/errors'
+
+module Germinator
+  ##
+  # A base class for the seed files
+  #
+  class Seed < Germinator::Base
+
+
+    attr_reader :config, :response, :message
+
+    def initialize
+      @response = "Success"
+      @config = SeedConfig.new
+      configure @config
+    end
+
+    ##
+    # An overridable method that allows you to modify this seed's configuration
+    #
+    def configure c
+      # Set the environments configuration to the response from the
+      # environments method so that the file will be backward compatible.
+      c.environments = self.environments
+    end
+
+    ##
+    # Specifies the commands to execute during a germinate process.
+    #
+    def germinate
+      # Do nothing for now.
+    end
+
+
+    ##
+    # Specifies the commands to execute during a shrivel process.
+    #
+    def shrivel
+      # Do nothing for now.
+    end
+
+    ##
+    # Either germinates or shrivles the database based on the direction specified.
+    #
+    # ==== Parameters:
+    #
+    # *direction* => The direction to execute. :up = germinate. :down = shrivel.
+    #
+    def migrate direction=:up
+      if is_valid_environment?
+        if models_are_valid?
+          begin
+            germinate if direction === :up
+            shrivel if direction === :down
+          rescue Exception => e
+            if config.stop_on_error
+              raise e
+            else
+              puts_error e
+              class_name = e.class.name
+              @response = class_name
+              @message = e.message
+              puts "Moving on..."
+            end
+          end
+        else
+          error = Germinator::Errors::InvalidSeedModel.new
+          @response = error.class.name.to_s.gsub(/Germinator\:\:Errors\:\:/,"")
+          @message = error.message
+          raise error
+        end
+      else
+        error = Germinator::Errors::InvalidSeedEnvironment.new
+        @response = error.class.name.to_s.gsub(/Germinator\:\:Errors\:\:/,"")
+        @message = error.message
+        raise error
+      end
+    end
+
+
+    ##
+    # Specifies which environments the Seed instance is allowed to execute in.
+    #
+    # *DEPRECATED:* Please use the Seed#configure method to set the environments configuration.
+    #
+    def environments
+      return true
+    end
+
+
+    ##
+    # Specifies the commands to execute during a plant process.
+    #
+    # *DEPRECATED:* Create a rake task to handle repeatable data manipulations.
+    #
+    def plant
+    end
+
+
+    private
+    ##
+    # Determines if the current environment is an acceptable environment to execute this
+    # seed in.
+    #
+    def is_valid_environment?
+      envs = config.environments
+      return envs if !!envs == envs
+      return false unless envs.kind_of?(String) || envs.kind_of?(Array)
+
+      envs = [ envs ] if envs.kind_of?(String)
+      envs = envs.map{ |e| e.downcase }
+
+      envs.include?(Rails.env.downcase)
+    end
+
+
+    def models_are_valid?
+      valid_models = config.valid_models
+      return valid_models if !!valid_models == valid_models
+      return false unless valid_models.kind_of?(Hash)
+
+      puts "Validating models..."
+
+      valid_models.default = true
+
+      valid_models.each do |name, methods|
+        begin
+          model = Module.const_get(name.to_s.camelize)
+          return false unless model.is_a?(Class)
+
+          model.connection.schema_cache.clear!
+          model.reset_column_information
+
+          next if !!methods == methods
+          return false unless methods.kind_of?(Array)
+
+          methods.each do |method|
+            unless (model.column_names.include?(method.to_s) || model.instance_methods.include?(method.to_sym) || model.metaclass.instance_methods.include?(method.to_sym))
+              puts "Method #{method} does not exist for model #{name.to_s.camelize}", 6
+              return false
+            end
+          end
+        rescue NameError => e
+          puts "Model #{name.to_s.camelize} does not exist!", 6
+          puts_error(e)
+          return false
+        rescue Exception => e
+          puts ""
+          puts_error e
+          puts ""
+          return false
+        end
+      end
+
+      return true
+    end
+
+    private def ellipsisize(str, minimum_length=4,edge_length=3)
+      return self if str.length < minimum_length or str.length <= edge_length*2
+      edge = '.'*edge_length
+      mid_length = str.length - edge_length*2
+      str.gsub(/(#{edge}).{#{mid_length},}(#{edge})/, '\1...\2')
+    end
+
+  end
+end

data/lib/germinator/seed_config.rb

@@ -0,0 +1,22 @@
+module Germinator
+  class SeedConfig
+
+    attr_accessor :stop_on_error, :stop_on_invalid_model, :environments, :valid_models
+
+    def initialize
+      @stop_on_error = false
+      @stop_on_invalid_model = false
+      @environments = true
+      @valid_models = true
+    end
+
+    def to_hash
+      {
+        stop_on_error: @stop_on_error,
+        stop_on_invalid_model: @stop_on_invalid_model,
+        environments: @environments,
+        valid_models: @valid_models
+      }
+    end
+  end
+end

data/lib/germinator/seed_file.rb

@@ -0,0 +1,75 @@
+module Germinator
+
+
+  ##
+  # A helper class to parse a seed file name and return the appropriate
+  # values
+  #
+  class SeedFile
+    require 'pathname'
+
+    attr_reader :path
+
+    ##
+    # Inititalize the class instance.
+    #
+    # ==== Parameters:
+    #
+    # *path* => The full path of the seed file being parsed.
+    #
+    def initialize path
+      @path = path
+    end
+
+
+    ##
+    # Returns the base file name of the seed file.
+    #
+    def basename
+      Pathname.new(@path).basename.to_s
+    end
+
+
+    ##
+    # Returns the version portion of the seed file.
+    #
+    def version
+      parts = basename.split('_', 2)
+      return "" if parts.length === 0
+      return parts[0]
+    end
+
+
+    ##
+    # Returns the name portion of the seed file.
+    #
+    def name
+      parts = basename.split('_', 2)
+      return "" if parts.length <= 1
+      return parts[1].gsub(/\.rb/, "").to_s
+    end
+
+
+    ##
+    # Returns the full seed name of the seed file (no path or extension).
+    def seed_name
+      "#{version}_#{name}"
+    end
+
+
+    ##
+    # Returns the name of the class for the seed file.
+    #
+    def class_name
+      name.camelize
+    end
+
+
+    ##
+    # Override the to_s method to make it more readable.
+    #
+    def to_s
+      "[#{version}] #{class_name}"
+    end
+  end
+end