db-clone 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49f2e655fd5b8142404f997e65a1f2e647c1c970
-  data.tar.gz: c6157b020d04905514e4de0ba16c69759b7a22c2
+  metadata.gz: 858dc634b9bdd7e324b615026b443a6f94848f2d
+  data.tar.gz: 3fb6466df18b1e20116d9c95c357e008167a298c
 SHA512:
-  metadata.gz: 6468a86aafb06f00e78727269d55668c42a2eb68746c99fbaad60476ce0980fdc87c69a3c7be4c965ae5e186b71a8e57905aae24f303c81b9700eaff10b4791d
-  data.tar.gz: 9274df308d3a9cb27085f5b4ef2c046ddfdbc11e1ef667fd1fd9efb0b1f7b54156ffdec53376773cee053ef29ad7aef8a9cb128a1a3289348cef02f8dc73bc87
+  metadata.gz: 9d816644da342037ba4181ea3bba95c95ee96a9ed44282c9603b2005654db29be9506d9333f18bf67e116bb76f014a9a0878b779159a1ac44e8e82efdebeca8a
+  data.tar.gz: '0569a2e201f32ef1c2df198ee480578d23aad86bc568338d56db8b43e0bf959ecb292852a4ef01cf595134e90028c958e3183cd705db96982eb5a12d7225adab'

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+#ruby=ruby-2.3.3
+#ruby-gemset=db-clone
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in db-clone.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sean Huber
+
+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,61 @@
+[![Gem Version](https://badge.fury.io/rb/db-clone.svg)](https://badge.fury.io/rb/db-clone)
+[![Build Status](https://travis-ci.org/seanhuber/db-clone.svg?branch=master)](https://travis-ci.org/seanhuber/db-clone)
+[![Coverage Status](https://coveralls.io/repos/github/seanhuber/db-clone/badge.svg?branch=master)](https://coveralls.io/github/seanhuber/db-clone?branch=master)
+
+# db-clone
+
+The `db-clone` gem provides a rake task for cloning one database into another.  It does this by making a system call to `mysqldump` or `pg_dump` (currently only mysql and postgresql are supported) and uses the contents of your application's `database.yml` to determine the command line arguments.
+
+![Screenshot](https://cdn.rawgit.com/seanhuber/db-clone/master/screenshot.png)
+
+## Requirements
+
+Ruby >= 2.3
+
+db-clone requires `mysqldump` (for MySQL) and/or `pg_dump` (for PostgreSQL).
+
+## Installation
+
+Add to `gem 'db-clone', '~> 2.0'` to your `Gemfile` and `bundle install`.
+
+## Usage
+
+To clone your `production` database to `development`, run:
+
+```
+rake db:clone
+```
+
+If you have more database blocks (besides `production` and `development`) defined in `config/database.yml`, you can clone between these databases using DbClone's CLI:
+
+```
+rake db:clone[manual]
+```
+
+## Configuration
+
+By default `rake db:clone` will read from `config/database.yml` and use your `production` database as the source and `development` as the destination.  You can configure these defaults to something else by adding to your `Rakefile` (or in an initializer if you're using Rails):
+
+```ruby
+Db::Clone.setup do |config|
+  # default is 'config/database.yml'
+  config.database_yml_path = '/path/to/my_database_config.yml'
+
+  # default is 'production'
+  config.default_source_database = 'my_source_db'
+
+  # default is 'development'
+  config.default_destination_database = 'my_destination_db'
+
+  # default is [], adds --ignore-table arguments to mysqldump
+  config.ignore_tables = ['schema_migrations', 'some_other_table']
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/seanhuber/db-clone.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,23 +1,16 @@
-#!/usr/bin/env rake
-begin
- require 'bundler/setup'
-rescue LoadError
- puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-Bundler::GemHelper.install_tasks
-
-APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
-load 'rails/tasks/engine.rake'
-
-Bundler::GemHelper.install_tasks
-
-Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
-
-require 'rspec/core'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'db/clone'
 
-desc 'Run all specs in spec directory (excluding plugin specs)'
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task :default => :spec
+
+Db::Clone.setup do |config|
+  config.database_yml_path            = File.join 'spec', 'sample_database.yml'
+  # config.default_source_database      = 'production'
+  # config.default_destination_database = 'development'
+  # config.default_source_database      = 'uat2'
+  # config.default_destination_database = 'test'
+  config.ignore_tables                = ['first_ignore', 'second_ignore']
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "db/clone"
+
+# 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/db-clone.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "db/clone/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "db-clone"
+  spec.version       = Db::Clone::VERSION
+  spec.authors       = ["Sean Huber"]
+  spec.email         = ["seanhuber@seanhuber.com"]
+  spec.homepage      = 'https://github.com/seanhuber/db-clone'
+  spec.summary       = 'rake db:clone will clone your production database to development'
+  spec.description   = 'rake db:clone[manual] provides a CLI for selecting a specific source database to copy to a specific destination database. Supports postgreql and mysql.'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'colorize', '~> 0.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'awesome_print'
+end

data/lib/db/clone.rb

@@ -0,0 +1,50 @@
+require 'colorize'
+require 'yaml'
+
+require 'db/clone/cmd_builder.rb'
+require 'db/clone/cmd_prompt.rb'
+require 'db/clone/base.rb'
+require 'db/clone/rake_task.rb'
+require 'db/clone/version'
+
+Db::Clone::RakeTask.new.install_tasks
+
+module Db
+  module Clone
+    @@database_yml_path = File.join 'config', 'database.yml'
+    def self.database_yml_path
+      @@database_yml_path
+    end
+    def self.database_yml_path=(database_yml_path)
+      @@database_yml_path = database_yml_path
+    end
+
+    @@default_source_database = 'production'
+    def self.default_source_database
+      @@default_source_database
+    end
+    def self.default_source_database=(default_source_database)
+      @@default_source_database = default_source_database
+    end
+
+    @@default_destination_database = 'development'
+    def self.default_destination_database
+      @@default_destination_database
+    end
+    def self.default_destination_database=(default_destination_database)
+      @@default_destination_database = default_destination_database
+    end
+
+    @@ignore_tables = []
+    def self.ignore_tables
+      @@ignore_tables
+    end
+    def self.ignore_tables=(ignore_tables)
+      @@ignore_tables = ignore_tables
+    end
+
+    def self.setup
+      yield self
+    end
+  end
+end

data/lib/db/clone/base.rb

@@ -0,0 +1,59 @@
+module Db::Clone
+  class Base
+    include CmdPrompt
+
+    def self.clone! invoke_cli
+      self.new.clone! invoke_cli
+    end
+
+    def initialize
+      @db_yml = YAML.load_file Db::Clone.database_yml_path
+      raise ArgumentError.new("#{Db::Clone.database_yml_path} does not have at least 2 database blocks.") unless @db_yml.length >= 2
+
+      @default_src = Db::Clone.default_source_database
+      @default_dest = Db::Clone.default_destination_database
+    end
+
+    def clone! invoke_cli
+      src_db, dest_db = invoke_cli ? prompt_for_src_and_dest : default_src_and_dest
+
+      cmd_builder = CmdBuilder.new src: @db_yml[src_db], dest: @db_yml[dest_db]
+
+      puts "\n  Executing: #{cmd_builder.cmd.light_blue}\n\n"
+      exec cmd_builder.cmd
+    end
+
+    private
+
+    def prompt_for_src_and_dest
+      databases = @db_yml.keys.sort
+      default_src = databases.include?(@default_src) ? @default_src : databases.first
+
+      src_db = prompt 'Which is the source database?', default_src, databases.map{|name| [name, name.yellow]}.to_h
+      puts "Source database = #{src_db.green}"
+
+      databases.delete src_db
+      default_dest = src_db != @default_dest && databases.include?(@default_dest) ? @default_dest : databases.first
+
+      dest_db = prompt 'Which is the destination database?', default_dest, databases.map{|name| [name, name.yellow]}.to_h
+      puts "Destination database = #{dest_db.green}"
+
+      if dest_db == @default_src
+        proceed = ask_yes_no "#{'WARNING!'.black.on_yellow} You have selected #{@default_src.green} as your destination database, meaning that db-clone will overwrite it with the contents of your #{src_db.green} database. Do you want to proceed anyway?", false
+        unless proceed
+          puts "\nCloning #{'canceled'.red}."
+          abort
+        end
+      end
+
+      [src_db, dest_db]
+    end
+
+    def default_src_and_dest
+      raise ArgumentError.new("Configured default source database, #{@default_src}, does not exist in #{Db::Clone.database_yml_path}") unless @db_yml[@default_src]
+      raise ArgumentError.new("Configured default destination database, #{@default_dest}, does not exist in #{Db::Clone.database_yml_path}") unless @db_yml[@default_dest]
+
+      [@default_src, @default_dest]
+    end
+  end
+end

data/lib/{db_clone → db/clone}/cmd_builder.rb

@@ -1,24 +1,22 @@
-module DbClone
+module Db::Clone
   class CmdBuilder
     VALID_DB_KEYS = ['host', 'port', 'username', 'database', 'password']
     SUPPORTED_DBS = [:mysql, :postgresql]
 
-    def exec!() exec @cmd end
+    attr_reader :cmd
 
-    def initialize( selections )
-      raise(ArgumentError, 'Both source and destination must be set') unless selections[:src] && selections[:dest]
-      raise(ArgumentError, 'Source and destination databases must be of the same type') unless selections[:src]['adapter'] == selections[:dest]['adapter']
+    def initialize selections
+      raise ArgumentError.new('Both source and destination must be set') unless selections[:src] && selections[:dest]
+      raise ArgumentError.new('Source and destination databases must be of the same type') unless selections[:src]['adapter'] == selections[:dest]['adapter']
       SUPPORTED_DBS.each{|db| @db_type = db if selections[:src]['adapter'].include?(db.to_s)}
-      raise(ArgumentError, "Unsupported database: #{selections[:src]['adapter']}") unless @db_type
+      raise ArgumentError.new("Unsupported database: #{selections[:src]['adapter']}") unless @db_type
       src_dest = selections.map{|k,v| [k,v.delete_if{|i,j| !VALID_DB_KEYS.include?(i)}]}.to_h
-      @cmd = send("build_#{@db_type}_cmd", src_dest)
+      @cmd = send "build_#{@db_type}_cmd", src_dest
     end
 
-    def get_cmd() @cmd end
-
     private
 
-    def build_mysql_cmd( src_dest )
+    def build_mysql_cmd src_dest
       mysqldump_args = [
         "mysqldump --no-create-db --add-drop-table --lock-tables=false",
         "--user=#{src_dest[:src]['username']}",
@@ -27,7 +25,7 @@ module DbClone
         "--port=#{src_dest[:src]['port']}"
       ]
 
-      DbClone.config[:ignore_tables].each{|tbl| mysqldump_args << "--ignore-table=#{src_dest[:src]['database']}.#{tbl}"} if DbClone.config && DbClone.config[:ignore_tables].is_a?(Array)
+      Db::Clone.ignore_tables.each{|tbl| mysqldump_args << "--ignore-table=#{src_dest[:src]['database']}.#{tbl}"}
 
       (mysqldump_args + [
         "#{src_dest[:src]['database']}",
@@ -40,7 +38,7 @@ module DbClone
       ]).join(' ')
     end
 
-    def build_postgresql_cmd( src_dest )
+    def build_postgresql_cmd src_dest
       [
         "pg_dump --no-password --clean",
         "--host=#{src_dest[:src]['host']}",

data/lib/db/clone/cmd_prompt.rb

@@ -0,0 +1,43 @@
+module Db::Clone
+  module CmdPrompt
+    # def ask_for_text instruction, default_text=nil
+    #   if default_text
+    #     print "\n#{instruction} [default = \"#{default_text}\"]: "
+    #   else
+    #     print "\n#{instruction}: "
+    #   end
+    #   text = STDIN.gets.chomp.strip
+    #   text = default_text if text.blank? && default_text
+    #   text
+    # end
+
+    def ask_yes_no question, default_to_yes=true
+      print "\n#{question} [#{default_to_yes ? 'Yn' : 'yN'}]: "
+      answer = STDIN.gets.chomp.strip.downcase
+      default_to_yes ? !(answer == 'n') : answer == 'y'
+    end
+
+    def prompt question, default, options={}
+      default_num = nil
+      numbered_opts = options.map.with_index do |opt, idx|
+        default_num = idx+1 if opt[0] == default
+        [idx+1, {ret_key: opt[0], label: opt[1]}]
+      end.to_h
+
+      puts "\n"
+      numbered_opts.each{|choice_num, opt| puts "  [#{choice_num.to_s.white}] #{opt[:label]}" }
+
+      print "\n#{question} [1-#{options.length}, default=#{default_num}]: "
+
+      selection = STDIN.gets.chomp.strip.to_i
+      selection = default_num if selection.zero?
+
+      if numbered_opts.has_key? selection
+        numbered_opts[selection][:ret_key]
+      else
+        puts "#{'Invalid selection:'.red} #{selection}"
+        prompt question, default, options
+      end
+    end
+  end
+end

data/lib/db/clone/rake_task.rb

@@ -0,0 +1,17 @@
+module Db::Clone
+  class RakeTask
+    include Rake::DSL if defined? Rake::DSL
+
+    def install_tasks
+      return unless defined? namespace
+
+      namespace :db do
+        desc 'clones a source database to a destination database'
+        task :clone, [:manual] => :environment do |t, args|
+          invoke_cli = !args[:manual].nil?
+          Db::Clone::Base.clone! invoke_cli
+        end
+      end
+    end
+  end
+end