listen 2.7.11 → 2.7.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50a3ac06e4268a2cd6b85ceae0dbf31f8683ab6f
-  data.tar.gz: 640a42142e94ab28e6d7414bedd864d5e7bf4d71
+  metadata.gz: 65b3168861b5ccc57809689d8ad5849a631db822
+  data.tar.gz: 3640593ce18fa45435a2ff0184e9c7fda77acfce
 SHA512:
-  metadata.gz: 2dc86cec1578b84961649ad4a1f685fc33bbc243397884c46cb3e047f3221e7b5f529c5940d5bf4be950f280dd0927899c7b4ba91e9844f8a77a736614905358
-  data.tar.gz: 1467477d54aa38100d861d73e3f1714906c2e7cddc9ae0917468934ab5a69ba13c0eeeabda7af3c89dcb5032938128406bcbbe50489ca5deb2b8de848058425f
+  metadata.gz: 1ba0723ef31cfc026fb71bc89f0d1f951cbd276270bb57329fef1ffa5aae8e982f645a69a2a7bbf39591ae6d8160950fbb71f356417874948c39d010559cca31
+  data.tar.gz: 1203e42ab3497f1c2d1348330398880f92b1932038f60b7f8f2283e67bfc4e04e034f10b35389bb00a0775db352d91228af98243951f702137cbc19a3ffe2ad5

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,232 +1,20 @@
-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
+inherit_from:
+  - vendor/hound/config/style_guides/ruby.yml
+  - .rubocop_todo.yml
+
+# Rails cops
+AllCops:
+  RunRailsCops: true
+
+# Files you want to exclude
+AllCops:
+  Exclude:
+    - db/schema.rb
+    - Gemfile
+    - Guardfile
+    - Rakefile
+
+# TODO: put your overrides here:
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,33 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-11-11 16:35:31 +0100 using RuboCop version 0.25.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 223
+
+# Offense count: 7
+Metrics/CyclomaticComplexity:
+  Max: 14
+
+# Offense count: 27
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 34
+
+# Offense count: 5
+Metrics/PerceivedComplexity:
+  Max: 16
+
+# Offense count: 19
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 44
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/DotPosition:
+  Enabled: false

data/CONTRIBUTING.md

@@ -4,6 +4,8 @@ Contribute to Listen
 File an issue
 -------------
 
+If you haven't already, first see [TROUBLESHOOTING](https://github.com/guard/listen/blob/master/TROUBLESHOOTING.md) for known issues, solutions and workarounds.
+
 You can report bugs and feature requests to [GitHub Issues](https://github.com/guard/listen/issues).
 
 **Please don't ask question in the issue tracker**, instead ask them in our
@@ -11,14 +13,12 @@ You can report bugs and feature requests to [GitHub Issues](https://github.com/g
 
 Try to figure out where the issue belongs to: Is it an issue with Listen itself or with Guard?
 
-When you file a bug, please try to follow these simple rules if applicable:
-
-* Make sure you run Listen with `bundle exec` first.
-* Add your `Guardfile` (if used) and `Gemfile` to the issue.
-* Make sure that the issue is reproducible with your description.
 
 **It's most likely that your bug gets resolved faster if you provide as much information as possible!**
 
+The MOST useful information is debugging output from Listen (`LISTEN_GEM_DEBUGGING=1`) - see [TROUBLESHOOTING](https://github.com/guard/listen/blob/master/TROUBLESHOOTING.md) for details.
+
+
 Development
 -----------
 

data/Gemfile

@@ -37,6 +37,7 @@ end
 group :tool do
   gem 'yard', require: false
   gem 'guard-rspec', require: false
+  gem 'rubocop', '0.25.0' # TODO: should match Gemfile HoundCi
   gem 'guard-rubocop'
   gem 'pry-rescue'
   gem 'pry-stack_explorer'

data/Guardfile

@@ -1,13 +1,16 @@
 ignore(%r{spec/\.fixtures/})
 
-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
+group :specs, halt_on_fail: true 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]) }
+  guard :rubocop, all_on_start: false, cli: '--rails' do
+    watch(%r{.+\.rb$}) { |m| m[0] }
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+    watch(%r{(?:.+/)?\.rubocop_todo\.yml$}) { |m| File.dirname(m[0]) }
+  end
 end

data/README.md

