rb-inotify 0.10.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 508d32162686edac9f8899476c72f067947853be3bf54636c03e8e26af5f1db6
-  data.tar.gz: 40ba36f43b4ddbc6659fdc60a23494fc0c3d3aea69e8da38100860b315410c10
+  metadata.gz: f0606a3b14ba7783689483410651837223b0a9d2967572cd768c421db22462bb
+  data.tar.gz: 28425a8d1c6c7067f365499185ef9916c0c9892fa467f74f5adbfc18039e4b19
 SHA512:
-  metadata.gz: e6a89d3e902bd71ed29ae54023f0a54be8fa525fa062a272a4291b35072fe75b1d597ce1d095eda32df4b6d842ea73321e770a9c67bb1492248c74c226cfc2ab
-  data.tar.gz: 70abecd11f1ceee101444d6cbd35c086ad0604a847d48b79c9fbda0658e3bc1ddad16c6047c1df50d84bdf7fa854251da66ede2106158b124eabe7d0b47bff7f
+  metadata.gz: f8b727242e12cb3debd140ac9b3e45a114f77c0642f33faa252f258360113ccf1fa16fb4c08ed1c16772884aef22d913ce394d3a4bf2be8a0754865a09e39f13
+  data.tar.gz: '02940752a3b3c8b44a465b71300290d60b910def4a56dfac8949a8f69379b8b58b01d278e58cb99c138eb8a6187fb8f44307efae15c9a3bf7c265991f90aebb4'

data/.github/workflows/test.yaml

@@ -0,0 +1,53 @@
+name: Test
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  CONSOLE_OUTPUT: XTerm
+
+jobs:
+  test:
+    name: ${{matrix.ruby}} on ${{matrix.os}}
+    runs-on: ${{matrix.os}}-latest
+    continue-on-error: ${{matrix.experimental}}
+    
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+        
+        ruby:
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
+        
+        experimental: [false]
+        
+        include:
+          - os: ubuntu
+            ruby: truffleruby
+            experimental: true
+          - os: ubuntu
+            ruby: jruby
+            experimental: true
+          - os: ubuntu
+            ruby: head
+            experimental: true
+    
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true
+    
+    - name: Run tests
+      timeout-minutes: 10
+      run: bundle exec rspec

data/Gemfile

@@ -3,14 +3,18 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in utopia.gemspec
 gemspec
 
-group :development do
-	gem 'pry'
-	gem 'pry-coolline'
-	
-	gem 'tty-prompt'
+group :maintenance, optional: true do
+  gem "bake-gem"
+  gem "bake-modernize"
 end
 
 group :test do
-	gem 'simplecov'
-	gem 'coveralls', require: false
+  gem "rspec", "~> 3.6"
+
+  gem 'simplecov'
+  gem 'coveralls', require: false
+
+  gem "bundler"
+  gem "rake"
+  gem "concurrent-ruby"
 end

data/LICENSE.md

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

data/README.md

