branchy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ff46d1f1add7c02a6bebbc34de50a0267f38ec2
+  data.tar.gz: f4eecfe2d89b233ef3ae4b0c24be87a537a8481d
+SHA512:
+  metadata.gz: 68175dc477d0d59430451b16ace6c6e4a7fc903b205e98c41e464ebf2bd6137dc1ad471008ef7cbc6356da6d38279d9d284e688f56a4762434933cf83f417a73
+  data.tar.gz: 76f027339cd2e7119d2e7b13a2636953ab20cd6f4012f294cb22cbf986afdfb6cdb56ce5ebb46ef0c304692e02be4c340687bdb4c2b05c980c5b2ca6193a2e94

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Consolo Services
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.rdoc

@@ -0,0 +1,65 @@
+== Branchy
+
+Branchy is a library for getting the name of the branch you're on. Lame, right? But its real purpose is to make it very easy to use
+the branched database pattern in Ruby, where each branch in your project has its own database. Rails was the original use-case, but
+there's nothing Rails-specific in it - you should be able to use it with just about any Ruby ORM. That said, all examples assume
+Rails and ActiveRecord. Salt to taste.
+
+Supported SCMs:
+* git
+
+== The Branched Database Pattern
+
+Do you use feature branches for development? Are you in migration hell, fighting merge conflicts in schema.rb and running into exceptions 
+caused by database changes from other branches? The branched database pattern might be what you're looking for. Each branch has its 
+own database, isolating it from any other branch's changes.
+
+NOTE Branched databases work best when everyone on your team uses them and practices good database migration habits. A more complete
+write-up on that subject can be found at http://jordanhollinger.com/2014/07/30/rails-migration-etiquette/. These are the highlights:
+* Use schema.rb to create your database (rake db:schema:load or rake db:setup).
+* After running migrations locally, commit the resulting changes in schema.rb.
+* Use branched databases to keep each branch's schema changes isolated.
+* Remember to restart your local Rails server after switching branches.
+
+== Installation
+In your Gemfile:
+
+  group :development, :test do
+    gem 'branchy', git: 'git://github.com/consolo/branchy.git'
+  end
+
+== Use in database.yml
+You probably only want to use it in your development and test environments.
+For a branch called "widgets" the database would be "foobar_development_widgets".
+
+  development:
+    database: <%= Branchy.git.db 'foobar_development' %>
+    ...
+
+== A database for EVERY branch? Overkill much?
+Maybe. If you have lots branches without schema changes, you might want to enable branchy on a per-branch basis. There's a command-line
+utility for this:
+
+  $ git checkout my_branch
+  $ branchy --enable
+
+Then in your database.yml file use the "db_if_enabled" method. It the current branch isn't branchy-enabled it will simply return
+whatever string your passed.
+
+  development:
+    database: <%= Branchy.git.db_if_enabled 'foobar_development' %>
+    ...
+
+== You don't even NEED this library
+It's really just a convenient way to share the idea. You can get 90% of the functionality in database.yml with:
+
+    <% branch = `git rev-parse --abbrev-ref HEAD`.chomp %>
+
+    development:
+      database: my_project_development_<%= branch %>
+      ...
+
+== License
+Copyright 2014 Consolo Services Group
+
+Licensed under the MIT License

data/bin/branchy

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'branchy'
+
+options = {}
+o = OptionParser.new do |opts|
+  opts.banner = 'Usage: branchy [options]'
+  opts.on('--enable', 'Enable a branched database for the current branch') { options[:command] = 'enable' }
+  opts.on('--disable', 'Disable a branched database for the current branch') { options[:command] = 'disable' }
+  opts.on('--scm SCM', 'Set the SCM (defaults to git). Supported SCMs: git') { |scm| options[:scm] = scm.downcase.strip }
+end
+o.parse!
+
+options[:scm] ||= 'git'
+branch = Branchy.respond_to?(options[:scm]) ? Branchy.send(options[:scm]) : nil
+unless branch.is_a? Branchy::Branch
+  $stderr.puts "Unknown scm '#{options[:scm]}'"
+  exit 1
+end
+
+begin
+  case options[:command]
+    when 'enable'
+      puts "Enabling branched database"
+      branch.enable!
+    when 'disable'
+      puts "Disabling branched database"
+      branch.disable!
+    else
+      puts o.help
+      exit 1
+  end
+rescue Branchy::CommandFailed => e
+  $stderr.puts e.message
+  exit 1
+end

data/lib/branchy/branch.rb

