multisync 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0293de3d6bf07fd58fcaf551c5469aad676d1b51682dcf58a59b85024dbe1f5
-  data.tar.gz: 55170bd7e42c82b2f3e3dcb7c5a9caede2ad53980611f209d7adad2c2a613ffc
+  metadata.gz: 0f5ccf30a0608eca5f17002de411dc941cb90d192c5343863a8b7898d2ab3270
+  data.tar.gz: 94d44b2c52223526c379112fa756249ebc0da3b1a61f77413c70229b95fe4525
 SHA512:
-  metadata.gz: bf970e9e365204d4af64b975ec165ba616f17bcf90fb6e752cf22348dccf8c515d57471ea22b4410bee8a38fa2de08030922835b8d43eac1bcf88c434bd187a5
-  data.tar.gz: 4ce7a0b3dc4d9317883558e2c137c2da63e2ed4c8a9a103dffa6e4d24a3ae74f15af04ac07036f4868dc9e5425b769503d5be514df213035d1d34a0e5ab8b46c
+  metadata.gz: 841ef74fc08150c9c639551a6b7fe84a2f1c941f77cea8cb10dfe56d0447709f8fc5a992afe7b4d217e76d9ab78248ac81f5859b323b1de0c8d25b26cb6c43de
+  data.tar.gz: e77a0e739af5df1530487d035c51ad6c8cc853e6d783a17207d63fae20e2253fe6098b54f5f5cf77c025f8fb48868a337d05c5417f3352176367ac90d9ec6e9f

data/CHANGELOG.md

@@ -0,0 +1,101 @@
+## Release v0.3.7 (2021-10-28)
+
+* Add grand total to summary
+
+
+## Release v0.3.6 (2019-08-20)
+
+* Tweak output when specifing --print and/or --quiet
+
+
+## Release v0.3.5 (2019-08-13)
+
+* Fix option quiet
+* Catch SIGINT and print a summary after an interrupt
+
+
+## Release v0.3.4 (2019-07-23)
+
+* Update help
+* Update readme
+* Update sample file
+
+
+## Release v0.3.3 (2019-07-23)
+
+* Update gem description
+
+
+## Release v0.3.2 (2019-07-23)
+
+* First public release
+
+
+## Release v0.3.1 (2018-06-01)
+
+Changes in DSL
+* removed "desc"
+* "from" accepts a description option
+* "to"" accepts a description option
+* New: "template" and "include"
+
+Changes in CLI
+* New: timeout option
+* New: quiet option
+* polished output
+
+
+## Release v0.2.4 (2017-09-23)
+
+* Fix: check command
+
+
+## Release v0.2.3 (2017-09-23)
+
+* Fix: check remote path
+
+
+## Release v0.2.2 (2017-09-23)
+
+* replaced shell_cmd gem with mixlib-shellout
+* Fix: check path for paths containing spaces
+
+
+## Release v0.2.1 (2017-09-22)
+
+* New: option "check_from" and "check_to" to let check host or path before sync
+* New: "from" and "to" accept an optional check: true|false parameter
+* Change summery output to a more compact tabular form
+* Use rainbow for colorization
+* Move "only_if" checks to runtime
+
+
+## Release v0.2.0 (2016-03-22)
+
+* New: option only_if for preflight checks, prior to sync
+* Command line option -p/--print changed to --show
+
+
+## Release v0.1.2 (2014-08-29)
+
+* Mark default sets with an * when listing
+
+
+## Release v0.1.1 (2014-08-28)
+
+* Add gem dependecy 'text-highlight'
+
+
+## Release v0.1.0 (2014-07-18)
+
+* New: define one or more groups/syncs as default, to run when no sets have been given as args
+
+
+## Release v0.0.2 (2014-07-17)
+
+* Fix: do no escape option strings
+
+
+## Release v0.0.1 (2014-07-11)
+
+* First release

data/Gemfile

@@ -1,5 +1,10 @@
-source 'https://rubygems.org'
-source 'https://gems.patrickmarchi.ch'
+# frozen_string_literal: true
 
-# Specify your gem's dependencies in multisync.gemspec
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gitoc.gemspec
 gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Patrick Marchi
+Copyright (c) 2021 Patrick Marchi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,2 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-task :default => :spec
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -7,8 +7,8 @@ require "multisync"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-require "pry"
-Pry.start
+# require "pry"
+# Pry.start
 
-# require "irb"
-# IRB.start(__FILE__)
+require "irb"
+IRB.start(__FILE__)

data/lib/multisync/rsync_stat.rb

@@ -1,58 +1,100 @@
-
-require 'filesize'
+require "filesize"
 
 class Multisync::RsyncStat
