lockf.rb 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc7a6787621983c5bcea9dc35a899eb064d8d09f20d905b90b8391e8fc018f64
-  data.tar.gz: e32dcc7d52786b2c1c2acdb652264b450506debd976583a2ff8f46a367b2efe9
+  metadata.gz: 07acab1cbd6394d179fafd3fed888bdb56f7bc52868a8557a6b2114500a409ca
+  data.tar.gz: '0178e4e393991e7b3ab099ba2491aa7888fb30e1f096d785d4797f6bbb30a048'
 SHA512:
-  metadata.gz: b275ee5e97c06f6dfcfbf32074139b1514b3fe4795ab1669bdbb188336f0039aee368846146b6e4b6ef15fc41d0077816844cfcf772e52039584b5816d5e8cbb
-  data.tar.gz: ffab08187b049fd42ad5549e060c0ba5da31228212c1e5419c3c9640a8842c96617a20cd54ee6f14edc265a5b28ddf50bc00e8dc343493fce0ec6a96a388a3cb
+  metadata.gz: 80e87c4f223f90db7ffb518dcf969342125c546b8d3a839af8a36086caeca67a7155b90953c883dab3f598c5f17d5d827b8fe72c2e53b841b6260a789fc6deeb
+  data.tar.gz: ad79f9b41adb8ea5fd4a891eabd0f8488bfe5a5afd80a27ccacc81f2e06eae1bd7530fd74edb985f988aad559f59176ed61392e87829fb7d9e65395d23f99e7c

data/README.md

@@ -1,6 +1,6 @@
 ## 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)
@@ -8,10 +8,9 @@ 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,
+can synchronize access to a file between multiple processes, or 
+synchronize access to a shared resource being accessed by multiple 
+processes at the same time. When used with a shared resource,
 [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.
@@ -131,32 +130,19 @@ file.close
 # Lock released
 ```
 
-## Sources
-
-* [Source code (GitHub)](https://github.com/0x1eef/lockf.rb#readme)
-* [Source code (GitLab)](https://gitlab.com/0x1eef/lockf.rb#about)
-
 ## 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,3 +1,4 @@
+require "bundler/setup"
 require "rake/extensiontask"
 require "rake/testtask"
 

data/ext/lockf.rb/lockf.c

@@ -13,24 +13,22 @@ lockf_lock(VALUE self, VALUE fd, VALUE cmd, VALUE len)
   Check_Type(len, T_FIXNUM);
   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 = "0.13.0"
 end

data/lib/lockf.rb

@@ -6,7 +6,6 @@
 class LockFile
   require "tmpdir"
   require_relative "lockf.rb.so"
-  include Fcntl
 
   ##
   # @!method self.lockf(fd, cmd, len)

data/lockf.rb.gemspec

@@ -10,7 +10,7 @@ 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"

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
+  # Lock::File#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
+  # Lock::File#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
+  # Lock::File#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/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: 0.13.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-06 00:00:00.000000000 Z
+date: 2024-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-description: A Ruby interface for lockf(3)
+description: Ruby bindings for lockf(3)
 email:
 - 0x1eef@protonmail.com
 executables: []
@@ -190,5 +190,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: []