capistrano-mysqldump 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b6171de0702d5184a3710a25fd7905a5fcedf316
-  data.tar.gz: 89494639809fcf9b4c8bee140f188172e709243d
+SHA256:
+  metadata.gz: a4dac8ba8a4797570e17b69860e660d50db64cc912cfac0bf167dcfc0db6c00e
+  data.tar.gz: 60057567797ed539e0b7016c22d34abe454ed2011111e1ebb8ebf9b48151a965
 SHA512:
-  metadata.gz: 2bb26ab73f303dfc7846642680ae01b678998f7893be1daf0dd1037aeee3d1bb07528762582b33858fcc1b5d13c4c5e4b4efbf10963984d8fcbef5f47ec8d5b5
-  data.tar.gz: 78f4899c94b6a75fb5359ee76df9f5d7d58fd9a69fd304fbc88cb7bed63f73a9ac7ed834985fe4d0f2b00f41ad1428c0f6b0103b86eac31957c28151fc9f06e4
+  metadata.gz: 62626182f607c82a9772085d41b59af0767d70c8b98011b5dd978b9243e200e503ba08ecb078bdfceea1163a35270844941517c47c12e67a2acbce9b549abb9a
+  data.tar.gz: f9cf7d5801a82dcce81afc9b334ab64b7c0ae3193df8f653f69a69e4dba874d28e5e9c9b46c75bf5fa68bb4f8497f33b44c9df320aa76b4c220a123e62a12325

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+dist: trusty
+sudo: false
+
+rvm:
+  - ruby-head
+  - 2.3
+  - 2.2
+  - 2.1
+  - 2.0
+
+allow_failures:
+  - rvm: ruby-head
+
+notifications:
+  email: false

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+2.0.0 - 2018-02-06
+==================
+
+## features
+[Upgraded to support Capistrano 3](https://github.com/alexfarrill/capistrano-mysqldump/pull/12)
+
 1.1.2 - 2014-10-06
 ==================
 
@@ -11,4 +17,4 @@
 ## style & finesse
 
 [fixed readme formatting](https://github.com/alexfarrill/capistrano-mysqldump/pull/5)
-[setup test env](https://github.com/alexfarrill/capistrano-mysqldump/pull/7)
+[setup test env](https://github.com/alexfarrill/capistrano-mysqldump/pull/7)

data/Gemfile.lock

@@ -1,46 +1,47 @@
 PATH
   remote: .
   specs:
-    capistrano-mysqldump (1.1.2)
-      capistrano (>= 1.0.0)
+    capistrano-mysqldump (2.0.0)
+      capistrano (>= 3.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.0.1)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    atomic (1.1.14)
-    capistrano (2.15.5)
-      highline
-      net-scp (>= 1.0.0)
-      net-sftp (>= 2.0.0)
-      net-ssh (>= 2.0.14)
-      net-ssh-gateway (>= 1.1.0)
-    highline (1.6.20)
-    i18n (0.6.5)
-    minitest (4.7.5)
-    multi_json (1.8.2)
-    net-scp (1.1.2)
-      net-ssh (>= 2.6.5)
-    net-sftp (2.1.2)
-      net-ssh (>= 2.6.5)
-    net-ssh (2.7.0)
-    net-ssh-gateway (1.2.0)
+    activesupport (4.2.10)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    airbrussh (1.3.0)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.10.1)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    concurrent-ruby (1.0.5)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.10.3)
+    net-scp (1.2.1)
       net-ssh (>= 2.6.5)
-    rake (0.9.2.2)
+    net-ssh (4.2.0)
+    power_assert (1.1.1)
+    rake (12.3.0)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
       shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.1.6)
-    shoulda-matchers (2.4.0)
+    shoulda-context (1.2.2)
+    shoulda-matchers (2.8.0)
       activesupport (>= 3.0.0)
-    thread_safe (0.1.3)
-      atomic
-    tzinfo (0.3.38)
+    sshkit (1.16.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    test-unit (3.2.6)
+      power_assert
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
@@ -50,3 +51,7 @@ DEPENDENCIES
   capistrano-mysqldump!
   rake
   shoulda
+  test-unit
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -4,6 +4,8 @@ Capistrano extension to run mysqldump remotely, download, and import into your l
 
 WARNING: This will blow away your development database (duh)
 
+## Note: For capistrano v2, see version 1
+
 ## Installation
 
 ```ruby
@@ -20,12 +22,6 @@ require 'capistrano/mysqldump'
 
 * Run:
 
-```ruby
-cap mysqldump
-```
-
-Or if you're using `capistrano-ext/multistage`, do
-
 ```ruby
 cap production mysqldump
 ```

data/VERSION

@@ -1 +1 @@
-1.1.2
+2.0.0

data/capistrano-mysqldump.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |s|
   s.name = "capistrano-mysqldump"
-  s.version = "1.1.2"
+  s.version = "2.0.0"
 
   s.authors = ["Alex Farrill"]
   s.date = "2013-07-03"
@@ -21,12 +21,14 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/alexfarrill/capistrano-mysqldump"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
   s.summary = "Capistrano extension to run mysqldump remotely, download, and import into your local Rails development database"
 
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.add_runtime_dependency(%q<capistrano>, [">= 1.0.0"])
+
+  s.required_ruby_version = ">= 2.0"
+  s.add_runtime_dependency(%q<capistrano>, [">= 3.0.0"])
   s.add_development_dependency "bundler", "~> 1.3"
   s.add_development_dependency "rake"
   s.add_development_dependency "shoulda"
-end
+  s.add_development_dependency "test-unit"
+end

data/lib/capistrano/dsl/mysqldump.rb

@@ -0,0 +1,36 @@
+module Capistrano
+  module DSL
+    module Mysqldump
+
+      # converts a hash of options into a string.
+      # drops falsey-valued keys.
+      #
+      # `{u: 'foo', 'single-transaction' => true, ignore-tables' => 'bar',  p: nil}`
+      # => '-ufoo --ignore-tables=bar --single-transaction
+      #
+      def mysqldump_options_string(options = nil)
+        options
+        options.map do |k,v|
+          next unless v
+          used_value = v == true ? nil : v
+          used_prefix, used_join = if k.length == 1
+                                     ["-", '']
+                                   else
+                                     ["--", '=']
+                                   end
+
+          "#{used_prefix}#{[k, used_value].compact.join used_join}"
+        end.compact.join ' '
+      end
+
+      # returns credential options for a given username and password
+      # when given an empty or nil password, does not include p: in the returned hash
+      def mysqldump_credential_options(username, password)
+        {}.tap do |opts|
+          opts[:u] = username
+          opts[:p] = password if password == true || password && !password.empty?
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/mysqldump.rb

@@ -1,135 +1,8 @@
 require 'capistrano'
+require "capistrano/dsl/mysqldump"
+require 'sshkit'
+self.extend Capistrano::DSL::Mysqldump
 
-module Capistrano
-  module Mysqldump 
+SSHKit::Backend::Netssh.send(:include, Capistrano::DSL::Mysqldump)
 
-    # converts a hash of options into a string.
-    # drops falsey-valued keys.
-    # 
-    # `{u: 'foo', 'single-transaction' => true, ignore-tables' => 'bar',  p: nil}`
-    # => '-ufoo --ignore-tables=bar --single-transaction
-    # 
-    def self.options_string(options = nil)
-      options
-      options.map do |k,v|
-        next unless v
-        used_value = v == true ? nil : v
-        used_prefix, used_join = if k.length == 1
-          ["-", '']
-        else
-          ["--", '=']
-        end
-
-        "#{used_prefix}#{[k, used_value].compact.join used_join}"
-      end.compact.join ' '
-    end
-
-    # returns credential options for a given username and password
-    # when given an empty or nil password, does not include p: in the returned hash
-    def self.credential_options(username, password)
-      {}.tap do |opts|
-        opts[:u] = username
-        opts[:p] = password if password == true || password && !password.empty?
-      end
-    end
-
-    def self.load_into(configuration)
-      configuration.load do 
-        namespace :mysqldump do
-          task :default, :roles => :db do
-            dump
-            import
-          end
-
-          task :setup do
-            @mysqldump_config = fetch :mysqldump_config, YAML.load_file("config/database.yml")[rails_env.to_s]
-            unless @mysqldump_config
-              raise "Cannot load database config for #{rails_env} environment"
-            end
-
-            host = @mysqldump_config["host"]
-
-            # overwrite these if necessary
-            @mysqldump_bin = fetch :mysqldump_bin, "`which mysqldump`"
-            mysqldump_remote_tmp_dir = fetch :mysqldump_remote_tmp_dir, "/tmp"
-            mysqldump_local_tmp_dir = fetch :mysqldump_local_tmp_dir, "/tmp"
-            @mysqldump_location = fetch :mysqldump_location, host && !host.empty? && host != "localhost" ? :remote : :local
-            @mysqldump_options = fetch :mysqldump_options, {}
-
-            # for convenience
-            mysqldump_filename = "%s-%s.sql" % [application, Time.now.to_i]
-            mysqldump_filename_gz = "%s.gz" % mysqldump_filename
-            @mysqldump_remote_filename = File.join( mysqldump_remote_tmp_dir, mysqldump_filename_gz )
-            @mysqldump_local_filename = File.join( mysqldump_local_tmp_dir, mysqldump_filename )
-            @mysqldump_local_filename_gz = File.join( mysqldump_local_tmp_dir, mysqldump_filename_gz )
-
-            @mysqldump_ignore_tables = fetch :mysqldump_ignore_tables, []
-            @mysqldump_tables = fetch :mysqldump_tables, []
-          end
-
-          def default_options
-            setup
-            username, password, host = @mysqldump_config.values_at *%w( username password host )
-            {
-              :h => host,
-              :quick => true,
-              "single-transaction" => true,
-            }.tap do |options|
-
-              password = true if @mysqldump_location == :remote
-
-              if @mysqldump_ignore_tables.any?
-                options['ignore-tables'] = [@mysqldump_ignore_tables].flatten.join ' '
-              end
-
-              options.merge! Mysqldump.credential_options(username, password)
-            end
-          end
-
-
-
-          task :dump, :roles => :db do
-            options = default_options
-            options.merge! @mysqldump_options
-            password, database = @mysqldump_config.values_at *%w( password database )
-            mysqldump_cmd = "#{@mysqldump_bin} #{Mysqldump.options_string(options)} #{database} #{[@mysqldump_tables].flatten.compact.join ' '}"
-
-            case @mysqldump_location
-            when :remote
-              mysqldump_cmd += " | gzip > %s" % @mysqldump_remote_filename
-
-              run mysqldump_cmd do |ch, stream, out|
-                ch.send_data "#{password}\n" if out =~ /^Enter password:/
-              end
-
-              download @mysqldump_remote_filename, @mysqldump_local_filename_gz, :via => :scp
-              run "rm #{@mysqldump_remote_filename}"
-
-              `gunzip #{@mysqldump_local_filename_gz}`
-            when :local
-              mysqldump_cmd += " > %s" % @mysqldump_local_filename
-
-              `#{mysqldump_cmd}`
-            end
-          end
-
-          task :import do
-            config = YAML.load_file("config/database.yml")["development"]
-            username, password, database = config.values_at *%w( username password database )
-
-            credentials_string = Mysqldump.options_string Mysqldump.credential_options(username, password)
-            
-            mysql_cmd = "mysql #{credentials_string}"
-            `#{mysql_cmd} -e "drop database #{database}; create database #{database}"`
-            `#{mysql_cmd} #{database} < #{@mysqldump_local_filename}`
-            `rm #{@mysqldump_local_filename}`
-          end
-        end
-      end
-    end
-  end
-end
-
-if Capistrano::Configuration.instance
-  Capistrano::Mysqldump.load_into(Capistrano::Configuration.instance)
-end
+load File.expand_path("../tasks/mysqldump.rake", __FILE__)

data/lib/capistrano/tasks/mysqldump.rake

@@ -0,0 +1,96 @@
+namespace :mysqldump do
+  task :default do
+    on roles(:db) do
+      dump
+      import
+    end
+  end
+
+  def setup_variables
+    @mysqldump_config = fetch :mysqldump_config, YAML.load_file("config/database.yml")[fetch(:rails_env).to_s]
+    unless @mysqldump_config
+      raise "Cannot load database config for #{fetch(:rails_env)} environment"
+    end
+
+    host = @mysqldump_config["host"]
+
+    # overwrite these if necessary
+    @mysqldump_bin = fetch :mysqldump_bin, "`which mysqldump`"
+    mysqldump_remote_tmp_dir = fetch :mysqldump_remote_tmp_dir, "/tmp"
+    mysqldump_local_tmp_dir = fetch :mysqldump_local_tmp_dir, "/tmp"
+    @mysqldump_location = fetch :mysqldump_location, host && !host.empty? && host != "localhost" ? :remote : :local
+    @mysqldump_options = fetch :mysqldump_options, {}
+
+    # for convenience
+    mysqldump_filename = "%s-%s.sql" % [fetch(:application), Time.now.to_i]
+    mysqldump_filename_gz = "%s.gz" % mysqldump_filename
+    @mysqldump_remote_filename = File.join( mysqldump_remote_tmp_dir, mysqldump_filename_gz )
+    @mysqldump_local_filename = File.join( mysqldump_local_tmp_dir, mysqldump_filename )
+    @mysqldump_local_filename_gz = File.join( mysqldump_local_tmp_dir, mysqldump_filename_gz )
+
+    @mysqldump_ignore_tables = fetch :mysqldump_ignore_tables, []
+    @mysqldump_tables = fetch :mysqldump_tables, []
+  end
+
+  def default_options
+    setup_variables
+    username, password, host = @mysqldump_config.values_at *%w( username password host )
+    {
+      :h => host,
+      :quick => true,
+      "single-transaction" => true,
+    }.tap do |options|
+
+      password = true if @mysqldump_location == :remote
+
+      if @mysqldump_ignore_tables.any?
+        options['ignore-tables'] = [@mysqldump_ignore_tables].flatten.join ' '
+      end
+
+      options.merge! mysqldump_credential_options(username, password)
+    end
+  end
+
+  task :dump do
+    options = default_options
+    options.merge! @mysqldump_options
+    password, database = @mysqldump_config.values_at *%w( password database )
+    mysqldump_cmd = "#{@mysqldump_bin} #{mysqldump_options_string(options)} #{database} #{[@mysqldump_tables].flatten.compact.join ' '}"
+
+    case @mysqldump_location
+    when :remote
+      # TODO: use `set` instead of binding to local variables
+      remote_filename = @mysqldump_remote_filename
+      local_filename_gz = @mysqldump_local_filename_gz
+      mysqldump_cmd += " | gzip > %s" % @mysqldump_remote_filename
+
+      on roles(:db) do
+        execute(
+          mysqldump_cmd,
+          interaction_handler: {
+            /^Enter password:/ => "#{password}\n"
+          })
+
+        download! remote_filename, local_filename_gz
+        execute "rm #{remote_filename}"
+      end
+      `gunzip #{@mysqldump_local_filename_gz}`
+    when :local
+      mysqldump_cmd += " > %s" % @mysqldump_local_filename
+
+      `#{mysqldump_cmd}`
+    end
+  end
+
+  task :import do
+    config = YAML.load_file("config/database.yml")["development"]
+    username, password, database = config.values_at *%w( username password database )
+
+    credentials_string = mysqldump_options_string mysqldump_credential_options(username, password)
+
+    mysql_cmd = "mysql #{credentials_string}"
+    `#{mysql_cmd} -e "drop database #{database}; create database #{database}"`
+    `#{mysql_cmd} #{database} < #{@mysqldump_local_filename}`
+    `rm #{@mysqldump_local_filename}`
+  end
+end

data/test/test_capistrano-mysqldump.rb

@@ -2,39 +2,42 @@ require 'helper'
 
 
 class TestCapistranoMysqldump < Test::Unit::TestCase
-  mysqldump = Capistrano::Mysqldump
+  class Dummy
+    include Capistrano::DSL::Mysqldump
+  end
+  mysqldump = Dummy.new
 
-  context '.options_string' do
+  context '.mysqldump_options_string' do
     should "not include falesy values" do
-      assert_equal '', mysqldump.options_string({:a => nil, :b => false})
+      assert_equal '', mysqldump.mysqldump_options_string({:a => nil, :b => false})
     end
 
     should 'use "--" prefix and "=" join for length > 1 keys' do
-      assert_equal '--multi_char_key=foo', mysqldump.options_string(:multi_char_key => 'foo')
+      assert_equal '--multi_char_key=foo', mysqldump.mysqldump_options_string(:multi_char_key => 'foo')
     end
 
     should 'use "-" prefix and "" join for length == 1 keys' do
-      assert_equal '-ofoo', mysqldump.options_string({:o => 'foo'})
+      assert_equal '-ofoo', mysqldump.mysqldump_options_string({:o => 'foo'})
     end
-    
+
     should 'not include variable for value = true' do
-      assert_equal '-o --multi_char_key', mysqldump.options_string(:o => true, :multi_char_key => true)
+      assert_equal '-o --multi_char_key', mysqldump.mysqldump_options_string(:o => true, :multi_char_key => true)
     end
   end
 
-  context '.credential_options(username, password)' do
+  context '.mysqldump_credential_options(username, password)' do
     should 'includes password if it exists' do
       assert_equal(
-        {:u => 'foo', :p => 'bar'}, 
-        mysqldump.credential_options('foo', 'bar')
+        {:u => 'foo', :p => 'bar'},
+        mysqldump.mysqldump_credential_options('foo', 'bar')
       )
     end
 
     should 'does not include password if falsey or empty' do
       assert_equal(
         {:u => 'foo'},
-        mysqldump.credential_options('foo', ''), 
-        mysqldump.credential_options('foo', false)
+        mysqldump.mysqldump_credential_options('foo', ''),
+        mysqldump.mysqldump_credential_options('foo', false)
       )
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-mysqldump
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Alex Farrill
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: ''
 email: alex.farrill@gmail.com
 executables: []
@@ -75,6 +89,7 @@ extra_rdoc_files:
 - README.md
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -83,7 +98,9 @@ files:
 - Rakefile
 - VERSION
 - capistrano-mysqldump.gemspec
+- lib/capistrano/dsl/mysqldump.rb
 - lib/capistrano/mysqldump.rb
+- lib/capistrano/tasks/mysqldump.rake
 - test/helper.rb
 - test/test_capistrano-mysqldump.rb
 homepage: http://github.com/alexfarrill/capistrano-mysqldump
@@ -98,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -106,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Capistrano extension to run mysqldump remotely, download, and import into