multisync 0.3.3 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8a0350c5ae280342b7adaf8b0fc631fb8c3ee599b50c5102a0a65ac3a10d0c5
-  data.tar.gz: 37cfb68379262654a58db051640cde44de7a2e7fc5da3a9a089cbcf28e5235ba
+  metadata.gz: 0f5ccf30a0608eca5f17002de411dc941cb90d192c5343863a8b7898d2ab3270
+  data.tar.gz: 94d44b2c52223526c379112fa756249ebc0da3b1a61f77413c70229b95fe4525
 SHA512:
-  metadata.gz: 01b4d15706e79188cc5c99cce466f22dccffacffefc1289abacf82f2d0879cc631dd1a763faade9c0853bb92a5dc4b5bda6a5721c1ca6048d0d9a3e039f8d059
-  data.tar.gz: 3d99412299c849635251f0feb2ffced54f39118d92a455379d3468d7751a32a6a8af968cd86712c9478a165688ec2e53a793fec0fcd6b28f845403a85a52e07a
+  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/README.md

@@ -1,30 +1,34 @@
-[![Gem Version](https://badge.fury.io/rb/amaze.svg)](https://badge.fury.io/rb/multisync)
+[![Gem Version](https://badge.fury.io/rb/multisync.svg)](https://badge.fury.io/rb/multisync)
 
-# Multisync
+# multisync
 
 Multisync offers a DSL to organize sets of rsync tasks. It takes advantage of templates, groups and inheritance to simplify things.
 
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install multisync with:
 
-```ruby
-gem 'multisync'
-```
+    $ gem install multisync
 
-And then execute:
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+In order to run multisync you first need a catalog file (default: `~/.multisync.rb`). Copy the [sample file](sample/multisync.rb) to `~/.multisync.rb` and use it as a starting point to adjust it to your needs.
 
-    $ gem install multisync
+List your configuration (and check your catalog file for errors):
 
+    $ multisync -l
 
-## Usage
 
-TODO: Write usage instructions here
+Print out the rsync commands without executing them:
+
+    $ multisync -p
+
+
+Run a group or task defined in your catalog file:
+
+    $ multisync nas
 
 
 ## Development

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/catalog.rb

@@ -1,8 +1,5 @@
 
 class Multisync::Catalog
-  autoload :List, 'multisync/catalog/list'
-  autoload :Filter, 'multisync/catalog/filter'
-  
   # top entity of definition
   attr_reader :definition
 
@@ -16,18 +13,10 @@ class Multisync::Catalog
     end
   end
   
-  def list
-    catalog_list = Multisync::Catalog::List.new
-    definition.accept(catalog_list)
-    catalog_list.result
+  def traverse visitor
+    definition.accept visitor
   end
   
-  def filter sets
-    catalog_filter = Multisync::Catalog::Filter.new sets
-    definition.accept(catalog_filter)
-    catalog_filter.result
-  end
-
   def path
     return @path if File.exist? @path
     sample_path = File.expand_path('../../../sample/multisync.rb', __FILE__)

data/lib/multisync/cli.rb

@@ -1,3 +1,4 @@
+
 require 'optparse'
 require 'rainbow/ext/string'
 require 'terminal-table'
@@ -13,14 +14,11 @@ class Multisync::Cli
   
   def parser
     OptionParser.new do |o|
-      o.banner = "\nRun rsync jobs defined in the catalog file '#{options[:file]}'.\n\n"+
-                 "Usage: #{File.basename $0} [options] [SET] [...]\n\n"+
-                 "       SET selects a section from the catalog (see option -l)\n"+
-                 "       use / as a follow:\n"+
-                 "       work/pictures to specify the sync defined in the group work and\n"+
-                 "       home/pictures to specify the sync defined in the group home\n"+
-                 "       pictures alone will select both syncs, the one in the group work\n"+
-                 "       as well as the one in the group home"
+      o.banner = "\nRun rsync jobs defined in the catalog file '#{options[:file]}'.\n\n" +
+                 "Usage: #{File.basename $0} [options] [SET] [...]\n\n" +
+                 "       SET selects a section from the catalog (see option -l)\n" +
+                 "       use / as a group/task separator.\n" +
+                 "       e.g. #{File.basename $0} nas/userdata"
       o.separator ''
       o.on('-l', '--list', "List the catalog") do
         options[:list] = true
@@ -46,63 +44,39 @@ class Multisync::Cli
   
   def start
     parser.parse!
-    @sets = ARGV
+    options[:quiet] = false if options[:print]
     
-    case
-    when options[:list]
-      list_definitions
-    else
-      run_tasks
-    end
-    puts
-  end
-  
-  def list_definitions
-    puts "Catalog: #{options[:file].color(:cyan)}"
-    table = Terminal::Table.new(rows: catalog.list, style: table_style)
-    puts
-    puts table
-  end
-  
-  def run_tasks
-    tasks.each do |task|
-      runtime.run task
-    end
-    return if options[:print]
-    table = Terminal::Table.new(headings: summary_headings, rows: summary_data, style: table_style)
-    puts
-    puts
-    puts table
-  end
-  
-  def summary_headings
-    %w( Source Destination Files + - → ∑ ↑ ).zip(%i( left left right right right right right right )).map{|v,a| {value: v, alignment: a} }
-  end
-  
-  def summary_data
-    tasks.map do |task|
-      result = task.result
-      desc = [task.source_description, "--> #{task.destination_description}"]
+    @sets = ARGV
+
+    if options[:list]
+      # List tasks
+      puts "Catalog: #{options[:file].color(:cyan)}"
+      puts
+      puts Multisync::List.new catalog
 
-      case result[:action]
-      when :run
-        if result[:status].success?
-          # successfull run
-          stat = Multisync::RsyncStat.new(result[:stdout]).parse
-          [*desc, *stat.to_a.map{|e| {value: e.color(:green), alignment: :right} } ]
-        else
-          # failed run
-          [*desc, { value: result[:stderr].strip.color(:red), colspan: 6 } ]
+    else
+      # Run tasks
+      return if tasks.empty?
+      begin
+        tasks.each do |task|
+          runtime.run task
         end
-      when :skip
-        # skiped sync
-        [*desc, { value: result[:skip_message].color(:yellow), colspan: 6 } ]
+      rescue Interrupt => e
+        $stderr.puts "\nAborted!".color(:red)
+      end
+      unless options[:print]
+        puts
+        puts
+        puts Multisync::Summary.new tasks
       end
     end
+
+    puts
   end
   
   def tasks
-    @_tasks ||= catalog.filter sets
+    @_tasks ||= Multisync::Selector.new(catalog, sets).tasks
+    # @_tasks ||= catalog.filter sets
   end
   
   def catalog
@@ -120,11 +94,7 @@ class Multisync::Cli
       dryrun: false,
       quiet: false,
       file: Multisync::Catalog.default_catalog_path,
-      timeout: 31536000,
+      timeout: 31536000, # 1 year
     }
   end
-  
-  def table_style
-    { border_top: false,  border_bottom: false, border_x: '–', border_y: '', border_i: '', padding_left: 0, padding_right: 3 }
-  end
 end

data/lib/multisync/list.rb

@@ -0,0 +1,44 @@
+
+require 'rainbow/ext/string'
+
+class Multisync::List
+  
+  # Given catalog
+  attr_reader :catalog
+  
+  # Tasks
+  attr_reader :tasks
+
+  def initialize catalog
+    @catalog = catalog
+    @tasks = []
+  end
+  
+  def to_s
+    catalog.traverse self
+    table.to_s
+  end
+  
+  def table
+    Terminal::Table.new(rows: tasks, style: table_style)
+  end
+  
+  def visit subject, level
+    if level > 0
+      tab = ''.ljust(2*(level-1), ' ')
+      default = subject.default? ? ' *' : ''
+      name = "#{tab}#{subject.name}#{default}"
+      tasks << [name, *description(subject).map(&:faint)]
+      # puts "#{name.ljust(32, ' ')}#{description(subject)}"
+    end
+  end
+  
+  def description subject
+    desc = [subject.source_description, subject.destination_description]
+    desc.any?(&:empty?) ? [] : [desc.first, ['--> ', desc.last].join]
+  end
+
+  def table_style
+    { border_top: false,  border_bottom: false, border_x: '–', border_y: '', border_i: '', padding_left: 0, padding_right: 3 }
+  end
+end

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/runtime.rb

@@ -38,11 +38,15 @@ class Multisync::Runtime
     # special meaning for home, instead of passing it as literal char
     source, destination = [sync.source, sync.destination].map {|path| path.gsub(/\s+/, '\\ ') }
     cmd = "rsync #{rsync_options.join(' ')} #{source} #{destination}"
-    rsync = Mixlib::ShellOut.new(cmd, live_stdout: $stdout, live_stderr: $stderr, timeout: timeout)
+    cmd_options = { timeout: timeout }
+    cmd_options.merge!({live_stdout: $stdout, live_stderr: $stderr}) unless quiet?
+    rsync = Mixlib::ShellOut.new(cmd, cmd_options)
     sync.result[:cmd] = rsync.command
-    
-    puts
-    puts [sync.source_description, sync.destination_description].join(' --> ').color(:cyan)
+
+    unless quiet?
+      puts
+      puts [sync.source_description, sync.destination_description].join(' --> ').color(:cyan)
+    end
     
     # Perform all only_if checks, from top to bottom
     sync.checks.each do |check|
@@ -77,7 +81,7 @@ class Multisync::Runtime
       puts rsync.command
     else
       sync.result[:action] = :run
-      puts rsync.command if dryrun?
+      puts rsync.command if dryrun? && !quiet?
       rsync.run_command
       sync.result[:status] = rsync.status
       sync.result[:stdout] = rsync.stdout

data/lib/multisync/{catalog/filter.rb → selector.rb}

@@ -1,16 +1,26 @@
 
-class Multisync::Catalog::Filter
-  # selected sets
+class Multisync::Selector
+  
+  # Given catalog
+  attr_reader :catalog
+  
+  # Given set names
   attr_reader :sets
   
-  # selected subjects
+  # Selected tasks
   attr_reader :result
 
-  def initialize sets
-    @sets = Array(sets)
+  def initialize catalog, sets
+    @catalog = catalog
+    @sets = sets
     @result = []
   end
-
+  
+  def tasks
+    catalog.traverse self
+    result
+  end
+  
   def visit subject, _level
     result << subject if selected?(subject)
   end
@@ -23,4 +33,4 @@ class Multisync::Catalog::Filter
     # subject matches any of the given sets
     sets.any? {|set| /\b#{set}\b/.match subject.fullname }
   end
-end
+end

data/lib/multisync/summary.rb

@@ -0,0 +1,53 @@
+class Multisync::Summary
+  
+  # All tasks to include in the summary
+  attr_reader :tasks
+  
+  def initialize tasks
+    @tasks = tasks
+  end
+  
+  def to_s
+    table.to_s
+  end
+  
+  def table
+    Terminal::Table.new(headings: headings, rows: data, style: table_style)
+  end
+  
+  def headings
+    %w( Source Destination Files + - → ∑ ↑ ).zip(%i( left left right right right right right right )).map{|v,a| {value: v, alignment: a} }
+  end
+  
+  def data
+    tasks.map do |task|
+      result = task.result
+      desc = [task.source_description, "--> #{task.destination_description}"]
+
+      case result[:action]
+      when :run
+        if result[:status] && result[:status].success?
+          # successfull run
+          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 } ]
+        end
+
+      when :skip
+        # skiped sync
+        [*desc, { value: result[:skip_message].color(:yellow), colspan: 6 } ]
+
+      else
+        # not executed
+        [*desc, { value: 'not executed'.faint, colspan: 6 } ]
+      end
+    end.push ["Total".faint, "", *Multisync::RsyncStat.formatted_totals.map{|e| {value: e.faint, alignment: :right} } ]
+  end
+  
+  def table_style
+    { border_top: false,  border_bottom: false, border_x: '–', border_y: '', border_i: '', padding_left: 0, padding_right: 3 }
+  end
+
+end

data/lib/multisync/version.rb

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

data/lib/multisync.rb

@@ -4,6 +4,9 @@ module Multisync
   autoload :Cli, 'multisync/cli'
   autoload :Definition, 'multisync/definition'
   autoload :Catalog, 'multisync/catalog'
+  autoload :Selector, 'multisync/selector'
   autoload :Runtime, 'multisync/runtime'
   autoload :RsyncStat, 'multisync/rsync_stat'
+  autoload :Summary, 'multisync/summary'
+  autoload :List, 'multisync/list'
 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      = ""
-  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"] = "TODO: Put your gem's public repo URL here."
-    # 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

data/sample/multisync.rb

@@ -1,39 +1,115 @@
-options %w( --archive --delete --delete-excluded --exclude=.DS_Store )
-
-group :home do
-  group :cloud do
-    to "/Backup/Cloud"
-
-    sync :dropbox do
-      desc "Dropbox"
-      from "~/Dropbox"
-      options %q(--exclude='.dropbox.cache')
-    end
-
-    sync :copy do
-      desc "Copy"
-      from "~/Copy"
-      options %w(--archive --delete --exclude='.copy.cache'), :override
-    end
+# Copy this file to your home: ~/.multisync.rb
+# Choose one of the section A), B) or C) as a starting point
+# to adjust the configuration to your needs.
+
+
+################################################################################
+
+# A) Simple rsync task
+
+sync :simple do
+  from "~/Documents"
+  to "/PathToExternalDisk"
+  options %w( --archive --exclude=.DS_Store ) # as array
+end
+
+# This task can be run with: "multisync simple"
+
+
+################################################################################
+
+# B) Group of rsync tasks
+
+group :userdata do
+  
+  # Define the target path for the whole group and check the existance of the
+  # target path before running the rsync task.
+  # Also set an optional description for the target.
+  to "/PathToExternalDisk", description: "External HD", check: true
+
+  # Define rsync options for the whole group
+  options %w( --archive --exclude=.DS_Store )
+  
+  sync :desktop do
+    # With optional description of the source
+    from "~/Desktop", description: "Desktop"
   end
 
-  sync :pictures do
-    desc "Pictures"
-    from "~/Pictures/Private"
-    to "/Backup/Home"
+  sync :documents do
+    from "~/Documents", description: "Documents"
+  end
+
+  sync :downloads do
+    from "~/Downloads", description: "Downloads"
+    # Add options specific to this task.
+    options %w( --exclude='*.download' )
   end
 end
 
-group :work do
-  to "/Backup/Work"
+# Run the whole group with: "multisync userdata"
+# Run a single taks with: "multisync userdata/downloads"
+
+
+################################################################################
+
+# C) Real world example using templates, defaults and options override
+
+# rsync options for all tasks
+options %w( --archive --delete --delete-excluded --delete-after --exclude=.DS_Store --exclude=.localized )
+
+
+# Use templates to define a set of tasks that can be included later
+template :data do
+  
+  # Always check the existance of the source path
+  check_from true
+  
+  # rsync tasks with uncomplete arguments:
+  # Define the target later where the template will be included.
+  # This can be used to sync multiple directories to different remote locations.
+  sync :documents do
+    from "~/Documents", description: "Documents"
+  end
 
   sync :pictures do
-    desc "Pictures"
-    from "~/Pictures/Work"
+    from "~/Pictures", description: "Pictures"
   end
 
-  sync :doc do
-    desc "Documentation"
-    from "~/Work/doc"
+  sync :downloads do
+    from "~/Downloads", description: "Downloads"
+    # Don't merge options
+    options %w( --times --exclude='*.download' ), :override
   end
-end
+end
+
+
+group :hd do
+  # Uncomment the following line to run this group by default
+  # default
+  
+  # Define the target to be used by all tasks.
+  # The existance of the target path should be checked.
+  to "/TargetPathToBackupDisk/MyComputer", description: "External Disk", check: true
+  
+  # Include the template with the task definitions
+  include :data
+end
+
+group :nas do
+  to "user@nas.local:/data/backup/my_computer", description: "NAS", check: true
+  
+  # Include the template with the task definitions
+  include :data
+end
+
+# Run both groups with: "multisync hd nas"
+# Sync "desktop" to "hd" and "nas": "multisync desktop"
+# Sync "desktop" to "hd" only: "multisync hd/desktop"
+
+
+################################################################################
+
+# Additional notes
+# - groups can be nested
+# - use "default" to run one or more groups without specifing a name
+# - "default" can also be set on the top level and defines all tasks as default.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multisync
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.7
 platform: ruby
 authors:
 - Patrick Marchi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-07-23 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
@@ -142,25 +86,29 @@ files:
 - exe/multisync
 - lib/multisync.rb
 - lib/multisync/catalog.rb
-- lib/multisync/catalog/filter.rb
-- lib/multisync/catalog/list.rb
 - lib/multisync/cli.rb
 - lib/multisync/definition.rb
 - lib/multisync/definition/dsl.rb
 - lib/multisync/definition/entity.rb
 - lib/multisync/definition/null.rb
 - lib/multisync/definition/template.rb
+- lib/multisync/list.rb
 - lib/multisync/rsync_stat.rb
 - lib/multisync/runtime.rb
+- lib/multisync/selector.rb
+- lib/multisync/summary.rb
 - lib/multisync/version.rb
 - multisync.gemspec
 - sample/multisync.rb
-homepage: ''
+homepage: https://github.com/pmarchi/multisync
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  homepage_uri: https://github.com/pmarchi/multisync
+  source_code_uri: https://github.com/pmarchi/multisync
+  changelog_uri: https://github.com/pmarchi/multisync/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,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.1
-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

data/lib/multisync/catalog/list.rb

@@ -1,24 +0,0 @@
-
-class Multisync::Catalog::List
-  # result
-  attr_reader :result
-
-  def initialize
-    @result = []
-  end
-
-  def visit subject, level
-    if level > 0
-      tab = ''.ljust(2*(level-1), ' ')
-      default = subject.default? ? ' *' : ''
-      name = "#{tab}#{subject.name}#{default}"
-      @result << [name, *description(subject)]
-      # puts "#{name.ljust(32, ' ')}#{description(subject)}"
-    end
-  end
-  
-  def description subject
-    desc = [subject.source_description, subject.destination_description]
-    desc.any?(&:empty?) ? [] : [desc.first, ['--> ', desc.last].join]
-  end
-end