@@ -17,12 +17,13 @@ The Listen gem listens to file modifications and notifies you about the changes.
 * Tested on MRI Ruby environments (1.9+ only) via [Travis CI](https://travis-ci.org/guard/listen),
 
 Please note that:
+- Some filesystems won't work without polling (VM/Vagrant Shared folders, NFS, Samba, sshfs, etc.)
 - 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.
 - \*BSD is broken and not supported any more, see: [#220](https://github.com/guard/listen/issues/220)
 
 
-## Pending features
+## Pending features / issues
 
 * ~~Non-recursive directory scanning~~ [#111](https://github.com/guard/listen/issues/111)
 * Symlinks support. [#25](https://github.com/guard/listen/issues/25)
@@ -168,11 +169,12 @@ 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.
 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
-work on any system. This adapter is slower than the rest of the adapters.
+There is also a polling adapter - although it's much slower than other adapters,
+it works on every platform/system and scenario (including network filesystems such as VM shared folders).
 
 The Darwin and Linux adapters are dependencies of the Listen gem so they work out of the box. For other adapters a specific gem will have to be added to your Gemfile, please read below.
 
@@ -182,12 +184,12 @@ while initializing the listener.
 
 ### On Windows
 
-If your are on Windows, you can try to use the [`wdm`](https://github.com/Maher4Ever/wdm) instead of polling.
+If your are on Windows, it's recommended to use the [`wdm`](https://github.com/Maher4Ever/wdm) adapter instead of polling.
+
 Please add the following to your Gemfile:
 
 ```ruby
-require 'rbconfig'
-gem 'wdm', '>= 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw|cygwin/i
+gem 'wdm', '>= 0.1.0' if Gem.win_platform?
 ```
 
 ### On \*BSD
@@ -195,6 +197,7 @@ gem 'wdm', '>= 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw|cygwin/i
 **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
@@ -213,29 +216,10 @@ end
 
 ### Issues and troubleshooting
 
-Sometimes OS-specific adapters don't work. :'(
-
-Here are some things you could try to avoid forcing polling.
-
-* [Update your Dropbox client](http://www.dropbox.com/downloading), if you have Dropbox installed.
-* Move or rename the listened directory.
-* Update/reboot your OS.
-* Increase latency.
-* If running Linux, check and see if you need package inotify-tools
-
-If your application keeps using the polling-adapter and you can't figure out why, feel free to [open an issue](https://github.com/guard/listen/issues/new) (and be sure to [give all the details](https://github.com/guard/listen/blob/master/CONTRIBUTING.md)).
-
-Also, if you have problems related to receiving the wrong events, too many
-events or none at all, be sure set the environment variable
-`LISTEN_GEM_DEBUGGING=1` and include the output when reporting a new issue.
+*NOTE: without providing the output after setting the `LISTEN_GEM_DEBUGGING=1` environment variable, it can be almost impossible to guess why listen is not working as expected.*
 
-If the listener works and then stops listening at some point and no errors are
-shown with `LISTEN_GEM_DEBUGGING=1`, set `LISTEN_GEM_DEBUGGING=2` for full
-logging.
+See [TROUBLESHOOTING](https://github.com/guard/listen/blob/master/TROUBLESHOOTING.md)
 
-Listen traps SIGINT signal to properly finalize listeners. If you plan
-on trapping this signal yourself - make sure to call `Listen.stop` in
-signal handler.
 
 ## Performance
 
@@ -250,13 +234,15 @@ Also, if the directories you're watching contain many files, make sure you're:
 * not running multiple instances of Listen in the background
 * using a file system with atime modification disabled (ideally)
 * not using a filesystem with inaccurate file modification times (ideally), e.g. HFS, VFAT
-* running Listen with the latency option not too small or too big (depends on needs)
+* running Listen with the `:latency` and `:wait_for_delay` options not too small or too big (depends on needs)
+* not buffering to a slow terminal (e.g. transparency + fancy font + slow gfx card + lots of output)
+* ideally not running a slow encryption stack, e.g. btrfs + ecryptfs
 
 When in doubt, LISTEN_GEM_DEBUGGING=2 can help discover the actual events and time they happened.
 
 ## Forwarding file events over TCP
 
-Listen is capable of forwarding file events over the network using a messaging protocol. This can be useful for virtualized development environments when file events are unavailable, as is the case with [Vagrant](https://github.com/mitchellh/vagrant).
+Listen is capable of forwarding file events over the network using a messaging protocol. This can be useful for virtualized development environments when file events are unavailable, as is the case with shared folders in VMs. [Vagrant](https://github.com/mitchellh/vagrant) uses Listen in it's rsync-auto mode to solve this issue.
 
 To broadcast events over TCP programmatically, use the `forward_to` option with an address - just a port or a hostname/port combination: