listen 0.3.3 → 0.4.0

data/lib/listen/adapters/darwin.rb

@@ -5,28 +5,49 @@ module Listen
     #
     class Darwin < Adapter
 
-      # Initialize the Adapter. See {Listen::Adapter#initialize} for more info.
+      LAST_SEPARATOR_REGEX = /\/$/
+
+      # Initializes the Adapter. See {Listen::Adapter#initialize} for more info.
       #
-      def initialize(directory, options = {}, &callback)
+      def initialize(directories, options = {}, &callback)
         super
-        init_worker
+        @worker = init_worker
       end
 
-      # Start the adapter.
+      # Starts the adapter.
       #
-      def start
-        super
-        @worker.run
+      # @param [Boolean] blocking whether or not to block the current thread after starting
+      #
+      def start(blocking = true)
+        @mutex.synchronize do
+          return if @stop == false
+          super
+        end
+
+        @worker_thread = Thread.new { @worker.run }
+        @poll_thread   = Thread.new { poll_changed_dirs }
+
+        # The FSEvent worker needs sometime to startup. Turnstiles can't
+        # be used to wait for it as it runs in a loop.
+        # TODO: Find a better way to block until the worker starts.
+        sleep @latency
+        @poll_thread.join if blocking
       end
 
-      # Stop the adapter.
+      # Stops the adapter.
       #
       def stop
-        super
+        @mutex.synchronize do
+          return if @stop == true
+          super
+        end
+
         @worker.stop
+        Thread.kill(@worker_thread) if @worker_thread
+        @poll_thread.join
       end
 
-      # Check if the adapter is usable on the current OS.
+      # Checks if the adapter is usable on the current OS.
       #
       # @return [Boolean] whether usable or not
       #
@@ -39,17 +60,21 @@ module Listen
         false
       end
 
-    private
+      private
 
-      # Initialiaze FSEvent worker and set watch callback block
+      # Initializes a FSEvent worker and adds a watcher for
+      # each directory passed to the adapter.
+      #
+      # @return [FSEvent] initialized worker
       #
       def init_worker
-        @worker = FSEvent.new
-        @worker.watch(@directory, :latency => @latency) do |changed_dirs|
-          next if @paused
-
-          changed_dirs.map! { |path| path.sub /\/$/, '' }
-          @callback.call(changed_dirs, {})
+        FSEvent.new.tap do |worker|
+          worker.watch(@directories.dup, :latency => @latency) do |changes|
+            next if @paused
+            @mutex.synchronize do
+              changes.each { |path| @changed_dirs << path.sub(LAST_SEPARATOR_REGEX, '') }
+            end
+          end
         end
       end
 

data/lib/listen/adapters/linux.rb

@@ -1,5 +1,3 @@
-require 'set'
-
 module Listen
   module Adapters
 
@@ -14,27 +12,39 @@ module Listen
     #
     class Linux < Adapter
 
-      # Initialize the Adapter. See {Listen::Adapter#initialize} for more info.
+      # Initializes the Adapter. See {Listen::Adapter#initialize} for more info.
       #
-      def initialize(directory, options = {}, &callback)
+      def initialize(directories, options = {}, &callback)
         super
-        @changed_dirs = Set.new
-        init_worker
+        @worker = init_worker
       end
 
-      # Start the adapter.
+      # Starts the adapter.
       #
-      def start
-        super
-        Thread.new { @worker.run }
-        poll_changed_dirs
+      # @param [Boolean] blocking whether or not to block the current thread after starting
+      #
+      def start(blocking = true)
+        @mutex.synchronize do
+          return if @stop == false
+          super
+        end
+
+        @worker_thread = Thread.new { @worker.run }
+        @poll_thread   = Thread.new { poll_changed_dirs }
+        @poll_thread.join if blocking
       end
 
-      # Stop the adapter.
+      # Stops the adapter.
       #
       def stop
-        super
+        @mutex.synchronize do
+          return if @stop == true
+          super
+        end
+
         @worker.stop
+        Thread.kill(@worker_thread) if @worker_thread
+        @poll_thread.join
       end
 
       # Check if the adapter is usable on the current OS.
@@ -52,30 +62,35 @@ module Listen
 
     private
 
-      # Initialize INotify worker and set watch callback block.
+      # Initializes a INotify worker and adds a watcher for
+      # each directory passed to the adapter.
       #
-      def init_worker
-        @worker = INotify::Notifier.new
-        @worker.watch(@directory, *EVENTS.map(&:to_sym)) do |event|
-          next if @paused
-          
-          unless event.name == "" # Event on root directory
-            @changed_dirs << File.dirname(event.absolute_name)
-          end
-        end
-      end
-
-      # Polling around @changed_dirs presence.
+      # @return [INotify::Notifier] initialized worker
       #
-      def poll_changed_dirs
-        until @stop
-          sleep(@latency)
+      def init_worker
+        worker = INotify::Notifier.new
+        @directories.each do |directory|
+          worker.watch(directory, *EVENTS.map(&:to_sym)) do |event|
+            if @paused || (
+              # Event on root directory
+              event.name == ""
+            ) || (
+              # INotify reports changes to files inside directories as events
+              # on the directories themselves too.
+              #
+              # @see http://linux.die.net/man/7/inotify
+              event.flags.include?(:isdir) and event.flags & [:close, :modify] != []
+            )
+              # Skip all of these!
+              next
+            end
 
-          next if @changed_dirs.empty?
-          changed_dirs = @changed_dirs.to_a
-          @changed_dirs.clear
-          @callback.call(changed_dirs, {})
+            @mutex.synchronize do
+              @changed_dirs << File.dirname(event.absolute_name)
+            end
+          end
         end
+        worker
       end
 
     end

data/lib/listen/adapters/polling.rb

@@ -13,22 +13,34 @@ module Listen
 
       # Initialize the Adapter. See {Listen::Adapter#initialize} for more info.
       #
-      def initialize(directory, options = {}, &callback)
+      def initialize(directories, options = {}, &callback)
         @latency ||= DEFAULT_POLLING_LATENCY
         super
       end
 
       # Start the adapter.
       #
-      def start
-        super
-        poll
+      # @param [Boolean] blocking whether or not to block the current thread after starting
+      #
+      def start(blocking = true)
+        @mutex.synchronize do
+          return if @stop == false
+          super
+        end
+
+        @poll_thread = Thread.new { poll }
+        @poll_thread.join if blocking
       end
 
       # Stop the adapter.
       #
       def stop
-        super
+        @mutex.synchronize do
+          return if @stop == true
+          super
+        end
+
+        @poll_thread.join
       end
 
     private
@@ -37,10 +49,11 @@ module Listen
       #
       def poll
         until @stop
-          sleep 0.1 && next if @paused
+          sleep(0.1) && next if @paused
 
           start = Time.now.to_f
-          @callback.call([@directory], :recursive => true)
+          @callback.call(@directories.dup, :recursive => true)
+          @turnstile.signal
           nap_time = @latency - (Time.now.to_f - start)
           sleep(nap_time) if nap_time > 0
         end

data/lib/listen/adapters/windows.rb

@@ -7,30 +7,42 @@ module Listen
     #
     class Windows < Adapter
 
-      # Initialize the Adapter. See {Listen::Adapter#initialize} for more info.
+      # Initializes the Adapter. See {Listen::Adapter#initialize} for more info.
       #
-      def initialize(directory, options = {}, &callback)
+      def initialize(directories, options = {}, &callback)
         super
-        @changed_dirs = Set.new
-        init_worker
+        @worker = init_worker
       end
 
-      # Start the adapter.
+      # Starts the adapter.
       #
-      def start
-        super
-        Thread.new { @worker.run }
-        poll_changed_dirs
+      # @param [Boolean] blocking whether or not to block the current thread after starting
+      #
+      def start(blocking = true)
+        @mutex.synchronize do
+          return if @stop == false
+          super
+        end
+
+        @worker_thread = Thread.new { @worker.run }
+        @poll_thread   = Thread.new { poll_changed_dirs(true) }
+        @poll_thread.join if blocking
       end
 
-      # Stop the adapter.
+      # Stops the adapter.
       #
       def stop
-        super
+        @mutex.synchronize do
+          return if @stop == true
+          super
+        end
+
         @worker.stop
