rb-kqueue 0.2.4 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e0fbb1227b72dfcf7a88a6518c1d682eb7b16cc
-  data.tar.gz: 1b116b3d52ff04e5d31a78ef819020a6a6001c6e
+SHA256:
+  metadata.gz: ac9ed909df24b81fc8a76d0a7f78284abb1e7b6adf93afd2dff83a746fc4ded0
+  data.tar.gz: 30c08e8b7010a5c62f91ff68977d2042d47f4c81d7853f618847250847592460
 SHA512:
-  metadata.gz: 5ada986f6476b4d522a5103fd2d56623a0dd7b86f271c7549c4a2fb9d0722492574446c09b8aa023ed059837fc8122fb30969436510798957a7b95e6a3c5c69f
-  data.tar.gz: 712ae220aa51c262ba8126909fcd6d1d9b981c2fa9cb6900b70629085e46bbab0ff775eebdcd6656100843a581f77a16c5c4a71a63f01f3a8d4dba3b07a48c02
+  metadata.gz: 72d763ee6c8c5db86c4f6cf01f876bd68401b3863459b093f5eb4a3cb97ea70aa18cc5912e94829e01d5d948694f2cf488a1752196414cb59d45ae36e682c83a
+  data.tar.gz: d09bd0aa9c66756823d08584ba55b96889c337e59dad1cd2f532ea24020f339e3e04780fdbb0d1ef6297f5273a9efe165b97401493dac98619939819d5bcf675

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+rb-kqueue

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.5

data/lib/rb-kqueue/event.rb

@@ -3,6 +3,11 @@ module KQueue
   # Each {Watcher} can fire many events,
   # which are passed to that Watcher's callback.
   class Event
+
+    # Exception raised on an attempt to construct an {Event}
+    # from a native event with unexpected field values.
+    class UnexpectedEvent < Exception; end
+
     # Some integer data, the interpretation of which
     # is specific to each individual {Watcher}.
     # For specifics, see the individual Watcher subclasses.
@@ -64,7 +69,11 @@ module KQueue
       @native = native
       @queue = queue
       @data = @native[:data]
-      @filter = KQueue::Native::Flags.from_flag("EVFILT", @native[:filter])
+      begin
+        @filter = KQueue::Native::Flags.from_flag("EVFILT", @native[:filter])
+      rescue Native::Flags::FlagNotFound
+        raise UnexpectedEvent
+      end
       @flags = Native::Flags.from_mask("EV", @native[:flags])
 
       KQueue.handle_error @native[:data] if @flags.include?(:error)

data/lib/rb-kqueue/native/flags.rb

@@ -6,17 +6,50 @@ module KQueue
     # @private
     module Flags
       # Filters
-      EVFILT_READ = -1
-      EVFILT_WRITE = -2
-      EVFILT_AIO = -3 # Attached to aio requests
-      EVFILT_VNODE = -4 # Attached to vnodes
-      EVFILT_PROC = -5 # Attached to struct proc
-      EVFILT_SIGNAL = -6 # Attached to struct proc
-      EVFILT_TIMER = -7 # Timers
-      EVFILT_MACHPORT = -8 # Mach portsets
-      EVFILT_FS = -9 # Filesystem events
-      EVFILT_USER = -10 # User events
-      EVFILT_SESSION = -11 # Audit session events
+      if FFI::Platform::IS_FREEBSD
+        EVFILT_READ = -1
+        EVFILT_WRITE = -2
+        EVFILT_AIO = -3 # Attached to aio requests
+        EVFILT_VNODE = -4 # Attached to vnodes
+        EVFILT_PROC = -5 # Attached to struct proc
+        EVFILT_SIGNAL = -6 # Attached to struct proc
+        EVFILT_TIMER = -7 # Timers
+        EVFILT_PROCDESC = -8 # Attached to process descriptors
+        EVFILT_FS = -9 # Filesystem events
+        EVFILT_LIO = -10 # Attached to lio requests
+        EVFILT_USER = -11 # User events
+        EVFILT_SENDFILE = -12 # Attached to sendfile requests
+        EVFILT_SYSCOUNT = 12
+      elsif FFI::Platform::IS_NETBSD
+        EVFILT_READ = 0
+        EVFILT_WRITE = 1
+        EVFILT_AIO = 2 # Attached to aio requests
+        EVFILT_VNODE = 3 # Attached to vnodes
+        EVFILT_PROC = 4 # Attached to struct proc
+        EVFILT_SIGNAL = 5 # Attached to struct proc
+        EVFILT_TIMER = 6 # Arbitrary timer (in ms)
+        EVFILT_SYSCOUNT = 7 # Number of filters
+      elsif FFI::Platform::IS_OPENBSD
+        EVFILT_READ = -1
+        EVFILT_WRITE = -2
+        EVFILT_AIO = -3 # Attached to aio requests
+        EVFILT_VNODE = -4 # Attached to vnodes
+        EVFILT_PROC = -5 # Attached to struct proc
+        EVFILT_SIGNAL = -6 # Attached to struct proc
+        EVFILT_TIMER = -7 # Timers
+      else
+        EVFILT_READ = -1
+        EVFILT_WRITE = -2
+        EVFILT_AIO = -3 # Attached to aio requests
+        EVFILT_VNODE = -4 # Attached to vnodes
+        EVFILT_PROC = -5 # Attached to struct proc
+        EVFILT_SIGNAL = -6 # Attached to struct proc
+        EVFILT_TIMER = -7 # Timers
+        EVFILT_MACHPORT = -8 # Mach portsets
+        EVFILT_FS = -9 # Filesystem events
+        EVFILT_USER = -10 # User events
+        EVFILT_SESSION = -11 # Audit session events
+      end
 
 
       # Actions
@@ -64,6 +97,9 @@ module KQueue
       NOTE_TIMER_NSECONDS = 0x00000004 # data is nanoseconds
       NOTE_TIMER_ABSOLUTE = 0x00000008 # absolute timeout
 
+      # Exception raised when a function fails to find a flag satisfying
+      # its given query.
+      class FlagNotFound < Exception; end
 
       # Converts a list of flags to the bitmask that the C API expects.
       #
@@ -110,6 +146,7 @@ module KQueue
           next unless c =~ re
           return c.to_s.sub("#{prefix}_", "").downcase.to_sym if const_get(c) == flag
         end
+        raise FlagNotFound
       end
     end
   end

data/lib/rb-kqueue/native.rb

@@ -13,13 +13,39 @@ module KQueue
     #
     # @private
     class KEvent < FFI::Struct
-      layout(
-        :ident,  :uintptr_t,
-        :filter, :int16,
-        :flags,  :uint16,
-        :fflags, :uint32,
-        :data,   :intptr_t,
-        :udata,  :pointer)
+      if FFI::Platform::IS_FREEBSD
+        layout(
+          :ident,  :uintptr_t,
+          :filter, :short,
+          :flags,  :u_short,
+          :fflags, :u_int,
+          :data,   :intptr_t,
+          :udata,  :pointer)
+      elsif FFI::Platform::IS_NETBSD
+        layout(
+          :ident,  :uintptr_t,
+          :filter, :uint32_t,
+          :flags,  :uint32_t,
+          :fflags, :uint32_t,
+          :data,   :int64_t,
+          :udata,  :pointer)
+      elsif FFI::Platform::IS_OPENBSD
+        layout(
+          :ident,  :__uintptr_t,
+          :filter, :short,
+          :flags,  :u_short,
+          :fflags, :u_int,
+          :data,   :quad_t,
+          :udata,  :pointer)
+      else
+        layout(
+          :ident,  :uintptr_t,
+          :filter, :int16,
+          :flags,  :uint16,
+          :fflags, :uint32,
+          :data,   :intptr_t,
+          :udata,  :pointer)
+      end
     end
 
     # The C struct describing a timeout.

data/lib/rb-kqueue/queue.rb

@@ -359,7 +359,13 @@ module KQueue
       res = Native.kevent(@fd, nil, 0, eventlist, size, timeout)
 
       KQueue.handle_error if res < 0
-      (0...res).map {|i| KQueue::Event.new(Native::KEvent.new(eventlist[i]), self)}
+      (0...res).map do |i|
+        begin
+          KQueue::Event.new(Native::KEvent.new(eventlist[i]), self)
+        rescue KQueue::Event::UnexpectedEvent
+          nil
+        end
+      end.compact
     end
   end
 end

data/lib/rb-kqueue/version.rb

@@ -1,3 +1,3 @@
 module KQueue
-  VERSION = [0, 2, 4]
+  VERSION = [0, 2, 8]
 end

data/lib/rb-kqueue/watcher/file.rb

@@ -37,20 +37,24 @@ module KQueue
             FFI.errno)
         end
 
-        ObjectSpace.define_finalizer(self, lambda do
-            next unless Native.close(@fd) < 0
-            raise SystemCallError.new(
-              "Failed to close file #{path}" +
-              case FFI.errno
-              when Errno::EBADF::Errno; ": Invalid file descriptor."
-              when Errno::EINTR::Errno; ": Closing interrupted."
-              when Errno::EIO::Errno; ": IO error."
-              else; ""
-              end,
-              FFI.errno)
-          end)
+        ObjectSpace.define_finalizer(self, self.class.finalizer(@fd, path))
         super(queue, @fd, :vnode, flags, nil, callback)
       end
+
+      def self.finalizer(fd, path)
+        lambda do |id=nil|
+          next unless Native.close(fd) < 0
+          raise SystemCallError.new(
+            "Failed to close file #{path}" +
+            case FFI.errno
+          when Errno::EBADF::Errno; ": Invalid file descriptor."
+          when Errno::EINTR::Errno; ": Closing interrupted."
+          when Errno::EIO::Errno; ": IO error."
+          else; ""
+          end,
+          FFI.errno)
+        end
+      end
     end
   end
 end

data/rb-kqueue.gemspec

@@ -1,8 +1,3 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
 require File.expand_path('../lib/rb-kqueue/version', __FILE__)
 
 Gem::Specification.new do |gem|
@@ -11,22 +6,20 @@ Gem::Specification.new do |gem|
 
   gem.authors = ["Mathieu Arnold", "Nathan Weizenbaum"]
   gem.email = %q{mat@mat.cc nex342@gmail.com}
-  gem.date = %q{2015-05-01}
   gem.description = %q{A Ruby wrapper for BSD's kqueue, using FFI}
   gem.extra_rdoc_files = %w(README.md)
   gem.licenses = ['MIT']
 
   gem.files = `git ls-files`.split(/\n/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
 
   gem.homepage = %q{http://github.com/mat813/rb-kqueue}
   gem.rdoc_options = ["--charset=UTF-8"]
   gem.require_paths = ["lib"]
-  gem.rubygems_version = %q{1.3.5}
   gem.summary = %q{A Ruby wrapper for BSD's kqueue, using FFI}
 
   gem.add_runtime_dependency(%q<ffi>, [">= 0.5.0"])
   gem.add_development_dependency(%q<yard>, [">= 0.4.0"])
+  gem.add_development_dependency(%q<rspec>, [">= 3.3.0"])
 end
-

data/spec/kqueue_queue_spec.rb

@@ -0,0 +1,32 @@
+require_relative '../lib/rb-kqueue'
+require 'tempfile'
+require 'pathname'
+
+RSpec.describe KQueue::Queue do
+  describe '#watch_file' do
+    let(:file_touched) { false }
+    let(:queue) { KQueue::Queue.new }
+    let(:file) { Tempfile.new 'rb-kqueue_test', Pathname(__dir__).parent.join('tmp') }
+
+    context 'file is watched for writes' do
+      before do
+        queue.watch_file file.path, :write do
+          file_touched = !file_touched
+        end
+        queue.process
+      end
+
+      context 'file is written to' do
+        it 'executes the defined block' do
+          expect { file.write 'test' }.to change { file_touched }.from(false).to true
+        end
+      end
+    end
+
+    context 'file is watched for reads' do
+    end
+
+    context 'file is not watched' do
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# 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_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.
+=begin
+  # 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
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  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
+end

metadata

@@ -1,44 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: rb-kqueue
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.8
 platform: ruby
 authors:
 - Mathieu Arnold
 - Nathan Weizenbaum
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2022-02-07 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
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 description: A Ruby wrapper for BSD's kqueue, using FFI
 email: mat@mat.cc nex342@gmail.com
 executables: []
@@ -46,13 +60,15 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- .gitignore
-- .yardopts
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".yardopts"
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
-- VERSION
 - lib/rb-kqueue.rb
 - lib/rb-kqueue/event.rb
 - lib/rb-kqueue/native.rb
@@ -67,29 +83,32 @@ files:
 - lib/rb-kqueue/watcher/socket_read_write.rb
 - lib/rb-kqueue/watcher/timer.rb
 - rb-kqueue.gemspec
+- spec/kqueue_queue_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/mat813/rb-kqueue
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 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: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: A Ruby wrapper for BSD's kqueue, using FFI
-test_files: []
+test_files:
+- spec/kqueue_queue_spec.rb
+- spec/spec_helper.rb

data/VERSION

@@ -1 +0,0 @@
-0.1.0