futex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8cbb61dfb861233a3f0883cd1ce83858bbbad9ec2b71f17f286edbbe2d0c57b
+  data.tar.gz: 6ef08599e9100ae73d0706270ce3c7aa6cb1b58f9c64ceb9f54026f07ac547f1
+SHA512:
+  metadata.gz: bc33d6417050639fd839530b820de078406b112d8d6ffc914c9956ce6b84b511be82678a2b438f9b9fa13311487a3033d6ac3e0efbe6262836b3c2c06443824d
+  data.tar.gz: 383ced7c5df759d14d494a183562771cc0cf3904b33bc9152c0870cea24e2683d966b660e11751a01aa32ab0137f538aaef7bc2eac9a53fa94149e46aa06dc84

data/.0pdd.yml

@@ -0,0 +1,9 @@
+errors:
+  - yegor256@gmail.com
+# alerts:
+#   github:
+#     - yegor256
+
+tags:
+  - pdd
+  - bug

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+*.gem
+.bundle/
+.DS_Store
+rdoc/

data/.pdd

@@ -0,0 +1,5 @@
+--source=.
+--verbose
+--rule min-words:20
+--rule min-estimate:15
+--rule max-estimate:90

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3.3
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 50
+Metrics/MethodLength:
+  Max: 30
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/PerceivedComplexity:
+  Max: 10
+Layout/AlignParameters:
+  Enabled: false

data/.rultor.yml

@@ -0,0 +1,23 @@
+assets:
+  rubygems.yml: zerocracy/home#assets/rubygems.yml
+install: |-
+  export GEM_HOME=~/.ruby
+  export GEM_PATH=$GEM_HOME:$GEM_PATH
+release:
+  script: |-
+    bundle install
+    rake
+    rm -rf *.gem
+    sed -i "s/0\.0\.0/${tag}/g" futex.gemspec
+    git add futex.gemspec
+    git commit -m "Version set to ${tag}"
+    gem build futex.gemspec
+    chmod 0600 ../rubygems.yml
+    gem push *.gem --config-file ../rubygems.yml
+  commanders:
+  - yegor256
+architect:
+- yegor256
+merge:
+  commanders: []
+deploy: {}

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.3.3
+branches:
+  only:
+    - master
+install:
+  - bundle install
+script:
+  - set -e
+  - rake
+

