capistrano-syncfiles 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1177558c37d50af39fefd640b3fef6b01d5d95b2
-  data.tar.gz: d1616acee6018b4001875964df9a9db4172ba304
+  metadata.gz: c24da0aad509d6c995486b9def72fa14f8050624
+  data.tar.gz: 627837c3153cc159f213d95ca8f9b859e5db8d11
 SHA512:
-  metadata.gz: 2eb78df5dcfed5fbbcc2966dda1d8e524710f56d764b34c195cb34a493cef5289a5b49f6eb06c1105dc4c4f063d97c0f86fd3c2cc764e5d78297b4224e81dc18
-  data.tar.gz: cb00e0c3907fd997e327ab85c5a19fd21e23cae3c002182e9e44bda464b1b3e9ef0a527f3bb74e481c05c1d24b9954b81c5a6881df29ebfb15adaf705dbdca77
+  metadata.gz: 49e3b3950af263136238dc78ac5ea3a4221272e8729b27af10a0d3aa4d9775550c3205788ae2837f8d414d9aee3f5066913f019b2c144579b78811f90bc5aef9
+  data.tar.gz: c9d8be34c597105f67aad5530176e62c75b956978335aae0b318b119adf3de6128582c451bb04534b4286ba28b4edca6e59b2ee1c003c82578412035b51c926e

data/README.md

@@ -22,6 +22,7 @@ set :syncfiles, {
       exclude: ['fvm', 'ithemes-security', 'wc-logs']     # excluded folders/files, based on local path, works also for remote
   }
 }
+set :syncfiles_rsync_options, '-avzuO'
 
 set :syncfiles_roles, :all  # roles to run on, default: :all
 
@@ -53,8 +54,14 @@ Capistrano tasks: http://capistranorb.com/documentation/getting-started/flow/
 The MIT License (MIT)
 
 ### Changelog
+##### 1.0.0
+  * add `syncfiles_rsync_options` default options
+
+##### 0.3.0
+  * use `current_path` instead of `release_path`
+
 ##### 0.2.0
-- add sftp strategy
+  * add sftp strategy
 
 ##### 0.1.0
-- Initial release
+  * Initial release

data/capistrano-syncfiles.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "capistrano-syncfiles"
-  s.version     = "0.2.0"
+  s.version     = "1.0.0"
   s.licenses    = ["MIT"]
   s.authors     = ["Tom Hanoldt"]
   s.email       = ["tom@creative-workflow.berlin"]

data/lib/capistrano/tasks/syncfiles.rake

@@ -1,6 +1,16 @@
+def get_syncfiles_base_path
+  fetch(:syncfiles_base_path, "#{current_path}/")
+end
+
 namespace :syncfiles do
   tasks = Dir[File.expand_path("syncfiles/*.rake", File.dirname(__FILE__))]
   tasks.each do |task|
     load task
   end
 end
+
+namespace :load do
+  task :defaults do
+    set :syncfiles_rsync_options, '-avzuO'
+  end
+end

data/lib/capistrano/tasks/syncfiles/rsync.rake

@@ -4,7 +4,7 @@ namespace :rsync do
     "#{user}#{role.hostname}"
   end
 
-  desc "Synchronise local and remote wp content folders via rsync"
+  desc "Synchronise from local to remote folder via rsync"
   task :up do
     files = fetch(:syncfiles)
     files.each do |local_path, config|
@@ -16,14 +16,16 @@ namespace :rsync do
       on release_roles sync_roles do |role|
         server = build_server_string(role)
 
-        cmd  = ["rsync -avzO #{local_path}/ #{server}:#{release_path}/#{remote_path}", *exclude_args]
+        args = fetch(:syncfiles_rsync_options)
+        args = args + " --rsync-path='sudo rsync'" if fetch(:use_sudo)
+        cmd  = ["rsync #{args} #{local_path}/ #{server}:#{get_syncfiles_base_path}#{remote_path}", *exclude_args]
         puts cmd.join(' ')
         system cmd.join(' ')
       end
     end
   end
 
-  desc "Synchronise local and remote wp content folders via rsync"
+  desc "Synchronise from remote to local folder via rsync"
   task :down do
     files = fetch(:syncfiles)
     files.each do |local_path, config|
@@ -35,7 +37,10 @@ namespace :rsync do
       on release_roles sync_roles do |role|
         server = build_server_string(role)
 
