vagrant-fsnotify 0.0.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 980ee6f0ef0bbb9c668dc07cc8dea559455e3f0d
-  data.tar.gz: 71277c09a929d9ff27e5483d7c1e3b6fbc65130b
+  metadata.gz: 461039d21338e7042fb005d2490fa17fc369089e
+  data.tar.gz: 16699e1e2d069a0e4c81ef954903a44f77e6a7cc
 SHA512:
-  metadata.gz: 00057f278fd64d3d60244ebb6317c46d31487fc8d725b4b7afafa2001fa1408f9a82b4997799248daf7b9f4a63ba196336ea3d2b728c78a6e6064edd97d7bd9e
-  data.tar.gz: d4400d6134353f3b2a1b0a232a875c214342e3f6728d9ed7787d6756df381994356af7077a744f2532157ab40c1156e0f253b6b442972dcafe389a5a222161e3
+  metadata.gz: 0626b5ee3d78752b6745f8531ed3b24a35430f34620c1a4feb9336a97ecbe78e794d5d6dff50af62f1a2c99f278ffd106a68f1f32747b90265200cf26d95d39f
+  data.tar.gz: e627af659185f6a19fda0436e87dcc2d44e1bccf1e3df1b0ade9fd07884028f9929eccce88237c9859897360c500090bf64d2b2e511eefeec4001ec4a16bcb50

data/AUTHORS

@@ -0,0 +1,5 @@
+# This file lists all individuals having contributed content to the repository.
+
+Adrien Kohlbecker <adrien.kohlbecker@gmail.com>
+Don Morrison <github@elskwid.net>
+Leandro Facchinetti <me@leafac.com>

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+0.2.0 - 2015-07-14
+==================
+- *Breaking change:* Minimum required Vagrant version changed to 1.7.3+
+- Fixed a dependency issue with celluloid (#10, @leafac)
+
+0.1.1 - 2015-07-05 (yanked)
+===========================
+Note: This release was yanked due to a dependency issue, see #9
+- Added command synopsis (#7, @leafac)
+- Fix issue with vagrant runtime dependency on celluloid (#8, @leafac)
+
+0.1.0 - 2015-07-05 (yanked)
+===========================
+Note: This release was yanked due to a dependency issue, see #9
+- *Breaking change:* Added support for forwading file addition/removal (#6, @leafac)
+- Depend on `vagrant` rather than `listen` for better compatibility with upstream (#5, @leafac)
+- Added documentation (#3 & #4, @leafac)
+
+0.0.6 - 2015-04-16
+==================
+- Fix multimachine use, allow specifying which machine to target (@elskwid)
+
+0.0.5 - 2015-04-11
+==================
+- Fix `listen` dependency
+
+0.0.4 - 2014-08-18
+==================
+- Uses access time modification, rather than modified time
+
+0.0.3 - 2014-08-15
+==================
+- Allow guest path overriding
+
+
+0.0.2 - 2014-08-15
+==================
+- Increase the delay between changes to 2 seconds

data/Gemfile

@@ -5,5 +5,5 @@ group :development do
 end
 
 group :plugins do
-  gemspec
+  gem "vagrant-fsnotify", path: "."
 end

data/README.md

@@ -1,4 +1,160 @@
 vagrant-fsnotify
 ================
 
-Forward filesystem change notifications to your Vagrant VM
+Forward filesystem change notifications to your [Vagrant][vagrant] VM.
+
+Problem
+-------
+
+Some filesystems (e.g. ext4, HFS+) have a feature of event notification.
+Interested applications can subscribe and are notified when filesystem events
+happen (e.g. a file was created, modified or deleted).
+
+Applications can make use of this system to provide features such as auto-reload
+or live updates. For example, [Jekyll][jekyll] regenerates the static website
+and [Guard][guard] triggers a test run or a build when source files are
+modified.
+
+Unfortunately, [Vagrant][vagrant] users have a hard time making use of these
+features when the application is running inside a virtual machine. When the file
+is modified on the host, the event is not propagated to the guest and the
+auto-reload never happens.
+
+There are several bug reports related to this issue:
+
+- <https://www.virtualbox.org/ticket/10660>
+- <https://github.com/guard/listen/issues/53>
+- <https://github.com/guard/listen/issues/57>
+- <https://github.com/guard/guard/issues/269>
+- <https://github.com/mitchellh/vagrant/issues/707>
+
+There are two generally accepted solutions. The first is fall back to long
+polling, the other is to
+[forward the events over TCP][forwarding-file-events-over-tcp]. The problem with
+long polling is that it's painfully slow, especially in shared folders. The
+problem with forwarding events is that it's not a general approach that works
+for any application.
+
+Solution
+--------
+
+`vagrant-fsnotify` proposes a different solution: run a process listening for
+filesystem events on the host and, when a notification is received, access the
+virtual machine guest and `touch` the file in there (or `touch` followed by a
+`rm` in case of file removals), causing an event to be propagated on the guest
+filesystem.
+
+This leverages the speed of using real filesystem events while still being
+general enough to don't require any support from applications.
+
+Caveats
+-------
+
+Due to the nature of filesystem events and the fact that `vagrant-fsnotify` uses
+`touch`, the events are triggerred back on the host a second time.  To avoid
+infinite loops, we add an arbitrary debounce of 2 seconds between `touch`-ing
+the same file. Thus, if a file is modified on the host more than once in 2
+seconds the VM will only see one notification.  If the second trigger on the
+host or this arbitrary debounce is unacceptable for your application,
+`vagrant-fsnotify` might not be for you.
+
+Installation
+------------
+
+`vagrant-fsnotify` is a [Vagrant][vagrant] plugin and can be installed by
+running:
+
+```console
+$ vagrant plugin install vagrant-fsnotify
+```
+
+[Vagrant][vagrant] version 1.5 or greater is required.
+
+Usage
+-----
+
+### Basic setup
+
+In `Vagrantfile` synced folder configuration, add the `fsnotify: true`
+option. For example, in order to enable `vagrant-fsnotify` for the the default
+`/vagrant` shared folder, add the following:
+
+```ruby
+config.vm.synced_folder ".", "/vagrant", fsnotify: true
+```
+
+When the guest virtual machine is up, run the following:
+
+```console
+$ vagrant fsnotify
+```
+
+This starts the long running process that captures filesystem events on the host
+and forwards them to the guest virtual machine.
+
+### Multi-VM environments
+
+In multi-VM environments, you can specify the name of the VMs targeted by
+`vagrant-fsnotify` using:
+
+```console
+$ vagrant fsnotify <vm-name-1> <vm-name-2> ...
+```
+
+### Excluding files
+
+To exclude files or directories from being watched, you can add an `:exclude`
+option, which takes an array of strings (matched as a regexp against relative
+paths):
+
+```ruby
+config.vm.synced_folder ".", "/vagrant", fsnotify: true,
+                                         exclude: ["path1", "some/directory"]
+```
+
+This will exclude all files inside the `path1` and `some/directory`. It will
+also exclude files such as `another/directory/path1`
+
+### Guest path override
+
+If your actual path on the VM is not the same as the one in `synced_folder`, for
+example when using [`vagrant-bindfs`][vagrant-bindfs], you can use the
+`:override_guestpath` option:
+
+```ruby
+config.vm.synced_folder ".", "/vagrant", fsnotify: true,
+                                         override_guestpath: "/real/path"
+```
+
+This will forward a notification on `./myfile` to `/real/path/myfile` instead of
+`/vagrant/myfile`.
+
+### Select filesystem events
+
+By default, when the `:fsnotify` key in the `Vagrantfile` is configured with
+`true`, all filesystem events are forwarded to the VM (i.e. file creation,
+modification and removal events). If, instead, you want to select only a few of
+those events to be forwarded (e.g. you don't care about file removals), you can
+use an Array of Symbols among the following options: `:added`, `:modified` and
+`:removed`.
+
+For example, to forward only added files events to the default `/vagrant`
+folder, add the following to the `Vagrantfile`:
+
+```ruby
+config.vm.synced_folder ".", "/vagrant", fsnotify: [:added]
+```
+
+
+Original work
+-------------
+
+This plugin used [`vagrant-rsync-back`][vagrant-rsync-back] by @smerill and the
+[Vagrant][vagrant] source code as a starting point.
+
+[vagrant]: https://www.vagrantup.com/
+[jekyll]: http://jekyllrb.com/
+[guard]: http://guardgem.org/
+[forwarding-file-events-over-tcp]: https://github.com/guard/listen#forwarding-file-events-over-tcp
+[vagrant-bindfs]: https://github.com/gael-ian/vagrant-bindfs
+[vagrant-rsync-back]: https://github.com/smerrill/vagrant-rsync-back

data/lib/vagrant-fsnotify/command-fsnotify.rb

@@ -4,6 +4,10 @@ module VagrantPlugins::Fsnotify
   class Command < Vagrant.plugin("2", :command)
     include Vagrant::Action::Builtin::MixinSyncedFolders
 
+    def self.synopsis
+      'forwards filesystem events to virtual machine'
+    end
+
     def execute
       @logger = Log4r::Logger.new("vagrant::commands::fsnotify")
 
@@ -29,7 +33,19 @@ module VagrantPlugins::Fsnotify
 
           folder.each do |id, opts|
 
-            next if not opts[:fsnotify]
+            if !(
+                (opts[:fsnotify] == true) ||
+                (
+                  opts[:fsnotify].respond_to?(:include?) &&
+                  (
+                    opts[:fsnotify].include?(:modified) ||
+                    opts[:fsnotify].include?(:added) ||
+                    opts[:fsnotify].include?(:removed)
+                  )
+                )
+              )
+              next
+            end
 
             # Folder info
             hostpath  = opts[:hostpath]
@@ -68,7 +84,27 @@ module VagrantPlugins::Fsnotify
       end
 
       if paths.empty?
-        @env.ui.info("Nothing to sync, exiting...")
+        @env.ui.info(<<-MESSAGE)
+Nothing to sync.
+
+Note that the valid values for the `:fsnotify' configuration key on
+`Vagrantfile' are either `true' (which forwards all kinds of filesystem events)
+or an Array containing symbols among the following options: `:modified',
+`:added' and `:removed' (in which case, only the specified filesystem events are
+forwarded).
+
+For example, to forward all filesystem events to the default `/vagrant' folder,
+add the following to the `Vagrantfile':
+
+  config.vm.synced_folder ".", "/vagrant", fsnotify: true
+
+And to forward only added files events to the default `/vagrant' folder, add the
+following to the `Vagrantfile':
+
+  config.vm.synced_folder ".", "/vagrant", fsnotify: [:added]
+
+Exiting...
+MESSAGE
         return 1
       end
 
@@ -95,7 +131,7 @@ module VagrantPlugins::Fsnotify
       Vagrant::Util::Busy.busy(callback) do
         listener.start
         queue.pop
-        listener.stop if listener.listen?
+        listener.stop if listener.state != :stopped
       end
 
       return 0
@@ -113,10 +149,26 @@ module VagrantPlugins::Fsnotify
       end
 
       tosync = {}
+      todelete = []
 
       paths.each do |hostpath, folder|
 
-        modified.each do |file|
+        toanalyze = []
+        if folder[:opts][:fsnotify] == true
+          toanalyze += modified + added + removed
+        else
+          if folder[:opts][:fsnotify].include? :modified
+            toanalyze += modified
+          end
+          if folder[:opts][:fsnotify].include? :added
+            toanalyze += added
+          end
+          if folder[:opts][:fsnotify].include? :removed
+            toanalyze += removed
+          end
+        end
+
+        toanalyze.each do |file|
 
           if file.start_with?(hostpath)
 
@@ -128,7 +180,13 @@ module VagrantPlugins::Fsnotify
             end
 
             @changes[rel_path] = Time.now.to_i
-            folder[:machine].ui.info("fsnotify: Changed: #{rel_path}")
+            if modified.include? file
+              folder[:machine].ui.info("fsnotify: Changed: #{rel_path}")
+            elsif added.include? file
+              folder[:machine].ui.info("fsnotify: Added: #{rel_path}")
+            elsif removed.include? file
+              folder[:machine].ui.info("fsnotify: Removed: #{rel_path}")
+            end
 
             guestpath = folder[:opts][:override_guestpath] || folder[:opts][:guestpath]
             guestpath = File.join(guestpath, rel_path)
@@ -136,6 +194,9 @@ module VagrantPlugins::Fsnotify
             tosync[folder[:machine]] = [] if !tosync.has_key?(folder[:machine])
             tosync[folder[:machine]] << guestpath
 
+            if removed.include? file
+              todelete << guestpath
+            end
           end
 
         end
@@ -144,6 +205,10 @@ module VagrantPlugins::Fsnotify
 
       tosync.each do |machine, files|
         machine.communicate.execute("touch -a '#{files.join("' '")}'")
+        remove_from_this_machine = files & todelete
+        unless remove_from_this_machine.empty?
+          machine.communicate.execute("rm -rf '#{remove_from_this_machine.join("' '")}'")
+        end
       end
 
     rescue => e

data/lib/vagrant-fsnotify/plugin.rb

@@ -4,8 +4,12 @@ rescue LoadError
   raise "The vagrant-fsnotify plugin must be run within Vagrant."
 end
 
-if Vagrant::VERSION < "1.5"
-  raise "The vagrant-fsnotify plugin is only compatible with Vagrant 1.5+"
+if Vagrant::VERSION < "1.7.3"
+  raise <<-ERROR
+The vagrant-fsnotify plugin is only compatible with Vagrant 1.7.3+. If you can't
+upgrade, consider installing an old version of vagrant-fsnotify with:
+  $ vagrant plugin install vagrant-fsnotify --plugin-version 0.0.6.
+ERROR
 end
 
 module VagrantPlugins::Fsnotify

data/lib/vagrant-fsnotify/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Fsnotify
-    VERSION = "0.0.6"
+    VERSION = "0.2.0"
   end
 end

data/vagrant-fsnotify.gemspec

@@ -18,8 +18,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "listen", "2.8.0"
-
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
 end

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-fsnotify
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Adrien Kohlbecker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: listen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.8.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: Use vagrant-fsnotify to forward filesystem change notifications to your
   Vagrant VM
 email:
@@ -60,7 +46,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- AUTHORS
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -83,17 +71,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Forward filesystem change notifications to your Vagrant VM