data/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,82 @@
+[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/futex)](http://www.rultor.com/p/yegor256/futex)
+[![We recommend RubyMine](http://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
+
+[![Build Status](https://travis-ci.org/yegor256/futex.svg)](https://travis-ci.org/yegor256/futex)
+[![Gem Version](https://badge.fury.io/rb/futex.svg)](http://badge.fury.io/rb/futex)
+[![Maintainability](https://api.codeclimate.com/v1/badges/5528e182bb5e4a2ecc1f/maintainability)](https://codeclimate.com/github/yegor256/futex/maintainability)
+
+Sometimes you need to synchronize your block of code, but `Mutex` is too coarse-grained,
+because it _always locks_, no matter what objects your code accesses. The
+`Futex` (from "file mutex") is more fine-grained and uses a file as an
+entrance lock to your code.
+
+First, install it:
+
+```bash
+$ gem install futex
+```
+
+Then, use it like this:
+
+```ruby
+require 'futex'
+Futex.new('/tmp/my-file.txt').open |f|
+  File.write(f, 'Hello, world!')
+end
+```
+
+The file `/tmp/my-file.txt.lock` will be created and used as an entrance lock.
+It will be deleted afterwards.
+
+For better traceability you can provide a few arguments to the
+constructor of the `Futex` class, including:
+
+  * `log`: an object that implements `debug()` method, which will
+    receive supplementary messages from the locking mechanism;
+
+  * `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).
+
+That's it.
+
+# How to contribute
+
+Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
+Make sure you build is green before you contribute
+your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
+[Bundler](https://bundler.io/) installed. Then:
+
+```
+$ bundle update
+$ rake
+```
+
+If it's clean and you don't see any error messages, submit your pull request.
+
+# License
+
+(The MIT License)
+
+Copyright (c) 2018 Yegor Bugayenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the 'Software'), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+
+CLEAN = FileList['coverage']
+
+def name
+  @name ||= File.basename(Dir['*.gemspec'].first, '.*')
+end
+
+def version
+  Gem::Specification.load(Dir['*.gemspec'].first).version
+end
+
+task default: %i[clean test rubocop]
+
+require 'rake/testtask'
+desc 'Run all unit tests'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = false
+end
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on all directories'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.requires << 'rubocop-rspec'
+end

data/futex.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'English'
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  if s.respond_to? :required_rubygems_version=
+    s.required_rubygems_version = Gem::Requirement.new('>= 0')
+  end
+  s.rubygems_version = '2.3.3'
+  s.required_ruby_version = '>=2.3'
+  s.name = 'futex'
+  s.version = '0.1.0'
+  s.license = 'MIT'
+  s.summary = 'File-based mutex'
+  s.description = 'Ruby Gem for file-based locking'
+  s.authors = ['Yegor Bugayenko']
+  s.email = 'yegor256@gmail.com'
+  s.homepage = 'http://github.com/yegor256/futex'
+  s.files = `git ls-files`.split($RS)
+  s.test_files = s.files.grep(%r{^(test)/})
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = ['README.md']
+  s.add_development_dependency 'minitest', '~>5'
+  s.add_development_dependency 'rake', '~>12'
+  s.add_development_dependency 'rdoc', '~>4'
+  s.add_development_dependency 'rubocop', '0.58.1'
+  s.add_development_dependency 'rubocop-rspec', '~>1'
+  s.add_development_dependency 'threads', '~>0'
+end

data/lib/futex.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'fileutils'
+require 'time'
+
+# Futex.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+class Futex
+  def initialize(path, log: STDOUT, timeout: 16, sleep: 0.005,
+    lock: path + '.lock')
+    raise "File path can't be nil" if path.nil?
+    @path = path
+    raise "Log can't be nil" if log.nil?
+    @log = log
+    raise "Timeout can't be nil" if timeout.nil?
+    raise "Timeout must be positive: #{timeout}" unless timeout.positive?
+    @timeout = timeout
+    raise "Sleep can't be nil" if sleep.nil?
+    raise "Sleep can't be negative or zero: #{sleep}" unless sleep.positive?
+    @sleep = sleep
+    raise "Lock path can't be nil" if lock.nil?
+    @lock = lock
+  end
+
+  def open
+    FileUtils.mkdir_p(File.dirname(@lock))
+    step = (1 / @sleep).to_i
+    start = Time.now
+    cycle = 0
+    loop do
+      if File.new(@lock, File::CREAT | File::RDWR)
+        .flock(File::LOCK_EX | File::LOCK_NB)
+        break
+      end
+      sleep(@sleep)
+      cycle += 1
+      if Time.now - start > @timeout
+        raise "##{Process.pid}/#{Thread.current.name} can't get \
+exclusive access to the file #{@path} \
+because of the lock at #{@lock}, after #{age(start)} \
+of waiting: #{IO.read(@lock)}"
+      end
+      if (cycle % step).zero? && Time.now - start > @timeout / 2
+        debug("##{Process.pid}/#{Thread.current.name} still waiting for \
+exclusive access to #{@path}, #{age(start)} already: #{IO.read(@lock)}")
+      end
+    end
+    debug("Locked by \"#{Thread.current.name}\" in #{age(start)}: #{@path} \
+(attempt no.#{cycle})")
+    File.write(@lock, "##{Process.pid}/#{Thread.current.name}")
+    acq = Time.now
+    res = yield(@path)
+    FileUtils.rm(@lock)
+    puts("Unlocked by \"#{Thread.current.name}\" in #{age(acq)}: #{@path}")
+    res
+  end
+
+  private
+
+  def age(time)
+    "#{((Time.now - time) * 1000).round}ms"
+  end
+
+  def debug(msg)
+    if @log.respond_to?(:debug)
+      @log.debug(msg)
+    elsif @log.respond_to?(:puts)
+      @log.puts(msg)
+    end
+  end
+end

data/test/test_futex.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require 'tmpdir'
+require 'threads'
+require_relative '../lib/futex'
+
+# Futex test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+class FutexTest < Minitest::Test
+  def test_syncs_access_to_file
+    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|
+          text = "op no.#{r}"
+          IO.write(f, text)
+          assert_equal(text, IO.read(f))
+        end
+      end
+    end
+  end
+
+  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|
+          text = "op no.#{r}"
+          IO.write(f, text)
+          sleep 0.2
+          assert_equal(text, IO.read(f))
+        end
+      end
+    end
+  end
+
+  def test_cleans_up_the_mess
+    Dir.mktmpdir do |dir|
+      Futex.new(File.join(dir, 'hey.txt')).open do |f|
+        IO.write(f, 'hey')
+        FileUtils.rm(f)
+      end
+      assert_equal(2, Dir.new(dir).count)
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: futex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yegor Bugayenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: threads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Gem for file-based locking
+email: yegor256@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".0pdd.yml"
+- ".gitignore"
+- ".pdd"
+- ".rubocop.yml"
+- ".rultor.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- futex.gemspec
+- lib/futex.rb
+- test/test_futex.rb
+homepage: http://github.com/yegor256/futex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 2
+summary: File-based mutex
+test_files:
+- test/test_futex.rb