sidekiq-history 0.0.13 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85c133e8ace68f1c2e531a3da68ac485748ab39bbc5318fe5545de83506cd142
-  data.tar.gz: b95fa6fce1c361fdf01a850ee982622e5e388e96c92de03f1bbfd7d858f14fa4
+  metadata.gz: c404f059cd1a45ea45b25adb559c200f8b24f868033c32239f874e40c2b714a3
+  data.tar.gz: 94fda5da0c6e402a9616e8a636db3607ea05de87e887418c06120ea80f064067
 SHA512:
-  metadata.gz: a029e21aed70b4fb114348a198625662841b6e27ae77ca10f0011b5cac21cec09c70dd146233de05438b0bc22fd69b58ae5d733cac488d15f17d68b9b9ade88b
-  data.tar.gz: 7889ff8d064889abfdf523b4a51d0feb7cb6dcb042060f57416dd2019271e9ae253ae9c82836e957e1db54043a405a66d2b9b23bc7f09ad85a4a6d6ff9f2939f
+  metadata.gz: 6ede8ecd3321e7fb2863ac8e304eba3628f7f1b68cf6d1f80137dbb5a3c047df80043cf63dcda5a7a9fac481eb5eb18b47c9c9b489535807eac0981fe3620d73
+  data.tar.gz: 5608de67eb33fa6d25f31c25a3885806ad3d9280ca22149a8ac872db0123c5b832785cf1d24d7dc81a972d9128c79b4f4ace3fb54c337d44c5b014cc157db934

data/lib/sidekiq/history/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module History
-    VERSION = '0.0.13'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/sidekiq/history/web_extension.rb

@@ -3,35 +3,57 @@ module Sidekiq
     module WebExtension
       ROOT = File.expand_path('../../../web', __dir__)
 
+      # Helpers module provides utility methods for the Sidekiq History web extension.
+      module Helpers
+        # Fetches the query parameters or body from the request based on the Sidekiq version.
+        #
+        # Sidekiq 8.0 recommended `url_params` as a replacement for `params`.
+        # This method ensures compatibility with both older and newer versions of Sidekiq.
+        #
+        # @param key [String] The key to fetch from the request.
+        # @return [String, nil] The value associated with the key, or nil if not found.
+        def request_params(key)
+          if Gem::Dependency.new('', '>= 8.0.0').match?('', Gem.loaded_specs['sidekiq'].version)
+            url_params(key.to_s)
+          else
+            params[key]
+          end
+        end
+      end
+
       def self.registered(app)
+        app.helpers Helpers
+
         app.get '/history' do
-          @count = (params[:count] || 25).to_i
-          (@current_page, @total_size, @messages) = page('history', params[:page], @count, reverse: true)
+          @count = (request_params(:count) || 25).to_i
+          (@current_page, @total_size, @messages) = page('history', request_params(:page), @count, reverse: true)
           @messages = @messages.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
 
           render(:erb, File.read("#{ROOT}/views/history.erb"))
         end
 
         app.post '/history/remove' do
-          Sidekiq::History.reset_history(counter: params['counter'])
+          Sidekiq::History.reset_history(counter: request_params(:counter))
           redirect("#{root_path}history")
         end
 
         app.get '/filter/history' do
-          return redirect "#{root_path}history" unless params[:substr]
+          return redirect "#{root_path}history" unless request_params(:substr)
 
-          @messages = search(HistorySet.new, params[:substr])
+          @messages = search(HistorySet.new, request_params(:substr))
           render(:erb, File.read("#{ROOT}/views/history.erb"))
         end
 
         app.post '/filter/history' do
-          return redirect "#{root_path}history" unless params[:substr]
+          return redirect "#{root_path}history" unless request_params(:substr)
 
-          @messages = search(HistorySet.new, params[:substr])
+          @messages = search(HistorySet.new, request_params(:substr))
           render(:erb, File.read("#{ROOT}/views/history.erb"))
         end
 
-        app.settings.locales << File.expand_path('locales', ROOT)
+        if Gem::Dependency.new('', '< 8.0.0').match?('', Gem.loaded_specs['sidekiq'].version)
+          app.settings.locales << File.expand_path('locales', ROOT)
+        end
       end
     end
   end

data/lib/sidekiq/history.rb

@@ -74,11 +74,22 @@ Sidekiq.configure_server do |config|
   end
 end
 
-Sidekiq::Web.register(Sidekiq::History::WebExtension)
-
-if Sidekiq::Web.tabs.is_a?(Array)
-  # For sidekiq < 2.5
-  Sidekiq::Web.tabs << 'history'
+# for Sidekiq >= 8.0.0
+if Gem::Dependency.new('', '>= 8.0.0').match?('', Gem.loaded_specs['sidekiq'].version)
+  Sidekiq::Web.configure do |config|
+    config.register_extension(Sidekiq::History::WebExtension,
+                              name: 'History',
+                              tab: 'History',
+                              index: 'history',
+                              root_dir: File.expand_path('../../web', __dir__))
+  end
 else
-  Sidekiq::Web.tabs['History'] = 'history'
+  Sidekiq::Web.register(Sidekiq::History::WebExtension)
+
+  if Sidekiq::Web.tabs.is_a?(Array)
+    # For Sidekiq < 2.5
+    Sidekiq::Web.tabs << 'history'
+  else
+    Sidekiq::Web.tabs['History'] = 'history'
+  end
 end

data/sidekiq-history.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "sidekiq", ">= 6.5.0"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", ">= 2.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rack-test"
   spec.add_development_dependency "sprockets"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-history
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 1.0.0
 platform: ruby
 authors:
 - Russ Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-27 00:00:00.000000000 Z
+date: 2025-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: History for sidekiq jobs.