vagrant-syncer 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 203811d9ebeabc6d7b97875a159f3697e48815b3
-  data.tar.gz: bd5e7b41b4b7fe99d533e19a7a2012d555597591
+  metadata.gz: 6b1cb649b133b1b2e72687523107f780915461ce
+  data.tar.gz: 099ae1ef55605d4d25cd0c6bf051b02f5c0fecfb
 SHA512:
-  metadata.gz: 83fb4ca0d48cc3e457cbc34c354de41f5ea91bb7c08a17c2943303fec6da0d2bfdd0c3dee27aa0487b885cd8cc35ee1b65bfc155381df73b0a319daf5dede2b8
-  data.tar.gz: 86ff7c6020bf5b3285fac3cb5930654e002b660e95a4ec7c7ac0b6409271235f4748e0b42dedbe2bab642de70ebe9cd39cbfa518fb51513059945a1d247f7971
+  metadata.gz: a0f8891268b87fd26378200efa3d395e4d29c9ae2f8a9d050c8613ec30888f0c9557a6e25973db877e525150955c324cd42a487fb6118e3af3968110c7d7214d
+  data.tar.gz: d634602c568ab7bd9039f719da9fc01f7d82c2b92209475aad01c89de0722ae476e5d1ce66183c99f376e5496518cecb3eee767e400771a3a8cbb92a7a308d5e

data/README.md

@@ -1,13 +1,13 @@
 # vagrant syncer
 
