listen 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3a85ae5a130d5ccf3d6ebf7174614610af93ba7
-  data.tar.gz: bd6f7c8f0dc70130c98de3e74d44bcc4fb98bb36
+  metadata.gz: 1ccc28e54b4f14ddb8662b77011a6ec04807ef0c
+  data.tar.gz: 044317983ad9a14eca7744f2e4542f281079981c
 SHA512:
-  metadata.gz: 27c880e3c70f58400ebe481a82a342438692c968611813a69032ce99a69ad7499531bccd839cb77d0d3e47e8f92ae63ea17a23a0e73155689339a6afca2c3ef4
-  data.tar.gz: 68ad5e3365d230048c343ea0e096a4a400833177f0ca18c86e5a89a3b3297f14b3c313b967d55ea0e67e153bc687b4770d0503e34012ec914b0cfbde451df1db
+  metadata.gz: d2e2e92218ec8d523114db9100f5fb5bc8eaaf470705fb0b179127bb13bd73992a598ca475f175fc8be7a54c18715ad0433be8e4551da1b4b5717b2175f56974
+  data.tar.gz: a80907bc0bf9366a832223cb4112cd9786ee21d46538dc0e74357f4c7fa7df931a84d3a5906b22640998dae06b0995d0388dba44381bee1c7a80b9a1dc914315

data/.gitignore

@@ -0,0 +1,27 @@
+pkg/*
+doc/*
+*.gem
+*.rbc
+.*.swp
+*.bak
+bundle
+.bundle
+.yardoc
+.rbx
+.rvmrc
+.vagrant
+Gemfile.lock
+spec/.fixtures
+coverage
+.ruby-version
+example*
+test.txt
+
+## MAC OS
+.DS_Store
+.Trashes
+.com.apple.timemachine.supported
+.fseventsd
+Desktop DB
+Desktop DF
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+bundler_args: --without tool
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode
+notifications:
+  recipients:
+    - thibaud@thibaud.me
+    - remy@rymai.me
+    - michi@netzpiraten.ch
+    - maher@sallam.me

data/.yardopts

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

data/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+Contribute to Listen
+===================
+
+File an issue
+-------------
+
+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
+[Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
+
+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!**
+
+Development
+-----------
+
+* Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/listen/master/frames).
+* Source hosted at [GitHub](https://github.com/guard/listen).
+
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
+
+* Please create a topic branch for every separate change you make.
+* Make sure your patches are well tested. All specs run with `rake spec` must pass.
+* Update the [Yard](http://yardoc.org/) documentation.
+* Update the [README](https://github.com/guard/listen/blob/master/README.md).
+* Update the [CHANGELOG](https://github.com/guard/listen/blob/master/CHANGELOG.md) for noteworthy changes.
+* Please **do not change** the version number.
+
+For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+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
+
+group :tool do
+  gem 'yard', require: false
+  gem 'guard-rspec', require: false
+end
+
+group :test do
+  gem 'coveralls', require: false
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, bundler: false 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

data/{LICENSE → LICENSE.txt}

@@ -1,5 +1,7 @@
 Copyright (c) 2013 Thibaud Guillaume-Gentil
 
+MIT License
+
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 "Software"), to deal in the Software without restriction, including

data/README.md

@@ -1,4 +1,6 @@
-# Listen [![Gem Version](https://badge.fury.io/rb/listen.png)](http://badge.fury.io/rb/listen) [![Build Status](https://travis-ci.org/guard/listen.png)](https://travis-ci.org/guard/listen) [![Dependency Status](https://gemnasium.com/guard/listen.png)](https://gemnasium.com/guard/listen) [![Code Climate](https://codeclimate.com/github/guard/listen.png)](https://codeclimate.com/github/guard/listen) [![Coverage Status](https://coveralls.io/repos/guard/listen/badge.png?branch=master)](https://coveralls.io/r/guard/listen)
+# Listen
+
+[![Gem Version](https://badge.fury.io/rb/listen.png)](http://badge.fury.io/rb/listen) [![Build Status](https://travis-ci.org/guard/listen.png)](https://travis-ci.org/guard/listen) [![Dependency Status](https://gemnasium.com/guard/listen.png)](https://gemnasium.com/guard/listen) [![Code Climate](https://codeclimate.com/github/guard/listen.png)](https://codeclimate.com/github/guard/listen) [![Coverage Status](https://coveralls.io/repos/guard/listen/badge.png?branch=master)](https://coveralls.io/r/guard/listen)
 
 The Listen gem listens to file modifications and notifies you about the changes.
 
@@ -66,7 +68,7 @@ listener.start
 listener.ignore! /\.pkg/  # overwrite all patterns and only ignore pkg extension.
 listener.ignore /\.rb/    # ignore rb extension in addition of pkg.
 sleep
-``
+```
 
 ## Changes callback
 

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/listen/listener.rb

@@ -116,9 +116,8 @@ module Listen
     end
 
     def _init_actors
-      cores = Celluloid.cores || 2
       Celluloid::Actor[:listen_silencer]    = Silencer.new(options)
-      Celluloid::Actor[:listen_change_pool] = Change.pool(size: cores, args: self)
+      Celluloid::Actor[:listen_change_pool] = Change.pool(args: self)
       Celluloid::Actor[:listen_adapter]     = Adapter.new(self)
       Celluloid::Actor[:listen_record]      = Record.new(self)
     end

data/lib/listen/version.rb

@@ -1,3 +1,3 @@
 module Listen
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/listen.gemspec

@@ -0,0 +1,30 @@
+# 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.me'
+  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($/)
+  s.test_files   = s.files.grep(%r{^spec/})
+  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 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-retry'
+end

data/spec/acceptance/listen_spec.rb

@@ -0,0 +1,204 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe "Listen" do
+  let(:options) { { } }
+  let(:callback) { ->(modified, added, removed) {
+    add_changes(:modified, modified)
+    add_changes(:added, added)
+    add_changes(:removed, removed)
+  } }
+  let(:listener) { @listener }
+  before {
+    @listener = setup_listener(options, callback)
+    @listener.start
+  }
+  after { listener.stop }
+
+  context "with one listen dir" do
+    let(:paths) { Pathname.new(Dir.pwd) }
+    around { |example| fixtures { |path| example.run } }
+
+    context "with change block raising" do
+      let(:callback) { ->(x,y,z) { raise 'foo' } }
+
+      it "warns the backtrace" do
+        expect(Kernel).to receive(:warn).with("[Listen warning]: Change block raise an execption: foo")
+        expect(Kernel).to receive(:warn).with(/^Backtrace:.*/)
+        listen { touch 'file.rb' }
+      end
+    end
+
+    [false, true].each do |polling|
+      context "force_polling option to #{polling}" do
+        let(:options) { { force_polling: polling, latency: 0.1 } }
+
+        context "nothing in listen dir" do
+          it "listens to file addition" do
+            expect(listen {
+              touch 'file.rb'
+            }).to eq({ modified: [], added: ['file.rb'], removed: [] })
+          end
+
+          it "listens to multiple files addition" do
+            expect(listen {
+              touch 'file1.rb'
+              touch 'file2.rb'
+            }).to eq({ modified: [], added: ['file1.rb', 'file2.rb'], removed: [] })
+          end
+
+          it "listens to file moved inside" do
+            touch '../file.rb'
+            expect(listen {
+              mv '../file.rb', 'file.rb'
+            }).to eq({ modified: [], added: ['file.rb'], removed: [] })
+          end
+        end
+
+        context "file in listen dir" do
+          around { |example| touch 'file.rb'; example.run }
+
+          it "listens to file touch" do
+            expect(listen {
+              touch 'file.rb'
+            }).to eq({ modified: ['file.rb'], added: [], removed: [] })
+          end
+
+          it "listens to file modification" do
+            expect(listen {
+              open('file.rb', 'w') { |f| f.write('foo') }
+            }).to eq({ modified: ['file.rb'], added: [], removed: [] })
+          end
+
+          it "listens to file modification and wait" do
+            expect(listen {
+              open('file.rb', 'w') { |f| f.write('foo') }
+              sleep 0.5
+            }).to eq({ modified: ['file.rb'], added: [], removed: [] })
+          end
+
+          it "listens to file echo" do
+            expect(listen {
+              `echo  foo > #{Dir.pwd}/file.rb`
+            }).to eq({ modified: ['file.rb'], added: [], removed: [] })
+          end
+
+          it "listens to file removal" do
+            expect(listen {
+              rm 'file.rb'
+            }).to eq({ modified: [], added: [], removed: ['file.rb'] })
+          end
+
+          it "listens to file moved out" do
+            expect(listen {
+              mv 'file.rb', '../file.rb'
+            }).to eq({ modified: [], added: [], removed: ['file.rb'] })
+          end
+
+          it "listens to file mode change" do
+            expect(listen {
+              chmod 0777, 'file.rb'
+            }).to eq({ modified: ['file.rb'], added: [], removed: [] })
+          end
+        end
+
+        context "hidden file in listen dir" do
+          around { |example| touch '.hidden'; example.run }
+
+          it "listens to file touch" do
+            expect(listen {
+              touch '.hidden'
+            }).to eq({ modified: ['.hidden'], added: [], removed: [] })
+          end
+        end
+
+        context "dir in listen dir" do
+          around { |example| mkdir_p 'dir'; example.run }
+
+          it "listens to file touch" do
+            expect(listen {
+              touch 'dir/file.rb'
+            }).to eq({ modified: [], added: ['dir/file.rb'], removed: [] })
+          end
+        end
+
+        context "dir with file in listen dir" do
+          around { |example| mkdir_p 'dir'; touch 'dir/file.rb'; example.run }
+
+          it "listens to file move" do
+            expect(listen {
+              mv 'dir/file.rb', 'file.rb'
+            }).to eq({ modified: [], added: ['file.rb'], removed: ['dir/file.rb'] })
+          end
+        end
+
+        context "two dirs with files in listen dir" do
+          around { |example|
+            mkdir_p 'dir1'; touch 'dir1/file1.rb'
+            mkdir_p 'dir2'; touch 'dir2/file2.rb'
+            example.run }
+
+          it "listens to multiple file moves" do
+            expect(listen {
+              mv 'dir1/file1.rb', 'dir2/file1.rb'
+              mv 'dir2/file2.rb', 'dir1/file2.rb'
+            }).to eq({ modified: [], added: ['dir1/file2.rb', 'dir2/file1.rb'], removed: ['dir1/file1.rb', 'dir2/file2.rb'] })
+          end
+
+          it "listens to dir move" do
+            expect(listen {
+              mv 'dir1', 'dir2/'
+            }).to eq({ modified: [], added: ['dir2/dir1/file1.rb'], removed: ['dir1/file1.rb'] })
+          end
+        end
+
+        context "ignored dir with file in listen dir" do
+          around { |example| mkdir_p 'ignored_dir'; touch 'ignored_dir/file.rb'; example.run }
+          let(:options) { { force_polling: polling, latency: 0.1, ignore: /ignored_dir/ } }
+
+          it "doesn't listen to file touch" do
+            expect(listen {
+              touch 'ignored_dir/file.rb'
+            }).to eq({ modified: [], added: [], removed: [] })
+          end
+        end
+
+        context "with ignored file in listen dir" do
+          around { |example| touch 'file.rb'; example.run }
+          let(:options) { { force_polling: polling, latency: 0.1, ignore: /\.rb$/ } }
+
+          it "doesn't listen to file touch" do
+            expect(listen {
+              touch 'file.rb'
+            }).to eq({ modified: [], added: [], removed: [] })
+          end
+        end
+
+        describe "#ignore" do
+          around { |example| touch 'file.rb'; example.run }
+          let(:options) { { force_polling: polling, latency: 0.1, ignore: /\.rb$/ } }
+
+          it "overwrites existing patterns" do
+            expect(listen {
+              listener.ignore(/\.txt/)
+              touch 'file.rb'
+              touch 'file.txt'
+            }).to eq({ modified: [], added: [], removed: [] })
+          end
+        end
+
+        describe "#ignore!" do
+          let(:options) { { force_polling: polling, latency: 0.1, ignore: /\.rb$/ } }
+
+          it "overwrites existing patterns" do
+            expect(listen {
+              listener.ignore!(/\.txt/)
+              touch 'file.rb'
+              touch 'file.txt'
+            }).to eq({ modified: [], added: ['file.rb'], removed: [] })
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/listen/adapter/base_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Listen::Adapter::Base do
+  let(:adapter) { described_class.new(listener) }
+  let(:listener) { double(Listen::Listener, options: {}) }
+
+  describe "#_latency" do
+    it "returns default_latency with listener actor latency not present" do
+      expect(adapter.send(:_latency)).to eq Listen::Adapter::Base::DEFAULT_LATENCY
+    end
+
+    it "returns latency from listener actor if present" do
+      listener.stub(:options) { { latency: 1234 } }
+      expect(adapter.send(:_latency)).to eq 1234
+    end
+  end
+
+  describe "#_notify_change" do
+    let(:change_pool) { double(Listen::Change) }
+    let(:change_pool_async) { double('ChangePoolAsync') }
+    before {
+      change_pool.stub(:async) { change_pool_async }
+      Celluloid::Actor.stub(:[]).with(:listen_change_pool) { change_pool }
+    }
+
+    context "listener listen" do
+      before { listener.stub(:listen?) { true} }
+
+      it "calls change on change_pool asynchronously" do
+        expect(change_pool_async).to receive(:change).with('path', type: 'Dir', recurcise: true)
+        adapter.send(:_notify_change, 'path', type: 'Dir', recurcise: true)
+      end
+    end
+
+    context "listener doesn't listen" do
+      before { listener.stub(:listen?) { false } }
+
+      it "calls change on change_pool asynchronously" do
+        expect(change_pool_async).to_not receive(:change)
+        adapter.send(:_notify_change, 'path', type: 'Dir', recurcise: true)
+      end
+    end
+  end
+end