@@ -6,11 +6,9 @@ It uses the [FFI](http://wiki.github.com/ffi/ffi) gem to avoid having to compile
 
 [API documentation is available on rdoc.info](http://rdoc.info/projects/nex3/rb-inotify).
 
-[![Build Status](https://secure.travis-ci.org/guard/rb-inotify.svg)](http://travis-ci.org/guard/rb-inotify)
-[![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)
+[![Development Status](https://github.com/guard/rb-inotify/workflows/Test/badge.svg)](https://github.com/guard/rb-inotify/actions?workflow=Test)
 
-## Basic Usage
+## Usage
 
 The API is similar to the inotify C API, but with a more Rubyish feel.
 First, create a notifier:
@@ -69,6 +67,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

data/lib/rb-inotify/notifier.rb

@@ -24,10 +24,8 @@ module INotify
   #   # Nothing happens until you run the notifier!
   #   notifier.run
   class Notifier
-    # A list of directories that should never be recursively watched.
-    #
     # * Files in `/dev/fd` sometimes register as directories, but are not enumerable.
-    RECURSIVE_BLACKLIST = %w[/dev/fd]
+    NON_RECURSIVE = "/dev/fd"
 
     # A hash from {Watcher} ids to the instances themselves.
     #
@@ -50,13 +48,20 @@ module INotify
     # @raise [SystemCallError] if inotify failed to initialize for some reason
     def initialize
       @running = Mutex.new
+      @stop = false
       @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 = {}
 
       fd = Native.inotify_init
       unless fd < 0
         @handle = IO.new(fd)
+        @handle.autoclose = false if RUBY_ENGINE == 'jruby'
         return
       end
 
@@ -191,20 +196,17 @@ module INotify
     def watch(path, *flags, &callback)
       return Watcher.new(self, path, *flags, &callback) unless flags.include?(:recursive)
 
-      dir = Dir.new(path)
+      dont_follow = flags.include?(:dont_follow)
 
-      dir.each do |base|
+      Dir.each_child(path) do |base|
         d = File.join(path, base)
-        binary_d = d.respond_to?(:force_encoding) ? d.dup.force_encoding('BINARY') : d
-        next if binary_d =~ /\/\.\.?$/ # Current or parent directory
-        next if RECURSIVE_BLACKLIST.include?(d)
-        next if flags.include?(:dont_follow) && File.symlink?(d)
-        next if !File.directory?(d)
+        next unless File.directory?(d)
+        next if dont_follow && File.symlink?(d)
+        next if NON_RECURSIVE == d
 
         watch(d, *flags, &callback)
       end
 
-      dir.close
 
       rec_flags = [:create, :moved_to]
       return watch(path, *((flags - [:recursive]) | rec_flags)) do |event|
@@ -224,10 +226,13 @@ module INotify
     # @see #process
     def run
       @running.synchronize do
-        @stop = false
+        Thread.current[:INOTIFY_RUN_THREAD] = true
 
         process until @stop
       end
+    ensure
+      Thread.current[:INOTIFY_RUN_THREAD] = false
+      @stop = false
     end
 
     # Stop watching for filesystem events.
@@ -237,8 +242,10 @@ module INotify
       @stop = true
       @pipe.last.write "."
 
-      @running.synchronize do
-        # no-op: we just needed to wait until the lock was available
+      unless Thread.current[:INOTIFY_RUN_THREAD]
+        @running.synchronize do
+          # no-op: we just needed to wait until the lock was available
+        end
       end
     end
 

data/lib/rb-inotify/version.rb

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

data/rb-inotify.gemspec

@@ -17,12 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
   
-  spec.required_ruby_version = '>= 2.2'
+  spec.required_ruby_version = '>= 2.5'
   
   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

@@ -94,13 +94,33 @@ describe INotify::Notifier do
         @notifier.stop
 
         dir.join("three.txt").write("hello world")
-        barriers.shift.wait(1)
-
-        dir.join("four.txt").write("hello world")
-        run_thread.join
+        run_thread.join(1) or raise "timeout"
 
         expect(events.map(&:name)).to match_array(%w(one.txt two.txt))
       end
+
+      it "can be stopped from within a callback" do
+        recording(dir, :create) { @notifier.stop }
+
+        run_thread = Thread.new { @notifier.run }
+
+        dir.join("one.txt").write("hello world")
+        run_thread.join(1) or raise "timeout"
+      end
+
+      it "can be stopped before it starts processing" do
+        barrier = Concurrent::Event.new
+
+        run_thread = Thread.new do
+          barrier.wait
+          @notifier.run
+        end
+
+        @notifier.stop
+        barrier.set
+
+        run_thread.join(1) or raise "timeout"
+      end
     end
 
     describe :fd do

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rb-inotify
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Natalie Weizenbaum
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-15 00:00:00.000000000 Z
+date: 2024-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -25,63 +25,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
+description:
 email:
 - nex342@gmail.com
 - samuel.williams@oriontransfer.co.nz
@@ -89,13 +33,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yaml"
 - ".gitignore"
-- ".travis.yml"
 - ".yardopts"
 - Gemfile
 - LICENSE.md
 - README.md
-- Rakefile
 - lib/rb-inotify.rb
 - lib/rb-inotify/errors.rb
 - lib/rb-inotify/event.rb
@@ -112,7 +55,7 @@ homepage: https://github.com/guard/rb-inotify
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,16 +63,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: A Ruby wrapper for Linux inotify, using FFI
 test_files:

data/.travis.yml

@@ -1,21 +0,0 @@
-language: ruby
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.3
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: jruby
-    - rvm: truffleruby
-    - rvm: jruby-head
-    - rvm: ruby-head
-    - rvm: rbx-3
-  allow_failures:
-    - rvm: truffleruby
-    - rvm: jruby
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx-3
-  fast_finish: true

data/Rakefile

@@ -1,14 +0,0 @@
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-desc "Run tests"
-task :default => :spec
-
-task :console do
-  require 'rb-inotify'
-  require 'pry'
-  
-  binding.pry
-end