Merge pull request #401 from aubergene/transfer_summarizer

Add option to specify transfer log percentage

Author: mattbrictson

CHANGELOG.md

@@ -6,6 +6,7 @@ appear at the top.
 ## [Unreleased][]
 
   * Your contribution here!
+  * [#401](https://github.com/capistrano/sshkit/pull/401): Add :log_percent option to specify upload!/download! transfer log percentage - [@aubergene](https://github.com/aubergene)
 
 ## [1.13.1][] (2017-03-31)
 

README.md

@@ -72,7 +72,7 @@ For the remote backend, the file is tranferred with scp.
 ```ruby
 on '1.example.com' do
   upload! 'some_local_file.txt', '/home/some_user/somewhere'
-  download! '/home/some_user/some_remote_file.txt', 'somewhere_local'
+  download! '/home/some_user/some_remote_file.txt', 'somewhere_local', :log_percent 25
 end
 ```
 

lib/sshkit/backends/netssh.rb

@@ -62,14 +62,14 @@ def assign_defaults
       end
 
       def upload!(local, remote, options = {})
-        summarizer = transfer_summarizer('Uploading')
+        summarizer = transfer_summarizer('Uploading', options)
         with_ssh do |ssh|
           ssh.scp.upload!(local, remote, options, &summarizer)
         end
       end
 
       def download!(remote, local=nil, options = {})
-        summarizer = transfer_summarizer('Downloading')
+        summarizer = transfer_summarizer('Downloading', options)
         with_ssh do |ssh|
           ssh.scp.download!(remote, local, options, &summarizer)
         end
@@ -96,14 +96,16 @@ def config
 
       private
 
-      def transfer_summarizer(action)
+      def transfer_summarizer(action, options = {})
+        log_percent = options[:log_percent] || 10
+        log_percent = 100 if log_percent <= 0
         last_name = nil
         last_percentage = nil
         proc do |_ch, name, transferred, total|
           percentage = (transferred.to_f * 100 / total.to_f)
           unless percentage.nan?
             message = "#{action} #{name} #{percentage.round(2)}%"
-            percentage_r = (percentage / 10).truncate * 10
+            percentage_r = (percentage / log_percent).truncate * log_percent
             if percentage_r > 0 && (last_name != name || last_percentage != percentage_r)
               info message
               last_name = name