multisync 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8a0350c5ae280342b7adaf8b0fc631fb8c3ee599b50c5102a0a65ac3a10d0c5
-  data.tar.gz: 37cfb68379262654a58db051640cde44de7a2e7fc5da3a9a089cbcf28e5235ba
+  metadata.gz: 61ac03244c8167301ec37ba7e610862fd8a04bbcbf076ae924d6e68de7a433ca
+  data.tar.gz: '06986d1e288623a55578897df7ad2e29245077387b9f49aacf0e0c5e1be5517d'
 SHA512:
-  metadata.gz: 01b4d15706e79188cc5c99cce466f22dccffacffefc1289abacf82f2d0879cc631dd1a763faade9c0853bb92a5dc4b5bda6a5721c1ca6048d0d9a3e039f8d059
-  data.tar.gz: 3d99412299c849635251f0feb2ffced54f39118d92a455379d3468d7751a32a6a8af968cd86712c9478a165688ec2e53a793fec0fcd6b28f845403a85a52e07a
+  metadata.gz: 661926fde8d62277b7865747afc6af70e991ab23ec92c1c34a1ec742a580d3a8a6b4b136d043a417ee304f25586ed20039895926c79988bcb44ba91a800f7c11
+  data.tar.gz: 73c84b8e6dd7218c63ae1e9be51bf6775caa3715f73c0a4b896363832623310b9bfcdcf180f0b149efa5612a4abce4a783cb59429e63cc5b17347f2e82f55496

data/README.md

@@ -1,4 +1,4 @@
-[![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
 
@@ -7,24 +7,28 @@ Multisync offers a DSL to organize sets of rsync tasks. It takes advantage of te
 
 ## 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/lib/multisync/cli.rb

@@ -13,14 +13,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
@@ -120,7 +117,7 @@ class Multisync::Cli
       dryrun: false,
       quiet: false,
       file: Multisync::Catalog.default_catalog_path,
-      timeout: 31536000,
+      timeout: 31536000, # 1 year
     }
   end
   

data/lib/multisync/version.rb

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

data/multisync.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{DSL for rsync.}
   spec.description   = %q{Multisync offers a DSL to organize sets of rsync tasks.}
-  spec.homepage      = ""
+  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'
@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   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["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 " \

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multisync
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Patrick Marchi
@@ -155,11 +155,13 @@ files:
 - 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
+  homepage_uri: https://github.com/pmarchi/multisync
+  source_code_uri: https://github.com/pmarchi/multisync
 post_install_message: 
 rdoc_options: []
 require_paths: