listen 2.7.4 → 2.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 959fbba40046ffb9eed7759c7c3169bfbd5c592a
-  data.tar.gz: e3a755884abdc5e53bba22a87afaf4c167ddc9d7
+  metadata.gz: f2b1fec6652b9c788556648b883430623b4953d2
+  data.tar.gz: 84e2262d6b7952b3afdb08defa5035604718f2f9
 SHA512:
-  metadata.gz: 2f1a7354c43c2f29405183e81d5497241e3238acb3cb6b3b4987c720125b1dcc09f64ef29ef704985116008b32a63f35a53ea2d97c075a0451daa0c9904ab6e5
-  data.tar.gz: 73755c82578e92f4d6a2111a30445c4cd7c9a40c9399347da5d37c7ef68a7cd373d17381a1c24cff517a9936ab799ac564e3dc6ef698a73dcd4ef55b69113313
+  metadata.gz: 3b7d31da3edbb75296f7bc8f174c192c9317f87295c13eca6081fbac78793b8b28a9d88851e00f9b74dce5cff508d6bf31ab5e552e1fb1f941160589809a8aba
+  data.tar.gz: 6d4df130ce978ecbbb46069030d1a7324aac5624719c2129d570e6fb7b5553035e4c44dd3c5a9618ec07d2bae9bc6a0099b44dbe448c4b90355ac08620d9ddcd

data/.rubocop.yml

@@ -0,0 +1,232 @@
+AccessorMethodName:
+  Enabled: false
+
+Alias:
+  Enabled: false
+
+ArrayJoin:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+AsciiIdentifiers:
+  Enabled: false
+
+Attr:
+  Enabled: false
+
+BlockNesting:
+  Enabled: false
+
+CaseEquality:
+  Enabled: false
+
+CharacterLiteral:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+ClassVars:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    find: detect
+    reduce: inject
+    collect: map
+    find_all: select
+
+ColonMethodCall:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Delegate:
+  Enabled: false
+
+DeprecatedHashMethods:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+DoubleNegation:
+  Enabled: false
+
+EmptyLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+EvenOdd:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+FlipFlop:
+  Enabled: false
+
+FormatString:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+IfWithSemicolon:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+LambdaCall:
+  Enabled: false
+
+LineEndConcatenation:
+  Enabled: false
+
+LineLength:
+  Max: 80
+
+MethodLength:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+NegatedIf:
+  Enabled: false
+
+NegatedWhile:
+  Enabled: false
+
+NilComparison:
+  Enabled: false
+
+Not:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false
+
+OneLineConditional:
+  Enabled: false
+
+OpMethod:
+  Enabled: false
+
+ParameterLists:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%': '{}'
+
+PerlBackrefs:
+  Enabled: false
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Proc:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+SelfAssignment:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+SingleLineMethods:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+TrailingComma:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+WhenThen:
+  Enabled: false
+
+WhileUntilModifier:
+  Enabled: false
+
+WordArray:
+  Enabled: false
+
+# Lint
+
+AmbiguousOperator:
+  Enabled: false
+
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ConditionPosition:
+  Enabled: false
+
+DeprecatedClassMethods:
+  Enabled: false
+
+ElseLayout:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+InvalidCharacterLiteral:
+  Enabled: false
+
+LiteralInCondition:
+  Enabled: false
+
+LiteralInInterpolation:
+  Enabled: false
+
+Loop:
+  Enabled: false
+
+ParenthesesAsGroupedExpression:
+  Enabled: false
+
+RequireParentheses:
+  Enabled: false
+
+UnderscorePrefixedVariableName:
+  Enabled: false
+
+Void:
+  Enabled: false

data/.travis.yml

@@ -3,14 +3,17 @@ bundler_args: --without tool
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.2
   - jruby
-  - rbx
+  - rbx-2
 matrix:
   allow_failures:
     - rvm: jruby
-    - rvm: rbx
+    - rvm: rbx-2
 notifications:
   recipients:
     - thibaud@thibaud.gg
     - remy@rymai.me
+os:
+  - linux
+  - osx

data/Gemfile

@@ -4,11 +4,19 @@ gemspec
 
 require 'rbconfig'
 gem 'wdm', '>= 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw|cygwin/i
-gem 'rb-kqueue', '>= 0.2' if RbConfig::CONFIG['target_os'] =~ /freebsd/i
+
+if RbConfig::CONFIG['target_os'] =~ /bsd|dragonfly/i
+  gem 'rb-kqueue', '>= 0.2'
+  # Versions not included have known bugs
+  # Even master branches may not work...
+  gem 'ffi', github: 'carpetsmoker/ffi', ref: 'ac63e07f7'
+  gem 'celluloid', github: 'celluloid/celluloid', ref: '7fdef04'
+end
 
 group :tool do
   gem 'yard', require: false
   gem 'guard-rspec', require: false
+  gem 'guard-rubocop'
 end
 
 group :test do

data/Guardfile

@@ -1,6 +1,11 @@
-guard :rspec do
+guard :rspec, cmd: 'bundle exec rspec', failed_mode: :keep do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch(%r{^spec/support/*})    { 'spec' }
   watch('spec/spec_helper.rb')  { 'spec' }
 end
+
+guard :rubocop, all_on_start: false, cli: '--rails' do
+  watch(%r{.+\.rb$}) { |m| m[0] }
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -7,7 +7,7 @@ The Listen gem listens to file modifications and notifies you about the changes.
 ## Features
 
 * Supports watching multiple directories from a single listener.
-* OS-specific adapters on MRI for Mac OS X 10.6+, Linux, *BSD and Windows, [more info](#listen-adapters) below.
+* OS-specific adapters on MRI for Mac OS X 10.6+, Linux, ~~\*BSD~~ and Windows, [more info](#listen-adapters) below.
 * Detects file modification, addition and removal.
 * Allows supplying regexp-patterns to ignore paths for better results.
 * File content checksum comparison for modifications made under the same second (OS X only).
@@ -16,7 +16,9 @@ The Listen gem listens to file modifications and notifies you about the changes.
 
 Please note that:
 - Specs suite on JRuby and Rubinius aren't reliable on Travis CI, but should work.
-- Windows and *BSD adapter aren't continuously and automaticaly tested.
+- Windows and \*BSD adapter aren't continuously and automaticaly tested.
+- \*BSD is broken and not supported any more, see: [#220](https://github.com/guard/listen/issues/220)
+
 
 ## Pending features
 
@@ -154,7 +156,7 @@ Also, setting the environment variable `LISTEN_GEM_DEBUGGING=1` does the same as
 ## Listen adapters
 
 The Listen gem has a set of adapters to notify it when there are changes.
-There are 4 OS-specific adapters to support Darwin, Linux, *BSD and Windows.
+There are 4 OS-specific adapters to support Darwin, Linux, ~~*BSD~~ and Windows.
 These adapters are fast as they use some system-calls to implement the notifying function.
 
 There is also a polling adapter which is a cross-platform adapter and it will
@@ -178,12 +180,23 @@ gem 'wdm', '>= 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw|cygwin/i
 
 ### On *BSD
 
+**NOTE: *BSD currently is BROKEN with no plans to fix it or support it (see: [#220](https://github.com/guard/listen/issues/220))**
+
 If your are on *BSD you can try to use the [`rb-kqueue`](https://github.com/mat813/rb-kqueue) instead of polling.
 Please add the following to your Gemfile:
 
 ```ruby
 require 'rbconfig'
-gem 'rb-kqueue', '>= 0.2' if RbConfig::CONFIG['target_os'] =~ /freebsd/i
+gem 'rb-kqueue', '>= 0.2'
+if RbConfig::CONFIG['target_os'] =~ /bsd|dragonfly/i
+  gem 'rb-kqueue', '>= 0.2'
+
+  # Base versions have known conflicts/bugs
+  # Even master branches may not work...
+  gem 'ffi', github: 'carpetsmoker/ffi', ref: 'ac63e07f7'
+  gem 'celluloid', github: 'celluloid/celluloid', ref: '7fdef04'
+end
+
 ```
 
 ### Issues

data/lib/listen.rb

@@ -1,14 +1,15 @@
 require 'celluloid'
 require 'listen/listener'
-require 'listen/tcp/listener'
 
 module Listen
   class << self
     attr_accessor :stopping
 
-    # Listens to file system modifications on a either single directory or multiple directories.
+    # Listens to file system modifications on a either single directory or
+    # multiple directories.
     #
-    # When :forward_to is specified, this listener will broadcast modifications over TCP.
+    # When :forward_to is specified, this listener will broadcast modifications
+    # over TCP.
     #
     # @param (see Listen::Listener#new)
     #
@@ -24,6 +25,7 @@ module Listen
       @stopping = false
       options = args.last.is_a?(Hash) ? args.last : {}
       if target = options.delete(:forward_to)
+        require 'listen/tcp'
         TCP::Listener.new(target, :broadcaster, *args, &block)
       else
         Listener.new(*args, &block)
@@ -31,7 +33,9 @@ module Listen
     end
 
     # Stop all listeners & Celluloid
-    # Use it for testing purpose or when you are sure that Celluloid could be ended.
+    #
+    # Use it for testing purpose or when you are sure that Celluloid could be
+    # ended.
     #
     def stop
       Celluloid.shutdown
@@ -49,6 +53,7 @@ module Listen
     # @return [Listen::Listener] the listener
     #
     def on(target, *args, &block)
+      require 'listen/tcp'
       TCP::Listener.new(target, :recipient, *args, &block)
     end
 

data/lib/listen/adapter.rb

@@ -3,13 +3,13 @@ require 'listen/adapter/bsd'
 require 'listen/adapter/darwin'
 require 'listen/adapter/linux'
 require 'listen/adapter/polling'
-require 'listen/adapter/tcp'
 require 'listen/adapter/windows'
 
 module Listen
   module Adapter
-    OPTIMIZED_ADAPTERS = %w[Darwin Linux BSD Windows]
-    POLLING_FALLBACK_MESSAGE = "Listen will be polling for changes. Learn more at https://github.com/guard/listen#polling-fallback."
+    OPTIMIZED_ADAPTERS = %w(Darwin Linux BSD Windows)
+    POLLING_FALLBACK_MESSAGE = 'Listen will be polling for changes.'\
+      'Learn more at https://github.com/guard/listen#polling-fallback.'
 
     def self.select(options = {})
       return TCP if options[:force_tcp]
@@ -28,10 +28,8 @@ module Listen
     end
 
     def self._warn_polling_fallback(options)
-      return if options[:polling_fallback_message] == false
-
-      warning = options.fetch(:polling_fallback_message, POLLING_FALLBACK_MESSAGE)
-      Kernel.warn "[Listen warning]:\n  #{warning}"
+      msg = options.fetch(:polling_fallback_message, POLLING_FALLBACK_MESSAGE)
+      Kernel.warn "[Listen warning]:\n  #{msg}" if msg
     end
   end
 end

data/lib/listen/adapter/base.rb

@@ -1,6 +1,5 @@
 module Listen
   module Adapter
-
     class Base
       include Celluloid
 
@@ -14,11 +13,15 @@ module Listen
       end
 
       def self.usable?
-        raise NotImplementedError
+        fail NotImplementedError
       end
 
       def start
-        raise NotImplementedError
+        fail NotImplementedError
+      end
+
+      def self.local_fs?
+        true
       end
 
       private
@@ -33,9 +36,9 @@ module Listen
 
       def _notify_change(path, options)
         sleep 0.01 until listener.registry[:change_pool]
-        listener.registry[:change_pool].async.change(path, options) if listener.listen?
+        pool = listener.registry[:change_pool]
+        pool.async.change(path, options) if listener.listen?
       end
     end
-
   end
 end