dump 1.0.4 → 1.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGMzMDVmMTc4YzIyN2IyMjBhMTlhODM1NjdlMzIxMjYzNTc5M2EwNg==
+    MzE3NmQ3MTRjN2QwOWJlMGNkMTMzNWZjMDcxOTQ5ZGNjYzBkYzJhZg==
   data.tar.gz: !binary |-
-    ZmEwODViYTNjMzcxOWM3N2E1YzY2NmQ5MDQ1YTJjM2RlMzFkZWZhZA==
+    NzFjNTA5MjgzOTEzMzczMjg4ZDYzYTg5NWVhZDRjN2Y3OTIzZWNiNg==
 SHA512:
   metadata.gz: !binary |-
-    MDZhMGNjY2JjODcwOGI1ZmFjMjJiYWIyYWJmMjkwYzVmZDE3NDU3N2ZhZDBi
-    NTE1OWJmM2VjNjYxNDNiYTBmZTIxMzk1ZGU4MjMwNDkxMTJlM2YwNDcxNTE5
-    YzI1YjY3ZWM3ZjY5M2Q3OTg3NjIzNWQ3YjAxOTg0ZTA4MDRkMDk=
+    MjkyOWRmMTZmMGVlNDNlZjUzYzAwMzdkZjAyNWE1MmIyZGQ2MzVmZTMxMjgy
+    MzY1OTBkZTA0ZWIxNTZlMmU1NTE5YTA3MDZkMjM3MjBjNzM3ZWViZGI1Y2U2
+    MDAwNTg4MmE2MzE5YzMwMGY3NDlkMWU2MjY0ZmQyMjkxZjE1OGM=
   data.tar.gz: !binary |-
-    Yzc5NzZkYjk3MzlmMWNmYjk0NTYwMTM2ZTEyMWZlMWYzOWJhYTQxYjY5Yzlm
-    OGJkZDRjOTAwOTBkMWM5ZWM2NzdkYjgwY2I2NWQ0NGM0OTUyNzU3ZmIzYTYx
-    ZjYwNWNkMTVkZTg3ODhlZTg0ZjVlZjRlMmM0YjZmYWM0NzZmNjc=
+    ZTQ0ZmVmOWQ0YzVkNzcyMDdiYzQ4ZDI0YTY0YmYzNjczMjlmNDM3ZDBiZDdm
+    YzAzNWI4ODI0OWUzZTE1MGRlMmQ2NWUxYWI2ZWZiMjcyMzY5YzA1OTYwM2Qw
+    YzVmMDc5MzA2NzQ3OTc1NjM4MGYzYTE5ZTczMzc1ZDY1ZWY1ZGQ=

data/.rubocop.yml

@@ -0,0 +1,53 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/dummy-*/**/*'
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/IfUnlessModifier:
+  MaxLineLength: 40
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+    '%W': '[]'
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma

data/.rubocop_todo.yml

@@ -0,0 +1,33 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-12-08 02:47:19 +0100 using RuboCop version 0.27.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 19
+Metrics/AbcSize:
+  Max: 45
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 226
+
+# Offense count: 6
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+# Offense count: 386
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 209
+
+# Offense count: 28
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 47
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 15

data/.travis.yml

@@ -12,7 +12,12 @@ env:
   - RAILS_VERSION='~> 3.2.0'
   - RAILS_VERSION='~> 4.0.0'
   - RAILS_VERSION='~> 4.1.0'
-script: "bundle exec rspec"
+script:
+  if [ -n "$RUBOCOP" ]; then
+    bundle exec rubocop
+  ; else
+    bundle exec rspec
+  ; fi
 before_install:
   - sudo /etc/init.d/postgresql stop
   - sudo /etc/init.d/postgresql start
@@ -20,8 +25,10 @@ before_install:
   - psql -c 'create database myapp_test;' -U postgres
   - cp .travis.database.yml spec/db/database.yml
 matrix:
-  allow_failures:
-    - rvm: jruby-19mode
+  fast_finish: true
+  include:
+    - env: RUBOCOP=true
+      rvm: default
   exclude:
     - rvm: 1.8.7 # not supported by rails 4
       env: RAILS_VERSION='~> 4.0.0'
@@ -31,3 +38,5 @@ matrix:
       env: RAILS_VERSION='~> 2.3.0'
     - rvm: 2.1.0
       env: RAILS_VERSION='~> 2.3.0'
+  allow_failures:
+    - rvm: jruby-19mode

data/README.markdown

