hummingbird 0.0.1 → 1.0.0

data/README.md

@@ -15,9 +15,25 @@ common denominator amongst those databases.
 
 Hummingbird will look for a `hummingbird.yml` in the directory passed
 to `Hummingbird::Configuration.new`.  Hummingbird will also look for a
-user-specific `.hummingbird.yml` in the current working directory.
-The user-specific configuration file will take precidence over the
-configuration in the `hummingbird.yml`.
+user-specific `.hummingbird.yml` in that directory.  The user-specific
+configuration file will take precidence over the configuration in the
+`hummingbird.yml`.  Both the configuration file name and path, and the
+user-specific configuration name and path can be overridden by passing
+`:config_file => config_name` or `:user_config_file => user_config_name`
+to `Hummingbird::Configuration.new`.
+
+For example:
+
+```Ruby
+config = Hummingbird::Configuration.new(
+  Dir.getwd,
+  config_file: 'path/to/config.yml',
+  user_config_file: '/absolute/path/to/user_config.yml'
+)
+```
+The above example will cause Hummingbird to look for the configuration
+file in `File.join(Dir.getwd, 'path/to/config.yml')`, and to look for
+the user's configuration file in `/absolute/path/to/user_config.yml`.
 
 Both of these configuration files are YAML files with the following
 format:
@@ -59,7 +75,7 @@ handle the maximum file path relative to `migrations_dir`), and a
 `run_on` column of type `INTEGER`.
 
 The following is an example for defining the `migrations_table` for
