futex 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8cbb61dfb861233a3f0883cd1ce83858bbbad9ec2b71f17f286edbbe2d0c57b
-  data.tar.gz: 6ef08599e9100ae73d0706270ce3c7aa6cb1b58f9c64ceb9f54026f07ac547f1
+  metadata.gz: 53e0b207143da0366545baa93f2801b8e79a5947682954191b9817e8d3c6fc9b
+  data.tar.gz: 5dac5eaab880bf15c6da9e7300fe2b7722d16c8e6c308cabe96372e8db32cce5
 SHA512:
-  metadata.gz: bc33d6417050639fd839530b820de078406b112d8d6ffc914c9956ce6b84b511be82678a2b438f9b9fa13311487a3033d6ac3e0efbe6262836b3c2c06443824d
-  data.tar.gz: 383ced7c5df759d14d494a183562771cc0cf3904b33bc9152c0870cea24e2683d966b660e11751a01aa32ab0137f538aaef7bc2eac9a53fa94149e46aa06dc84
+  metadata.gz: ec18ba0e63dd2584f9294e1b60d37a1c338029b6d1fba0f88c4e4ba1dd0a920442522b81ba307688340413038c5e01d2bc007a9360999b82d6fe8a1830df45ba
+  data.tar.gz: c1b855e96480add275103776b65e0bad32853292f5c1ee7cb21bb7c5be9b1c220f927b8e7ebb12d499922e296fd5baae87703cb97c37e5c27499bfadb377bcc4

data/.rubocop.yml

@@ -12,5 +12,7 @@ Metrics/CyclomaticComplexity:
   Max: 10
 Metrics/PerceivedComplexity:
   Max: 10
+Metrics/ParameterLists:
+  Max: 10
 Layout/AlignParameters:
   Enabled: false

data/README.md

@@ -34,12 +34,16 @@ constructor of the `Futex` class, including:
   * `log`: an object that implements `debug()` method, which will
     receive supplementary messages from the locking mechanism;
 
+  * `logging`: set it to `false` if you don't want to see any logs;
+
   * `timeout`: the number of seconds to wait for the lock availability
     (an exception is raised when the wait is expired);
 
   * `sleep`: the number of seconds to wait between attempts to acquire
     the lock file (the smaller the number, the more reactive is the software,
-    but the higher the load for the file system and the CPU).
+    but the higher the load for the file system and the CPU);
+
+  * `lock`: the absolute path of the lock file;
 
 That's it.
 

data/futex.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.3.3'
   s.required_ruby_version = '>=2.3'
   s.name = 'futex'
-  s.version = '0.1.0'
+  s.version = '0.2.0'
   s.license = 'MIT'
   s.summary = 'File-based mutex'
   s.description = 'Ruby Gem for file-based locking'

data/lib/futex.rb

@@ -31,11 +31,13 @@ require 'time'
 # License:: MIT
 class Futex
   def initialize(path, log: STDOUT, timeout: 16, sleep: 0.005,
-    lock: path + '.lock')
+    lock: path + '.lock', logging: true)
     raise "File path can't be nil" if path.nil?
     @path = path
     raise "Log can't be nil" if log.nil?
     @log = log
+    raise "Logging can't be nil" if logging.nil?
+    @logging = logging
     raise "Timeout can't be nil" if timeout.nil?
     raise "Timeout must be positive: #{timeout}" unless timeout.positive?
     @timeout = timeout
@@ -75,7 +77,7 @@ exclusive access to #{@path}, #{age(start)} already: #{IO.read(@lock)}")
     acq = Time.now
     res = yield(@path)
     FileUtils.rm(@lock)
-    puts("Unlocked by \"#{Thread.current.name}\" in #{age(acq)}: #{@path}")
+    debug("Unlocked by \"#{Thread.current.name}\" in #{age(acq)}: #{@path}")
     res
   end
 
@@ -86,6 +88,7 @@ exclusive access to #{@path}, #{age(start)} already: #{IO.read(@lock)}")
   end
 
   def debug(msg)
+    return unless @logging
     if @log.respond_to?(:debug)
       @log.debug(msg)
     elsif @log.respond_to?(:puts)

data/test/test_futex.rb

@@ -36,7 +36,7 @@ class FutexTest < Minitest::Test
     Dir.mktmpdir do |dir|
       path = File.join(dir, 'a/b/c/file.txt')
       Threads.new(5).assert(100) do |_, r|
-        Futex.new(path).open do |f|
+        Futex.new(path, logging: false).open do |f|
           text = "op no.#{r}"
           IO.write(f, text)
           assert_equal(text, IO.read(f))
@@ -48,11 +48,11 @@ class FutexTest < Minitest::Test
   def test_syncs_access_to_file_in_slow_motion
     Dir.mktmpdir do |dir|
       path = File.join(dir, 'a/b/c/file.txt')
-      Threads.new(2).assert(4) do |_, r|
-        Futex.new(path).open do |f|
+      Threads.new(5).assert(50) do |_, r|
+        Futex.new(path, logging: false).open do |f|
           text = "op no.#{r}"
           IO.write(f, text)
-          sleep 0.2
+          sleep 0.01
           assert_equal(text, IO.read(f))
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: futex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yegor Bugayenko