lockf.rb 0.13.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07acab1cbd6394d179fafd3fed888bdb56f7bc52868a8557a6b2114500a409ca
-  data.tar.gz: '0178e4e393991e7b3ab099ba2491aa7888fb30e1f096d785d4797f6bbb30a048'
+  metadata.gz: 05e204191db7552902307b79f09636be97f36fba053a89c5ab849c6dd0205830
+  data.tar.gz: 82167b478eae279325094a0ba29b8d75500dc6d0a53ea32fd24ed0ef200fa643
 SHA512:
-  metadata.gz: 80e87c4f223f90db7ffb518dcf969342125c546b8d3a839af8a36086caeca67a7155b90953c883dab3f598c5f17d5d827b8fe72c2e53b841b6260a789fc6deeb
-  data.tar.gz: ad79f9b41adb8ea5fd4a891eabd0f8488bfe5a5afd80a27ccacc81f2e06eae1bd7530fd74edb985f988aad559f59176ed61392e87829fb7d9e65395d23f99e7c
+  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

@@ -7,14 +7,6 @@ The
 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 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.
-
 ## Examples
 
 ### LockFile
@@ -43,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)
@@ -75,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)
@@ -130,6 +122,11 @@ file.close
 # Lock released
 ```
 
+## Documentation
+
+A complete API reference is available at 
+[0x1eef.github.io/x/lockf.rb](https://0x1eef.github.io/x/lockf.rb).
+
 ## Install
 
 **Rubygems.org**

data/Rakefile.rb

@@ -2,21 +2,22 @@ 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,11 +10,14 @@ 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 == 0) {
+  if (result == 0)
+  {
     return INT2NUM(result);
-  } else {
+  }
+  else
+  {
     rb_syserr_fail(errno, "lockf");
   }
 }

data/lib/lockf/version.rb

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

data/lib/lockf.rb

@@ -1,7 +1,7 @@
 ##
 # 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"
@@ -79,7 +79,8 @@ class LockFile
   end
 
   ##
-  # Acquire a lock (blocking)
+  # Acquire a lock (blocking).
+  #
   # @raise [Errno::EBADF]
   # @raise [Errno::EDEADLK]
   # @raise [Errno::EINTR]
@@ -94,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]
@@ -105,7 +107,8 @@ class LockFile
   end
 
   ##
-  # Release a lock
+  # Release a lock.
+  #
   # @raise [Errno::EBADF]
   # @raise [Errno::ENOLCK]
   # @return [Integer]

data/lockf.rb.gemspec

@@ -13,12 +13,9 @@ Gem::Specification.new do |gem|
   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

@@ -4,7 +4,7 @@ class LockFile::Test < Test::Unit::TestCase
   attr_reader :lockf
 
   def setup
-    @file  = Tempfile.new("lockf-test").tap(&:unlink)
+    @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
+  # LockFile#lock
   def test_lock
     assert_equal 0, lockf.lock
   ensure
@@ -30,7 +30,7 @@ class LockFile::Test < Test::Unit::TestCase
   end
 
   ##
-  # Lock::File#lock_nonblock
+  # LockFile#lock_nonblock
   def test_lock_nonblock
     assert_equal 0, lockf.lock_nonblock
   ensure
@@ -47,7 +47,7 @@ class LockFile::Test < Test::Unit::TestCase
   end
 
   ##
-  # Lock::File#locked?
+  # LockFile#locked?
   def test_locked?
     pid = fork_sleep { lockf.lock }
     sleep(0.1)

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*' \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockf.rb
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 1.0.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 2024-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -25,117 +25,75 @@ 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'
+        version: '0.6'
 description: Ruby bindings for lockf(3)
 email:
 - 0x1eef@protonmail.com
@@ -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

data/ext/lockf.rb/lockf.h

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