delayed_job_class_name_plugin 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af391dd335fc36171feaf80d26dde8cb2633eaac
+  data.tar.gz: 3548674074f29df3c8079d935f473f5e99735eb8
+SHA512:
+  metadata.gz: bc3407a67d489d384c0e8ba0ee7080ceec54da5338882a3faf1dfaa5a05384ce936e78b2e51c14cf36fe53ae8744a61cae1fb487cd061de93ffbecea653d6e69
+  data.tar.gz: 9ba02151503d7df487006eba43f62d2cafe0ce3a1f331accfa854b0f8bb9fd4c2575aaab53a53a59acb172b48e0a6d07034f29721071cdb8f1ea05403cb97fdf

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/doc/
+/pkg/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Cyrus Eslami
+
+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,53 @@
+# Delayed::ClassName Plugin
+
+[Delayed Job](https://github.com/collectiveidea/delayed_job) records a serialized payload object to the `delayed_jobs` table. If you want to know what _kinds of_ jobs are currently enqueued, you must write complicated and brittle queries to parse the serialized payloads (ie `Delayed::Job#handler`).
+
+This plugin adds an indexed `class_name` column to the `delayed_jobs` table. By default, it contains the stringified class name of the enqeued payload object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delayed_job_class_name_plugin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delayed_job_class_name_plugin
+
+Run the required database migrations:
+
+    $ rails generate delayed_job_class_name_plugin:install
+    $ rails db:migrate
+
+## Usage
+
+In certain cases, you may want to parse the payload object in a custom way to derive its "class name."
+
+For example, [ActiveJob](http://edgeguides.rubyonrails.org/active_job_basics.html) in Rails, will always enqueue a `JobWrapper` as the payload object. This object, predictably, wraps the object that's actually doing work. By default, "JobWrapper" would be the value of `Delayed::Job#class_name`. You may find this less helpful than having `#class_name` contain the class of the _wrapped_ object.
+
+Let's see how we can use the `#custom_parser` configuration to accomplish this:
+
+```ruby
+# config/initializers/delayed_job.rb
+Delayed::ClassName.configure do |c|
+  c.custom_parser = ->(job) {
+    if job.class == ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper
+      job.payload_object.job_data['job_class']
+    else
+      job.payload_object.class.name
+    end
+  }
+end
+```
+
+`Configuration#custom_parser` can take a `Proc` which receives a single parameter, `job`, and returns a `String` that will be written to `Delayed::Job#class_name` at enqueue-time.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/delayed_job_class_name_plugin.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'delayed/class_name/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'delayed_job_class_name_plugin'
+  spec.version       = Delayed::ClassName::VERSION
+  spec.authors       = ['Cyrus Eslami']
+  spec.email         = ['ceslami@gmail.com']
+
+  spec.summary       = 'Delayed::Job plugin to record the class name of the enqueued payload object'
+  spec.homepage      = 'https://github.com/ceslami/delayed_job_class_name_plugin'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = Dir.glob('spec/**/*')
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_dependency 'delayed_job', '~> 4.1', '>= 4.1.0'
+  spec.add_dependency 'delayed_job_active_record', '~> 4.1', '>= 4.1.0'
+
+  spec.add_development_dependency 'rake', '< 11.0'
+  spec.add_development_dependency 'rspec', '3.3.0'
+end

data/lib/delayed/class_name.rb

@@ -0,0 +1,19 @@
+require 'delayed/class_name/configuration'
+require 'delayed/class_name/plugin'
+require 'delayed/class_name/version'
+
+module Delayed
+  module ClassName
+    @configuration = Delayed::ClassName::Configuration.new
+
+    class << self
+      def configure
+        yield(configuration) if block_given?
+      end
+
+      def configuration
+        @configuration
+      end
+    end
+  end
+end

data/lib/delayed/class_name/configuration.rb

@@ -0,0 +1,17 @@
+module Delayed
+  module ClassName
+    class Configuration
+      attr_accessor :custom_parser
+
+      def initialize(options = {})
+        options.each do |key, value|
+          send("#{key}=", value)
+        end
+      end
+
+      def custom_parser?
+        !!@custom_parser
+      end
+    end
+  end
+end

data/lib/delayed/class_name/plugin.rb

@@ -0,0 +1,18 @@
+module Delayed
+  module ClassName
+    class Plugin < Delayed::Plugin
+      callbacks do |lifecycle|
+        lifecycle.before(:enqueue) do |job|
+          payload_object = job.payload_object
+
+          if Delayed::ClassName.configuration.custom_parser?
+            job.class_name = Delayed::ClassName.configuration.custom_parser.call payload_object
+          else
+            job.class_name = payload_object.class.name
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/delayed/class_name/version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module Delayed
+  module ClassName
+    VERSION = '1.0.1'.freeze
+  end
+end

data/lib/delayed_job_class_name_plugin.rb

@@ -0,0 +1,7 @@
+require 'active_support'
+require 'active_record'
+require 'delayed_job'
+require 'delayed_job_active_record'
+require 'delayed/class_name'
+
+Delayed::Worker.plugins << Delayed::ClassName::Plugin

data/lib/generators/delayed_job_class_name_plugin/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module DelayedJobClassNamePlugin
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    self.source_paths << File.join(File.dirname(__FILE__), 'templates')
+
+    def create_migration_file
+      migration_template('migration.rb', 'db/migrate/add_class_name_to_delayed_jobs.rb', migration_version: migration_version)
+    end
+
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    private
+
+    def migration_version
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]" if ActiveRecord::VERSION::MAJOR >= 5
+    end
+  end
+end

data/lib/generators/delayed_job_class_name_plugin/templates/migration.rb

@@ -0,0 +1,6 @@
+class AddClassNameToDelayedJobs < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :delayed_jobs, :class_name, :string
+    add_index :delayed_jobs, :class_name
+  end
+end

data/spec/delayed/class_name_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Delayed::ClassName do
+  let(:job) { Delayed::Job.all.first }
+
+  context 'when there is not a custom parser' do
+    before do
+      Delayed::ClassName.configure do |c|
+        c.custom_parser = nil
+      end
+    end
+
+    it 'assigns the class name of the payload object to class_name' do
+      Delayed::Job.enqueue TestJob.new
+      expect(job.class_name).to eq 'TestJob'
+    end
+  end
+
+  context 'when there is a custom parser' do
+    before do
+      Delayed::ClassName.configure do |c|
+        c.custom_parser = ->(job) {
+          job.class.name + '1'
+        }
+      end
+    end
+
+    it 'assigns the parsed value to class_name' do
+      Delayed::Job.enqueue TestJob.new
+      expect(job.class_name).to eq 'TestJob1'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'delayed_job_class_name_plugin'
+
+spec_dir = File.dirname(__FILE__)
+Dir["#{spec_dir}/support/**/*.rb"].sort.each { |f| require f }
+$LOAD_PATH << File.expand_path("support/delayed_job", __dir__)
+
+Delayed::Worker.backend = :test
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.before :each do
+    Delayed::Job.delete_all
+  end
+end

data/spec/support/delayed_job/delayed/backend/test.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+# copied from https://github.com/collectiveidea/delayed_job/blob/master/spec/delayed/backend/test.rb
+# add attr_accessor for class_name field
+require "ostruct"
+
+# An in-memory backend suitable only for testing. Tries to behave as if it were an ORM.
+module Delayed
+  module Backend
+    module Test
+      class Job
+        attr_accessor :id
+        attr_accessor :priority
+        attr_accessor :attempts
+        attr_accessor :handler
+        attr_accessor :last_error
+        attr_accessor :run_at
+        attr_accessor :locked_at
+        attr_accessor :locked_by
+        attr_accessor :failed_at
+        attr_accessor :queue
+        attr_accessor :class_name
+
+        include Delayed::Backend::Base
+
+        cattr_accessor :id, default: 0
+
+        def initialize(hash = {})
+          self.attempts = 0
+          self.priority = 0
+          self.id = (self.class.id += 1)
+          hash.each { |k, v| send(:"#{k}=", v) }
+        end
+
+        @jobs = []
+        def self.all
+          @jobs
+        end
+
+        def self.count
+          all.size
+        end
+
+        def self.delete_all
+          all.clear
+        end
+
+        def self.create(attrs = {})
+          new(attrs).tap(&:save)
+        end
+
+        def self.create!(*args); create(*args); end
+
+        def self.clear_locks!(worker_name)
+          all.select { |j| j.locked_by == worker_name }.each { |j| j.locked_by = nil; j.locked_at = nil }
+        end
+
+        # Find a few candidate jobs to run (in case some immediately get locked by others).
+        def self.find_available(worker_name, limit = 5, max_run_time = Worker.max_run_time)
+          jobs = all.select do |j|
+            j.run_at <= db_time_now &&
+            (j.locked_at.nil? || j.locked_at < db_time_now - max_run_time || j.locked_by == worker_name) &&
+            !j.failed?
+          end
+
+          jobs = jobs.select { |j| Worker.queues.include?(j.queue) }   if Worker.queues.any?
+          jobs = jobs.select { |j| j.priority >= Worker.min_priority } if Worker.min_priority
+          jobs = jobs.select { |j| j.priority <= Worker.max_priority } if Worker.max_priority
+          jobs.sort_by { |j| [j.priority, j.run_at] }[0..limit - 1]
+        end
+
+        # Lock this job for this worker.
+        # Returns true if we have the lock, false otherwise.
+        def lock_exclusively!(max_run_time, worker)
+          now = self.class.db_time_now
+          if locked_by != worker
+            # We don't own this job so we will update the locked_by name and the locked_at
+            self.locked_at = now
+            self.locked_by = worker
+          end
+
+          true
+        end
+
+        def self.db_time_now
+          Time.current
+        end
+
+        def update_attributes(attrs = {})
+          attrs.each { |k, v| send(:"#{k}=", v) }
+          save
+        end
+
+        def destroy
+          self.class.all.delete(self)
+        end
+
+        def save
+          self.run_at ||= Time.current
+
+          self.class.all << self unless self.class.all.include?(self)
+          true
+        end
+
+        def save!; save; end
+
+        def reload
+          reset
+          self
+        end
+      end
+    end
+  end
+end

data/spec/support/test_job.rb

@@ -0,0 +1,4 @@
+class TestJob
+  def perform
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: delayed_job_class_name_plugin
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Cyrus Eslami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: 
+email:
+- ceslami@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- delayed_job_class_name_plugin.gemspec
+- lib/delayed/class_name.rb
+- lib/delayed/class_name/configuration.rb
+- lib/delayed/class_name/plugin.rb
+- lib/delayed/class_name/version.rb
+- lib/delayed_job_class_name_plugin.rb
+- lib/generators/delayed_job_class_name_plugin/install_generator.rb
+- lib/generators/delayed_job_class_name_plugin/templates/migration.rb
+- spec/delayed/class_name_spec.rb
+- spec/spec_helper.rb
+- spec/support/delayed_job/delayed/backend/test.rb
+- spec/support/delayed_job/delayed/serialization/test.rb
+- spec/support/test_job.rb
+homepage: https://github.com/ceslami/delayed_job_class_name_plugin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Delayed::Job plugin to record the class name of the enqueued payload object
+test_files:
+- spec/delayed/class_name_spec.rb
+- spec/spec_helper.rb
+- spec/support/delayed_job/delayed/backend/test.rb
+- spec/support/delayed_job/delayed/serialization/test.rb
+- spec/support/test_job.rb