-SQLite3:
+SQLite3, and PostgreSQL:
 
 ```sql
 CREATE TABLE hummingbird_migrations (

data/lib/hummingbird/configuration.rb

@@ -5,23 +5,28 @@ class Hummingbird
     CONFIG_FILE = 'hummingbird.yml'
     USER_CONFIG_FILE = '.hummingbird.yml'
 
-    def initialize(config_dir)
-      @config = Optimism.require(
-        File.expand_path(File.join(config_dir, CONFIG_FILE)),
-        File.expand_path(File.join(FileUtils.pwd, USER_CONFIG_FILE))
-      )
+    def initialize(config_dir,opts={})
+      opts[:config_file]      ||= CONFIG_FILE
+      opts[:user_config_file] ||= USER_CONFIG_FILE
+
+      config_file_names = [opts[:config_file],opts[:user_config_file]].map do |f|
+        File.expand_path(f,config_dir)
+      end
+
+      @config_dir = config_dir
+      @config = Optimism.require(*config_file_names)
     end
 
     def basedir
-      @basedir ||= @config[:basedir] || '.'
+      @basedir ||= File.expand_path(@config[:basedir] || '.', @config_dir)
     end
 
     def planfile
-      @planfile ||= File.expand_path(File.join(basedir, @config[:planfile] || 'hummingbird.plan'))
+      @planfile ||= File.expand_path(@config[:planfile] || 'hummingbird.plan', basedir)
     end
 
     def migrations_dir
-      @migrations_dir ||= File.expand_path(File.join(basedir, @config[:migrations_dir] || 'migrations'))
+      @migrations_dir ||= File.expand_path(@config[:migrations_dir] || 'migrations', basedir)
     end
 
     def migrations_table

data/lib/hummingbird/plan.rb

@@ -54,7 +54,7 @@ class Hummingbird
     end
 
     def get_migration_contents(migration_file)
-      File.read(File.absolute_path(migration_file, @migration_dir))
+      File.read(File.expand_path(migration_file, @migration_dir))
     end
 
     private

data/lib/hummingbird/version.rb

@@ -1,3 +1,3 @@
 class Hummingbird
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/test/fixtures/config/overridden_config.yml

@@ -0,0 +1,6 @@
+---
+basedir: 'overridden-sql'
+planfile: 'overridden-application.plan'
+migrations_dir: 'overridden-migrations-dir'
+migrations_table: 'overridden_application_migrations'
+connection_string: 'overridden sequel connection string'

data/test/lib/hummingbird/configuration_test.rb

@@ -15,33 +15,33 @@ describe Hummingbird::Configuration do
 
   it 'loads the hummingbird.yml file from the specified config_dir' do
     copy_fixture_to(
-      'basic_config.yml',
+      ['config','basic_config.yml'],
       File.join(@tempdir, Hummingbird::Configuration::CONFIG_FILE)
     )
 
     config = Hummingbird::Configuration.new(@tempdir)
 
-    assert_equal 'sql',                                     config.basedir
+    assert_equal File.expand_path('sql',@tempdir),          config.basedir
     assert_equal _with_basedir(config, 'application.plan'), config.planfile
     assert_equal _with_basedir(config, 'migrations-dir'),   config.migrations_dir
     assert_equal :application_migrations,                   config.migrations_table
     assert_equal 'sequel connection string',                config.connection_string
   end
 
-  it "defaults #basedir to be '.'" do
+  it "defaults #basedir to be the configuration directory" do
     copy_fixture_to(
-      'no_basedir_config.yml',
+      ['config','no_basedir_config.yml'],
       File.join(@tempdir, Hummingbird::Configuration::CONFIG_FILE)
     )
 
     config = Hummingbird::Configuration.new(@tempdir)
 
-    assert_equal '.', config.basedir
+    assert_equal @tempdir, config.basedir
   end
 
   it "defaults #planfile to be basedir + 'hummingbird.plan'" do
     copy_fixture_to(
-      'no_planfile_config.yml',
+      ['config','no_planfile_config.yml'],
       File.join(@tempdir, Hummingbird::Configuration::CONFIG_FILE)
     )
 
@@ -52,7 +52,7 @@ describe Hummingbird::Configuration do
 
   it "defaults #migrations_dir to be basedir + 'migrations'" do
     copy_fixture_to(
-      'no_migrations_dir_config.yml',
+      ['config','no_migrations_dir_config.yml'],
       File.join(@tempdir, Hummingbird::Configuration::CONFIG_FILE)
     )
 
@@ -63,7 +63,7 @@ describe Hummingbird::Configuration do
 
   it 'defaults #migrations_table to be :hummingbird_migrations' do
     copy_fixture_to(
-      'no_migrations_table_config.yml',
+      ['config','no_migrations_table_config.yml'],
       File.join(@tempdir, Hummingbird::Configuration::CONFIG_FILE)
     )
 
@@ -74,7 +74,7 @@ describe Hummingbird::Configuration do
 
   it "does not have a default #connection_string" do
     copy_fixture_to(
-      'no_connection_string_config.yml',
+      ['config','no_connection_string_config.yml'],
       File.join(@tempdir, Hummingbird::Configuration::CONFIG_FILE)
     )
 
@@ -83,71 +83,121 @@ describe Hummingbird::Configuration do
     assert_equal nil, config.connection_string
   end
 
-  it "prefers the user's configuration file if one is present" do
-    [['basic_config.yml', Hummingbird::Configuration::CONFIG_FILE],
-      ['user_config.yml', Hummingbird::Configuration::USER_CONFIG_FILE]].each do |s,d|
-      copy_fixture_to(s, File.join(@tempdir, d))
+  it "prefers the user's configuration file if one is present in the config dir" do
+    [ ['basic_config.yml', Hummingbird::Configuration::CONFIG_FILE],
+      ['user_config.yml',  Hummingbird::Configuration::USER_CONFIG_FILE]].each do |s,d|
+      copy_fixture_to(['config',s], File.join(@tempdir, d))
     end
 
-    config = nil
-    FileUtils.stub :pwd, @tempdir do
-      config = Hummingbird::Configuration.new(@tempdir)
-    end
+    config = Hummingbird::Configuration.new(@tempdir)
 
-    assert_equal 'user-sql',                                    config.basedir
+    assert_equal File.expand_path('user-sql', @tempdir),        config.basedir
     assert_equal _with_basedir(config,'user-application.plan'), config.planfile
     assert_equal _with_basedir(config,'user-migrations-dir'),   config.migrations_dir
   end
 
   it "uses non-user basedir if not present for user" do
-    [['basic_config.yml', Hummingbird::Configuration::CONFIG_FILE],
+    [ ['basic_config.yml',           Hummingbird::Configuration::CONFIG_FILE],
       ['no_basedir_user_config.yml', Hummingbird::Configuration::USER_CONFIG_FILE]].each do |s,d|
-      copy_fixture_to(s, File.join(@tempdir, d))
+      copy_fixture_to(['config',s], File.join(@tempdir, d))
     end
 
-    config = nil
-    FileUtils.stub :pwd, @tempdir do
-      config = Hummingbird::Configuration.new(@tempdir)
-    end
+    config = Hummingbird::Configuration.new(@tempdir)
 
-    assert_equal 'sql',                                          config.basedir
+    assert_equal File.expand_path('sql', @tempdir),              config.basedir
     assert_equal _with_basedir(config, 'user-application.plan'), config.planfile
     assert_equal _with_basedir(config, 'user-migrations-dir'),   config.migrations_dir
   end
 
   it "uses non-user planfile if not present for user" do
-    [['basic_config.yml', Hummingbird::Configuration::CONFIG_FILE],
+    [ ['basic_config.yml',            Hummingbird::Configuration::CONFIG_FILE],
       ['no_planfile_user_config.yml', Hummingbird::Configuration::USER_CONFIG_FILE]].each do |s,d|
-      copy_fixture_to(s, File.join(@tempdir, d))
+      copy_fixture_to(['config',s], File.join(@tempdir, d))
     end
 
-    config = nil
-    FileUtils.stub :pwd, @tempdir do
-      config = Hummingbird::Configuration.new(@tempdir)
-    end
+    config = Hummingbird::Configuration.new(@tempdir)
 
-    assert_equal 'user-sql',                                   config.basedir
+    assert_equal File.expand_path('user-sql', @tempdir),       config.basedir
     assert_equal _with_basedir(config, 'application.plan'),    config.planfile
     assert_equal _with_basedir(config, 'user-migrations-dir'), config.migrations_dir
   end
 
   it "uses non-user migrations_dir if not present for user" do
-    [['basic_config.yml', Hummingbird::Configuration::CONFIG_FILE],
+    [ ['basic_config.yml',                  Hummingbird::Configuration::CONFIG_FILE],
       ['no_migrations_dir_user_config.yml', Hummingbird::Configuration::USER_CONFIG_FILE]].each do |s,d|
-      copy_fixture_to(s, File.join(@tempdir, d))
+      copy_fixture_to(['config',s], File.join(@tempdir, d))
     end
 
-    config = nil
-    FileUtils.stub :pwd, @tempdir do
-      config = Hummingbird::Configuration.new(@tempdir)
-    end
+    config = Hummingbird::Configuration.new(@tempdir)
 
-    assert_equal 'user-sql',                                     config.basedir
+    assert_equal File.expand_path('user-sql', @tempdir),         config.basedir
     assert_equal _with_basedir(config, 'user-application.plan'), config.planfile
     assert_equal _with_basedir(config, 'migrations-dir'),        config.migrations_dir
   end
 
+  it "overrides the base config file name when given a relative :config_file option" do
+    [ ['overridden_config.yml', 'overridden_name.yml'],
+      ['basic_config.yml',      Hummingbird::Configuration::CONFIG_FILE]].each do |s,d|
+      copy_fixture_to(['config',s],File.join(@tempdir,d))
+    end
+
+    config = Hummingbird::Configuration.new(@tempdir, config_file: 'overridden_name.yml')
+
+    assert_equal File.expand_path('overridden-sql', @tempdir),                    config.basedir
+    assert_equal File.expand_path('overridden-application.plan', config.basedir), config.planfile
+    assert_equal File.expand_path('overridden-migrations-dir', config.basedir),   config.migrations_dir
+    assert_equal :overridden_application_migrations,                              config.migrations_table
+    assert_equal 'overridden sequel connection string',                           config.connection_string
+  end
+
+  it "overrides the base config file name when given an absolute :config_file option" do
+    copy_fixture_to(['config','basic_config.yml'], File.join(@tempdir,Hummingbird::Configuration::CONFIG_FILE))
+    overridden_config_path = File.join(tempdir,'config.yml')
+    copy_fixture_to(['config','overridden_config.yml'], overridden_config_path)
+
+    config = Hummingbird::Configuration.new(@tempdir, config_file: overridden_config_path)
+
+    assert_equal File.expand_path('overridden-sql', @tempdir),                    config.basedir
+    assert_equal File.expand_path('overridden-application.plan', config.basedir), config.planfile
+    assert_equal File.expand_path('overridden-migrations-dir', config.basedir),   config.migrations_dir
+    assert_equal :overridden_application_migrations,                              config.migrations_table
+    assert_equal 'overridden sequel connection string',                           config.connection_string
+  end
+
+  it "overrides the base user config file name when given a relative :user_config_file option" do
+    [ ['basic_config.yml',      Hummingbird::Configuration::CONFIG_FILE],
+      ['user_config.yml',       Hummingbird::Configuration::USER_CONFIG_FILE],
+      ['overridden_config.yml', 'overridden_name.yml']].each do |s,d|
+      copy_fixture_to(['config',s],File.join(@tempdir,d))
+    end
+
+    config = Hummingbird::Configuration.new(@tempdir, user_config_file: 'overridden_name.yml')
+
+    assert_equal File.expand_path('overridden-sql', @tempdir),                    config.basedir
+    assert_equal File.expand_path('overridden-application.plan', config.basedir), config.planfile
+    assert_equal File.expand_path('overridden-migrations-dir', config.basedir),   config.migrations_dir
+    assert_equal :overridden_application_migrations,                              config.migrations_table
+    assert_equal 'overridden sequel connection string',                           config.connection_string
+  end
+
+  it "overrides the base user config file name when given an absolute :user_config_file option" do
+    overridden_config_path = File.join(tempdir,'overridden_name.yml')
+    [ ['basic_config.yml',      Hummingbird::Configuration::CONFIG_FILE],
+      ['user_config.yml',       Hummingbird::Configuration::USER_CONFIG_FILE],
+      ['overridden_config.yml', overridden_config_path]].each do |s,d|
+      copy_fixture_to(['config',s],File.expand_path(d,@tempdir))
+    end
+
+    config = Hummingbird::Configuration.new(@tempdir, user_config_file: overridden_config_path)
+
+    assert_equal File.expand_path('overridden-sql', @tempdir),                    config.basedir
+    assert_equal File.expand_path('overridden-application.plan', config.basedir), config.planfile
+    assert_equal File.expand_path('overridden-migrations-dir', config.basedir),   config.migrations_dir
+    assert_equal :overridden_application_migrations,                              config.migrations_table
+    assert_equal 'overridden sequel connection string',                           config.connection_string
+  end
+
   def _with_basedir(config,path)
-    File.expand_path(File.join(config.basedir,path))
+    File.expand_path(path,config.basedir)
   end
 end

data/test/test_helper.rb

@@ -45,7 +45,7 @@ class MiniTest::Unit::TestCase
   end
 
   def copy_fixture_to(fixture, dest)
-    FileUtils.cp(path_to_fixture(fixture), dest)
+    FileUtils.cp(path_to_fixture(*fixture), dest)
   end
 
   def assert_set_equal(exp, act, msg = nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hummingbird
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2012-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -161,22 +161,23 @@ files:
 - lib/hummingbird/plan.rb
 - lib/hummingbird/plan_error.rb
 - lib/hummingbird/version.rb
-- test/fixtures/basic_config.yml
-- test/fixtures/no_basedir_config.yml
-- test/fixtures/no_basedir_user_config.yml
-- test/fixtures/no_connection_string_config.yml
-- test/fixtures/no_migrations_dir_config.yml
-- test/fixtures/no_migrations_dir_user_config.yml
-- test/fixtures/no_migrations_table_config.yml
-- test/fixtures/no_planfile_config.yml
-- test/fixtures/no_planfile_user_config.yml
+- test/fixtures/config/basic_config.yml
+- test/fixtures/config/no_basedir_config.yml
+- test/fixtures/config/no_basedir_user_config.yml
+- test/fixtures/config/no_connection_string_config.yml
+- test/fixtures/config/no_migrations_dir_config.yml
+- test/fixtures/config/no_migrations_dir_user_config.yml
+- test/fixtures/config/no_migrations_table_config.yml
+- test/fixtures/config/no_planfile_config.yml
+- test/fixtures/config/no_planfile_user_config.yml
+- test/fixtures/config/overridden_config.yml
+- test/fixtures/config/user_config.yml
 - test/fixtures/plan/basic.plan
 - test/fixtures/sql/migrations/basic/file1.sql
 - test/fixtures/sql/migrations/basic/file2.sql
 - test/fixtures/sql/migrations/basic/file3.sql
 - test/fixtures/sql/migrations/basic/file4.sql
 - test/fixtures/sql/migrations_table.sql
-- test/fixtures/user_config.yml
 - test/lib/hummingbird/configuration_test.rb
 - test/lib/hummingbird/database_test.rb
 - test/lib/hummingbird/plan_test.rb
@@ -204,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1062239906783200272
+      hash: -2384325587943083337
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -213,22 +214,23 @@ specification_version: 3
 summary: No DSL, as little magic as possible.  Write your DB migrations in SQL, and
   run them in the order specified by a plan file.
 test_files:
-- test/fixtures/basic_config.yml
-- test/fixtures/no_basedir_config.yml
-- test/fixtures/no_basedir_user_config.yml
-- test/fixtures/no_connection_string_config.yml
-- test/fixtures/no_migrations_dir_config.yml
-- test/fixtures/no_migrations_dir_user_config.yml
-- test/fixtures/no_migrations_table_config.yml
-- test/fixtures/no_planfile_config.yml
-- test/fixtures/no_planfile_user_config.yml
+- test/fixtures/config/basic_config.yml
+- test/fixtures/config/no_basedir_config.yml
+- test/fixtures/config/no_basedir_user_config.yml
+- test/fixtures/config/no_connection_string_config.yml
+- test/fixtures/config/no_migrations_dir_config.yml
+- test/fixtures/config/no_migrations_dir_user_config.yml
+- test/fixtures/config/no_migrations_table_config.yml
+- test/fixtures/config/no_planfile_config.yml
+- test/fixtures/config/no_planfile_user_config.yml
+- test/fixtures/config/overridden_config.yml
+- test/fixtures/config/user_config.yml
 - test/fixtures/plan/basic.plan
 - test/fixtures/sql/migrations/basic/file1.sql
 - test/fixtures/sql/migrations/basic/file2.sql
 - test/fixtures/sql/migrations/basic/file3.sql
 - test/fixtures/sql/migrations/basic/file4.sql
 - test/fixtures/sql/migrations_table.sql
-- test/fixtures/user_config.yml
 - test/lib/hummingbird/configuration_test.rb
 - test/lib/hummingbird/database_test.rb
 - test/lib/hummingbird/plan_test.rb