reentrant_flock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d20c3216b95cf824f521614caca8e048843f649
+  data.tar.gz: 8957df239f692bfa3703545431070fd8f311c606
+SHA512:
+  metadata.gz: 178c166ac4fc276c43ebc1c59160e6787ddfb92b52ad9dc3715343c2c61819f2de1a1e8270c02191071ba2f96cbfbdc0e56133b641c9559838f5c3ed4ada9a2d
+  data.tar.gz: bf0f978871509dab41c0192f7191530fc07eeec7f349dc33cf3d92cc84433ef96ef1064d5932c20105541fdd72fed0ca48605adfc2e86a1f756cd4b07ad891ee

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.*
+  - 2.3.*
+  - 2.4.*
+before_install: gem install bundler -v 1.15.4

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (2017-09-05)
+
+initial version

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in reentrant_flock.gemspec
+gemspec

data/README.md

@@ -0,0 +1,63 @@
+# ReentrantFlock
+
+A reentrant/recursive flock.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reentrant_flock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reentrant_flock
+
+## Usage
+
+```ruby
+require 'reentrant_flock'
+
+File.open('/tmp/lock', File::RDWR | File::CREAT) do |fp|
+  ReentrantFlock.synchronize(fp, File::LOCK_EX) do
+    ReentrantFlock.synchronize(fp, File::LOCK_EX) do
+      # not to be blocked by myself
+    end
+  end
+end
+```
+
+```ruby
+require 'reentrant_flock'
+
+def with_lock(&block)
+  File.open('/tmp/lock', File::RDWR | File::CREAT) do |fp|
+    ReentrantFlock.synchronize(fp, File::LOCK_EX, &block)
+  end
+end
+
+with_lock do
+  with_lock do
+    # not to be blocked by myself
+  end
+end
+```
+
+`ReentrantFlock.synchronize` would raise `ReentrantFlock::AlreadyLocked` if `File::LOCK_NB` is given and already locked by somebody else.
+
+See [File#flock](https://ruby-doc.org/core-2.2.0/File.html#method-i-flock) for flags.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/reentrant_flock.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "reentrant_flock"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/reentrant_flock/version.rb

@@ -0,0 +1,3 @@
+class ReentrantFlock
+  VERSION = "0.1.0"
+end

data/lib/reentrant_flock.rb

@@ -0,0 +1,179 @@
+require "reentrant_flock/version"
+
+class ReentrantFlock
+  class AlreadyLocked < StandardError; end
+end
+
+class ReentrantFlock
+  class << self
+    # Note that File#flock is automatically unlocked when a file is closed,
+    # but ReentrantFlock.flock cannot automatically reset internal counts
+    # when a file is closed. Use ReentrantFlock.synchronize to assure
+    # decrementing internal counts.
+    #
+    # @param fp [File]
+    # @param operation [PARAM]
+    # @see File#flock for more details
+    # @param [PARAM] operation See File#flock
+    # @return see File#flock
+    def flock(fp, operation)
+      if (operation & File::LOCK_UN) > 0
+        unlock(fp)
+      else
+        lock(fp, operation)
+      end
+    end
+
+    # @param fp [File]
+    # @param [PARAM] operation See File#flock
+    # @yield
+    # @raise [AlreadyLocked] if already locked and LOCK_NB operation is specified
+    # @return [Object] the result of block
+    def synchronize(fp, operation)
+      raise 'Must be called with a block' unless block_given?
+
+      begin
+        raise AlreadyLocked if lock(fp, operation) == false
+        yield
+      ensure
+        unlock(fp)
+      end
+    end
+
+    # @param fp [File]
+    # @return [Boolean] true if locked by self
+    def self_locked?(fp)
+      k = key(fp)
+      Thread.current.key?(k) and Thread.current[k] >= 1
+    end
+
+    private
+
+    # @return [0] if current thread holds the lock
+    # @return [false] if current thread holds the lock
+    def lock(fp, operation)
+      c = incr(key(fp))
+      if c <= 1
+        # flock returns 0 if successfully locked.
+        # LOCK_NB returns false if somebody else already locked
+        fp.flock(operation)
+      else
+        0
+      end
+    end
+
+    def unlock(fp)
+      k = key(fp)
+      c = decr(k)
+      if c <= 0
+        fp.flock(File::LOCK_UN)
+        del(k)
+      end
+    end
+
+    def key(fp)
+      "reentrant_flock_#{fp.path}"
+    end
+
+    def incr(key)
+      Thread.current[key] ||= 0
+      Thread.current[key] += 1
+    end
+
+    def decr(key)
+      Thread.current[key] ||= 0
+      Thread.current[key] -= 1
+    end
+
+    def del(key)
+      Thread.current[key] = nil
+    end
+  end
+end
+
+# There is a fact that
+#
+# ```
+# fp = File.open('a', 'w')
+# fp.flock(File::LOCK_EX)
+# fp.flock(File::LOCK_EX) # does not block
+# fp = File.open('a', 'w')
+# fp.flock(File::LOCK_EX) # block
+# ```
+#
+# That is, File#flock is orginally reentrant for the same
+# file object because its file descriptor has lock information
+# on kernel layer. So, this instance version, which holds an
+# instance of File, may not worth to be prepared.
+class ReentrantFlock
+  attr_reader :fp
+
+  def initialize(fp)
+    @fp = fp
+    @mutex = Mutex.new
+    @counts = Hash.new(0)
+  end
+
+  # @param [PARAM] operation See File#flock
+  # @return see File#flock
+  def flock(operation)
+    if (operation & File::LOCK_UN) > 0
+      unlock
+    else
+      lock(operation)
+    end
+  end
+
+  # @param [PARAM] operation See File#flock
+  # @yield
+  # @raise [AlreadyLocked] if already locked and LOCK_NB operation is specified
+  # @return [Object] the result of block
+  def synchronize(operation)
+    raise 'Must be called with a block' unless block_given?
+
+    begin
+      raise AlreadyLocked if lock(operation) == false
+      yield
+    ensure
+      unlock
+    end
+  end
+
+  # @return [Boolean] true if locked by self
+  def self_locked?
+    @mutex.synchronize { @counts[Thread.current] >= 1 }
+  end
+
+  private
+
+  def lock(operation)
+    c = incr
+    if c <= 1
+      # flock returns 0 if successfully locked.
+      # LOCK_NB returns false if somebody else already locked
+      fp.flock(operation)
+    else
+      0
+    end
+  end
+
+  def unlock
+    c = decr
+    if c <= 0
+      fp.flock(File::LOCK_UN)
+      del
+    end
+  end
+
+  def incr
+    @mutex.synchronize { @counts[Thread.current] += 1 }
+  end
+
+  def decr
+    @mutex.synchronize { @counts[Thread.current] -= 1 }
+  end
+
+  def del
+    @mutex.synchronize { @counts.delete(Thread.current) }
+  end
+end

data/reentrant_flock.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "reentrant_flock/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "reentrant_flock"
+  spec.version       = ReentrantFlock::VERSION
+  spec.authors       = ["Naotoshi Seo"]
+  spec.email         = ["sonots@gmail.com"]
+
+  spec.summary       = %q{A reentrant/recursive flock.}
+  spec.description   = %q{A reentrant/recursive flock.}
+  spec.homepage      = "https://github.com/sonots/reentrant_flock"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "test-unit-power_assert"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: reentrant_flock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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'
+- !ruby/object:Gem::Dependency
+  name: test-unit-power_assert
+  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: A reentrant/recursive flock.
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reentrant_flock.rb
+- lib/reentrant_flock/version.rb
+- reentrant_flock.gemspec
+homepage: https://github.com/sonots/reentrant_flock
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A reentrant/recursive flock.
+test_files: []