dbmgr 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c1d63aa7bc4f6795171479e42483e54e207c7cb
-  data.tar.gz: 7921f72d031bafcc7935b943a141cd79c68391e3
+  metadata.gz: 93d8ee795896f8c51a88fd038bd689a828beca6a
+  data.tar.gz: e205d42fe6ca7fee844b3d1b49cb29e382a3ec33
 SHA512:
-  metadata.gz: b4e81173f851f17c5561353da4dba82bfbb5804cdf38504ff67617d7fb521f673f0179161377a498fb31e5ea61b30d4dad8b004dcae54c0fdedcfa2b55965a60
-  data.tar.gz: 7870b8b83dc3d899a139b61e34d19b29cae250a6b4cc389c84c8b680fefd59aa61c469f261bf71fcf7dc786a2885ebfebf96caa6562af065b5a41cd5aa933971
+  metadata.gz: 686aac888b556537252078f0b986026860851107365e54bbf3bb9b3c515c83535e1aea835ef8d8afe3d7eb87a24bd4b91493fc5eaff941ad9ccb492d7462f33d
+  data.tar.gz: 935866afca624476219810cce0e992c184327cee5ba58250937e2df81d151f6f9a025146f98075028b9077bbe2133ed2e7fb84b55767ccfc1864d4c29ec5b9ce

data/README.md

@@ -1,30 +1,81 @@
 # Dbmgr
 
-`dbmgr` is a command line tool for backing up and restoring development databases. I created this
-because my inexperience led me to run `docker-compose down` on our MySQL image causing me to
-_unexpectedly_ lose my development database. Since that day, I've found `dbmgr` to be very useful
-in:
-- Sharing databases between developers on our team
+`dbmgr` is a command line tool for backing up and restoring databases. It's a useful
+tool for:
+- Sharing databases between developers
+- Provisioning new Vagrant vms and Docker images
 - Provisioning new developers with a working database
 
 ## Installation
 
+```
+$ brew install callahanrts/dbmgr/dbmgr
+```
+or
 ```
 $ gem install dbmgr
 ```
 
 ## Usage
 
-#### Backup
-##### Help
+#### Help
 ```
-dbmgr mysql help backup
+$ dbmgr help
 ```
+
+#### Backup
 ```
-dbmgr mysql backup --options
+$ dmgr mysql backup --options
 ```
 
 #### Restore
 ```
-dbmgr mysql restore --options
+$ dbmgr mysql restore --options
+```
+
+#### Config
+Options can either be passed in each command or they can be set as defaults in the `~/.dbmgr`
+config file.
+```ruby
+# ~/.dbmgr
+
+:dbmgr:
+  :path: "~/.db_backups"
+
+:mysql:
+  :port: 3306
+  :host: 'localhost'
+  :user: "root"
+```
+
+## Examples
+#### Back up a MySQL database
+
+```bash
+# Back up database from local MySQL server
+$ dbmgr mysql backup database_name
+
+# Back up database from a remote MySQL server
+$ dbmgr mysql backup database_name -P 3307 -h 192.168.33.10 -u root
+
+# Back up database and store in a specific location
+$ dbmgr mysql backup database_name -p ~/Downloads
+
+# Back up database as a named backup
+$ dbmgr mysql backup database_name -f my_backup.sql
+```
+
+#### Restore a MySQL database
+```bash
+# Restore local database from the latest backup in the default location
+$ dbmgr mysql restore database_name
+
+# Restore remote database with the latest backup
+$ dbmgr mysql restore database_name -P 3307 -h 192.168.33.10 -u root
+
+# Restore local database from the latest backup in a specific location
+$ dbmgr mysql restore database_name -p ~/Downloads
+
+# Restore database from a named backup
+$ dbmgr mysql restore database_name -f my_backup.sql
 ```

data/dbmgr.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "mysql2", "~> 0.4.5"
+  spec.add_development_dependency "mocha", "~> 1.2.1"
 end

data/lib/dbmgr/cli/mysql.rb

@@ -20,21 +20,21 @@ module Dbmgr::CLI
                   banner: "#{ENV["HOME"]}/.db_backups",
                   desc: "Directory of database backups"
 
-    method_option :dbport,
+    method_option :port,
                   aliases: ["P"],
                   type: :numeric,
                   default: 3306,
                   banner: "3306",
                   desc: "MySQL database port"
 
-    method_option :dbhost,
+    method_option :host,
                   aliases: ["h"],
                   type: :string,
                   default: "localhost",
                   banner: "localhost",
                   desc: "MySQL database host"
 
-    method_option :dbuser,
+    method_option :user,
                   aliases: ["u"],
                   type: :string,
                   default: "root",
@@ -42,14 +42,14 @@ module Dbmgr::CLI
                   desc: "MySQL database user"
 
     def backup db_name
-      puts "Backing up '#{db_name}' to '#{options[:path]}'..."
       file = options[:filename] || "#{db_name}_#{Time.now.to_i}.sql"
+      puts "Backing up '#{db_name}' (#{options[:path]}/#{file})..."
 
       # Create the backups directory if it doesn't exist already
       system "mkdir -p #{options[:path]}"
 
       # Create a mysql backup from the user supplied options
-      system "mysqldump -u#{options[:dbuser]} -h #{options[:dbhost]} -P #{options[:dbport]} #{db_name} > #{options[:path]}/#{file}"
+      system "mysqldump -u#{options[:user]} -h #{options[:host]} -P #{options[:port]} #{db_name} > #{options[:path]}/#{file}"
     end
 
 
@@ -70,21 +70,21 @@ module Dbmgr::CLI
                   banner: "#{ENV["HOME"]}/.db_backups",
                   desc: "Directory of database backups"
 
-    method_option :dbport,
+    method_option :port,
                   aliases: ["P"],
                   type: :numeric,
                   default: 3306,
                   banner: "3306",
                   desc: "MySQL database port"
 
-    method_option :dbhost,
+    method_option :host,
                   aliases: ["h"],
                   type: :string,
                   default: "localhost",
                   banner: "localhost",
                   desc: "MySQL database host"
 
-    method_option :dbuser,
+    method_option :user,
                   aliases: ["u"],
                   type: :string,
                   default: "root",
@@ -95,24 +95,28 @@ module Dbmgr::CLI
       puts "Create database if it doesn't exist..."
 
       # Create the database to restore if it doesn't exist already
-      system "mysql -u#{options[:dbuser]} -h #{options[:dbhost]} -P #{options[:dbport]} -e \"CREATE DATABASE IF NOT EXISTS #{db_name}\""
+      system "mysql -u#{options[:user]} -h #{options[:host]} -P #{options[:port]} -e \"CREATE DATABASE IF NOT EXISTS #{db_name}\""
 
       # Grab the backup file or the latest backup from the backups directory
       backup = options[:backup] || Dir.glob("#{options[:path]}/#{db_name}_*.sql").last
-      raise "Restore failed: backup not found" unless File.file?(backup)
+      raise "Restore failed: backup not found" unless File.file?(backup.to_s)
 
       # Restore the database from a backup
-      system("mysql -u#{options[:dbuser]} #{db_name} -h #{options[:dbhost]} -P #{options[:dbport]} < #{backup}")
+      system("mysql -u#{options[:user]} #{db_name} -h #{options[:host]} -P #{options[:port]} < #{backup}")
     end
 
   private
 
     def options
       original = super
-      return original unless File.file?("#{ENV["HOME"]}/.dbmgr")
-      config = YAML::load_file("#{ENV["HOME"]}/.dbmgr") || {}
-      config[:dbmgr][:path].gsub!("~/", "#{ENV["HOME"]}/") # Expand ~/ manually
-      Thor::CoreExt::HashWithIndifferentAccess.new([original, config[:dbmgr], config[:mysql]].reduce &:merge)
+      return original unless File.file?("#{home}/.dbmgr")
+      config = YAML::load_file("#{home}/.dbmgr") || {dbmgr: {}, mysql: {}}
+      config[:dbmgr][:path].gsub!("~/", "#{home}/") if !config[:dbmgr].nil? && config[:dbmgr].has_key?(:path) # Expand ~/ manually
+      Thor::CoreExt::HashWithIndifferentAccess.new([config[:dbmgr], config[:mysql], original].reduce &:merge)
+    end
+
+    def home
+      ENV["HOME"]
     end
 
   end

data/lib/dbmgr/version.rb

@@ -1,3 +1,3 @@
 module Dbmgr
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbmgr
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Cody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-25 00:00:00.000000000 Z
+date: 2016-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 description: Create database backups to share with others across your dev team. Other
   developers can restore from backups you've created.
 email:
@@ -101,7 +115,6 @@ files:
 - bin/dbmgr-dev
 - bin/setup
 - dbmgr.gemspec
-- dbmgr.rb
 - examples/.dbmgr
 - lib/dbmgr.rb
 - lib/dbmgr/cli.rb

data/dbmgr.rb

@@ -1,20 +0,0 @@
-
-class Dbmgr < Formula
-
-  desc "Backup and restore development databases"
-  homepage "https://github.com/callahanrts/dbmgr"
-  url "https://github.com/callahanrts/dbmgr/archive/v0.1.2.tar.gz"
-
-  head "https://github.com/callahanrts/dbmgr.git"
-  bottle :unneeded
-
-  def install
-    lib.install Dir["lib/*"]
-    bin.install "bin/dbmgr"
-  end
-
-  test do
-    system "#{bin}/dbmgr", "help"
-  end
-
-end