mschuerig-branch_db 0.0.8 → 0.0.9

data/README.rdoc

@@ -15,7 +15,7 @@ Give each git branch its own databases for ActiveRecord.
 == SYNOPSIS:
 
 Put the following block of code into config/environment.rb *before*
-Rails::Initializer.run. This code ensures that the database is 
+Rails::Initializer.run. This code ensures that the database is
 automatically switched, based on the checked out git branch.
 
   # config/environment.rb

data/Rakefile

@@ -1,24 +1,24 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/branch_db'
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('branch_db', BranchDb::VERSION) do |p|
-  p.developer('Michael Schuerig', 'michael@schuerig.de')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.extra_deps         = [
-    ['activerecord','>= 2.0.2'],
-  ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
-end
-
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
-
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/branch_db'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('branch_db', BranchDb::VERSION) do |p|
+  p.developer('Michael Schuerig', 'michael@schuerig.de')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps         = [
+    ['activerecord','>= 2.0.2'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+

data/branch_db.gemspec

@@ -2,21 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{branch_db}
-  s.version = "0.0.8"
+  s.version = "0.0.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Schuerig"]
-  s.date = %q{2009-05-21}
+  s.date = %q{2009-05-25}
   s.description = %q{Give each git branch its own databases for ActiveRecord.}
   s.email = ["michael@schuerig.de"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
   s.files = [".gitignore", "History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "branch_db.gemspec", "lib/branch_db.rb", "lib/branch_db/configuration_twiddler.rb", "lib/branch_db/mysql_switcher.rb", "lib/branch_db/postgresql_switcher.rb", "lib/branch_db/real_db_switchers_common.rb", "lib/branch_db/sqlite_switcher.rb", "lib/branch_db/switcher.rb", "lib/branch_db/task_helper.rb", "lib/tasks/db_branches.rb", "rails/properties.rb", "test/mocks.rb", "test/test_configuration_twiddler.rb", "test/test_helper.rb", "test/test_postgresql_switcher.rb", "test/test_sqlite_switcher.rb", "test/test_switcher.rb"]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/mschuerig/branch_db}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{branch_db}
-  s.rubygems_version = %q{1.3.2}
+  s.rubygems_version = %q{1.3.3}
   s.summary = %q{Give each git branch its own databases for ActiveRecord.}
   s.test_files = ["test/test_sqlite_switcher.rb", "test/test_helper.rb", "test/test_configuration_twiddler.rb", "test/test_postgresql_switcher.rb", "test/test_switcher.rb"]
 

data/lib/branch_db.rb

@@ -2,9 +2,9 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module BranchDb
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
   DEFAULT_BRANCH = 'master'
-  
+
   class Error < StandardError; end
 
   def self.current_repo_branch(raise_on_error = false)

data/lib/branch_db/configuration_twiddler.rb

@@ -3,7 +3,7 @@ require 'branch_db'
 
 module BranchDb # :nodoc
   module ConfigurationTwiddler
-    
+
     def self.included(base)
       base.send(:alias_method, :database_configuration_without_branches, :database_configuration)
       base.send(:alias_method, :database_configuration, :database_configuration_with_branches)

data/lib/branch_db/mysql_switcher.rb

@@ -6,21 +6,17 @@ module BranchDb # :nodoc:
 
   class MysqlSwitcher < Switcher
     include RealDbSwitchersCommon
-    
+
     def self.can_handle?(config)
       config['adapter'] == 'mysql'
     end
-    
+
     def current
       current_branch = branch_db_exists?(@branch) ? @branch : 'master'
       puts "#{@rails_env}: #{branch_db(current_branch)} (MySQL)"
     end
-    
+
     protected
-    
-    def self.show_branches(rails_env, config)
-      super
-    end
 
     def create_database(branch)
       ### TODO when copying a database, determine charset and collation from original
@@ -31,36 +27,33 @@ module BranchDb # :nodoc:
       ActiveRecord::Base.connection.create_database(config['database'], :charset => (config['charset'] || charset), :collation => (config['collation'] || collation))
       ActiveRecord::Base.establish_connection(config)
     end
-    
+
     def drop_database(branch)
       config = branch_config(branch)
       ActiveRecord::Base.establish_connection(config)
       ActiveRecord::Base.connection.drop_database config['database']
-      @existing_databases = nil
+      reset_existing_databases
       nil
     end
-    
-    def existing_databases
-      @existing_databases ||=
-        begin
-          raw_dbs = `mysql #{command_options(@config)} -e 'SHOW DATABASES'`
-          if $? == 0
-            existing_dbs = raw_dbs.split("\n").drop(1)
-            existing_dbs -= %w( information_schema )
-          else
-            raise Error, "Cannot determine existing databases."
-          end
-        end
+
+    def self.find_existing_databases
+      raw_dbs = `mysql #{command_options(@config)} -e 'SHOW DATABASES'`
+      if $? == 0
+        existing_dbs = raw_dbs.split("\n").drop(1)
+        existing_dbs -= %w( information_schema )
+      else
+        raise Error, "Cannot determine existing databases."
+      end
     end
-    
+
     def dump_command(config, dump_file)
       %{mysqldump #{command_options(config)} #{config["database"]} > #{dump_file}}
     end
-    
+
     def load_command(config, dump_file)
       %{mysql #{command_options(config)} #{config["database"]} < #{dump_file}}
     end
-    
+
     def command_options(config)
       returning opts = '' do
         %w( user username password password host host).each_slice(2) do |o, k|

data/lib/branch_db/postgresql_switcher.rb

@@ -6,21 +6,17 @@ module BranchDb # :nodoc:
 
   class PostgresqlSwitcher < Switcher
     include RealDbSwitchersCommon
-    
+
     def self.can_handle?(config)
       config['adapter'] == 'postgresql'
     end
-    
+
     def current
       current_branch = branch_db_exists?(@branch) ? @branch : 'master'
       puts "#{@rails_env}: #{branch_db(current_branch)} (PostgreSQL)"
     end
-    
+
     protected
-    
-    def self.show_branches(rails_env, config)
-      super
-    end
 
     def create_database(branch)
       config = branch_config(branch).merge(
@@ -30,32 +26,29 @@ module BranchDb # :nodoc:
       ActiveRecord::Base.establish_connection(config)
       nil
     end
-    
+
     def drop_database(branch)
       config = branch_config(branch)
       ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
       ActiveRecord::Base.connection.drop_database(config['database'])
-      @existing_databases = nil
+      reset_existing_databases
       nil
     end
-    
-    def existing_databases
-      @existing_databases ||=
-        begin
-          raw_dbs = `psql -l`
-          if $? == 0
-            existing_dbs = raw_dbs.split("\n").drop_while { |l| l !~ /^-/ }.drop(1).take_while { |l| l !~ /^\(/ }.map { |l| l.split('|')[0].strip }
-            existing_dbs.reject { |db| db =~ /^template/ }
-          else
-            raise Error, "Cannot determine existing databases."
-          end
-        end
+
+    def self.find_existing_databases
+      raw_dbs = `psql -l`
+      if $? == 0
+        existing_dbs = raw_dbs.split("\n").drop_while { |l| l !~ /^-/ }.drop(1).take_while { |l| l !~ /^\(/ }.map { |l| l.split('|')[0].strip }
+        existing_dbs.reject { |db| db =~ /^template/ }
+      else
+        raise Error, "Cannot determine existing databases."
+      end
     end
-    
+
     def dump_command(config, dump_file)
       %{pg_dump #{command_options(config)} --clean #{config['database']} > #{dump_file}}
     end
-    
+
     def load_command(config, dump_file)
       %{psql #{command_options(config)} -f "#{dump_file}" #{config['database']}}
     end

data/lib/branch_db/real_db_switchers_common.rb

@@ -1,8 +1,41 @@
+
 module BranchDb # :nodoc:
 
   module RealDbSwitchersCommon
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def branch_dbs
+        existing_databases.grep
+      end
+
+      def find_existing_databases
+        raise Error, "Classes including RealDbSwitchersCommon must implement #find_existing_databases."
+      end
+
+      def existing_databases
+        @existing_databases ||= find_existing_databases
+      end
+
+      def reset_existing_databases
+        @existing_databases = nil
+      end
+
+      def show_branches(rails_env, config)
+        case per_branch = config['per_branch']
+        when true
+          master_db = config['database']
+          pat = master_db.split(/[_-]/).join('(?:(?:[-_]+)|(?:[-_]+[-_\w]+?[-_]+))')
+          dbs = existing_databases.grep(/^#{pat}$/)
+          puts "#{rails_env}: #{dbs.join(', ')}."
+        end
+      end
+    end
+
     protected
-    
+
     def branch_db(branch)
       if branch == 'master'
         @config['database']
@@ -12,14 +45,14 @@ module BranchDb # :nodoc:
     end
 
     def branch_db_exists?(branch)
-      existing_databases.include?(branch_db(branch))
+      self.class.existing_databases.include?(branch_db(branch))
     end
-    
+
     def copy_database(from_branch, to_branch)
       dump_file = dump_branch_db(from_branch)
       load_branch_db(to_branch, dump_file)
     end
-    
+
     def dump_branch_db(branch)
       require 'tempfile'
       config = branch_config(branch)
@@ -33,7 +66,7 @@ module BranchDb # :nodoc:
     ensure
       File.umask(old_umask)
     end
-    
+
     def load_branch_db(branch, dump_file)
       config = branch_config(branch)
       cmd = load_command(config, dump_file)

data/lib/branch_db/sqlite_switcher.rb

@@ -12,9 +12,9 @@ module BranchDb # :nodoc:
       current_branch = branch_db_exists?(@branch) ? @branch : 'master'
       puts "#{@rails_env}: #{rails_root_relative(branch_db(current_branch))} (SQLite)"
     end
-    
+
     protected
-    
+
     def self.show_branches(rails_env, config)
       super
     end
@@ -26,17 +26,17 @@ module BranchDb # :nodoc:
         @config['database'].sub(/(.+)\./, "\\1_#{branch}.")
       end
     end
-    
+
     def branch_db_exists?(branch)
       File.exists?(branch_db_path(branch))
     end
-    
+
     def create_database(branch)
       config = branch_config(branch)
       ActiveRecord::Base.establish_connection(config)
       ActiveRecord::Base.connection
     end
-    
+
     def drop_database(branch)
       FileUtils.rm_f(branch_db_path(branch))
     end
@@ -44,9 +44,9 @@ module BranchDb # :nodoc:
     def copy_database(from_branch, to_branch)
       FileUtils.cp(branch_db_path(from_branch), branch_db_path(to_branch))
     end
-    
+
     private
-    
+
     def branch_db_path(branch)
       File.join(RAILS_ROOT, branch_db(branch))
     end

data/lib/branch_db/switcher.rb

@@ -10,15 +10,15 @@ module BranchDb # :nodoc:
       end
       switcher
     end
-    
+
     def self.can_handle?(config)
       raise Error, "Subclasses of BranchDb::Switcher must implement #can_handle?(config)."
     end
-    
+
     def self.create(rails_env, config, branch, options = {})
       which(config).new(rails_env, config, branch, options)
     end
-    
+
     def self.branches(rails_env, config)
       self.which(config).show_branches(rails_env, config)
     end
@@ -32,17 +32,17 @@ module BranchDb # :nodoc:
     def current
       # Must be implemented in subclasses.
     end
-    
+
     def exists?
       branch_db_exists?(@branch)
     end
-    
+
     def switch!
       if exists?
         @config.replace(branch_config(@branch))
       end
     end
-    
+
     def create_empty_database
       db = branch_db(@branch)
       if branch_db_exists?(@branch)
@@ -58,40 +58,34 @@ module BranchDb # :nodoc:
       create_database(@branch)
       yield if block_given?
     end
-    
+
     def delete_database
       ensure_branch_db_exists!(@branch)
       puts "Dropping existing database #{branch_db(@branch)}..."
       drop_database(@branch)
     end
-    
+
     def copy_from(from_branch)
       ensure_branch_db_exists!(from_branch)
 
       create_empty_database do
-        puts "Copying data from #{from_branch}..."
+        puts "Copying data from #{branch_db(from_branch)}..."
         copy_database(from_branch, @branch)
       end
     end
-    
+
     protected
-    
+
     def self.show_branches(rails_env, config)
-      case per_branch = config['per_branch']
-      when true
+      if config['per_branch']
         puts "#{rails_env}: Has branch databases. Cannot determine which ones."
-#      when Hash
-#        puts "#{rails_env}:"
-#        per_branch.each do |db|
-#          puts "  #{db}"
-#        end
       end
     end
 
     def verbose?
       @verbose
     end
-    
+
     def branch_config(branch)
       @config.merge('database' => branch_db(branch))
     end
@@ -105,23 +99,23 @@ module BranchDb # :nodoc:
     def branch_db_exists?(branch)
       false
     end
-    
+
     def branch_db(branch)
       # Must be implemented in subclasses.
     end
-    
+
     def create_database(branch)
       # Must be implemented in subclasses.
     end
-    
+
     def drop_database(branch)
       # Must be implemented in subclasses.
     end
-    
+
     def copy_database(from_branch, to_branch)
       # Must be implemented in subclasses.
     end
-    
+
     private
 
     def self.switchers

data/lib/branch_db/task_helper.rb

@@ -7,7 +7,7 @@ module BranchDb # :nodoc:
     def current_branch
       BranchDb::current_repo_branch(true)
     end
-    
+
     def environment_options
       returning options = {} do
         [:overwrite, :verbose].each do |opt|
@@ -15,7 +15,7 @@ module BranchDb # :nodoc:
         end
       end
     end
-    
+
     def target_branch
       ENV['BRANCH'] || current_branch
     end
@@ -23,7 +23,7 @@ module BranchDb # :nodoc:
     def originating_branch
       ENV['ORIG_BRANCH'] || 'master' ### TODO determine originating branch
     end
-    
+
     def each_local_config
       ActiveRecord::Base.configurations.each do |rails_env, config|
         next unless config['database']
@@ -38,7 +38,7 @@ module BranchDb # :nodoc:
         end
       end
     end
-    
+
     def each_local_database(*args)
       options = args.last.kind_of?(Hash) ? args.pop : {}
       options = options.reverse_merge(environment_options)

data/lib/tasks/db_branches.rb

@@ -7,14 +7,14 @@ namespace :db do
       require 'branch_db/task_helper'
       include BranchDb::TaskHelper
     end
-    
+
     desc "List all branch databases"
     task :list => :setup do
       each_local_config do |rails_env, config|
         BranchDb::Switcher.branches(rails_env, config)
       end
     end
-    
+
     desc "Currently selected databases."
     task :current => :setup do
       each_local_database { |switcher| switcher.current }
@@ -24,7 +24,7 @@ namespace :db do
     task :create => :setup do
       each_local_database { |switcher| switcher.create_empty_database }
     end
-    
+
     desc "Copy databases from one branch to another. Default is from ORIG_BRANCH=master to BRANCH=<current branch>"
     task :copy => :setup do
       each_local_database { |switcher| switcher.copy_from(originating_branch) }

data/test/mocks.rb

@@ -20,7 +20,7 @@ module Recorder
   def verify(*expected)
     assert_equal(expected, recorded_calls)
   end
-end    
+end
 
 module BranchDb
   def self.set_branch(branch)
@@ -29,24 +29,26 @@ module BranchDb
   def self.current_repo_branch
     @branch
   end
-  
+
   class MysqlSwitcher < Switcher
+    include RealDbSwitchersCommon
     include Recorder
     record :create_database, :drop_database, :load_branch_db
     record(:dump_branch_db) { 'the-dump-file' }
 
-    def existing_databases
+    def self.find_existing_databases
       %w( testit_development testit_feature_development testit_test )
     end
   end
 
   ### FIXME this repetition is dumb
   class PostgresqlSwitcher < Switcher
+    include RealDbSwitchersCommon
     include Recorder
     record :create_database, :drop_database, :load_branch_db
     record(:dump_branch_db) { 'the-dump-file' }
 
-    def existing_databases
+    def self.find_existing_databases
       %w( testit_development testit_feature_development testit_test )
     end
   end

data/test/test_configuration_twiddler.rb

@@ -8,7 +8,7 @@ class MockConfiguration
   def initialize(config)
     @config = config
   end
-  
+
   def database_configuration
     @config
   end
@@ -21,13 +21,13 @@ module RealDatabaseTests
     assert_env_db 'testit_development', 'development'
     assert_env_db 'testit_test', 'test'
   end
-  
+
   def test_branch
     BranchDb.set_branch('feature')
     assert_env_db 'testit_feature_development', 'development'
     assert_env_db 'testit_test', 'test'
   end
-  
+
   def test_non_existing_branch
     BranchDb.set_branch('erehwon')
     assert_env_db 'testit_development', 'development'
@@ -53,7 +53,7 @@ class TestConfigurationTwiddlerPostgreSQL < Test::Unit::TestCase
       }
     })
   end
-  
+
   include RealDatabaseTests
 end
 
@@ -71,14 +71,14 @@ class TestConfigurationTwiddlerMysql < Test::Unit::TestCase
       }
     })
   end
-  
+
   include RealDatabaseTests
 end
 
 class TestConfigurationTwiddlerSQLite < Test::Unit::TestCase
   def setup
     create_mock_sqlite_db(
-      'db/development.sqlite3', 
+      'db/development.sqlite3',
       'db/development_feature.sqlite3',
       'db/test.sqlite3'
     )
@@ -94,23 +94,23 @@ class TestConfigurationTwiddlerSQLite < Test::Unit::TestCase
       }
     })
   end
-  
+
   def teardown
     FileUtils.rm_rf(RAILS_ROOT)
   end
-  
+
   def test_master_branch
     BranchDb.set_branch('master')
     assert_env_db 'db/development.sqlite3', 'development'
     assert_env_db 'db/test.sqlite3', 'test'
   end
-  
+
   def test_branch
     BranchDb.set_branch('feature')
     assert_env_db 'db/development_feature.sqlite3', 'development'
     assert_env_db 'db/test.sqlite3', 'test'
   end
-  
+
   def test_non_existing_branch
     BranchDb.set_branch('erehwon')
     assert_env_db 'db/development.sqlite3', 'development'

data/test/test_postgresql_switcher.rb

@@ -22,9 +22,9 @@ class TestPostgresqlSwitcher < Test::Unit::TestCase
     branch = options.delete(:branch) || 'feature'
     BranchDb::PostgresqlSwitcher.new(env, @config[env], branch, options)
   end
-  
+
   def test_branches
-    assert_stdout "development: Has branch databases. Cannot determine which ones.\n" do
+    assert_stdout "development: testit_development, testit_feature_development.\n" do
       BranchDb::Switcher.branches('development', @config['development'])
     end
     assert_stdout "" do

data/test/test_sqlite_switcher.rb

@@ -5,7 +5,7 @@ require 'mocks'
 class TestSqliteSwitcher < Test::Unit::TestCase
   def setup
     create_mock_sqlite_db(
-      'db/development.sqlite3', 
+      'db/development.sqlite3',
       'db/development_feature.sqlite3',
       'db/test.sqlite3'
     )
@@ -31,7 +31,7 @@ class TestSqliteSwitcher < Test::Unit::TestCase
     branch = options.delete(:branch) || 'feature'
     BranchDb::SqliteSwitcher.new(env, @config[env], branch, options)
   end
-  
+
   def test_branches
     assert_stdout "development: Has branch databases. Cannot determine which ones.\n" do
       BranchDb::Switcher.branches('development', @config['development'])

data/test/test_switcher.rb

@@ -2,7 +2,7 @@
 require 'test_helper'
 
 class TestSwitcher < Test::Unit::TestCase
-  
+
   def test_dummy
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mschuerig-branch_db
 version: !ruby/object:Gem::Version 
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors: 
 - Michael Schuerig
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-21 00:00:00 -07:00
+date: 2009-05-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,7 +76,7 @@ files:
 - test/test_postgresql_switcher.rb
 - test/test_sqlite_switcher.rb
 - test/test_switcher.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/mschuerig/branch_db
 post_install_message: 
 rdoc_options: