ProcessLock 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d61970b09ca1da8457f493e866c8b05b8dca9ee9
+  data.tar.gz: 2ed9372c86217c075f6a0ecb3837fe00007e1a0f
+SHA512:
+  metadata.gz: 575034da90d7591e6b8dbcb8a06528efb7a7fefdd264865b72e240525a3b7a73a9237fa701a4c54c12ca3ec14a7f6613e8c105673b29dc54f1dee97636e0a791
+  data.tar.gz: 35c71219c3e686ac924e7d7c4aaa8f5faf1e2f58db208763e71ee542d54e94b032a1a3842e35f22cc9e09a25a5b5df267c73daddd8d55f0e904a7223b4cf908b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ProcessLock.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Courtney de Lautour
+
+MIT License
+
+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/ProcessLock.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ProcessLock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ProcessLock"
+  spec.version       = ProcessLock::VERSION
+  spec.authors       = ["Courtney de Lautour"]
+  spec.email         = ["clautour@thefrontiergroup.com.au"]
+  spec.summary       = %q{Locks a method to a single process}
+  spec.homepage      = "https://github.com/Amerdrix/ruby-ProcessLock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "rspec", "~> 2.3"
+end

data/README.md

@@ -0,0 +1,41 @@
+# ProcessLock
+
+Provides a process level synchronization context, allowing only a single process to execute a section of code any given
+time.
+
+Windows is currently not supported.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ProcessLock'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ProcessLock
+
+## Usage
+
+
+Wrap any code you want to run in a synchronized context with
+
+    ProcessLock.ensure_only_process do
+      # Your code here
+    end
+
+Process lock will automatically infer a key based on the current file and method which is running. Optionally you can
+specify a your self `ensure_only_process(:your_key_here)`
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<Amerdrix>/ProcessLock/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/ProcessLock/locked_error.rb

@@ -0,0 +1,5 @@
+module ProcessLock
+  class LockedError < StandardError
+
+  end
+end

data/lib/ProcessLock/nix_locker.rb

@@ -0,0 +1,43 @@
+require 'SecureRandom'
+require_relative 'locked_error'
+
+module ProcessLock
+  class NixLocker
+
+    EXISTS = Object.new
+
+    def ensure_only_process(name)
+      path = File.join(tmpdir, "#{name}.pid")
+      result = run(path) { yield }
+      raise LockedError if result == EXISTS
+      result
+    end
+
+    private
+
+    def tmpdir
+      '/tmp'
+    end
+
+    def run(path)
+      thrown = false
+      catch(EXISTS) do
+        begin
+          begin
+            File.open(path, File::WRONLY|File::CREAT|File::EXCL) do |file|
+              file << Process.pid
+            end
+          rescue
+            thrown = true
+            throw(EXISTS, EXISTS)
+          end
+
+          yield
+
+        ensure
+          File.delete(path) unless thrown
+        end
+      end
+    end
+  end
+end

data/lib/ProcessLock/version.rb

@@ -0,0 +1,3 @@
+module ProcessLock
+  VERSION = "0.1.2"
+end

data/lib/ProcessLock.rb

@@ -0,0 +1,22 @@
+require "ProcessLock/version"
+require "ProcessLock/locked_error"
+require "ProcessLock/nix_locker"
+
+module ProcessLock
+  class << self
+    def ensure_only_process(name = nil, &block)
+      raise ArgumentError, "No block given" unless block_given?
+      name ||= infer_name(block)
+      locker = NixLocker.new
+      locker.ensure_only_process(name, &block)
+    end
+
+    private
+
+    def infer_name(block)
+      method = block.binding.eval('__method__')
+      file = File.basename(block.binding.eval('__FILE__'), '.*')
+      "#{file}-#{method}"
+    end
+  end
+end

data/spec/process_lock_spec.rb

@@ -0,0 +1,35 @@
+require_relative '../lib/process_lock'
+require_relative '../lib/ProcessLock/locked_error'
+
+describe ProcessLock do
+  describe '.ensure_only_process' do
+
+    specify 'raises an error when a block is not passed' do
+      expect { ProcessLock.ensure_only_process }.to raise_error(ArgumentError)
+    end
+
+    specify 'raises an error when run simultaneously' do
+      expect { ProcessLock.ensure_only_process { ProcessLock.ensure_only_process {} } }.to raise_error(ProcessLock::LockedError)
+    end
+
+    specify 'raises an error raised by the block' do
+      exp = Exception.new
+      expect { ProcessLock.ensure_only_process { raise exp } }.to raise_error(exp)
+    end
+
+    specify 'does not raise an error when running when a block is passed' do
+      expect { ProcessLock.ensure_only_process {} }.to_not raise_error
+    end
+
+    specify 'does not raise an error when run twice in a row' do
+      ProcessLock.ensure_only_process {}
+      expect { ProcessLock.ensure_only_process {} }.to_not raise_error
+    end
+
+    specify 'return the result of the block' do
+      result = Object.new
+      expect(ProcessLock.ensure_only_process { result }).to be result
+    end
+  end
+end
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: ProcessLock
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Courtney de Lautour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 
+email:
+- clautour@thefrontiergroup.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- ProcessLock.gemspec
+- README.md
+- Rakefile
+- lib/ProcessLock.rb
+- lib/ProcessLock/locked_error.rb
+- lib/ProcessLock/nix_locker.rb
+- lib/ProcessLock/version.rb
+- spec/process_lock_spec.rb
+homepage: https://github.com/Amerdrix/ruby-ProcessLock
+licenses:
+- MIT
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Locks a method to a single process
+test_files:
+- spec/process_lock_spec.rb