sidekiq-enqueue 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8593bdbca30e66b0faba29c2b89fb574b95bd65c2d512e47c44c5b8e2385c638
-  data.tar.gz: 7bcdc4668baa2064190c2cd92f64a307f2f795aafb36b4eff1d5417c633a61f0
+  metadata.gz: b7e0670989272758e4def45a7bb33e090464b31078ab7d2a23f0eb6ff08b905a
+  data.tar.gz: 62f0740f8438f75f016fc961aaa13fba6c45b4846495465a704edc398dace8ae
 SHA512:
-  metadata.gz: a870b1cb00ba2bbcf7cbcdd2d41511ce8af4add5342cebbac1ed641159e57eaf0b623bc4bbc31e890ec5817e9f8bff31f206fcbacc6b8c21fd210edf87282524
-  data.tar.gz: 670a97ac89055a0fcc299f4c05e2adedb392723da62fef3dfa5baa864a7bc920ccd33654ae549f8b8c0d65f1f52799a0178a284c42b40cceeabb294b7296b6ca
+  metadata.gz: dd686de4c4c309c36e3c9ad2cc5f9ea9ed1f03aed57591e8c0eeb455964808508dab4e7d46a3ffa15dfe58d79fbf963b1896136a57d6cf407a403f3198744cd5
+  data.tar.gz: 9035c08ea3c292b8b7e13195869ae5e799e4e38f3f6a45e27f6baf4ec0b87ac4e94e7c4196c3b8df0191053943e1f1f8c3d0260bec00cd4a0d2f5ef8fbc5299a

data/.rubocop.yml

@@ -4,7 +4,7 @@ require:
 AllCops:
   NewCops: enable
   SuggestExtensions: false
-  TargetRubyVersion: 3.1.0
+  TargetRubyVersion: 3.4.0
 
 Gemspec/DevelopmentDependencies:
   Enabled: false
@@ -34,6 +34,9 @@ RSpec/SpecFilePathFormat:
 RSpec/SubjectStub:
   Enabled: false
 
+RSpec/MultipleExpectations:
+  Enabled: false
+
 RSpec/VerifiedDoubles:
   Enabled: false
 

data/.tool-versions

@@ -1 +1 @@
-ruby 3.4.4
+ruby 3.4.7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
+## [0.0.4]
+
+- Bump Ruby to 3.4.7
+- Update Sidekiq support to 8.x
+- Added datalist options to select from when queueing a job
+
 ## [0.0.2]
 
 - Bumped version of `rack` to 3.1.6
-
-## [Unreleased]

data/Gemfile.lock

@@ -1,30 +1,30 @@
 PATH
   remote: .
   specs:
-    sidekiq-enqueue (0.0.3)
-      sidekiq (< 8)
+    sidekiq-enqueue (0.0.4)
+      sidekiq (< 9)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    base64 (0.2.0)
-    connection_pool (2.5.0)
-    diff-lcs (1.5.1)
-    json (2.9.1)
-    language_server-protocol (3.17.0.3)
-    logger (1.6.5)
-    parallel (1.26.3)
-    parser (3.3.7.0)
+    ast (2.4.3)
+    connection_pool (3.0.2)
+    diff-lcs (1.6.2)
+    json (2.19.2)
+    language_server-protocol (3.17.0.5)
+    logger (1.7.0)
+    parallel (1.27.0)
+    parser (3.3.10.2)
       ast (~> 2.4.1)
       racc
+    prism (1.9.0)
     racc (1.8.1)
