listen 2.8.4 → 2.8.5

data/.rubocop_todo.yml

@@ -1,33 +0,0 @@
-# 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/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-bundler_args: --without tool
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.2
-  - jruby
-  - rbx-2
-matrix:
-  allow_failures:
-    - rvm: jruby
-    - rvm: rbx-2
-os:
-  - linux
-  - osx

data/.yardopts

@@ -1,11 +0,0 @@
---title 'Listen Documentation'
---readme README.md
---markup markdown
---markup-provider redcarpet
---private
---protected
---output-dir ./doc
-lib/**/*.rb
--
-CHANGELOG.md
-LICENSE

data/Gemfile

@@ -1,48 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-require 'rbconfig'
-
-case RbConfig::CONFIG['target_os']
-
-when /mswin|mingw|cygwin/i
-  gem 'wdm', '>= 0.1.0'
-  Kernel.warn 'NOTE: Known issues for your platform:'
-  Kernel.warn ' * celluloid-io dns resovler bug causes TCP adapter to fail'
-  Kernel.warn ' (fixed celluloid-io requires unreleased celluloid version)'
-  Kernel.warn " * celluloid master branch doesn't work properly on Windows"
-
-  # has fix, but causes above other problems:
-  # gem 'celluloid-io', github: 'celluloid/celluloid-io', ref: 'a72cae2e'
-
-when /bsd|dragonfly/i
-
-  gem 'rb-kqueue', '>= 0.2'
-
-  Kernel.warn 'NOTE: BSD is unsupported because:'
-  Kernel.warn "* Ruby threads don't work correctly (Ruby/MRI unit tests)"
-  Kernel.warn "* and because of them, Celluloid doesn't work correctly"
-
-  Kernel.warn '* FFI blows up when libc is a LD script (ac63e07f7)'
-  gem 'ffi', github: 'carpetsmoker/ffi', ref: 'ac63e07f7'
-
-  Kernel.warn '* Celluloid core detection blows up (7fdef04)'
-  gem 'celluloid', github: 'celluloid/celluloid', ref: '7fdef04'
-
-else
-  # handled by gemspec
-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'
-end
-
-group :test do
-  gem 'coveralls', require: false
-end

data/Guardfile

@@ -1,16 +0,0 @@
-ignore(%r{spec/\.fixtures/})
-
-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]) }
-    watch(%r{(?:.+/)?\.rubocop_todo\.yml$}) { |m| File.dirname(m[0]) }
-  end
-end

data/Rakefile

