sidekiq-belt 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1d58a367e0ec0d41fb826a95a5b61cc59c6431fd5d50f235786cb3521e1ac69
-  data.tar.gz: 2cf1947d6e5ca5b54fe9989ec5a30e09923474412bce3d65475a13aa693d29fd
+  metadata.gz: fb4d769018b00b231892ae9852e6fd7d8c51074f6752332fa46ce6e606d68ba7
+  data.tar.gz: 9b05f6c1a3a505c7e6028bd6248f07ed7964a307129d7f8fc3206d96817c2b61
 SHA512:
-  metadata.gz: 8f8b2a0e54438fc416a638c3de38bcdccd187eea0363863d33ec04a2aa97dfc97983548445ab1f7f15148837123dccdad11cc47274ac59287e473c1223189b78
-  data.tar.gz: 6467a245b671d70c33b759b579f1ea12d4adf48c0bde494979e39d8c6663468859fc147f9f9add16ac967a9249e3ae6ac50476078fb59629167a14d5aeffa610
+  metadata.gz: d7c1f6c6ef57da7f982bc3c1c2cfc8ffec1982ed0030a37f9b829fc9ff4e2dcabd1f606283d81014e668fa1063504f6b2dcf77837b45939a3654f91d5f99354b
+  data.tar.gz: 6cb88155712149c79268f4f0a27a49c81e60eccc890c6eed0a1a9c29b9697ff561d9730f333c16b428bbf3ca0b50a2857da1439e7b049f367b8511b3b269af3a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.3.4] - 2024-01-07
+
+- Feature top label
+
+## [0.3.3] - 2024-06-11
+
+- Feature list to run jobs
+
 ## [0.3.2] - 2024-01-07
 
 - Feature to sort periodic list by class name

data/README.md

