dbmgr 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93d8ee795896f8c51a88fd038bd689a828beca6a
-  data.tar.gz: e205d42fe6ca7fee844b3d1b49cb29e382a3ec33
+  metadata.gz: 6d50678d7d88d2e977fac194da5a297dfff2c611
+  data.tar.gz: 0f434fb01363d2bce751cda495b5122902b92575
 SHA512:
-  metadata.gz: 686aac888b556537252078f0b986026860851107365e54bbf3bb9b3c515c83535e1aea835ef8d8afe3d7eb87a24bd4b91493fc5eaff941ad9ccb492d7462f33d
-  data.tar.gz: 935866afca624476219810cce0e992c184327cee5ba58250937e2df81d151f6f9a025146f98075028b9077bbe2133ed2e7fb84b55767ccfc1864d4c29ec5b9ce
+  metadata.gz: '088e02444623d19812306acde778136b6f8eb7c0ae40129c81cec93b9fa38d9a356435df2ddfc1cdb0900f083d30e0e76e1dfd88adc7d2be57aa93071eb7f5f5'
+  data.tar.gz: a6522f4e50ddc9043f2fdfff0637381d693a268228b1e38781ea7278f6c32a876f4d00fde74a8f22f17ae01c1c05a4fa63901c67d4abd615b23e67c79a78ad35

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at callahanrts@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -33,21 +33,6 @@ $ dmgr mysql backup --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
 

data/bin/dbmgr

@@ -6,4 +6,4 @@ $LOAD_PATH.unshift(File.join(DBMGR_HOME, 'lib'))
 
 require 'dbmgr'
 
-Dbmgr::DbMgr.start(ARGV)
+Dbmgr::CLI.start(ARGV)

data/dbmgr.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Cody"]
   spec.email         = ["callahanrts@gmail.com"]
 
-  spec.required_ruby_version = '< 2.4'
+  spec.required_ruby_version = '< 2.5'
 
   spec.summary       = %q{Create database backups and restore from previously created backups}
   spec.description   = %q{Create database backups to share with others across your dev team. Other developers can restore from backups you've created.}
@@ -23,11 +23,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/dbmgr$}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'thor'
+  spec.add_dependency 'thor', "~> 0"
 
   spec.add_development_dependency "bundler", "~> 1.13"
   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"
+  spec.add_development_dependency "mocha", "~> 1.2"
 end

data/lib/database/database.rb

@@ -0,0 +1,33 @@
+# Database Class
+class Database
+  def initialize(options = {})
+    @user = options[:user]
+    @host = options[:host]
+    @port = options[:port]
+    @path = options[:path]
+    @file = options[:filename]
+    @backup = options[:backup]
+  end
+
+  private
+
+  # Construct a name for the backup. This is either a given name or a timestamped name
+  # for the given database name
+  def filename db_name
+    @file || "#{db_name}_#{Time.now.to_i}.sql"
+  end
+
+  # Back up from a given backup file--default to the most recent timestamped backup
+  def backup_file db_name
+    # Grab the backup file or the latest backup from the backups directory
+    backup = @backup || Dir.glob("#{@path}/#{db_name}_*.sql").last
+    raise "Restore failed: backup not found" unless File.file?(backup.to_s)
+    backup
+  end
+
+  # Construct the /file/path/backup.sql string
+  def filepath db_name
+    "#{@path}/#{filename db_name}"
+  end
+
+end

data/lib/database/mysql.rb

@@ -0,0 +1,44 @@
+require 'fileutils'
+
+# MySQL Module
+module MySQL
+  def backup(db_name)
+    FileUtils::mkdir_p @path
+
+    # Create a mysql backup from the user supplied options
+    system backup_db_command db_name
+  rescue
+    raise 'Unable to back up database'
+  end
+
+  def restore(db_name)
+    # Create the database to restore if it doesn't exist already
+    system create_db_command db_name
+
+    # Restore the database from a backup
+    system restore_db_command db_name
+  rescue
+    raise 'Unable to restore database'
+  end
+
+  private
+
+  def backup_db_command(db_name)
+    %( mysqldump -u#{@user} \
+                 -h #{@host} \
+                 -P #{@port} #{db_name} > #{filepath db_name} )
+  end
+
+  def create_db_command(db_name)
+    %( mysql -u#{@user} \
+             -h #{@host} \
+             -P #{@port} \
+             -e \"CREATE DATABASE IF NOT EXISTS #{db_name}\" )
+  end
+
+  def restore_db_command(db_name)
+    %( mysql -u#{@user} #{db_name} \
+             -h #{@host} \
+             -P #{@port} < #{backup_file db_name})
+  end
+end

data/lib/dbmgr/backup.rb

@@ -0,0 +1,57 @@
+
+module Dbmgr
+  class CLI < Thor
+
+    #
+    # Backup
+    #
+    desc "backup [database_name]", "Create a backup"
+    method_option :filename,
+                  aliases: ["f"],
+                  type: :string,
+                  banner: "my_backup.sql",
+                  desc: "Name of the backup created"
+
+    method_option :path,
+                  aliases: ["p"],
+                  type: :string,
+                  default: "#{ENV["HOME"]}/.db_backups",
+                  banner: "#{ENV["HOME"]}/.db_backups",
+                  desc: "Directory of database backups"
+
+    method_option :port,
+                  aliases: ["P"],
+                  type: :numeric,
+                  default: 3306,
+                  banner: "3306",
+                  desc: "MySQL database port"
+
+    method_option :host,
+                  aliases: ["h"],
+                  type: :string,
+                  default: "localhost",
+                  banner: "localhost",
+                  desc: "MySQL database host"
+
+    method_option :user,
+                  aliases: ["u"],
+                  type: :string,
+                  default: "root",
+                  banner: "root",
+                  desc: "MySQL database user"
+
+    method_option :database,
+                  aliases: "d",
+                  type: :string,
+                  default: "mysql",
+                  banner: "mysql",
+                  desc: "Database type"
+
+    def backup db_name
+      Database.new(options)
+              .extend(DATABASES[options[:database].to_sym])
+              .backup db_name
+    end
+
+  end
+end

data/lib/dbmgr/databases.rb

@@ -0,0 +1,6 @@
+
+module Dbmgr
+  DATABASES = {
+    mysql: MySQL
+  }
+end

data/lib/dbmgr/restore.rb

@@ -0,0 +1,58 @@
+
+module Dbmgr
+  class CLI < Thor
+
+    #
+    # Restore
+    #
+    desc "restore", "Restore from a backup"
+    method_option :backup,
+                  aliases: ["b"],
+                  type: :string,
+                  banner: "#{ENV["HOME"]}/.db_backups/backup.sql",
+                  desc: "Path to backup to restore from"
+
+    method_option :path,
+                  aliases: ["p"],
+                  type: :string,
+                  default: "#{ENV["HOME"]}/.db_backups",
+                  banner: "#{ENV["HOME"]}/.db_backups",
+                  desc: "Directory of database backups"
+
+    method_option :port,
+                  aliases: ["P"],
+                  type: :numeric,
+                  default: 3306,
+                  banner: "3306",
+                  desc: "MySQL database port"
+
+    method_option :host,
+                  aliases: ["h"],
+                  type: :string,
+                  default: "localhost",
+                  banner: "localhost",
+                  desc: "MySQL database host"
+
+    method_option :user,
+                  aliases: ["u"],
+                  type: :string,
+                  default: "root",
+                  banner: "root",
+                  desc: "MySQL database user"
+
+    method_option :database,
+                  aliases: "d",
+                  type: :string,
+                  default: "mysql",
+                  banner: "mysql",
+                  desc: "Database type"
+
+    def restore db_name
+      Database.new(options)
+              .extend(DATABASES[options[:database].to_sym])
+              .restore db_name
+    end
+
+  end
+end
+

data/lib/dbmgr/version.rb

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

data/lib/dbmgr.rb

@@ -1,6 +1,10 @@
+require 'thor'
+require "database/database"
+require "database/mysql"
 require "dbmgr/version"
-require "dbmgr/cli"
+require "dbmgr/databases"
+require "dbmgr/backup"
+require "dbmgr/restore"
 
 module Dbmgr
-  # Your code goes here...
 end

metadata

@@ -1,99 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: dbmgr
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Cody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-31 00:00:00.000000000 Z
+date: 2017-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !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
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '1.2'
 description: Create database backups to share with others across your dev team. Other
   developers can restore from backups you've created.
 email:
@@ -103,8 +103,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -116,9 +116,13 @@ files:
 - bin/setup
 - dbmgr.gemspec
 - examples/.dbmgr
+- lib/database/database.rb
+- lib/database/mysql.rb
 - lib/dbmgr.rb
+- lib/dbmgr/backup.rb
 - lib/dbmgr/cli.rb
-- lib/dbmgr/cli/mysql.rb
+- lib/dbmgr/databases.rb
+- lib/dbmgr/restore.rb
 - lib/dbmgr/version.rb
 homepage: https://github.com/callahanrts/dbmgr
 licenses:
@@ -130,17 +134,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - <
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Create database backups and restore from previously created backups

data/lib/dbmgr/cli/mysql.rb

@@ -1,123 +0,0 @@
-require 'yaml'
-
-module Dbmgr::CLI
-  class Mysql < Thor
-
-    #
-    # Backup
-    #
-    desc "backup [database_name]", "Create a backup"
-    method_option :filename,
-                  aliases: ["f"],
-                  type: :string,
-                  banner: "my_backup.sql",
-                  desc: "Name of the backup created"
-
-    method_option :path,
-                  aliases: ["p"],
-                  type: :string,
-                  default: "#{ENV["HOME"]}/.db_backups",
-                  banner: "#{ENV["HOME"]}/.db_backups",
-                  desc: "Directory of database backups"
-
-    method_option :port,
-                  aliases: ["P"],
-                  type: :numeric,
-                  default: 3306,
-                  banner: "3306",
-                  desc: "MySQL database port"
-
-    method_option :host,
-                  aliases: ["h"],
-                  type: :string,
-                  default: "localhost",
-                  banner: "localhost",
-                  desc: "MySQL database host"
-
-    method_option :user,
-                  aliases: ["u"],
-                  type: :string,
-                  default: "root",
-                  banner: "root",
-                  desc: "MySQL database user"
-
-    def backup db_name
-      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[:user]} -h #{options[:host]} -P #{options[:port]} #{db_name} > #{options[:path]}/#{file}"
-    end
-
-
-    #
-    # Restore
-    #
-    desc "restore", "Restore from a backup"
-    method_option :backup,
-                  aliases: ["b"],
-                  type: :string,
-                  banner: "#{ENV["HOME"]}/.db_backups/backup.sql",
-                  desc: "Path to backup to restore from"
-
-    method_option :path,
-                  aliases: ["p"],
-                  type: :string,
-                  default: "#{ENV["HOME"]}/.db_backups",
-                  banner: "#{ENV["HOME"]}/.db_backups",
-                  desc: "Directory of database backups"
-
-    method_option :port,
-                  aliases: ["P"],
-                  type: :numeric,
-                  default: 3306,
-                  banner: "3306",
-                  desc: "MySQL database port"
-
-    method_option :host,
-                  aliases: ["h"],
-                  type: :string,
-                  default: "localhost",
-                  banner: "localhost",
-                  desc: "MySQL database host"
-
-    method_option :user,
-                  aliases: ["u"],
-                  type: :string,
-                  default: "root",
-                  banner: "root",
-                  desc: "MySQL database user"
-
-    def restore db_name
-      puts "Create database if it doesn't exist..."
-
-      # Create the database to restore if it doesn't exist already
-      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.to_s)
-
-      # Restore the database from a 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?("#{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
-end