@@ -1,151 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-if ENV["CI"] != "true"
-  require "rubocop/rake_task"
-  RuboCop::RakeTask.new(:rubocop)
-  task default: [:spec, :rubocop]
-else
-  task default: [:spec]
-end
-
-class Releaser
-  def initialize(options = {})
-    @project_name = options.delete(:project_name) do
-      fail "project_name is needed!"
-    end
-
-    @gem_name = options.delete(:gem_name) do
-      fail "gem_name is needed!"
-    end
-
-    @github_repo = options.delete(:github_repo) do
-      fail "github_repo is needed!"
-    end
-
-    @version = options.delete(:version) do
-      fail "version is needed!"
-    end
-  end
-
-  def full
-    rubygems
-    github
-  end
-
-  def rubygems
-    begin
-      STDOUT.puts "Release #{@project_name} #{@version} to RubyGems? (y/n)"
-      input = STDIN.gets.chomp.downcase
-    end while !%w(y n).include?(input)
-
-    exit if input == "n"
-
-    Rake::Task["release"].invoke
-  end
-
-  def github
-    tag_name = "v#{@version}"
-
-    require "gems"
-
-    _verify_released
-    _verify_tag_pushed
-
-    require "octokit"
-    gh_client = Octokit::Client.new(netrc: true)
-
-    gh_release = _detect_gh_release(gh_client, tag_name, true)
-    return unless gh_release
-
-    STDOUT.puts "Draft release for #{tag_name}:\n"
-    STDOUT.puts gh_release.body
-    STDOUT.puts "\n-------------------------\n\n"
-
-    _confirm_publish
-
-    return unless _update_release(gh_client, gh_release, tag_name)
-
-    gh_release = _detect_gh_release(gh_client, tag_name, false)
-
-    _success_summary(gh_release, tag_name)
-  end
-
-  private
-
-  def _verify_released
-    if @version != Gems.info(@gem_name)["version"]
-      STDOUT.puts "#{@project_name} #{@version} is not yet released."
-      STDOUT.puts "Please release it first with: rake release:gem"
-      exit
-    end
-  end
-
-  def _verify_tag_pushed
-    tags = `git ls-remote --tags origin`.split("\n")
-    return if tags.detect { |tag| tag =~ /v#{@version}$/ }
-
-    STDOUT.puts "The tag v#{@version} has not yet been pushed."
-    STDOUT.puts "Please push it first with: rake release:gem"
-    exit
-  end
-
-  def _success_summary(gh_release, tag_name)
-    href = gh_release.rels[:html].href
-    STDOUT.puts "GitHub release #{tag_name} has been published!"
-    STDOUT.puts "\nPlease enjoy and spread the word!"
-    STDOUT.puts "Lack of inspiration? Here's a tweet you could improve:\n\n"
-    STDOUT.puts "Just released #{@project_name} #{@version}! #{href}"
-  end
-
-  def _detect_gh_release(gh_client, tag_name, draft)
-    gh_releases = gh_client.releases(@github_repo)
-    gh_releases.detect { |r| r.tag_name == tag_name && r.draft == draft }
-  end
-
-  def _confirm_publish
-    begin
-      STDOUT.puts "Would you like to publish this GitHub release now? (y/n)"
-      input = STDIN.gets.chomp.downcase
-    end while !%w(y n).include?(input)
-
-    exit if input == "n"
-  end
-
-  def _update_release(gh_client, gh_release, tag_name)
-    result = gh_client.update_release(gh_release.rels[:self].href, draft: false)
-    return true if result
-    STDOUT.puts "GitHub release #{tag_name} couldn't be published!"
-    false
-  end
-end
-
-PROJECT_NAME = "Listen"
-CURRENT_VERSION = Listen::VERSION
-
-def releaser
-  $releaser ||= Releaser.new(
-    project_name: PROJECT_NAME,
-    gem_name: "guard",
-    github_repo: "guard/guard",
-    version: CURRENT_VERSION)
-end
-
-namespace :release do
-  desc "Push #{PROJECT_NAME} #{CURRENT_VERSION} to RubyGems and publish"\
-    " its GitHub release"
-
-  task full: ["release:gem", "release:github"]
-
-  desc "Push #{PROJECT_NAME} #{CURRENT_VERSION} to RubyGems"
-  task :gem do
-    releaser.rubygems
-  end
-
-  desc "Publish #{PROJECT_NAME} #{CURRENT_VERSION} GitHub release"
-  task :github do
-    releaser.github
-  end
-end

data/TROUBLESHOOTING.md

@@ -1,139 +0,0 @@
-# Issues and troubleshooting
-
-## 3 steps before you start diagnosing problems
-
-These 3 steps will:
-* help quickly troubleshoot issues caused by obscure problems
-* help quickly identify the area of the problem (a full list is [below](#known-issues))
-* help you get familiar with listen's diagnostic mode
-* help you create relevant output before you submit an issue
-
-1) For effective troubleshooting set the `LISTEN_GEM_DEBUGGING=1` variable
-before starting listen.
-
-2) Verify polling works (see `force_polling` option).
-
-After starting listen, you should see something like:
-```
-INFO -- : Celluloid loglevel set to: 1
-INFO -- : Record.build(): 0.06773114204406738 seconds
-```
-
-(Listen uses [Celluloid](https://github.com/celluloid/celluloid) for logging, so if you don't see anything, `Celluloid.logger` might have been disabled by a different gem, e.g. sidekiq)
-
-If you don't see the line `Record.build()`:
-* and there's a lot of disk activity, you may have to wait a few seconds
-* you may be using an outdated version of Listen
-* listen may have got stuck on a recursive symlink, see #259
-
-3) Make changes e.g. `touch foo` or `echo "a" >> foo` (for troubleshooting, avoid using an editor which could generate too many misleading events)
-
-You should see something like:
-
-```
-INFO -- : listen: raw changes: [[:added, "/home/me/foo"]]
-INFO -- : listen: final changes: {:modified=>[], :added=>["/home/me/foo"], :removed=>[]}
-```
-
-"raw changes" contains changes collected during the `:wait_for_delay` and `:latency` intervals, while "final changes" is what listen decided are relevant changes (for better editor support).
-
-## Adapter-specific diagnostics
-
-Use the `LISTEN_GEM_DEBUGGING` set to `2` for additional info.
-
-E.g. you'll get:
-
-```
-INFO -- : Celluloid loglevel set to: 0
-DEBUG -- : Broadcaster: starting tcp server: 127.0.0.1:4000
-DEBUG -- : Adapter: considering TCP ...
-DEBUG -- : Adapter: considering polling ...
-DEBUG -- : Adapter: considering optimized backend...
-INFO -- : Record.build(): 0.0007264614105224609 seconds
-DEBUG -- : inotify: foo ([:create])
-DEBUG -- : raw queue: [:file, #<Pathname:/tmp/x>, "foo", {:change=>:added}]
-DEBUG -- : added: file:/tmp/x/foo ({:change=>:added})
-DEBUG -- : inotify: foo ([:attrib])
-DEBUG -- : raw queue: [:file, #<Pathname:/tmp/x>, "foo", {:change=>:modified}]
-DEBUG -- : inotify: foo ([:close_write, :close])
-DEBUG -- : raw queue: [:file, #<Pathname:/tmp/x>, "foo", {:change=>:modified}]
-DEBUG -- : modified: file:/tmp/x/foo ({:change=>:modified})
-DEBUG -- : modified: file:/tmp/x/foo ({:change=>:modified})
-INFO -- : listen: raw changes: [[:added, "/tmp/x/foo"]]
-INFO -- : listen: final changes: {:modified=>[], :added=>["/tmp/x/foo"], :removed=>[]}
-DEBUG -- : Callback took 4.410743713378906e-05 seconds
-```
-
-This shows:
-* host port listened to (for forwarding events)
-* the actual adapter used (here, it's "optimized backend")
-* the event received (here it's `:create` from rb-inotify)
-* "raw queue" - events queued for processing (collected during `:latency`)
-* "Callback took" - how long it took your app to process changes
-
-#### Known issues
-
-Here are common issues grouped by area in which they occur:
-
-1. System/OS
-  * [Update your Dropbox client](http://www.dropbox.com/downloading), if you have Dropbox installed.
-  * old MacOS (< 10.6)
-  * certain old versions of Ruby (try a newer Ruby on Windows for `wdm` and TCP mode to work)
-  * system limits
-    * threads for Celluloid (e.g. Virtual Machine CPU/RAM limitations)
-    * [inotify limits (Linux)](https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers)
-  * system in an inconsistent state or stuck (try rebooting/updating on Windows/Mac - seriously!)
-  * FSEvent bug: (http://feedback.livereload.com/knowledgebase/articles/86239)
-
-2. Installation/gems/config
-  * not running listen or your app (e.g. guard) with `bundle exec` first
-  * old version of listen
-  * problems with adapter gems (`wdm`, `rb-fsevent`, `rb-inotify`) not installed, not detected properly (Windows) or not in Gemfile (Windows)
-  * Celluloid actors are silently crashing (when no LISTEN_GEM_DEBUGGING variable is present)
-  * see the [Performance](https://github.com/guard/listen/blob/master/README.md#Performance) section in the README
-
-3. Filesystem
-  * VM shared folders and network folders (NFS, Samba, SSHFS) don't work with optimized backends (workaround: polling, [TCP mode](https://github.com/guard/listen/blob/master/README.md#forwarding-file-events-over-tcp), Vagrant's rsync-auto mode, rsync/unison)
-  * FAT/HFS timestamps have 1-second precision, which can cause polling and rb-fsevent to be very slow on large files (try `LISTEN_GEM_DISABLE_HASHING` variable)
-  * virtual filesystems may not implement event monitoring
-  * restrictive file/folder permissions
-  * watched folders moved/removed while listen was running (try restarting listen and moving/copying watched folder to a new location)
-
-4. Insufficient latency (for polling and rb-fsevent)
-  * too many files being watched (polling) and not enough threads or CPU power
-  * slow editor save (see below)
-  * slow hard drive
-  * encryption
-  * a combination of factors
-
-5. Too few or too many callbacks (`:wait_for_delay` option)
-  * complex editor file-save causes events to happen during callback (result: multiple callbacks if wait_for_delay is too small)
-  * too large when using TCP mode (see timestamps in output to debug)
-  * too many changes happening too frequently (use ignore rules to filter them out)
-
-6. Paths
-  * default ignore rules
-  * encoding-related issues (bad filenames, mounted FS encoding mismatch)
-  * symlinks may cause listen to hang (#259)
-  * symlinks may not work as you expect or work differently for polling vs non-polling
-  * TCP paths don't match with client's current working directory
-
-7. Editors
-  * "atomic save" in editors may confuse listen (disable it and try again)
-  * listen's default ignore rules may need tweaking
-  * your editor may not be supported yet (see default ignore rules for editors)
-  * use `touch foo` or `echo "a" >> foo`  to confirm it's an editor issue
-  * slow terminal/GFX card, slow font, transparency effects in terminal
-  * complex/lengthy editor save (due to e.g. many plugins running during save)
-  * listen has complex rules for detecting atomic file saves (Linux)
-
-8. TCP (tcp mode) issues
-  * not a recent listen gem (before 2.7.11)
-  * additional network delay and collecting may need a higher `:wait_for_delay` value
-  * changes (added, removed, deleted) not matching actual changes
-
-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)).
-
-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.

data/listen.gemspec

@@ -1,33 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'listen/version'
-
-Gem::Specification.new do |s|
-  s.name        = 'listen'
-  s.version     = Listen::VERSION
-  s.license     = 'MIT'
-  s.author      = 'Thibaud Guillaume-Gentil'
-  s.email       = 'thibaud@thibaud.gg'
-  s.homepage    = 'https://github.com/guard/listen'
-  s.summary     = 'Listen to file modifications'
-  s.description = 'The Listen gem listens to file modifications and '\
-    'notifies you about the changes. Works everywhere!'
-
-  s.files        = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  s.test_files   = s.files.grep(/^spec\//)
-  s.executable   = 'listen'
-  s.require_path = 'lib'
-
-  s.required_ruby_version = '>= 1.9.3'
-
-  s.add_dependency 'celluloid',  '>= 0.15.2'
-  s.add_dependency 'rb-fsevent', '>= 0.9.3'
-  s.add_dependency 'rb-inotify', '>= 0.9'
-
-  s.add_development_dependency 'bundler', '>= 1.3.5'
-  s.add_development_dependency 'celluloid-io', '>= 0.15.0'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '~> 3.0.0rc1'
-  s.add_development_dependency 'rspec-retry'
-end