listen 0.4.7 → 0.5.0

data/lib/listen/listener.rb

@@ -1,203 +1,203 @@
-require 'pathname'
-
-module Listen
-  class Listener
-    attr_reader :directory, :directory_record, :adapter
-
-    # The default value for using relative paths in the callback.
-    DEFAULT_TO_RELATIVE_PATHS = false
-
-    # Initializes the directory listener.
-    #
-    # @param [String] directory the directory to listen to
-    # @param [Hash] options the listen options
-    # @option options [Regexp] ignore a pattern for ignoring paths
-    # @option options [Regexp] filter a pattern for filtering paths
-    # @option options [Float] latency the delay between checking for changes in seconds
-    # @option options [Boolean] relative_paths whether or not to use relative-paths in the callback
-    # @option options [Boolean] force_polling whether to force the polling adapter or not
-    # @option options [String, Boolean] polling_fallback_message to change polling fallback message or remove it
-    #
-    # @yield [modified, added, removed] the changed files
-    # @yieldparam [Array<String>] modified the list of modified files
-    # @yieldparam [Array<String>] added the list of added files
-    # @yieldparam [Array<String>] removed the list of removed files
-    #
-    def initialize(directory, options = {}, &block)
-      @block              = block
-      @directory          = Pathname.new(directory).realpath.to_s
-      @directory_record   = DirectoryRecord.new(@directory)
-      @use_relative_paths = DEFAULT_TO_RELATIVE_PATHS
-
-      @use_relative_paths = options.delete(:relative_paths) if options[:relative_paths]
-      @directory_record.ignore(*options.delete(:ignore))    if options[:ignore]
-      @directory_record.filter(*options.delete(:filter))    if options[:filter]
-
-      @adapter_options = options
-    end
-
-    # Starts the listener by initializing the adapter and building
-    # the directory record concurrently, then it starts the adapter to watch
-    # for changes.
-    #
-    # @param [Boolean] blocking whether or not to block the current thread after starting
-    #
-    def start(blocking = true)
-      t = Thread.new { @directory_record.build }
-      @adapter = initialize_adapter
-      t.join
-      @adapter.start(blocking)
-    end
-
-    # Stops the listener.
-    #
-    def stop
-      @adapter.stop
-    end
-
-    # Pauses the listener.
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def pause
-      @adapter.paused = true
-      self
-    end
-
-    # Unpauses the listener.
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def unpause
-      @directory_record.build
-      @adapter.paused = false
-      self
-    end
-
-    # Returns whether the listener is paused or not.
-    #
-    # @return [Boolean] adapter paused status
-    #
-    def paused?
-      !!@adapter && @adapter.paused == true
-    end
-
-    # Adds ignoring patterns to the listener.
-    #
-    # @param (see Listen::DirectoryRecord#ignore)
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def ignore(*regexps)
-      @directory_record.ignore(*regexps)
-      self
-    end
-
-    # Adds filtering patterns to the listener.
-    #
-    # @param (see Listen::DirectoryRecord#filter)
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def filter(*regexps)
-      @directory_record.filter(*regexps)
-      self
-    end
-
-    # Sets the latency for the adapter. This is a helper method
-    # to simplify changing the latency directly from the listener.
-    #
-    # @example Wait 0.5 seconds each time before checking changes
-    #   latency 0.5
-    #
-    # @param [Float] seconds the amount of delay, in seconds
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def latency(seconds)
-      @adapter_options[:latency] = seconds
-      self
-    end
-
-    # Sets whether the use of the polling adapter
-    # should be forced or not.
-    #
-    # @example Forcing the use of the polling adapter
-    #   force_polling true
-    #
-    # @param [Boolean] value whether to force the polling adapter or not
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def force_polling(value)
-      @adapter_options[:force_polling] = value
-      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
-    #   polling_fallback_message false
-    #
-    # @param [String, Boolean] value to change polling fallback message or remove it
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def polling_fallback_message(value)
-      @adapter_options[:polling_fallback_message] = value
-      self
-    end
-
-    # Sets the callback that gets called on changes.
-    #
-    # @example Assign a callback to be called on changes
-    #   callback = lambda { |modified, added, removed| ... }
-    #   change &callback
-    #
-    # @param [Proc] block the callback proc
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def change(&block) # modified, added, removed
-      @block = block
-      self
-    end
-
-    # Runs the callback passing it the changes if there are any.
-    #
-    # @param (see Listen::DirectoryRecord#fetch_changes)
-    #
-    def on_change(directories, options = {})
-      changes = @directory_record.fetch_changes(directories, options.merge(
-        :relative_paths => @use_relative_paths
-      ))
-      unless changes.values.all? { |paths| paths.empty? }
-        @block.call(changes[:modified],changes[:added],changes[:removed])
-      end
-    end
-
-    private
-
-    # Initializes an adapter passing it the callback and adapters' options.
-    #
-    def initialize_adapter
-      callback = lambda { |changed_dirs, options| self.on_change(changed_dirs, options) }
-      Adapter.select_and_initialize(@directory, @adapter_options, &callback)
-    end
-  end
-end
+require 'pathname'
+
+module Listen
+  class Listener
+    attr_reader :directory, :directory_record, :adapter
+
+    # The default value for using relative paths in the callback.
+    DEFAULT_TO_RELATIVE_PATHS = false
+
+    # Initializes the directory listener.
+    #
+    # @param [String] directory the directory to listen to
+    # @param [Hash] options the listen options
+    # @option options [Regexp] ignore a pattern for ignoring paths
+    # @option options [Regexp] filter a pattern for filtering paths
+    # @option options [Float] latency the delay between checking for changes in seconds
+    # @option options [Boolean] relative_paths whether or not to use relative-paths in the callback
+    # @option options [Boolean] force_polling whether to force the polling adapter or not
+    # @option options [String, Boolean] polling_fallback_message to change polling fallback message or remove it
+    #
+    # @yield [modified, added, removed] the changed files
+    # @yieldparam [Array<String>] modified the list of modified files
+    # @yieldparam [Array<String>] added the list of added files
+    # @yieldparam [Array<String>] removed the list of removed files
+    #
+    def initialize(directory, options = {}, &block)
+      @block              = block
+      @directory          = Pathname.new(directory).realpath.to_s
+      @directory_record   = DirectoryRecord.new(@directory)
+      @use_relative_paths = DEFAULT_TO_RELATIVE_PATHS
+
+      @use_relative_paths = options.delete(:relative_paths) if options[:relative_paths]
+      @directory_record.ignore(*options.delete(:ignore))    if options[:ignore]
+      @directory_record.filter(*options.delete(:filter))    if options[:filter]
+
+      @adapter_options = options
+    end
+
+    # Starts the listener by initializing the adapter and building
+    # the directory record concurrently, then it starts the adapter to watch
+    # for changes.
+    #
+    # @param [Boolean] blocking whether or not to block the current thread after starting
+    #
+    def start(blocking = true)
+      t = Thread.new { @directory_record.build }
+      @adapter = initialize_adapter
+      t.join
+      @adapter.start(blocking)
+    end
+
+    # Stops the listener.
+    #
+    def stop
+      @adapter.stop
+    end
+
+    # Pauses the listener.
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def pause
+      @adapter.paused = true
+      self
+    end
+
+    # Unpauses the listener.
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def unpause
+      @directory_record.build
+      @adapter.paused = false
+      self
+    end
+
+    # Returns whether the listener is paused or not.
+    #
+    # @return [Boolean] adapter paused status
+    #
+    def paused?
+      !!@adapter && @adapter.paused == true
+    end
+
+    # Adds ignoring patterns to the listener.
+    #
+    # @param (see Listen::DirectoryRecord#ignore)
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def ignore(*regexps)
+      @directory_record.ignore(*regexps)
+      self
+    end
+
+    # Adds filtering patterns to the listener.
+    #
+    # @param (see Listen::DirectoryRecord#filter)
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def filter(*regexps)
+      @directory_record.filter(*regexps)
+      self
+    end
+
+    # Sets the latency for the adapter. This is a helper method
+    # to simplify changing the latency directly from the listener.
+    #
+    # @example Wait 0.5 seconds each time before checking changes
+    #   latency 0.5
+    #
+    # @param [Float] seconds the amount of delay, in seconds
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def latency(seconds)
+      @adapter_options[:latency] = seconds
+      self
+    end
+
+    # Sets whether the use of the polling adapter
+    # should be forced or not.
+    #
+    # @example Forcing the use of the polling adapter
+    #   force_polling true
+    #
+    # @param [Boolean] value whether to force the polling adapter or not
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def force_polling(value)
+      @adapter_options[:force_polling] = value
+      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
+    #   polling_fallback_message false
+    #
+    # @param [String, Boolean] value to change polling fallback message or remove it
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def polling_fallback_message(value)
+      @adapter_options[:polling_fallback_message] = value
+      self
+    end
+
+    # Sets the callback that gets called on changes.
+    #
+    # @example Assign a callback to be called on changes
+    #   callback = lambda { |modified, added, removed| ... }
+    #   change &callback
+    #
+    # @param [Proc] block the callback proc
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def change(&block) # modified, added, removed
+      @block = block
+      self
+    end
+
+    # Runs the callback passing it the changes if there are any.
+    #
+    # @param (see Listen::DirectoryRecord#fetch_changes)
+    #
+    def on_change(directories, options = {})
+      changes = @directory_record.fetch_changes(directories, options.merge(
+        :relative_paths => @use_relative_paths
+      ))
+      unless changes.values.all? { |paths| paths.empty? }
+        @block.call(changes[:modified],changes[:added],changes[:removed])
+      end
+    end
+
+    private
+
+    # Initializes an adapter passing it the callback and adapters' options.
+    #
+    def initialize_adapter
+      callback = lambda { |changed_dirs, options| self.on_change(changed_dirs, options) }
+      Adapter.select_and_initialize(@directory, @adapter_options, &callback)
+    end
+  end
+end

