ProcessLock

Ensures that multiple processes cannot be run concurrently, using redis.

Installation

Add this line to your application's Gemfile:

gem 'with_process_lock'

And then execute:

$ bundle

Or install it yourself as:

$ gem install with_process_lock

Usage

You can attempt to run a process once with execute_once. It will execute the block if the process is not locked, otherwise it will raise an exception.

  ProcessLock::WithProcessLock.execute_once('unique_key_for_your_process') do
    # The code to run in the process
    do_stuff
  end

You can run a process with a retry:

  ProcessLock::WithProcessLock.execute_with_retry(
    'unique_key_for_your_process'
  ) do
    # The code to run in the process
    do_stuff
  end

This will retry running the block every 1 second until the process is unblocked. The current thread will be blocked until the block successfully executes. You can override the default retry wait by providing the retry_wait parameter in seconds.

  ProcessLock::WithProcessLock.execute_with_retry(
    'unique_key_for_your_process',
    retry_wait: 2
  ) do
    # The code to run in the process
    do_stuff
  end

If you don't want the retry to run forever, you can specify a timeout by providing the timeout parameter in seconds:

  ProcessLock::WithProcessLock.execute_with_retry(
    'unique_key_for_your_process',
    retry_wait: 2,
    timeout: 10
  ) do
    # The code to run in the process
    do_stuff
  end

This will retry until the timeout time is expired, then raise an error.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/process_lock.