lockf.rb 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05e204191db7552902307b79f09636be97f36fba053a89c5ab849c6dd0205830
-  data.tar.gz: 82167b478eae279325094a0ba29b8d75500dc6d0a53ea32fd24ed0ef200fa643
+  metadata.gz: b0f68d54d3ad30fc3c9c6316910adebcd74645876546aec01c86402261275ff6
+  data.tar.gz: ed9cbe6b94840dd3987d16825737b3e98c42efb4904f15fd2ef206ebd0ab431a
 SHA512:
-  metadata.gz: 31b69f15f99e3a4b6f522de3b708130ee67ab3a3c5498df989e034bf281f0c02463f360d948150ca9cd562e85a9fd4a8d802d27dad6fa014e289abaa33c6f5d6
-  data.tar.gz: 8b9d9b5979cf813a0234054531e0fe4e6d7c7be83221f49540aeaec97d94347db851756fece830b4f711da42683d4195589f7d3578264a232d6aedd37d7d0377
+  metadata.gz: 663fb2919e2560b75307ce6ea01291582e61fca0fa14f9c86f54dfd7ab598a2301b361be09952800a93089a5010f53dcd8ee76870ba1cc44ff7470ef1295abb0
+  data.tar.gz: a249a8c95037378796bbc8cb4fd3224da60137117902ac189546860791bfa9b1256a26636895762ffbcd3a74037e4bb38c26d6aefe57721ca6d603a0022f1128

data/.github/workflows/tests.yml

@@ -11,8 +11,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest]
-        ruby: [3.2]
+        os: [ubuntu-latest, macos-latest]
+        ruby: [3.2, 3.3]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
@@ -20,4 +20,4 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
     - run: bundle install
-    - run: bundle exec rake
+    - run: ruby -S rake ci

data/.gitignore

@@ -1,10 +1,4 @@
-*.so
-*.o
-*.lock
-Makefile
-tmp/
-pkg/
-*~
-.yardoc/
-.gems/
-doc/
+/*.lock
+/.yardoc/
+/.gems/
+/doc/

data/.rubocop.yml

@@ -14,6 +14,14 @@ Layout/MultilineMethodCallIndentation:
   Enabled: false
 Layout/ArgumentAlignment:
   Enabled: false
+Layout/MultilineArrayBraceLayout:
+  Enabled: false
+Layout/ExtraSpacing:
+  Enabled: false
+Style/MultilineIfModifier:
+  Enabled: false
+Layout/ArrayAlignment:
+  Enabled: false
 
 ##
 # Options for all cops.
@@ -23,3 +31,4 @@ AllCops:
     - lib/*.rb
     - lib/**/*.rb
     - test/*.rb
+    - share/lockf.rb/examples/*.rb

data/README.md

@@ -2,40 +2,36 @@
 
 lockf.rb provides Ruby bindings for
 [lockf(3)](https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3).
-The
-[lockf(3)](https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3)
-function implements an advisory-mode lock that can be placed on select
-regions of a file, or on the entire contents of a file.
 
 ## Examples
 
-### LockFile
-
-The
-[`LockFile`](https://0x1eef.github.io/x/lockf.rb/LockFile.html)
-class provides an abstract, Ruby-oriented interface to
-[lockf(3)](https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3).
+### Lock::File
 
-__Blocking lock__
+__Blocking__
 
-The `LockFile#lock` method can be used to acquire a lock. The method will
-block when another process has acquired a lock beforehand:
+[Lock::File#lock](http://0x1eef.github.io/x/lockf.rb/Lock/File.html#lock-instance_method)
+can be used to acquire a lock.
+[Lock::File.temporary_file](http://0x1eef.github.io/x/lockf.rb/Lock/File.html#temporary_file-class_method)
+returns a lock for an unlinked temporary file.
+[Lock::File#lock](http://0x1eef.github.io/x/lockf.rb/Lock/File.html#lock-instance_method)
+will block when another
+process has acquired a lock beforehand:
 
 ```ruby
-require "lockf"
+#!/usr/bin/env ruby
+require "lock/file"
 
-lockf = LockFile.temporary_file
+lockf = Lock::File.temporary_file
 lockf.lock
 print "Lock acquired by parent process (#{Time.now.utc})", "\n"
-pid = fork do
+fork do
   print "Child process waiting on lock (#{Time.now.utc})", "\n"
   lockf.lock
   print "Lock acquired by child process (#{Time.now.utc})", "\n"
 end
 sleep(3)
 lockf.release
-Process.wait(pid)
-lockf.close
+Process.wait
 
 ##
 # Lock acquired by parent process (2023-02-11 16:43:15 UTC)
@@ -43,31 +39,31 @@ lockf.close
 # Lock acquired by child process (2023-02-11 16:43:18 UTC)
 ```
 
-__Non-blocking lock__
+__Non-blocking__
 
-The `LockFile#lock_nonblock` method can be used to acquire a lock
-without blocking. When it is found that acquiring a lock would block
-the method will raise an exception (ie `Errno::EAGAIN` /`Errno::EWOULDBLOCK`)
-instead:
+[Lock::File#lock_nonblock](http://0x1eef.github.io/x/lockf.rb/Lock/File.html#lock_nonblock-instance_method)
+can be used to acquire a lock without blocking. When it is found
+that acquiring a lock would block the method will raise an
+exception (`Errno::EAGAIN` / `Errno::EWOULDBLOCK`) instead:
 
 ```ruby
-require "lockf"
+#!/usr/bin/env ruby
+require "lock/file"
 
-lockf = LockFile.temporary_file
+lockf = Lock::File.temporary_file
 lockf.lock_nonblock
 print "Lock acquired by parent process (#{Time.now.utc})", "\n"
-pid = fork do
+fork do
   lockf.lock_nonblock
   print "Lock acquired by child process (#{Time.now.utc})", "\n"
 rescue Errno::EWOULDBLOCK
-  print "Lock would block", "\n"
   sleep 1
+  print "Lock would block", "\n"
   retry
 end
 sleep 3
 lockf.release
-Process.wait(pid)
-lockf.close
+Process.wait
 
 ##
 # Lock acquired by parent process (2023-02-11 19:03:05 UTC)
@@ -77,43 +73,25 @@ lockf.close
 # Lock acquired by child process (2023-02-11 19:03:08 UTC)
 ```
 
-### LockFile.lockf
+### Lock::File::FFI
+
+__lockf__
 
-The
-[`LockFile.lockf`](https://0x1eef.github.io/x/lockf.rb/LockFile.html#lockf-class_method)
-method provides a direct interface to
+[Lock::File::FFI.lockf](http://0x1eef.freebsd.home.network/x/lockf.rb/Lock/File/FFI.html#lockf-instance_method)
+provides a direct interface to
 [lockf(3)](https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3)
 that is more or less equivalent to how the function would be called
-from C.
-
-__Blocking lock__
-
-```ruby
-require "lockf"
-require "tempfile"
-
-file = Tempfile.new("lockf-ffi").tap(&:unlink)
-LockFile.lockf(file.fileno, LockFile::F_LOCK, 0)
-print "Lock acquired", "\n"
-LockFile.lockf(file.fileno, LockFile::F_ULOCK, 0)
-print "Lock released", "\n"
-file.close
-
-##
-# Lock acquired
-# Lock released
-```
-
-__Non-blocking lock__
+from C:
 
 ```ruby
-require "lockf"
+#!/usr/bin/env ruby
+require "lock/file"
 require "tempfile"
 
 file = Tempfile.new("lockf-ffi").tap(&:unlink)
-LockFile.lockf(file.fileno, LockFile::F_TLOCK, 0)
+Lock::File::FFI.lockf(file, Lock::File::F_LOCK, 0)
 print "Lock acquired", "\n"
-LockFile.lockf(file.fileno, LockFile::F_ULOCK, 0)
+Lock::File::FFI.lockf(file, Lock::File::F_ULOCK, 0)
 print "Lock released", "\n"
 file.close
 
@@ -124,14 +102,12 @@ file.close
 
 ## Documentation
 
-A complete API reference is available at 
-[0x1eef.github.io/x/lockf.rb](https://0x1eef.github.io/x/lockf.rb).
+A complete API reference is available at
+[0x1eef.github.io/x/lockf.rb](https://0x1eef.github.io/x/lockf.rb)
 
 ## Install
 
-**Rubygems.org**
-
-lockf.rb can be installed via rubygems.org.
+lockf.rb can be installed via rubygems.org:
 
     gem install lockf.rb
 
@@ -142,7 +118,7 @@ lockf.rb can be installed via rubygems.org.
 
 ## License
 
-[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
+[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
 <br>
-See [LICENSE](./LICENSE).
+See [LICENSE](./LICENSE)
 

data/Rakefile.rb

@@ -1,26 +1,23 @@
 require "bundler/setup"
-require "rake/extensiontask"
-require "rake/testtask"
 
-namespace :clang do
-  desc "Run clang-format"
-  task :format do
-    sh "clang-format -style=file:.clang-format -i ext/lockf.rb/*.c"
+namespace :format do
+  desc "Apply rubocop fixes"
+  task :apply do
+    sh "bundle exec rubocop -A"
   end
-end
 
-namespace :ruby do
   desc "Run rubocop"
-  task :format do
-    sh "bundle exec rubocop -A"
+  task :check do
+    sh "bundle exec rubocop"
   end
 end
-task format: %w[clang:format ruby:format]
+task format: %w[format:apply]
+
+desc "Run CI tasks"
+task ci: %i[format:check test]
 
-Rake::ExtensionTask.new("lockf.rb")
-Rake::TestTask.new do |t|
-  t.test_files = FileList["test/*_test.rb"]
-  t.verbose = true
-  t.warning = false
+desc "Run tests"
+task :test do
+  sh "bin/test-runner"
 end
-task default: %w[clobber compile test]
+task default: %w[test]

data/bin/test-runner

@@ -0,0 +1,6 @@
+#!/bin/sh
+set -e
+
+for t in test/*_test.rb; do
+    ruby -Itest "${t}"
+done

data/lib/lock/file/constants.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Lock::File
+  # The constants found in this module are defined
+  # by unistd.h. Their documentation can be found in
+  # the
+  # [lockf(3)](https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3)
+  # man page
+  module Constants
+    F_ULOCK = 0x0
+    F_LOCK  = 0x1
+    F_TLOCK = 0x2
+    F_TEST  = 0x3
+  end
+end

data/lib/lock/file/ffi.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class Lock::File
+  module FFI
+    require "fiddle"
+    include Fiddle::Types
+    extend self
+
+    ##
+    # Provides a Ruby interface for lockf(3)
+    #
+    # @see https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3 lockf(3)
+    # @param [Integer, #fileno] fd
+    # @param [Integer] function
+    # @param [Integer] size
+    # @raise [SystemCallError]
+    #  Might raise a subclass of SystemCallError
+    # @return [Boolean]
+    #  Returns true when successful
+    def lockf(fd, function, size = 0)
+      fileno = fd.respond_to?(:fileno) ? fd.fileno : fd
+      Fiddle::Function.new(
+        libc["lockf"],
+        [INT, INT, INT],
+        INT
+      ).call(fileno, function, size)
+       .zero? || raise(SystemCallError.new("lockf", Fiddle.last_error))
+    end
+
+    ##
+    # @return [Fiddle::Handle]
+    def libc
+      @libc ||= begin
+        globs = %w[
+          /lib/libc.so.*
+          /usr/lib/libc.so.*
+          /lib/x86_64-linux-gnu/libc.so.*
+          /lib/i386-linux-gnu/libc.so.*
+        ]
+        Fiddle.dlopen(Dir[*globs].first)
+      end
+    end
+  end
+end

data/lib/lock/file/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Lock::File
+  VERSION = "2.1.0"
+end

data/lib/lock/file.rb

@@ -0,0 +1,109 @@
+module Lock
+end unless defined?(Lock)
+
+##
+# {Lock::File Lock::File} provides an object-oriented
+# [lockf(3)](https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3)
+# interface
+class Lock::File
+  require_relative "file/version"
+  require_relative "file/ffi"
+  require_relative "file/constants"
+
+  include FFI
+  include Constants
+
+  ##
+  # Accepts the same parameters as Tempfile.new
+  #
+  # @example
+  #  lockf = Lock::File.temporary_file
+  #  lockf.lock
+  #  # ...
+  #
+  # @return [Lock::File]
+  #  Returns a {Lock::File Lock::File} for a random,
+  #  unlinked temporary file
+  def self.temporary_file(...)
+    require "tempfile" unless defined?(Tempfile)
+    Lock::File.new Tempfile.new(...).tap(&:unlink)
+  end
+
+  ##
+  # @return [<#fileno>]
+  #  Returns a file handle
+  attr_reader :file
+
+  ##
+  # @param [<#fileno>] file
+  # @param [Integer] size
+  # @return [Lock::File]
+  #  Returns an instance of {Lock::File Lock::File}
+  def initialize(file, size = 0)
+    @file = file
+    @size = size
+  end
+
+  ##
+  # Acquire lock (blocking)
+  #
+  # @see https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3 lockf(3)
+  # @raise [SystemCallError]
+  #  Might raise a subclass of SystemCallError
+  # @return [Boolean]
+  #  Returns true when successful
+  def lock
+    tries ||= 0
+    lockf(@file, F_LOCK, @size)
+  rescue Errno::EINTR => ex
+    tries += 1
+    (tries == 3) ? raise(ex) : retry
+  end
+
+  ##
+  # Acquire lock (non-blocking)
+  #
+  # @see https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3 lockf(3)
+  # @raise [SystemCallError]
+  #  Might raise a subclass of SystemCallError
+  # @return [Boolean]
+  #  Returns true when successful
+  def lock_nonblock
+    lockf(@file, F_TLOCK, @size)
+  end
+
+  ##
+  # Release lock
+  #
+  # @see https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3 lockf(3)
+  # @raise [SystemCallError]
+  #  Might raise a subclass of SystemCallError
+  # @return [Boolean]
+  #  Returns true when successful
+  def release
+    lockf(@file, F_ULOCK, @size)
+  end
+
+  ##
+  # @return [Boolean]
+  #  Returns true when lock is held by another process
+  def locked?
+    lockf(@file, F_TEST, @size)
+    false
+  rescue Errno::EACCES, Errno::EAGAIN
+    true
+  end
+
+  ##
+  # Closes {Lock::File#file Lock::File#file}
+  #
+  # @example
+  #  # Equivalent to:
+  #  lockf = Lock::File.temporary_file
+  #  lockf.file.close
+  # @return [void]
+  def close
+    return unless @file.respond_to?(:close)
+    @file.close
+  end
+end

data/lib/lockf.rb

@@ -1,142 +1 @@
-##
-# The
-# [LockFile](https://0x1eef.github.io/x/lockf.rb/LockFile.html)
-# class provides a Ruby interface to
-# [lockf(3)](https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3).
-class LockFile
-  require "tmpdir"
-  require_relative "lockf.rb.so"
-
-  ##
-  # @!method self.lockf(fd, cmd, len)
-  #   @example
-  #     LockFile.lockf(5, LockFile::F_LOCK, 0)
-  #
-  #   @param [Integer] fd
-  #     A number that represents a file descriptor.
-  #
-  #   @param [Integer] cmd
-  #     {LockFile::F_LOCK}, {LockFile::F_TLOCK}, {LockFile::F_ULOCK}, or
-  #     {LockFile::F_TEST}.
-  #
-  #   @param [Integer] len
-  #     The number of bytes to place a lock on.
-  #     A value of "0" covers the entire file.
-  #
-  #   @raise [SystemCallError]
-  #     Might raise a number of Errno exception classes.
-  #
-  #   @return [Integer]
-  #     Returns 0 on success.
-  #
-  #   @see (https://man7.org/linux/man-pages/man3/lockf.3.html) lockf man page (Linux)
-  #   @see (https://man.openbsd.org/lockf.3) lockf man page (OpenBSD)
-  #   @see (https://www.freebsd.org/cgi/man.cgi?query=lockf) lockf man page (FreeBSD)
-
-  ##
-  # @example
-  #   lockf = LockFile.temporary_file
-  #   lockf.lock
-  #   lockf.release
-  #   lockf.file.close
-  #
-  # @param [String] basename
-  #  The basename of the temporary file.
-  #
-  # @param [String] tmpdir
-  #  The path to the parent directory of the temporary file.
-  #
-  # @return [LockFile]
-  #  Returns an instance of {LockFile LockFile} backed by an
-  #  unlinked instance of Tempfile.
-  def self.from_temporary_file(basename: "lockf", tmpdir: Dir.tmpdir)
-    require "tempfile" unless defined?(Tempfile)
-    file = Tempfile.new(basename, tmpdir:).tap(&:unlink)
-    LockFile.new(file)
-  end
-  class << self
-    alias_method :temporary_file, :from_temporary_file
-  end
-
-  ##
-  # @return [<File, Tempfile, #fileno>]
-  #  Returns a file object.
-  attr_reader :file
-
-  ##
-  # @param [<File, TempFile, String, #fileno>] file
-  #  The file to place a lock on.
-  #
-  # @param [Integer] len
-  #  The number of bytes to place a lock on.
-  #  A value of "0" covers the entire file.
-  #
-  # @return [LockFile]
-  #  Returns an instance of {LockFile LockFile}.
-  def initialize(file, len = 0)
-    @file = String === file ? File.open(file, "r+") : file
-    @len = len
-  end
-
-  ##
-  # Acquire a lock (blocking).
-  #
-  # @raise [Errno::EBADF]
-  # @raise [Errno::EDEADLK]
-  # @raise [Errno::EINTR]
-  # @raise [Errno::ENOLCK]
-  # @return [Integer]
-  def lock
-    attempts ||= 0
-    LockFile.lockf(@file.fileno, F_LOCK, @len)
-  rescue Errno::EINTR => ex
-    attempts += 1
-    attempts == 3 ? raise(ex) : retry
-  end
-
-  ##
-  # Acquire a lock (non-blocking).
-  #
-  # @raise [Errno::EAGAIN]
-  # @raise [Errno::EBADF]
-  # @raise [Errno::ENOLCK]
-  # @raise [Errno::EINVAL]
-  # @return [Integer]
-  def lock_nonblock
-    LockFile.lockf(@file.fileno, F_TLOCK, @len)
-  end
-
-  ##
-  # Release a lock.
-  #
-  # @raise [Errno::EBADF]
-  # @raise [Errno::ENOLCK]
-  # @return [Integer]
-  def release
-    LockFile.lockf(@file.fileno, F_ULOCK, @len)
-  end
-
-  ##
-  # @return [Boolean]
-  #  Returns true when a lock has been acquired by another process.
-  def locked?
-    LockFile.lockf(@file.fileno, F_TEST, @len)
-    false
-  rescue Errno::EACCES, Errno::EAGAIN
-    true
-  end
-
-  ##
-  # Closes {LockFile#file LockFile#file}.
-  #
-  # @example
-  #   # Equivalent to:
-  #   lockf = LockFile.temporary_file
-  #   lockf.file.close
-  #
-  # @return [void]
-  def close
-    return unless @file.respond_to?(:close)
-    @file.close
-  end
-end
+require_relative "lock/file"

data/lib/lockfile.rb

@@ -0,0 +1 @@
+require_relative "lock/file"

data/lockf.rb.gemspec

@@ -1,21 +1,21 @@
-require "./lib/lockf/version"
+require_relative "lib/lockfile"
 
 Gem::Specification.new do |gem|
   gem.name = "lockf.rb"
   gem.authors = ["0x1eef"]
   gem.email = ["0x1eef@protonmail.com"]
   gem.homepage = "https://github.com/0x1eef/lockf.rb#readme"
-  gem.version = LockFile::VERSION
+  gem.version = Lock::File::VERSION
   gem.licenses = ["0BSD"]
   gem.files = `git ls-files`.split($/)
   gem.require_paths = ["lib"]
-  gem.extensions = %w[ext/lockf.rb/extconf.rb]
   gem.summary = "Ruby bindings for lockf(3)"
   gem.description = gem.summary
+
+  gem.add_runtime_dependency "fiddle", "~> 1.1"
   gem.add_development_dependency "yard", "~> 0.9"
-  gem.add_development_dependency "standard", "~> 1.12"
+  gem.add_development_dependency "standard", "~> 1.39"
   gem.add_development_dependency "rubocop", "~> 1.29"
   gem.add_development_dependency "test-unit", "~> 3.5"
-  gem.add_development_dependency "rake-compiler", "~> 1.2"
-  gem.add_development_dependency "test-cmd.rb", "~> 0.6"
+  gem.add_development_dependency "test-cmd.rb", "~> 0.12"
 end

data/share/lockf.rb/examples/{1_lockfile_blocking_variant.rb → 1_lock_file_blocking_variant.rb}

@@ -1,17 +1,18 @@
-require "lockf"
+#!/usr/bin/env ruby
+# frozen_string_literal: true
 
-lockf = LockFile.from_temporary_file
+require "lock/file"
+lockf = Lock::File.temporary_file
 lockf.lock
 print "Lock acquired by parent process (#{Time.now.utc})", "\n"
-pid = fork do
+fork do
   print "Child process waiting on lock (#{Time.now.utc})", "\n"
   lockf.lock
   print "Lock acquired by child process (#{Time.now.utc})", "\n"
 end
 sleep(3)
 lockf.release
-Process.wait(pid)
-lockf.close
+Process.wait
 
 ##
 # Lock acquired by parent process (2023-02-11 16:43:15 UTC)

data/share/lockf.rb/examples/{2_lockfile_nonblocking_variant.rb → 2_lock_file_nonblocking_variant.rb}

@@ -1,9 +1,11 @@
-require "lockf"
+#!/usr/bin/env ruby
+# frozen_string_literal: true
 
-lockf = LockFile.from_temporary_file
+require "lock/file"
+lockf = Lock::File.temporary_file
 lockf.lock_nonblock
 print "Lock acquired by parent process (#{Time.now.utc})", "\n"
-pid = fork do
+fork do
   lockf.lock_nonblock
   print "Lock acquired by child process (#{Time.now.utc})", "\n"
 rescue Errno::EWOULDBLOCK
@@ -13,8 +15,7 @@ rescue Errno::EWOULDBLOCK
 end
 sleep 3
 lockf.release
-Process.wait(pid)
-lockf.close
+Process.wait
 
 ##
 # Lock acquired by parent process (2023-02-11 19:03:05 UTC)

data/share/lockf.rb/examples/3_ffi_lockf_blocking_variant.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "lock/file"
+require "tempfile"
+file = Tempfile.new("lockf-ffi").tap(&:unlink)
+Lock::File::FFI.lockf(file, Lock::File::F_LOCK, 0)
+print "Lock acquired", "\n"
+Lock::File::FFI.lockf(file, Lock::File::F_ULOCK, 0)
+print "Lock released", "\n"
+file.close
+
+##
+# Lock acquired
+# Lock released

data/share/lockf.rb/examples/4_ffi_lockf_nonblocking_variant.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "lock/file"
+require "tempfile"
+file = Tempfile.new("lockf-ffi").tap(&:unlink)
+Lock::File::FFI.lockf(file, Lock::File::F_TLOCK, 0)
+print "Lock acquired", "\n"
+Lock::File::FFI.lockf(file, Lock::File::F_ULOCK, 0)
+print "Lock released", "\n"
+file.close
+
+##
+# Lock acquired
+# Lock released

data/test/lock_file_test.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 require_relative "setup"
-class LockFile::Test < Test::Unit::TestCase
+
+class Lock::File::Test < Test::Unit::TestCase
   attr_reader :file
   attr_reader :lockf
 
   def setup
     @file = Tempfile.new("lockf-test").tap(&:unlink)
-    @lockf = LockFile.new(file)
+    @lockf = Lock::File.new(file)
   end
 
   def teardown
@@ -15,7 +18,7 @@ class LockFile::Test < Test::Unit::TestCase
   ##
   # LockFile#lock
   def test_lock
-    assert_equal 0, lockf.lock
+    assert_equal true, lockf.lock
   ensure
     lockf.release
   end
@@ -32,7 +35,7 @@ class LockFile::Test < Test::Unit::TestCase
   ##
   # LockFile#lock_nonblock
   def test_lock_nonblock
-    assert_equal 0, lockf.lock_nonblock
+    assert_equal true, lockf.lock_nonblock
   ensure
     lockf.release
   end
@@ -60,9 +63,9 @@ class LockFile::Test < Test::Unit::TestCase
   ##
   # LockFile.temporary_file
   def test_temporary_file
-    lockf = LockFile.temporary_file
-    assert_equal 0, lockf.lock
-    assert_equal 0, lockf.release
+    lockf = Lock::File.temporary_file
+    assert_equal true, lockf.lock
+    assert_equal true, lockf.release
   ensure
     lockf.file.close
   end

data/test/readme_test.rb

@@ -3,38 +3,40 @@
 require_relative "setup"
 require "test/cmd"
 
-class LockFile::ReadmeTest < Test::Unit::TestCase
+class Lock::File::ReadmeTest < Test::Unit::TestCase
   def test_lockfile_blocking_variant
-    r = 'Lock acquired by parent process \(.+\)\s*' \
-    'Child process waiting on lock \(.+\)\s*' \
-    'Lock acquired by child process \(.+\)\s*'
-    assert_match Regexp.new(r),
-                 readme_example("1_lockfile_blocking_variant.rb").stdout
+    r = ruby(readme_example("1_lock_file_blocking_variant.rb"))
+    ["Lock acquired by parent process (.+)\n",
+     "Child process waiting on lock (.+)\n",
+     "Lock acquired by child process (.+)\n"
+    ].each { assert_match Regexp.new(_1), r.stdout }
   end
 
   def test_lockfile_nonblocking_variant
-    r = 'Lock acquired by parent process \(.+\)\s*' \
-    '(Lock would block\s*){3,4}' \
-    'Lock acquired by child process \(.+\)\s*'
-    assert_match Regexp.new(r),
-                 readme_example("2_lockfile_nonblocking_variant.rb").stdout
+    r = ruby(readme_example("2_lock_file_nonblocking_variant.rb"))
+    ["Lock acquired by parent process (.+)\n",
+     "(Lock would block\n){3,4}",
+     "Lock acquired by child process (.+)\n"
+    ].each { assert_match Regexp.new(_1), r.stdout }
   end
 
   def test_ffi_lockf_blocking_variant
     assert_equal "Lock acquired\nLock released\n",
-                 readme_example("3_ffilockf_blocking_variant.rb").stdout
+                 ruby(readme_example("3_ffi_lockf_blocking_variant.rb")).stdout
   end
 
   def test_ffi_lockf_nonblocking_variant
     assert_equal "Lock acquired\nLock released\n",
-                 readme_example("4_ffilockf_nonblocking_variant.rb").stdout
+                 ruby(readme_example("4_ffi_lockf_nonblocking_variant.rb")).stdout
   end
 
   private
 
-  def readme_example(path)
-    examples_dir = File.join(Dir.getwd, "share", "lockf.rb", "examples")
-    example = File.join(examples_dir, path)
-    cmd "bundle exec ruby #{example}"
+  def ruby(*argv)
+    cmd("ruby", *argv)
+  end
+
+  def readme_example(example_name)
+    File.join(__dir__, "..", "share", "lockf.rb", "examples", example_name)
   end
 end

data/test/setup.rb

@@ -1,4 +1,4 @@
 require "bundler/setup"
 require "test/unit"
-require "lockf"
+require "lock/file"
 require "tempfile"

metadata

@@ -1,128 +1,128 @@
 --- !ruby/object:Gem::Specification
 name: lockf.rb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-30 00:00:00.000000000 Z
+date: 2024-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: fiddle
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
+        version: '1.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.29'
+        version: '1.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.29'
+        version: '1.39'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '1.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '1.29'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: test-cmd.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.12'
 description: Ruby bindings for lockf(3)
 email:
 - 0x1eef@protonmail.com
 executables: []
-extensions:
-- ext/lockf.rb/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
 - ".bundle/config"
-- ".clang-format"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".projectile"
 - ".rubocop.yml"
-- ".uncrustify.cfg"
 - ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile.rb
-- ext/lockf.rb/extconf.rb
-- ext/lockf.rb/lockf.c
+- bin/test-runner
+- lib/lock/file.rb
+- lib/lock/file/constants.rb
+- lib/lock/file/ffi.rb
+- lib/lock/file/version.rb
 - lib/lockf.rb
-- lib/lockf/version.rb
+- lib/lockfile.rb
 - lockf.rb.gemspec
-- share/lockf.rb/examples/1_lockfile_blocking_variant.rb
-- share/lockf.rb/examples/2_lockfile_nonblocking_variant.rb
-- share/lockf.rb/examples/3_ffilockf_blocking_variant.rb
-- share/lockf.rb/examples/4_ffilockf_nonblocking_variant.rb
+- share/lockf.rb/examples/1_lock_file_blocking_variant.rb
+- share/lockf.rb/examples/2_lock_file_nonblocking_variant.rb
+- share/lockf.rb/examples/3_ffi_lockf_blocking_variant.rb
+- share/lockf.rb/examples/4_ffi_lockf_nonblocking_variant.rb
 - test/lock_file_test.rb
 - test/readme_test.rb
 - test/setup.rb
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Ruby bindings for lockf(3)

data/.clang-format

@@ -1,11 +0,0 @@
-BasedOnStyle: LLVM
-IndentWidth: 2
-SortIncludes: false
-UseTab: Never
-BreakBeforeBraces: Allman
-AllowShortFunctionsOnASingleLine: Inline
-AlwaysBreakAfterDefinitionReturnType: TopLevel
-BreakBeforeBinaryOperators: All
-BinPackArguments: false
-AlignConsecutiveAssignments: true
-AlwaysBreakAfterReturnType: None

data/.uncrustify.cfg

@@ -1,2 +0,0 @@
-indent_with_tabs = 0
-indent_columns = 4

data/ext/lockf.rb/extconf.rb

@@ -1,12 +0,0 @@
-require "mkmf"
-
-[
-  "INSTALL_DATA", "INSTALL_SCRIPT",
-  "INSTALL_PROGRAM", "INSTALL_DATA",
-  "INSTALL"
-].each do
-  CONFIG[_1].sub!(/-o [a-zA-Z0-9]+/, "")
-  CONFIG[_1].sub!(/-g [a-zA-Z0-9]+/, "")
-end
-
-create_makefile "lockf.rb"

data/ext/lockf.rb/lockf.c

@@ -1,36 +0,0 @@
-#include <ruby.h>
-#include <unistd.h>
-#include <errno.h>
-
-static VALUE
-lockf_lock(VALUE self, VALUE fd, VALUE cmd, VALUE len)
-{
-  int result;
-
-  Check_Type(fd, T_FIXNUM);
-  Check_Type(cmd, T_FIXNUM);
-  Check_Type(len, T_FIXNUM);
-  errno  = 0;
-  result = lockf(NUM2INT(fd), NUM2INT(cmd), NUM2INT(len));
-  if (result == 0)
-  {
-    return INT2NUM(result);
-  }
-  else
-  {
-    rb_syserr_fail(errno, "lockf");
-  }
-}
-
-void
-Init_lockf(void)
-{
-  VALUE cLockf;
-
-  cLockf = rb_define_class("LockFile", rb_cObject);
-  rb_define_const(cLockf, "F_LOCK", INT2NUM(F_LOCK));
-  rb_define_const(cLockf, "F_TLOCK", INT2NUM(F_TLOCK));
-  rb_define_const(cLockf, "F_ULOCK", INT2NUM(F_ULOCK));
-  rb_define_const(cLockf, "F_TEST", INT2NUM(F_TEST));
-  rb_define_singleton_method(cLockf, "lockf", lockf_lock, 3);
-}

data/lib/lockf/version.rb

@@ -1,3 +0,0 @@
-class LockFile
-  VERSION = "1.0.0"
-end

data/share/lockf.rb/examples/3_ffilockf_blocking_variant.rb

@@ -1,13 +0,0 @@
-require "lockf"
-require "tempfile"
-
-file = Tempfile.new("lockf-ffi").tap(&:unlink)
-LockFile.lockf(file.fileno, LockFile::F_LOCK, 0)
-print "Lock acquired", "\n"
-LockFile.lockf(file.fileno, LockFile::F_ULOCK, 0)
-print "Lock released", "\n"
-file.close
-
-##
-# Lock acquired
-# Lock released

data/share/lockf.rb/examples/4_ffilockf_nonblocking_variant.rb

@@ -1,13 +0,0 @@
-require "lockf"
-require "tempfile"
-
-file = Tempfile.new("lockf-ffi").tap(&:unlink)
-LockFile.lockf(file.fileno, LockFile::F_TLOCK, 0)
-print "Lock acquired", "\n"
-LockFile.lockf(file.fileno, LockFile::F_ULOCK, 0)
-print "Lock released", "\n"
-file.close
-
-##
-# Lock acquired
-# Lock released