rb-inotify 0.9.10 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 69000e8c37c13a07c1435aa2cc5069c40e1bf162
-  data.tar.gz: fdf9152bb595159f06f669b37244a1a6f7a77935
+SHA256:
+  metadata.gz: 803cf77fe31e9334147381cbc2fcdc911f5c8c060582af70afb80ba00caa4967
+  data.tar.gz: dc13bce654e7a7c20d17722db4a62d4a091a6f21918e8133702306d90d5e0ccb
 SHA512:
-  metadata.gz: aaffecd5e2d7995d5a65939fd32adc8bfd06a114e560f490fef626cda14de3ffcd27d0909a49321c1a65b1aed4ad6dc3a7c099b7fec9243c64c8af8b4b603379
-  data.tar.gz: c3a30a09b2e67ee8c1e99a24cbc11fb75fcf4e2a98681519837316e0df474433d8d895412d300344c80145a7b5cfe7e2f664a52a09eb4abbe102704d4828da26
+  metadata.gz: 8b798f26a05bb0757e2bb29c49bdc07b694659c9bfd1a007be3fec48acbfccb59c049bbf17881c739f80f66fc63b03df15fb70574aaae73ce2f457667e726eec
+  data.tar.gz: c29ccd96375401b43d52ca09345ab235e11b044706ef4995525372961b126d4b845ac468c422c40dd77eec36995ac19855dccab85706a6458f34505bec5ac02b

data/.gitignore

@@ -16,4 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 .tags*
-.rspec_status
+.rspec_status
+/guard/
+/listen/

data/.travis.yml

@@ -1,30 +1,19 @@
 language: ruby
-sudo: false
-dist: trusty
 cache: bundler
-rvm:
-  - 1.8
-  - 1.9
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - jruby-head
-  - ruby-head
-  - jruby-9.1.8.0
-  - jruby-head
-  - rbx-3
+
 matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: jruby
+    - rvm: truffleruby
+    - rvm: jruby-head
+    - rvm: ruby-head
   allow_failures:
+    - rvm: truffleruby
+    - rvm: jruby
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx-3
   fast_finish: true
-script:
-  # Unit test
-  - bundle exec rake
-  # Install test
-  - gem build rb-inotify.gemspec
-  - gem install rb-inotify-*.gem
-  - sh -c "gem list | grep rb-inotify"

data/Gemfile

@@ -1,3 +1,16 @@
 source 'https://rubygems.org'
 
+# Specify your gem's dependencies in utopia.gemspec
 gemspec
+
+group :development do
+	gem 'pry'
+	gem 'pry-coolline'
+	
+	gem 'tty-prompt'
+end
+
+group :test do
+	gem 'simplecov'
+	gem 'coveralls', require: false
+end

data/LICENSE.md

@@ -0,0 +1,10 @@
+# The MIT License
+
+Copyright, 2009, by [Natalie Weizenbaum](https://github.com/nex3).  
+Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com).  
+
+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

@@ -10,7 +10,7 @@ It uses the [FFI](http://wiki.github.com/ffi/ffi) gem to avoid having to compile
 [![Code Climate](https://codeclimate.com/github/guard/rb-inotify.svg)](https://codeclimate.com/github/guard/rb-inotify)
 [![Coverage Status](https://coveralls.io/repos/guard/rb-inotify/badge.svg)](https://coveralls.io/r/guard/rb-inotify)
 
-## Basic Usage
+## Usage
 
 The API is similar to the inotify C API, but with a more Rubyish feel.
 First, create a notifier:
@@ -69,6 +69,16 @@ Unfortunately, this currently doesn't work under JRuby.
 JRuby currently doesn't use native file descriptors for the IO object,
 so we can't use the notifier's file descriptor as a stand-in.
 
+### Resource Limits
+
+If you get an error like `inotify event queue has overflowed` you might be running into system limits. You can add the following to your `/etc/sysctl.conf` to increase the number of files that can be monitored:
+
+```
+fs.inotify.max_user_watches = 100000
+fs.inotify.max_queued_events = 100000
+fs.inotify.max_user_instances = 100000
+```
+
 ## Contributing
 
 1. Fork it
@@ -81,7 +91,7 @@ so we can't use the notifier's file descriptor as a stand-in.
 
 Released under the MIT license.
 
-Copyright, 2009, by Nathan Weizenbaum.  
+Copyright, 2009, by [Natalie Weizenbaum](https://github.com/nex3).
 Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/rb-inotify/native.rb

@@ -29,8 +29,5 @@ module INotify
     attach_function :inotify_add_watch, [:int, :string, :uint32], :int
     attach_function :inotify_rm_watch, [:int, :uint32], :int
     attach_function :fpathconf, [:int, :int], :long
-
-    attach_function :read, [:int, :pointer, :size_t], :ssize_t
-    attach_function :close, [:int], :int
   end
 end

data/lib/rb-inotify/notifier.rb

@@ -1,3 +1,5 @@
+require 'thread'
+
 module INotify
   # Notifier wraps a single instance of inotify.
   # It's possible to have more than one instance,
@@ -38,12 +40,8 @@ module INotify
     # (except under JRuby -- see \{#to\_io}).
     #
     # @return [Fixnum]
-    attr_reader :fd
-
-    # @return [Boolean] Whether or not this Ruby implementation supports
-    #   wrapping the native file descriptor in a Ruby IO wrapper.
-    def self.supports_ruby_io?
-      RUBY_PLATFORM !~ /java/
+    def fd
+      @handle.fileno
     end
 
     # Creates a new {Notifier}.
@@ -51,9 +49,22 @@ module INotify
     # @return [Notifier]
     # @raise [SystemCallError] if inotify failed to initialize for some reason
     def initialize
-      @fd = Native.inotify_init
+      @running = Mutex.new
+      @pipe = IO.pipe
+      # JRuby shutdown sometimes runs IO finalizers before all threads finish.
+      if RUBY_ENGINE == 'jruby'
+        @pipe[0].autoclose = false
+        @pipe[1].autoclose = false
+      end
+
       @watchers = {}
-      return unless @fd < 0
+
+      fd = Native.inotify_init
+      unless fd < 0
+        @handle = IO.new(fd)
+        @handle.autoclose = false if RUBY_ENGINE == 'jruby'
+        return
+      end
 
       raise SystemCallError.new(
         "Failed to initialize inotify" +
@@ -82,10 +93,7 @@ module INotify
     # @return [IO] An IO object wrapping the file descriptor
     # @raise [NotImplementedError] if this is being called in JRuby
     def to_io
-      unless self.class.supports_ruby_io?
-        raise NotImplementedError.new("INotify::Notifier#to_io is not supported under JRuby")
-      end
-      @io ||= IO.new(@fd)
+      @handle
     end
 
     # Watches a file or directory for changes,
@@ -221,8 +229,14 @@ module INotify
     #
     # @see #process
     def run
-      @stop = false
-      process until @stop
+      @running.synchronize do
+        Thread.current[:INOTIFY_RUN_THREAD] = true
+        @stop = false
+
+        process until @stop
+      end
+    ensure
+      Thread.current[:INOTIFY_RUN_THREAD] = false
     end
 
     # Stop watching for filesystem events.
@@ -230,6 +244,13 @@ module INotify
     # exit out as soon as we finish handling the events.
     def stop
       @stop = true
+      @pipe.last.write "."
+
+      unless Thread.current[:INOTIFY_RUN_THREAD]
+        @running.synchronize do
+          # no-op: we just needed to wait until the lock was available
+        end
+      end
     end
 
     # Blocks until there are one or more filesystem events
@@ -250,17 +271,8 @@ module INotify
     # @raise [SystemCallError] if closing the underlying file descriptor fails.
     def close
       stop
-      if Native.close(@fd) == 0
-        @watchers.clear
-        return
-      end
-
-      raise SystemCallError.new("Failed to properly close inotify socket" +
-       case FFI.errno
-       when Errno::EBADF::Errno; ": invalid or closed file descriptior"
-       when Errno::EIO::Errno; ": an I/O error occured"
-       end,
-       FFI.errno)
+      @handle.close
+      @watchers.clear
     end
 
     # Blocks until there are one or more filesystem events that this notifier
@@ -302,38 +314,13 @@ module INotify
 
     # Same as IO#readpartial, or as close as we need.
     def readpartial(size)
-      # Use Ruby's readpartial if possible, to avoid blocking other threads.
-      begin
-        return to_io.readpartial(size) if self.class.supports_ruby_io?
-      rescue Errno::EBADF, IOError
-        # If the IO has already been closed, reading from it will cause
-        # Errno::EBADF. In JRuby it can raise IOError with invalid or
-        # closed file descriptor.
-        return nil
-      rescue IOError => ex
-        return nil if ex.message =~ /stream closed/
-        raise
-      end
-
-      tries = 0
-      begin
-        tries += 1
-        buffer = FFI::MemoryPointer.new(:char, size)
-        size_read = Native.read(fd, buffer, size)
-        return buffer.read_string(size_read) if size_read >= 0
-      end while FFI.errno == Errno::EINTR::Errno && tries <= 5
-
-      raise SystemCallError.new("Error reading inotify events" +
-        case FFI.errno
-        when Errno::EAGAIN::Errno; ": no data available for non-blocking I/O"
-        when Errno::EBADF::Errno; ": invalid or closed file descriptor"
-        when Errno::EFAULT::Errno; ": invalid buffer"
-        when Errno::EINVAL::Errno; ": invalid file descriptor"
-        when Errno::EIO::Errno; ": I/O error"
-        when Errno::EISDIR::Errno; ": file descriptor is a directory"
-        else; ""
-        end,
-        FFI.errno)
+      readable, = select([@handle, @pipe.first])
+      return nil if readable.include?(@pipe.first)
+      @handle.readpartial(size)
+    rescue Errno::EBADF
+      # If the IO has already been closed, reading from it will cause
+      # Errno::EBADF.
+      nil
     end
   end
 end

data/lib/rb-inotify/version.rb

@@ -20,5 +20,5 @@
 # THE SOFTWARE.
 
 module INotify
-  VERSION = '0.9.10'
+  VERSION = '0.10.1'
 end

data/rb-inotify.gemspec

@@ -1,7 +1,5 @@
 # -*- encoding: utf-8 -*-
-
-$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
-require 'rb-inotify/version'
+require_relative 'lib/rb-inotify/version'
 
 Gem::Specification.new do |spec|
   spec.name     = 'rb-inotify'
@@ -18,13 +16,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = '>= 0'
-
-  spec.add_dependency 'ffi', '>= 0.5.0', '< 2'
-
-  spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "bundler", "~> 1.3"
-  # rake 11.x requires Ruby >= 1.9.3
-  spec.add_development_dependency "rake", ">= 10.5.0", "< 13"
+  
+  spec.required_ruby_version = '>= 2.2'
+  
+  spec.add_dependency "ffi", "~> 1.0"
+  
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "concurrent-ruby"
 end

data/spec/notifier_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+require 'tmpdir'
+require 'concurrent'
+
+describe INotify::Notifier do
+  describe "instance" do
+    around do |block|
+      Dir.mktmpdir do |dir|
+        @root = Pathname.new(dir)
+        @notifier = INotify::Notifier.new
+
+        begin
+          block.call
+        ensure
+          @notifier.close
+        end
+      end
+    end
+
+    let(:dir) do
+      @root.join("foo").tap(&:mkdir)
+    end
+
+    let(:another_dir) do
+      @root.join("bar").tap(&:mkdir)
+    end
+
+    it "stops" do
+      @notifier.stop
+    end
+
+    describe :process do
+      it "gets events" do
+        events = recording(dir, :create)
+        dir.join("test.txt").write("hello world")
+
+        @notifier.process
+
+        expect(events.size).to eq(1)
+        expect(events.first.name).to eq("test.txt")
+        expect(events.first.absolute_name).to eq(dir.join("test.txt").to_s)
+      end
+
+      it "gets simultaneous events" do
+        events = recording(dir, :create)
+
+        dir.join("one.txt").write("hello world")
+        dir.join("two.txt").write("hello world")
+
+        @notifier.process
+
+        expect(events.map(&:name)).to match_array(%w(one.txt two.txt))
+      end
+
+      it "separates events between watches" do
+        bar_events = nil
+
+        foo_events = recording(dir, :create)
+        bar_events = recording(another_dir, :create)
+
+        dir.join("test.txt").write("hello world")
+        another_dir.join("test_two.txt").write("hello world")
+
+        @notifier.process
+
+        expect(foo_events.size).to eq(1)
+        expect(foo_events.first.name).to eq("test.txt")
+        expect(foo_events.first.absolute_name).to eq(dir.join("test.txt").to_s)
+
+        expect(bar_events.size).to eq(1)
+        expect(bar_events.first.name).to eq("test_two.txt")
+        expect(bar_events.first.absolute_name).to eq(another_dir.join("test_two.txt").to_s)
+      end
+    end
+
+    describe :run do
+      it "processes repeatedly until stopped" do
+        barriers = Array.new(3) { Concurrent::Event.new }
+        barrier_queue = barriers.dup
+        events = recording(dir, :create) { barrier_queue.shift.set }
+
+        run_thread = Thread.new { @notifier.run }
+
+        dir.join("one.txt").write("hello world")
+        barriers.shift.wait(1) or raise "timeout"
+
+        expect(events.map(&:name)).to match_array(%w(one.txt))
+
+        dir.join("two.txt").write("hello world")
+        barriers.shift.wait(1) or raise "timeout"
+
+        expect(events.map(&:name)).to match_array(%w(one.txt two.txt))
+
+        @notifier.stop
+
+        dir.join("three.txt").write("hello world")
+        barriers.shift.wait(1)
+
+        dir.join("four.txt").write("hello world")
+        run_thread.join
+
+        expect(events.map(&:name)).to match_array(%w(one.txt two.txt))
+      end
+
+      it "can be stopped from within a callback" do
+        barriers = Array.new(3) { Concurrent::Event.new }
+        barrier_queue = barriers.dup
+        events = recording(dir, :create) { @notifier.stop }
+
+        run_thread = Thread.new { @notifier.run }
+        dir.join("one.txt").write("hello world")
+        run_thread.join
+      end
+    end
+
+    describe :fd do
+      it "returns an integer" do
+        expect(@notifier.fd).to be_an(Integer)
+      end
+    end
+
+    describe :to_io do
+      it "returns a ruby IO" do
+        expect(@notifier.to_io).to be_an(::IO)
+      end
+
+      it "matches the fd" do
+        expect(@notifier.to_io.fileno).to eq(@notifier.fd)
+      end
+
+      it "caches its result" do
+        expect(@notifier.to_io).to be(@notifier.to_io)
+      end
+
+      it "is selectable" do
+        events = recording(dir, :create)
+        expect(select([@notifier.to_io], nil, nil, 0.2)).to be_nil
+
+        dir.join("test.txt").write("hello world")
+        expect(select([@notifier.to_io], nil, nil, 0.2)).to eq([[@notifier.to_io], [], []])
+
+        @notifier.process
+        expect(select([@notifier.to_io], nil, nil, 0.2)).to be_nil
+      end
+    end
+
+    private
+
+    def recording(dir, *flags, callback: nil)
+      events = []
+      @notifier.watch(dir.to_s, *flags) do |event|
+        events << event
+        yield if block_given?
+      end
+
+      events
+    end
+  end
+
+  describe "mixed instances" do
+    it "doesn't tangle fds" do
+      notifiers = Array.new(30) { INotify::Notifier.new }
+      notifiers.each(&:to_io)
+
+      one = Array.new(10) { IO.pipe.last }
+      notifiers.each(&:close)
+
+      two = Array.new(10) { IO.pipe.last }
+
+      notifiers = nil
+      GC.start
+
+      _, writable, _ = select(nil, one, nil, 1)
+      expect(writable).to match_array(one)
+
+      _, writable, _ = select(nil, two, nil, 1)
+      expect(writable).to match_array(two)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,21 @@
 
+if ENV['COVERAGE'] || ENV['TRAVIS']
+	begin
+		require 'simplecov'
+		
+		SimpleCov.start do
+			add_filter "/spec/"
+		end
+		
+		if ENV['TRAVIS']
+			require 'coveralls'
+			Coveralls.wear!
+		end
+	rescue LoadError
+		warn "Could not load simplecov: #{$!}"
+	end
+end
+
 require "bundler/setup"
 require "rb-inotify"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rb-inotify
 version: !ruby/object:Gem::Version
-  version: 0.9.10
+  version: 0.10.1
 platform: ruby
 authors:
 - Natalie Weizenbaum
@@ -9,76 +9,78 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-17 00:00:00.000000000 Z
+date: 2019-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.5.0
-    - - "<"
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - nex342@gmail.com
@@ -91,6 +93,7 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/rb-inotify.rb
@@ -102,8 +105,8 @@ files:
 - lib/rb-inotify/version.rb
 - lib/rb-inotify/watcher.rb
 - rb-inotify.gemspec
-- spec/rb-inotify/errors_spec.rb
-- spec/rb-inotify_spec.rb
+- spec/inotify_spec.rb
+- spec/notifier_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/guard/rb-inotify
 licenses:
@@ -117,19 +120,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for Linux inotify, using FFI
 test_files:
-- spec/rb-inotify/errors_spec.rb
-- spec/rb-inotify_spec.rb
+- spec/inotify_spec.rb
+- spec/notifier_spec.rb
 - spec/spec_helper.rb

data/spec/rb-inotify/errors_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-
-describe INotify do
-  describe "QueueOverflowError" do
-    it "exists" do
-      expect(INotify::QueueOverflowError).to be_truthy
-    end
-  end
-end