-        cmd  = ["rsync -avzO #{server}:#{release_path}/#{remote_path}/ #{local_path}", *exclude_args]
+        args = fetch(:syncfiles_rsync_options)
+        args = args + " --rsync-path='sudo rsync'" if fetch(:use_sudo)
+
+        cmd  = ["rsync #{args} #{server}:#{get_syncfiles_base_path}#{remote_path}/ #{local_path}", *exclude_args]
         puts cmd.join(' ')
         system cmd.join(' ')
       end

data/lib/capistrano/tasks/syncfiles/sftp.rake

@@ -1,4 +1,5 @@
 require 'fun_sftp'
+
 namespace :sftp do
   def connection(server, username, password)
     @connection ||= FunSftp::SFTPClient.new(server, username, password)
@@ -16,11 +17,11 @@ namespace :sftp do
     handle.mkdir!(remote_directory)
   end
 
-  desc "Synchronise local and remote wp content folders via sftp"
+  desc "Synchronise from local to remote folder via sftp"
   task :up do
     files = fetch(:syncfiles)
     files.each do |local_path, config|
-      remote_path  = config[:remote]
+      remote_path  = "#{get_syncfiles_base_path}#{config[:remote]}"
       exclude_dir  = Array(config[:exclude])
       exclude_args = exclude_dir.map { |dir| "! -path '#{dir}/*'"}
       sync_roles   = fetch(:syncfiles_roles, :all)
@@ -47,34 +48,34 @@ namespace :sftp do
     end
   end
 
-  desc "Synchronise local and remote wp content folders via sftp"
+  desc "Synchronise from remote to local folder via sftp"
   task :down do
     files = fetch(:syncfiles)
     files.each do |local_path, config|
-      remote_path  = config[:remote]
+      remote_path  = "#{get_syncfiles_base_path}#{config[:remote]}"
       exclude_dir  = Array(config[:exclude])
       sync_roles   = fetch(:syncfiles_roles, :all)
 
       on primary sync_roles do |role|
-          handle = connection(role.hostname, role.user, fetch(:syncfiles_sftp_password))
-
-          puts "collecting files in #{remote_path}"
-          handle.glob(remote_path, "**/*").each do |remote_file|
-
-            remote_file = "#{remote_path}/#{remote_file}"
+        handle = connection(role.hostname, role.user, fetch(:syncfiles_sftp_password))
 
-            local_file = remote_file.sub(remote_path, local_path)
+        puts "collecting files in #{remote_path}"
+        handle.glob(remote_path, "**/*").each do |remote_file|
 
-            next if exclude_dir.any? do |exclude|
-              local_file.start_with?(exclude)
-            end
+          remote_file = "#{remote_path}/#{remote_file}"
 
-            `mkdir -p #{::File.dirname(local_file)}`
+          local_file = remote_file.sub(remote_path, local_path)
 
-            handle.download!(remote_file, local_file)
+          next if exclude_dir.any? do |exclude|
+            local_file.start_with?(exclude)
           end
 
+          `mkdir -p #{::File.dirname(local_file)}`
+
+          handle.download!(remote_file, local_file)
+        end
       end
     end
   end
+
 end

data/lib/capistrano/tasks/syncfiles/tar.rake

@@ -1,5 +1,5 @@
 namespace :tar do
-  desc "Synchronise local and remote wp content folders via rsync"
+  desc "Synchronise from local to remote folder via tar copy"
   task :up do
     files = fetch(:syncfiles)
     files.each do |local_path, config|
@@ -18,14 +18,14 @@ namespace :tar do
 
       on release_roles sync_roles do
         upload!(archive_name, tmp_file)
-        execute :tar, "-xzf", tmp_file, "-C", "#{release_path}/#{remote_path}"
+        execute :tar, "-xzf", tmp_file, "-C", "#{get_syncfiles_base_path}#{remote_path}"
         execute :rm, tmp_file
       end
       system "rm -f #{archive_name}"
     end
   end
 
-  desc "Synchronise local and remote wp content folders via rsync"
+  desc "Synchronise from remote to local folder via tar copy"
   task :down do
     files = fetch(:syncfiles)
     files.each do |local_path, config|
@@ -38,7 +38,7 @@ namespace :tar do
       sync_roles   = fetch(:syncfiles_roles, :all)
 
       on primary sync_roles do
-        execute :tar, "-c#{tar_verbose}zf", tmp_file, "-C", "#{release_path}/#{remote_path} .", *exclude_args
+        execute :tar, "-c#{tar_verbose}zf", tmp_file, "-C", "#{get_syncfiles_base_path}#{remote_path} .", *exclude_args
 
         download!(tmp_file, archive_name)
         execute :rm, tmp_file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-syncfiles
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tom Hanoldt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: This gem provides up and down file syncing with rsync, tar or sftp. This