mirrorworks 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58cb6b98f44aff4d8dbc13f4484dff1ade3803d1
-  data.tar.gz: afc17f0cc0320aaf5eddc94b0c67d458efc832ab
+  metadata.gz: e04d639d5a4487b53abdb576a77d782bdc077059
+  data.tar.gz: 16824c75ca849cdeb376ac42819ef043de3ed366
 SHA512:
-  metadata.gz: ba6a4407b7b2f5d2b05e58e57f795dca3f6ee7f9cadaf9c73bef775f0229615884647c9e182c1efead09d34ae11bc19f093e990c0232b48381aeca8ac43ef06e
-  data.tar.gz: 995f9b9a4f0fbbf10340ab42aaa98b2cb585ac09a0d3d57ae0c9513dd2fb69b4848fc5e5246cbbd24c296a0b0f361ba393830ba78180b0dd06b4ffb0e06d2d7e
+  metadata.gz: 23472f26451960e8ed4d3c8321b3c0c88f4f7b876c4ac1f105eade0f4590f06a28e059a978bccafe4f0ef80dfd1d6c068ce7bcf4fb05c29fd40af7eda586ce91
+  data.tar.gz: 581e9b76bb927ab16e73de91601a3e485e9676727f1319f20cef29eab3fa22827ba662ef5ae81593f6a37d63caaf1da19ad87725ccf156e26d08b76cfaa7c5f3

data/README.md

@@ -4,11 +4,11 @@ Mirrorworks
 A handy rsync wrapper cli tool.
 
 This is a dead-simple script that lets you easily set up pairs of files or
-directories (called 'reflections') and sync them locally or over the network
+directories - called 'reflections' - and sync them locally or over the network
 with commands like  
-`$ mirrorworks push`  
+`$ mirrorworks push [reflection...]`  
 and  
-`$ mirrorworks pull`
+`$ mirrorworks pull [reflection...]`
 
 Installation and Configuration
 ------------------------------
@@ -21,7 +21,7 @@ Install the gem with
 
 Mirrorworks reads a configuration file at ~/.mirrorworksrc.json.
 To create an example config file run:  
-`$ mirrorworks install`
+`$ mirrorworks setup`
 
 This file contains some underlying rsync runtime options as well as a set of
 'reflections'. Reflections are pairs files or directories that you want to have
@@ -38,6 +38,21 @@ Using Mirrorworks
 The script is very straightforward. For usage, run  
 `$ mirrorworks --help`
 
+Pushmodes/Pullmodes
+-------------------
+Since version 0.2.0, each reflection can optionally have a `pushmode` and a
+`pullmode`. The value of each mode can be `soft`, `hard`, or `ignore`.
+
+If a mode isn't included in the reflection, it will default to `soft`, which
+does not delete any extra files when transferring (unless overridden with `-x`).
+
+Using `hard` is the equivalent of supplying `-x` when running the command;
+extra files on the destination that are not on the source will be deleted.
+
+Providing `ignore` for a mode disables transfer for that mode. For example,
+`"pushmode": "ignore"` would cause mirrorworks to always skip pushing that
+reflection.
+
 Development
 -----------
 For bug reports and feature requests, feel free to open an issue or make a

data/example.mirrorworksrc.json

@@ -1,22 +1,25 @@
 {
   "rsync_opts": [
     "-rtupEl",
-    "--exclude=.git/*",
     "--backup",
+    "--exclude=.git/*",
     "--backup-dir=$HOME/.backup",
     "--suffix=.$(date +%Y-%m-%d-%H-%M)"
   ],
 
   "reflections": [
     {
-      "name":   "first_example",
-      "local":  "/dirs/end/with/slash/",
-      "remote": "me@example.com:~/dest/"
+      "name":     "first_example",
+      "local":    "/dirs/end/with/slash/",
+      "remote":   "me@example.com:~/dest/",
+      "pullmode": "soft"
     },
     {
-      "name":   "second_example",
-      "local":  "$HOME/.mirrorworksrc.json",
-      "remote": "/public/mirrorworksrc.json"
+      "name":     "second_example",
+      "local":    "$HOME/.mirrorworksrc.json",
+      "remote":   "/public/mirrorworksrc.json",
+      "pushmode": "hard",
+      "pullmode": "ignore"
     }
   ]
 }

data/lib/mirrorworks.rb

@@ -3,14 +3,12 @@ require 'fileutils'
 require 'rsync'
 require 'json'
 
-VERSION = '0.1.1'
+VERSION = '0.2.0'
 CONF_AT = File.join(Dir.home, '.mirrorworksrc.json')
 
 class Mirrorworks
 
   def initialize
-    @help_msg = ''
-    @options = {}
     @conf = {}
   end
 
@@ -18,10 +16,9 @@ class Mirrorworks
 
   def parse_config
     unless File.readable? CONF_AT
-      raise "Can't read #{CONF_AT}. Use 'install' command to make example conf."
+      raise "Can't read #{CONF_AT}. Use 'setup' command to make example conf."
     end
     File.open(CONF_AT, 'r') {|f| @conf = JSON.parse(f.read)}
-    @conf['rsync_opts'] << '--delete' if @options[:x]
   end
 
   def each_reflection(args)
@@ -46,17 +43,21 @@ class Mirrorworks
     end
   end
 
-  def install
+  def setup
     src = File.join(File.dirname(__FILE__), '..', 'example.mirrorworksrc.json')
     raise "#{CONF_AT} already exists. Nothing to do." if File.exists? CONF_AT
     FileUtils.cp(src, CONF_AT)
     puts "Created example config at #{CONF_AT}"
   end
 
