mysql_dumper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f9f14de100bde7364e2ccf399e9bf84338dba40
+  data.tar.gz: 5238aa528a8f86ba2bf5b8f0a1986bb63558e01c
+SHA512:
+  metadata.gz: 2b710df22ed383236b7f599744bf88d9c291667cbf577d83e8a90f6280fead5e6e6bc8f1b094c3f61fdf7191407ca5015f2aab3e4529470801c03e5daa1f8d84
+  data.tar.gz: 437a8c5437bb08e442090aec0dd300218020cb0a809c61ba1f12ce28058ce7e102bfab74b85173eedd8a45cc9a0546787797f99a6e1efd9dd5694dc2b2f425b7

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yang-Hsing Lin
+
+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,45 @@
+# MysqlDumper
+
+MysqlDumper is a ruby wrapper of `mysqldump`.
+It provides both ruby and command line interface.
+
+## Usage
+
+### Ruby interface:
+
+        require 'mysql_dumper'
+        config = {
+          "database" => "the_db_name",
+          "username" => "db_user_name"
+          "password" => "xxxx"
+        }
+
+        dumper = MysqlDumper.new config
+
+        # dump whole db, including stored procedure
+        dumper.dump_to("path/to/db.sql")
+
+        # dump only schema and certain tables
+        dumper.dump_schema_to("path/to/db.sql", { :preserve => ["table1", "table2"] })
+
+        # load a sql file to a database
+        dumper.load_from("path/to/db.sql")
+
+### command-line interface: (more expressive than native mysqldump interface)
+
+1. dump whole db:
+`$ mysql_dumper dump DBNAME --to path/to/db.sql -u USERNAME [-p PASSWORD]`
+
+2. dump schema only:
+`$ mysql_dumper dump_schema DBNAME --to path/to/schema.sql -u USERNAME [--perserve table1,table2...] [-p PASSWORD]`
+
+3. load from schema:
+`$ mysql_dumper load DBNAME --from path/to/db.sql -u USERNAME [-p PASSWORD]`
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/bin/mysql_dumper

@@ -0,0 +1,94 @@
+#! /usr/bin/env ruby
+# command line interface
+# usage:
+# 1. dump whole db:
+# $ mysql_dumper dump DBNAME --to SQL_FILE_PATH -u USERNAME
+#
+# 2. dump schema:
+# $ mysql_dumper dump_schema DBNAME --to SQL_FILE_PATH -u USERNAME [--perserve t1,t2...]
+#
+# 3. load schema to db:
+# $ mysql_dumper load DBNAME --from SQL_FILE_PATH -u USERNAME
+
+require 'optparse'
+require "mysql_dumper"
+
+class ArgumentSet
+  attr_accessor :config, :action, :file, :preserve, :username, :error
+  VALID_ACTIONS = [ "dump", "dump_schema", "load" ]
+  def initialize
+    @config = {}
+    parser.parse! ARGV
+    @action = ARGV[0]
+    @config["database"] = ARGV[1]
+    @error = ""
+  end
+
+  def parser
+    @parser ||= OptionParser.new do |opts|
+      opts.banner = "Usage: mysql_dumper ACTION [options]"
+      opts.on("-u", "--username USERNAME", "username to connect") do |username|
+        @config["username"] = username
+      end
+      opts.on("-f", "--to FILENAME", "file path of sql") do |filename|
+        @file = filename
+      end
+      opts.on("-f", "--from FILENAME", "file path of sql") do |filename|
+        @file = filename
+      end
+      opts.on("-p", "--password PASSWORD", "password of db") do |pwd|
+        @config["password"] = pwd
+      end
+      opts.on("-t", "--preserve DBNAME1,DBNAME2...", Array, "tables to preserve") do |tables|
+        @preserve = tables
+      end
+      opts.on("-h", "--help") do 
+        puts opts
+        exit
+      end
+    end
+  end
+
+  def valid?
+    ensure_exists @config["username"], "username"
+    ensure_exists @config["database"], "database"
+    ensure_exists @file, "sql_file"
+    validate_action
+
+    @error == ""
+  end
+
+  def ensure_exists param, attr_name
+    if ! param
+      @error += "missing argument #{attr_name}\n"
+    end
+  end
+  
+  def validate_action
+    if ! VALID_ACTIONS.include? @action
+      @error += "invalid action: #{@action}"
+    end
+  end
+
+  def show_help
+    puts parser
+  end
+
+end
+
+arguments = ArgumentSet.new
+
+if arguments.valid?
+  dumper = MysqlDumper.new(arguments.config)
+  case arguments.action
+  when "dump"
+    dumper.dump_to(arguments.file)
+  when "dump_schema"
+    dumper.dump_schema_to(arguments.file, { :preserve => arguments.preserve })
+  when "load"
+    dumper.load_from(arguments.file)
+  end
+else
+  puts arguments.error
+  arguments.show_help
+end

data/lib/mysql_dumper/version.rb

@@ -0,0 +1,3 @@
+class MysqlDumper
+  VERSION = "0.0.1"
+end

data/lib/mysql_dumper.rb

@@ -0,0 +1,31 @@
+require "mysql_dumper/version"
+
+class MysqlDumper
+  class InitFailedException < Exception; end;
+  def initialize config
+    @password = config["password"]
+    @username = config["username"]
+    @database = config["database"]
+    raise InitFailedException, "username is required to init a dumper" unless @username
+    raise InitFailedException, "database is required to init a dumper" unless @database
+  end
+
+  def dump_schema_to path, options = {}
+    preserved_tables = options[:preserve] || []
+    table_string = preserved_tables.join(" ")
+
+    system "mysqldump -u #{@username} -p#{@password} -R -d --skip-comments #{@database} > #{path}"
+    if ! table_string.strip.empty?
+      system "mysqldump -u #{@username} -p#{@password} --skip-comments #{@database} #{table_string} >> #{path}"
+    end
+  end
+
+  def dump_to path
+    system "mysqldump -u #{@username} -p#{@password} -R --skip-comments #{@database} > #{path}"
+  end
+
+  def load_from path
+    system "cat #{path} | mysql -u #{@username} -p#{@password} #{@database}"
+  end
+
+end

data/mysql_dumper.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mysql_dumper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mysql_dumper"
+  spec.version       = MysqlDumper::VERSION
+  spec.authors       = ["Yang-Hsing Lin"]
+  spec.email         = ["yanghsing.lin@gmail.com"]
+  spec.description   = %q{mysqldump wrapper}
+  spec.summary       = %q{provides both command line and ruby interface}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+end

data/spec/mysql_dumper_spec.rb

@@ -0,0 +1,89 @@
+require "mysql_dumper"
+
+describe MysqlDumper do
+  let(:database) { "db_name" }
+  let(:username) { "the_username" }
+  let(:password) { "the_pwd" }
+  before(:each) do
+    @config = {
+      "database" => database,
+      "username" => username,
+      "password" => password
+    }
+  end
+
+  it "takes a config to init" do
+    dumper = MysqlDumper.new @config
+  end
+
+  def self.ensure_in_config attr_name
+    it "raises MysqlDumper::InitFailedException if no #{attr_name}" do
+      @config.delete attr_name
+
+      expect {
+        MysqlDumper.new @config
+      }.to raise_error(MysqlDumper::InitFailedException, 
+                       "#{attr_name} is required to init a dumper")
+    end
+  end
+
+  ensure_in_config "username"
+  ensure_in_config "database"
+
+  context "dumping methods" do
+    let(:file_path) { "/tmp/dummy.sql" }
+    before(:each) do
+      @dumper = MysqlDumper.new @config
+      @dumper.stub(:system)
+    end
+    describe "#dump_schema_to(destination_file[, options])" do
+      it "dump schema to destination_file" do
+        executed = false
+        @dumper.stub(:system) do |command|
+          sql = <<-SQL
+          mysqldump -u #{username} -p#{password} -R -d --skip-comments #{database} > #{file_path}
+          SQL
+          command.should == sql.strip
+          executed = true
+        end
+
+        @dumper.dump_schema_to(file_path)   
+        executed.should be_true
+      end
+
+      it "preserves tables data if specified" do
+        table1 = "table1"
+        table2 = "table2"
+        sql_schema_only = 
+          "mysqldump -u #{username} -p#{password} -R -d --skip-comments #{database} > #{file_path}"
+        sql_with_tables =
+          "mysqldump -u #{username} -p#{password} --skip-comments #{database} #{table1} #{table2} >> #{file_path}"
+
+        @dumper.should_receive(:system).with(sql_schema_only)
+        @dumper.should_receive(:system).with(sql_with_tables)
+
+        @dumper.dump_schema_to(file_path, { :preserve => [ table1, table2 ] })   
+      end
+    end
+
+    describe "#dump_to(destination_file)" do
+      it "dumps whole db to destination_file" do
+        @dumper.should_receive(:system).
+          with("mysqldump -u #{username} -p#{password} -R --skip-comments #{database} > #{file_path}")
+        @dumper.dump_to(file_path)
+      end
+    end
+
+    describe "#load_from(sql_file)" do
+      it "loads sql_file to specific db" do
+        @dumper.should_receive(:system).
+          with("cat #{file_path} | mysql -u #{username} -p#{password} #{database}")    
+        @dumper.load_from(file_path)
+      end
+    end
+    
+  end
+
+
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: mysql_dumper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yang-Hsing Lin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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: mysqldump wrapper
+email:
+- yanghsing.lin@gmail.com
+executables:
+- mysql_dumper
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mysql_dumper
+- lib/mysql_dumper.rb
+- lib/mysql_dumper/version.rb
+- mysql_dumper.gemspec
+- spec/mysql_dumper_spec.rb
+homepage: ''
+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.0.7
+signing_key: 
+specification_version: 4
+summary: provides both command line and ruby interface
+test_files:
+- spec/mysql_dumper_spec.rb