database_fork 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2481e3d19c6e65d915b9d101e2f278f6142ca4d
+  data.tar.gz: bc6f79626eeb8d59ddff470d97bcdb77e3e788bd
+SHA512:
+  metadata.gz: 9cd6ba6d808ec148e4e8ad151c590cb4d2b283c85e35df54d13e3184c3c646eaf512d005cec453fd0a79fa2679157c22355428759080fbc0aefdf9842312fdce
+  data.tar.gz: f1115ca6776bc93c8fb322e318cd8daa20a72612e6e4a65f6de85c64cfaab95e3d9199d96172bfa451e9eb018fbb8c2d079f6ee4829572b0f4af6e9fbc373df1

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+pkg

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in database_fork.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 the-architect
+
+MIT License
+
+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,29 @@
+# DatabaseFork
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'database_fork'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install database_fork
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/database_fork/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/database_fork.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "database_fork"
+  spec.version       = '0.0.1'
+  spec.authors       = ["the-architect"]
+  spec.email         = ["marcel.scherf@epicteams.com"]
+  spec.summary       = %q{Fork your database}
+  spec.description   = %q{Fork your database}
+  spec.homepage      = "http://github.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/database_fork.rb

@@ -0,0 +1,173 @@
+require 'yaml'
+require 'erb'
+require 'logger'
+
+class DatabaseFork
+
+  class << self
+    #  call this at the end of your application.rb file
+    def setup_env(env, root_dir)
+      db_fork_var = "DATABASE_FORK_#{env}".upcase
+      db_fork_file = File.join(root_dir, 'tmp', db_fork_var)
+      if File.exists?(db_fork_file)
+        ENV[db_fork_var] = open(db_fork_file).read.strip
+      end
+    end
+  end
+
+  # use DatabaseFork.new.run in your post-checkout hook
+  def initialize(config_file = '.db_forks.yml', logger = Logger.new(STDOUT))
+    @config_file = config_file
+    @logger = logger
+  end
+
+  def run
+    if config['ignore'].include?(current_branch)
+      log_info 'This branch name is ignored in .db_fork.yml config. Skipping along.'
+      reset_env
+    elsif Regexp.new(config['check_branch_name_regex']).match(current_branch)
+      log_info 'branch qualified for database forking'
+
+      if fork_exists?
+        log_info 'database fork already exists'
+        export_env
+      else
+        log_info "Create a database fork '#{fork_db_name}'? [y|n|enter=ignore]"
+
+        # trick to read user input:
+        decision = IO.new(IO.sysopen('/dev/tty'), 'r').gets.chomp
+
+        case decision
+          when 'y'
+            create_database_fork!
+            export_env
+          when 'n'
+            # do nothing
+            reset_env
+          else
+            config['ignore'] << current_branch
+            reset_env
+        end
+      end
+    else
+      log_info 'not a feature branch. not creating database fork.'
+      reset_env
+    end
+
+    save_config
+  end
+
+  def create_database_fork!
+    config['environments'].each do |env|
+      log_info "creating database fork '#{fork_db_name(env)}' from #{source_db(env)}"
+
+      create_dump(env)
+      create_database(env)
+      import_dump(env)
+      delete_dump_file(env)
+    end
+  end
+
+  def create_dump(env = 'development')
+    run_command %Q{mysqldump #{connection_params(env)} --routines --triggers -C #{source_db(env)} > #{dump_file_path(env)}}, "dumping #{source_db(env)}"
+  end
+
+  def create_database(env = 'development')
+    run_command %Q{mysql #{connection_params(env)} -e "CREATE DATABASE IF NOT EXISTS #{fork_db_name(env)} CHARACTER SET '#{character_set}' COLLATE '#{collation}';"}, "create database #{fork_db_name(env)}"
+  end
+
+  def import_dump(env = 'development')
+    run_command %Q{mysql #{connection_params(env)} -C -A -D#{fork_db_name(env)} < #{dump_file_path(env)}}, 'importing dump'
+  end
+
+  def delete_dump_file(env = 'development')
+    run_command "rm #{dump_file_path(env)}", 'cleanup'
+  end
+
+  def reset_env
+    run_command "rm ./tmp/DATABASE_FORK_DEVELOPMENT", 'rm DATABASE_FORK_DEVELOPMENT'
+    run_command "rm ./tmp/DATABASE_FORK_TEST", 'rm DATABASE_FORK_TEST'
+  end
+
+  def export_env
+    run_command "echo #{fork_db_name('development')} > ./tmp/DATABASE_FORK_DEVELOPMENT", 'setting DATABASE_FORK_DEVELOPMENT'
+    run_command "echo #{fork_db_name('test')} > ./tmp/DATABASE_FORK_TEST", 'setting DATABASE_FORK_TEST'
+  end
+
+  def run_command(command, message)
+    log_info message
+    log_debug command
+    `#{command}`
+  end
+
+  def dump_file_path(env = 'development')
+    "./tmp/dump_#{env}.sql"
+  end
+
+  # could be queried from source_db:
+  def character_set
+    config['character_set'] || 'utf8'
+  end
+
+  # could be queried from source_db:
+  def collation
+    config['collation'] || 'utf8_unicode_ci'
+  end
+
+  def log_info(message)
+    @logger.info message
+  end
+
+  def log_debug(message)
+    @logger.debug message
+  end
+
+  def fork_exists?(env = 'development')
+    command = %Q{mysql #{connection_params[env]} -s -N -e "SHOW DATABASES LIKE '#{fork_db_name(env)}';" }
+    !`#{command}`.empty?
+  end
+
+  # simplify
+  # make framework agnostic
+  def connection_params(env = 'development')
+    @connection_params ||= if ENV['USER'] == 'vagrant'
+      %Q{--user=#{app_connection[env]['username']} --password=#{app_connection[env]['password']} --socket=#{app_connection[env]['socket']}}
+    else
+      %Q{--user=#{app_connection[env]['username']} --password=#{app_connection[env]['password']} --host=#{app_connection[env]['host']} --port=#{app_connection[env]['port']}}
+    end
+  end
+
+  def fork_db_name(env = 'development')
+    "#{source_db(env)}_#{current_branch}".strip
+  end
+
+  def source_db(env= 'development')
+    app_connection[env]['database']
+  end
+
+  def app_connection
+    @app_connection ||= YAML.load(ERB.new(open(File.join(File.dirname(__FILE__), '..', '..', 'config', 'database.yml')).read).result)
+  end
+
+  def current_branch
+    @current_branch ||= `git rev-parse --abbrev-ref HEAD`.strip.gsub('/', '_')
+  end
+
+  def config
+    @config ||= begin
+      config = {
+        'check_branch_name_regex' => '^feature_',
+        'ignore' => [],
+        'environments' => %w(development test)
+      }
+      config.merge! YAML.load(open(@config_file).read) if File.exists?(@config_file)
+      config
+    end
+  end
+
+  def save_config
+    File.open(@config_file, 'w') do |f|
+      f.puts @config.to_yaml
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: database_fork
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- the-architect
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fork your database
+email:
+- marcel.scherf@epicteams.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- database_fork.gemspec
+- lib/database_fork.rb
+homepage: http://github.com/
+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: Fork your database
+test_files: []