@@ -80,6 +80,70 @@ Sidekiq::Belt.use!([:failed_batch_remove])
 ```
 ![failed_batch_remove](https://github.com/dannnylo/sidekiq-belt/assets/20794/e285a8b2-4626-48e1-b04a-5190ae51d43b)
 
+### Create a list of jobs to run (sidekiq)
+This feature is a manual job manager where you can list jobs. These jobs are grouped and organized in a `Run Jobs` tab.
+You can easily and quickly select which job you want to run manually.
+
+To enable this feature, pass the `run_job` option:
+```ruby
+Sidekiq::Belt.use!([:run_job])
+```
+
+![List jobs to run](https://github.com/dannnylo/sidekiq-belt/assets/20794/ed32dac7-46e2-4c44-b3de-69983c3b990c)
+
+To configure the list of jobs
+
+```ruby
+Sidekiq::Belt.configure do |config|
+  config.run_jobs = [
+    { class: "ManualClearDataWorker", args: ['a'] },
+    { class: "ManualDoSomethingWorker", args: ['b'] },
+    { class: "FirstOperationalWorker", args: ['c'], group: 'Operational' },
+    { class: "SecondOperationalWorker", args: ['d'], group: 'Operational' },
+    { class: "AnotherGroupWorker", args: ['e'], group: 'Group with a long name' }
+  ]
+end
+```
+Or
+
+```ruby
+Sidekiq::Belt.configure do |config|
+  config.run_jobs.push({ class: "AWorker", args: ["a"] })
+  config.run_jobs.push({ class: "BWorker" })
+
+  config.run_jobs << { class: "CWorker", args: ["a"], group: "Etc" }
+  config.run_jobs << { class: "DWorker", args: ["a"], group: "Etc" }
+end
+```
+
+### Add to your web sidekiq a top label by enviroment (sidekiq)
+
+This feature adds a little line on top of Sidekiq web that shows a configurable message.
+
+![Top Page Development](https://github.com/dannnylo/sidekiq-belt/assets/20794/b1e2f6c2-a257-4172-92ec-09c61511334b)
+![Top Page Production](https://github.com/dannnylo/sidekiq-belt/assets/20794/8e64d0e8-dcb2-42ee-b184-67d2f0b2cf6f)
+
+To enable this feature, pass the `top_label` option:
+```ruby
+Sidekiq::Belt.use!([:top_label])
+```
+
+```ruby
+Sidekiq::Belt.configure do |config|
+  config.top_label = {
+    production: {
+      background_color: 'red',
+      text: 'Be carefull',
+      color: 'white'
+    },
+    development: {
+      background_color: 'green',
+      text: 'You are safe!',
+      color: 'white'
+    }
+  }
+end
+```
 
 ## Development
 

data/lib/sidekiq/belt/community/files.rb

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
 
 require "sidekiq"
-# require_relative "feature"
+
+require_relative "run_job"
+require_relative "top_label"
 
 module Sidekiq
   module Belt
     module Community
       module Files
-        def self.use!(_options = [:all])
-          # all = options.include?(:all)
-          # Sidekiq::Belt::Pro::Feature.load! if all || options.include?(:feature)
+        def self.use!(options = [:all])
+          Sidekiq::Belt::Community::RunJob.use! if should_use?(:run_job, options)
+          Sidekiq::Belt::Community::TopLabel.use! if should_use?(:top_label, options)
 
           true
         end
+
+        def self.should_use?(key, options)
+          options.include?(:all) || options.include?(key)
+        end
       end
     end
   end

data/lib/sidekiq/belt/community/run_job.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "sidekiq/web"
+require "sidekiq/web/helpers"
+
+module Sidekiq
+  module Belt
+    module Community
+      module RunJob
+        def self.list_grouped_jobs
+          jobs = {}
+          Sidekiq::Belt.config.run_jobs.each_with_index do |job, i|
+            job.transform_keys(&:to_sym)
+            job[:id] = i
+
+            jobs[job[:group].to_s] ||= []
+            jobs[job[:group].to_s] << job
+          end
+
+          jobs
+        end
+
+        def self.run_job(job_id)
+          job = Sidekiq::Belt.config.run_jobs[job_id.to_i]
+          job.transform_keys(&:to_sym)
+
+          Module.const_get(job[:class]).perform_async(*job.fetch(:args, []))
+        end
+
+        module SidekiqRunJob
+          def self.registered(app)
+            app.tabs["Run Jobs"] = "run_jobs"
+
+            app.get("/run_jobs") do
+              @jobs = Sidekiq::Belt::Community::RunJob.list_grouped_jobs
+
+              render(:erb, File.read(File.join(__dir__, "views/run_jobs.erb")))
+            end
+
+            app.post("/run_jobs/:rjid/run") do
+              Sidekiq::Belt::Community::RunJob.run_job(params[:rjid].to_i)
+
+              return redirect "#{root_path}run_jobs"
+            end
+          end
+        end
+
+        def self.use!
+          Sidekiq::Web.register(Sidekiq::Belt::Community::RunJob::SidekiqRunJob)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/belt/community/top_label.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "sidekiq/web"
+require "sidekiq/web/helpers"
+
+module Sidekiq
+  module Belt
+    module Community
+      module TopLabel
+        def self.use!
+          Sidekiq::WebActionHelper.change_layout do |content|
+            top_label = (Sidekiq::Belt.config.top_label || {}).fetch(Sidekiq::Belt.env, {})
+
+            html = "<div class='container-fluid'
+                         style='background: #{::Rack::Utils.escape_html(top_label.fetch(:background_color, "red"))};
+                                text-align: center;
+                                color: #{::Rack::Utils.escape_html(top_label.fetch(:color, "white"))};'>
+                      &nbsp;#{::Rack::Utils.escape_html(top_label[:text].to_s)}&nbsp;
+                    </div>"
+            unless top_label.empty?
+              content.gsub!('<div class="container-fluid">',
+                            "#{html} <div class='container-fluid'>")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/belt/community/views/run_jobs.erb

@@ -0,0 +1,30 @@
+<% @jobs.each do |group, jobs| %>
+  <div class="header-container">
+    <h1><%= group %></h1>
+  </div>
+
+  <div class="table_container">
+    <table class="queues table table-hover table-bordered table-striped">
+      <thead>
+        <th><%= t('Class') %></th>
+        <th><%= t('Args') %></th>
+        <th><%= t('Run') %></th>
+      </thead>
+      <tbody>
+      <% jobs.each do |job| %>
+        <tr>
+          <td><%= job[:class] %></td>
+          <td><%= job[:args].inspect %></td>
+          <td style='width: 100px'>
+            <form action="<%= root_path %>run_jobs/<%= job[:id] %>/run" method="post">
+              <%= csrf_tag %>
+              <input class="btn btn-danger" type="submit" name="run" value="<%= t('Run') %>"
+                data-confirm="Run the job <%= job[:klass] %>? <%= t('AreYouSure') %>" />
+            </form>
+          </td>
+        </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </div>
+<% end %>

data/lib/sidekiq/belt/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Belt
-    VERSION = "0.3.2"
+    VERSION = "0.3.4"
   end
 end

data/lib/sidekiq/belt.rb

@@ -19,5 +19,21 @@ module Sidekiq
       Sidekiq::Belt::Pro::Files.use!(options)
       Sidekiq::Belt::Ent::Files.use!(options)
     end
+
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= Struct.new(:run_jobs, :top_label).new([], {})
+    end
+
+    def self.env
+      (Sidekiq.default_configuration[:environment] ||
+        ENV["APP_ENV"] ||
+        ENV["RAILS_ENV"] ||
+        ENV["RACK_ENV"] ||
+        "development").to_sym
+    end
   end
 end

data/lib/sidekiq/web_action_helper.rb

@@ -22,6 +22,23 @@ module Sidekiq
 
       super(engine, content, options)
     end
+
+    def self.change_layout(&block)
+      Sidekiq::Config::DEFAULTS[:layout_changes] ||= []
+      Sidekiq::Config::DEFAULTS[:layout_changes] << block
+    end
+
+    def _render
+      content = super
+
+      layout_changes = Sidekiq::Config::DEFAULTS[:layout_changes] || []
+
+      layout_changes.each do |content_block|
+        content_block.call(content)
+      end
+
+      content
+    end
   end
 
   Sidekiq::WebAction.prepend(Sidekiq::WebActionHelper)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-belt
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Danilo Jeremias da Silva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2024-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -42,6 +42,9 @@ files:
 - lib/sidekiq-belt.rb
 - lib/sidekiq/belt.rb
 - lib/sidekiq/belt/community/files.rb
+- lib/sidekiq/belt/community/run_job.rb
+- lib/sidekiq/belt/community/top_label.rb
+- lib/sidekiq/belt/community/views/run_jobs.erb
 - lib/sidekiq/belt/ent/files.rb
 - lib/sidekiq/belt/ent/periodic_pause.rb
 - lib/sidekiq/belt/ent/periodic_run.rb
@@ -74,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: This Ruby gem enhances the capabilities of Sidekiq, Sidekiq Pro, and Sidekiq