sidekiq-belt 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 300d0c79beb050fe381ebbc075dc66f59454eda2fa01fc0fdcbb8b1945cd2140
-  data.tar.gz: 875c38988275047a9fb6f3293aa68ac0c1d0ca0733b02025f20397b2980d295a
+  metadata.gz: fb4d769018b00b231892ae9852e6fd7d8c51074f6752332fa46ce6e606d68ba7
+  data.tar.gz: 9b05f6c1a3a505c7e6028bd6248f07ed7964a307129d7f8fc3206d96817c2b61
 SHA512:
-  metadata.gz: b8c6e92eeea82ce664ee76a9670561173b927d699dc44cb3bd8bb762c29a95c8f73cfb63fa81a0ce2646896d8bcd4aeaf29cf9ea796a3edf690f3f139198b38e
-  data.tar.gz: bdfc0a9b7662c086c3743e6825e0356ee79f5dd17db3fd24750e9dd8b8b6e34c0ae5589ae2a7ce01ed8d61a852d6fbd1f82c89a55547abb429a43269b442d389
+  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

@@ -116,6 +116,35 @@ Sidekiq::Belt.configure do |config|
 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
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

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

@@ -3,6 +3,7 @@
 require "sidekiq"
 
 require_relative "run_job"
+require_relative "top_label"
 
 module Sidekiq
   module Belt
@@ -10,6 +11,7 @@ module Sidekiq
       module Files
         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

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/version.rb

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

data/lib/sidekiq/belt.rb

@@ -25,7 +25,15 @@ module Sidekiq
     end
 
     def self.config
-      @config ||= Struct.new(:run_jobs).new([])
+      @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.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Danilo Jeremias da Silva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2024-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -43,6 +43,7 @@ files:
 - 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