@@ -249,6 +249,14 @@ restore backup (upload dump and restore on remote):
 
     cap dump:backup:restore
 
+#### If you have separate db server
+
+by default, dump's capistrano tasks use remote server with role :db, :primary => true. If you have separate db server, and want to use dump with assets, you should run cap tasks as following:
+
+    cap dump:mirror:down HOSTS=myappserver.com
+
+where myappserver.com is application server carrying assets with database access.
+
 ## Copyright
 
 Copyright (c) 2008-2014 Ivan Kuchin. See LICENSE.txt for details.

data/dump.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'dump'
-  s.version     = '1.0.4'
+  s.version     = '1.0.5'
   s.summary     = %q{Rails app rake and capistrano tasks to create and restore dumps of database and assets}
   s.homepage    = "http://github.com/toy/#{s.name}"
   s.authors     = ['Ivan Kuchin']
@@ -18,4 +18,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'archive-tar-minitar', '= 0.5.2'
   s.add_dependency 'progress', '~> 2.4.0'
   s.add_development_dependency 'rspec', '~> 3.0'
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9.3')
+    s.add_development_dependency 'rubocop', '~> 0.27'
+  end
 end

data/lib/dump.rb

@@ -1,3 +1,4 @@
+# Namespace for railtie
 module Dump
   require 'dump/railtie' if defined?(Rails)
 end

data/lib/dump/capistrano.rb

@@ -1 +1,7 @@
-require File.join(File.dirname(__FILE__), '../../recipes/dump.rb')
+require 'capistrano/version'
+
+if defined?(Capistrano::Version) && Capistrano::Version::MAJOR == 2
+  require 'dump/capistrano/v2'
+else
+  fail 'Capistrano 3 is not yet supported'
+end

data/lib/dump/capistrano/v2.rb

