branchbot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fa6c1ef194f2f10f54ac1a874d0ef1971e585f2ff9b2c8aefe958178fca3d54
+  data.tar.gz: fbfc9ffc56df62c39152ece3a5ca4ba28334bf857e9b42fdb4c19c65c08a6707
+SHA512:
+  metadata.gz: 2e3b4baf23cd8108b3d096a91d946c9e0b8f175374b83103024514416ce0cb255e3e2b991ce82d6a2fb5112efe972c9891225e6294dcf7ee3f2a61f1308fc5e5
+  data.tar.gz: 263700bdbfa46eba2d124a21df567946bfed5209676ac1c45fa6d2612bb61782e44a76413e92ebce61446da03837e6352870f8716eea3058e8a10a41ee036ed1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in branchbot.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    branchbot (0.1.0)
+      commander (~> 4.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    commander (4.6.0)
+      highline (~> 2.0.0)
+    highline (2.0.3)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-18
+
+DEPENDENCIES
+  branchbot!
+
+BUNDLED WITH
+   2.2.19

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Room 118 Solutions Inc.
+
+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.md

@@ -0,0 +1,39 @@
+branchbot
+==============================
+
+Save and restore the state of your Rails development and test databases as you work on different branches.
+
+This allows you to make some changes to the structure of your database on a feature branch, then be able to quickly switch back to your master branch to make a hotfix or start a new feature branch with your original database structure and content.
+
+# Installation
+
+1. Install the gem:
+   
+    `gem install branchbot`
+
+2. Download the `post-checkout` file into the `.git/hooks` directory of your project.
+   Modify to configure any flags.
+   
+   Note: Be sure to keep the `post-checkout` name to match Git's expectations.
+
+# Support
+
+Only PostgreSQL and MySQL databases are currently supported.
+
+# Non-Rails Usage
+
+While this hook is geared towards Rails and depends on Ruby, it is very easy to use it in non-Ruby/Rails projects, so long as you have Ruby installed on your system.
+
+This script will look for a `database.yml` config file (default: `config/database.yml` in your project's root directory), and expects it to look like this:
+
+```yaml
+development:
+  adapter: <adapter>
+  username: <database username>
+  password: <database password>
+  database: <database name>
+```
+
+The path to this file is configurable via the `--db-config-path` option.
+
+We currently support two adapters: `mysql2` and `postgresql`. We don't actually rely on these gems, but instead use them to determine which database's command line tools we should use (mysqldump/mysql or pg_dump/psql). Use `mysql2` if you are using a MySQL database, or `postgresql` if you are using a PostgreSQL database.

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "branchbot"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/branchbot.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/branchbot/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "branchbot"
+  spec.version       = Branchbot::VERSION
+  spec.authors       = ["Jim Ryan"]
+  spec.email         = ["jim@room118solutions.com"]
+  spec.license       = 'MIT'
+  spec.summary       = "Saves and restores the state of your local database as you work on different git branches."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/room118solutions/branchbot"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/room118solutions/git-rails-database-branch-hook"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = ['branchbot']
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_runtime_dependency "commander", '~> 4.6.0'
+  
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/exe/branchbot

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "commander/import"
+require "branchbot"
+
+program :name, 'branchbot'
+program :version, Branchbot::VERSION
+program :description, "Saves and restores the state of your local database as you work on different git branches."
+
+command :switch do |cmd|
+  cmd.syntax = "branchbot switch [options]"
+  cmd.option '--from FROM_REF', String, 'ref switching from'
+  cmd.option '--db-config-path path/to/database.yml', String, 'path to database.yml relative to project root (default: config/database.yml)'
+
+  cmd.action do |args, options|
+    unless options.from
+      say "--from required"
+      next
+    end
+
+    options.default db_config_path: 'config/database.yml'
+
+    Branchbot::BranchSwitcher.new(
+      database_yml_path: options.db_config_path
+    ).switch_from(options.from)
+  end
+end

data/lib/branchbot.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "branchbot/version"
+require_relative "branchbot/adapters/abstract"
+require_relative "branchbot/adapters/unsupported_database"
+require_relative "branchbot/adapters/mysql"
+require_relative "branchbot/adapters/postgresql"
+require_relative "branchbot/branch_switcher"
+
+require 'yaml'
+require 'erb'
+require 'fileutils'
+
+module Branchbot
+
+end

data/lib/branchbot/adapters/abstract.rb

@@ -0,0 +1,74 @@
+module Branchbot
+  module Adapters
+    class Abstract
+
+      def self.build(config, dump_folder)
+        klass = case config['adapter']
+        when 'postgresql'
+          PostgreSQL
+        when 'mysql2'
+          MySQL
+        else
+          raise UnsupportedDatabase.new(config['adapter'])
+        end
+
+        klass.new(config, dump_folder)
+      end
+
+      def initialize(config, dump_folder)
+        @config = config
+        @database_name = config['database']
+
+        @dump_folder = dump_folder
+      end
+
+      def dump(branch_name)
+        print "Saving state of database on '#{branch_name}' branch..."
+
+        if system(dump_cmd(branch_name))
+          print "done!\n"
+          true
+        else
+          print "failed!\n"
+          false
+        end
+      end
+
+      def dump_exists?(branch_name)
+        File.exists?(dump_file(branch_name))
+      end
+
+      def restore(branch_name)
+        print "Restoring #{database_name} to its previous state on this branch..."
+
+        if system(restore_cmd(branch_name))
+          print "done!\n"
+          true
+        else
+          print "failed!\n"
+          false
+        end
+      end
+
+      private
+
+        attr_reader :dump_folder, :database_name
+
+        def dump_cmd(branch_name)
+          raise NotImplementedError
+        end
+
+        def restore_cmd(branch_name)
+          raise NotImplementedError
+        end
+
+        def dump_file(branch_name)
+          # Replace any special characters that may cause file system issues
+          branch_name = branch_name.gsub(/[^0-9a-z.\-_]/i, '_')
+
+          "#{dump_folder}/#{database_name}-#{branch_name}"
+        end
+
+    end
+  end
+end

data/lib/branchbot/adapters/mysql.rb

@@ -0,0 +1,26 @@
+module Branchbot
+  module Adapters
+    class MySQL < Abstract
+
+      def initialize(*)
+        super
+
+        @username = @config['username']
+        @password = @config['password']
+      end
+
+      private
+
+        attr_reader :username, :password
+
+        def dump_cmd(branch_name)
+          %[mysqldump --add-drop-database --user=#{username} --password="#{password}" --databases #{database_name} > "#{dump_file(branch_name)}"]
+        end
+
+        def restore_cmd(branch_name)
+          %[mysql -u #{username} --password="#{password}" #{database_name} < "#{dump_file(branch_name)}"]
+        end
+
+    end
+  end
+end

data/lib/branchbot/adapters/postgresql.rb

@@ -0,0 +1,47 @@
+module Branchbot
+  module Adapters
+    class PostgreSQL < Abstract
+
+      private
+
+        def dump_cmd(branch_name)
+          # Delete legacy SQL dump, or previous directory-format archive since folder cannot already exist
+          if File.exist?(dump_file(branch_name))
+            FileUtils.rm_r dump_file(branch_name)
+          end
+
+          %[pg_dump --file="#{dump_file(branch_name)}" --format=directory --jobs=#{number_of_jobs} #{database_name}]
+        end
+
+        def restore_cmd(branch_name)
+          # Drop existing connections
+          system(%[psql --command="SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = '#{database_name}' AND pid <> pg_backend_pid();" postgres > /dev/null])
+
+          # Drop database
+          system(%[dropdb #{database_name}])
+
+          # Create database
+          system(%[createdb #{database_name}])
+
+          if File.directory?(dump_file(branch_name))
+            # Restore directory-format archive
+            %[pg_restore --dbname=#{database_name} --jobs=#{number_of_jobs} "#{dump_file(branch_name)}"]
+          else
+            # Restore legacy SQL dump
+            %[psql --file="#{dump_file(branch_name)}" #{database_name} > /dev/null]
+          end
+        end
+
+        def number_of_jobs
+          require 'etc'
+
+          if Etc.respond_to?(:nprocessors) # Available in 2.2.3+
+            Etc.nprocessors
+          else
+            1
+          end
+        end
+
+    end
+  end
+end

data/lib/branchbot/adapters/unsupported_database.rb

@@ -0,0 +1,17 @@
+module Branchbot
+  module Adapters
+    class UnsupportedDatabase < RuntimeError
+
+      attr_reader :adapter
+
+      def initialize(adapter)
+        @adapter = adapter
+      end
+
+      def message
+        "Adapter `#{adapter}` is not supported."
+      end
+
+    end
+  end
+end

data/lib/branchbot/branch_switcher.rb

@@ -0,0 +1,80 @@
+module Branchbot
+  class BranchSwitcher
+    def initialize(database_yml_path: 'config/database.yml')
+      @database_yml_path = database_yml_path
+    end
+
+    def switch_from(prev_ref)
+      # Get the current (destination) branch
+      @destination_branch = `git rev-parse --abbrev-ref HEAD`.strip
+
+      # Since we're just given a commit ID referencing the branch head we're coming from,
+      # it could be at the head of multiple branches. We can assume the source isn't the same as the
+      # destination branch, so we can remove that immediately.
+      @source_branches = branches_from_refhead(prev_ref).reject{ |b| b == @destination_branch }
+
+      @project_root = %x[git rev-parse --show-toplevel].strip
+      @dump_folder = "#{@project_root}/.db_branch_dumps"
+
+      # Load Rails DB config and grab database name
+      @rails_db_config = YAML.load(ERB.new(File.read(File.join @project_root, @database_yml_path)).result)
+      dev_database_name = @rails_db_config['development']['database']
+
+      begin
+        @adapter = Adapters::Abstract.build(@rails_db_config['development'], @dump_folder)
+      rescue Adapters::UnsupportedDatabase => e
+        puts "\nERROR: #{e.message}"
+        exit
+      end
+
+      # Ensure dump directory exists
+      unless Dir.exists?(@dump_folder)
+        Dir.mkdir @dump_folder
+      end
+
+      # Don't do anything if the source and destination branches are the same or nonexistent
+      unless @source_branches.include?(@destination_branch) || @source_branches.empty? || (@source_branches | [@destination_branch]).any?{ |b| b == '' }
+        # Dump database for source branches
+        if @source_branches.all? { |branch| @adapter.dump(branch) }
+          # Restore dump from this branch, if it exists
+          if @adapter.dump_exists?(@destination_branch)
+            if @adapter.restore(@destination_branch)
+              prepare_test_database
+            end
+          else
+            print "No DB dump for #{dev_database_name} on the '#{@destination_branch}' branch was found!\n"
+            print "The state of your database has been saved for when you return to the '#{@source_branches.join('\' or \'')}' branch, but its current state has been left unchanged.  You are now free to make changes to it that are specific to this branch, and they will be saved when you checkout a different branch, then restored when you checkout this one again.\n"
+          end
+        else
+          print "Failed to dump database. Halting.\n"
+        end
+      end
+    end
+
+    private
+
+      def branches_from_refhead(ref)
+        `git show-ref --heads | grep #{ref} | awk '{print $2}'`.split("\n").map{ |b| b.sub(/^refs\/heads\//, '') }
+      end
+
+      def prepare_test_database
+        if File.exists?("#{@project_root}/Rakefile")
+          print "Preparing test database..."
+
+          rake_cmd = "rake db:test:prepare"
+
+          if File.exists?("#{@project_root}/bin/rake")
+            rake_cmd = "./bin/#{rake_cmd}"
+          elsif File.exists?("#{@project_root}/Gemfile")
+            rake_cmd = "bundle exec #{rake_cmd}"
+          end
+
+          system rake_cmd
+
+          print "done!\n"
+        else
+          print "No Rakefile detected, skipping test database restoration\n"
+        end
+      end
+    end
+end

data/lib/branchbot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Branchbot
+  VERSION = "0.1.0"
+end

data/post-checkout

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+if [ "$3" = "1" ]
+then
+  branchbot switch --from=$1
+fi

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: branchbot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Ryan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+description: Saves and restores the state of your local database as you work on different
+  git branches.
+email:
+- jim@room118solutions.com
+executables:
+- branchbot
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- branchbot.gemspec
+- exe/branchbot
+- lib/branchbot.rb
+- lib/branchbot/adapters/abstract.rb
+- lib/branchbot/adapters/mysql.rb
+- lib/branchbot/adapters/postgresql.rb
+- lib/branchbot/adapters/unsupported_database.rb
+- lib/branchbot/branch_switcher.rb
+- lib/branchbot/version.rb
+- post-checkout
+homepage: https://github.com/room118solutions/branchbot
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/room118solutions/branchbot
+  source_code_uri: https://github.com/room118solutions/git-rails-database-branch-hook
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Saves and restores the state of your local database as you work on different
+  git branches.
+test_files: []