multisync 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f5ccf30a0608eca5f17002de411dc941cb90d192c5343863a8b7898d2ab3270
-  data.tar.gz: 94d44b2c52223526c379112fa756249ebc0da3b1a61f77413c70229b95fe4525
+  metadata.gz: e799810bb5e357087f31733c9b885581a349832f6806a94e726d581c49e044b6
+  data.tar.gz: b2682c3578aa9381ee3e3b0b36fc6d4566462cea8c1c10a5458ae6951f959c87
 SHA512:
-  metadata.gz: 841ef74fc08150c9c639551a6b7fe84a2f1c941f77cea8cb10dfe56d0447709f8fc5a992afe7b4d217e76d9ab78248ac81f5859b323b1de0c8d25b26cb6c43de
-  data.tar.gz: e77a0e739af5df1530487d035c51ad6c8cc853e6d783a17207d63fae20e2253fe6098b54f5f5cf77c025f8fb48868a337d05c5417f3352176367ac90d9ec6e9f
+  metadata.gz: f9fbf97fda456b7d7f29f5822321960e1eab877d609c6456905039b05d8908010faae42967d1cd2e2644b1196611fcea0cabf5198247372d439aeece761bc827
+  data.tar.gz: 457c9cbf9c5c4a8ed1c06574594dc348e2d1fdf2febf75372ba96adbf31c76bb3734a87165cc30ca3a1825f8ab8c159691bef641a242686f5cb5a7dbc5d98089

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -1,101 +1,111 @@
-## Release v0.3.7 (2021-10-28)
+## [0.4.0] - 2025-11-02
 
-* Add grand total to summary
+- New CLI
+- List and start accept the same query argument to select the catalog tasks
+- New option to omit summary
+- New failure summary after task summary
+- Adjustment in output colors
+- Breaking change: to run tasks you must call multisync start
 
 
-## Release v0.3.6 (2019-08-20)
+## [0.3.7] - 2021-10-28
 
-* Tweak output when specifing --print and/or --quiet
+- Add grand total to summary
 
 
-## Release v0.3.5 (2019-08-13)
+## [0.3.6] - 2019-08-20
 
-* Fix option quiet
-* Catch SIGINT and print a summary after an interrupt
+- Tweak output when specifing --print and/or --quiet
 
 
-## Release v0.3.4 (2019-07-23)
+## [0.3.5] - 2019-08-13
 
-* Update help
-* Update readme
-* Update sample file
+- Fix option quiet
+- Catch SIGINT and print a summary after an interrupt
 
 
-## Release v0.3.3 (2019-07-23)
+## [0.3.4] - 2019-07-23
 
-* Update gem description
+- Update help
+- Update readme
+- Update sample file
 
 
-## Release v0.3.2 (2019-07-23)
+## [0.3.3] - 2019-07-23
 
-* First public release
+- Update gem description
 
 
-## Release v0.3.1 (2018-06-01)
+## [0.3.2] - 2019-07-23
+
+- First public release
+
+
+## [0.3.1] - 2018-06-01
 
 Changes in DSL
-* removed "desc"
-* "from" accepts a description option
-* "to"" accepts a description option
-* New: "template" and "include"
+- 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
+- New: timeout option
+- New: quiet option
+- polished output
 
 
-## Release v0.2.4 (2017-09-23)
+## [0.2.4] - 2017-09-23
 
-* Fix: check command
+- Fix: check command
 
 
-## Release v0.2.3 (2017-09-23)
+## [0.2.3] - 2017-09-23
 
-* Fix: check remote path
+- Fix: check remote path
 
 
-## Release v0.2.2 (2017-09-23)
+## [0.2.2] - 2017-09-23
 
-* replaced shell_cmd gem with mixlib-shellout
-* Fix: check path for paths containing spaces
+- replaced shell_cmd gem with mixlib-shellout
+- Fix: check path for paths containing spaces
 
 
-## Release v0.2.1 (2017-09-22)
+## [0.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
+- 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)
+## [0.2.0] - 2016-03-22
 
-* New: option only_if for preflight checks, prior to sync
-* Command line option -p/--print changed to --show
+- 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)
+## [0.1.2] - 2014-08-29
 
-* Mark default sets with an * when listing
+- Mark default sets with an * when listing
 
 
-## Release v0.1.1 (2014-08-28)
+## [0.1.1] - 2014-08-28
 
-* Add gem dependecy 'text-highlight'
+- Add gem dependecy 'text-highlight'
 
 
-## Release v0.1.0 (2014-07-18)
+## [0.1.0] - 2014-07-18
 
-* New: define one or more groups/syncs as default, to run when no sets have been given as args
+- 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)
+## [0.0.2] - 2014-07-17
 
-* Fix: do no escape option strings
+- Fix: do no escape option strings
 
 
-## Release v0.0.1 (2014-07-11)
+## [0.0.1] - 2014-07-11
 
