listen 0.4.2 → 0.4.3

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.4.3 - June 6, 2012
+
+### Bug fixes
+
+- [#24](https://github.com/guard/listen/issues/24): Fail gracefully when the inotify limit is not enough for Listen to function. (reported by [@daemonza][], fixed by [@Maher4Ever][])
+- [#32](https://github.com/guard/listen/issues/32): Fix a crash when trying to calculate the checksum of unreadable files. (reported by [@nex3][], fixed by [@Maher4Ever][])
+
+### Improvements
+
+- Add `#relative_paths` method to listeners. ([@Maher4Ever][])
+- Add `#started?` query-method to adapters. ([@Maher4Ever][])
+- Dynamically detect the mtime precision used on a system. ([@Maher4Ever][] with help from [@nex3][])
+
 ## 0.4.2 - May 1, 2012
 
 ### Bug fixes
@@ -88,3 +101,4 @@
 [@akerbos]: https://github.com/akerbos
 [@fny]: https://github.com/fny
 [@cobychapple]: https://github.com/cobychapple
+[@nex3]: https://github.com/nex3

data/README.md

@@ -32,12 +32,12 @@ Feel free to give your feeback via [Listen issues](https://github.com/guard/list
 
 ``` ruby
 # Listen to a single directory.
-Listen.to('dir/path/to/listen', filter: /\.rb$/, ignore: %r{ignored/path/}) do |modified, added, removed|
+Listen.to('dir/path/to/listen', :filter => /\.rb$/, :ignore => %r{ignored/path/}) do |modified, added, removed|
   # ...
 end
 
 # Listen to multiple directories.
-Listen.to('dir/to/awesome_app', 'dir/to/other_app', filter: /\.rb$/, latency: 0.1) do |modified, added, removed|
+Listen.to('dir/to/awesome_app', 'dir/to/other_app', :filter => /\.rb$/, :latency => 0.1) do |modified, added, removed|
   # ...
 end
 ```
@@ -193,6 +193,9 @@ These options can be set through `Listen.to` params or via methods (see the "Obj
 :latency => 0.5                                # Set the delay (**in seconds**) between checking for changes
                                                # default: 0.1 sec (1.0 sec for polling)
 
+:relative_paths => true                        # Enable the use of relative paths in the callback.
+                                               # default: false
+
 :force_polling => true                         # Force the use of the polling adapter
                                                # default: none
 

data/lib/listen/adapter.rb

@@ -83,6 +83,14 @@ module Listen
       @turnstile.signal # ensure no thread is blocked
     end
 
+    # Returns whether the adapter is statred or not
+    #
+    # @return [Boolean] whether the adapter is started or not
+    #
+    def started?
+      @stop.nil? ? false : !@stop
+    end
+
     # Blocks the main thread until the poll thread
     # calls the callback.
     #
@@ -129,7 +137,7 @@ module Listen
     ensure
       Thread.kill(t) if t
       FileUtils.rm(test_file) if File.exists?(test_file)
-      adapter.stop
+      adapter.stop if adapter && adapter.started?
     end
 
     private

data/lib/listen/adapters/linux.rb

@@ -1,22 +1,33 @@
 module Listen
   module Adapters
 
-    # Watched INotify EVENTS
-    #
-    # @see http://www.tin.org/bin/man.cgi?section=7&topic=inotify
-    # @see https://github.com/nex3/rb-inotify/blob/master/lib/rb-inotify/notifier.rb#L99-L177
-    #
-    EVENTS = %w[recursive attrib close modify move create delete delete_self move_self]
-
     # Listener implementation for Linux `inotify`.
     #
     class Linux < Adapter
 
+      # Watched inotify events
+      #
+      # @see http://www.tin.org/bin/man.cgi?section=7&topic=inotify
+      # @see https://github.com/nex3/rb-inotify/blob/master/lib/rb-inotify/notifier.rb#L99-L177
+      #
+      EVENTS = %w[recursive attrib close modify move create delete delete_self move_self]
+
+      # The message to show when the limit of inotify watchers is not enough
+      #
+      INOTIFY_LIMIT_MESSAGE = <<-EOS.gsub(/^\s*/, '')
+        Listen error: unable to monitor directories for changes.
+
+        Please head to https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers
+        for information on how to solve this issue.
+      EOS
+
       # Initializes the Adapter. See {Listen::Adapter#initialize} for more info.
       #
       def initialize(directories, options = {}, &callback)
         super
         @worker = init_worker
+      rescue Errno::ENOSPC
+        abort(INOTIFY_LIMIT_MESSAGE)
       end
 
       # Starts the adapter.

data/lib/listen/directory_record.rb

@@ -15,6 +15,15 @@ module Listen
 
     DEFAULT_IGNORED_EXTENSIONS  = %w[.DS_Store]
 
+    # Defines the used precision based on the type of mtime returned by the
+    # system (whether its in milliseconds or just seconds)
+    #
+    HIGH_PRECISION_SUPPORTED = File.mtime(__FILE__).to_f.to_s[-2..-1] != '.0'
+
+    # Data structure used to save meta data about a path
+    #
+    MetaData = Struct.new(:type, :mtime)
+
     # Class methods
     #
     class << self
@@ -71,7 +80,7 @@ module Listen
     # Adds ignoring patterns to the record.
     #
     # @example Ignore some paths
-    #   ignore ".git", ".svn"
+    #   ignore %r{^ignored/path/}, /man/
     #
     # @param [Regexp] regexp a pattern for ignoring paths
     #
@@ -86,8 +95,6 @@ module Listen
     #
     # @param [Regexp] regexp a pattern for filtering paths
     #
-    # @return [Listen::Listener] the listener itself
-    #
     def filter(*regexps)
       @filtering_patterns.merge(regexps)
     end
@@ -123,7 +130,6 @@ module Listen
     def build
       @paths = Hash.new { |h, k| h[k] = Hash.new }
       important_paths { |path| insert_path(path) }
-      @updated_at = Time.now.to_f
     end
 
     # Detects changes in the passed directories, updates
@@ -139,12 +145,13 @@ module Listen
     def fetch_changes(directories, options = {})
       @changes    = { :modified => [], :added => [], :removed => [] }
       directories = directories.sort_by { |el| el.length }.reverse # diff sub-dir first
+
       directories.each do |directory|
         next unless directory[@directory] # Path is or inside directory
         detect_modifications_and_removals(directory, options)
         detect_additions(directory, options)
       end
-      @updated_at = Time.now.to_f
+
       @changes
     end
 
@@ -173,10 +180,10 @@ module Listen
     # @option options [Boolean] relative_paths whether or not to use relative paths for changes
     #
     def detect_modifications_and_removals(directory, options = {})
-      @paths[directory].each do |basename, type|
+      @paths[directory].each do |basename, meta_data|
         path = File.join(directory, basename)
 
-        case type
+        case meta_data.type
         when 'Dir'
           if File.directory?(path)
             detect_modifications_and_removals(path, options) if options[:recursive]
@@ -187,8 +194,15 @@ module Listen
           end
         when 'File'
           if File.exist?(path)
-            new_mtime = File.mtime(path).to_f
-            if @updated_at < new_mtime || (@updated_at == new_mtime && content_modified?(path))
+            new_mtime = mtime_of(path)
+
+            # First check if we are in the same second (to update checksums)
+            # before checking the time difference
+            if  (meta_data.mtime.to_i == new_mtime.to_i && content_modified?(path)) || meta_data.mtime < new_mtime
+              # Update the meta data of the files
+              meta_data.mtime = new_mtime
+              @paths[directory][basename] = meta_data
+
               @changes[:modified] << (options[:relative_paths] ? relative_to_base(path) : path)
             end
           else
@@ -238,12 +252,14 @@ module Listen
     #
     def content_modified?(path)
       sha1_checksum = Digest::SHA1.file(path).to_s
-      if @sha1_checksums[path] != sha1_checksum
-        @sha1_checksums[path] = sha1_checksum
-        true
-      else
-        false
-      end
+      return false if @sha1_checksums[path] == sha1_checksum
+
+      had_no_checksum = @sha1_checksums[path].nil?
+      @sha1_checksums[path] = sha1_checksum
+
+      had_no_checksum ? false : true
+    rescue Errno::EACCES # unreadble file
+      false
     end
 
     # Traverses the base directory looking for paths that should
@@ -274,7 +290,10 @@ module Listen
     # @param [String] path the path to insert in @paths.
     #
     def insert_path(path)
-      @paths[File.dirname(path)][File.basename(path)] = File.directory?(path) ? 'Dir' : 'File'
+      meta_data = MetaData.new
+      meta_data.type = File.directory?(path) ? 'Dir' : 'File'
+      meta_data.mtime = mtime_of(path) unless meta_data.type == 'Dir' # mtimes of dirs are not used yet
+      @paths[File.dirname(path)][File.basename(path)] = meta_data
     end
 
     # Returns whether or not a path exists in the paths hash.
@@ -286,5 +305,15 @@ module Listen
     def existing_path?(path)
       @paths[File.dirname(path)][File.basename(path)] != nil
     end
+
+    # Returns the modification time of a file based on the precision defined by the system
+    #
+    # @param [String] file the file for which the mtime must be returned
+    #
+    # @return [Fixnum, Float] the mtime of the file
+    #
+    def mtime_of(file)
+      File.mtime(file).send(HIGH_PRECISION_SUPPORTED ? :to_f : :to_i)
+    end
   end
 end

data/lib/listen/listener.rb

@@ -119,7 +119,7 @@ module Listen
       self
     end
 
-    # Defines whether the use of the polling adapter
+    # Sets whether the use of the polling adapter
     # should be forced or not.
     #
     # @example Forcing the use of the polling adapter
@@ -134,6 +134,21 @@ module Listen
       self
     end
 
+    # Sets whether the paths in the callback should be
+    # relative or absolute.
+    #
+    # @example Enabling relative paths in the callback
+    #   relative_paths true
+    #
+    # @param [Boolean] value whether to enable relative paths in the callback or not
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def relative_paths(value)
+      @use_relative_paths = value
+      self
+    end
+
     # Defines a custom polling fallback message of disable it.
     #
     # @example Disabling the polling fallback message

data/lib/listen/version.rb

@@ -1,3 +1,3 @@
 module Listen
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000 Z
+date: 2012-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &14607320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: 0.9.1
   type: :runtime
   prerelease: false
-  version_requirements: *14607320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &14606840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +38,15 @@ dependencies:
         version: 0.8.8
   type: :runtime
   prerelease: false
-  version_requirements: *14606840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
 - !ruby/object:Gem::Dependency
   name: rb-fchange
-  requirement: &14606320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +54,15 @@ dependencies:
         version: 0.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *14606320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &14605920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +70,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14605920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The Listen gem listens to file modifications and notifies you about the
   changes. Works everywhere!
 email:
@@ -66,16 +86,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/listen.rb
+- lib/listen/version.rb
+- lib/listen/adapter.rb
 - lib/listen/multi_listener.rb
-- lib/listen/directory_record.rb
 - lib/listen/listener.rb
-- lib/listen/version.rb
-- lib/listen/adapters/linux.rb
+- lib/listen/turnstile.rb
+- lib/listen/directory_record.rb
 - lib/listen/adapters/polling.rb
 - lib/listen/adapters/darwin.rb
+- lib/listen/adapters/linux.rb
 - lib/listen/adapters/windows.rb
-- lib/listen/adapter.rb
-- lib/listen/turnstile.rb
 - CHANGELOG.md
 - LICENSE
 - README.md
@@ -91,6 +111,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -692640991
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -99,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: listen
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Listen to file modifications