capistrano-db-tasks 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea446d397b392606dc52f06573bcb96a9393512c
-  data.tar.gz: 5f7e0c4afe2bbabe318dbc4394f89ef785b48dfd
+  metadata.gz: 18ac3ae6cd8e72a0cf8aeb17906f23c009b38e84
+  data.tar.gz: 648af7e955625ab548ff6d086bbbea56c8234f38
 SHA512:
-  metadata.gz: 176d858ac97f2e33fd31457e178c1e34c33d9022594bf83f2cb81b1dd4253ce665782c4f5eaaef36ff263c9b2ee3cd0b4dc4c5229ea7417d48d1cc57215c8426
-  data.tar.gz: c850f2dd9138ba36f5cb07506eb67c0f6b6feda66f5daef31d2edccaf71fec8ac9990d199ef03113e311f1811102330079a13a2112d0a434f0edb0812ff683f3
+  metadata.gz: 44884aea8dc26dc0a9d66c10c428b4b543a01720a912bf6efabe4f325b12c105d1da0ac67c78f460db10864efa9ac60cef4012eba6a7ab6dd03fec2d389ecd28
+  data.tar.gz: de3f9770a4c9cf2a35f9df7c61e70281feb7db5a2c0d23bc913b9ed37684c5e0c43d5c665412ffb6fc75014fca1df05d0b110376c40998e26a3b3a912714fa95

data/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+charset = utf-8

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,57 @@
+Rails:
+  Enabled: true
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'client/**/*'
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+    - 'test/factories/**/*'
+    - 'lib/configus.rb'
+    - 'node_modules/**/*'
+    - 'tmp/**/*'
+    - '**/*.haml'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 160
+
+Metrics/AbcSize:
+  Max: 40
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/ModuleLength:
+  Max: 150
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Capistrano-db-tasks Changelog
+
+Reverse Chronological Order:
+
+## master
+
+https://github.com/sgruhier/capistrano-db-tasks/compare/v0.5...HEAD
+
+* Your contribution here!
+
+# 0.5 (Nov 29 2016)
+
+* Fixed iteration on remote/local assets dir #98 (@elthariel)
+* Fetch :user property on server #97 (@elthariel)
+* Add support of ENV['DATABASE_URL'] #54 #70 #99 (@numbata, @fabn, @donbobka, @ktaragorn, @markgandolfo, @leifcr, @elthariel)
+* Specify database for pg\_terminate_backend #93 (@stevenchanin)
+* Show local execution failure log #89 (@dtaniwaki)
+* Add postigs to allowed PG adapters #91 (@matfiz)
+* Added database name to --ignore-table statements for MySQL #76 (@km-digitalpatrioten)
+* Add :db\_ignore\_tables option #65 (@rdeshpande)
+* Update README.markdown #67 (@alexbrinkman)
+* Using gzip instead of bzip2 (configurable) #48 #59 (@numbata)
+
+# 0.4 (Feb 26 2015)
+
+https://github.com/sgruhier/capistrano-db-tasks/compare/v0.3...v0.4
+
+* Set correct username for pg connection #55 (@numbata)
+* Protect remote server from pushing #51 (@IntractableQuery)
+* Use stage name as rails\_env #49 (@bronislav)
+* Remove local db dump after db:push if db_local_clean is set #47 (@pugetive)
+* Fixed app:pull and app:push tasks #42 (@iamdeuterium)
+* Added space between -p and the password #41 (@iamdeuterium)
+* Add option to skip data synchronization prompt question #37 (@rafaelsales)
+* Add option to remove remote dump file after downloading to local #36 (@rafaelsales)
+* Use port option from database.yml #35 (@numbata)
+* Use heroku dump/restore arguments for postgresql #26 (@mdpatrick)
+
+# 0.3 (Feb 9 2014)
+
+https://github.com/sgruhier/capistrano-db-tasks/compare/v0.2.1...v0.3
+
+* Capistrano 3 support PR #23 (@sauliusgrigaitis)

data/README.md

@@ -0,0 +1,100 @@
+# CapistranoDbTasks | [![Code Climate](https://codeclimate.com/github/sgruhier/capistrano-db-tasks/badges/gpa.svg)](https://codeclimate.com/github/sgruhier/capistrano-db-tasks) [![Gem Version](https://badge.fury.io/rb/capistrano-db-tasks.svg)](http://badge.fury.io/rb/capistrano-db-tasks)
+
+Add database AND assets tasks to capistrano to a Rails project. It only works with capistrano 3. Older versions until 0.3 works with capistrano 2.
+
+Currently
+
+* It only supports mysql and postgresql (both side remote and local)
+* Synchronize assets remote to local and local to remote
+
+Commands mysql, mysqldump (or pg\_dump, psql), bzip2 and unbzip2 (or gzip) must be in your PATH
+
+Feel free to fork and to add more database support or new tasks.
+
+## Install
+
+Add it as a gem:
+
+```ruby
+gem "capistrano-db-tasks", require: false
+```
+
+Add to config/deploy.rb:
+
+```ruby
+require 'capistrano-db-tasks'
+
+# if you haven't already specified
+set :rails_env, "production"
+
+# if you want to remove the local dump file after loading
+set :db_local_clean, true
+
+# if you want to remove the dump file from the server after downloading
+set :db_remote_clean, true
+
+# if you want to exclude table from dump
+set :db_ignore_tables, []
+
+# if you want to exclude table data (but not table schema) from dump
+set :db_ignore_data_tables, []
+
+# If you want to import assets, you can change default asset dir (default = system)
+# This directory must be in your shared directory on the server
+set :assets_dir, %w(public/assets public/att)
+set :local_assets_dir, %w(public/assets public/att)
+
+# if you want to work on a specific local environment (default = ENV['RAILS_ENV'] || 'development')
+set :locals_rails_env, "production"
+
+# if you are highly paranoid and want to prevent any push operation to the server
+set :disallow_pushing, true
+
+# if you prefer bzip2/unbzip2 instead of gzip
+set :compressor, :bzip2
+```
+
+Add to .gitignore
+
+```yml
+/db/*.sql
+```
+
+[How to install bzip2 on Windows](http://stackoverflow.com/a/25625988/3324219)
+
+## Available tasks
+
+```
+app:local:sync      || app:pull     # Synchronize your local assets AND database using remote assets and database
+app:remote:sync     || app:push     # Synchronize your remote assets AND database using local assets and database
+
+assets:local:sync   || assets:pull  # Synchronize your local assets using remote assets
+assets:remote:sync  || assets:push  # Synchronize your remote assets using local assets
+
+db:local:sync       || db:pull      # Synchronize your local database using remote database data
+db:remote:sync      || db:push      # Synchronize your remote database using local database data
+```
+
+## Example
+
+```
+cap db:pull
+cap production db:pull # if you are using capistrano-ext to have multistages
+```
+
+## Contributors
+
+* tilsammans (http://github.com/tilsammansee)
+* bigfive    (http://github.com/bigfive)
+* jakemauer  (http://github.com/jakemauer)
+* tjoneseng  (http://github.com/tjoneseng)
+* numbata    (http://github.com/numbata)
+* rafaelsales (http://github.com/rafaelsales)
+* rdeshpande (http://github.com/rdeshpande)
+
+## TODO
+
+* May be change project's name as it's not only database tasks now :)
+* Add tests
+
+Copyright (c) 2009 [Sébastien Gruhier - XILINUS], released under the MIT license

data/capistrano-db-tasks.gemspec

@@ -1,22 +1,25 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "capistrano-db-tasks/version"
 
-Gem::Specification.new do |s|
-  s.name        = "capistrano-db-tasks"
-  s.version     = CapistranoDbTasks::VERSION
-  s.authors     = ["Sebastien Gruhier"]
-  s.email       = ["sebastien.gruhier@xilinus.com"]
-  s.homepage    = "https://github.com/sgruhier/capistrano-db-tasks"
-  s.summary     = "A collection of capistrano tasks for syncing assets and databases"
-  s.description = "A collection of capistrano tasks for syncing assets and databases"
+Gem::Specification.new do |gem|
+  gem.name        = "capistrano-db-tasks"
+  gem.version     = CapistranoDbTasks::VERSION
+  gem.authors     = ["Sebastien Gruhier"]
+  gem.email       = ["sebastien.gruhier@xilinus.com"]
+  gem.homepage    = "https://github.com/sgruhier/capistrano-db-tasks"
+  gem.summary     = "A collection of capistrano tasks for syncing assets and databases"
+  gem.description = "A collection of capistrano tasks for syncing assets and databases"
 
-  s.rubyforge_project = "capistrano-db-tasks"
+  gem.rubyforge_project = "capistrano-db-tasks"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  gem.licenses      = ["MIT"]
 
-  s.add_runtime_dependency "capistrano", ">= 3.0.0"
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "capistrano", ">= 3.0.0"
 end

data/lib/capistrano-db-tasks.rb

@@ -1,2 +1,2 @@
 require "capistrano"
-require File.expand_path("#{File.dirname(__FILE__)}/capistrano-db-tasks/dbtasks")
+require File.expand_path("#{File.dirname(__FILE__)}/capistrano-db-tasks/dbtasks")

data/lib/capistrano-db-tasks/asset.rb

@@ -5,9 +5,12 @@ module Asset
     servers = Capistrano::Configuration.env.send(:servers)
     server = servers.detect { |s| s.roles.include?(:app) }
     port = server.netssh_options[:port] || 22
-    user = server.netssh_options[:user]
-    [cap.fetch(:assets_dir)].flatten.each do |dir|
-      system("rsync -a --del -L -K -vv --progress --rsh='ssh -p #{port}' #{user}@#{server}:#{cap.current_path}/#{dir} #{cap.fetch(:local_assets_dir)}")
+    user = server.netssh_options[:user] || server.properties.fetch(:user)
+    dirs = [cap.fetch(:assets_dir)].flatten
+    local_dirs = [cap.fetch(:local_assets_dir)].flatten
+
+    dirs.each_index do |idx|
+      system("rsync -a --del -L -K -vv --progress --rsh='ssh -p #{port}' #{user}@#{server}:#{cap.current_path}/#{dirs[idx]} #{local_dirs[idx]}")
     end
   end
 
@@ -15,9 +18,12 @@ module Asset
     servers = Capistrano::Configuration.env.send(:servers)
     server = servers.detect { |s| s.roles.include?(:app) }
     port = server.netssh_options[:port] || 22
-    user = server.netssh_options[:user]
-    [cap.fetch(:assets_dir)].flatten.each do |dir|
-      system("rsync -a --del -L -K -vv --progress --rsh='ssh -p #{port}' ./#{dir} #{user}@#{server}:#{cap.current_path}/#{cap.fetch(:local_assets_dir)}")
+    user = server.netssh_options[:user] || server.properties.fetch(:user)
+    dirs = [cap.fetch(:assets_dir)].flatten
+    local_dirs = [cap.fetch(:local_assets_dir)].flatten
+
+    dirs.each_index do |idx|
+      system("rsync -a --del -L -K -vv --progress --rsh='ssh -p #{port}' ./#{dirs[idx]} #{user}@#{server}:#{cap.current_path}/#{local_dirs[idx]}")
     end
   end
 

data/lib/capistrano-db-tasks/compressors/base.rb

@@ -0,0 +1,3 @@
+module Compressors
+  class Base; end
+end

data/lib/capistrano-db-tasks/compressors/bzip2.rb

@@ -0,0 +1,37 @@
+module Compressors
+  class Bzip2 < Base
+    class << self
+      def file_extension
+        "bz2"
+      end
+
+      def compress(from, to = nil)
+        to = case to
+             when "-"
+               "-c --stdout"
+             when nil
+               ""
+             else
+               "-c --stdout > #{to}"
+             end
+
+        "bzip2 #{from} #{to}"
+      end
+
+      def decompress(from, to = nil)
+        from = "-f #{from}" unless from == "-"
+
+        to = case to
+             when "-"
+               "-c --stdout"
+             when nil
+               ""
+             else
+               "-c --stdout > #{to}"
+             end
+
+        "bunzip2 -f #{from} #{to}"
+      end
+    end
+  end
+end

data/lib/capistrano-db-tasks/compressors/gzip.rb

@@ -0,0 +1,37 @@
+module Compressors
+  class Gzip < Base
+    class << self
+      def file_extension
+        "gz"
+      end
+
+      def compress(from, to = nil)
+        from = from == :stdin ? "-" : from
+        to = case to
+             when '-'
+               "-c --stdout"
+             when nil
+               ""
+             else
+               "-c --stdout > #{to}"
+             end
+
+        "gzip #{from} #{to}"
+      end
+
+      def decompress(from, to = nil)
+        from = from == :stdin ? "-" : from
+        to = case to
+             when :stdout
+               "-c --stdout"
+             when nil
+               ""
+             else
+               "-c --stdout > #{to}"
+             end
+
+        "gzip -d #{from} #{to}"
+      end
+    end
+  end
+end

data/lib/capistrano-db-tasks/database.rb

@@ -1,178 +1,226 @@
-module Database
-  class Base
-    attr_accessor :config, :output_file
-    def initialize(cap_instance)
-      @cap = cap_instance
-    end
-
-    def mysql?
-      @config['adapter'] =~ /^mysql/
-    end
-
-    def postgresql?
-      %w(postgresql pg).include? @config['adapter']
-    end
-
-    def credentials
-      credential_params = ""
-      username = @config['username'] || @config['user']
-
-      if mysql?
-        credential_params << " -u #{username} " if username
-        credential_params << " -p'#{@config['password']}' " if @config['password']
-        credential_params << " -h #{@config['host']} " if @config['host']
-        credential_params << " -S #{@config['socket']} " if @config['socket']
-        credential_params << " -P #{@config['port']} " if @config['port']
-      elsif postgresql?
-        credential_params << " -U #{username} " if username
-        credential_params << " -h #{@config['host']} " if @config['host']
-        credential_params << " -p #{@config['port']} " if @config['port']
-      end
-
-      credential_params
-    end
-
-    def database
-      @config['database']
-    end
-
-    def current_time
-      Time.now.strftime("%Y-%m-%d-%H%M%S")
-    end
-
-    def output_file
-      @output_file ||= "db/#{database}_#{current_time}.sql.bz2"
-    end
-
-    def pgpass
-      "PGPASSWORD='#{@config['password']}'" if @config['password']
-    end
-
-  private
-
-    def dump_cmd
-      if mysql?
-        "mysqldump #{credentials} #{database} --lock-tables=false"
-      elsif postgresql?
-        "#{pgpass} pg_dump --no-acl --no-owner #{credentials} #{database}"
-      end
-    end
-
-    def import_cmd(file)
-      if mysql?
-        "mysql #{credentials} -D #{database} < #{file}"
-      elsif postgresql?
-        terminate_connection_sql = "SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = '#{database}' AND pid <> pg_backend_pid();"
-        "#{pgpass} psql -c \"#{terminate_connection_sql};\" #{credentials}; #{pgpass} dropdb #{credentials} #{database}; #{pgpass} createdb #{credentials} #{database}; #{pgpass} psql #{credentials} -d #{database} < #{file}"
-      end
-    end
-
-  end
-
-  class Remote < Base
-    def initialize(cap_instance)
-      super(cap_instance)
-      @config = @cap.capture("cat #{@cap.current_path}/config/database.yml")
-      @config = YAML.load(ERB.new(@config).result)[@cap.fetch(:rails_env).to_s]
-    end
-
-    def dump
-      @cap.execute "cd #{@cap.current_path} && #{dump_cmd} | bzip2 - - > #{output_file}"
-      self
-    end
-
-    def download(local_file = "#{output_file}")
-      @cap.download! dump_file_path, local_file
-    end
-
-    def clean_dump_if_needed
-      if @cap.fetch(:db_remote_clean)
-        @cap.execute "rm -f #{dump_file_path}"
-      else
-        @cap.info "leaving #{dump_file_path} on the server (add \"set :db_remote_clean, true\" to deploy.rb to remove)"
-      end
-    end
-
-    # cleanup = true removes the mysqldump file after loading, false leaves it in db/
-    def load(file, cleanup)
-      unzip_file = File.join(File.dirname(file), File.basename(file, '.bz2'))
-      # @cap.run "cd #{@cap.current_path} && bunzip2 -f #{file} && RAILS_ENV=#{@cap.rails_env} bundle exec rake db:drop db:create && #{import_cmd(unzip_file)}"
-      @cap.execute "cd #{@cap.current_path} && bunzip2 -f #{file} && RAILS_ENV=#{@cap.fetch(:rails_env)} && #{import_cmd(unzip_file)}"
-      @cap.execute("cd #{@cap.current_path} && rm #{unzip_file}") if cleanup
-    end
-
-    private
-
-    def dump_file_path
-      "#{@cap.current_path}/#{output_file}"
-    end
-  end
-
-  class Local < Base
-    def initialize(cap_instance)
-      super(cap_instance)
-      @config = YAML.load(ERB.new(File.read(File.join('config', 'database.yml'))).result)[fetch(:local_rails_env).to_s]
-      puts "local #{@config}"
-    end
-
-    # cleanup = true removes the mysqldump file after loading, false leaves it in db/
-    def load(file, cleanup)
-      unzip_file = File.join(File.dirname(file), File.basename(file, '.bz2'))
-      # system("bunzip2 -f #{file} && bundle exec rake db:drop db:create && #{import_cmd(unzip_file)} && bundle exec rake db:migrate")
-      @cap.info "executing local: bunzip2 -f #{file} && #{import_cmd(unzip_file)}"
-      system("bunzip2 -f #{file} && #{import_cmd(unzip_file)}")
-      if cleanup
-        @cap.info "removing #{unzip_file}"
-        File.unlink(unzip_file)
-      else
-        @cap.info "leaving #{unzip_file} (specify :db_local_clean in deploy.rb to remove)"
-      end
-      @cap.info "Completed database import"
-    end
-
-    def dump
-      system "#{dump_cmd} | bzip2 - - > #{output_file}"
-      self
-    end
-
-    def upload
-      remote_file = "#{@cap.current_path}/#{output_file}"
-      @cap.upload! output_file, remote_file
-    end
-  end
-
-
-  class << self
-    def check(local_db, remote_db)
-      unless (local_db.mysql? && remote_db.mysql?) || (local_db.postgresql? && remote_db.postgresql?)
-        raise 'Only mysql or postgresql on remote and local server is supported'
-      end
-    end
-
-    def remote_to_local(instance)
-      local_db  = Database::Local.new(instance)
-      remote_db = Database::Remote.new(instance)
-
-      check(local_db, remote_db)
-
-      begin
-        remote_db.dump.download
-      ensure
-        remote_db.clean_dump_if_needed
-      end
-      local_db.load(remote_db.output_file, instance.fetch(:db_local_clean))
-    end
-
-    def local_to_remote(instance)
-      local_db  = Database::Local.new(instance)
-      remote_db = Database::Remote.new(instance)
-
-      check(local_db, remote_db)
-
-      local_db.dump.upload
-      remote_db.load(local_db.output_file, instance.fetch(:db_local_clean))
-      File.unlink(local_db.output_file) if instance.fetch(:db_local_clean)
-    end
-  end
-
-end
+module Database
+  class Base
+    DBCONFIG_BEGIN_FLAG = "__CAPISTRANODB_CONFIG_BEGIN_FLAG__".freeze
+    DBCONFIG_END_FLAG = "__CAPISTRANODB_CONFIG_END_FLAG__".freeze
+
+    attr_accessor :config, :output_file
+
+    def initialize(cap_instance)
+      @cap = cap_instance
+    end
+
+    def mysql?
+      @config['adapter'] =~ /^mysql/
+    end
+
+    def postgresql?
+      %w(postgresql pg postgis).include? @config['adapter']
+    end
+
+    def credentials
+      credential_params = ""
+      username = @config['username'] || @config['user']
+
+      if mysql?
+        credential_params << " -u #{username} " if username
+        credential_params << " -p'#{@config['password']}' " if @config['password']
+        credential_params << " -h #{@config['host']} " if @config['host']
+        credential_params << " -S #{@config['socket']} " if @config['socket']
+        credential_params << " -P #{@config['port']} " if @config['port']
+      elsif postgresql?
+        credential_params << " -U #{username} " if username
+        credential_params << " -h #{@config['host']} " if @config['host']
+        credential_params << " -p #{@config['port']} " if @config['port']
+      end
+
+      credential_params
+    end
+
+    def database
+      @config['database']
+    end
+
+    def current_time
+      Time.zone.now.strftime("%Y-%m-%d-%H%M%S")
+    end
+
+    def output_file
+      @output_file ||= "db/#{database}_#{current_time}.sql.#{compressor.file_extension}"
+    end
+
+    def compressor
+      @compressor ||= begin
+        compressor_klass = @cap.fetch(:compressor).to_s.split('_').collect(&:capitalize).join
+        klass = Object.module_eval("::Compressors::#{compressor_klass}", __FILE__, __LINE__)
+        klass
+      end
+    end
+
+    private
+
+    def pgpass
+      @config['password'] ? "PGPASSWORD='#{@config['password']}'" : ""
+    end
+
+    def dump_cmd
+      if mysql?
+        "mysqldump #{credentials} #{database} #{dump_cmd_opts}"
+      elsif postgresql?
+        "#{pgpass} pg_dump #{credentials} #{database} #{dump_cmd_opts}"
+      end
+    end
+
+    def import_cmd(file)
+      if mysql?
+        "mysql #{credentials} -D #{database} < #{file}"
+      elsif postgresql?
+        terminate_connection_sql = "SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = '#{database}' AND pid <> pg_backend_pid();"
+        "#{pgpass} psql -c \"#{terminate_connection_sql};\" #{credentials} #{database}; #{pgpass} dropdb #{credentials} #{database}; #{pgpass} createdb #{credentials} #{database}; #{pgpass} psql #{credentials} -d #{database} < #{file}"
+      end
+    end
+
+    def dump_cmd_opts
+      if mysql?
+        "--lock-tables=false #{dump_cmd_ignore_tables_opts} #{dump_cmd_ignore_data_tables_opts}"
+      elsif postgresql?
+        "--no-acl --no-owner #{dump_cmd_ignore_tables_opts} #{dump_cmd_ignore_data_tables_opts}"
+      end
+    end
+
+    def dump_cmd_ignore_tables_opts
+      ignore_tables = @cap.fetch(:db_ignore_tables, [])
+      if mysql?
+        ignore_tables.map { |t| "--ignore-table=#{database}.#{t}" }.join(" ")
+      elsif postgresql?
+        ignore_tables.map { |t| "--exclude-table=#{t}" }.join(" ")
+      end
+    end
+
+    def dump_cmd_ignore_data_tables_opts
+      ignore_tables = @cap.fetch(:db_ignore_data_tables, [])
+      ignore_tables.map { |t| "--exclude-table-data=#{t}" }.join(" ") if postgresql?
+    end
+  end
+
+  class Remote < Base
+    def initialize(cap_instance)
+      super(cap_instance)
+      @cap.info "Loading remote database config"
+      @cap.within @cap.current_path do
+        @cap.with rails_env: @cap.fetch(:rails_env) do
+          dirty_config_content = @cap.capture(:rails, "runner \"puts '#{DBCONFIG_BEGIN_FLAG}' + ActiveRecord::Base.connection.instance_variable_get(:@config).to_yaml + '#{DBCONFIG_END_FLAG}'\"", '2>/dev/null')
+          # Remove all warnings, errors and artefacts produced by bunlder, rails and other useful tools
+          config_content = dirty_config_content.match(/#{DBCONFIG_BEGIN_FLAG}(.*?)#{DBCONFIG_END_FLAG}/m)[1]
+          @config = YAML.load(config_content).each_with_object({}) { |(k, v), h| h[k.to_s] = v }
+        end
+      end
+    end
+
+    def dump
+      @cap.execute "cd #{@cap.current_path} && #{dump_cmd} | #{compressor.compress('-', output_file)}"
+      self
+    end
+
+    def download(local_file = "#{output_file}")
+      @cap.download! dump_file_path, local_file
+    end
+
+    def clean_dump_if_needed
+      if @cap.fetch(:db_remote_clean)
+        @cap.execute "rm -f #{dump_file_path}"
+      else
+        @cap.info "leaving #{dump_file_path} on the server (add \"set :db_remote_clean, true\" to deploy.rb to remove)"
+      end
+    end
+
+    # cleanup = true removes the mysqldump file after loading, false leaves it in db/
+    def load(file, cleanup)
+      unzip_file = File.join(File.dirname(file), File.basename(file, ".#{compressor.file_extension}"))
+      # @cap.run "cd #{@cap.current_path} && bunzip2 -f #{file} && RAILS_ENV=#{@cap.rails_env} bundle exec rake db:drop db:create && #{import_cmd(unzip_file)}"
+      @cap.execute "cd #{@cap.current_path} && #{compressor.decompress(file)} && RAILS_ENV=#{@cap.fetch(:rails_env)} && #{import_cmd(unzip_file)}"
+      @cap.execute("cd #{@cap.current_path} && rm #{unzip_file}") if cleanup
+    end
+
+    private
+
+    def dump_file_path
+      "#{@cap.current_path}/#{output_file}"
+    end
+  end
+
+  class Local < Base
+    def initialize(cap_instance)
+      super(cap_instance)
+      @cap.info "Loading local database config"
+      command = "#{Dir.pwd}/bin/rails runner \"puts '#{DBCONFIG_BEGIN_FLAG}' + ActiveRecord::Base.connection.instance_variable_get(:@config).to_yaml + '#{DBCONFIG_END_FLAG}'\""
+      stdout, status = Open3.capture2(command)
+      raise "Error running command (status=#{status}): #{command}" if status != 0
+
+      config_content = stdout.match(/#{DBCONFIG_BEGIN_FLAG}(.*?)#{DBCONFIG_END_FLAG}/m)[1]
+      @config = YAML.load(config_content).each_with_object({}) { |(k, v), h| h[k.to_s] = v }
+    end
+
+    # cleanup = true removes the mysqldump file after loading, false leaves it in db/
+    def load(file, cleanup)
+      unzip_file = File.join(File.dirname(file), File.basename(file, ".#{compressor.file_extension}"))
+      @cap.info "executing local: #{compressor.decompress(file)} && #{import_cmd(unzip_file)}"
+      execute("#{compressor.decompress(file)} && #{import_cmd(unzip_file)}")
+      if cleanup
+        @cap.info "removing #{unzip_file}"
+        File.unlink(unzip_file)
+      else
+        @cap.info "leaving #{unzip_file} (specify :db_local_clean in deploy.rb to remove)"
+      end
+      @cap.info "Completed database import"
+    end
+
+    def dump
+      execute "#{dump_cmd} | #{compressor.compress('-', output_file)}"
+      self
+    end
+
+    def upload
+      remote_file = "#{@cap.current_path}/#{output_file}"
+      @cap.upload! output_file, remote_file
+    end
+
+    private
+
+    def execute(cmd)
+      result = system cmd
+      @cap.error "Failed to execute the local command: #{cmd}" unless result
+      result
+    end
+  end
+
+  class << self
+    def check(local_db, remote_db)
+      raise 'Only mysql or postgresql on remote and local server is supported' unless (local_db.mysql? && remote_db.mysql?) || (local_db.postgresql? && remote_db.postgresql?)
+    end
+
+    def remote_to_local(instance)
+      local_db  = Database::Local.new(instance)
+      remote_db = Database::Remote.new(instance)
+
+      check(local_db, remote_db)
+
+      begin
+        remote_db.dump.download
+      ensure
+        remote_db.clean_dump_if_needed
+      end
+      local_db.load(remote_db.output_file, instance.fetch(:db_local_clean))
+    end
+
+    def local_to_remote(instance)
+      local_db  = Database::Local.new(instance)
+      remote_db = Database::Remote.new(instance)
+
+      check(local_db, remote_db)
+
+      local_db.dump.upload
+      remote_db.load(local_db.output_file, instance.fetch(:db_local_clean))
+      File.unlink(local_db.output_file) if instance.fetch(:db_local_clean)
+    end
+  end
+end

data/lib/capistrano-db-tasks/dbtasks.rb

@@ -1,120 +1,124 @@
-require File.expand_path("#{File.dirname(__FILE__)}/util")
-require File.expand_path("#{File.dirname(__FILE__)}/database")
-require File.expand_path("#{File.dirname(__FILE__)}/asset")
-
-set :local_rails_env, ENV['RAILS_ENV'] || 'development' unless fetch(:local_rails_env)
-set :rails_env, fetch(:stage) || 'production' unless fetch(:rails_env)
-set :db_local_clean, false unless fetch(:db_local_clean)
-set :assets_dir, 'system' unless fetch(:assets_dir)
-set :local_assets_dir, 'public' unless fetch(:local_assets_dir)
-set :skip_data_sync_confirm, (ENV['SKIP_DATA_SYNC_CONFIRM'].to_s.downcase == 'true')
-set :disallow_pushing, false unless fetch(:disallow_pushing)
-
-namespace :capistrano_db_tasks do
-  task :check_can_push do
-    raise "pushing is disabled, set disallow_pushing to false to carry out this operation" if fetch(:disallow_pushing)
-  end
-end
-
-namespace :db do
-  namespace :remote do
-    desc 'Synchronize your remote database using local database data'
-    task :sync => 'capistrano_db_tasks:check_can_push' do
-      on roles(:db) do
-        if fetch(:skip_data_sync_confirm) || Util.prompt('Are you sure you want to REPLACE THE REMOTE DATABASE with local database')
-          Database.local_to_remote(self)
-        end
-      end
-    end
-  end
-
-  namespace :local do
-    desc 'Synchronize your local database using remote database data'
-    task :sync do
-      on roles(:db) do
-        puts "Local database: #{Database::Local.new(self).database}"
-        if fetch(:skip_data_sync_confirm) || Util.prompt('Are you sure you want to erase your local database with server database')
-          Database.remote_to_local(self)
-        end
-      end
-    end
-  end
-
-  desc 'Synchronize your local database using remote database data'
-  task :pull => "db:local:sync"
-
-  desc 'Synchronize your remote database using local database data'
-  task :push => "db:remote:sync"
-end
-
-namespace :assets do
-  namespace :remote do
-    desc 'Synchronize your remote assets using local assets'
-    task :sync => 'capistrano_db_tasks:check_can_push' do
-      on roles(:app) do
-        puts "Assets directories: #{fetch(:assets_dir)}"
-        if fetch(:skip_data_sync_confirm) || Util.prompt("Are you sure you want to erase your server assets with local assets")
-          Asset.local_to_remote(self)
-        end
-      end
-    end
-  end
-
-  namespace :local do
-    desc 'Synchronize your local assets using remote assets'
-    task :sync do
-      on roles(:app) do
-        puts "Assets directories: #{fetch(:local_assets_dir)}"
-        if fetch(:skip_data_sync_confirm) || Util.prompt("Are you sure you want to erase your local assets with server assets")
-          Asset.remote_to_local(self)
-        end
-      end
-    end
-  end
-
-  desc 'Synchronize your local assets using remote assets'
-  task :pull => "assets:local:sync"
-
-  desc 'Synchronize your remote assets using local assets'
-  task :push => "assets:remote:sync"
-end
-
-namespace :app do
-  namespace :remote do
-    desc 'Synchronize your remote assets AND database using local assets and database'
-    task :sync => 'capistrano_db_tasks:check_can_push' do
-      if fetch(:skip_data_sync_confirm) || Util.prompt("Are you sure you want to REPLACE THE REMOTE DATABASE AND your remote assets with local database and assets(#{fetch(:assets_dir)})")
-        on roles(:db) do
-          Database.local_to_remote(self)
-        end
-
-        on roles(:app) do
-          Asset.local_to_remote(self)
-        end
-      end
-    end
-  end
-
-  namespace :local do
-    desc 'Synchronize your local assets AND database using remote assets and database'
-    task :sync do
-      puts "Local database     : #{Database::Local.new(self).database}"
-      puts "Assets directories : #{fetch(:local_assets_dir)}"
-      if fetch(:skip_data_sync_confirm) || Util.prompt("Are you sure you want to erase your local database AND your local assets with server database and assets(#{fetch(:assets_dir)})")
-        on roles(:db) do
-          Database.remote_to_local(self)
-        end
-
-        on roles(:app) do
-          Asset.remote_to_local(self)
-        end
-      end
-    end
-  end
-
-  desc 'Synchronize your local assets AND database using remote assets and database'
-  task :pull => "app:local:sync"
-
-  desc 'Synchronize your remote assets AND database using local assets and database'
-  task :push => "app:remote:sync"
-end
+require File.expand_path("#{File.dirname(__FILE__)}/util")
+require File.expand_path("#{File.dirname(__FILE__)}/database")
+require File.expand_path("#{File.dirname(__FILE__)}/asset")
+require File.expand_path("#{File.dirname(__FILE__)}/compressors/base")
+require File.expand_path("#{File.dirname(__FILE__)}/compressors/bzip2")
+require File.expand_path("#{File.dirname(__FILE__)}/compressors/gzip")
+
+set :local_rails_env, ENV['RAILS_ENV'] || 'development' unless fetch(:local_rails_env)
+set :rails_env, fetch(:stage) || 'production' unless fetch(:rails_env)
+set :db_local_clean, false unless fetch(:db_local_clean)
+set :assets_dir, 'system' unless fetch(:assets_dir)
+set :local_assets_dir, 'public' unless fetch(:local_assets_dir)
+set :skip_data_sync_confirm, ENV['SKIP_DATA_SYNC_CONFIRM'].to_s.casecmp('true').zero?
+set :disallow_pushing, false unless fetch(:disallow_pushing)
+set :compressor, :gzip unless fetch(:compressor)
+
+namespace :capistrano_db_tasks do
+  task :check_can_push do
+    raise "pushing is disabled, set disallow_pushing to false to carry out this operation" if fetch(:disallow_pushing)
+  end
+end
+
+namespace :db do
+  namespace :remote do
+    desc 'Synchronize your remote database using local database data'
+    task :sync => 'capistrano_db_tasks:check_can_push' do
+      on roles(:db) do
+        if fetch(:skip_data_sync_confirm) || Util.prompt('Are you sure you want to REPLACE THE REMOTE DATABASE with local database')
+          Database.local_to_remote(self)
+        end
+      end
+    end
+  end
+
+  namespace :local do
+    desc 'Synchronize your local database using remote database data'
+    task :sync do
+      on roles(:db) do
+        puts "Local database: #{Database::Local.new(self).database}"
+        if fetch(:skip_data_sync_confirm) || Util.prompt('Are you sure you want to erase your local database with server database')
+          Database.remote_to_local(self)
+        end
+      end
+    end
+  end
+
+  desc 'Synchronize your local database using remote database data'
+  task :pull => "db:local:sync"
+
+  desc 'Synchronize your remote database using local database data'
+  task :push => "db:remote:sync"
+end
+
+namespace :assets do
+  namespace :remote do
+    desc 'Synchronize your remote assets using local assets'
+    task :sync => 'capistrano_db_tasks:check_can_push' do
+      on roles(:app) do
+        puts "Assets directories: #{fetch(:assets_dir)}"
+        if fetch(:skip_data_sync_confirm) || Util.prompt("Are you sure you want to erase your server assets with local assets")
+          Asset.local_to_remote(self)
+        end
+      end
+    end
+  end
+
+  namespace :local do
+    desc 'Synchronize your local assets using remote assets'
+    task :sync do
+      on roles(:app) do
+        puts "Assets directories: #{fetch(:local_assets_dir)}"
+        if fetch(:skip_data_sync_confirm) || Util.prompt("Are you sure you want to erase your local assets with server assets")
+          Asset.remote_to_local(self)
+        end
+      end
+    end
+  end
+
+  desc 'Synchronize your local assets using remote assets'
+  task :pull => "assets:local:sync"
+
+  desc 'Synchronize your remote assets using local assets'
+  task :push => "assets:remote:sync"
+end
+
+namespace :app do
+  namespace :remote do
+    desc 'Synchronize your remote assets AND database using local assets and database'
+    task :sync => 'capistrano_db_tasks:check_can_push' do
+      if fetch(:skip_data_sync_confirm) || Util.prompt("Are you sure you want to REPLACE THE REMOTE DATABASE AND your remote assets with local database and assets(#{fetch(:assets_dir)})")
+        on roles(:db) do
+          Database.local_to_remote(self)
+        end
+
+        on roles(:app) do
+          Asset.local_to_remote(self)
+        end
+      end
+    end
+  end
+
+  namespace :local do
+    desc 'Synchronize your local assets AND database using remote assets and database'
+    task :sync do
+      puts "Local database     : #{Database::Local.new(self).database}"
+      puts "Assets directories : #{fetch(:local_assets_dir)}"
+      if fetch(:skip_data_sync_confirm) || Util.prompt("Are you sure you want to erase your local database AND your local assets with server database and assets(#{fetch(:assets_dir)})")
+        on roles(:db) do
+          Database.remote_to_local(self)
+        end
+
+        on roles(:app) do
+          Asset.remote_to_local(self)
+        end
+      end
+    end
+  end
+
+  desc 'Synchronize your local assets AND database using remote assets and database'
+  task :pull => "app:local:sync"
+
+  desc 'Synchronize your remote assets AND database using local assets and database'
+  task :push => "app:remote:sync"
+end

data/lib/capistrano-db-tasks/util.rb

@@ -1,6 +1,6 @@
 module Util
   def self.prompt(msg, prompt = "(y)es, (n)o ")
     ask(:answer, "#{msg} #{prompt} ? ")
-    (fetch(:answer) =~ /^y$|^yes$/i) == 0
+    (fetch(:answer) =~ /^y$|^yes$/i).zero?
   end
 end

data/lib/capistrano-db-tasks/version.rb

@@ -1,3 +1,3 @@
 module CapistranoDbTasks
-  VERSION = "0.4"
+  VERSION = "0.5".freeze
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-db-tasks
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Sebastien Gruhier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 description: A collection of capistrano tasks for syncing assets and databases
@@ -31,13 +31,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .editorconfig
+- .gitignore
+- .rubocop.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
-- README.markdown
+- README.md
 - Rakefile
 - capistrano-db-tasks.gemspec
 - lib/capistrano-db-tasks.rb
 - lib/capistrano-db-tasks/asset.rb
+- lib/capistrano-db-tasks/compressors/base.rb
+- lib/capistrano-db-tasks/compressors/bzip2.rb
+- lib/capistrano-db-tasks/compressors/gzip.rb
 - lib/capistrano-db-tasks/database.rb
 - lib/capistrano-db-tasks/dbtasks.rb
 - lib/capistrano-db-tasks/util.rb
@@ -45,7 +52,8 @@ files:
 - test/capistrano_db_tasks_test.rb
 - test/test_helper.rb
 homepage: https://github.com/sgruhier/capistrano-db-tasks
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -53,17 +61,17 @@ 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: capistrano-db-tasks
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: A collection of capistrano tasks for syncing assets and databases

data/README.markdown

@@ -1,92 +0,0 @@
-CapistranoDbTasks
-=================
-
-Add database AND assets tasks to capistrano to a Rails project.
-It only works with capistrano 3. Older versions until 0.3 works with capistrano 2.
-
-Currently
-
-* It only supports mysql and postgresql (both side remote and local)
-* Synchronize assets remote to local and local to remote
-
-Commands mysql, mysqldump (or pg_dump, psql), bzip2 and unbzip2 must be in your PATH
-
-Feel free to fork and to add more database support or new tasks.
-
-Install
-=======
-
-Add it as a gem:
-
-```ruby
-    gem "capistrano-db-tasks", require: false
-```
-
-Add to config/deploy.rb:
-
-```ruby
-    require 'capistrano-db-tasks'
-
-    # if you haven't already specified
-    set :rails_env, "production"
-
-    # if you want to remove the local dump file after loading
-    set :db_local_clean, true
-
-    # if you want to remove the dump file from the server after downloading
-    set :db_remote_clean, true
-
-    # If you want to import assets, you can change default asset dir (default = system)
-    # This directory must be in your shared directory on the server
-    set :assets_dir, %w(public/assets public/att)
-    set :local_assets_dir, %w(public/assets public/att)
-
-    # if you want to work on a specific local environment (default = ENV['RAILS_ENV'] || 'development')
-    set :locals_rails_env, "production"
-
-    # if you are highly paranoid and want to prevent any push operation to the server
-    set :disallow_pushing, true
-```
-
-Add to .gitignore
-```yml
-    /db/*.sql
-```
-
-
-[How to install bzip2 on Windows](http://stackoverflow.com/a/25625988/3324219)
-
-Available tasks
-===============
-
-    app:local:sync      || app:pull     # Synchronize your local assets AND database using remote assets and database
-    app:remote:sync     || app:push     # Synchronize your remote assets AND database using local assets and database
-
-    assets:local:sync   || assets:pull  # Synchronize your local assets using remote assets
-    assets:remote:sync  || assets:push  # Synchronize your remote assets using local assets
-
-    db:local:sync       || db:pull      # Synchronize your local database using remote database data
-    db:remote:sync      || db:push      # Synchronize your remote database using local database data
-
-Example
-=======
-
-    cap db:pull
-    cap production db:pull # if you are using capistrano-ext to have multistages
-
-
-Contributors
-============
-
-* tilsammans (http://github.com/tilsammansee)
-* bigfive    (http://github.com/bigfive)
-* jakemauer  (http://github.com/jakemauer)
-* tjoneseng  (http://github.com/tjoneseng)
-
-TODO
-====
-
-* May be change project's name as it's not only database tasks now :)
-* Add tests
-
-Copyright (c) 2009 [Sébastien Gruhier - XILINUS], released under the MIT license