listen 3.2.1 → 3.3.0.pre.2

data/lib/listen/listener.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'English'
 
 require 'listen/version'
@@ -19,7 +21,6 @@ require 'listen/listener/config'
 
 module Listen
   class Listener
-    # TODO: move the state machine's methods private
     include Listen::FSM
 
     # Initializes the directories listener.
@@ -38,7 +39,7 @@ module Listen
       @config = Config.new(options)
 
       eq_config = Event::Queue::Config.new(@config.relative?)
-      queue = Event::Queue.new(eq_config) { @processor.wakeup_on_event }
+      queue = Event::Queue.new(eq_config)
 
       silencer = Silencer.new
       rules = @config.silencer_rules
@@ -57,41 +58,42 @@ module Listen
 
       @processor = Event::Loop.new(pconfig)
 
-      super() # FSM
+      initialize_fsm
     end
 
-    default_state :initializing
+    start_state :initializing
 
     state :initializing, to: [:backend_started, :stopped]
 
-    state :backend_started, to: [:frontend_ready, :stopped] do
-      backend.start
-    end
-
-    state :frontend_ready, to: [:processing_events, :stopped] do
-      processor.setup
+    state :backend_started, to: [:processing_events, :stopped] do
+      @backend.start
     end
 
     state :processing_events, to: [:paused, :stopped] do
-      processor.resume
+      @processor.start
     end
 
     state :paused, to: [:processing_events, :stopped] do
-      processor.pause
+      @processor.pause
     end
 
     state :stopped, to: [:backend_started] do
-      backend.stop # should be before processor.teardown to halt events ASAP
-      processor.teardown
+      @backend.stop # halt events ASAP
+      @processor.stop
     end
 
     # Starts processing events and starts adapters
     # or resumes invoking callbacks if paused
     def start
-      transition :backend_started if state == :initializing
-      transition :frontend_ready if state == :backend_started
-      transition :processing_events if state == :frontend_ready
-      transition :processing_events if state == :paused
+      case state
+      when :initializing
+        transition :backend_started
+        transition :processing_events
+      when :paused
+        transition :processing_events
+      else
+        raise ArgumentError, "cannot start from state #{state.inspect}"
+      end
     end
 
     # Stops both listening for events and processing them
@@ -113,6 +115,10 @@ module Listen
       state == :paused
     end
 
+    def stopped?
+      state == :stopped
+    end
+
     def ignore(regexps)
       @silencer_controller.append_ignores(regexps)
     end
@@ -124,10 +130,5 @@ module Listen
     def only(regexps)
       @silencer_controller.replace_with_only(regexps)
     end
-
-    private
-
-    attr_reader :processor
-    attr_reader :backend
   end
 end

data/lib/listen/listener/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   class Listener
     class Config

data/lib/listen/logger.rb

@@ -1,32 +1,35 @@
+# frozen_string_literal: true
+
 module Listen
-  def self.logger
-    @logger ||= nil
-  end
+  @logger = nil
 
-  def self.logger=(logger)
-    @logger = logger
-  end
+  # Listen.logger will always be present.
+  # If you don't want logging, set Listen.logger = ::Logger.new('/dev/null', level: ::Logger::UNKNOWN)
+
+  class << self
+    attr_writer :logger
 
-  def self.setup_default_logger_if_unset
-    self.logger ||= ::Logger.new(STDERR).tap do |logger|
-      debugging = ENV['LISTEN_GEM_DEBUGGING']
-      logger.level =
-        case debugging.to_s
-        when /2/
-          ::Logger::DEBUG
-        when /true|yes|1/i
-          ::Logger::INFO
-        else
-          ::Logger::ERROR
-        end
+    def logger
+      @logger ||= default_logger
     end
-  end
 
-  class Logger
-    [:fatal, :error, :warn, :info, :debug].each do |meth|
-      define_singleton_method(meth) do |*args, &block|
-        Listen.logger.public_send(meth, *args, &block) if Listen.logger
-      end
+    private
+
+    def default_logger
+      level = case ENV['LISTEN_GEM_DEBUGGING'].to_s
+              when /debug|2/i
+                ::Logger::DEBUG
+              when /info|true|yes|1/i
+                ::Logger::INFO
+              when /warn/i
+                ::Logger::WARN
+              when /fatal/i
+                ::Logger::FATAL
+              else
+                ::Logger::ERROR
+              end
+
+      ::Logger.new(STDERR, level: level)
     end
   end
 end

data/lib/listen/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   class Options
     def initialize(opts, defaults)
@@ -10,7 +12,7 @@ module Listen
       return if given_options.empty?
 
       msg = "Unknown options: #{given_options.inspect}"
-      Listen::Logger.warn msg
+      Listen.logger.warn msg
       fail msg
     end
 

data/lib/listen/queue_optimizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   class QueueOptimizer
     class Config

