locked_process 0.0.1

data/README.md

@@ -0,0 +1,26 @@
+# LockedProcess
+Locked process is a way of executing a Thread but preventing the same Thread from being executed while the first one is still running.
+
+## Instalation
+```bash
+gem install 'locked_process'
+```
+
+## Usage
+```ruby
+require 'locked_process'
+
+process = LockedProcess.new('/tmp/download_images.pid') do
+  MyImageDownloader.new.download
+end
+
+process.execute # executes MyImageDownloader.new.download in a Thread
+
+# if the process is still running
+process.execute # raises LockedProcess::Error
+
+```
+
+
+## Author
+Marcelo Jacobus

data/lib/locked_process.rb

@@ -0,0 +1,42 @@
+require 'thread'
+
+class LockedProcess
+  VERSION = '0.0.1'
+
+  class Error < StandardError; end
+
+  attr_reader :pid_file
+
+  def initialize(pid_file)
+    unless block_given?
+      raise ArgumentError.new('Block must be given')
+    end
+
+    @process = lambda { yield }
+    @pid_file = pid_file
+  end
+
+  def pid_file_exists?
+    File.exists?(pid_file)
+  end
+
+  def execute
+    create_pid_file
+    Thread.new do
+      @process.call
+      remove_pid_file
+    end
+  end
+
+  private
+    def create_pid_file
+      if pid_file_exists?
+        raise Error.new("Process is already running (pidfile '#{pid_file}' exists)")
+      end
+      File.open(pid_file, 'w').close
+    end
+
+    def remove_pid_file
+      File.unlink(pid_file)
+    end
+end

data/spec/lib/locked_process_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe LockedProcess do
+  before do
+    system("rm -f #{pidfile}")
+    system("rm -f #{test_file}")
+  end
+
+  after do
+    system("rm -f #{pidfile}")
+    system("rm -f #{test_file}")
+  end
+
+  let(:mocked) { mock(:mocked, run: 'running') }
+  let(:pidfile) { '/tmp/locked_process_spec.pid' }
+  let(:test_file) { '/tmp/locked_process_test_file.pid' }
+
+  subject do
+    LockedProcess.new(pidfile) do
+      mocked.run('abc')
+    end
+  end
+
+
+  describe "#initialize" do
+    context "when block is not given" do
+      it "raises ArgumentError" do
+        expect { LockedProcess.new(pidfile) }.to raise_error(ArgumentError, 'Block must be given')
+      end
+    end
+  end
+
+  describe "#execute" do
+    it "creates a pid file" do
+      subject.execute
+      File.exists?(pidfile).should be_true
+    end
+
+    it "raises an exception when file exists" do
+      subject.stub(:pid_file_exists?).and_return(true)
+      expect { subject.execute }.to raise_error(LockedProcess::Error, "Process is already running (pidfile '#{pidfile}' exists)")
+    end
+
+    it "executes the code in a thread and removes the pid file" do
+      process = LockedProcess.new(pidfile) do
+        sleep(0.1)
+        File.open(test_file, 'w').close
+      end
+
+      process.execute
+
+      File.exists?(test_file).should be_false
+      File.exists?(pidfile).should be_true
+      sleep(0.2)
+      File.exists?(test_file).should be_true
+      File.exists?(pidfile).should be_false
+    end
+
+    it "executes even if the main process is gone down" do
+      process = LockedProcess.new(pidfile) do
+        sleep(0.1)
+        File.open(test_file, 'w').close
+      end
+
+      process.execute
+
+      fork do
+        exit
+      end
+
+      File.exists?(test_file).should be_false
+      File.exists?(pidfile).should be_true
+      sleep(0.2)
+      File.exists?(test_file).should be_true
+      File.exists?(pidfile).should be_false
+
+    end
+  end
+
+  describe "#pid_file_exists?" do
+    it "checks whether pid file exists" do
+      subject.pid_file_exists?.should be_false
+      system("touch #{pidfile}")
+      subject.pid_file_exists?.should be_true
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter "spec"
+end
+
+require 'locked_process'
+
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

data/spec/test.rb

@@ -0,0 +1,17 @@
+$:.push File.expand_path("../../lib", __FILE__)
+
+require 'locked_process'
+
+file    = '/tmp/locked_process_test_file.txt'
+pidfile = '/tmp/locked_process_test_file_pid.pid'
+
+File.unlink(file) if File.exists?(file)
+#File.unlink(pidfile) if File.exists?(pidfile)
+
+process = LockedProcess.new(pidfile) do
+  sleep 2
+  File.open(file, 'w').close
+  sleep 2
+end
+
+process.execute

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: locked_process
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marcelo Jacobus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Trhead process that only executes if no other thread with the same lock
+  file is running
+email: marcelo.jacobus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/locked_process.rb
+- spec/test.rb
+- spec/spec_helper.rb
+- spec/lib/locked_process_spec.rb
+homepage: https://github.com/mjacobus/locked_process
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Thread process with that can run only if it is unique
+test_files:
+- spec/test.rb
+- spec/spec_helper.rb
+- spec/lib/locked_process_spec.rb