flipp 0.0.1

data/README.md

@@ -0,0 +1,17 @@
+# flipp
+
+To alleviate issues around highly divergent development databases on feature/refactor branches, flipp helps switch databases upon new branch checkouts.
+
+# Database Support
+
+Current support is for MySQL only.
+
+# Installation & Usage
+
+1. Add `gem 'flipp'` to your Gemfile or do `gem install flipp`.
+2. Run `rake flipp:install` from your project's root directory to install the git hook
+3. Normal git workflow, ie. switch branches normally
+
+# License
+
+flipp is released under the MIT license

data/Rakefile

@@ -0,0 +1,2 @@
+$:.unshift File.expand_path('..', __FILE__)
+require 'tasks/flipp'

data/flipp.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'bundler'
+
+Gem::Specification.new do |s|
+  s.name        = "flipp"
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mike Pack"]
+  s.email       = ["mikepackdev@gmail.com"]
+  s.homepage    = "http://www.mikepackdev.com"
+  s.summary     = %q{Switch development databases upon branch checkouts.}
+  s.description = %q{To alleviate issues around highly divergent development databases on feature/refactor branches, flipp helps switch databases upon new branch checkouts.}
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_runtime_dependency 'active_record'
+  s.add_runtime_dependency 'database_exporter'
+
+  s.files = %w( README.md Rakefile flipp.gemspec tasks/flipp.rb ) + Dir["lib/**/*.rb"]
+  s.test_files = Dir["spec/**/*.rb"]
+  s.require_paths = ["lib"]
+end

data/lib/flipp.rb

@@ -0,0 +1,2 @@
+require 'flipp/flipp'
+require 'flipp/railties/reestablish_connection' if defined?(Rails)

data/lib/flipp/flipp.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'active_record'
+require 'database_exporter'
+require File.join(File.dirname(__FILE__), '../helpers/git_helper')
+
+# The Flipp class orchestrates the actual switching of databaseses
+class Flipp
+  def initialize(branch = GitHelper.current_branch)
+    @branch = branch
+  end
+
+  def switch_databases
+    current_config = ActiveRecord::Base.connection_pool.spec.config  
+    new_config = current_config.merge!({:database => new_database_name(current_config)})
+
+    puts "Switching databases (#{new_config[:database]})..."
+
+    # Try connecting to the new database
+    begin
+      ActiveRecord::Base.establish_connection new_config
+    rescue
+      create_new_db_or_fallback current_config, new_config
+    end
+  end
+
+  def create_new_db_or_fallback(current_config, new_config)
+    # Try creating then connecting to the new database
+    begin
+      create_and_copy_data! current_config, new_config
+    rescue => exception
+      # Fallback and use the original config
+      puts "Could not use the new database, falling back to your normal development database..."
+      ActiveRecord::Base.establish_connection current_config
+    end
+  end
+
+  def new_database_name(config)
+    # The new name for the database
+    # eg. if the original dev database is dev_db and the branch was "new_feature",
+    #     the new database would be db_db_new_feature
+    config[:database] + '_' + @branch
+  end
+
+  def create_and_copy_data!(current_config, new_config)
+    # Copy the current development database's data to the new database
+    puts "Copying data to the new database (this could take a minute but will only run once)..."
+    copy_data current_config, new_config
+
+    # Try out the new database
+    ActiveRecord::Base.establish_connection new_config
+  end
+
+  def copy_data(current_config, new_config)
+    DatabaseExporter.new(current_config).copy(new_config)
+  end
+end

data/lib/flipp/railties/reestablish_connection.rb

@@ -0,0 +1,11 @@
+require 'flipp'
+
+class ReestablishConnection < Rails::Railtie
+  initializer "restablish_connection.configure_rails_initialization" do
+    if Rails.env.development? and GitHelper.hook_installed?
+      # Use the connection determined by flipp
+      flipp = Flipp.new
+      flipp.switch_databases
+    end
+  end
+end

data/lib/helpers/git_helper.rb

@@ -0,0 +1,33 @@
+require 'fileutils'
+
+module GitHelper
+  def self.hook_installed?
+    File.exists? '.git/hooks/post-checkout'
+  end
+
+  def self.install_hook
+    # Check for the .git directory
+    if File.directory? '.git'
+      unless File.directory? '.git/hooks'
+        # Create hooks directory
+      end
+
+      # Copy the file to the git hooks
+      puts 'Moving git hook into place...'
+      FileUtils.cp 'lib/git_hooks/post-checkout', File.expand_path('.git/hooks/post-checkout')
+      # And give it execute permissions
+      FileUtils.chmod 0755, '.git/hooks/post-checkout'
+    else
+      puts "Can't find your .git directory. Are you at the root of your project?"
+    end
+  end
+
+  def self.uninstall_hook
+    puts 'Removing git hook...'
+    FileUtils.rm File.expand_path('.git/hooks/post-checkout')
+  end
+
+  def self.current_branch
+    `git branch --no-color 2> /dev/null | sed -e '/^[^*]/d' -e 's/* /\1/'`.chomp[1..-1] # Remove control character
+  end
+end

data/spec/lib/flipp/flipp_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Flipp do
+  let(:flipp) { Flipp.new('new_feature_branch') }
+  let(:old_db) { {:adapter => 'mysql2', :host => 'localhost', :username => 'root', :database => 'old_db'} }
+  let(:new_db) { {:adapter => 'mysql2', :host => 'localhost', :username => 'root', :database => 'new_db'} }
+
+  describe '#switch_databases' do
+    before do
+      # Stub the current connection
+      ActiveRecord::Base.stub_chain(:connection_pool, :spec, :config).and_return({:adapter => 'mysql2', :host => 'localhost', :username => 'root', :database => 'old_db'})
+    end
+
+    it 'tries to connect to the new database' do
+      ActiveRecord::Base.should_receive(:establish_connection).with(an_instance_of(Hash))
+      flipp.switch_databases
+    end
+
+    it 'tries to create and copy data to new database, then connect' do
+      ActiveRecord::Base.stub(:establish_connection) { raise }
+      flipp.should_receive(:create_new_db_or_fallback).with(an_instance_of(Hash), an_instance_of(Hash))
+      flipp.switch_databases
+    end
+  end
+
+  describe '#create_new_db_or_fallback' do
+    it 'falls back on the original connection if the new database can not be formed' do
+      flipp.stub(:create_and_copy_data!) { raise }
+      flipp.should_receive(:create_and_copy_data!).with(old_db, new_db)
+      ActiveRecord::Base.should_receive(:establish_connection).with(old_db)
+      flipp.create_new_db_or_fallback(old_db, new_db)
+    end
+  end
+
+  describe '#new_database_name' do
+    it 'constructs a database name consisting of the current dev db and the branch name' do
+      flipp.new_database_name({:database => 'dev_db'}).should == 'dev_db_new_feature_branch'
+    end
+  end
+
+  describe '#create_and_copy_data!' do
+    it 'copies the database' do
+      flipp.should_receive(:copy_data).with(old_db, new_db)
+      flipp.create_and_copy_data!(old_db, new_db)
+    end
+
+    it 'tries to connect to the new database' do
+      ActiveRecord::Base.should_receive(:establish_connection).with(new_db)
+      flipp.create_and_copy_data!(old_db, new_db)
+    end
+  end
+
+  describe '#copy_data' do
+    it 'invokes the database adapter and makes a copy' do
+      # Mock DatabaseExporter so we can access the #copy method
+      mock = double(DatabaseExporter)
+      DatabaseExporter.stub(:new).and_return(mock)
+
+      # Expect it to instantiate and call the #copy method
+      DatabaseExporter.should_receive(:new).with(old_db)
+      mock.should_receive(:copy).with(new_db)
+
+      flipp.copy_data(old_db, new_db)
+    end
+  end
+end

data/spec/lib/helpers/git_helper_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe GitHelper do
+  describe '#hook_installed?' do
+    it 'returns true when the hook exists' do
+      FileUtils.touch '.git/hooks/post-checkout'
+      GitHelper.hook_installed?.should be_true
+    end
+
+    it 'returns false when the hook does not exists' do
+      FileUtils.rm '.git/hooks/post-checkout'
+      GitHelper.hook_installed?.should be_false
+    end
+  end
+
+  describe '#install_hook' do
+    it 'moves the git hook into place' do
+      GitHelper.install_hook
+      FileUtils.compare_file('.git/hooks/post-checkout', File.expand_path('../../../../lib/git_hooks/post-checkout', __FILE__))
+    end
+  end
+
+  describe '#uninstall_hook' do
+    before { GitHelper.install_hook }
+
+    it 'remove the git hook' do
+      GitHelper.uninstall_hook
+      GitHelper.hook_installed?.should be_false
+    end
+  end
+
+  describe '#current_branch' do
+    it 'returns the name of the current git branch' do
+      `git checkout -b new_and_fun_branch`
+      GitHelper.current_branch.should == 'new_and_fun_branch'
+
+      # Cleanup
+      `git checkout master && git branch -d new_and_fun_branch`
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$:.unshift File.expand_path('../..', __FILE__)
+require 'lib/helpers/git_helper'
+require 'lib/flipp/flipp'

data/tasks/flipp.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), '../lib/helpers/git_helper')
+
+namespace :flipp do
+  desc 'Install flipp'
+  task :install do
+    # Move git hook into place
+    GitHelper.install_hook
+  end
+
+  desc 'Uninstall flipp'
+  task :uninstall do
+    # Remove git hook
+    GitHelper.uninstall_hook
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: flipp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Pack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_record
+  requirement: &70345674000980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70345674000980
+- !ruby/object:Gem::Dependency
+  name: database_exporter
+  requirement: &70345673999500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70345673999500
+description: To alleviate issues around highly divergent development databases on
+  feature/refactor branches, flipp helps switch databases upon new branch checkouts.
+email:
+- mikepackdev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- flipp.gemspec
+- tasks/flipp.rb
+- lib/flipp/flipp.rb
+- lib/flipp/railties/reestablish_connection.rb
+- lib/flipp.rb
+- lib/helpers/git_helper.rb
+- spec/lib/flipp/flipp_spec.rb
+- spec/lib/helpers/git_helper_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.mikepackdev.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Switch development databases upon branch checkouts.
+test_files:
+- spec/lib/flipp/flipp_spec.rb
+- spec/lib/helpers/git_helper_spec.rb
+- spec/spec_helper.rb