data/lib/listen/record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thread'
 require 'listen/record/entry'
 require 'listen/record/symlink_detector'
@@ -45,8 +47,7 @@ module Listen
         if [nil, '', '.'].include? rel_path.to_s
           tree
         else
-          tree[rel_path.to_s] ||= _auto_hash
-          tree[rel_path.to_s]
+          _sub_tree(rel_path)
         end
 
       result = {}
@@ -57,6 +58,19 @@ module Listen
       result
     end
 
+    def _sub_tree(rel_path)
+      tree.each_with_object({}) do |(path, meta), result|
+        next unless path.start_with?(rel_path)
+
+        if path == rel_path
+          result.merge!(meta)
+        else
+          sub_path         = path.sub(%r{\A#{rel_path}/?}, '')
+          result[sub_path] = meta
+        end
+      end
+    end
+
     def build
       @tree = _auto_hash
       # TODO: test with a file name given

data/lib/listen/record/entry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   # @private api
   class Record
@@ -22,7 +24,7 @@ module Listen
 
       def meta
         lstat = ::File.lstat(sys_path)
-        { mtime: lstat.mtime.to_f, mode: lstat.mode }
+        { mtime: lstat.mtime.to_f, mode: lstat.mode, size: lstat.size }
       end
 
       # record hash is e.g.

data/lib/listen/record/symlink_detector.rb

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

data/lib/listen/silencer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   class Silencer
     # The default list of directories that get ignored.

data/lib/listen/silencer/controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   class Silencer
     class Controller

data/lib/listen/thread.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'thread'
+
+require_relative 'logger'
+
+module Listen
+  module Thread
+    class << self
+      # Creates a new thread with the given name.
+      # Any exceptions raised by the thread will be logged with the thread name and complete backtrace.
+      def new(name)
+        thread_name = "listen-#{name}"
+
+        caller_stack = caller
+        ::Thread.new do
+          begin
+            yield
+          rescue Exception => ex
+            _log_exception(ex, thread_name, caller_stack)
+            nil
+          end
+        end.tap do |thread|
+          thread.name = thread_name
+        end
+      end
+
+      private
+
+      def _log_exception(ex, thread_name, caller_stack)
+        complete_backtrace = [*ex.backtrace, "--- Thread.new ---", *caller_stack]
+        message = "Exception rescued in #{thread_name}:\n#{_exception_with_causes(ex)}\n#{complete_backtrace * "\n"}"
+        Listen.logger.error(message)
+      end
+
+      def _exception_with_causes(ex)
+        result = +"#{ex.class}: #{ex}"
+        if ex.cause
+          result << "\n"
+          result << "--- Caused by: ---\n"
+          result << _exception_with_causes(ex.cause)
+        end
+        result
+      end
+    end
+  end
+end

data/lib/listen/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
-  VERSION = '3.2.1'.freeze
+  VERSION = '3.3.0.pre.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0.pre.2
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-05 00:00:00.000000000 Z
+date: 2020-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
@@ -50,22 +50,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.10
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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
-  changes. Works everywhere!
+  changegem. Works everywhere!
 email: thibaud@thibaud.gg
 executables:
 - listen
@@ -96,7 +82,6 @@ files:
 - lib/listen/event/queue.rb
 - lib/listen/file.rb
 - lib/listen/fsm.rb
-- lib/listen/internals/thread_pool.rb
 - lib/listen/listener.rb
 - lib/listen/listener/config.rb
 - lib/listen/logger.rb
@@ -107,30 +92,29 @@ files:
 - lib/listen/record/symlink_detector.rb
 - lib/listen/silencer.rb
 - lib/listen/silencer/controller.rb
+- lib/listen/thread.rb
 - lib/listen/version.rb
 homepage: https://github.com/guard/listen
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
-    - !ruby/object:Gem::Version
-      version: '2.2'
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.2.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Listen to file modifications

data/lib/listen/internals/thread_pool.rb

@@ -1,29 +0,0 @@
-module Listen
-  # @private api
-  module Internals
-    module ThreadPool
-      def self.add(&block)
-        Thread.new { block.call }.tap do |th|
-          (@threads ||= Queue.new) << th
-        end
-      end
-
-      def self.stop
-        return unless @threads ||= nil
-        return if @threads.empty? # return to avoid using possibly stubbed Queue
-
-        killed = Queue.new
-        # You can't kill a read on a descriptor in JRuby, so let's just
-        # ignore running threads (listen rb-inotify waiting for disk activity
-        # before closing)  pray threads die faster than they are created...
-        limit = RUBY_ENGINE == 'jruby' ? [1] : []
-
-        killed << @threads.pop.kill until @threads.empty?
-        until killed.empty?
-          th = killed.pop
-          th.join(*limit) unless th[:listen_blocking_read_thread]
-        end
-      end
-    end
-  end
-end