listen-compat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bac4b0ee225554a721aaa8daada780e569fbdc8c
+  data.tar.gz: 035bc356f079cea0a7ded926c471ac93a7cc8435
+SHA512:
+  metadata.gz: b8b7b7f57c0011f7e6cbb19c902fb1ad1a15e801d4ceca0a3f0df519c1ec89122991f9855cc81e8314fdc1a6d83dae28d205ff1208fc2250fea58a1f1656aa0e
+  data.tar.gz: 7b8c356db968632ae02e95c6348e0cfc67efd9de70d3644c362b51f9d8cfc9f2ed3f5e41d6341ae811c1a4b28a6d1d5aa18ae1676f57cc26ce38ed6c34f491f8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format doc

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,14 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-11-27 16:11:17 +0100 using RuboCop version 0.27.1.
+# 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: 1
+Lint/HandleExceptions:
+  Enabled: false
+
+# Offense count: 6
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rspec', require: false
+  gem 'rubocop', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cezary Baginski
+
+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
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,139 @@
+# Listen::Compat
+
+A wrapper for [Listen](https://github.com/guard/listen) to "guarantee" a
+simplified and unchanging (future-compatible) API for cross-platform watching
+files and directories.
+
+It is designed to work with any version of Listen installed (it contains
+workarounds for buggy or incomplete old versions).
+
+This is useful for app/gem developers who want to "just watch files until
+Ctrl-C". (And not care about historical incompatibilities or bug fixes /
+regressions related to Listen).
+
+It also helps easily write unit tests for using listen in other apps, without
+having to deal with threads, locks, queues, sleeping, Listen API changes, etc.
+
+## Installation
+
+As long as users of you application have *any* version of Listen installed,
+listen-compat should work.
+
+Example Gemfile:
+
+```ruby
+gem 'listen-compat'
+gem 'listen' # hopefully, any version you like will work
+```
+
+## Usage
+
+You can assume the following interface will never change.
+
+
+```ruby
+require 'listen/compat/wrapper'
+
+listener = Listen::Compat::Wrapper.create
+
+directories = %w(foo bar baz)
+options = { force_polling: false }
+
+listener.listen(directories, options) do |modified, added, removed|
+  puts "Modified: #{modified.inspect}"
+  puts "Added: #{added.inspect}"
+  puts "Removed: #{removed.inspect}"
+end
+```
+
+(You can assume compatibility will become better and more robust without having
+to make any changes in your app's code.)
+
+
+## Details
+
+This will always be guaranteed to include everything necessary:
+
+```ruby
+require 'listen/compat/wrapper'
+```
+
+The following will do whatever magic necessary to find a usable version of
+Listen, require it, and return the right wrapper.
+
+
+```ruby
+listener = Listen::Compat::Wrapper.create
+```
+
+You can assume directories can be passed in any form (relative, absolute,
+    Pathname, real-only directories) and any encoding and this gem's
+responsibility is to deal with it.
+
+```ruby
+directories = %w(foo bar baz)
+```
+
+While different version of listen support different options, it's
+Listen-Compat's responsibility to make sure they are properly translated or
+ignored, and possible to set without changes in your code (e.g. environment
+    variables, listen config files, etc.)
+
+```ruby
+options = { force_polling: false }
+```
+
+You can assume your callback will always receive an array of 3 arrays:
+- possibly changed files (but maybe no longer existing)
+- possibly added files (but maybe no longer existing)
+- possibly removed files (but may be existing again)
+
+
+```ruby
+listener.listen(directories, options) do |modified, added, removed|
+```
+
+## Unit testing Listen in you app
+
+Listen-compat provides a fast-enough and thorough enough test helper for you to
+just add a single unit test to accurately simulate a real blocking session with
+Listen.
+
+It also lets you conveniently use relative files for simulating events (even
+though the actual Listen implementation reports full paths).
+
+
+```ruby
+require "listen/compat/test/session"
+
+def test_if_watching_files_works
+
+  session = Listen::Compat::Test::Session.new do
+    # put whatever code would cause Listen to block here:
+    myapp.start_listening_for_changes
+  end
+
+  # simulate changes
+  session.simulate_events(["foo.png"], [], [])
+
+  # simulate the user stopping the listening with Ctrl-C
+  session.interrupt
+
+  # whatever tests to make you app's callback was called:
+  assert_equal(%w(foo.png), myapp.updated_files_or_something)
+end
+```
+
+## Summary
+
+By using the above interface and the single using test above, you shouldn't
+have to care about anything else related about how Listen works with your app.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/listen-compat/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false unless ENV.key?('CI')
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+task default: [:spec, :rubocop]

data/example.rb

@@ -0,0 +1,12 @@
+require 'listen/compat/wrapper'
+
+listener = Listen::Compat::Wrapper.create
+
+directories = %w(lib pkg spec)
+options = { force_polling: false }
+
+listener.listen(directories, options) do |modified, added, removed|
+  puts "Modified: #{modified.inspect}"
+  puts "Added: #{added.inspect}"
+  puts "Removed: #{removed.inspect}"
+end

data/lib/listen/compat.rb

@@ -0,0 +1,2 @@
+require 'listen/compat/version'
+require 'listen/compat/wrapper'

data/lib/listen/compat/test.rb

@@ -0,0 +1 @@
+require 'listen/compat/test/session'

data/lib/listen/compat/test/fake.rb

@@ -0,0 +1,61 @@
+require 'listen/compat/wrapper'
+
+module Listen
+  module Compat
+    module Test
+      class Fake < Listen::Compat::Wrapper::Common
+        def self.fire_events(thread, *args)
+          processed = _processed(thread)
+          processed.pop until processed.empty?
+          _events(thread) << args
+          processed.pop
+        end
+
+        def self.collect_instances(thread)
+          return [] if _instances(thread).empty?
+          result = []
+          result << _instances(thread).pop until _instances(thread).empty?
+          result
+        end
+
+        attr_reader :directories
+
+        def initialize
+          thread = Thread.current
+
+          thread[:fake_instances] = Queue.new
+          thread[:fake_events] = Queue.new
+          thread[:fake_processed_events] = Queue.new
+
+          Fake._instances(thread) << self
+        end
+
+        private
+
+        def _start_and_wait(*args, &block)
+          @directories = args[0..-2]
+          loop do
+            ev = Fake._events(Thread.current).pop
+            block.call(*ev)
+            Fake._processed(Thread.current) << ev
+          end
+        end
+
+        def _stop
+        end
+
+        def self._processed(thread)
+          thread[:fake_processed_events]
+        end
+
+        def self._events(thread)
+          thread[:fake_events]
+        end
+
+        def self._instances(thread)
+          thread[:fake_instances]
+        end
+      end
+    end
+  end
+end

data/lib/listen/compat/test/session.rb

@@ -0,0 +1,70 @@
+require 'listen/compat/wrapper'
+require 'listen/compat/test/fake'
+require 'listen/compat/test/simple'
+
+module Listen
+  module Compat
+    module Test
+      # Class for conveniently simulating interaction with Listen
+      class Session
+        # Calls the potentially blocking given block in a background thread
+        def initialize(wrapper_class = nil, &block)
+          Wrapper.wrapper_class = wrapper_class || Listen::Compat::Test::Fake
+          Wrapper.listen_module = Listen::Compat::Test::Simple
+
+          fail 'No block given!' unless block_given?
+
+          @thread = Thread.new { _supervise(&block) }
+        end
+
+        # Simulate a Ctrl-C from the user
+        def interrupt
+          _wait_until_ready
+          @thread.raise Interrupt
+          @thread.join
+        end
+
+        # Simulate Listen events you want passed asynchronously to your callback
+        def simulate_events(modified, added, removed)
+          _wait_until_ready
+          Fake.fire_events(@thread, *_events(modified, added, removed))
+        end
+
+        # Return a list of fake Listen instances actually created
+        def instances
+          @instances ||= Fake.collect_instances(@thread)
+        end
+
+        private
+
+        def _supervise(&block)
+          block.call
+        rescue StandardError => e
+          msg = "\n\nERROR: Watched listen thread failed: %s: \n%s"
+          STDERR.puts format(msg, e.message, e.backtrace * "\n")
+          raise
+        end
+
+        def _events(modified, added, removed)
+          [_abs_paths(modified), _abs_paths(added), _abs_paths(removed)]
+        end
+
+        def _abs_paths(paths)
+          paths.map { |path| ::File.expand_path(path) }
+        end
+
+        def _wait_until_ready
+          sleep 0.1
+          sleep 0.1 while @thread.status == 'running'
+
+          # Show error on crashes
+          @thread.join if @thread.status.nil?
+
+          return if @thread.status == 'sleep'
+
+          fail "Unexpected thread state: #{@thread.status.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/listen/compat/test/simple.rb

@@ -0,0 +1,15 @@
+module Listen
+  module Compat
+    module Test
+      # Simple stub for a real Listen instance, which just forwards events
+      class Simple
+        def self.to(*_args)
+          Simple.new
+        end
+
+        def start
+        end
+      end
+    end
+  end
+end

data/lib/listen/compat/version.rb

@@ -0,0 +1,5 @@
+module Listen
+  module Compat
+    VERSION = '0.1.0'
+  end
+end

data/lib/listen/compat/wrapper.rb

@@ -0,0 +1,180 @@
+require 'listen/compat/version' # just for convenience
+
+module Listen
+  module Compat
+    # Tries to require Listen using rubygems or vendored version
+    module Loader
+      module_function
+
+      def load!
+        defined?(gem) ? try_rubygems : try_without_rubygems
+      end
+
+      def try_rubygems
+        gem 'listen', '>= 1.1.0', '< 3.0.0'
+        require 'listen'
+      rescue LoadError, Gem::LoadError => e
+        e.message.replace(format("%s\n%s", e.message, msg_about_gem_install))
+        raise
+      end
+
+      def compatible_version
+        !older_than_193?  ?  '~> 2.7' : '~> 1.1'
+      end
+
+      def older_than_193?
+        Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9.3')
+      end
+
+      def msg_about_gem_install
+        format("Run \"gem install listen --version '%s'\" to get it.",
+               compatible_version)
+      end
+    end
+
+    module Wrapper
+      class << self
+        attr_writer :listen_module
+        attr_accessor :wrapper_class
+
+        def listen_module
+          @listen_module ||= Listen
+        end
+      end
+
+      # History of bugs/workarounds:
+      #
+      # Ancient (< 2.0.0) - very old version
+      #   - uses start!
+      #   - polling method
+      #   - start method blocks
+      #   - fails on readonly directories and files
+      #
+      # Old (>= 2.0.0) - major API change
+      #   - uses Celluloid, so shutdown/thread handling is different
+      #   - start returns a thread (not sure if 2.0.0 or later)
+      #   - sleep is needed to block
+      #   = 2.7.6 - start() returns adapter thread (instead of wait_thread)
+      #
+      # Stale (>= 2.7.7) - broke mutliple dir handling on OSX (#243)
+      #   - devious threads hack in Sass works by accident (!)
+      #   = 2.7.11 - last version where start still returns a thread
+      #
+      # Current (>= 2.7.12)- start() no longer returns a thread
+      #   - fixed multiple dir handling (#243)
+      #   = 2.8.0 - current version
+
+      # "Expected" functionality from any Listen version
+      class Common
+        # Run listen continously to monitor changes and gracefully terminate
+        # on Ctrl-C
+        def listen(*args, &block)
+          _start_and_wait(*args, &block)
+        rescue Interrupt
+          _stop
+        end
+
+        protected
+
+        # Overridable method so a fake implementation can be used in tests
+        def _listen_module
+          Wrapper.listen_module
+        end
+
+        # Overridable method so a fake implementation can be used in tests
+        def _listen_class
+          _listen_module::Listener
+        end
+
+        private
+
+        # Run listen continuously, regardless whether it blocks or starts
+        # a background thread
+        def _start_and_wait(*args, &block)
+          _listen_module.to(*args, &block).start
+          sleep
+        end
+
+        # Gracefully shutdown Listen after a Ctrl-C, join threads, etc.
+        def _stop
+          _listen_module.stop
+        end
+      end
+
+      # Workarounds for pre 2.0 versions of Listen
+      class Ancient < Common
+        NEXT_VERSION = Gem::Version.new('2.0.0')
+
+        # A Listen version prior to 2.0 will write a test file to a directory
+        # to see if a watcher supports watching that directory. That breaks
+        # horribly on read-only directories, so we filter those out.
+        def watchable_directories(directories)
+          directories.select { |d| ::File.directory?(d) && ::File.writable?(d) }
+        end
+
+        def listen(*args, &block)
+          options     = args.last.is_a?(Hash) ? args.pop : {}
+          # Note: force_polling is a method here (since Listen 2.0.0 it's an
+          # option passed to Listen.new)
+          poll = options[:force_polling]
+
+          directories = watchable_directories(args.flatten)
+
+          # Don't optimize this out because of Ruby 1.8
+          args = directories
+          args << options
+
+          listener = _listen_class.new(*args, &block)
+          listener.force_polling(true) if poll
+          listener.start!
+        rescue Interrupt
+        end
+      end
+
+      # >= 2.0.0, <= 2.7.6
+      class Old < Common
+        NEXT_VERSION = Gem::Version.new('2.7.7')
+      end
+
+      # >= 2.7.7, <= 2.7.11
+      class Stale < Common
+        NEXT_VERSION = Gem::Version.new('2.7.12')
+
+        # Work around guard/listen#243 (>= v2.7.9, < v2.8.0)
+        def _start_and_wait(*args, &block)
+          options = args.pop if args.last.is_a?(Hash)
+          listeners = args.map do |dir|
+            _listen_module.to(dir, options, &block)
+          end
+          listeners.map(&:start)
+          sleep
+        end
+      end
+
+      # >= 2.7.12, <= 2.8.0
+      class Current < Common
+        NEXT_VERSION = Gem::Version.new('2.99.99')
+      end
+
+      # Returns a wrapper matching the listen version
+      # @param version_string overrides detection (e.g. for testing)
+      def self.create(version_string = nil)
+        return Wrapper.wrapper_class.new if Wrapper.wrapper_class
+
+        version = Gem::Version.new(version_string || _detect_listen_version)
+
+        [Ancient, Old, Stale, Current].each do |klass|
+          return klass.new if version < klass.const_get('NEXT_VERSION')
+        end
+      end
+
+      private
+
+      def self._detect_listen_version
+        Loader.load!
+        require 'listen/version'
+        Listen::VERSION
+      end
+    end
+  end
+end

data/listen-compat.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'listen/compat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'listen-compat'
+  spec.version       = Listen::Compat::VERSION
+  spec.authors       = ['Cezary Baginski']
+  spec.email         = ['cezary@chronomantic.net']
+  spec.summary       = 'Simplified compatibility layer for Listen gem'
+  spec.description   = 'For developers to have a minimal, guaranteed API for \
+    using Listen'
+
+  spec.homepage      = 'https://github.com/guard/listen-compat'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/spec/listen/compat/example_spec.rb

@@ -0,0 +1,39 @@
+require 'listen/compat/test/session'
+
+class MyExampleApp
+  attr_reader :changed
+
+  def start_listening_for_changes
+    listener = Listen::Compat::Wrapper.create
+
+    directories = %w(foo bar baz)
+    options = { force_polling: false }
+
+    listener.listen(directories, options) do |modified, _added, _removed|
+      @changed ||= []
+      @changed += modified.map do |full_path|
+        Pathname(full_path).relative_path_from(Pathname.pwd).to_s
+      end
+    end
+  end
+end
+
+RSpec.describe MyExampleApp do
+  it 'works' do
+    myapp = MyExampleApp.new
+
+    session = Listen::Compat::Test::Session.new do
+      # put whatever code would cause Listen to block here:
+      myapp.start_listening_for_changes
+    end
+
+    # simulate changes
+    session.simulate_events(['foo.png'], [], [])
+
+    # simulate the user stopping the listening with Ctrl-C
+    session.interrupt
+
+    # whatever tests to make you app's callback was called:
+    expect(myapp.changed).to eq(%w(foo.png))
+  end
+end

data/spec/listen/compat/wrapper_spec.rb

@@ -0,0 +1,228 @@
+require 'fileutils'
+require 'pathname'
+require 'tmpdir'
+
+require 'listen/compat/wrapper'
+
+# TODO: since we're using RSpec now, this is not necessary
+module MockListen
+  class Listener
+    def initialize(*args)
+      @calls = Queue.new
+      @calls << [__method__, *args]
+      MockListen.add_instance(self)
+    end
+
+    def method_missing(meth, *args, &_block)
+      @calls << [meth, *args]
+    end
+
+    def calls
+      MockListen.dump(@calls)
+    end
+  end
+
+  class << self
+    def dump(queue)
+      res = []
+      res << queue.pop until queue.empty?
+      res
+    end
+
+    def setup_for_tests
+      Listen::Compat::Wrapper.listen_module = MockListen
+      Listen::Compat::Wrapper.wrapper_class = nil # autodetect
+      @calls = Queue.new
+      @mocks = Queue.new
+      @responses = {}
+      @called = []
+    end
+
+    def reset_for_tests
+      instance_variables.each do |var|
+        instance_variable_set(var, :unset)
+      end
+      Listen::Compat::Wrapper.listen_module = nil
+      Listen::Compat::Wrapper.wrapper_class = nil
+    end
+
+    # setup actions
+    attr_reader :responses
+
+    def add_instance(obj)
+      @mocks << obj
+    end
+
+    # Get results
+    def instances
+      MockListen.dump(@mocks)
+    end
+
+    def calls
+      MockListen.dump(@calls)
+    end
+
+    def method_missing(meth, *args, &block)
+      @calls << [meth, *args]
+      block = responses[meth]
+      block.call(*args) unless block.nil?
+    end
+  end
+end
+
+module DelayedInterruptHelper
+  def delayed_interrupt(&block)
+    th = Thread.new(&block)
+    sleep 0.1
+    sleep 0.1 while (status = th.status) == 'running'
+    th.raise Interrupt
+    th.join
+    status
+  end
+end
+
+RSpec.describe Listen::Compat::Wrapper::Ancient do
+  let(:wrapper) { Listen::Compat::Wrapper.create('0.1.0') }
+
+  before do
+    MockListen.setup_for_tests
+    MockListen.responses[:start!] = proc { fail Interrupt }
+  end
+
+  after do
+    MockListen.reset_for_tests
+  end
+
+  it { is_expected.to be_a described_class }
+
+  it 'readonly dirs are avoided' do
+    tmpdir, result = Dir.mktmpdir do |dir|
+      ro_dir = File.join(dir, 'foo')
+      FileUtils.mkdir(ro_dir, mode: 0444)
+      [dir, wrapper.watchable_directories([dir, ro_dir, '.'])]
+    end
+
+    expect(result).to eq([tmpdir, '.'])
+  end
+
+  it 'passes parameters to listen' do
+    wrapper.listen('.', {})
+    expect(MockListen.instances[0].calls[0]).to eq([:initialize, '.', {}])
+  end
+
+  it 'calls start' do
+    wrapper.listen('.', {})
+    expect(MockListen.instances[0].calls[1]).to eq([:start!])
+  end
+
+  it 'does not call stop' do
+    wrapper.listen('.', {})
+    expect(MockListen.calls).to eq([])
+  end
+end
+
+RSpec.describe Listen::Compat::Wrapper::Old do
+  include DelayedInterruptHelper
+
+  let(:wrapper) { Listen::Compat::Wrapper.create('2.7.6') }
+
+  before do
+    MockListen.setup_for_tests
+    MockListen.responses[:to] = proc { |*args| MockListen::Listener.new(*args) }
+  end
+
+  after do
+    MockListen.reset_for_tests
+  end
+
+  it { is_expected.to be_a described_class }
+
+  it 'passes parameters to listen' do
+    delayed_interrupt { wrapper.listen('.', {}) }
+    expect(MockListen.calls[0]).to eq([:to, '.', {}])
+  end
+
+  it 'calls start' do
+    delayed_interrupt { wrapper.listen('.', {}) }
+    expect(MockListen.instances[0].calls[1]).to eq([:start])
+  end
+
+  it 'sleeps after start' do
+    status = delayed_interrupt { wrapper.listen('.', {}) }
+    expect(status).to eq('sleep')
+  end
+
+  it 'calls stop' do
+    delayed_interrupt { wrapper.listen('.', {}) }
+    expect(MockListen.calls[1]).to eq([:stop])
+  end
+end
+
+RSpec.describe Listen::Compat::Wrapper::Stale do
+  include DelayedInterruptHelper
+
+  let(:wrapper) { Listen::Compat::Wrapper.create('2.7.11') }
+
+  before do
+    MockListen.setup_for_tests
+    MockListen.responses[:to] = proc { |*args| MockListen::Listener.new(*args) }
+  end
+
+  after do
+    MockListen.reset_for_tests
+  end
+
+  it { is_expected.to be_a described_class }
+
+  it 'calls start' do
+    delayed_interrupt { wrapper.listen('.', {}) }
+    expect(MockListen.instances[0].calls[1]).to eq([:start])
+  end
+
+  it 'sleeps after start' do
+    status = delayed_interrupt { wrapper.listen('.', {}) }
+    expect(status).to eq('sleep')
+  end
+
+  it 'calls stop' do
+    delayed_interrupt { wrapper.listen('.', {}) }
+    expect(MockListen.calls[1]).to eq([:stop])
+  end
+end
+
+RSpec.describe Listen::Compat::Wrapper::Current do
+  include DelayedInterruptHelper
+
+  let(:wrapper) { Listen::Compat::Wrapper.create('2.7.12') }
+
+  before do
+    MockListen.setup_for_tests
+    MockListen.responses[:to] = proc { |*args| MockListen::Listener.new(*args) }
+  end
+
+  after do
+    MockListen.reset_for_tests
+  end
+
+  it { is_expected.to be_a described_class }
+
+  it 'passes parameters to listen' do
+    delayed_interrupt { wrapper.listen('.', {}) }
+    expect(MockListen.calls[0]).to eq([:to, '.', {}])
+  end
+
+  it 'calls start' do
+    delayed_interrupt { wrapper.listen('.', {}) }
+    expect(MockListen.instances[0].calls[1]).to eq([:start])
+  end
+
+  it 'sleeps after start' do
+    status = delayed_interrupt { wrapper.listen('.', {}) }
+    expect(status).to eq('sleep')
+  end
+
+  it 'calls stop' do
+    delayed_interrupt { wrapper.listen('.', {}) }
+    expect(MockListen.calls[1]).to eq([:stop])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,73 @@
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_doubled_constant_names = true
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run focus: ENV['CI'] != 'true'
+
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: listen-compat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cezary Baginski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |-
+  For developers to have a minimal, guaranteed API for \
+      using Listen
+email:
+- cezary@chronomantic.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example.rb
+- lib/listen/compat.rb
+- lib/listen/compat/test.rb
+- lib/listen/compat/test/fake.rb
+- lib/listen/compat/test/session.rb
+- lib/listen/compat/test/simple.rb
+- lib/listen/compat/version.rb
+- lib/listen/compat/wrapper.rb
+- listen-compat.gemspec
+- spec/listen/compat/example_spec.rb
+- spec/listen/compat/wrapper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/guard/listen-compat
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simplified compatibility layer for Listen gem
+test_files:
+- spec/listen/compat/example_spec.rb
+- spec/listen/compat/wrapper_spec.rb
+- spec/spec_helper.rb