listen 3.2.1 → 3.3.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9a53907593c7c8390f895d361bce34873381883dbd033e02d1706e2e28c13d1
-  data.tar.gz: 5a8dfdc3c74345e7283b5f5aee13b5ded0f3f44c8fecaf7027551eb2359ecdae
+  metadata.gz: 82d32d20751964de477dd8c2ff8af48cc0c70558b323c1043b37d5bf9183c3ba
+  data.tar.gz: fb40a33b41e0bf52ce30303fc88a7fb1dd35a9d56e2e920fccf598fcd7193c17
 SHA512:
-  metadata.gz: b5cbabed841e265c54aebfff999d306f5a91590e5e5abe8f9867c5ea9e66caa4d952acc7e7b8be10c2f1ea0a77b0ff4a07d653ec45d3009e149b5faa8331a689
-  data.tar.gz: 76c990e22b861cae3d9c764a290fab1ed90f6547b9c1329c92be797b8d99364ae21cb3367a84e8064e6834c9a3b76ab440a8c597f0dcacae1e06b1991e39c303
+  metadata.gz: 14e679e027bb5c100eaf438f10ec96ce5336465366facf7559a19ed6fa23d0c6e89f72eba25fb53a1e689ca08d0572d54399826b3d78d5cb354f2b2c7d105b61
+  data.tar.gz: 4b4f93d99b7519d06a7302152e8d86332edb8a656caef7c1b164596d79c221d539ad0a29481709915070945e46fb1c4661bde3368f0e9c55cd277ffe52bc8b13

data/README.md