data/lib/listen/multi_listener.rb

@@ -1,121 +1,121 @@
-module Listen
-  class MultiListener < Listener
-    attr_reader :directories, :directories_records, :adapter
-
-    # Initializes the multiple directories listener.
-    #
-    # @param [String] directories the directories to listen to
-    # @param [Hash] options the listen options
-    # @option options [Regexp] ignore a pattern for ignoring paths
-    # @option options [Regexp] filter a pattern for filtering paths
-    # @option options [Float] latency the delay between checking for changes in seconds
-    # @option options [Boolean] force_polling whether to force the polling adapter or not
-    # @option options [String, Boolean] polling_fallback_message to change polling fallback message or remove it
-    #
-    # @yield [modified, added, removed] the changed files
-    # @yieldparam [Array<String>] modified the list of modified files
-    # @yieldparam [Array<String>] added the list of added files
-    # @yieldparam [Array<String>] removed the list of removed files
-    #
-    def initialize(*args, &block)
-      options     = args.last.is_a?(Hash) ? args.pop : {}
-      directories = args
-
-      @block               = block
-      @directories         = directories.map  { |d| Pathname.new(d).realpath.to_s }
-      @directories_records = @directories.map { |d| DirectoryRecord.new(d) }
-
-      ignore(*options.delete(:ignore)) if options[:ignore]
-      filter(*options.delete(:filter)) if options[:filter]
-
-      @adapter_options = options
-    end
-
-    # Starts the listener by initializing the adapter and building
-    # the directory record concurrently, then it starts the adapter to watch
-    # for changes.
-    #
-    # @param [Boolean] blocking whether or not to block the current thread after starting
-    #
-    def start(blocking = true)
-      t = Thread.new { @directories_records.each { |r| r.build } }
-      @adapter = initialize_adapter
-      t.join
-      @adapter.start(blocking)
-    end
-
-    # Unpauses the listener.
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def unpause
-      @directories_records.each { |r| r.build }
-      @adapter.paused = false
-      self
-    end
-
-    # Adds ignored paths to the listener.
-    #
-    # @param (see Listen::DirectoryRecord#ignore)
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def ignore(*paths)
-      @directories_records.each { |r| r.ignore(*paths) }
-      self
-    end
-
-    # Adds file filters to the listener.
-    #
-    # @param (see Listen::DirectoryRecord#filter)
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def filter(*regexps)
-      @directories_records.each { |r| r.filter(*regexps) }
-      self
-    end
-
-    # Runs the callback passing it the changes if there are any.
-    #
-    # @param (see Listen::DirectoryRecord#fetch_changes)
-    #
-    def on_change(directories_to_search, options = {})
-      changes = fetch_records_changes(directories_to_search, options)
-      unless changes.values.all? { |paths| paths.empty? }
-        @block.call(changes[:modified],changes[:added],changes[:removed])
-      end
-    end
-
-    private
-
-    # Initializes an adapter passing it the callback and adapters' options.
-    #
-    def initialize_adapter
-      callback = lambda { |changed_dirs, options| self.on_change(changed_dirs, options) }
-      Adapter.select_and_initialize(@directories, @adapter_options, &callback)
-    end
-
-    # Returns the sum of all the changes to the directories records
-    #
-    # @param (see Listen::DirectoryRecord#fetch_changes)
-    #
-    # @return [Hash] the changes
-    #
-    def fetch_records_changes(directories_to_search, options)
-      @directories_records.inject({}) do |h, r|
-        # directory records skips paths outside their range, so passing the
-        # whole `directories` array is not a problem.
-        record_changes = r.fetch_changes(directories_to_search, options.merge(:relative_paths => DEFAULT_TO_RELATIVE_PATHS))
-
-        if h.empty?
-          h.merge!(record_changes)
-        else
-          h.each { |k, v| h[k] += record_changes[k] }
-        end
-
-        h
-      end
-    end
-  end
-end
+module Listen
+  class MultiListener < Listener
+    attr_reader :directories, :directories_records, :adapter
+
+    # Initializes the multiple directories listener.
+    #
+    # @param [String] directories the directories to listen to
+    # @param [Hash] options the listen options
+    # @option options [Regexp] ignore a pattern for ignoring paths
+    # @option options [Regexp] filter a pattern for filtering paths
+    # @option options [Float] latency the delay between checking for changes in seconds
+    # @option options [Boolean] force_polling whether to force the polling adapter or not
+    # @option options [String, Boolean] polling_fallback_message to change polling fallback message or remove it
+    #
+    # @yield [modified, added, removed] the changed files
+    # @yieldparam [Array<String>] modified the list of modified files
+    # @yieldparam [Array<String>] added the list of added files
+    # @yieldparam [Array<String>] removed the list of removed files
+    #
+    def initialize(*args, &block)
+      options     = args.last.is_a?(Hash) ? args.pop : {}
+      directories = args
+
+      @block               = block
+      @directories         = directories.map  { |d| Pathname.new(d).realpath.to_s }
+      @directories_records = @directories.map { |d| DirectoryRecord.new(d) }
+
+      ignore(*options.delete(:ignore)) if options[:ignore]
+      filter(*options.delete(:filter)) if options[:filter]
+
+      @adapter_options = options
+    end
+
+    # Starts the listener by initializing the adapter and building
+    # the directory record concurrently, then it starts the adapter to watch
+    # for changes.
+    #
+    # @param [Boolean] blocking whether or not to block the current thread after starting
+    #
+    def start(blocking = true)
+      t = Thread.new { @directories_records.each { |r| r.build } }
+      @adapter = initialize_adapter
+      t.join
+      @adapter.start(blocking)
+    end
+
+    # Unpauses the listener.
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def unpause
+      @directories_records.each { |r| r.build }
+      @adapter.paused = false
+      self
+    end
+
+    # Adds ignored paths to the listener.
+    #
+    # @param (see Listen::DirectoryRecord#ignore)
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def ignore(*paths)
+      @directories_records.each { |r| r.ignore(*paths) }
+      self
+    end
+
+    # Adds file filters to the listener.
+    #
+    # @param (see Listen::DirectoryRecord#filter)
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def filter(*regexps)
+      @directories_records.each { |r| r.filter(*regexps) }
+      self
+    end
+
+    # Runs the callback passing it the changes if there are any.
+    #
+    # @param (see Listen::DirectoryRecord#fetch_changes)
+    #
+    def on_change(directories_to_search, options = {})
+      changes = fetch_records_changes(directories_to_search, options)
+      unless changes.values.all? { |paths| paths.empty? }
+        @block.call(changes[:modified],changes[:added],changes[:removed])
+      end
+    end
+
+    private
+
+    # Initializes an adapter passing it the callback and adapters' options.
+    #
+    def initialize_adapter
+      callback = lambda { |changed_dirs, options| self.on_change(changed_dirs, options) }
+      Adapter.select_and_initialize(@directories, @adapter_options, &callback)
+    end
+
+    # Returns the sum of all the changes to the directories records
+    #
+    # @param (see Listen::DirectoryRecord#fetch_changes)
+    #
+    # @return [Hash] the changes
+    #
+    def fetch_records_changes(directories_to_search, options)
+      @directories_records.inject({}) do |h, r|
+        # directory records skips paths outside their range, so passing the
+        # whole `directories` array is not a problem.
+        record_changes = r.fetch_changes(directories_to_search, options.merge(:relative_paths => DEFAULT_TO_RELATIVE_PATHS))
+
+        if h.empty?
+          h.merge!(record_changes)
+        else
+          h.each { |k, v| h[k] += record_changes[k] }
+        end
+
+        h
+      end
+    end
+  end
+end