-* First release
+- First release

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Patrick Marchi
+Copyright (c) 2025 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

@@ -7,9 +7,17 @@ Multisync offers a DSL to organize sets of rsync tasks. It takes advantage of te
 
 ## Installation
 
-Install multisync with:
+Install the gem and add to the application's Gemfile by executing:
 
-    $ gem install multisync
+```bash
+bundle add multisync
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install multisync
+```
 
 
 ## Usage
@@ -18,24 +26,19 @@ In order to run multisync you first need a catalog file (default: `~/.multisync.
 
 List your configuration (and check your catalog file for errors):
 
-    $ multisync -l
-
-
-Print out the rsync commands without executing them:
-
-    $ multisync -p
+    $ multisync list [QUERY ...]
 
 
-Run a group or task defined in your catalog file:
+Run the tasks defined in your catalog file:
 
-    $ multisync nas
+    $ multisync start [QUERY ...]
 
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 
 ## Contributing

data/Rakefile

@@ -5,4 +5,6 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+require "standard/rake"
+
+task default: %i[spec standard]

data/exe/multisync

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'multisync'
+require "multisync"
 
-Multisync::Cli.start
+Multisync::Cli.start ARGV

data/lib/multisync/catalog.rb

@@ -1,29 +1,26 @@
-
 class Multisync::Catalog
-  # top entity of definition
-  attr_reader :definition
-
   def initialize path
     @path = File.expand_path(path)
   end
-  
+
+  # top entity of definition
   def definition
-    @_definition ||= Multisync::Definition::Entity.new(Multisync::Definition::Null.new, '__MAIN__').tap do |e|
-      e.instance_eval File.read(path)
-    end
+    @definition ||= Multisync::Definition::Entity
+      .new(Multisync::Definition::Null.new, "")
+      .tap { _1.instance_eval File.read(path) }
   end
-  
+
   def traverse visitor
     definition.accept visitor
   end
-  
+
   def path
     return @path if File.exist? @path
-    sample_path = File.expand_path('../../../sample/multisync.rb', __FILE__)
+    sample_path = File.expand_path("../../../sample/multisync.rb", __FILE__)
     raise RuntimeError.new, "No catalog found at #{@path}. Copy sample from #{sample_path} to #{@path} and adjust to your needs."
   end
-  
+
   def self.default_catalog_path
-    '~/.multisync.rb'
+    "~/.multisync.rb"
   end
 end

data/lib/multisync/cli.rb

@@ -1,100 +1,72 @@
+require "thor"
+require "rainbow"
+require "terminal-table"
 
-require 'optparse'
-require 'rainbow/ext/string'
-require 'terminal-table'
+class Multisync::Cli < Thor
+  include Thor::Actions
+  include Multisync::Colors
 
-class Multisync::Cli
-  
-  def self.start
-    new.start
-  end
-  
-  # Given sets to run or empty
-  attr_reader :sets
-  
-  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 group/task separator.\n" +
-                 "       e.g. #{File.basename $0} nas/userdata"
-      o.separator ''
-      o.on('-l', '--list', "List the catalog") do
-        options[:list] = true
-      end
-      o.on('-p', '--print', "Print the commands without executing them") do
-        options[:print] = true
-      end
-      o.on('-q', '--quiet', "Show only rsync summary") do
-        options[:quiet] = true
-      end
-      o.on('--catalog FILE', "Specify a catalog", "Default is #{options[:file]}") do |file|
-        options[:file] = file
-      end
-      o.on('--timeout SECS', Integer, "Timeout for rsync job", "Default is #{options[:timeout]}") do |timeout|
-        options[:timeout] = timeout
-      end
-      o.on('-n', '--dryrun', "Run rsync in dry-run mode") do
-        options[:dryrun] = true
-      end
-      o.separator ''
-    end
+  def self.exit_on_failure? = true
+
+  class_option :catalog, aliases: "-f", default: Multisync::Catalog.default_catalog_path, desc: "Specify a custom catalog file"
+
+  desc "list [QUERY ...]", "List catalog tasks"
+  long_desc <<~LONGDESC
+    List catalog tasks
+
+    QUERY selects a section from the catalog (see list)
+    \x05use / as a group/task separator.
+    \x05e.g. #{File.basename $0} nas/userdata"
+  LONGDESC
+  method_option :all, aliases: "-a", type: :boolean, desc: "List all tasks"
+  def list *queries
+    queries = ["."] if options[:all]
+    tasks = Multisync::Selector.new(catalog, queries).tasks(parents: true)
+
+    puts "Catalog file: #{as_main(options[:catalog])}"
+    puts Multisync::List.new(tasks)
   end
-  
-  def start
-    parser.parse!
-    options[:quiet] = false if options[:print]
-    
-    @sets = ARGV
 
-    if options[:list]
-      # List tasks
-      puts "Catalog: #{options[:file].color(:cyan)}"
-      puts
-      puts Multisync::List.new catalog
+  desc "start [QUERY ...]", "Run catalog tasks"
+  long_desc <<~LONGDESC
+    Run catalog tasks
 
-    else
-      # Run tasks
-      return if tasks.empty?
-      begin
-        tasks.each do |task|
-          runtime.run task
-        end
-      rescue Interrupt => e
-        $stderr.puts "\nAborted!".color(:red)
-      end
-      unless options[:print]
-        puts
-        puts
-        puts Multisync::Summary.new tasks
-      end
-    end
+    QUERY selects a section from the catalog (see list)
+    \x05use / as a group/task separator.
+    \x05e.g. #{File.basename $0} nas/userdata"
+  LONGDESC
+  method_option :timeout, aliases: "-t", type: :numeric, default: 31536000, desc: "Timeout for single rsync task" # 1 year
+  method_option :print, aliases: "-p", type: :boolean, desc: "Print commands without executing"
+  method_option :quiet, aliases: "-q", type: :boolean, desc: "Run tasks quietly"
+  method_option :summary, type: :boolean, default: true, desc: "Show summary"
+  method_option :dryrun, aliases: "-n", type: :boolean, desc: "Run jobs in dry-run, don't make any changes"
+  def start *queries
+    tasks = Multisync::Selector.new(catalog, queries)
+      .tasks
+      # only leafs of the task tree can be executed
+      .select(&:executeable?)
 
-    puts
+    # Run
+    tasks.each { runtime.run _1 }
+  rescue Interrupt
+    warn as_fail("\nAborted!")
+  ensure
+    # Summarize
+    puts Multisync::Summary.new(tasks) if options[:summary] && !options[:print]
   end
-  
-  def tasks
-    @_tasks ||= Multisync::Selector.new(catalog, sets).tasks
-    # @_tasks ||= catalog.filter sets
+
+  desc "version", "Print version information"
+  def version
+    puts "multisync v#{Multisync::VERSION}"
   end
-  
+
+  private
+
   def catalog
-    @_catalog ||= Multisync::Catalog.new options[:file]
+    @catalog ||= Multisync::Catalog.new options[:catalog]
   end
-  
+
   def runtime
-    @_runtime ||= Multisync::Runtime.new(options)
-  end
-  
-  def options
-    @_options ||= { 
-      list: false,
-      print: false,
-      dryrun: false,
-      quiet: false,
-      file: Multisync::Catalog.default_catalog_path,
-      timeout: 31536000, # 1 year
-    }
+    @runtime ||= Multisync::Runtime.new(options)
   end
-end
+end

data/lib/multisync/colors.rb

@@ -0,0 +1,23 @@
+require "rainbow"
+
+module Multisync::Colors
+  def as_note x
+    Rainbow(x).faint
+  end
+
+  def as_main x
+    Rainbow(x).color(:aqua)
+  end
+
+  def as_skipped x
+    Rainbow(x).color(:yellow)
+  end
+
+  def as_success x
+    Rainbow(x).color(:green)
+  end
+
+  def as_fail x
+    Rainbow(x).color(:red)
+  end
+end

data/lib/multisync/definition/dsl.rb

@@ -1,61 +1,59 @@
-
 module Multisync::Definition::Dsl
-
   # The DSL methods
   def group name, &block
     Multisync::Definition::Entity.new self, name, &block
   end
-  
+
   def sync name, &block
     Multisync::Definition::Entity.new self, name, &block
   end
-  
+
   def template name, &block
     Multisync::Definition::Template.new name, &block
   end
-  
+
   def include name
     template = Multisync::Definition::Template.lookup name
-    instance_eval &template.block
+    instance_eval(&template.block)
   end
-  
-  def from value, options={}
+
+  def from value, options = {}
     @from_value = value
     # Check source's host or path before sync
     @from_check = options[:check]
     @from_description = options[:description]
   end
-  
-  def to value, options={}
+
+  def to value, options = {}
     @to_value = value
     # Check destination's host or path before sync
     @to_check = options[:check]
     @to_description = options[:description]
   end
-  
-  def options rsync_options, mode=:append
+
+  def options rsync_options, mode = :append
     @rsync_options_mode = mode
     @rsync_options = Array(rsync_options)
   end
-  
+
   def default
     @default = true
   end
-  
+
   # Defines a check, that should pass in order to invoke the sync
-  def only_if cmd, options={}
-    @check = { cmd: cmd, message: options.fetch(:message, cmd) }
+  def only_if cmd, options = {}
+    @check = {cmd: cmd, message: options.fetch(:message, cmd)}
   end
-  
+
   # Check source's host or path before sync
   # can also be set as option of "from"
-  def check_from flag=true
+  def check_from flag = true
     @from_check = flag
   end
-  
+
   # Check destination's host or path before sync
   # can also be set as option of "to"
-  def check_to flag=true
+  def check_to flag = true
     @to_check = flag
   end
-end
+end