+        Thread.kill(@worker_thread) if @worker_thread
+        @poll_thread.join
       end
 
-      # Check if the adapter is usable on the current OS.
+      # Checks if the adapter is usable on the current OS.
       #
       # @return [Boolean] whether usable or not
       #
@@ -45,28 +57,23 @@ module Listen
 
     private
 
-      # Initialiaze FSEvent worker and set watch callback block
+      # Initializes a FChange worker and adds a watcher for
+      # each directory passed to the adapter.
       #
-      def init_worker
-        @worker = FChange::Notifier.new
-        @worker.watch(@directory, :all_events, :recursive) do |event|
-          next if @paused
-          
-          @changed_dirs << File.expand_path(event.watcher.path)
-        end
-      end
-
-      # Polling around @changed_dirs presence.
+      # @return [FChange::Notifier] initialized worker
       #
-      def poll_changed_dirs
-        until @stop
-          sleep(@latency)
-
-          next if @changed_dirs.empty?
-          changed_dirs = @changed_dirs.to_a
-          @changed_dirs.clear          
-          @callback.call(changed_dirs, :recursive => true)
+      def init_worker
+        worker = FChange::Notifier.new
+        @directories.each do |directory|
+          watcher = worker.watch(directory, :all_events, :recursive) do |event|
+            next if @paused
+            @mutex.synchronize do
+              @changed_dirs << File.expand_path(event.watcher.path)
+            end
+          end
+          worker.add_watcher(watcher)
         end
+        worker
       end
 
     end

data/lib/listen/directory_record.rb

@@ -0,0 +1,254 @@
+require 'set'
+require 'find'
+require 'pathname'
+require 'digest/sha1'
+
+module Listen
+
+  # The directory record stores information about
+  # a directory and keeps track of changes to
+  # the structure of its childs.
+  #
+  class DirectoryRecord
+    attr_reader :directory, :paths, :sha1_checksums
+
+    # Default paths' beginnings that doesn't get stored in the record
+    DEFAULT_IGNORED_PATHS = %w[.bundle .git .DS_Store log tmp vendor]
+
+    # Initializes a directory record.
+    #
+    # @option [String] directory the directory to keep track of
+    #
+    def initialize(directory)
+      @directory = directory
+      raise ArgumentError, "The path '#{directory}' is not a directory!" unless File.directory?(@directory)
+
+      @ignored_paths  = Set.new(DEFAULT_IGNORED_PATHS)
+      @filters        = Set.new
+      @sha1_checksums = Hash.new
+    end
+
+    # Returns the ignored paths in the record
+    #
+    # @return [Array<String>] the ignored paths
+    #
+    def ignored_paths
+      @ignored_paths.to_a
+    end
+
+    # Returns the filters used in the record to know
+    # which paths should be stored.
+    #
+    # @return [Array<String>] the used filters
+    #
+    def filters
+      @filters.to_a
+    end
+
+    # Adds ignored path to the record.
+    #
+    # @example Ignore some paths
+    #   ignore ".git", ".svn"
+    #
+    # @param [String, Array<String>] paths a path or a list of paths to ignore
+    #
+    def ignore(*paths)
+      @ignored_paths.merge(paths)
+    end
+
+    # Adds file filters to the listener.
+    #
+    # @example Filter some files
+    #   ignore /\.txt$/, /.*\.zip/
+    #
+    # @param [Array<Regexp>] regexps a list of regexps file filters
+    #
+    # @return [Listen::Listener] the listener itself
+    #
+    def filter(*regexps)
+      @filters.merge(regexps)
+    end
+
+    # Returns whether a path should be ignored or not.
+    #
+    # @param [String] path the path to test.
+    #
+    # @return [Boolean]
+    #
+    def ignored?(path)
+      @ignored_paths.any? { |ignored_path| path =~ /#{ignored_path}$/ }
+    end
+
+    # Returns whether a path should be filtered or not.
+    #
+    # @param [String] path the path to test.
+    #
+    # @return [Boolean]
+    #
+    def filtered?(path)
+      @filters.empty? || @filters.any? { |filter| path =~ filter }
+    end
+
+    # Finds the paths that should be stored and adds them
+    # to the paths' hash.
+    #
+    def build
+      @paths = Hash.new { |h, k| h[k] = Hash.new }
+      important_paths { |path| insert_path(path) }
+      @updated_at = Time.now.to_i
+    end
+
+    # Detects changes in the passed directories, updates
+    # the record with the new changes and returns the changes
+    #
+    # @param [Array] directories the list of directories scan for changes
+    # @param [Hash] options
+    # @option options [Boolean] recursive scan all sub-directories recursively
+    # @option options [Boolean] relative_paths whether or not to use relative paths for changes
+    #
+    # @return [Hash<Array>] the changes
+    #
+    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_i
+      @changes
+    end
+
+    private
+
+    # Detects modifications and removals recursively in a directory.
+    #
+    # @note Modifications detection begins by checking the modification time (mtime)
+    #   of files and then by checking content changes (using SHA1-checksum)
+    #   when the mtime of files is not changed.
+    #
+    # @param [String] directory the path to analyze
+    # @param [Hash] options
+    # @option options [Boolean] recursive scan all sub-directories recursively
+    # @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|
+        path = File.join(directory, basename)
+
+        case type
+        when 'Dir'
+          if File.directory?(path)
+            detect_modifications_and_removals(path, options) if options[:recursive]
+          else
+            detect_modifications_and_removals(path, { :recursive => true }.merge(options))
+            @paths[directory].delete(basename)
+            @paths.delete("#{directory}/#{basename}")
+          end
+        when 'File'
+          if File.exist?(path)
+            new_mtime = File.mtime(path).to_i
+            if @updated_at < new_mtime || (@updated_at == new_mtime && content_modified?(path))
+              @changes[:modified] << (options[:relative_paths] ? relative_to_base(path) : path)
+            end
+          else
+            @paths[directory].delete(basename)
+            @sha1_checksums.delete(path)
+            @changes[:removed] << (options[:relative_paths] ? relative_to_base(path) : path)
+          end
+        end
+      end
+    end
+
+    # Detects additions in a directory.
+    #
+    # @param [String] directory the path to analyze
+    # @param [Hash] options
+    # @option options [Boolean] recursive scan all sub-directories recursively
+    # @option options [Boolean] relative_paths whether or not to use relative paths for changes
+    #
+    def detect_additions(directory, options = {})
+      Find.find(directory) do |path|
+        next if path == @directory
+
+        if File.directory?(path)
+          if ignored?(path) || (directory != path && (!options[:recursive] && existing_path?(path)))
+            Find.prune # Don't look any further into this directory.
+          else
+            insert_path(path)
+          end
+        elsif !ignored?(path) && filtered?(path) && !existing_path?(path)
+          if File.file?(path)
+            @changes[:added] << (options[:relative_paths] ? relative_to_base(path) : path)
+          end
+          insert_path(path)
+        end
+      end
+    end
+
+    # Returns whether or not a file's content has been modified by
+    # comparing the SHA1-checksum to a stored one.
+    #
+    # @param [String] path the file path
+    #
+    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
+    end
+
+    # Traverses the base directory looking for paths that should
+    # be stored; thus paths that are filters or not ignored.
+    #
+    # @yield [path] an important path
+    #
+    def important_paths
+      Find.find(@directory) do |path|
+        next if path == @directory
+
+        if File.directory?(path)
+          if ignored?(path)
+            Find.prune # Don't look any further into this directory.
+          else
+            yield(path)
+          end
+        elsif !ignored?(path) && filtered?(path)
+          yield(path)
+        end
+      end
+    end
+
+    # Inserts a path with its type (Dir or File) in paths hash.
+    #
+    # @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'
+    end
+
+    # Returns whether or not a path exists in the paths hash.
+    #
+    # @param [String] path the path to check
+    #
+    # @return [Boolean]
+    #
+    def existing_path?(path)
+      @paths[File.dirname(path)][File.basename(path)] != nil
+    end
+
+    # Converts an absolute path to a path that's relative to the base directory.
+    #
+    # @param [String] path the path to convert
+    #
+    # @return [String] the relative path
+    #
+    def relative_to_base(path)
+      path.sub(%r(^#{@directory}/?/), '')
+    end
+  end
+end