ejhayes_standalone_migrations 2.2.0

data/VERSION

@@ -0,0 +1 @@
+2.2.0

data/example/.gitignore

@@ -0,0 +1,5 @@
+*.sqlite3
+Gemfile
+.bundle/
+bin/
+Gemfile.lock

data/example/Rakefile

@@ -0,0 +1,9 @@
+# $LOAD_PATH handling not need if the standalone_migrations
+# gem is installed
+lib = File.expand_path("../../lib", __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require "standalone_migrations"
+StandaloneMigrations::Tasks.load_tasks
+
+# and that's it!

data/example/db/config.yml

@@ -0,0 +1,15 @@
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/example/db/migrate/20120930053225_create_table_awesome_migration.rb

@@ -0,0 +1,7 @@
+class CreateTableAwesomeMigration < ActiveRecord::Migration
+  def up
+  end
+
+  def down
+  end
+end

data/lib/standalone_migrations.rb

@@ -0,0 +1,20 @@
+lib_path = File.expand_path("../", __FILE__)
+$:.unshift lib_path unless $:.include?(lib_path)
+
+require "rubygems"
+require "rails"
+require "active_record"
+
+require "standalone_migrations/configurator"
+require "standalone_migrations/generator"
+require "standalone_migrations/callbacks"
+
+railtie_app_path = "#{lib_path}/standalone_migrations/minimal_railtie_config"
+APP_PATH = File.expand_path(railtie_app_path,  __FILE__)
+
+require "standalone_migrations/minimal_railtie_config"
+require "standalone_migrations/tasks"
+
+if !ENV["RAILS_ENV"]
+  ENV["RAILS_ENV"] = ENV["DB"] || ENV["RACK_ENV"] || Rails.env || "development"
+end

data/lib/standalone_migrations/callbacks.rb

@@ -0,0 +1,13 @@
+module StandaloneMigrations
+  @@callbacks ||= []
+
+  def self.on_loaded(&block)
+    @@callbacks << block
+  end
+
+  def self.run_on_load_callbacks
+    @@callbacks.each do |callback|
+      callback.call
+    end
+  end
+end

data/lib/standalone_migrations/configurator.rb

@@ -0,0 +1,88 @@
+require 'active_support/all'
+
+module StandaloneMigrations
+
+  class InternalConfigurationsProxy
+
+    def initialize(configurations)
+      @configurations = configurations
+    end
+
+    def on(config_key)
+      if @configurations[config_key] && block_given?
+        @configurations[config_key] = yield(@configurations[config_key]) || @configurations[config_key]
+      end
+      @configurations[config_key]
+    end
+
+  end
+
+  class Configurator
+    def self.load_configurations
+      @standalone_configs ||= Configurator.new.config
+      @environments_config ||= YAML.load(ERB.new(File.read(@standalone_configs)).result).with_indifferent_access
+    end
+
+    def self.environments_config
+      proxy = InternalConfigurationsProxy.new(load_configurations)
+      yield(proxy) if block_given?
+    end
+
+    def initialize(options = {})
+      defaults = {
+        :config       => "db/config.yml",
+        :migrate_dir  => "db/migrate",
+        :seeds        => "db/seeds.rb",
+        :schema       => "db/schema.rb"
+      }
+      @options = load_from_file(defaults.dup) || defaults.merge(options)
+      ENV['SCHEMA'] = ENV['SCHEMA'] || File.expand_path(schema)
+    end
+
+    def config
+      @options[:config]
+    end
+
+    def migrate_dir
+      @options[:migrate_dir]
+    end
+
+    def seeds
+      @options[:seeds]
+    end
+
+    def schema
+      @options[:schema]
+    end
+
+    def config_for_all
+      Configurator.load_configurations.dup
+    end
+
+    def config_for(environment)
+      config_for_all[environment]
+    end
+
+    private
+
+    def configuration_file
+      if !ENV['DATABASE']
+        ".standalone_migrations"
+      else
+        ".#{ENV['DATABASE']}.standalone_migrations"
+      end
+    end
+
+    def load_from_file(defaults)
+      return nil unless File.exists? configuration_file
+      config = YAML.load( ERB.new(IO.read(configuration_file)).result )
+      {
+        :config       => config["config"] ? config["config"]["database"] : defaults[:config],
+        :migrate_dir  => (config["db"] || {})["migrate"] || defaults[:migrate_dir],
+        :seeds        => (config["db"] || {})["seeds"] || defaults[:seeds],
+        :schema       => (config["db"] || {})["schema"] || defaults[:schema]
+      }
+    end
+
+  end
+end

data/lib/standalone_migrations/generator.rb

@@ -0,0 +1,11 @@
+# these generators are backed by rails' generators
+require "rails/generators"
+module StandaloneMigrations
+  class Generator
+    def self.migration(name, options="")
+      generator_params = [name] + options.split(" ")
+      Rails::Generators.invoke "active_record:migration", generator_params,
+        :destination_root => Rails.root
+    end
+  end
+end

data/lib/standalone_migrations/minimal_railtie_config.rb

@@ -0,0 +1,10 @@
+module StandaloneMigrations
+  class StandaloneMigrations::MinimalRailtieConfig < Rails::Application
+    config.generators.options[:rails] = {:orm => :active_record}
+
+    config.generators.options[:active_record] = {
+      :migration => true,
+      :timestamps => true
+    }
+  end
+end

data/lib/standalone_migrations/tasks.rb

@@ -0,0 +1,36 @@
+module StandaloneMigrations
+  class Tasks
+    class << self
+      def configure
+        Deprecations.new.call
+        configurator = Configurator.new
+        paths = Rails.application.config.paths
+        paths.add "config/database", :with => configurator.config
+        paths.add "db/migrate", :with => configurator.migrate_dir
+        paths.add "db/seeds", :with => configurator.seeds
+      end
+
+      def load_tasks
+        configure
+
+        MinimalRailtieConfig.load_tasks
+        %w(
+          connection
+          environment
+          db/new_migration
+        ).each do
+          |task| load "standalone_migrations/tasks/#{task}.rake"
+        end
+        load "active_record/railties/databases.rake"
+      end
+    end
+  end
+
+  class Tasks::Deprecations
+    def call
+      if File.directory?('db/migrations')
+        puts "DEPRECATED move your migrations into db/migrate"
+      end
+    end
+  end
+end

data/lib/standalone_migrations/tasks/connection.rake

@@ -0,0 +1,8 @@
+require File.expand_path("../../../standalone_migrations", __FILE__)
+namespace :standalone do
+  task :connection do
+    configurator = StandaloneMigrations::Configurator.new
+    ActiveRecord::Base.establish_connection configurator.config_for(Rails.env)
+    StandaloneMigrations.run_on_load_callbacks
+  end
+end

data/lib/standalone_migrations/tasks/db/new_migration.rake

@@ -0,0 +1,19 @@
+namespace :db do
+  desc "Creates a new migration file with the specified name"
+  task :new_migration, :name, :options do |t, args|
+    name = args[:name] || ENV['name']
+    options = args[:options] || ENV['options']
+    
+    unless name
+      puts "Error: must provide name of migration to generate."
+      puts "For example: rake #{t.name} name=add_field_to_form"
+      abort
+    end
+    
+    if options
+      StandaloneMigrations::Generator.migration name, options.gsub('/', ' ')
+    else
+      StandaloneMigrations::Generator.migration name
+    end
+  end
+end

data/lib/standalone_migrations/tasks/environment.rake

@@ -0,0 +1,3 @@
+require File.expand_path("../../../standalone_migrations", __FILE__)
+task :environment => ["standalone:connection"] do
+end

data/lib/tasks/standalone_migrations.rb

@@ -0,0 +1,10 @@
+# I really think we should deprecate this file, seems to me that is
+# more explicit if the user require "standalone_migrations" and then
+# call the load_tasks methods in his Rakefile. But this only a
+# suggestion, and we can get rid of this comment if others on the
+# project don't agree with that
+#
+# Ricardo Valeriano
+
+require File.expand_path("../../standalone_migrations", __FILE__)
+StandaloneMigrations::Tasks.load_tasks

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$: << File.join(File.expand_path('../', __FILE__), 'lib')
+
+require 'rake'
+require 'standalone_migrations'

data/spec/standalone_migrations/callbacks_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+module StandaloneMigrations
+
+  describe "Callbacks" do
+
+    describe ".on_loaded" do
+
+      it "responds to on_loaded" do
+        StandaloneMigrations.should respond_to :on_loaded
+      end
+
+      it "responds to run_on_load_callbacks" do
+        StandaloneMigrations.should respond_to :run_on_load_callbacks
+      end
+
+      it "can pass a block do on_loaded" do
+        callback_was_called = false
+
+        StandaloneMigrations.on_loaded do
+          callback_was_called = true
+        end
+
+        # invoke the callbacks
+        StandaloneMigrations.run_on_load_callbacks
+
+        callback_was_called.should be_true
+      end
+
+      it "can pass multiple blocks to on_loaded" do
+        callback_count = 0
+
+        for i in 1..4
+          StandaloneMigrations.on_loaded do
+            callback_count += 1
+          end
+        end
+
+        StandaloneMigrations.run_on_load_callbacks
+
+        callback_count.should == 4
+      end
+
+    end
+
+  end
+
+end

data/spec/standalone_migrations/configurator_spec.rb

@@ -0,0 +1,263 @@
+require 'spec_helper'
+require 'yaml'
+
+module StandaloneMigrations
+  describe Configurator, "which allows define custom dirs and files to work with your migrations" do
+
+    describe "environment yaml configuration loading" do
+
+      let(:env_hash) do
+        {
+          "development" => { "adapter" => "sqlite3", "database" => "db/development.sql" },
+          "test" => { "adapter" => "sqlite3", "database" => "db/test.sql" },
+          "production" => {"adapter" => "sqlite3", "database" => ":memory:" }
+        }
+      end
+
+      let(:env_hash_other_db) do
+        {
+          "development" => { "adapter" => "mysql2", "database" => "database_name" },
+          "test" => { "adapter" => "mysql2", "database" => "database_name" },
+          "production" => {"adapter" => "mysql2", "database" => "database_name" }
+        }
+      end
+
+      before(:all) do
+        @original_dir = Dir.pwd
+        Dir.chdir( File.expand_path("../../", __FILE__) )
+        FileUtils.mkdir_p "tmp/db"
+        Dir.chdir "tmp"
+        File.open("db/config.yml", "w") do |f|
+          f.write env_hash.to_yaml
+        end
+      end
+
+      it "load the specific environment config" do
+        config = Configurator.new.config_for(:development)
+        config.should == env_hash["development"]
+      end
+
+      it "load the yaml with environment configurations" do
+        config = Configurator.new.config_for(:development)
+        config[:database].should == "db/development.sql"
+      end
+
+      it "allow access the original configuration hash (for all environments)" do
+        Configurator.new.config_for_all.should == env_hash
+      end
+
+      context "customizing the environments configuration dynamically" do
+
+        let(:configurator) { Configurator.new }
+        let(:new_config) { { 'sbrobous' => 'test' } }
+
+        before(:all) do
+          Configurator.environments_config do |env|
+            env.on "production" do
+              new_config
+            end
+          end
+        end
+
+        it "allow changes on the configuration hashes" do
+          configurator.config_for("production").should == new_config
+        end
+
+        it "return current configuration if block yielding returns nil" do
+          Configurator.environments_config do |env|
+            env.on "production" do
+              nil
+            end
+          end
+          configurator.config_for("production").should == new_config
+        end
+
+        it "pass the current configuration as block argument" do
+          Configurator.environments_config do |env|
+            env.on "production" do |current_config|
+              current_config.should == new_config
+            end
+          end
+        end
+
+      end
+
+      after(:all) do
+        Dir.chdir @original_dir
+      end
+
+    end
+
+    context "default values when .standalone_configurations is missing" do
+
+      let(:configurator) do
+        Configurator.new
+      end
+
+      it "use config/database.yml" do
+        configurator.config.should == 'db/config.yml'
+      end
+
+      it "use db/migrate dir" do
+        configurator.migrate_dir.should == 'db/migrate'
+      end
+
+      it "use db/seeds.rb" do
+        configurator.seeds.should == "db/seeds.rb"
+      end
+
+      it "use db/schema.rb" do
+        configurator.schema.should == "db/schema.rb"
+      end
+
+    end
+
+    context "passing configurations as a parameter" do
+      let(:args) do
+        {
+          :config       => "custom/config/database.yml",
+          :migrate_dir  => "custom/db/migrate",
+          :seeds        => "custom/db/seeds.rb",
+          :schema       => "custom/db/schema.rb"
+        }
+      end
+
+      let(:configurator) do
+        Configurator.new args
+      end
+
+      it "use custom config" do
+        configurator.config.should == args[:config]
+      end
+
+      it "use custom migrate dir" do
+        configurator.migrate_dir.should == args[:migrate_dir]
+      end
+
+      it "use custom seeds" do
+        configurator.seeds.should == args[:seeds]
+      end
+
+      it "use custom schema" do
+        configurator.schema.should == args[:schema]
+      end
+
+    end
+
+    context "using a .standalone_migrations file with configurations" do
+
+      before(:all) do
+        @original_dir = Dir.pwd
+        Dir.chdir File.expand_path("../", __FILE__)
+      end
+
+      let(:yaml_hash) do
+        {
+          "db" => {
+            "seeds"    => "file/db/seeds.rb",
+            "migrate"  => "file/db/migrate",
+            "schema"   => "file/db/schema.rb"
+          },
+          "config" => {
+            "database" => "file/config/database.yml"
+          }
+        }
+      end
+
+      let(:yaml_hash_other_db) do
+        {
+          "db" => {
+            "seeds"    => "db2/seeds.rb",
+            "migrate"  => "db2/migrate",
+            "schema"   => "db2/schema.rb"
+          },
+          "config" => {
+            "database" => "config/config_other.yml"
+          }
+        }
+      end
+
+      let(:configurator) do
+        file = ".standalone_migrations"
+        File.open(file, "w") { |file| file.write(yaml_hash.to_yaml) }
+        Configurator.new
+      end
+
+      context "with database environment variable passed" do
+
+        before(:all) do
+          ENV['DATABASE'] = "other_db"
+        end
+
+        let(:other_configurator) do
+          file_other_db = ".other_db.standalone_migrations"
+          File.open(file_other_db, "w") { |file| file.write(yaml_hash_other_db.to_yaml) }
+          Configurator.new
+        end
+
+        it "look up named dot file" do
+          other_configurator.config.should == yaml_hash_other_db['config']['database']
+        end
+
+        it "load config from named dot file" do
+          other_configurator.migrate_dir.should == 'db2/migrate'
+        end
+
+        after(:all) do
+          File.delete ".other_db.standalone_migrations"
+          ENV['DATABASE'] = nil
+        end
+
+      end
+
+      context "with some configurations missing" do
+
+        let(:yaml_hash) do
+          {
+            "config" => {
+              "database" => "file/config/database.yml"
+            },
+            "db" => {
+              "seeds" => "file/db/seeds.rb"
+            }
+          }
+        end
+
+        it "use default values for the missing configurations" do
+          configurator.migrate_dir.should == 'db/migrate'
+        end
+
+        it "use custom config from file" do
+          configurator.config.should == yaml_hash["config"]["database"]
+        end
+
+        it "use custom config value from partial configuration" do
+          configurator.seeds.should == yaml_hash["db"]["seeds"]
+        end
+
+      end
+
+      it "use custom config from file" do
+        configurator.config.should == yaml_hash["config"]["database"]
+      end
+
+      it "use custom migrate dir from file" do
+        configurator.migrate_dir.should == yaml_hash["db"]["migrate"]
+      end
+
+      it "use custom seeds from file" do
+        configurator.seeds.should == yaml_hash["db"]["seeds"]
+      end
+
+      it "use custom schema from file" do
+        configurator.schema.should == yaml_hash["db"]["schema"]
+      end
+
+      after(:all) do
+        File.delete ".standalone_migrations"
+        Dir.chdir @original_dir
+      end
+
+    end
+  end
+end