lockf.rb 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a49042a4d79251c0a85dbe626fefaa323862ea30a45426012a1d8bab08f63fb
-  data.tar.gz: 57f2c700f963a299ce4502e3a7856cc75283ceb80d1c27864ea08438950047d5
+  metadata.gz: b0f68d54d3ad30fc3c9c6316910adebcd74645876546aec01c86402261275ff6
+  data.tar.gz: ed9cbe6b94840dd3987d16825737b3e98c42efb4904f15fd2ef206ebd0ab431a
 SHA512:
-  metadata.gz: 7d5c94dbaa6ad0b2eff1fe114e902d7c49014f2bb0ce69b2c5512ae0d107274d7c3c8b6a2d688672faeb85c7b48510689952efd9c64dc4cc78616e3e566f2e8e
-  data.tar.gz: 27c55d59bbab2f8e76b5370b010b3541d65a346b88279361e7f64110b3e6a1fe3f1ddaf4677fbefcec7f2e6409d70483937298f47cda1e3d729c209122d821df
+  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/Rakefile.rb

@@ -1,12 +1,20 @@
 require "bundler/setup"
 
 namespace :format do
-  desc "Run rubocop"
-  task :ruby do
+  desc "Apply rubocop fixes"
+  task :apply do
     sh "bundle exec rubocop -A"
   end
+
+  desc "Run rubocop"
+  task :check do
+    sh "bundle exec rubocop"
+  end
 end
-task format: %w[format:ruby]
+task format: %w[format:apply]
+
+desc "Run CI tasks"
+task ci: %i[format:check test]
 
 desc "Run tests"
 task :test do

data/lib/lock/file/ffi.rb

@@ -27,10 +27,18 @@ class Lock::File
        .zero? || raise(SystemCallError.new("lockf", Fiddle.last_error))
     end
 
-    private
-
+    ##
+    # @return [Fiddle::Handle]
     def libc
-      @libc ||= Fiddle.dlopen Dir["/lib/libc.*"].first
+      @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

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

data/lib/lock/file.rb

@@ -6,7 +6,6 @@ end unless defined?(Lock)
 # [lockf(3)](https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3)
 # interface
 class Lock::File
-  require "tmpdir"
   require_relative "file/version"
   require_relative "file/ffi"
   require_relative "file/constants"
@@ -15,23 +14,19 @@ class Lock::File
   include Constants
 
   ##
+  # Accepts the same parameters as Tempfile.new
+  #
   # @example
   #  lockf = Lock::File.temporary_file
   #  lockf.lock
   #  # ...
   #
-  # @param [String] basename
-  # @param [String] tmpdir
   # @return [Lock::File]
   #  Returns a {Lock::File Lock::File} for a random,
   #  unlinked temporary file
-  def self.from_temporary_file(basename: "lockf", tmpdir: Dir.tmpdir)
+  def self.temporary_file(...)
     require "tempfile" unless defined?(Tempfile)
-    file = Tempfile.new(basename, tmpdir:).tap(&:unlink)
-    Lock::File.new(file)
-  end
-  class << self
-    alias_method :temporary_file, :from_temporary_file
+    Lock::File.new Tempfile.new(...).tap(&:unlink)
   end
 
   ##
@@ -62,7 +57,7 @@ class Lock::File
     lockf(@file, F_LOCK, @size)
   rescue Errno::EINTR => ex
     tries += 1
-    tries == 3 ? raise(ex) : retry
+    (tries == 3) ? raise(ex) : retry
   end
 
   ##

data/lockf.rb.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
 
   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 "test-cmd.rb", "~> 0.12"

data/test/lock_file_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "setup"
 
 class Lock::File::Test < Test::Unit::TestCase

data/test/readme_test.rb

@@ -5,29 +5,29 @@ require "test/cmd"
 
 class Lock::File::ReadmeTest < Test::Unit::TestCase
   def test_lockfile_blocking_variant
-    r = ruby(readme_example("1_lockfile_blocking_variant.rb"))
-    ["Lock acquired by parent process \(.+\)\n",
-     "Child process waiting on lock \(.+\)\n",
-     "Lock acquired by child process \(.+\)\n"
+    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 = ruby(readme_example("2_lockfile_nonblocking_variant.rb"))
-    ["Lock acquired by parent process \(.+\)\n",
+    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"
+     "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",
-                 ruby(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",
-                 ruby(readme_example("4_ffilockf_nonblocking_variant.rb")).stdout
+                 ruby(readme_example("4_ffi_lockf_nonblocking_variant.rb")).stdout
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockf.rb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiddle
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.39'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -102,12 +102,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".bundle/config"
-- ".clang-format"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".projectile"
 - ".rubocop.yml"
-- ".uncrustify.cfg"
 - ".yardopts"
 - Gemfile
 - LICENSE
@@ -121,10 +119,10 @@ files:
 - lib/lockf.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

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