-  
+
+  # Keep track of totals
+  def self.total
+    @total ||= Hash.new 0
+  end
+
+  # Sample output
+  #   ...
+  #   Number of files: 89,633 (reg: 59,322, dir: 30,311)
+  #   Number of created files: 356 (reg: 281, dir: 75)
+  #   Number of deleted files: 114 (reg: 101, dir: 13)
+  #   Number of regular files transferred: 344
+  #   Total file size: 546,410,522,192 bytes
+  #   Total transferred file size: 7,991,491,676 bytes
+  #   Literal data: 7,952,503,842 bytes
+  #   Matched data: 38,987,834 bytes
+  #   File list size: 3,063,808
+  #   File list generation time: 2.414 seconds
+  #   File list transfer time: 0.000 seconds
+  #   Total bytes sent: 7,957,645,803
+  #   Total bytes received: 101,299
+  #
+  #   sent 7,957,645,803 bytes  received 101,299 bytes  23,719,067.37 bytes/sec
+  #   total size is 546,410,522,192  speedup is 68.66
   def initialize output
     @output = output
   end
 
-  # Build an internal hash with normalized stats  
-  def parse
-    @stats = definitions.each_with_object({}) do |definition, stats|
-      value = scan[definition[:match]]
-      stats[definition[:key]] = value ? (definition[:coerce] ? definition[:coerce].call(value) : value) : definition[:default]
-    end
-    self
-  end
-  
-  # Scan output and return a hash
+  # extracted returns a hash with labels as keys and extracted strings as values
   #   {
-  #     "Number of files" => "35,648",
-  #     "Number of created files" => "0",
-  #     "Number of deleted files" => "0",
-  #     "Number of regular files transferred"=>"0",
+  #     "Number of files" => "35,648", 
+  #     "Number of created files" => "2,120", 
   #     ...
   #   }
-  def scan
-    @scan ||= @output.scan(/(#{definitions.map{|d| d[:match] }.join('|')}):\s+([,0-9]+)/).each_with_object({}) {|(k,v), o| o[k] = v }
-  end
-  
-  def to_a
-    [
-      @stats[:files],
-      @stats[:created],
-      @stats[:deleted],
-      @stats[:transferred],
-      @stats[:file_size],
-      @stats[:transferred_size],
-    ]
-  end
-  
-  def method_missing name
-    key = name.to_sym
-    return @stats[key] if @stats.keys.include? key
-    super
-  end
-  
-  def definitions
-    [
-      { key: :files, match: 'Number of files', coerce: ->(x) { x.gsub(',',"'") }, default: '0' },
-      { key: :created, match: 'Number of created files', coerce: ->(x) { x.gsub(',',"'") }, default: '0' },
-      { key: :deleted, match: 'Number of deleted files', coerce: ->(x) { x.gsub(',',"'") }, default: '0' },
-      { key: :transferred, match: 'Number of regular files transferred', coerce: ->(x) { x.gsub(',',"'") }, default: '0' },
-      { key: :file_size, match: 'Total file size', coerce: ->(x) { Filesize.new(x.gsub(',','').to_i).pretty }, default: '0 B' },
-      { key: :transferred_size, match: 'Total transferred file size', coerce: ->(x) { Filesize.new(x.gsub(',','').to_i).pretty }, default: '0 B' },
-    ]
+  def extracted
+    @extraced ||= @output.scan(/(#{labels.join('|')}):\s+([,0-9]+)/).to_h
+  end
+
+  # stats returns a hash with the follwing keys (and updates class total)
+  #   {
+  #     "Number of files" => 35648, 
+  #     "Number of created files" => 2120, 
+  #     "Number of deleted files" => 37,
+  #     "Number of regular files transferred" => 394,
+  #     "Total file size" => 204936349,
+  #     "Total transferred file size" => 49239,
+  #   }
+  def stats
+    @stats ||= labels.each_with_object({}) do |label, h|
+      value = extracted[label]&.delete(",").to_i
+
+      self.class.total[label] += value # update total
+      h[label] = value
+    end
+  end
+
+  def labels
+    self.class.format_map.keys
+  end
+
+  def formatted_values
+    self.class.format_values do |label|
+      stats[label]
+    end
+  end
+
+  def self.formatted_totals
+    format_values do |label|
+      total[label]
+    end
+  end
+
+  def self.format_values
+    format_map.map do |label, format|
+      format.call(yield label)
+    end
+  end
+
+  def self.format_map
+    {
+      'Number of files' => to_numbers,
+      'Number of created files' => to_numbers,
+      'Number of deleted files' => to_numbers,
+      'Number of regular files transferred' => to_numbers,
+      'Total file size' => to_filesize,
+      'Total transferred file size' => to_filesize,
+    }
+  end
+
+  def self.to_numbers
+    ->(x) { x.to_s.gsub(/\B(?=(...)*\b)/, "'") }
+  end
+
+  def self.to_filesize
+    ->(x) { Filesize.new(x).pretty }
   end
 end

data/lib/multisync/summary.rb

@@ -1,4 +1,3 @@
-
 class Multisync::Summary
   
   # All tasks to include in the summary
@@ -21,7 +20,6 @@ class Multisync::Summary
   end
   
   def data
-    # Exclude tasks with an empty result (> not run) first
     tasks.map do |task|
       result = task.result
       desc = [task.source_description, "--> #{task.destination_description}"]
@@ -30,8 +28,8 @@ class Multisync::Summary
       when :run
         if result[:status] && result[:status].success?
           # successfull run
-          stat = Multisync::RsyncStat.new(result[:stdout]).parse
-          [*desc, *stat.to_a.map{|e| {value: e.color(:green), alignment: :right} } ]
+          stats = Multisync::RsyncStat.new(result[:stdout])
+          [*desc, *stats.formatted_values.map{|e| {value: e.color(:green), alignment: :right} } ]
         else
           # failed or interrupted run
           [*desc, { value: (result[:stderr] || 'n/a').strip.color(:red), colspan: 6 } ]
@@ -45,7 +43,7 @@ class Multisync::Summary
         # not executed
         [*desc, { value: 'not executed'.faint, colspan: 6 } ]
       end
-    end
+    end.push ["Total".faint, "", *Multisync::RsyncStat.formatted_totals.map{|e| {value: e.faint, alignment: :right} } ]
   end
   
   def table_style

data/lib/multisync/version.rb

@@ -1,3 +1,3 @@
 module Multisync
-  VERSION = "0.3.6"
+  VERSION = "0.3.7"
 end

data/multisync.gemspec

@@ -1,45 +1,41 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "multisync/version"
+
+# frozen_string_literal: true
+
+require_relative "lib/multisync/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "multisync"
-  spec.version       = Multisync::VERSION
-  spec.authors       = ["Patrick Marchi"]
-  spec.email         = ["mail@patrickmarchi.ch"]
-
-  spec.summary       = %q{DSL for rsync.}
-  spec.description   = %q{Multisync offers a DSL to organize sets of rsync tasks.}
-  spec.homepage      = "https://github.com/pmarchi/multisync"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/pmarchi/multisync"
-    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
+  spec.name = "multisync"
+  spec.version = Multisync::VERSION
+  spec.authors = ["Patrick Marchi"]
+  spec.email = ["mail@patrickmarchi.ch"]
+
+  spec.summary = [spec.name, spec.version].join("-")
+  spec.description = "A DSL to organize sets of rsync tasks."
+  spec.homepage = "https://github.com/pmarchi/multisync"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = File.join(spec.homepage, "blob/main/CHANGELOG.md")
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  # Uncomment to register a new dependency of your gem
   spec.add_dependency "mixlib-shellout"
   spec.add_dependency "filesize"
   spec.add_dependency "rainbow"
   spec.add_dependency "terminal-table"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pry"
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multisync
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Patrick Marchi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -66,63 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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: Multisync offers a DSL to organize sets of rsync tasks.
+description: A DSL to organize sets of rsync tasks.
 email:
 - mail@patrickmarchi.ch
 executables:
@@ -132,8 +76,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
-- History.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -163,7 +107,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/pmarchi/multisync
   source_code_uri: https://github.com/pmarchi/multisync
-post_install_message: 
+  changelog_uri: https://github.com/pmarchi/multisync/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,15 +116,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
-summary: DSL for rsync.
+summary: multisync-0.3.7
 test_files: []

data/History.md

@@ -1,50 +0,0 @@
-
-# multisync
-
-## v0.3.1 (2018-06-01)
-Changes in DSL
-- removed "desc"
-- "from" accepts a description option
-- "to"" accepts a description option
-- New: "template" and "include"
-
-Changes in CLI
-- New: timeout option
-- New: quiet option
-- polished output
-
-## v0.2.4 (2017-09-23)
-- Fix: check command
-
-## v0.2.3 (2017-09-23)
-- Fix: check remote path
-
-## v0.2.2 (2017-09-23)
-- replaced shell_cmd gem with mixlib-shellout
-- Fix: check path for paths containing spaces
-
-## v0.2.1 (2017-09-22)
-- New: option "check_from" and "check_to" to let check host or path before sync
-- New: "from" and "to" accept an optional check: true|false parameter
-- Change summery output to a more compact tabular form
-- Use rainbow for colorization
-- Move "only_if" checks to runtime
-
-## v0.2.0 (2016-03-22)
-- New: option only_if for preflight checks, prior to sync
-- Command line option -p/--print changed to --show
-
-## v0.1.2 (2014-08-29)
-- Mark default sets with an * when listing
-
-## v0.1.1 (2014-08-28)
-- Add gem dependecy 'text-highlight'
-
-## v0.1.0 (2014-07-18)
-- New: define one or more groups/syncs as default, to run when no sets have been given as args
-
-## v0.0.2 (2014-07-17)
-- Fix: do no escape option strings
-
-## v0.0.1 (2014-07-11)
-- First release