-A Vagrant synced folder plugin that is an optimized implementation of [Vagrant rsync(-auto)](https://github.com/mitchellh/vagrant/tree/b721eb62cfbfa93895d0d4cf019436ab6b1df05d/plugins/synced_folders/rsync), based heavily on [vagrant-gatling-rsync](https://github.com/smerrill/vagrant-gatling-rsync)'s great listener implementations for watching large hierarchies.
+  This Vagrant plugin optimizes to the following Vagrant commands to not
+  be that CPU hog with large file hierachies:
 
-Vagrant syncer forks [Vagrant's RsyncHelper](https://github.com/mitchellh/vagrant/blob/b721eb62cfbfa93895d0d4cf019436ab6b1df05d/plugins/synced_folders/rsync/helper.rb)
-to make it (c)leaner, instead of using the class like [vagrant-gatling-rsync](https://github.com/smerrill/vagrant-gatling-rsync) does.
+    vagrant rsync
+    vagrant rsync-auto
 
-If the optimizations seem to work in heavy use, I'll see if (some of) them can
-be merged to Vagrant core and be submitted as pull requests to
-[the official Vagrant repo](https://github.com/mitchellh/vagrant).
+  All the [rsync synced folder settings](https://docs.vagrantup.com/v2/synced-folders/rsync.html)
+  are supported. They also have the same default values for backwards compatibility.
 
 
 ## Installation
@@ -15,43 +15,43 @@ be merged to Vagrant core and be submitted as pull requests to
     vagrant plugin install vagrant-syncer
 
 
-## Configuration
+## Updating
 
-All the [rsync synced folder settings](https://docs.vagrantup.com/v2/synced-folders/rsync.html)
-are supported. They also have the same default values.
+    vagrant plugin update vagrant-syncer
+
+
+## Configuration
 
 See [the example Vagrantfile](https://github.com/asyrjasalo/vagrant-syncer/blob/master/example/Vagrantfile)
 for additional plugin specific ```config.syncer``` settings and their default
 values.
 
 
-## Usage
-
-  The plugin replaces the following stock commands:
-
-    vagrant rsync
-    vagrant rsync-auto
-
-## Improvements over the stock commands
+## Changes to the Vagrant's rsync and rsync-auto
 
 - The plugin has leaner rsync implementation with most of the rsync command
   argument constructing already handled in the class initializer and not
-  sync-time
+  sync-time (in the sync loop).
 - Uses [rb-fsevent](https://github.com/thibaudgg/rb-fsevent) and
   [rb-inotify](https://github.com/nex3/rb-inotify) gems underneath for
   performance on OS X and GNU/Linux respectively, instead of using Listen.
-  On Windows, Listen is used though as using wdm still needs some testing.
+  On Windows, Listen is used though as using plain wdm gem requires some tests.
 - Allow defining additional SSH arguments to rsync in Vagrantfile using
-  ```config.syncer.ssh_args```. This can be used for e.g. disabling SSH
-  compression to lower CPU overhead.
+  ```config.syncer.ssh_args```. Use this for e.g. disabling SSH compression to
+  lower CPU overhead.
 - Runs ```vagrant rsync-auto``` to start watching changes after vagrant up,
   reload and resume, if ```config.syncer.run_on_startup``` set to ```true```
-  in Vagrantfile
+  in Vagrantfile.
 - Vagrant's implementation assumes that the primary group of the SSH user
   has the same name as the user, if rsync option ```group``` is not explicitly
   defined. This plugin queries the user's real primary group from the guest.
 - Hooking Vagrant's ```:rsync_pre``` is removed, as this unnecessarily runs mkdir
   to create the target directory, which rsync command creates sync-time anyway.
+- On Windows, expect relative paths, instead of Cygwin style, as Cygwin shall
+  not be a requirement.
+- ControlPath settings are not in the default SSH arguments on Windows,
+  as they fail on [Vagrant 1.8.0 and 1.8.1](https://github.com/mitchellh/vagrant/issues/7046).
+- The rsync stdout outputs are all single line by default, and colored.
 
 
 ## Development
@@ -72,7 +72,7 @@ Or outside the bundle:
     ./build_and_install.sh
     vagrant rsync-auto
 
-I'll kindly take pull requests as well.
+Also, I kindly take pull requests.
 
 ## Credits
 

data/lib/syncer/actions.rb

@@ -12,7 +12,7 @@ module Vagrant
 
           return  unless env[:machine].config.syncer.run_on_startup
 
-          # If Vagrant up/reload/resume exited successfully, run this rsync-auto
+          # If vagrant up/reload/resume exited successfully, run rsync-auto.
           at_exit do
             env[:machine].env.cli("rsync-auto")  if $!.status == 0
           end

data/lib/syncer/command/rsync.rb

@@ -29,7 +29,7 @@ module Vagrant
           argv = parse_options(opts)
           return if !argv
 
-          # Go through each machine and perform the rsync
+          # Go through each machine and perform full sync.
           error = false
           with_target_vms(argv) do |machine|
             if machine.provider.capability?(:proxy_machine)

data/lib/syncer/command/rsync_auto.rb

@@ -5,7 +5,7 @@ require "vagrant/action/builtin/mixin_synced_folders"
 require "vagrant/util/platform"
 
 
-# This is to avoid a bug in nio 1.0.0. Remove around nio 1.0.1
+# This is to avoid a bug in nio 1.0.0. Remove around nio 1.0.1.
 ENV["NIO4R_PURE"] = "1"  if Vagrant::Util::Platform.windows?
 
 module Vagrant
@@ -45,8 +45,8 @@ module Vagrant
                 machine.ui.warn(I18n.t(
                   "vagrant.rsync_proxy_machine",
                   name: machine.name.to_s,
-                  provider: machine.provider_name.to_s))
-
+                  provider: machine.provider_name.to_s
+                ))
                 machine = proxy
               end
             end

data/lib/syncer/config.rb

@@ -23,6 +23,8 @@ module Vagrant
             '-o UserKnownHostsFile=/dev/null',
           ]
 
+          # ControlPaths seem to fail on Windows with Vagrant >= 1.8.0.
+          # See: https://github.com/mitchellh/vagrant/issues/7046
           unless Vagrant::Util::Platform.windows?
             @ssh_args += [
               '-o ControlMaster=auto',

data/lib/syncer/listeners/fsevents.rb

@@ -9,7 +9,7 @@ module Vagrant
           @absolute_path = absolute_path
           @settings = settings.merge!(no_defer: false)
           @callback = callback
-          # rb-fsevent does not support excludes
+          # rb-fsevent does not support excludes.
         end
 
         def run

data/lib/syncer/listeners/inotify.rb

@@ -9,7 +9,7 @@ module Vagrant
           @absolute_path = absolute_path
           @settings = settings
           @callback = callback
-          # rb-inotify does not support excludes
+          # rb-inotify does not support excludes.
         end
 
         def run

data/lib/syncer/listeners/listen.rb

@@ -46,7 +46,7 @@ module Vagrant
             Thread.new { queue << true }
           end
 
-          # Run the listener in a busy block, exit once we receive an interrupt
+          # Run the listener in a busy block, exit once we receive an interrupt.
           Vagrant::Util::Busy.busy(callback) do
             listener.start
             queue.pop

data/lib/syncer/plugin.rb

@@ -23,6 +23,7 @@ module Vagrant
         Vagrant::Syncer::Command::RsyncAuto
       end
 
+      # For backwards compatibility with earlier vagrant-syncer versions.
       command("syncer", primary: false) do
         require_relative "command/rsync_auto"
         Vagrant::Syncer::Command::RsyncAuto

data/lib/syncer/syncers/rsync.rb

@@ -12,7 +12,8 @@ module Vagrant
 
           @machine_path = machine.env.root_path.to_s
           @host_path = parse_host_path(path_opts[:hostpath])
-          @rsync_args = parse_rsync_args(path_opts[:rsync__args], path_opts[:rsync__rsync_path])
+          @rsync_args = parse_rsync_args(path_opts[:rsync__args],
+            path_opts[:rsync__rsync_path])
           @rsync_verbose = path_opts[:rsync__verbose] || false
           @ssh_command = parse_ssh_command(machine.config.syncer.ssh_args)
           @exclude_args = parse_exclude_args(path_opts[:rsync__exclude])
@@ -73,7 +74,7 @@ module Vagrant
             return
           end
 
-          # Set owner/group after the files are transferred
+          # Set owner and group after the files are transferred.
           if @machine.guest.capability?(:rsync_post)
             @machine.guest.capability(:rsync_post, @vagrant_rsync_opts)
           end
@@ -85,12 +86,13 @@ module Vagrant
           abs_host_path = File.expand_path(host_dir, @machine_path)
           abs_host_path = Vagrant::Util::Platform.fs_real_path(abs_host_path).to_s
 
-          # Rsync on Windows expects relative paths
+          # Rsync on Windows to use relative paths and not to expect Cygwin.
           if Vagrant::Util::Platform.windows?
             abs_host_path = abs_host_path.gsub(@machine_path + '/', '')
           end
 
-          # Ensure path ends with '/' to prevent creating directory inside directory
+          # Ensure the path ends with '/' to prevent creating a directory
+          # inside a directory.
           abs_host_path += "/"  if !abs_host_path.end_with?("/")
 
           abs_host_path
@@ -98,7 +100,7 @@ module Vagrant
 
         def parse_exclude_args(excludes=nil)
           excludes ||= []
-          excludes << '.vagrant/'  # in any case, exclude .vagrant directory
+          excludes << '.vagrant/'  # Always exclude .vagrant directory.
           excludes.uniq.map { |e| ["--exclude", e] }
         end
 
@@ -120,24 +122,28 @@ module Vagrant
           rsync_args ||= ["--archive", "--delete", "--compress", "--copy-links",
             "--verbose"]
 
-          # This is the default rsync output unless overridden by user
+          # The default rsync output, later user opt --out-format arguments
+          # take presence.
           rsync_args.unshift("--out-format=%L%n")
 
-          rsync_chmod_args_given = rsync_args.any? { |arg| arg.start_with?("--chmod=") }
+          rsync_chmod_args_given = rsync_args.any? { |arg|
+            arg.start_with?("--chmod=")
+          }
 
-          # On Windows, enable all non-masked bits to avoid permission issues
+          # On Windows, enable all non-masked bits to avoid permission issues.
           if Vagrant::Util::Platform.windows? && !rsync_chmod_args_given
             rsync_args << "--chmod=ugo=rwX"
 
-            # Remove the -p option if --archive (equals -rlptgoD) is given
-            # Otherwise new files won't get the destination-default permissions
+            # Remove the -p option if --archive (equals -rlptgoD) is given.
+            # Otherwise new files won't get the destination's default
+            # permissions.
             if rsync_args.include?("--archive") || rsync_args.include?("-a")
               rsync_args << "--no-perms"
             end
           end
 
-          # Disable rsync's owner/group preservation (implied by --archive) unless
-          # explicitly requested, since we adjust owner/group later ourselves
+          # Disable rsync's owner and group preservation (implied by --archive)
+          # unless explicitly wanted, since we set owner/group using sudo rsync.
           unless rsync_args.include?("--owner") || rsync_args.include?("-o")
             rsync_args << "--no-owner"
           end
@@ -145,7 +151,7 @@ module Vagrant
             rsync_args << "--no-group"
           end
 
-          # Invoke remote rsync with sudo to allow owner and group settings to work
+          # Invoke remote rsync with sudo to allow chowning.
           if !rsync_path && @machine.guest.capability?(:rsync_command)
             rsync_path = @machine.guest.capability(:rsync_command)
           end

data/lib/syncer/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Syncer
-    VERSION = "1.0.5"
+    VERSION = "1.0.6"
   end
 end

data/vagrant-syncer.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Vagrant::Syncer::VERSION
   spec.authors       = ["Anssi Syrjäsalo"]
   spec.email         = ["anssi.syrjasalo@gmail.com"]
-  spec.summary       = %q{Optimized Vagrant rsync-auto}
-  spec.description   = %q{Optimized Vagrant rsync(-auto) plugin for large file hierarchies.}
+  spec.summary       = %q{Less resource-hog Vagrant rsync and rsync-auto}
+  spec.description   = %q{Optimized rsync and rsync-auto for large file hierarchies.}
   spec.homepage      = "https://github.com/asyrjasalo/vagrant-syncer"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-syncer
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Anssi Syrjäsalo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Optimized Vagrant rsync(-auto) plugin for large file hierarchies.
+description: Optimized rsync and rsync-auto for large file hierarchies.
 email:
 - anssi.syrjasalo@gmail.com
 executables:
@@ -111,5 +111,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Optimized Vagrant rsync-auto
+summary: Less resource-hog Vagrant rsync and rsync-auto
 test_files: []