lockf.rb 0.12.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc7a6787621983c5bcea9dc35a899eb064d8d09f20d905b90b8391e8fc018f64
-  data.tar.gz: e32dcc7d52786b2c1c2acdb652264b450506debd976583a2ff8f46a367b2efe9
+  metadata.gz: 05e204191db7552902307b79f09636be97f36fba053a89c5ab849c6dd0205830
+  data.tar.gz: 82167b478eae279325094a0ba29b8d75500dc6d0a53ea32fd24ed0ef200fa643
 SHA512:
-  metadata.gz: b275ee5e97c06f6dfcfbf32074139b1514b3fe4795ab1669bdbb188336f0039aee368846146b6e4b6ef15fc41d0077816844cfcf772e52039584b5816d5e8cbb
-  data.tar.gz: ffab08187b049fd42ad5549e060c0ba5da31228212c1e5419c3c9640a8842c96617a20cd54ee6f14edc265a5b28ddf50bc00e8dc343493fce0ec6a96a388a3cb
+  metadata.gz: 31b69f15f99e3a4b6f522de3b708130ee67ab3a3c5498df989e034bf281f0c02463f360d948150ca9cd562e85a9fd4a8d802d27dad6fa014e289abaa33c6f5d6
+  data.tar.gz: 8b9d9b5979cf813a0234054531e0fe4e6d7c7be83221f49540aeaec97d94347db851756fece830b4f711da42683d4195589f7d3578264a232d6aedd37d7d0377

data/.clang-format

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

data/.rubocop.yml

@@ -18,4 +18,8 @@ Layout/ArgumentAlignment:
 ##
 # Options for all cops.
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
+  Include:
+    - lib/*.rb
+    - lib/**/*.rb
+    - test/*.rb

data/Gemfile

@@ -1,3 +1,2 @@
 source "https://rubygems.org"
 gemspec
-gem "test-cmd.rb", github: "0x1eef/test-cmd.rb", tag: "v0.4.0"

data/README.md

@@ -1,21 +1,12 @@
 ## About
 
-lockf.rb is a C extension that provides a Ruby interface to
+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.
 
-[lockf(3)](https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3)
-can be used to synchronize access to a file between multiple
-processes, or be used more generally to synchronize access to a shared
-resource being accessed by multiple processes at the same time. When used
-generally,
-[lockf(3)](https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3)
-can provide something similar to a mutex that works across multiple
-processes rather than multiple threads.
-
 ## Examples
 
 ### LockFile
@@ -44,7 +35,7 @@ end
 sleep(3)
 lockf.release
 Process.wait(pid)
-lockf.file.close
+lockf.close
 
 ##
 # Lock acquired by parent process (2023-02-11 16:43:15 UTC)
@@ -76,7 +67,7 @@ end
 sleep 3
 lockf.release
 Process.wait(pid)
-lockf.file.close
+lockf.close
 
 ##
 # Lock acquired by parent process (2023-02-11 19:03:05 UTC)
@@ -131,32 +122,24 @@ file.close
 # Lock released
 ```
 
-## Sources
+## Documentation
 
-* [Source code (GitHub)](https://github.com/0x1eef/lockf.rb#readme)
-* [Source code (GitLab)](https://gitlab.com/0x1eef/lockf.rb#about)
+A complete API reference is available at 
+[0x1eef.github.io/x/lockf.rb](https://0x1eef.github.io/x/lockf.rb).
 
 ## Install
 
-**Git**
-
-lockf.rb is distributed as a RubyGem through its git repositories. <br>
-[GitHub](https://github.com/0x1eef/lockf.rb),
-and
-[GitLab](https://gitlab.com/0x1eef/lockf.rb)
-are available as sources.
-
-``` ruby
-# Gemfile
-gem "lock.fb", github: "0x1eef/lockf.rb", tag: "v0.12.0"
-```
-
 **Rubygems.org**
 
-lock.rb can also be installed via rubygems.org.
+lockf.rb can be installed via rubygems.org.
 
     gem install lockf.rb
 
+## Sources
+
+* [GitHub](https://github.com/0x1eef/lockf.rb#readme)
+* [GitLab](https://gitlab.com/0x1eef/lockf.rb#about)
+
 ## License
 
 [BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).

data/Rakefile.rb

@@ -1,21 +1,23 @@
+require "bundler/setup"
 require "rake/extensiontask"
 require "rake/testtask"
 
-namespace :linters do
-  desc "Run the C linter"
-  task :c do
-    sh "uncrustify -c .uncrustify.cfg --no-backup --replace ext/lockf.rb/*.c"
+namespace :clang do
+  desc "Run clang-format"
+  task :format do
+    sh "clang-format -style=file:.clang-format -i ext/lockf.rb/*.c"
   end
+end
 
-  desc "Run the Ruby linter"
-  task :ruby do
-    sh "bundle exec rubocop -A Rakefile.rb lib/**/*.rb spec/**/*.rb"
+namespace :ruby do
+  desc "Run rubocop"
+  task :format do
+    sh "bundle exec rubocop -A"
   end
 end
-task lint: ["linters:c", "linters:ruby"]
+task format: %w[clang:format ruby:format]
 
 Rake::ExtensionTask.new("lockf.rb")
-
 Rake::TestTask.new do |t|
   t.test_files = FileList["test/*_test.rb"]
   t.verbose = true

data/ext/lockf.rb/lockf.c

@@ -1,7 +1,6 @@
 #include <ruby.h>
 #include <unistd.h>
 #include <errno.h>
-#include "lockf.h"
 
 static VALUE
 lockf_lock(VALUE self, VALUE fd, VALUE cmd, VALUE len)
@@ -11,26 +10,27 @@ lockf_lock(VALUE self, VALUE fd, VALUE cmd, VALUE len)
   Check_Type(fd, T_FIXNUM);
   Check_Type(cmd, T_FIXNUM);
   Check_Type(len, T_FIXNUM);
-  errno = 0;
+  errno  = 0;
   result = lockf(NUM2INT(fd), NUM2INT(cmd), NUM2INT(len));
-  if (result == -1) {
-    rb_syserr_fail(errno, "lockf");
-  } else {
+  if (result == 0)
+  {
     return INT2NUM(result);
   }
+  else
+  {
+    rb_syserr_fail(errno, "lockf");
+  }
 }
 
 void
 Init_lockf(void)
 {
-  VALUE cLockf, mFcntl;
+  VALUE cLockf;
 
-  rb_require("fcntl");
   cLockf = rb_define_class("LockFile", rb_cObject);
-  mFcntl = rb_const_get(rb_cObject, rb_intern("Fcntl"));
-  rb_define_const(mFcntl, "F_LOCK", INT2NUM(F_LOCK));
-  rb_define_const(mFcntl, "F_TLOCK", INT2NUM(F_TLOCK));
-  rb_define_const(mFcntl, "F_ULOCK", INT2NUM(F_ULOCK));
-  rb_define_const(mFcntl, "F_TEST", INT2NUM(F_TEST));
+  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 +1,3 @@
 class LockFile
-  VERSION = "0.12.0"
+  VERSION = "1.0.0"
 end

data/lib/lockf.rb

@@ -1,12 +1,11 @@
 ##
 # The
-# [`LockFile`](https://0x1eef.github.io/x/lockf.rb/LockFile.html)
-# class provides a Ruby-oriented interface to the C function
+# [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"
-  include Fcntl
 
   ##
   # @!method self.lockf(fd, cmd, len)
@@ -80,7 +79,8 @@ class LockFile
   end
 
   ##
-  # Acquire a lock (blocking)
+  # Acquire a lock (blocking).
+  #
   # @raise [Errno::EBADF]
   # @raise [Errno::EDEADLK]
   # @raise [Errno::EINTR]
@@ -95,7 +95,8 @@ class LockFile
   end
 
   ##
-  # Acquire a lock (non-blocking)
+  # Acquire a lock (non-blocking).
+  #
   # @raise [Errno::EAGAIN]
   # @raise [Errno::EBADF]
   # @raise [Errno::ENOLCK]
@@ -106,7 +107,8 @@ class LockFile
   end
 
   ##
-  # Release a lock
+  # Release a lock.
+  #
   # @raise [Errno::EBADF]
   # @raise [Errno::ENOLCK]
   # @return [Integer]

data/lockf.rb.gemspec

@@ -10,15 +10,12 @@ Gem::Specification.new do |gem|
   gem.files = `git ls-files`.split($/)
   gem.require_paths = ["lib"]
   gem.extensions = %w[ext/lockf.rb/extconf.rb]
-  gem.summary = "A Ruby interface for lockf(3)"
+  gem.summary = "Ruby bindings for lockf(3)"
   gem.description = gem.summary
   gem.add_development_dependency "yard", "~> 0.9"
-  gem.add_development_dependency "redcarpet", "~> 3.5"
-  gem.add_development_dependency "standard", "= 1.12.1"
-  gem.add_development_dependency "rubocop", "= 1.29.1"
-  gem.add_development_dependency "test-unit", "~> 3.5.7"
-  gem.add_development_dependency "rake-compiler", "= 1.2.0"
-  gem.add_development_dependency "rack", "~> 3.0"
-  gem.add_development_dependency "rackup", "~> 2.1"
-  gem.add_development_dependency "test-cmd.rb", "~> 0.4"
+  gem.add_development_dependency "standard", "~> 1.12"
+  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"
 end

data/share/lockf.rb/examples/1_lockfile_blocking_variant.rb

@@ -11,7 +11,7 @@ end
 sleep(3)
 lockf.release
 Process.wait(pid)
-lockf.file.close
+lockf.close
 
 ##
 # Lock acquired by parent process (2023-02-11 16:43:15 UTC)

data/share/lockf.rb/examples/2_lockfile_nonblocking_variant.rb

@@ -14,7 +14,7 @@ end
 sleep 3
 lockf.release
 Process.wait(pid)
-lockf.file.close
+lockf.close
 
 ##
 # Lock acquired by parent process (2023-02-11 19:03:05 UTC)

data/test/lock_file_test.rb

@@ -1,10 +1,10 @@
 require_relative "setup"
 class LockFile::Test < Test::Unit::TestCase
-  include Timeout
-  include FileUtils
+  attr_reader :file
   attr_reader :lockf
 
   def setup
+    @file = Tempfile.new("lockf-test").tap(&:unlink)
     @lockf = LockFile.new(file)
   end
 
@@ -13,7 +13,7 @@ class LockFile::Test < Test::Unit::TestCase
   end
 
   ##
-  # Lock::File#lock tests
+  # LockFile#lock
   def test_lock
     assert_equal 0, lockf.lock
   ensure
@@ -21,19 +21,16 @@ class LockFile::Test < Test::Unit::TestCase
   end
 
   def test_lock_in_fork
-    Process.wait fork {
-      lockf.lock
-      Process.kill("SIGINT", Process.ppid)
-      sleep(1)
-    }
-  rescue Interrupt
-    assert_raises(Timeout::Error) { timeout(0.5) { lockf.lock } }
+    pid = fork_sleep { lockf.lock }
+    sleep(0.1)
+    assert_raises(Errno::EWOULDBLOCK) { lockf.lock_nonblock }
   ensure
+    Process.kill("KILL", pid)
     lockf.release
   end
 
   ##
-  # Lock::File#lock_nonblock tests
+  # LockFile#lock_nonblock
   def test_lock_nonblock
     assert_equal 0, lockf.lock_nonblock
   ensure
@@ -41,52 +38,41 @@ class LockFile::Test < Test::Unit::TestCase
   end
 
   def test_lock_nonblock_in_fork
-    Process.wait fork {
-      lockf.lock_nonblock
-      Process.kill("SIGINT", Process.ppid)
-      sleep(1)
-    }
-  rescue Interrupt
-    assert_raises(Errno::EAGAIN) { lockf.lock_nonblock }
+    pid = fork_sleep { lockf.lock_nonblock }
+    sleep(0.1)
+    assert_raises(Errno::EWOULDBLOCK) { lockf.lock_nonblock }
   ensure
+    Process.kill("KILL", pid)
     lockf.release
   end
 
   ##
-  # Lock::File#locked? tests
+  # LockFile#locked?
   def test_locked?
-    lockf.lock
-    Process.wait fork { lockf.locked? ? exit(0) : exit(1) }
-    assert_equal 0, $?.exitstatus
+    pid = fork_sleep { lockf.lock }
+    sleep(0.1)
+    assert_equal true, lockf.locked?
   ensure
+    Process.kill("KILL", pid)
     lockf.release
   end
 
   ##
-  # LockFile#initialize
-  def test_initialize_with_str_path
-    path = File.join(Dir.getwd, "test", "tmp.txt")
-    touch(path)
-    lockf = LockFile.new(path)
+  # LockFile.temporary_file
+  def test_temporary_file
+    lockf = LockFile.temporary_file
     assert_equal 0, lockf.lock
     assert_equal 0, lockf.release
   ensure
     lockf.file.close
-    rm(path)
-  end
-
-  ##
-  # LockFile.from_temporary_file
-  def test_from_temporary_file
-    lockf = LockFile.from_temporary_file
-    assert_equal 0, lockf.lock
-    assert_equal 0, lockf.release
-    lockf.file.close
   end
 
   private
 
-  def file
-    @file ||= Tempfile.new("lockf-test").tap(&:unlink)
+  def fork_sleep
+    fork do
+      yield
+      sleep
+    end
   end
 end

data/test/readme_test.rb

@@ -4,8 +4,6 @@ require_relative "setup"
 require "test/cmd"
 
 class LockFile::ReadmeTest < Test::Unit::TestCase
-  include Test::Cmd
-
   def test_lockfile_blocking_variant
     r = 'Lock acquired by parent process \(.+\)\s*' \
     'Child process waiting on lock \(.+\)\s*' \

data/test/setup.rb

@@ -1,6 +1,4 @@
 require "bundler/setup"
 require "test/unit"
 require "lockf"
-require "timeout"
-require "fileutils"
 require "tempfile"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockf.rb
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-06 00:00:00.000000000 Z
+date: 2024-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -25,118 +25,76 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.12.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.29.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.29.1
-- !ruby/object:Gem::Dependency
-  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.7
+        version: '1.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.7
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.29'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: rackup
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: test-cmd.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-description: A Ruby interface for lockf(3)
+        version: '0.6'
+description: Ruby bindings for lockf(3)
 email:
 - 0x1eef@protonmail.com
 executables: []
@@ -145,6 +103,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".bundle/config"
+- ".clang-format"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".projectile"
@@ -157,7 +116,6 @@ files:
 - Rakefile.rb
 - ext/lockf.rb/extconf.rb
 - ext/lockf.rb/lockf.c
-- ext/lockf.rb/lockf.h
 - lib/lockf.rb
 - lib/lockf/version.rb
 - lockf.rb.gemspec
@@ -190,5 +148,5 @@ requirements: []
 rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: A Ruby interface for lockf(3)
+summary: Ruby bindings for lockf(3)
 test_files: []

data/ext/lockf.rb/lockf.h

@@ -1 +0,0 @@
-void Init_lockf(void);