@@ -0,0 +1,331 @@
+# encoding: UTF-8
+
+require 'fileutils'
+require 'shellwords'
+
+require 'dump_rake/continious_timeout'
+require 'dump_rake/env'
+
+require 'active_support/core_ext/object/blank'
+
+require 'English'
+
+Capistrano::Configuration.instance(:i_need_this!).load do
+  namespace :dump do
+    def dump_command(command, env = {})
+      rake = env.delete(:rake) || 'rake'
+
+      # stringify_keys! from activesupport
+      DumpRake::Env.stringify!(env)
+
+      env.update(DumpRake::Env.for_command(command, true))
+
+      cmd = %W[-s dump:#{command}]
+      cmd += env.sort.map{ |key, value| "#{key}=#{value}" }
+      "#{rake} #{cmd.shelljoin}"
+    end
+
+    def fetch_rails_env
+      fetch(:rails_env, 'production')
+    end
+
+    def got_rsync?
+      `which rsync`
+      $CHILD_STATUS.success?
+    end
+
+    def do_transfer_via(via, direction, from, to)
+      case via
+      when :rsync
+        if run_local('which rsync').present? && $CHILD_STATUS.success?
+          execute_on_servers do |servers|
+            commands = servers.map do |server|
+              target = sessions[server]
+              user = target.options[:user] || fetch(:user, nil)
+              host = target.host
+              port = target.options[:port]
+              full_host = "#{"#{user}@" if user.present?}#{host}"
+
+              ssh = port.present? ? "ssh -p #{port}" : 'ssh'
+              cmd = %W[rsync -P -e #{ssh} --timeout=15]
+              case direction
+              when :up
+                cmd << from << "#{full_host}:#{to}"
+              when :down
+                cmd << "#{full_host}:#{from}" << to
+              else
+                fail "Don't know how to transfer in direction #{direction}"
+              end
+              cmd.shelljoin
+            end
+            commands.each do |cmd|
+              logger.info cmd if logger
+
+              3.times do
+                break if system(cmd)
+                break unless [10, 11, 12, 23, 30, 35].include?($CHILD_STATUS.exitstatus)
+              end
+              fail "rsync returned #{$CHILD_STATUS.exitstatus}" unless $CHILD_STATUS.success?
+            end
+          end
+        end
+      when :sftp, :scp
+        DumpRake::ContiniousTimeout.timeout 15 do |thread|
+          transfer(direction, from, to, :via => via) do |_channel, _path, transfered, total|
+            thread.defer
+            progress = if transfered < total
+              format("\e[1m%5.1f%%\e[0m", transfered * 100.0 / total)
+            else
+              '100%'
+            end
+            $stderr << "\rTransfering: #{progress}"
+          end
+        end
+      else
+        fail "Unknown transfer method #{via}"
+      end
+    end
+
+    def do_transfer(direction, from, to)
+      via = DumpRake::Env[:transfer_via]
+      case via && via.downcase
+      when nil
+        if got_rsync?
+          do_transfer_via(:rsync, direction, from, to)
+        else
+          $stderr.puts 'To transfer using rsync — make rsync binary accessible and verify that remote host can work with rsync through ssh'
+          begin
+            do_transfer_via(:sftp, direction, from, to)
+          rescue => e
+            $stderr.puts e
+            do_transfer_via(:scp, direction, from, to)
+          end
+        end
+      when 'rsync'
+        do_transfer_via(:rsync, direction, from, to)
+      when 'sftp'
+        do_transfer_via(:sftp, direction, from, to)
+      when 'scp'
+        do_transfer_via(:scp, direction, from, to)
+      else
+        fail "Unknown transfer method #{via}"
+      end
+    end
+
+    def with_additional_tags(*tags)
+      tags = [tags, DumpRake::Env[:tags]].flatten.select(&:present?).join(',')
+      DumpRake::Env.with_env(:tags => tags) do
+        yield
+      end
+    end
+
+    def print_and_return_or_fail
+      out = yield
+      fail 'Failed creating dump' if out.blank?
+      print out
+      out.strip
+    end
+
+    def run_local(cmd)
+      `#{cmd}`
+    end
+
+    def run_remote(cmd)
+      output = ''
+      run(cmd) do |_channel, io, data|
+        case io
+        when :out
+          output << data
+        when :err
+          $stderr << data
+        end
+      end
+      output
+    end
+
+    def last_part_of_last_line(out)
+      line = out.strip.split(/\s*[\n\r]\s*/).last
+      line.split("\t").last if line
+    end
+
+    def fetch_rake
+      fetch(:rake, nil)
+    end
+
+    def auto_backup?
+      !DumpRake::Env.no?(:backup)
+    end
+
+    namespace :local do
+      desc 'Shorthand for dump:local:create' << DumpRake::Env.explain_variables_for_command(:create)
+      task :default, :roles => :db, :only => {:primary => true} do
+        local.create
+      end
+
+      desc 'Create local dump' << DumpRake::Env.explain_variables_for_command(:create)
+      task :create, :roles => :db, :only => {:primary => true} do
+        print_and_return_or_fail do
+          with_additional_tags('local') do
+            run_local(dump_command(:create))
+          end
+        end
+      end
+
+      desc 'Restore local dump' << DumpRake::Env.explain_variables_for_command(:restore)
+      task :restore, :roles => :db, :only => {:primary => true} do
+        run_local(dump_command(:restore))
+      end
+
+      desc 'Versions of local dumps' << DumpRake::Env.explain_variables_for_command(:versions)
+      task :versions, :roles => :db, :only => {:primary => true} do
+        print run_local(dump_command(:versions, :show_size => true))
+      end
+
+      desc 'Cleanup local dumps' << DumpRake::Env.explain_variables_for_command(:cleanup)
+      task :cleanup, :roles => :db, :only => {:primary => true} do
+        print run_local(dump_command(:cleanup))
+      end
+
+      desc 'Upload dump' << DumpRake::Env.explain_variables_for_command(:transfer)
+      task :upload, :roles => :db, :only => {:primary => true} do
+        file = DumpRake::Env.with_env(:summary => nil) do
+          last_part_of_last_line(run_local(dump_command(:versions)))
+        end
+        if file
+          do_transfer :up, "dump/#{file}", "#{current_path}/dump/#{file}"
+        end
+      end
+    end
+
+    namespace :remote do
+      desc 'Shorthand for dump:remote:create' << DumpRake::Env.explain_variables_for_command(:create)
+      task :default, :roles => :db, :only => {:primary => true} do
+        remote.create
+      end
+
+      desc 'Create remote dump' << DumpRake::Env.explain_variables_for_command(:create)
+      task :create, :roles => :db, :only => {:primary => true} do
+        print_and_return_or_fail do
+          with_additional_tags('remote') do
+            run_remote("cd #{current_path}; #{dump_command(:create, :rake => fetch_rake, :RAILS_ENV => fetch_rails_env, :PROGRESS_TTY => '+')}")
+          end
+        end
+      end
+
+      desc 'Restore remote dump' << DumpRake::Env.explain_variables_for_command(:restore)
+      task :restore, :roles => :db, :only => {:primary => true} do
+        run_remote("cd #{current_path}; #{dump_command(:restore, :rake => fetch_rake, :RAILS_ENV => fetch_rails_env, :PROGRESS_TTY => '+')}")
+      end
+
+      desc 'Versions of remote dumps' << DumpRake::Env.explain_variables_for_command(:versions)
+      task :versions, :roles => :db, :only => {:primary => true} do
+        print run_remote("cd #{current_path}; #{dump_command(:versions, :rake => fetch_rake, :RAILS_ENV => fetch_rails_env, :PROGRESS_TTY => '+', :show_size => true)}")
+      end
+
+      desc 'Cleanup of remote dumps' << DumpRake::Env.explain_variables_for_command(:cleanup)
+      task :cleanup, :roles => :db, :only => {:primary => true} do
+        print run_remote("cd #{current_path}; #{dump_command(:cleanup, :rake => fetch_rake, :RAILS_ENV => fetch_rails_env, :PROGRESS_TTY => '+')}")
+      end
+
+      desc 'Download dump' << DumpRake::Env.explain_variables_for_command(:transfer)
+      task :download, :roles => :db, :only => {:primary => true} do
+        file = DumpRake::Env.with_env(:summary => nil) do
+          last_part_of_last_line(run_remote("cd #{current_path}; #{dump_command(:versions, :rake => fetch_rake, :RAILS_ENV => fetch_rails_env, :PROGRESS_TTY => '+')}"))
+        end
+        if file
+          FileUtils.mkpath('dump')
+          do_transfer :down, "#{current_path}/dump/#{file}", "dump/#{file}"
+        end
+      end
+    end
+
+    desc 'Shorthand for dump:local:upload' << DumpRake::Env.explain_variables_for_command(:transfer)
+    task :upload, :roles => :db, :only => {:primary => true} do
+      local.upload
+    end
+
+    desc 'Shorthand for dump:remote:download' << DumpRake::Env.explain_variables_for_command(:transfer)
+    task :download, :roles => :db, :only => {:primary => true} do
+      remote.download
+    end
+
+    namespace :mirror do
+      desc 'Creates local dump, uploads and restores on remote' << DumpRake::Env.explain_variables_for_command(:mirror)
+      task :up, :roles => :db, :only => {:primary => true} do
+        auto_backup = if auto_backup?
+          with_additional_tags('auto-backup') do
+            remote.create
+          end
+        end
+        if !auto_backup? || auto_backup.present?
+          file = with_additional_tags('mirror') do
+            local.create
+          end
+          if file.present?
+            DumpRake::Env.with_clean_env(:like => file) do
+              local.upload
+              remote.restore
+            end
+          end
+        end
+      end
+
+      desc 'Creates remote dump, downloads and restores on local' << DumpRake::Env.explain_variables_for_command(:mirror)
+      task :down, :roles => :db, :only => {:primary => true} do
+        auto_backup = if auto_backup?
+          with_additional_tags('auto-backup') do
+            local.create
+          end
+        end
+        if !auto_backup? || auto_backup.present?
+          file = with_additional_tags('mirror') do
+            remote.create
+          end
+          if file.present?
+            DumpRake::Env.with_clean_env(:like => file) do
+              remote.download
+              local.restore
+            end
+          end
+        end
+      end
+    end
+
+    namespace :backup do
+      desc 'Shorthand for dump:backup:create' << DumpRake::Env.explain_variables_for_command(:backup)
+      task :default, :roles => :db, :only => {:primary => true} do
+        backup.create
+      end
+
+      desc "Creates remote dump and downloads to local (desc defaults to 'backup')" << DumpRake::Env.explain_variables_for_command(:backup)
+      task :create, :roles => :db, :only => {:primary => true} do
+        file = with_additional_tags('backup') do
+          remote.create
+        end
+        if file.present?
+          DumpRake::Env.with_clean_env(:like => file) do
+            remote.download
+          end
+        end
+      end
+
+      desc 'Uploads dump with backup tag and restores it on remote' << DumpRake::Env.explain_variables_for_command(:backup_restore)
+      task :restore, :roles => :db, :only => {:primary => true} do
+        file = with_additional_tags('backup') do
+          last_part_of_last_line(run_local(dump_command(:versions)))
+        end
+        if file.present?
+          DumpRake::Env.with_clean_env(:like => file) do
+            local.upload
+            remote.restore
+          end
+        end
+      end
+    end
+  end
+
+  after 'deploy:update_code' do
+    from, to = %W[#{shared_path}/dump #{release_path}/dump]
+    run "mkdir -p #{from}; rm -rf #{to}; ln -s #{from} #{to}"
+  end
+end