-    rack (3.2.4)
+    rack (3.2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    redis-client (0.23.2)
+    redis-client (0.28.0)
       connection_pool
-    regexp_parser (2.10.0)
+    regexp_parser (2.11.3)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -50,20 +50,21 @@ GEM
       rubocop-ast (>= 1.36.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.37.0)
-      parser (>= 3.3.1.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
     rubocop-rspec (3.0.5)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    sidekiq (7.3.8)
-      base64
-      connection_pool (>= 2.3.0)
-      logger
-      rack (>= 2.2.4)
-      redis-client (>= 0.22.2)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
+    sidekiq (8.1.1)
+      connection_pool (>= 3.0.0)
+      json (>= 2.16.0)
+      logger (>= 1.7.0)
+      rack (>= 3.2.0)
+      redis-client (>= 0.26.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 
 PLATFORMS
   arm64-darwin-24
@@ -78,4 +79,4 @@ DEPENDENCIES
   sidekiq-enqueue!
 
 BUNDLED WITH
-   2.5.20
+   2.6.9

data/README.md

@@ -21,3 +21,14 @@ Sidekiq::Enqueue.init
 ## Web UI
 
 The web UI is accessible via `#{root_url}/#{sidekiq_web_path}/enqueue`.
+
+## Release
+
+Merging to `main` does not automatically publish a new gem version. Before another app can consume a new release by updating its `Gemfile`, publish the gem to RubyGems:
+
+1. Update `Sidekiq::Enqueue::VERSION` in `lib/sidekiq/enqueue/version.rb`.
+2. Update `CHANGELOG.md`.
+3. Merge the release changes to `main`.
+4. Run `bundle exec rake release`.
+
+`bundle exec rake release` will build the gem, create a git tag for the version, and push the gem to RubyGems. After that, update the gem version in the other app's `Gemfile` and run Bundler as usual.

data/lib/sidekiq/enqueue/services/available_jobs.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Enqueue
+    module Services
+      class AvailableJobs
+        def self.call
+          eager_load_jobs!
+
+          job_names
+        end
+
+        def self.job_names
+          @job_names ||= ObjectSpace.each_object(Class)
+                                    .filter_map { |klass| job_name_for(klass) }
+                                    .uniq
+                                    .sort
+        end
+
+        def self.reset_cache!
+          @job_names = nil
+          @job_files = nil
+        end
+
+        def self.eager_load_jobs!
+          return unless defined?(Rails) && Rails.respond_to?(:root) && Rails.root
+
+          job_files
+        end
+
+        def self.job_files
+          @job_files ||= Dir[Rails.root.join("app/jobs/**/*.rb")].each do |file|
+            if defined?(require_dependency)
+              require_dependency(file)
+            else
+              require(file)
+            end
+          end
+        end
+
+        def self.job_name_for(klass)
+          return unless klass.name
+          return unless valid_job_class?(klass)
+
+          klass.name
+        rescue StandardError
+          nil
+        end
+
+        def self.valid_job_class?(klass)
+          klass.respond_to?(:perform_async) && klass.respond_to?(:get_sidekiq_options)
+        end
+
+        private_class_method :eager_load_jobs!, :job_name_for, :valid_job_class?, :new
+      end
+    end
+  end
+end

data/lib/sidekiq/enqueue/services/enqueue.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
+require "json"
+
 module Sidekiq
   module Enqueue
     module Services
       class Enqueue
         def initialize(job_name, arguments)
-          @job_class = Module.const_get(job_name)
+          @job_name = job_name
           @arguments = arguments
         end
 
         def call
-          @job_class.perform_async(*@arguments.split(",").map(&:strip))
+          job_class.perform_async(*@arguments.split(",").map(&:strip))
+        end
+
+        private
+
+        def job_class
+          Module.const_get(@job_name)
         end
       end
     end

data/lib/sidekiq/enqueue/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Enqueue
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/sidekiq/enqueue/web/locales/en.yml

@@ -1,5 +1,8 @@
 en:
   sidekiq_enqueue: Enqueue Job
   sidekiq_enqueue_arguments: Arguments
+  sidekiq_enqueue_arguments_hint: Enter a comma-separated list of arguments to pass to the job.
   sidekiq_enqueue_job_name: Job Name
+  sidekiq_enqueue_jobs_load_error: Unable to load available jobs.
+  sidekiq_enqueue_job_name_hint: Search for or enter the worker class name to enqueue.
   sidekiq_enqueue_submit: Submit

data/lib/sidekiq/enqueue/web/routes/enqueue.rb

@@ -7,9 +7,14 @@ module Sidekiq
         class Enqueue
           def self.register(app)
             app.post "/enqueue" do
-              Sidekiq::Enqueue::Services::Enqueue.new(params[:job_name], params[:arguments]).call
+              raise StandardError, "Job name is required" if url_params("job_name").nil? || url_params("job_name").empty?
+
+              Sidekiq::Enqueue::Services::Enqueue.new(url_params("job_name"), url_params("arguments")).call
 
               redirect "#{root_path}enqueue"
+            rescue StandardError => e
+              @enqueue_error = e
+              erb File.read(File.join(VIEW_PATH, "index.html.erb"))
             end
           end
         end

data/lib/sidekiq/enqueue/web/routes/index.rb

@@ -8,6 +8,8 @@ module Sidekiq
           def self.register(app)
             app.get "/enqueue" do
               erb File.read(File.join(VIEW_PATH, "index.html.erb"))
+            rescue StandardError
+              erb File.read(File.join(VIEW_PATH, "index.html.erb"))
             end
           end
         end

data/lib/sidekiq/enqueue/web/templates/index.html.erb

@@ -1,25 +1,93 @@
-<h3><%= t('sidekiq_enqueue') %></h3>
+<style nonce="<%= csp_nonce %>">
+  .enqueue-form-container {
+    max-width: 40rem;
+    padding: 1.5rem 0;
+  }
 
-<form action="<%= root_path %>enqueue" method="post" id="enqueue-form">
-  <%= csrf_tag %>
+  .enqueue-form-title {
+    margin-bottom: 1.25rem;
+  }
 
-  <div class="form-group row">
-    <label class="col-sm-2 col-form-label" for="job_name"><%= t('sidekiq_enqueue_job_name') %></label>
-    <div class="col-sm-4">
-      <input class="form-control" type="text" name="job_name" id="job_name" />
+  .enqueue-form {
+    display: block;
+    width: 100%;
+  }
+
+  .enqueue-form-group {
+    display: block;
+    margin-bottom: 1.5rem;
+    width: 100%;
+  }
+
+  .enqueue-form-label {
+    display: block;
+    margin-bottom: 0.35rem;
+  }
+
+  .enqueue-form-input {
+    box-sizing: border-box;
+    display: block;
+    height: auto;
+    min-height: 2.25rem;
+    width: 100%;
+  }
+
+  .enqueue-form-hint {
+    display: block;
+    margin-top: 0.35rem;
+  }
+
+  .enqueue-form-actions {
+    margin-top: 1.5rem;
+  }
+</style>
+
+<script nonce="<%= csp_nonce %>">
+  localStorage.sidekiqLivePoll = "disabled";
+</script>
+
+<% available_jobs = [] %>
+<% available_jobs_error = nil %>
+<% begin %>
+  <% available_jobs = Sidekiq::Enqueue::Services::AvailableJobs.call %>
+<% rescue StandardError %>
+  <% available_jobs_error = t('sidekiq_enqueue_jobs_load_error', default: 'Unable to load available jobs.') %>
+<% end %>
+
+<div class="enqueue-form-container">
+  <h3 class="enqueue-form-title"><%= t('sidekiq_enqueue') %></h3>
+
+  <% if defined?(@enqueue_error) && @enqueue_error %>
+    <div class="alert alert-danger" role="alert">
+      <%= @enqueue_error.message %>
+    </div>
+  <% end %>
+
+  <form action="<%= root_path %>enqueue" method="post" id="enqueue-form" class="enqueue-form">
+    <%= csrf_tag %>
+
+    <div class="form-group string enqueue-form-group">
+      <label for="job_name" class="enqueue-form-label"><%= t('sidekiq_enqueue_job_name') %></label>
+      <input class="form-control enqueue-form-input" type="text" name="job_name" id="job_name" list="available_jobs" autocomplete="off" />
+      <datalist id="available_jobs">
+        <% available_jobs.each do |job_name| %>
+          <option value="<%= job_name %>"></option>
+        <% end %>
+      </datalist>
+      <% if available_jobs_error %>
+        <small class="hint enqueue-form-hint text-danger"><%= available_jobs_error %></small>
+      <% end %>
+      <small class="hint enqueue-form-hint"><%= t('sidekiq_enqueue_job_name_hint', default: 'Search for or enter the worker class name to enqueue.') %></small>
     </div>
-  </div>
 
-  <div class="form-group row">
-    <label class="col-sm-2 col-form-label" for="arguments"><%= t('sidekiq_enqueue_arguments') %></label>
-    <div class="col-sm-4">
-      <input class="form-control" type="text" name="arguments" id="arguments" />
+    <div class="form-group string enqueue-form-group">
+      <label for="arguments" class="enqueue-form-label"><%= t('sidekiq_enqueue_arguments') %></label>
+      <input class="form-control enqueue-form-input" type="text" name="arguments" id="arguments" autocomplete="off" />
+      <small class="hint enqueue-form-hint"><%= t('sidekiq_enqueue_arguments_hint', default: 'Enter a JSON array of arguments to pass to the job.') %></small>
     </div>
-  </div>
 
-  <div class="form-group row">
-    <div class="col-sm-4">
+    <div class="form-actions enqueue-form-actions">
       <button type="submit" class="btn btn-danger"><%= t('sidekiq_enqueue_submit') %></button>
     </div>
-  </div>
-</form>
+  </form>
+</div>

data/lib/sidekiq/enqueue/web.rb

@@ -5,6 +5,7 @@ require "pathname"
 ROUTE_PATH = File.expand_path("web/routes", __dir__)
 
 require_relative "services/enqueue"
+require_relative "services/available_jobs"
 
 require_relative "web/routes/enqueue"
 require_relative "web/routes/index"

data/sidekiq-enqueue.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/sidekiq/enqueue/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sidekiq-enqueue"
+  spec.version = Sidekiq::Enqueue::VERSION
+  spec.authors = ["Jordan Ell"]
+  spec.email = ["jordan.ell@riipen.com"]
+
+  spec.summary = "Manually enqueue Sidekiq jobs from the web UI."
+  spec.homepage = "https://github.com/riipen/sidekiq-enqueue"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/riipen/sidekiq-enqueue/blob/master/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "rspec", "~> 3.12.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.6.0"
+  spec.add_development_dependency "rubocop", "~> 1.69.2"
+  spec.add_development_dependency "rubocop-rspec", "~> 3.0.4"
+
+  spec.add_dependency "sidekiq", "< 9"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-enqueue
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jordan Ell
@@ -85,14 +85,14 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 email:
 - jordan.ell@riipen.com
 executables: []
@@ -110,6 +110,7 @@ files:
 - README.md
 - Rakefile
 - lib/sidekiq/enqueue.rb
+- lib/sidekiq/enqueue/services/available_jobs.rb
 - lib/sidekiq/enqueue/services/enqueue.rb
 - lib/sidekiq/enqueue/version.rb
 - lib/sidekiq/enqueue/web.rb
@@ -117,6 +118,7 @@ files:
 - lib/sidekiq/enqueue/web/routes/enqueue.rb
 - lib/sidekiq/enqueue/web/routes/index.rb
 - lib/sidekiq/enqueue/web/templates/index.html.erb
+- sidekiq-enqueue.gemspec
 homepage: https://github.com/riipen/sidekiq-enqueue
 licenses:
 - MIT
@@ -131,14 +133,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Manually enqueue Sidekiq jobs from the web UI.
 test_files: []