@@ -0,0 +1,73 @@
+##
+# A library for interacting with branched database. I.E. each of your feature branches may
+# have its own database to keep schema changes seperated until each is merged into the 
+# mainline.
+#
+# Supported SCMs:
+# - git
+#
+# Example:
+#  -> Branchy.git.db('my_project_development')
+#  -> "my_project_development_branch_name"
+#
+# Example with optional branching enabled:
+#  -> Branchy.git.db_if_enabled('my_project_development')
+#  -> "my_project_development_branch_name"
+#
+# Example with optional branching disabled:
+#  -> Branchy.git.db_if_enabled('my_project_development')
+#  -> "my_project_development"
+#
+# To enable or disable branched databases in a branch, check out your branch and run:
+#  $ branchy --enable|--disable
+#
+module Branchy
+  # Returns a new Branchy object initialized for use with git
+  def self.git
+    Branch.new(Drivers::Git)
+  end
+
+  # A class for getting a branch's database name
+  class Branch
+    # The SCM driver
+    attr_reader :scm
+
+    # Initializes a new Branchy with the specified SCM driver
+    def initialize(driver)
+      @scm = driver
+    end
+
+    # Returns the name of the current branch
+    def name
+      scm.branch
+    end
+
+    # Returns prefix + branch name (e.g. "my_project_development_my_branch"), replacing any db name
+    # unfriendly characthers with _.
+    # If it's the master/trunk/mainline branch only the prefix is returned.
+    def database(prefix)
+      db_name = scm.trunk? ? prefix : "#{prefix}_#{name}"
+      db_name.gsub(/[^A-Za-z0-9_]+/, '_')
+    end
+
+    alias_method :db, :database
+
+    # Returns the prefix + branch name, but *only* if branched db has been enabled for this branch.
+    # Otherwise it just returns the prefix.
+    def database_if_enabled(prefix)
+      scm.enabled? ? database(prefix) : prefix
+    end
+
+    alias_method :db_if_enabled, :database_if_enabled
+
+    # Enable a branched database for this branch
+    def enable!
+      scm.enable!
+    end
+
+    # Disable a branched database for this branch
+    def disable!
+      scm.disable!
+    end
+  end
+end

data/lib/branchy/cli.rb

@@ -0,0 +1,28 @@
+require 'open3'
+
+module Branchy
+  # Exception for failed CLI commands
+  CommandFailed = Class.new(RuntimeError)
+
+  # Shared command line functionality
+  module CLI
+    protected
+
+    # If command is successful, returns stdout. Otherwise raises a CommandFailed exception.
+    def exec_or_raise(command, success_codes = [0])
+      stdout, stderr, process_status = self.exec(command)
+      if success_codes.include? process_status.exitstatus
+        return stdout.gets.to_s.chomp
+      else
+        raise CommandFailed, "Command `#{command}` failed with status #{process_status.exitstatus}\n#{stderr.gets.to_s.chomp}"
+      end
+    end
+
+    # Execute the command and return stdout, stderr, and process_status
+    def exec(command)
+      stdin, stdout, stderr, wait_thread = Open3.popen3(command)
+      process_status = wait_thread.value
+      return stdout, stderr, process_status
+    end
+  end
+end

data/lib/branchy/drivers/git.rb

@@ -0,0 +1,34 @@
+module Branchy
+  # Drivers for SCMs
+  module Drivers
+    # A Branchy driver for git
+    class Git
+      extend ::Branchy::CLI
+
+      # Returns the git branch name
+      def self.branch
+        exec_or_raise('git symbolic-ref HEAD').sub('refs/heads/', '')
+      end
+
+      # Returns true if it's the master/trunk/mainline branch.
+      def self.trunk?
+        branch == 'master'
+      end
+
+      # Returns true if this git branch has been configured with a branched database
+      def self.enabled?
+        exec_or_raise("git config --bool branch.#{branch}.database", [0,1]) == 'true'
+      end
+
+      # Enables a database for this git branch
+      def self.enable!
+        exec_or_raise("git config --bool branch.#{branch}.database true")
+      end
+
+      # Disables a database for this git branch
+      def self.disable!
+        exec_or_raise("git config --bool branch.#{branch}.database false")
+      end
+    end
+  end
+end

data/lib/branchy/version.rb

@@ -0,0 +1,4 @@
+module Branchy
+  # The gem version
+  VERSION = '0.0.1'.freeze
+end

data/lib/branchy.rb

@@ -0,0 +1,4 @@
+require 'branchy/cli'
+require 'branchy/branch'
+require 'branchy/drivers/git'
+require 'branchy/version'

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: branchy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jordan Hollinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-07 00:00:00.000000000 Z
+dependencies: []
+description: Use a different database for each of your branches!
+email: jordan@jordanhollinger.com
+executables:
+- branchy
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.rdoc
+- bin/branchy
+- lib/branchy.rb
+- lib/branchy/branch.rb
+- lib/branchy/cli.rb
+- lib/branchy/drivers/git.rb
+- lib/branchy/version.rb
+homepage: http://github.com/consolo/branchy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Branched database helpers
+test_files: []