futex 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8a8d71051dbbfbccbf315a3ff9db4a8412d254a6f2076a759c5cc0ed27f1e34
-  data.tar.gz: 6f89829eb5326e4152c8422e8d5057c4c54c9e74cab0593c959d52aa2ef76b1f
+  metadata.gz: 8a40f777d578131870588931a9f18fde1960ba7a5219b5b5cd50dd97a7b9fc07
+  data.tar.gz: 0bf2196fca978a7a75b63faccd92ca4115510fcedf24c639a2d1c1251bf420b4
 SHA512:
-  metadata.gz: 379a44ca71ef3e5e76f92a89ee5a702177c4561e3c251a973caed8958182656bca60b469d46642f0cd753a9047b9daf96b43e759705f06af737141a97948011a
-  data.tar.gz: e50ddd647eb79bd744a5f382be7600cff51779d6392feb699cc308bf59c1a67779a04675bf863f8d5bd70ded46835c9bfdc8300a95ba21e53c6c2c35176ac09f
+  metadata.gz: 49791caf45a0b5c250aee714870bd6315c359b6c5e32e93a69663d15490ec0d56b9ede3d0726e1fd90c5f8231b46bd29a3accc8a2bd6d4407834e8498174543c
+  data.tar.gz: 85296003d7fb88544f1365ca1b9f026ece2fc1eebf2f532bf82fe7a947f14f92b1d45054fff516cf1eabc2f800817c60b949773cdb686abee58d06cae8202f2a

data/.gitignore

@@ -3,3 +3,4 @@ Gemfile.lock
 .bundle/
 .DS_Store
 rdoc/
+.idea/

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.8.1'
+  s.version = '0.8.2'
   s.license = 'MIT'
   s.summary = 'File-based mutex'
   s.description = 'Ruby Gem for file-based locking'
@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md']
   s.add_development_dependency 'minitest', '5.11.3'
+  s.add_development_dependency 'openssl', '2.1.2'
   s.add_development_dependency 'rake', '12.3.1'
   s.add_development_dependency 'rdoc', '4.3.0'
   s.add_development_dependency 'rubocop', '0.60.0'

data/lib/futex.rb

@@ -24,6 +24,8 @@
 
 require 'fileutils'
 require 'time'
+require 'singleton'
+require 'json'
 
 # Futex (file mutex) is a fine-grained mutex that uses a file, not an entire
 # thread, like <tt>Mutex</tt> does. Use it like this:
@@ -95,7 +97,7 @@ class Futex
     b = badge(exclusive)
     Thread.current.thread_variable_set(:futex_lock, @lock)
     Thread.current.thread_variable_set(:futex_badge, b)
-    File.open(@lock, File::CREAT | File::RDWR) do |f|
+    open_synchronized(@lock) do |f|
       cycle = 0
       loop do
         if f.flock((exclusive ? File::LOCK_EX : File::LOCK_SH) | File::LOCK_NB)
@@ -157,4 +159,45 @@ access to #{@path}, #{age(start)} already: #{IO.read(@lock)} \
       @log.puts(msg)
     end
   end
+
+  def open_synchronized(path)
+    path = File.absolute_path(path)
+    file = nil
+    synchronized do |ref_counts_file|
+      file = File.open(path, File::CREAT | File::RDWR)
+      ref_counts = deserialize(File.read(ref_counts_file.path))
+      ref_counts[path] = (ref_counts[path] || 0) + 1
+      File.write(ref_counts_file.path, serialize(ref_counts))
+    end
+    yield file
+  ensure
+    synchronized do |ref_counts_file|
+      file.close
+      ref_counts = deserialize(File.read(ref_counts_file.path))
+      ref_counts[path] -= 1
+      if ref_counts[path].zero?
+        FileUtils.rm(path, force: true)
+        ref_counts.delete(path)
+      end
+      File.write(ref_counts_file.path, serialize(ref_counts))
+    end
+  end
+
+  def synchronized
+    ref_counts_file = File.join(Dir.tmpdir, '.futex.lock')
+    File.open(ref_counts_file, File::CREAT | File::RDWR) do |f|
+      f.flock(File::LOCK_EX)
+      yield f
+    end
+  end
+
+  def serialize(data)
+    # NOTE: JSON is just an example,
+    # use whatever serialization is more appropriate here
+    data.to_json
+  end
+
+  def deserialize(data)
+    data.empty? ? {} : JSON.parse(data)
+  end
 end

data/test/test_futex.rb

@@ -93,32 +93,57 @@ class FutexTest < Minitest::Test
     end
   end
 
-  def test_non_exclusive_locking
+  def test_exclusive_and_shared_locking
     Dir.mktmpdir do |dir|
       path = File.join(dir, 'g/e/f/file.txt')
       Threads.new(20).assert(1000) do |_, r|
         if (r % 50).zero?
           Futex.new(path).open do |f|
             text = SecureRandom.hex(1024)
-            hash = Digest::SHA256.hexdigest(text)
+            hash = hash(text)
             IO.write(f, text + ' ' + hash)
           end
         end
         Futex.new(path).open(false) do |f|
           if File.exist?(f)
             text, hash = IO.read(f, text).split(' ')
-            assert_equal(hash, Digest::SHA256.hexdigest(text))
+            assert_equal(hash, hash(text))
           end
         end
       end
     end
   end
 
-  # This test doesn't work and I can't fix it. If I remove the file
-  # afterwards, the flock() logic gets broken. More about it here:
-  # https://stackoverflow.com/questions/53011200
+  def test_exclusive_and_shared_locking_in_processes
+    Dir.mktmpdir do |dir|
+      path = File.join(dir, 'g/e/f/file.txt')
+      10.times do
+        Process.fork do
+          Threads.new(20).assert(1000) do |_, r|
+            if (r % 50).zero?
+              Futex.new(path).open do |f|
+                text = SecureRandom.hex(1024)
+                hash = hash(text)
+                IO.write(f, text + ' ' + hash)
+              end
+            end
+            Futex.new(path).open(false) do |f|
+              if File.exist?(f)
+                text, hash = IO.read(f, text).split(' ')
+                assert_equal(hash, hash(text))
+              end
+            end
+          end
+          exit!(0)
+        end
+      end
+      Process.waitall.each do |p, e|
+        raise "Failed in PID ##{p}: #{e}" unless e.exitstatus.zero?
+      end
+    end
+  end
+
   def test_cleans_up_the_mess
-    skip
     Dir.mktmpdir do |dir|
       Futex.new(File.join(dir, 'hey.txt')).open do |f|
         IO.write(f, 'hey')
@@ -165,4 +190,10 @@ class FutexTest < Minitest::Test
       Futex.new(File.join(dir, 'hey.txt')).open
     end
   end
+
+  private
+
+  def hash(text)
+    Digest::SHA256.hexdigest(text)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futex
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-16 00:00:00.000000000 Z
+date: 2018-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -24,6 +24,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement