multisync 0.3.7 → 0.4.0

data/lib/multisync/summary.rb

@@ -1,53 +1,90 @@
 class Multisync::Summary
-  
+  include Multisync::Colors
+
   # All tasks to include in the summary
   attr_reader :tasks
-  
+
   def initialize tasks
     @tasks = tasks
   end
-  
+
   def to_s
-    table.to_s
+    ["", as_main("Summary"), table.to_s, failures].compact.join("\n")
   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} }
+    %w[SOURCE DESTINATION FILES + - → ∑ ↑]
+      .map(&method(:as_note))
+      .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}"]
+      desc = [task.source_description, task.destination_description]
 
       case result[:action]
       when :run
-        if result[:status] && result[:status].success?
+        if result[:status]&.success?
           # successfull run
           stats = Multisync::RsyncStat.new(result[:stdout])
-          [*desc, *stats.formatted_values.map{|e| {value: e.color(:green), alignment: :right} } ]
+          [*desc, *stats.formatted_values.map { {value: as_success(_1), alignment: :right} }]
         else
           # failed or interrupted run
-          [*desc, { value: (result[:stderr] || 'n/a').strip.color(:red), colspan: 6 } ]
+          [*desc, as_message(as_fail("Failed, for more information see details below"))]
+          # [*desc, as_message(as_fail(result[:stderr] || "n/a").strip)]
         end
 
       when :skip
         # skiped sync
-        [*desc, { value: result[:skip_message].color(:yellow), colspan: 6 } ]
+        [*desc, as_message(as_skipped(result[:skip_message]))]
 
       else
         # not executed
-        [*desc, { value: 'not executed'.faint, colspan: 6 } ]
+        [*desc, as_message(as_note("not executed"))]
       end
-    end.push ["Total".faint, "", *Multisync::RsyncStat.formatted_totals.map{|e| {value: e.faint, alignment: :right} } ]
+    end.push(
+      [
+        as_note("Total"),
+        "",
+        *Multisync::RsyncStat
+          .formatted_totals
+          .map { {value: as_note(_1), alignment: :right} }
+      ]
+    )
   end
-  
-  def table_style
-    { border_top: false,  border_bottom: false, border_x: '–', border_y: '', border_i: '', padding_left: 0, padding_right: 3 }
+
+  def failures
+    tasks
+      .select { _1.result[:action] == :run && !_1.result[:status]&.success? }
+      .flat_map do |task|
+        [
+          as_fail([task.source_description, task.destination_description].join(" --> ")),
+          message_or_nil(task.result[:stdout]),
+          message_or_nil(task.result[:stderr]),
+          ""
+        ].compact
+      end
+      # Add title if any failures
+      .tap { _1.unshift "\n#{as_main("Failures")}" if _1.any? }
+      # Return failures as string or nil
+      .then { _1.any? ? _1.join("\n") : nil }
+  end
+
+  def as_message message
+    {value: message, colspan: 6}
   end
 
+  def message_or_nil message
+    (message.nil? || message.empty?) ? nil : message
+  end
+
+  def table_style
+    {border_x: as_note("─"), border_y: "", border_i: "", border_top: false, border_bottom: false, padding_left: 0, padding_right: 3}
+  end
 end

data/lib/multisync/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Multisync
-  VERSION = "0.3.7"
+  VERSION = "0.4.0"
 end

data/lib/multisync.rb

@@ -1,12 +1,17 @@
-require "multisync/version"
+# frozen_string_literal: true
+
+require_relative "multisync/version"
 
 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'
+  class Error < StandardError; end
+
+  autoload :Cli, "multisync/cli"
+  autoload :Colors, "multisync/colors"
+  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/sample/multisync.rb

@@ -2,7 +2,6 @@
 # Choose one of the section A), B) or C) as a starting point
 # to adjust the configuration to your needs.
 
-
 ################################################################################
 
 # A) Simple rsync task
@@ -10,26 +9,24 @@
 sync :simple do
   from "~/Documents"
   to "/PathToExternalDisk"
-  options %w( --archive --exclude=.DS_Store ) # as array
+  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 )
-  
+  options %w[--archive --exclude=.DS_Store]
+
   sync :desktop do
     # With optional description of the source
     from "~/Desktop", description: "Desktop"
@@ -42,28 +39,25 @@ group :userdata do
   sync :downloads do
     from "~/Downloads", description: "Downloads"
     # Add options specific to this task.
-    options %w( --exclude='*.download' )
+    options %w[--exclude='*.download']
   end
 end
 
 # 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 )
-
+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.
@@ -78,26 +72,25 @@ template :data do
   sync :downloads do
     from "~/Downloads", description: "Downloads"
     # Don't merge options
-    options %w( --times --exclude='*.download' ), :override
+    options %w[--times --exclude='*.download'], :override
   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
@@ -106,7 +99,6 @@ end
 # Sync "desktop" to "hd" and "nas": "multisync desktop"
 # Sync "desktop" to "hd" only: "multisync hd/desktop"
 
-
 ################################################################################
 
 # Additional notes

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: multisync
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Patrick Marchi
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-28 00:00:00.000000000 Z
+date: 2025-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -66,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A DSL to organize sets of rsync tasks.
 email:
 - mail@patrickmarchi.ch
@@ -74,19 +87,17 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - ".rspec"
+- ".standard.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - exe/multisync
 - lib/multisync.rb
 - lib/multisync/catalog.rb
 - lib/multisync/cli.rb
+- lib/multisync/colors.rb
 - lib/multisync/definition.rb
 - lib/multisync/definition/dsl.rb
 - lib/multisync/definition/entity.rb
@@ -98,7 +109,6 @@ files:
 - lib/multisync/selector.rb
 - lib/multisync/summary.rb
 - lib/multisync/version.rb
-- multisync.gemspec
 - sample/multisync.rb
 homepage: https://github.com/pmarchi/multisync
 licenses:
@@ -107,8 +117,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   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:
+  changelog_uri: https://github.com/pmarchi/multisync/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -116,15 +125,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
-summary: multisync-0.3.7
+summary: multisync-0.4.0
 test_files: []

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-Gemfile.lock

data/Gemfile

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "multisync"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# 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 "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/multisync.gemspec

@@ -1,41 +0,0 @@
-
-# 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 = [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")
-
-  # 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{\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"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end