safe_flock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d93a87058706f01d75abc1892f295c1448bbe62829dbd71fd05f50b21660c24
+  data.tar.gz: 50307bf731dcba44c41e0304154cc38e67d8ef3f93e45de02bd7568c05ea12d6
+SHA512:
+  metadata.gz: 40506d496027784cd008d5ff95fd855e85d84ea492ff2f7be40a84bb3393fdce11be11ecf0a249d820ea953708eb4e3078a596d433ce3313cc47e5b312021002
+  data.tar.gz: 71c2b6401b2e6b93e4172d53b8a93b0fdd6c282c2da976050f7ca5c6923aaf69de94297e48027fe4f23118f57fb7b991a6d9bf1c9723499aa40bec6f7408e2a2

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.5

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 safe_flock.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    safe_flock (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  safe_flock!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+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/README.md

@@ -0,0 +1,60 @@
+# SafeFlock
+
+Thread-safe, transferable, flock-based file lock.
+
+This helper solves mutual exclusion within niche constraints:
+
+* A parent process must acquire a lock and transfer it to a child process.
+* The parent may terminate before the child.
+* Locks may be created within threads within the parent.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safe_flock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safe_flock
+
+## Usage
+
+Simple example:
+
+```
+require "safe_flock"
+
+SafeFlock.create("/var/run/myapp/myapp.lck") do
+  # ... mutually excluded processing
+end
+```
+
+The use case for which the helper was created:
+
+```
+require "safe_flock"
+
+SafeFlock.create("/var/run/myapp/myapp.lck") do
+  child = fork do
+    # ... mutually excluded processing
+  end
+end
+Process.detach(child)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/starjuice/safe_flock.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+task :default => :spec
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "safe_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/safe_flock/lockfile.rb

@@ -0,0 +1,95 @@
+require "time"
+
+module SafeFlock
+
+  class Lockfile
+
+    class Error < RuntimeError; end
+    class Locked < RuntimeError; end
+
+    @@global_mutex = Mutex.new unless defined?(@@global_mutex)
+    @@path_mutex = {} unless defined?(@@path_mutex)
+
+    # +path+ full pathname of mutually agreed lock file.
+    #
+    # +options+
+    # * +max_wait+ seconds to retry acquiring lock before giving up and raising +Error+ (+5.0+)
+    #
+    def initialize(path, max_wait: 5.0)
+      @pid = $$
+      @thread_id = Thread.current.object_id
+      @path = path
+      @max_wait = max_wait
+      @wait_per_try = 0.1
+      @mlocked = false
+      @lockfd = nil
+    end
+
+    def lock
+      deadline = Time.now.to_f + @max_wait
+      while !(is_locked = try_lock)
+        if Time.now.to_f < deadline
+          sleep @wait_per_try
+        else
+          break
+        end
+      end
+      is_locked
+    end
+
+    # If the lock is inherited by a forked child process, it will hold the lock until
+    # the child calls +unlock+ (or terminates) _and_ the parent's +Lockfile.create+
+    # block terminates. The parent should not call +unlock+.
+    #
+    def unlock
+      if @lockfd
+        @lockfd.close
+        @lockfd = nil
+      end
+      if @mlocked && @pid == $$ and @thread_id == Thread.current.object_id
+        mutex_unlock
+      end
+    end
+
+    attr_reader :path, :pid, :thread_id
+
+    private
+
+    def try_lock
+      begin
+        if try_mutex_lock
+          @lockfd = File.new(@path, "a")
+          @lockfd.flock(File::LOCK_EX | File::LOCK_NB)
+        end
+      rescue
+        @lockfd.close if @lockfd and !@lockfd.closed?
+        @lockfd = nil
+        mutex_unlock
+        raise
+      end
+    end
+
+    def try_mutex_lock
+      @@global_mutex.synchronize do
+        @@path_mutex[@path] = Mutex.new unless @@path_mutex[@path]
+        @mlocked = @@path_mutex[@path].try_lock
+      end
+    end
+
+    def mutex_unlock
+      @@global_mutex.synchronize do
+        if @mlocked
+          @@path_mutex[@path].unlock
+          @@path_mutex.delete(@path)
+          @mlocked = false
+        end
+      end
+    end
+
+    def debug(*args)
+      #$stderr.puts "DEBUG: LOCKFILE: [#{$$}]<#{"0x%x" % Thread.current.object_id}>: " + args.join(": ")
+    end
+
+  end
+
+end

data/lib/safe_flock/version.rb

@@ -0,0 +1,3 @@
+module SafeFlock
+  VERSION = "0.1.0"
+end

data/lib/safe_flock.rb

@@ -0,0 +1,25 @@
+require "safe_flock/lockfile"
+require "safe_flock/version"
+
+module SafeFlock
+
+  class Error < RuntimeError; end
+  class Locked < RuntimeError; end
+
+  def self.create(path, options = {})
+    raise(ArgumentError, "Block required") unless block_given?
+    lockfile = Lockfile.new(path, options)
+    begin
+      if lockfile.lock
+        begin
+          yield lockfile
+        ensure
+          lockfile.unlock
+        end
+      else
+        raise Locked, "Timed out waiting for lock"
+      end
+    end
+  end
+
+end

data/safe_flock.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "safe_flock/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "safe_flock"
+  spec.version       = SafeFlock::VERSION
+  spec.authors       = ["Sheldon Hearn"]
+  spec.email         = ["sheldonh@starjuice.net"]
+
+  spec.summary       = %q{Thread-safe, transferable, flock-based lock file}
+  spec.description   = %q{Thread-safe, transferable, flock-based lock file}
+  spec.homepage      = "https://github.com/starjuice/safe_flock"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: safe_flock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sheldon Hearn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Thread-safe, transferable, flock-based lock file
+email:
+- sheldonh@starjuice.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/safe_flock.rb
+- lib/safe_flock/lockfile.rb
+- lib/safe_flock/version.rb
+- safe_flock.gemspec
+homepage: https://github.com/starjuice/safe_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.7.6
+signing_key: 
+specification_version: 4
+summary: Thread-safe, transferable, flock-based lock file
+test_files: []