listen 0.7.3 → 1.0.0

data/lib/listen/multi_listener.rb

@@ -1,143 +1,15 @@
 module Listen
   class MultiListener < Listener
-    attr_reader :directories, :directories_records, :adapter
 
-    # Initializes the multiple directories listener.
+    # This class is deprecated, please use Listen::Listener instead.
     #
-    # @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
+    # @see Listen::Listener
+    # @deprecated
     #
     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
-
-    # Replaces ignored paths in 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
-
-    # Replaces file filters in the listener.
-    #
-    # @param (see Listen::DirectoryRecord#filter!)
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def filter!(*regexps)
-      @directories_records.each { |r| r.filter!(*regexps) }
-      self
+      Kernel.warn "[Listen warning]:\nListen::MultiListener is deprecated, please use Listen::Listener instead."
+      super
     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

data/lib/listen/turnstile.rb

@@ -1,28 +1,32 @@
 module Listen
+
   # Allows two threads to wait on eachother.
   #
   # @note Only two threads can be used with this Turnstile
   #   because of the current implementation.
   class Turnstile
+    attr_accessor :queue
 
     # Initialize the turnstile.
     #
     def initialize
-      # Until ruby offers semahpores, only queues can be used
+      # Until Ruby offers semahpores, only queues can be used
       # to implement a turnstile.
-      @q = Queue.new
+      @queue = Queue.new
     end
 
     # Blocks the current thread until a signal is received.
     #
     def wait
-      @q.pop if @q.num_waiting == 0
+      queue.pop if queue.num_waiting == 0
     end
 
-    # Unblocks the waiting thread if there is one.
+    # Unblocks the waiting thread if any.
     #
     def signal
-      @q.push :dummy if @q.num_waiting == 1
+      queue.push(:dummy) if queue.num_waiting == 1
     end
+
   end
+
 end

data/lib/listen/version.rb

@@ -1,3 +1,3 @@
 module Listen
-  VERSION = '0.7.3'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 0.7.3
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
@@ -10,22 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-24 00:00:00.000000000 Z
+date: 2013-04-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rb-kqueue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: The Listen gem listens to file modifications and notifies you about the
@@ -37,48 +90,42 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/listen/dependency_manager.rb
-- lib/listen/version.rb
-- lib/listen/adapters/darwin.rb
+- lib/listen/adapter.rb
 - lib/listen/adapters/bsd.rb
+- lib/listen/adapters/darwin.rb
 - lib/listen/adapters/linux.rb
 - lib/listen/adapters/polling.rb
 - lib/listen/adapters/windows.rb
 - lib/listen/directory_record.rb
+- lib/listen/listener.rb
 - lib/listen/multi_listener.rb
 - lib/listen/turnstile.rb
-- lib/listen/listener.rb
-- lib/listen/adapter.rb
+- lib/listen/version.rb
 - lib/listen.rb
 - CHANGELOG.md
 - LICENSE
 - README.md
 homepage: https://github.com/guard/listen
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -750859891
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: listen
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Listen to file modifications
 test_files: []
-has_rdoc: 

data/lib/listen/dependency_manager.rb

@@ -1,126 +0,0 @@
-require 'set'
-
-module Listen
-
-  # The dependency-manager offers a simple DSL which allows
-  # classes to declare their gem dependencies and load them when
-  # needed.
-  # It raises a user-friendly exception when the dependencies
-  # can't be loaded which has the install command in the message.
-  #
-  module DependencyManager
-
-    GEM_LOAD_MESSAGE = <<-EOS.gsub(/^ {6}/, '')
-      Missing dependency '%s' (version '%s')!
-    EOS
-
-    GEM_INSTALL_COMMAND = <<-EOS.gsub(/^ {6}/, '')
-      Please run the following to satisfy the dependency:
-        gem install --version '%s' %s
-    EOS
-
-    BUNDLER_DECLARE_GEM = <<-EOS.gsub(/^ {6}/, '')
-      Please add the following to your Gemfile to satisfy the dependency:
-        gem '%s', '%s'
-    EOS
-
-    Dependency = Struct.new(:name, :version)
-
-    # The error raised when a dependency can't be loaded.
-    class Error < StandardError; end
-
-    # A list of all loaded dependencies in the dependency manager.
-    @_loaded_dependencies = Set.new
-
-    # class methods
-    class << self
-
-      # Initializes the extended class.
-      #
-      # @param [Class] the class for which some dependencies must be managed
-      #
-      def extended(base)
-        base.class_eval do
-          @_dependencies = Set.new
-        end
-      end
-
-      # Adds a loaded dependency to a list so that it doesn't have
-      # to be loaded again by another classes.
-      #
-      # @param [Dependency] dependency
-      #
-      def add_loaded(dependency)
-        @_loaded_dependencies << dependency
-      end
-
-      # Returns whether the dependency is alread loaded or not.
-      #
-      # @param [Dependency] dependency
-      # @return [Boolean]
-      #
-      def already_loaded?(dependency)
-        @_loaded_dependencies.include?(dependency)
-      end
-
-      # Clears the list of loaded dependencies.
-      #
-      def clear_loaded
-        @_loaded_dependencies.clear
-      end
-    end
-
-    # Registers a new dependency.
-    #
-    # @param [String] name the name of the gem
-    # @param [String] version the version of the gem
-    #
-    def dependency(name, version)
-      @_dependencies << Dependency.new(name, version)
-    end
-
-    # Loads the registered dependencies.
-    #
-    # @raise DependencyManager::Error if the dependency can't be loaded.
-    #
-    def load_depenencies
-      @_dependencies.each do |dependency|
-        begin
-          next if DependencyManager.already_loaded?(dependency)
-          gem(dependency.name, dependency.version)
-          require(dependency.name)
-          DependencyManager.add_loaded(dependency)
-          @_dependencies.delete(dependency)
-        rescue Gem::LoadError
-          args = [dependency.name, dependency.version]
-          command = if running_under_bundler?
-            BUNDLER_DECLARE_GEM % args
-          else
-            GEM_INSTALL_COMMAND % args.reverse
-          end
-          message = GEM_LOAD_MESSAGE % args
-
-          raise Error.new(message + command)
-        end
-      end
-    end
-
-    # Returns whether all the dependencies has been loaded or not.
-    #
-    # @return [Boolean]
-    #
-    def dependencies_loaded?
-      @_dependencies.empty?
-    end
-
-    private
-
-    # Returns whether we are running under bundler or not
-    #
-    # @return [Boolean]
-    #
-    def running_under_bundler?
-      !!(File.exists?('Gemfile') && ENV['BUNDLE_GEMFILE'])
-    end
-  end
-end