standalone_migrations 1.0.4 → 1.0.5

data/Gemfile.lock

@@ -1,40 +1,38 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.1.0.rc4)
-      activesupport (= 3.1.0.rc4)
-      bcrypt-ruby (~> 2.1.4)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
       builder (~> 3.0.0)
       i18n (~> 0.6)
-    activerecord (3.1.0.rc4)
-      activemodel (= 3.1.0.rc4)
-      activesupport (= 3.1.0.rc4)
-      arel (~> 2.1.1)
-      tzinfo (~> 0.3.27)
-    activesupport (3.1.0.rc4)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.1)
       multi_json (~> 1.0)
-    arel (2.1.1)
-    bcrypt-ruby (2.1.4)
+    arel (2.2.1)
     builder (3.0.0)
-    diff-lcs (1.1.2)
+    diff-lcs (1.1.3)
     git (1.2.5)
     i18n (0.6.0)
-    jeweler (1.6.2)
+    jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
     multi_json (1.0.3)
-    rake (0.9.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+    rake (0.9.2.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    sqlite3 (1.3.3)
-    tzinfo (0.3.27)
+    rspec-mocks (2.7.0)
+    sqlite3 (1.3.4)
+    tzinfo (0.3.31)
 
 PLATFORMS
   ruby

data/README.markdown

@@ -16,11 +16,13 @@ Install Ruby, RubyGems and a ruby-database driver (e.g. `gem install mysql`) the
 
 Add to `Rakefile` in your projects base directory:
 
-    begin
-      require 'tasks/standalone_migrations'
-    rescue LoadError => e
-      puts "gem install standalone_migrations to get db:migrate:* tasks! (Error: #{e})"
-    end
+```ruby
+begin
+  require 'tasks/standalone_migrations'
+rescue LoadError => e
+  puts "gem install standalone_migrations to get db:migrate:* tasks! (Error: #{e})"
+end
+```
 
 Add database configuration to `db/config.yml` in your projects base directory e.g.:
 
@@ -55,13 +57,15 @@ Add database configuration to `db/config.yml` in your projects base directory e.
 
 #### If you really want to, you can just execute raw SQL:
 
-    def self.up
-      execute "insert into foo values (123,'something');"
-    end
+```ruby
+def self.up
+  execute "insert into foo values (123,'something');"
+end
 
-    def self.down
-      execute "delete from foo where field='something';"
-    end
+def self.down
+  execute "delete from foo where field='something';"
+end
+```
 
 #### Even better, you can use the _generate_ task to create the initial migration ####
 
@@ -77,20 +81,22 @@ An example to create a Person table with 3 columns (and it will automatically ad
 
 This will create a migration in db/migrate/
 
-    class CreatePerson < ActiveRecord::Migration
-      def self.up
-        create_table :Person do |t|
-          t.string :first_name
-          t.string :last_name
-          t.integer :age
-          t.timestamps
-        end
-      end
-
-      def self.down
-        drop_table :Person
-      end
+```ruby
+class CreatePerson < ActiveRecord::Migration
+  def self.up
+    create_table :Person do |t|
+      t.string :first_name
+      t.string :last_name
+      t.integer :age
+      t.timestamps
     end
+  end
+
+  def self.down
+    drop_table :Person
+  end
+end
+```
 
 ### To apply your newest migration:
 
@@ -125,16 +131,76 @@ directory structure to work with, you can use a configuration file
 named .standalone_migrations in the root of your project containing
 the following:
 
-    db:
-        seeds: db/seeds.rb
-        migrate: db/migrate
-        schema: db/schema.rb
-    config:
-        database: db/config.yml
+```yaml
+db:
+    seeds: db/seeds.rb
+    migrate: db/migrate
+    schema: db/schema.rb
+config:
+    database: db/config.yml
+```
 
 These are the configurable options available. You can omit any of
 the keys and Standalone Migrations will assume the default values. 
 
+#### Changing environment config in runtime
+
+If you are using Heroku or have to create or change your connection
+configuration based on runtime aspects (maybe environment variables),
+you can use the `StandaloneMigrations::Configurator.environments_config`
+method. Check the usage example:
+
+```ruby
+require 'tasks/standalone_migrations'
+
+StandaloneMigrations::Configurator.environments_config do |env|
+
+  env.on "production" do
+
+    if (ENV['DATABASE_URL'])
+      db = URI.parse(ENV['DATABASE_URL'])
+      return {
+        :adapter  => db.scheme == 'postgres' ? 'postgresql' : db.scheme,
+        :host     => db.host,
+        :username => db.user,
+        :password => db.password,
+        :database => db.path[1..-1],
+        :encoding => 'utf8'
+      }
+    end
+
+    nil
+  end
+
+end
+```
+
+You have to put this anywhere on your `Rakefile`. If you want to
+change some configuration, call the #on method on the object
+received as argument in your block passed to ::environments_config
+method call. The #on method receives the key to the configuration
+that you want to change within the block. The block should return
+your new configuration hash or nil if you want the configuration
+to stay the same.
+
+Your logic to decide the new configuration need to access some data
+in your current configuration? Then you should receive the configuration
+in your block, like this:
+
+```ruby
+require 'tasks/standalone_migrations'
+
+StandaloneMigrations::Configurator.environments_config do |env|
+
+  env.on "my_custom_config" do |current_custom_config|
+    p current_custom_config
+    # => the values on your current "my_custom_config" environment
+    nil
+  end
+
+end
+```
+
 Contributors
 ============
  - [Todd Huss](http://gabrito.com/)

data/Rakefile

@@ -10,6 +10,8 @@ end
 task :specs => ["specs:nodb"]
 namespace :specs do
   require 'rspec/core/rake_task'
+
+  desc "only specs that don't use database connection"
   RSpec::Core::RakeTask.new "nodb" do |t|
     t.pattern = "spec/standalone_migrations/**/*_spec.rb"
   end

data/VERSION

@@ -1 +1 @@
-1.0.4
+1.0.5

data/lib/standalone_migrations/configurator.rb

@@ -1,5 +1,32 @@
+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 = {
@@ -8,7 +35,7 @@ module StandaloneMigrations
         :seeds        => "db/seeds.rb",
         :schema       => "db/schema.rb"
       }
-      @options = load_from_file || defaults.merge(options)
+      @options = load_from_file(defaults.dup) || defaults.merge(options)
     end
 
     def config
@@ -27,20 +54,28 @@ module StandaloneMigrations
       @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
       ".standalone_migrations"
     end
 
-    def load_from_file
+    def load_from_file(defaults)
       return nil unless File.exists? configuration_file
       config = YAML.load( IO.read(configuration_file) ) 
       {
-        :config       => config["config"]["database"],
-        :migrate_dir  => config["db"]["migrate"],
-        :seeds        => config["db"]["seeds"],
-        :schema       => config["db"]["schema"]
+        :config       => config["config"] ? config["config"]["database"] : defaults[:config],
+        :migrate_dir  => config["db"] ? config["db"]["migrate"] : defaults[:migrate_dir],
+        :seeds        => config["db"] ? config["db"]["seeds"] : defaults[:seeds],
+        :schema       => config["db"] ? config["db"]["schema"] : defaults[:schema]
       }
     end
 

data/lib/tasks/standalone_migrations.rb

@@ -8,11 +8,9 @@ if File.directory?('db/migrations')
   puts "DEPRECATED move your migrations into db/migrate"
 end
 
-configurator = StandaloneMigrations::Configurator.new
-
-DB_CONFIG = YAML.load(
-  ERB.new(File.read(configurator.config)).result
-).with_indifferent_access
+def standalone_configurator
+  @configurator ||= StandaloneMigrations::Configurator.new
+end
 
 module Rails
   def self.env
@@ -29,19 +27,17 @@ module Rails
     s = "fake_app"
 
     def s.paths
-      configurator = StandaloneMigrations::Configurator.new
-
       {
-        "db/migrate"   => [configurator.migrate_dir],
-        "db/seeds.rb"  => [configurator.seeds],
-        "db/schema.rb" => [configurator.schema]
+        "db/migrate"   => [standalone_configurator.migrate_dir],
+        "db/seeds.rb"  => [standalone_configurator.seeds],
+        "db/schema.rb" => [standalone_configurator.schema]
       } 
     end
 
     def s.config
       s = "fake_config"
       def s.database_configuration
-        DB_CONFIG
+        standalone_configurator.config_for_all
       end
       s
     end
@@ -55,8 +51,8 @@ end
 task(:rails_env){}
 
 task(:environment) do
-  ActiveRecord::Base.configurations = DB_CONFIG
-  ActiveRecord::Base.establish_connection DB_CONFIG[Rails.env]
+  ActiveRecord::Base.configurations = standalone_configurator.config_for_all
+  ActiveRecord::Base.establish_connection standalone_configurator.config_for Rails.env
 end
 
 load 'active_record/railties/databases.rake'
@@ -86,7 +82,7 @@ eof
   end
 
   def configurator
-    StandaloneMigrations::Configurator.new
+    standalone_configurator
   end
 
   def create_file file, contents

data/spec/standalone_migrations/configurator_spec.rb

@@ -4,6 +4,82 @@ 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
+
+      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
@@ -87,6 +163,25 @@ module StandaloneMigrations
         Configurator.new
       end
 
+      context "with some configurations missing" do
+
+        let(:yaml_hash) do
+          {
+            "config" => {
+              "database" => "file/config/database.yml"
+            }
+          }
+        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
+      end
+
       it "use custom config from file" do
         configurator.config.should == yaml_hash["config"]["database"]
       end

data/standalone_migrations.gemspec

@@ -4,13 +4,13 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "standalone_migrations"
-  s.version = "1.0.4"
+  s.name = %q{standalone_migrations}
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Todd Huss", "Michael Grosser"]
-  s.date = "2011-11-04"
-  s.email = "thuss@gabrito.com"
+  s.authors = [%q{Todd Huss}, %q{Michael Grosser}]
+  s.date = %q{2011-11-13}
+  s.email = %q{thuss@gabrito.com}
   s.extra_rdoc_files = [
     "README.markdown"
   ]
@@ -32,10 +32,10 @@ Gem::Specification.new do |s|
     "vendor/migration_helpers/init.rb",
     "vendor/migration_helpers/lib/migration_helper.rb"
   ]
-  s.homepage = "http://github.com/thuss/standalone-migrations"
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
-  s.summary = "A thin wrapper to use Rails Migrations in non Rails projects"
+  s.homepage = %q{http://github.com/thuss/standalone-migrations}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.7}
+  s.summary = %q{A thin wrapper to use Rails Migrations in non Rails projects}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,46 +1,49 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: standalone_migrations
-version: !ruby/object:Gem::Version
-  version: 1.0.4
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 1.0.5
 platform: ruby
-authors:
+authors: 
 - Todd Huss
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-04 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-11-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &70273003731020 !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
   prerelease: false
-  version_requirements: *70273003731020
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: activerecord
-  requirement: &70273003730340 !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3"
   type: :runtime
   prerelease: false
-  version_requirements: *70273003730340
+  version_requirements: *id002
 description: 
 email: thuss@gabrito.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.markdown
-files:
+files: 
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -59,26 +62,30 @@ files:
 - vendor/migration_helpers/lib/migration_helper.rb
 homepage: http://github.com/thuss/standalone-migrations
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: A thin wrapper to use Rails Migrations in non Rails projects
 test_files: []
+