-  def transfer(src, dest)
-    src.gsub! ' ', '\ '
-    dest.gsub! ' ', '\ '
-    result = Rsync.run(src, dest, @conf['rsync_opts'])
+  def transfer(src, dest, runtime_vars)
+    src = src.gsub(' ', '\ ').gsub('(', '\(').gsub(')', '\)')
+    dest = dest.gsub(' ', '\ ').gsub('(', '\(').gsub(')', '\)')
+    opts = @conf['rsync_opts']
+    opts << '--delete' if runtime_vars[:hard]
+    opts << '--dry-run' if runtime_vars[:dry]
+    puts "rsync #{opts.join(' ')} #{src} #{dest}" if runtime_vars[:verbose]
+    result = Rsync.run(src, dest, opts)
     raise result.error unless result.success?
     result.changes.each do |c|
       unless c.update_type == :no_update
@@ -64,40 +65,58 @@ class Mirrorworks
         puts summary << "\t" << c.filename
       end
     end
-    puts
   end
 
-  def push(args)
+  def push(args, runtime_vars)
     each_reflection(args) do |ref|
-      puts ">>>> Pushing #{ref['name']} >>>>"
-      src = ref['local']
-      dest = ref['remote']
-      transfer(src, dest)
+      mode = ref['pushmode'].nil? ? 'soft' : ref['pushmode'].downcase
+      if mode == 'ignore'
+        puts "---- Ignoring push for #{ref['name']} ----"
+      else
+        runtime_vars[:hard] = true if mode == 'hard'
+        puts ">>>> Pushing #{ref['name']} >>>>"
+        src = ref['local']
+        dest = ref['remote']
+        transfer(src, dest, runtime_vars)
+      end
+      puts
     end
   end
 
-  def pull(args)
+  def pull(args, runtime_vars)
     each_reflection(args) do |ref|
-      puts "<<<< Pulling #{ref['name']} <<<<"
-      src = ref['remote']
-      dest = ref['local']
-      transfer(src, dest)
+      mode = ref['pullmode'].nil? ? 'soft' : ref['pullmode'].downcase
+      if mode == 'ignore'
+        puts "---- Ignoring pull for #{ref['name']} ----"
+      else
+        runtime_vars[:hard] = true if mode == 'hard'
+        puts "<<<< Pulling #{ref['name']} <<<<"
+        src = ref['remote']
+        dest = ref['local']
+        transfer(src, dest, runtime_vars)
+      end
+      puts
     end
   end
 
-  def status(args)
+  def status(args, runtime_vars)
     puts 'Starting dry run. No changes will be made.'
-    @conf['rsync_opts'] << '-n'
-    push(args)
-    pull(args)
+    puts
+    runtime_vars[:dry] = true
+    push(args, runtime_vars)
+    pull(args, runtime_vars)
     puts 'End of dry run.'
   end
 
   def list(args)
     each_reflection(args) do |ref|
       puts "Name: #{ref['name']}",
-           "  Local:  #{ref['local']}",
-           "  Remote: #{ref['remote']}",
+           "  Local:    #{ref['local']}",
+           "  Remote:   #{ref['remote']}",
+           "  Pushmode: #{ref['pushmode'].nil? ?
+                          'soft' : ref['pushmode'].downcase}",
+           "  Pullmode: #{ref['pullmode'].nil? ?
+                          'soft' : ref['pullmode'].downcase}",
            ''
     end
   end
@@ -107,11 +126,11 @@ class Mirrorworks
     exit
   end
 
-  def help
-    puts @help_msg
+  def help(opts_msg)
+    puts opts_msg
     puts '',
          '  Commands:',
-         '    install     create example conf in home directory',
+         '    setup       create example conf in home directory',
          '    push        push from local to remote',
          '    pull        pull from remote to local',
          '    status      get status of reflections',
@@ -127,31 +146,37 @@ class Mirrorworks
 
   def run(args)
     begin
+      runtime_vars = {}
+      opts_msg = ''
       OptionParser.new do |opts|
-        opts.banner = 'Usage: mirrorworks [options] <command> [reflections]'
+        opts.banner = "Usage: mirrorworks [options] <command> [reflections]\n"
+        opts.banner += '  Options:'
         opts.on('-V', '--version', 'print version and exit') {version}
-        opts.on('-h', '--help', 'print help and exit') {help}
+        opts.on('-h', '--help', 'print help and exit') {help(opts_msg)}
+        opts.on('-v', '--verbose', 'show rsync command when executing') do |v|
+          runtime_vars[:verbose] = v
+        end
         opts.on('-x', '--hard', 'delete extra files on transfer') do |x|
-          @options[:x] = x
+          runtime_vars[:hard] = x
         end
-        @help_msg = opts.to_s
+        opts_msg = opts.to_s
       end.parse! args
 
-      help if args.empty?
+      help(opts_msg) if args.empty?
 
       command = args.shift
-      parse_config unless command == 'install'
+      parse_config unless command == 'setup'
       case command
       when 'push'
-        push args
+        push args, runtime_vars
       when 'pull'
-        pull args
+        pull args, runtime_vars
       when 'status'
-        status args
+        status args, runtime_vars
       when 'list'
         list args
-      when 'install'
-        install
+      when 'setup'
+        setup
       else
         raise "No command '#{command}'"
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mirrorworks
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Brazier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-01 00:00:00.000000000 Z
+date: 2014-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsync