listen 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 042d2544c103c6d5dfbf379cfc2c9f3f6bf84f3e
-  data.tar.gz: dc1649706fbc543ea1cce0ef66f004f27f785152
+  metadata.gz: 4c36c878c828e97095cc4497053d1243846ab65e
+  data.tar.gz: 1a1b6cb5c69ac240031139da5c8799a9fb621370
 SHA512:
-  metadata.gz: d97f0b9f72731fe5675324aee96cc6671efd538bec2207f3b3386c5fb98e3aab1f85251f36b8f8a12447a2932c7ae0dfb9220bb37e3fd369326280037ead5d87
-  data.tar.gz: 5facee3fb794d2c49670a783119d434c589da911b12dd4b32445808e8b8750e19513ba57045da4ce6e18c38817e3b31d26bd219bb8b7d402523bb0e66544adba
+  metadata.gz: a8cc54bd15b9e71184141775941b546acf42103d24f47f1eeaf713ba2d1f3c01fd7fa6e46995415418f84ad532572a41a79dd4966bf36bbdada4c5d562fd6646
+  data.tar.gz: d0c4813cf6417449bb38687dbcc723993a9b59952a67f6bb6ac58eed65d6bd0d67eebd10910968a291bcfa540097ef81084cddb7af9085ea75b6ec4bdf89f43b

data/.travis.yml

@@ -4,12 +4,12 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - jruby-19mode
-  - rbx-19mode
+  - jruby
+  - rbx
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
-    - rvm: rbx-19mode
+    - rvm: jruby
+    - rvm: rbx
 notifications:
   recipients:
     - thibaud@thibaud.gg

data/README.md

@@ -190,6 +190,7 @@ Here are some things you could try to avoid forcing polling.
 * Move or rename the listened directory.
 * Update/reboot your OS.
 * Increase latency.
+* If running Linux, check and see if you need package inotify-tools
 
 If your application keeps using the polling-adapter and you can't figure out why, feel free to [open an issue](https://github.com/guard/listen/issues/new) (and be sure to [give all the details](https://github.com/guard/listen/blob/master/CONTRIBUTING.md)).
 
@@ -197,7 +198,7 @@ If your application keeps using the polling-adapter and you can't figure out why
 
 Listen is capable of forwarding file events over the network using a messaging protocol. This can be useful for virtualized development environments when file events are unavailable, as is the case with [Vagrant](https://github.com/mitchellh/vagrant).
 
-To broadcast events over TCP, use the `forward_to` option with an address - just a port or a hostname/port combination:
+To broadcast events over TCP programmatically, use the `forward_to` option with an address - just a port or a hostname/port combination:
 
 ```ruby
 listener = Listen.to 'path/to/app', forward_to: '10.0.0.2:4000' do |modified, added, removed|
@@ -208,6 +209,13 @@ listener.start
 sleep
 ```
 
+As a convenience, the `listen` script is supplied which listens to a directory and forwards the events to a network address
+
+```bash
+listen -f "10.0.0.2:4000"
+listen -v -d "/projects/my_project" -f "10.0.0.2:4000"
+```
+
 To connect to a broadcasting listener as a recipient, specify its address using `Listen.on`:
 
 ```ruby

data/bin/listen

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'listen'
+require 'listen/cli'
+
+Listen::CLI.start
+

data/lib/listen/cli.rb

@@ -0,0 +1,60 @@
+require 'thor'
+require 'Listen'
+
+module Listen
+  class CLI < Thor
+    default_task :start
+
+    desc 'start', 'Starts Listen'
+
+    class_option :verbose,
+                  type:    :boolean,
+                  default: false,
+                  aliases: '-v',
+                  banner:  'Verbose'
+
+    class_option :forward,
+                  type:    :string,
+                  default: '127.0.0.1:4000',
+                  aliases: '-f',
+                  banner:  'The address to forward filesystem events'
+
+    class_option :directory,
+                  type:    :string,
+                  default: '.',
+                  aliases: '-d',
+                  banner:  'The directory to listen to'
+
+
+  def start
+    Listen::Forwarder.new(options).start
+  end
+
+  end
+
+  class Forwarder
+    def initialize(options)
+      @options = options
+    end
+
+    def start
+      puts "Starting listen..."
+      address = @options[:forward]
+      directory = @options[:directory]
+      callback = Proc.new do |modified, added, removed|
+        if @options[:verbose]
+          puts "+ #{added}" unless added.empty?
+          puts "- #{removed}" unless removed.empty?
+          puts "> #{modified}" unless modified.empty?
+        end
+      end
+
+      listener = Listen.to directory, forward_to: address, &callback
+      listener.start
+
+      while listener.listen?
+        sleep 0.5
+      end
+    end
+  end
+end

data/lib/listen/file.rb

@@ -1,6 +1,6 @@
 module Listen
   class File
-    attr_accessor :listener, :path, :data
+    attr_accessor :listener, :path, :data, :md5
 
     def initialize(listener, path)
       @listener = listener
@@ -51,10 +51,21 @@ module Listen
       _mode != _record_data[:mode]
     end
 
-    # Only useful on Darwin because of the file mtime second precision
+    # Only useful on Darwin because of the file mtime second precision.
+    # Only check if in the same seconds (mtime == current time).
+    # MD5 is eager loaded, so the first time it'll always return false.
     #
     def _content_modified?
-      _record_data[:md5] && _md5 != _record_data[:md5]
+      return false unless RbConfig::CONFIG['target_os'] =~ /darwin/i
+      return false unless _mtime.to_i == Time.now.to_i
+
+      _set_md5
+      if _record_data[:md5]
+        md5 != _record_data[:md5]
+      else
+        _set_record_data
+        false
+      end
     end
 
     def _set_record_data
@@ -66,11 +77,9 @@ module Listen
       _record.async.unset_path(path)
     end
 
-    # Only Darwin need md5 comparaison because of the file mtime second precision
-    #
     def _new_data
       data = { mtime: _mtime, mode: _mode }
-      data[:md5] = _md5 if RbConfig::CONFIG['target_os'] =~ /darwin/i
+      data[:md5] = md5 if md5
       data
     end
 
@@ -100,8 +109,8 @@ module Listen
       nil
     end
 
-    def _md5
-      @md5 ||= Digest::MD5.file(path).digest
+    def _set_md5
+      @md5 = Digest::MD5.file(path).digest
     rescue
       nil
     end

data/lib/listen/version.rb

@@ -1,3 +1,3 @@
 module Listen
-  VERSION = '2.5.0'
+  VERSION = '2.6.0'
 end

data/listen.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
 
   s.files        = `git ls-files`.split($/)
   s.test_files   = s.files.grep(%r{^spec/})
+  s.executable   = 'listen'
   s.require_path = 'lib'
 
   s.required_ruby_version = ">= 1.9.3"

data/spec/lib/listen/file_spec.rb

@@ -11,13 +11,7 @@ describe Listen::File do
   describe "#change" do
     let(:file_path) { path.join('file.rb') }
     let(:file) { Listen::File.new(listener, file_path) }
-    let(:expected_data) {
-      if darwin?
-        { type: 'File', mtime: kind_of(Float), mode: kind_of(Integer), md5: kind_of(String) }
-      else
-        { type: 'File', mtime: kind_of(Float), mode: kind_of(Integer) }
-      end
-    }
+    let(:expected_data) { { type: 'File', mtime: kind_of(Float), mode: kind_of(Integer) } }
 
     context "path present in record" do
       let(:record_mtime) { nil }
@@ -55,7 +49,6 @@ describe Listen::File do
         context "same record path mtime" do
           let(:record_mtime) { ::File.lstat(file_path).mtime.to_f }
           let(:record_mode)  { ::File.lstat(file_path).mode }
-          let(:record_md5)   { Digest::MD5.file(file_path).digest }
 
           context "same record path mode" do
             it "returns nil" do
@@ -77,15 +70,18 @@ describe Listen::File do
             end
           end
 
-          context "different record path md5" do
-            let(:record_md5) { 'foo' }
-
-            it "returns modified" do
-              expect(file.change).to eq :modified
-            end
-            it "sets path in record with expected data" do
-              expect(record.async).to receive(:set_path).with(file_path, expected_data)
-              file.change
+          if darwin?
+            context "different record path md5" do
+              let(:record_md5) { 'foo' }
+              let(:expected_data) { { type: 'File', mtime: kind_of(Float), mode: kind_of(Integer), md5: kind_of(String) } }
+
+              it "returns modified" do
+                expect(file.change).to eq :modified
+              end
+              it "sets path in record with expected data" do
+                expect(record.async).to receive(:set_path).with(file_path, expected_data)
+                file.change
+              end
             end
           end
 

data/spec/spec_helper.rb

@@ -25,7 +25,7 @@ end
 
 require 'rspec/retry'
 RSpec.configure do |config|
-  config.default_retry_count = ci? ? 3 : 1
+  config.default_retry_count = ci? ? 5 : 1
 end
 
 require 'celluloid/rspec'

data/spec/support/acceptance_helper.rb

@@ -18,6 +18,7 @@ end
 
 def add_changes(type, changes)
   @changes[type] += relative_path(changes)
+  @changes[type].uniq!
   @changes[type].sort!
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-11 00:00:00.000000000 Z
+date: 2014-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -125,7 +125,8 @@ dependencies:
 description: The Listen gem listens to file modifications and notifies you about the
   changes. Works everywhere!
 email: thibaud@thibaud.gg
-executables: []
+executables:
+- listen
 extensions: []
 extra_rdoc_files: []
 files:
@@ -140,6 +141,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/listen
 - lib/listen.rb
 - lib/listen/adapter.rb
 - lib/listen/adapter/base.rb
@@ -150,6 +152,7 @@ files:
 - lib/listen/adapter/tcp.rb
 - lib/listen/adapter/windows.rb
 - lib/listen/change.rb
+- lib/listen/cli.rb
 - lib/listen/directory.rb
 - lib/listen/file.rb
 - lib/listen/listener.rb