mschuerig-branch_db 0.0.1 → 0.0.2

data/Manifest.txt

@@ -3,6 +3,7 @@ History.txt
 Manifest.txt
 README.rdoc
 Rakefile
+branch_db.gemspec
 lib/branch_db.rb
 lib/branch_db/configuration_twiddler.rb
 lib/branch_db/postgresql_switcher.rb
@@ -11,7 +12,6 @@ lib/branch_db/switcher.rb
 lib/branch_db/task_helper.rb
 lib/tasks/db_branches.rb
 test/mocks.rb
-test/test_branch_db.rb
 test/test_configuration_twiddler.rb
 test/test_helper.rb
 test/test_postgresql_switcher.rb

data/README.rdoc

@@ -20,10 +20,24 @@ Put the following block of code into config/environment.rb *before*
 Rails::Initializer.run. This code ensures that the database is 
 automatically switched, based on the checked out git branch.
 
+  # config/environment.rb
+  ...
   require 'branch_db/configuration_twiddler'
   Rails::Configuration.class_eval do
     include ::BranchDb::ConfigurationTwiddler
   end
+  ...
+
+In config/database.yml, mark the configuration that may have
+databases specific to current branch
+
+  # config/database.yml
+  development: &development
+    adapter: postgresql
+    database: myproject_development
+    host: localhost
+    port: 5432
+    per_branch: true
 
 To your Rakefile or a file in lib/tasks add
 
@@ -47,6 +61,16 @@ Then you can use these rake tasks to manage your databases.
   rake db:branches:delete
       Delete databases for a branch given by BRANCH
 
+Say, you have a configuration as above and you're currently on
+git branch "feature" when you decide that you need a database
+specific to this branch. Then
+
+  ~/projects/myproject (feature*)$ rake db:branches:copy ORIG_BRANCH=master
+
+will give you a copy of the database from branch "master".
+If your branch already has a database that you want to overwrite,
+add OVERWRITE=true to the command line.
+
 == REQUIREMENTS:
 
 * ActiveRecord

