delayed_job_unique 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6e42c56a5be6f3253194021d173b2eb33375c6aea688af9654df4f4a52356a6
+  data.tar.gz: f88071747f8751079a83013dafeced59ea05afc84fa10bff9ce4fb4106893123
+SHA512:
+  metadata.gz: 1248f523d05a4208eab06f974845055dd7895593069a6967c6ef10f42306e778e44589608c0428f3b4c0707369be847d04b83f8d9d1c6a9ff4e91c4e64ec4790
+  data.tar.gz: 6898a0f19a650239ac7f7f55219155f228b5f0b3efae99427dd54af68ada1b5b53b29944bb6841b3727474344905c7e0030b22ebc2defa812935269c131adc10

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.3

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 SINAPTIA
+
+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,64 @@
+# Delayed Job Unique
+
+Delayed Job Unique is a Ruby gem that provides an extension to `delayed_job_active_record` for handling unique jobs in the queue.
+
+## Installation
+
+```bash
+$ bundle add delayed_job_unique
+```
+Or add the following line to your application's Gemfile:
+
+```ruby
+gem 'delayed_job_unique'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+The gem provides a `Delayed::Job::enqueue_once` class method which will use the `unique_key` of your job to check for other **not failed** jobs enqueued under the same key.
+This provides a simple yet flexible mechanism to finely control the concurrency on each Job class.
+
+If the job was already enqueued it will return `false`, otherwise it will return the enqueued job instance.
+
+## Example
+
+```ruby
+class MyUniqueJob
+  def perform
+    # Your job logic here
+  end
+
+  def unique_key
+    # Return a unique key for the job (String)
+  end
+end
+
+# Enqueue the job only if it's not already in the queue
+if Delayed::Job.enqueue_once(MyUniqueJob.new)
+  # job enqueued
+else
+  # job was already enqueued 
+end
+```
+
+## Development
+
+```bash
+git clone https://github.com/sinaptia/delayed_job_unique.git
+cd delayed_job_uniq
+bundle install
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "delayed_job_unique/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "delayed_job_unique"
+  spec.version       = DelayedJobUnique::VERSION
+  spec.authors       = ["Esteban Debole"]
+  spec.email         = ["estebandebole@gmail.com"]
+
+  spec.summary       = "Delayed Job Unique"
+  spec.description   = "Enqueue just one job with the same key"
+  spec.homepage      = "https://sinaptia.dev"
+  spec.license = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/sinaptia/delayed_job_unique"
+    spec.metadata["changelog_uri"] = "https://github.com/sinaptia/delayed_job_unique"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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)/|\.gem$}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "delayed_job_active_record", "~> 4.1"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/delayed_job_unique/active_record_extension.rb

@@ -0,0 +1,7 @@
+require "delayed_job_unique/unique_job"
+
+module Delayed
+  class Job < ActiveRecord::Base
+    extend Delayed::UniqueJob
+  end
+end

data/lib/delayed_job_unique/unique_job.rb

@@ -0,0 +1,26 @@
+require "delayed_job_active_record"
+
+module Delayed
+  module UniqueJob
+    def enqueue_once(*args)
+      job = args.first
+      raise "Job `#{job.class}` must respond to `#unique_key`" unless job.respond_to?(:unique_key)
+      Delayed::Job.transaction do
+        if job_already_enqueued?(job)
+          Delayed::Worker.logger.error "Job with key: #{job.unique_key} it's already on queue"
+          false
+        else
+          Delayed::Job.enqueue(job, key: job.unique_key)
+        end
+      end
+    end
+
+    private
+
+    def job_already_enqueued?(job)
+      # failed_at not nil means DJ doesnt retry the job again
+      # https://github.com/collectiveidea/delayed_job_active_record/blob/c7e7ceb10b7a50cf4de4e485fdef4581ad2c37e1/lib/delayed/backend/active_record.rb#L57
+      Delayed::Job.where(failed_at: nil, key: job.unique_key).exists?
+    end
+  end
+end

data/lib/delayed_job_unique/version.rb

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

data/lib/delayed_job_unique.rb

@@ -0,0 +1,6 @@
+require "delayed_job_unique/version"
+require "delayed_job_unique/unique_job"
+
+ActiveSupport.on_load(:active_record) do
+  require "delayed_job_unique/active_record_extension"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: delayed_job_unique
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Esteban Debole
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Enqueue just one job with the same key
+email:
+- estebandebole@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- delayed_job_unique.gemspec
+- lib/delayed_job_unique.rb
+- lib/delayed_job_unique/active_record_extension.rb
+- lib/delayed_job_unique/unique_job.rb
+- lib/delayed_job_unique/version.rb
+homepage: https://sinaptia.dev
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://sinaptia.dev
+  source_code_uri: https://github.com/sinaptia/delayed_job_unique
+  changelog_uri: https://github.com/sinaptia/delayed_job_unique
+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: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Delayed Job Unique
+test_files: []