placate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c781f759fd2282b4cbbf32039ef53e5eed2f1959bf46d670b13cc57139e7a91
+  data.tar.gz: e96b43f21704a5ae648a1acc2a3dfd8530f5669c301cfdf872d44d8bbbc73510
+SHA512:
+  metadata.gz: 7d3005d9ff5ba7a53b501706066bb5d7657fa72e5e40b6846dab2e1b8282dcf973a5a932d4d1c932f02a2d2409851060b56c22d492b759d0915651dea7a60acf
+  data.tar.gz: e2be1bab70de91dd7e595c64c50367e3a2985551d69f2f587af4e0d3183c03c9ada2a3b99562497f2396f69609ee08d9e7f8922fcb7820f7663aa500dd2e6f7d

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 3.3
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-28
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+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,113 @@
+# Placate
+
+Placate is a simple Redis-based solution for preventing duplicate job execution in Ruby background job processors. It's designed to work with ActiveJob and any Redis-backed job system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'placate'
+```
+
+And then execute:
+```bash
+bundle install
+```
+
+## Usage
+
+### Basic Setup
+
+First, configure Placate with your Redis connection:
+
+```ruby
+# config/initializers/placate.rb
+Placate.configure do |config|
+  config.redis = Redis.new
+  config.default_lock_ttl = 30 # Default time-to-live in seconds
+end
+```
+
+### In Your Jobs
+
+Include the UniqueJob module in any job you want to prevent duplicates:
+
+```ruby
+class ProcessOrderJob < ApplicationJob
+  include Placate::UniqueJob
+  
+  def perform(order_id)
+    # Your job code here
+  end
+end
+```
+
+Now if you try to enqueue the same job with the same arguments within the TTL window, the duplicate will be prevented:
+
+```ruby
+ProcessOrderJob.perform_later(order_id: 123) # First job enqueued
+ProcessOrderJob.perform_later(order_id: 123) # Blocked as duplicate
+ProcessOrderJob.perform_later(order_id: 456) # Different args, will be enqueued
+```
+
+### Customization
+
+You can customize the TTL per job class:
+
+```ruby
+class LongRunningJob < ApplicationJob
+  include Placate::UniqueJob
+  
+  self.unique_lock_ttl = 120 # 2 minutes
+  
+  def perform
+    # Your job code here
+  end
+end
+```
+
+Or use a custom key prefix:
+
+```ruby
+class CustomPrefixJob < ApplicationJob
+  include Placate::UniqueJob
+  
+  self.unique_lock_prefix = 'my_app_jobs'
+  
+  def perform
+    # Your job code here
+  end
+end
+```
+
+## How It Works
+
+Placate uses Redis to maintain a lock based on the job class name and arguments. When a job is enqueued (`before_enqueue`):
+
+1. A unique key is generated based on the job class and arguments
+2. The current timestamp is stored in Redis with this key
+3. If a key exists and its timestamp is within the TTL window, the job is not enqueued
+4. If no key exists or the existing timestamp is older than the TTL, the job is enqueued
+
+After the job is performed (`after_perform`):
+
+1. The unique key is deleted, to enable the next job.
+
+## Requirements
+
+- Ruby 3.3+
+- Rails 7.0+
+- Redis
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/placate/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Placate
+  class Configuration
+    attr_accessor :redis, :default_lock_ttl
+
+    def initialize
+      @default_lock_ttl = 60 # 1 minute default
+    end
+  end
+end

data/lib/placate/unique_job.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module Placate
+  module UniqueJob
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def unique_lock_ttl
+        @unique_lock_ttl || Placate.configuration.default_lock_ttl
+      end
+
+      def unique_lock_ttl=(seconds)
+        @unique_lock_ttl = seconds
+      end
+    end
+
+    included do
+      class_attribute :unique_lock_prefix, instance_writer: false, default: nil
+
+      before_enqueue do |job|
+        args_hash = Digest::MD5.hexdigest(job.arguments.to_s)
+        prefix = job.class.unique_lock_prefix || job.class.name
+        lock_key = "#{prefix}:#{args_hash}:lock"
+
+        current_time = Time.now.to_i
+        existing_lock = Placate.redis.get(lock_key)
+
+        if existing_lock
+          lock_time = existing_lock.to_i
+          throw :abort if current_time - lock_time < (job.class.unique_lock_ttl || 30)
+        end
+
+        Placate.redis.set(lock_key, current_time)
+      end
+
+      after_perform do |job|
+        args_hash = Digest::MD5.hexdigest(job.arguments.to_s)
+        prefix = job.class.unique_lock_prefix || job.class.name
+        lock_key = "#{prefix}:#{args_hash}:lock"
+
+        Placate.redis.del(lock_key) if lock_key
+      end
+    end
+  end
+end

data/lib/placate/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Placate
+  VERSION = "0.1.0"
+end

data/lib/placate.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "active_support"
+
+require_relative "placate/version"
+require_relative "placate/configuration"
+require_relative "placate/unique_job"
+
+module Placate
+  class Error < StandardError; end
+  # Your code goes here...
+
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def redis
+      configuration.redis
+    end
+  end
+end

data/sig/placate.rbs

@@ -0,0 +1,4 @@
+module Placate
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: placate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Toby
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: Prevents duplicate job execution using Redis locks for any Redis-based
+  job processing system
+email:
+- toby@darkroom.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/placate.rb
+- lib/placate/configuration.rb
+- lib/placate/unique_job.rb
+- lib/placate/version.rb
+- sig/placate.rbs
+homepage: https://github.com/tobyond/placate
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tobyond/placate
+  source_code_uri: https://github.com/tobyond/placate
+  changelog_uri: https://github.com/tobyond/placate/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Unique job handling for Redis-based job processors
+test_files: []