@@ -1,13 +1,14 @@
-## IMPORTANT: If you cannot install Listen (e.g. on Travis/CI builds), [a workaround is here](https://github.com/guard/listen/wiki/Ruby-version-requirements)
-
-:exclamation: Listen is currently accepting more maintainers. Please [read this](https://github.com/guard/guard/wiki/Maintainers) if you're interested in joining the team.
-
 # Listen
 
-[![Gem Version](https://badge.fury.io/rb/listen.svg)](http://badge.fury.io/rb/listen) [![Build Status](https://travis-ci.org/guard/listen.svg)](https://travis-ci.org/guard/listen) [![Code Climate](https://codeclimate.com/github/guard/listen.svg)](https://codeclimate.com/github/guard/listen) [![Coverage Status](https://coveralls.io/repos/guard/listen/badge.svg?branch=master)](https://coveralls.io/r/guard/listen)
-
 The Listen gem listens to file modifications and notifies you about the changes.
 
+:exclamation: Listen is currently accepting more maintainers. Please [read this](https://github.com/guard/guard/wiki/Maintainers) if you're interested in joining the team.
+
+[![Development Status](https://github.com/guard/listen/workflows/Development/badge.svg)](https://github.com/guard/listen/actions?workflow=Development)
+[![Gem Version](https://badge.fury.io/rb/listen.svg)](http://badge.fury.io/rb/listen)
+[![Code Climate](https://codeclimate.com/github/guard/listen.svg)](https://codeclimate.com/github/guard/listen)
+[![Coverage Status](https://coveralls.io/repos/guard/listen/badge.svg?branch=master)](https://coveralls.io/r/guard/listen)
+
 ## Features
 
 * OS-optimized adapters on MRI for Mac OS X 10.6+, Linux, \*BSD and Windows, [more info](#listen-adapters) below.

data/lib/listen.rb

@@ -1,23 +1,18 @@
+# frozen_string_literal: true
+
 require 'logger'
+require 'weakref'
 require 'listen/logger'
 require 'listen/listener'
 
-require 'listen/internals/thread_pool'
-
-# Always set up logging by default first time file is required
-#
-# NOTE: If you need to clear the logger completely, do so *after*
-# requiring this file. If you need to set a custom logger,
-# require the listen/logger file and set the logger before requiring
-# this file.
-Listen.setup_default_logger_if_unset
-
 # Won't print anything by default because of level - unless you've set
 # LISTEN_GEM_DEBUGGING or provided your own logger with a high enough level
-Listen::Logger.info "Listen loglevel set to: #{Listen.logger.level}"
-Listen::Logger.info "Listen version: #{Listen::VERSION}"
+Listen.logger.info "Listen loglevel set to: #{Listen.logger.level}"
+Listen.logger.info "Listen version: #{Listen::VERSION}"
 
 module Listen
+  @listeners = Queue.new
+
   class << self
     # Listens to file system modifications on a either single directory or
     # multiple directories.
@@ -32,21 +27,21 @@ module Listen
     # @return [Listen::Listener] the listener
     #
     def to(*args, &block)
-      @listeners ||= []
       Listener.new(*args, &block).tap do |listener|
-        @listeners << listener
+        @listeners.enq(WeakRef.new(listener))
       end
     end
 
     # This is used by the `listen` binary to handle Ctrl-C
     #
     def stop
-      Internals::ThreadPool.stop
-      @listeners ||= []
-
-      # TODO: should use a mutex for this
-      @listeners.each(&:stop)
-      @listeners = nil
+      while (listener = @listeners.deq(true))
+        begin
+          listener.stop
+        rescue WeakRef::RefError
+        end
+      end
+    rescue ThreadError
     end
   end
 end

data/lib/listen/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'listen/adapter/base'
 require 'listen/adapter/bsd'
 require 'listen/adapter/darwin'
@@ -13,15 +15,15 @@ module Listen
 
     class << self
       def select(options = {})
-        _log :debug, 'Adapter: considering polling ...'
+        Listen.logger.debug 'Adapter: considering polling ...'
         return Polling if options[:force_polling]
-        _log :debug, 'Adapter: considering optimized backend...'
+        Listen.logger.debug 'Adapter: considering optimized backend...'
         return _usable_adapter_class if _usable_adapter_class
-        _log :debug, 'Adapter: falling back to polling...'
+        Listen.logger.debug 'Adapter: falling back to polling...'
         _warn_polling_fallback(options)
         Polling
       rescue
-        _log :warn, format('Adapter: failed: %s:%s', $ERROR_POSITION.inspect,
+        Listen.logger.warn format('Adapter: failed: %s:%s', $ERROR_POSITION.inspect,
                            $ERROR_POSITION * "\n")
         raise
       end
@@ -36,10 +38,6 @@ module Listen
         msg = options.fetch(:polling_fallback_message, POLLING_FALLBACK_MESSAGE)
         Kernel.warn "[Listen warning]:\n  #{msg}" if msg
       end
-
-      def _log(type, message)
-        Listen::Logger.send(type, message)
-      end
     end
   end
 end

data/lib/listen/adapter/base.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'listen/options'
 require 'listen/record'
 require 'listen/change'
+require 'listen/thread'
 
 module Listen
   module Adapter
@@ -30,7 +33,7 @@ module Listen
       # TODO: it's a separate method as a temporary workaround for tests
       def configure
         if @configured
-          _log(:warn, 'Adapter already configured!')
+          Listen.logger.warn('Adapter already configured!')
           return
         end
 
@@ -63,48 +66,39 @@ module Listen
         configure
 
         if started?
-          _log(:warn, 'Adapter already started!')
+          Listen.logger.warn('Adapter already started!')
           return
         end
 
         @started = true
 
-        calling_stack = caller.dup
-        Listen::Internals::ThreadPool.add do
-          begin
-            @snapshots.values.each do |snapshot|
-              _timed('Record.build()') { snapshot.record.build }
-            end
-            _run
-          rescue
-            msg = 'run() in thread failed: %s:\n'\
-              ' %s\n\ncalled from:\n %s'
-            _log_exception(msg, calling_stack)
-            raise # for unit tests mostly
+        @run_thread = Listen::Thread.new("run_thread") do
+          @snapshots.values.each do |snapshot|
+            _timed('Record.build()') { snapshot.record.build }
           end
+          _run
         end
       end
 
       def stop
         _stop
-      end
-
-      def self.usable?
-        const_get('OS_REGEXP') =~ RbConfig::CONFIG['target_os']
+        config.queue.close # this causes queue.pop to return `nil` to the front-end
       end
 
       private
 
       def _stop
+        @run_thread&.kill
+        @run_thread = nil
       end
 
       def _timed(title)
         start = Time.now.to_f
         yield
         diff = Time.now.to_f - start
-        Listen::Logger.info format('%s: %.05f seconds', title, diff)
+        Listen.logger.info format('%s: %.05f seconds', title, diff)
       rescue
-        Listen::Logger.warn "#{title} crashed: #{$ERROR_INFO.inspect}"
+        Listen.logger.warn "#{title} crashed: #{$ERROR_INFO.inspect}"
         raise
       end
 
@@ -114,10 +108,6 @@ module Listen
         @snapshots[dir].invalidate(type, rel_path, options)
       end
 
-      def _log(*args, &block)
-        self.class.send(:_log, *args, &block)
-      end
-
       def _log_exception(msg, caller_stack)
         formatted = format(
           msg,
@@ -126,14 +116,12 @@ module Listen
           caller_stack * "\n"
         )
 
-        _log(:error, formatted)
+        Listen.logger.error(formatted)
       end
 
       class << self
-        private
-
-        def _log(*args, &block)
-          Listen::Logger.send(*args, &block)
+        def usable?
+          const_get('OS_REGEXP') =~ RbConfig::CONFIG['target_os']
         end
       end
     end

data/lib/listen/adapter/bsd.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Listener implementation for BSD's `kqueue`.
 # @see http://www.freebsd.org/cgi/man.cgi?query=kqueue
 # @see https://github.com/mat813/rb-kqueue/blob/master/lib/rb-kqueue/queue.rb
@@ -94,7 +96,7 @@ module Listen
       def _watch_file(path, queue)
         queue.watch_file(path, *options.events, &@callback)
       rescue Errno::ENOENT => e
-        _log :warn, "kqueue: watch file failed: #{e.message}"
+        Listen.logger.warn "kqueue: watch file failed: #{e.message}"
       end
 
       # Quick rubocop workaround

data/lib/listen/adapter/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module Listen

data/lib/listen/adapter/darwin.rb

@@ -1,12 +1,13 @@
-require 'thread'
-require 'listen/internals/thread_pool'
+# frozen_string_literal: true
+
+require 'listen/thread'
 
 module Listen
   module Adapter
     # Adapter implementation for Mac OS X `FSEvents`.
     #
     class Darwin < Base
-      OS_REGEXP = /darwin(?<major_version>1\d+)/i
+      OS_REGEXP = /darwin(?<major_version>(1|2)\d+)/i
 
       # The default delay between checking for changes.
       DEFAULTS = { latency: 0.1 }.freeze
@@ -43,9 +44,9 @@ module Listen
         require 'rb-fsevent'
         worker = FSEvent.new
         dirs_to_watch = @callbacks.keys.map(&:to_s)
-        _log(:info) { "fsevent: watching: #{dirs_to_watch.inspect}" }
+        Listen.logger.info { "fsevent: watching: #{dirs_to_watch.inspect}" }
         worker.watch(dirs_to_watch, { latency: options.latency }, &method(:_process_changes))
-        Listen::Internals::ThreadPool.add { _run_worker(worker) }
+        @worker_thread = Listen::Thread.new("worker_thread") { worker.run }
       end
 
       def _process_changes(dirs)
@@ -61,18 +62,15 @@ module Listen
       end
 
       def _process_event(dir, path)
-        _log(:debug) { "fsevent: processing path: #{path.inspect}" }
+        Listen.logger.debug { "fsevent: processing path: #{path.inspect}" }
         # TODO: does this preserve symlinks?
         rel_path = path.relative_path_from(dir).to_s
         _queue_change(:dir, dir, rel_path, recursive: true)
       end
 
-      def _run_worker(worker)
-        _log(:debug) { "fsevent: running worker: #{worker.inspect}" }
-        worker.run
-      rescue
-        format_string = 'fsevent: running worker failed: %s:%s called from: %s'
-        _log_exception format_string, caller
+      def _stop
+        @worker_thread&.kill
+        super
       end
     end
   end

data/lib/listen/adapter/linux.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   module Adapter
     # @see https://github.com/nex3/rb-inotify
@@ -35,9 +37,7 @@ module Listen
       end
 
       def _run
-        Thread.current[:listen_blocking_read_thread] = true
         @worker.run
-        Thread.current[:listen_blocking_read_thread] = false
       end
 
       def _process_event(dir, event)
@@ -47,7 +47,7 @@ module Listen
         path = Pathname.new(event.watcher.path) + event.name
         rel_path = path.relative_path_from(dir).to_s
 
-        _log(:debug) { "inotify: #{rel_path} (#{event.flags.inspect})" }
+        Listen.logger.debug { "inotify: #{rel_path} (#{event.flags.inspect})" }
 
         if /1|true/ =~ ENV['LISTEN_GEM_SIMULATE_FSEVENT']
           if (event.flags & [:moved_to, :moved_from]) || _dir_event?(event)
@@ -99,7 +99,9 @@ module Listen
       end
 
       def _stop
-        @worker && @worker.close
+        @worker&.close
+
+        super
       end
     end
   end

data/lib/listen/adapter/polling.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   module Adapter
     # Polling Adapter that works cross-platform and

data/lib/listen/adapter/windows.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   module Adapter
     # Adapter implementation for Windows `wdm`.
@@ -15,7 +17,7 @@ module Listen
         require 'wdm'
         true
       rescue LoadError
-        _log :debug, format('wdm - load failed: %s:%s', $ERROR_INFO,
+        Listen.logger.debug format('wdm - load failed: %s:%s', $ERROR_INFO,
                             $ERROR_POSITION * "\n")
 
         Kernel.warn BUNDLER_DECLARE_GEM
@@ -26,7 +28,7 @@ module Listen
 
       def _configure(dir)
         require 'wdm'
-        _log :debug, 'wdm - starting...'
+        Listen.logger.debug 'wdm - starting...'
         @worker ||= WDM::Monitor.new
         @worker.watch_recursively(dir.to_s, :files) do |change|
           yield([:file, change])
@@ -47,7 +49,7 @@ module Listen
       end
 
       def _process_event(dir, event)
-        _log :debug, "wdm - callback: #{event.inspect}"
+        Listen.logger.debug "wdm - callback: #{event.inspect}"
 
         type, change = event
 
@@ -80,7 +82,7 @@ module Listen
         end
       rescue
         details = event.inspect
-        _log :error, format('wdm - callback (%s): %s:%s', details, $ERROR_INFO,
+        Listen.logger.error format('wdm - callback (%s): %s:%s', details, $ERROR_INFO,
                             $ERROR_POSITION * "\n")
         raise
       end

data/lib/listen/backend.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'listen/adapter'
 require 'listen/adapter/base'
 require 'listen/adapter/config'

data/lib/listen/change.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'listen/file'
 require 'listen/directory'
 
@@ -35,13 +37,13 @@ module Listen
       cookie = options[:cookie]
 
       if !cookie && config.silenced?(rel_path, type)
-        Listen::Logger.debug { "(silenced): #{rel_path.inspect}" }
+        Listen.logger.debug { "(silenced): #{rel_path.inspect}" }
         return
       end
 
       path = watched_dir + rel_path
 
-      Listen::Logger.debug do
+      Listen.logger.debug do
         log_details = options[:silence] && 'recording' || change || 'unknown'
         "#{log_details}: #{type}:#{path} (#{options.inspect})"
       end
@@ -65,7 +67,7 @@ module Listen
         __method__,
         exinspect,
         ex.backtrace * "\n")
-      Listen::Logger.error(msg)
+      Listen.logger.error(msg)
       raise
     end
 

data/lib/listen/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'listen'
 require 'logger'
@@ -35,8 +37,7 @@ module Listen
     attr_reader :logger
     def initialize(options)
       @options = options
-      @logger = ::Logger.new(STDOUT)
-      @logger.level = ::Logger::INFO
+      @logger = ::Logger.new(STDOUT, level: ::Logger::INFO)
       @logger.formatter = proc { |_, _, _, msg| "#{msg}\n" }
     end
 

data/lib/listen/directory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Listen
@@ -14,7 +16,7 @@ module Listen
       path = dir + rel_path
       current = Set.new(_children(path))
 
-      Listen::Logger.debug do
+      Listen.logger.debug do
         format('%s: %s(%s): %s -> %s',
                (options[:silence] ? 'Recording' : 'Scanning'),
                rel_path, options.inspect, previous.inspect, current.inspect)
@@ -47,7 +49,7 @@ module Listen
       _async_changes(snapshot, path, previous, options)
       _change(snapshot, :file, rel_path, options)
     rescue
-      Listen::Logger.warn do
+      Listen.logger.warn do
         format('scan DIED: %s:%s', $ERROR_INFO, $ERROR_POSITION * "\n")
       end
       raise