data/branch_db.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{branch_db}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Schuerig"]
+  s.date = %q{2009-04-09}
+  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/postgresql_switcher.rb", "lib/branch_db/sqlite_switcher.rb", "lib/branch_db/switcher.rb", "lib/branch_db/task_helper.rb", "lib/tasks/db_branches.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 = false
+  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.1}
+  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"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.0.2"])
+      s.add_development_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.0.2"])
+      s.add_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.0.2"])
+    s.add_dependency(%q<newgem>, [">= 1.3.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/lib/branch_db/sqlite_switcher.rb

@@ -28,7 +28,7 @@ module BranchDb # :nodoc:
     end
     
     def branch_db_exists?(branch)
-      File.exist?(File.join(RAILS_ROOT, branch_db(branch)))
+      File.exists?(branch_db_path(branch))
     end
     
     def create_database(branch)
@@ -38,11 +38,18 @@ module BranchDb # :nodoc:
     end
     
     def drop_database(branch)
-      FileUtils.rm_f(branch_db(branch))
+      FileUtils.rm_f(branch_db_path(branch))
     end
 
     def copy_database(from_branch, to_branch)
-      FileUtils.cp(branch_db(from_branch), branch_db(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
+
   end
 end

data/lib/branch_db/switcher.rb

@@ -5,7 +5,7 @@ module BranchDb # :nodoc:
     def self.which(config)
       switcher = switchers.detect { |sw| sw.can_handle?(config) }
       unless switcher
-        $stderr.puts 'Your database adapter is not supported yet.'
+        $stderr.puts "Your database adapter (#{config['adapter']}) is not supported yet."
         switcher = self # double as null switcher
       end
       switcher

data/lib/branch_db/task_helper.rb

@@ -10,7 +10,7 @@ module BranchDb # :nodoc:
     
     def environment_options
       { 
-        :overwrite => ENV['OVERWRITE']
+        :overwrite => (ENV['OVERWRITE'] =~ /^(true|1)$/i) == 0
       }
     end
     

data/lib/branch_db.rb

@@ -2,7 +2,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module BranchDb
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
   DEFAULT_BRANCH = 'master'
   
   class Error < StandardError; end

data/lib/tasks/db_branches.rb

@@ -27,11 +27,7 @@ namespace :db do
     
     desc "Copy databases from one branch to another. Default is from ORIG_BRANCH=master to BRANCH=<current branch>"
     task :copy => :setup do
-      if target_branch == current_branch
-        $stderr.puts "Cannot copy database to itself."
-      else
-        each_local_database { |switcher| switcher.copy_from(originating_branch) }
-      end
+      each_local_database { |switcher| switcher.copy_from(originating_branch) }
     end
 
     desc "Delete databases for a branch given by BRANCH"

data/test/mocks.rb

@@ -1,17 +1,26 @@
 
-require 'branch_db'
-require 'branch_db/configuration_twiddler'
-
-class MockConfiguration
-  def initialize(config)
-    @config = config
+module Recorder
+  include Test::Unit::Assertions
+  def self.included(base)
+    base.extend(SingletonMethods)
   end
-  
-  def database_configuration
-    @config
+  def recorded_calls
+    @recorded_calls ||= []
   end
-  include ::BranchDb::ConfigurationTwiddler
-end
+  module SingletonMethods
+    def record(*methods, &block)
+      methods.each do |m|
+        define_method(m) do |*args|
+          recorded_calls << [m.to_sym] + args
+          block.call if block
+        end
+      end
+    end
+  end
+  def verify(*expected)
+    assert_equal(expected, recorded_calls)
+  end
+end    
 
 module BranchDb
   def self.set_branch(branch)
@@ -22,14 +31,10 @@ module BranchDb
   end
   
   class PostgresqlSwitcher < Switcher
-    def dump_branch_db(*args)
-      @ops ||= []
-      @ops << [:dump_branch_db] + args
-    end
-    def load_branch_db(*args)
-      @ops ||= []
-      @ops << [:load_branch_db] + args
-    end
+    include Recorder
+    record :create_database, :drop_database, :load_branch_db
+    record(:dump_branch_db) { 'the-dump-file' }
+
     def existing_databases
       %w( testit_development testit_feature_development testit_test )
     end
@@ -37,8 +42,17 @@ module BranchDb
       @ops
     end
   end
+
+  class SqliteSwitcher < Switcher
+    include Recorder
+    record :create_database
+  end
 end
 
-def create_mock_sqlite_db(name)
-  File.open(File.join(RAILS_ROOT, name), 'w') { |f| f.puts 'Mock' }
+def create_mock_sqlite_db(*names)
+  db_dir = File.join(RAILS_ROOT, 'db')
+  FileUtils.mkdir_p(db_dir) unless File.directory?(db_dir)
+  names.each do |name|
+    File.open(File.join(RAILS_ROOT, name), 'w') { |f| f.puts 'Mock' }
+  end
 end

data/test/test_configuration_twiddler.rb

@@ -1,8 +1,20 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
+
+require 'test_helper'
 
 require 'branch_db/configuration_twiddler'
 require 'mocks'
 
+class MockConfiguration
+  def initialize(config)
+    @config = config
+  end
+  
+  def database_configuration
+    @config
+  end
+  include ::BranchDb::ConfigurationTwiddler
+end
+
 module RealDatabaseTests
   def test_master_branch
     BranchDb.set_branch('master')
@@ -68,6 +80,11 @@ end
 
 class TestConfigurationTwiddlerSQLite < Test::Unit::TestCase
   def setup
+    create_mock_sqlite_db(
+      'db/development.sqlite3', 
+      'db/development_feature.sqlite3',
+      'db/test.sqlite3'
+    )
     @mock = MockConfiguration.new({
       'development' => {
         'database' => 'db/development.sqlite3',
@@ -79,11 +96,6 @@ class TestConfigurationTwiddlerSQLite < Test::Unit::TestCase
         'adapter' => 'sqlite3'
       }
     })
-
-    @tmpdir = FileUtils.mkdir_p(File.join(RAILS_ROOT, 'db'))
-    create_mock_sqlite_db('db/development.sqlite3')
-    create_mock_sqlite_db('db/development_feature.sqlite3')
-    create_mock_sqlite_db('db/test.sqlite3')
   end
   
   def teardown

data/test/test_helper.rb

@@ -1,8 +1,42 @@
+
 require 'stringio'
+require 'fileutils'
 require 'test/unit'
-require File.dirname(__FILE__) + '/../lib/branch_db'
 
-require 'rubygems'
-require 'ruby-debug'
+require 'branch_db'
+
+#require 'rubygems'
+#require 'ruby-debug'
 
 RAILS_ROOT = File.expand_path(File.join(File.dirname(__FILE__), 'tmp'))
+
+def assert_stdout(expected)
+  oldout = $stdout
+  $stdout = StringIO.new
+  yield
+  $stdout.rewind
+  case expected
+  when String
+    assert_equal(expected, $stdout.read)
+  when Regexp
+    assert_match(expected, $stdout.read)
+  else
+    raise ArgumentError, "Don't know how to check stdout against #{expected.inspect}."
+  end
+ensure
+  $stdout = oldout
+end
+
+def assert_sqlite_db_exist(name)
+  assert File.exists?(File.join(RAILS_ROOT, name)), "SQLite database #{name} does not exist."
+end
+
+# from ActiveSupport
+def silence_stream(stream)
+  old_stream = stream.dup
+  stream.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
+  stream.sync = true
+  yield
+ensure
+  stream.reopen(old_stream)
+end

data/test/test_postgresql_switcher.rb

@@ -1,5 +1,5 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
 
+require 'test_helper'
 require 'mocks'
 
 class TestPostgresqlSwitcher < Test::Unit::TestCase
@@ -7,13 +7,69 @@ class TestPostgresqlSwitcher < Test::Unit::TestCase
     @config = {
       'development' => {
         'database' => 'testit_development',
+        'adapter' => 'postgresql',
+        'per_branch' => true
+      },
+      'test' => {
+        'database' => 'testit_test',
         'adapter' => 'postgresql'
       }
     }
-    @switcher = BranchDb::PostgresqlSwitcher.new('development', @config, 'feature')
+  end
+
+  def make_switcher(options = {})
+    env = options.delete(:env) || 'development'
+    branch = options.delete(:branch) || 'feature'
+    BranchDb::PostgresqlSwitcher.new(env, @config[env], branch, options)
   end
   
   def test_branches
-    puts BranchDb::PostgresqlSwitcher.branches('development', @config['development'])
+    assert_stdout "development: Has branch databases. Cannot determine which ones.\n" do
+      BranchDb::Switcher.branches('development', @config['development'])
+    end
+    assert_stdout "" do
+      BranchDb::Switcher.branches('development', @config['test'])
+    end
+  end
+
+  def test_create_empty_database_non_existing
+    switcher = make_switcher(:branch => 'misfeature')
+    silence_stream($stdout) do
+      switcher.create_empty_database
+    end
+    switcher.verify(
+      [:create_database, 'misfeature']
+    )
+  end
+
+  def test_create_empty_database_existing
+    switcher = make_switcher
+    silence_stream($stderr) do
+      switcher.create_empty_database
+    end
+    switcher.verify
+  end
+
+  def test_create_empty_database_existing_overwrite
+    switcher = make_switcher(:overwrite => true)
+    silence_stream($stdout) do
+      switcher.create_empty_database
+    end
+    switcher.verify(
+      [:drop_database, 'feature'],
+      [:create_database, 'feature']
+    )
+  end
+
+  def test_copy_database
+    switcher = make_switcher(:branch => 'misfeature')
+    silence_stream($stdout) do
+      switcher.copy_from('feature')
+    end
+    switcher.verify(
+      [:create_database, "misfeature"],
+      [:dump_branch_db, "feature"],
+      [:load_branch_db, "misfeature", "the-dump-file"]
+    )
   end
 end

data/test/test_sqlite_switcher.rb

@@ -1,9 +1,82 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
 
-require 'branch_db/switcher'
+require 'test_helper'
+require 'mocks'
 
 class TestSqliteSwitcher < Test::Unit::TestCase
+  def setup
+    create_mock_sqlite_db(
+      'db/development.sqlite3', 
+      'db/development_feature.sqlite3',
+      'db/test.sqlite3'
+    )
+    @config = {
+      'development' => {
+        'database' => 'db/development.sqlite3',
+        'adapter' => 'sqlite3',
+        'per_branch' => true
+      },
+      'test' => {
+        'database' => 'db/test.sqlite3',
+        'adapter' => 'sqlite3'
+      }
+    }
+  end
+
+  def teardown
+    FileUtils.rm_rf(RAILS_ROOT)
+  end
+
+  def make_switcher(options = {})
+    env = options.delete(:env) || 'development'
+    branch = options.delete(:branch) || 'feature'
+    BranchDb::SqliteSwitcher.new(env, @config[env], branch, options)
+  end
   
-  def test_dummy
+  def test_branches
+    assert_stdout "development: Has branch databases. Cannot determine which ones.\n" do
+      BranchDb::Switcher.branches('development', @config['development'])
+    end
+    assert_stdout "" do
+      BranchDb::Switcher.branches('development', @config['test'])
+    end
+  end
+
+  def test_create_empty_database_non_existing
+    switcher = make_switcher(:branch => 'misfeature')
+    silence_stream($stdout) do
+      switcher.create_empty_database
+    end
+    switcher.verify(
+      [:create_database, 'misfeature']
+    )
+  end
+
+  def test_create_empty_database_existing
+    switcher = make_switcher
+    silence_stream($stderr) do
+      switcher.create_empty_database
+    end
+    switcher.verify
+  end
+
+  def test_create_empty_database_existing_overwrite
+    switcher = make_switcher(:overwrite => true)
+    assert_stdout(/^Dropping/) do
+      switcher.create_empty_database
+    end
+    switcher.verify(
+      [:create_database, 'feature']
+    )
+  end
+
+  def test_copy_database
+    switcher = make_switcher(:branch => 'misfeature')
+    silence_stream($stdout) do
+      switcher.copy_from('feature')
+    end
+    switcher.verify(
+      [:create_database, "misfeature"]
+    )
+    assert_sqlite_db_exist('db/development_misfeature.sqlite3')
   end
 end

data/test/test_switcher.rb

@@ -1,6 +1,5 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
 
-require 'branch_db/switcher'
+require 'test_helper'
 
 class TestSwitcher < Test::Unit::TestCase
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mschuerig-branch_db
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Michael Schuerig
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-08 00:00:00 -07:00
+date: 2009-04-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,7 @@ files:
 - Manifest.txt
 - README.rdoc
 - Rakefile
+- branch_db.gemspec
 - lib/branch_db.rb
 - lib/branch_db/configuration_twiddler.rb
 - lib/branch_db/postgresql_switcher.rb
@@ -67,7 +68,6 @@ files:
 - lib/branch_db/task_helper.rb
 - lib/tasks/db_branches.rb
 - test/mocks.rb
-- test/test_branch_db.rb
 - test/test_configuration_twiddler.rb
 - test/test_helper.rb
 - test/test_postgresql_switcher.rb
@@ -105,5 +105,4 @@ test_files:
 - test/test_helper.rb
 - test/test_configuration_twiddler.rb
 - test/test_postgresql_switcher.rb
-- test/test_branch_db.rb
 - test/test_switcher.rb

data/test/test_branch_db.rb

@@ -1,13 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-require 'branch_db'
-
-class TestBranchDb < Test::Unit::TestCase
-
-  def setup
-  end
-  
-  def test_truth
-    assert true
-  end
-end