database_fork 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02395bcab269066b8b7cc5b5a106c3bb27fed5cb
-  data.tar.gz: b5566ba02e4fac55af6050358dc2819f4e47657f
+  metadata.gz: 04574ce63b8ffaee559e658f2dae84d148b7c29e
+  data.tar.gz: db2386f28f81ca972e189c1b9a188dca33f07f08
 SHA512:
-  metadata.gz: 60d8786f2fa1b4e2271bb17018db9f534e0e4363192796a23e10f1648cd1e9bf87230a0412602c3f520dd2c62ab9561766750d32e55e08cc6c3f30a2b589464c
-  data.tar.gz: f75dcd966a0439a43018250b6c36086057f3ec5828f58b478ad6db8cd8731647f0ad46c5b220893ab19707943d0646b7418ee7d6ebe8aa7157b3e79b9dc06cff
+  metadata.gz: f62e70674fd53c2b970e44b6ed59650fd6bf50f59c4518b4e7a1c373cdfaf03a10144549a691bcb96d7d42f1427911100b10aff5ddc9273cb367253aed99dde8
+  data.tar.gz: eae82273430626967731953b465d67a1204a95df624241655e05d431fb145f02d53065109066b89354a0a0e7c255d8770e3db39c029252ae91e25633123afa0f

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+database_fork

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, all_after_pass: true, all_on_start: true, notification: true, sticky: true  do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+

data/Rakefile

@@ -1,2 +1,7 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/database_fork.gemspec

@@ -3,20 +3,23 @@ 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.3'
-  spec.authors       = ["the-architect"]
-  spec.email         = ["marcel.scherf@epicteams.com"]
+  spec.name          = 'database_fork'
+  spec.version       = '0.0.4'
+  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.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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'ruby_gntp'
 end

data/lib/database_fork.rb

@@ -1,8 +1,16 @@
 require 'yaml'
-require 'erb'
 require 'logger'
+require 'fileutils'
+
+require_relative 'database_fork/logging'
+require_relative 'database_fork/commands'
+require_relative 'database_fork/load_database_config'
+require_relative 'database_fork/mysql_connection'
+require_relative 'database_fork/mysql_fork'
 
 class DatabaseFork
+  include Logging
+  include Commands
 
   class << self
     #  call this at the end of your application.rb file
@@ -13,42 +21,50 @@ class DatabaseFork
         ENV[db_fork_var] = open(db_fork_file).read.strip
       end
     end
+
+    def reset_all_environments!(root_dir, logger = Logger.new(STDOUT))
+      logger.info 'removing DATABASE_FORK_* files'
+      FileUtils.rm Dir[File.join(root_dir, 'tmp', 'DATABASE_FORK_*')]
+    end
+
   end
 
   # use DatabaseFork.new.run in your post-checkout hook
   def initialize(root_dir, logger = Logger.new(STDOUT))
-    @root_dir = root_dir
-    @config_file = File.join(@root_dir, '.db_forks.yml')
-    @logger = logger
-    @commands = []
+    @root_dir     = root_dir
+    @config_file  = File.join(@root_dir, '.db_forks.yml')
+    @logger       = logger
+
+    reset_commands!
   end
 
-  # TODO: simplify this somehow
   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)
+    if 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
-        case ask_user("Create database: '#{fork_db_name}'? (y(es), n(no), enter=ignore)")
-          when 'y'
-            create_database_fork!
-            export_env
-          when 'n'
-            # do nothing
-            reset_env
-          else
-            config['ignore'] << current_branch
-            reset_env
+      config['environments'].each do |env|
+        adapter = MysqlFork.new(@root_dir, app_connection[env], env, current_branch, @logger)
+
+        if adapter.exists?
+          log_info "Database #{adapter.target_name} exists. Skipping."
+          adapter.export_env
+        else
+          case ask_user("Create database: '#{adapter.target_name}'? (y(es), n(no), enter=ignore)")
+            when 'y'
+              adapter.fork
+              adapter.export_env
+            when 'n'
+              adapter.reset_env
+            else
+              config['ignore'] << current_branch
+              adapter.reset_env
+          end
         end
+
       end
+
     else
-      reset_env
+      self.class.reset_all_environments!(@root_dir)
     end
 
     save_config
@@ -60,101 +76,9 @@ class DatabaseFork
     IO.new(IO.sysopen('/dev/tty'), 'r').gets.chomp
   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
-
-  # TODO: refactor to adapter
-  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
-
-  # TODO: refactor to adapter
-  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
-
-  # TODO: refactor to adapter
-  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
-    log_info 'Resetting fork information'
-    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, dry_run = false)
-    log_info message
-    log_debug command
-    @commands << [command, message]
-    `#{command}` unless dry_run
-  end
-
-  def dump_file_path(env = 'development')
-    File.join(@root_dir, '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(@root_dir, 'config', 'database.yml')).read).result)
+    @database_config ||= LoadDatabaseConfig.new(@root_dir)
+    @database_config.config
   end
 
   def current_branch

data/lib/database_fork/commands.rb

@@ -0,0 +1,17 @@
+module Commands
+  def record_command(command, message)
+    @commands << [command, message]
+  end
+
+  def execute_commands
+    @commands.each do |command, message|
+      log_info message
+      log_debug command
+      `#{command}`
+    end
+  end
+
+  def reset_commands!
+    @commands = []
+  end
+end

data/lib/database_fork/db_fork.rb

@@ -0,0 +1,102 @@
+require_relative 'logging'
+require_relative 'commands'
+
+class DBFork
+  include Logging
+  include Commands
+
+  # implement this is your adapter:
+  def exists?(dry_run = false)
+    raise NotImplementedError
+  end
+
+  # implement this is your adapter:
+  def connection_parameters
+    raise NotImplementedError
+  end
+
+  def create_dump
+    raise NotImplementedError
+  end
+
+  def create_database
+    raise NotImplementedError
+  end
+
+  def import_dump
+    raise NotImplementedError
+  end
+
+  def query_default_settings(dry_run = false)
+    raise NotImplementedError
+  end
+
+
+  def initialize(root_dir, connection, env, branch_name, logger)
+    @root_dir = root_dir
+    @connection = connection
+    @env = env
+    @branch_name = branch_name
+    @logger = logger
+
+    @character_set = nil
+    @collation = nil
+
+    reset_commands!
+  end
+
+  attr_accessor :commands
+
+  def fork(dry_run = false)
+    reset_commands!
+
+    log_info "creating database fork '#{target_name}' from #{source_db}"
+
+    create_dump
+    create_database
+    import_dump
+    delete_dump_file
+
+    execute_commands unless dry_run
+  end
+
+  def target_name
+    "#{source_db}_#{@branch_name}"
+  end
+
+
+  def source_db
+    @connection['database']
+  end
+
+  def reset_env(dry_run = false)
+    reset_commands!
+    filename = File.join(@root_dir, 'tmp', "DATABASE_FORK_#{@env.upcase}")
+    record_command "rm #{filename}", "removing DATABASE_FORK_#{@env.upcase}"
+    execute_commands unless dry_run
+  end
+
+  def export_env(dry_run = false)
+    reset_commands!
+    filename = File.join(@root_dir, 'tmp', "DATABASE_FORK_#{@env.upcase}")
+    record_command "echo #{target_name} > #{filename}", "setting DATABASE_FORK_#{@env.upcase}"
+    execute_commands unless dry_run
+  end
+
+  def delete_dump_file
+    record_command "rm #{dump_file}", 'cleanup'
+  end
+
+  def character_set
+    @character_set || 'utf8'
+  end
+
+  def collation
+    @collation || 'utf8_unicode_ci'
+  end
+
+  def dump_file
+    File.join(@root_dir, 'tmp', "dump_#{source_db}.sql")
+  end
+
+end

data/lib/database_fork/load_database_config.rb

@@ -0,0 +1,13 @@
+require 'erb'
+
+# this is very Rails specific
+# TODO: make this work with other frameworks too :)
+class LoadDatabaseConfig
+  def initialize(root_dir)
+    @root_dir = root_dir
+  end
+
+  def config
+    @config ||= YAML.load(ERB.new(open(File.join(@root_dir, 'config', 'database.yml')).read).result)
+  end
+end

data/lib/database_fork/logging.rb

@@ -0,0 +1,9 @@
+module Logging
+  def log_info(message)
+    @logger.info message
+  end
+
+  def log_debug(message)
+    @logger.debug message
+  end
+end

data/lib/database_fork/mysql_connection.rb

@@ -0,0 +1,26 @@
+class MysqlConnection
+  def initialize(config)
+    @config = config
+  end
+
+  def params
+    key_mapping = {
+      'username' => 'user',
+      'password' => 'password',
+      'socket' => 'socket',
+      'host' => 'host',
+      'port' => 'port'
+    }
+
+    @config.inject(Hash.new) do |akk, tupel|
+      key, value = *tupel
+
+      akk[key_mapping[key.to_s]] = value if key_mapping.key?(key.to_s)
+      akk
+    end.map do |tupel|
+      key, value = *tupel
+
+      "--#{key}=#{value}"
+    end.sort.join(' ')
+  end
+end

data/lib/database_fork/mysql_fork.rb

@@ -0,0 +1,47 @@
+require_relative 'db_fork'
+require_relative 'mysql_connection'
+
+class MysqlFork < DBFork
+
+  def exists?(dry_run = false)
+    command = %Q{mysql #{connection_parameters} -s -N -e "SHOW DATABASES LIKE '#{target_name}';" }
+    if dry_run
+      reset_commands!
+      record_command command, 'query default character set and collation'
+    else
+      !`#{command}`.empty?
+    end
+  end
+
+  def connection_parameters
+    @connection_parameters ||= MysqlConnection.new(@connection).params
+  end
+
+  def create_dump
+    record_command %Q{mysqldump #{connection_parameters} --routines --triggers -C #{source_db} > #{dump_file}}, "dumping #{source_db}"
+  end
+
+  def source_db
+    @connection['database']
+  end
+
+  def create_database
+    record_command %Q{mysql #{connection_parameters} -e "CREATE DATABASE IF NOT EXISTS #{target_name} CHARACTER SET '#{character_set}' COLLATE '#{collation}';"}, "create database #{@fork_db_name}"
+  end
+
+  def import_dump
+    record_command %Q{mysql #{connection_parameters} -C -A -D#{target_name} < #{dump_file}}, 'importing dump'
+  end
+
+  def query_default_settings(dry_run = false)
+    command = %Q{mysql #{connection_parameters} -s -N -e "SELECT DEFAULT_CHARACTER_SET_NAME, DEFAULT_COLLATION_NAME FROM information_schema.SCHEMATA S WHERE schema_name = 'papersmart_dev';"}
+    if dry_run
+      reset_commands!
+      record_command command, 'query default character set and collation'
+    else
+      @character_set, @collation = *(`#{command}`.("\t"))
+    end
+  end
+
+
+end

data/spec/lib/database_fork/mysql_connection_spec.rb

@@ -0,0 +1,18 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/database_fork/mysql_connection'
+
+describe MysqlConnection do
+
+  let(:connection) { {
+    'host' => '127.0.0.1',
+    'port' => '3306',
+    'username' => 'root',
+    'password' => '',
+    'database' => 'myapp_development'
+  } }
+
+  subject{ MysqlConnection.new(connection) }
+
+  it { expect(subject.params).to eql '--host=127.0.0.1 --password= --port=3306 --user=root' }
+
+end

data/spec/lib/database_fork/mysql_fork_spec.rb

@@ -0,0 +1,59 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/database_fork/mysql_fork'
+
+describe MysqlFork do
+
+  let(:connection) { {
+    'host' => '127.0.0.1',
+    'port' => '3306',
+    'username' => 'root',
+    'password' => '',
+    'database' => 'myapp_development'
+  } }
+
+  let(:branch_name){ 'feature_branch' }
+  let(:env){ 'development' }
+
+  it 'loads correctly' do
+    MysqlFork.new(tmp_path, connection, env, branch_name, Logger.new(StringIO.new))
+  end
+
+  describe 'with connection configuration' do
+    let(:dev){  }
+
+    subject{ MysqlFork.new(tmp_path, connection, env, branch_name, Logger.new(StringIO.new))}
+
+    it{ expect(subject.target_name).to eql 'myapp_development_feature_branch' }
+
+    it 'fork commands' do
+      subject.fork(true)
+      expect(subject.commands).to_not be_empty
+    end
+
+    it 'dump_file' do
+      expect(subject.dump_file).to match(%r{tmp/dump_myapp_development.sql$}i)
+    end
+
+    it 'create_dump' do
+      subject.create_dump
+      commands = subject.commands
+      expect(commands.size).to eql 1
+      expect(commands[0][0]).to match(%r{--routines --triggers -C #{connection['database']} >})
+    end
+
+    it 'create_database' do
+      subject.create_database
+      commands = subject.commands
+      expect(commands.size).to eql 1
+      expect(commands[0][0]).to match(%r{-e "CREATE DATABASE IF NOT EXISTS #{connection['database']}_#{branch_name} CHARACTER SET 'utf8' COLLATE 'utf8_unicode_ci';"})
+    end
+
+    it 'source_db' do
+      expect(subject.source_db).to eql connection['database']
+    end
+
+  end
+
+
+
+end

data/spec/lib/database_fork_spec.rb

@@ -0,0 +1,5 @@
+require_relative '../../lib/database_fork'
+
+describe DatabaseFork do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+
+require 'logger'
+require 'fileutils'
+require 'stringio'
+
+def tmp_path
+  $tmp_path ||= File.join(File.dirname(__FILE__), 'tmp')
+end
+
+def clean_tmp
+  FileUtils.mkdir_p(tmp_path) # just in case it does not exist
+  FileUtils.rm_r tmp_path
+end
+
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+  c.filter_run :focus => true
+  c.run_all_when_everything_filtered = true
+
+  c.before do
+    clean_tmp
+  end
+end
+

metadata

@@ -1,41 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: database_fork
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - the-architect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-07-18 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  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
@@ -45,13 +87,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - database_fork.gemspec
 - lib/database_fork.rb
+- lib/database_fork/commands.rb
+- lib/database_fork/db_fork.rb
+- lib/database_fork/load_database_config.rb
+- lib/database_fork/logging.rb
+- lib/database_fork/mysql_connection.rb
+- lib/database_fork/mysql_fork.rb
+- spec/lib/database_fork/mysql_connection_spec.rb
+- spec/lib/database_fork/mysql_fork_spec.rb
+- spec/lib/database_fork_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/
 licenses:
 - MIT
@@ -62,18 +118,22 @@ 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
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Fork your database
-test_files: []
+test_files:
+- spec/lib/database_fork/mysql_connection_spec.rb
+- spec/lib/database_fork/mysql_fork_spec.rb
+- spec/lib/database_fork_spec.rb
+- spec/spec_helper.rb