sidekiq-tasks 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66094bc7c16bfcdf4a54af810f3cc6b277ec26f16c45644bd87d234fcf5108fa
-  data.tar.gz: 5f7858178970a54368b222deabeb83221015bd2a7ff7d591d0368f4cda4366cb
+  metadata.gz: 9f8d4001fa7c85be52975408343d261f87b68da263508e6a97e23d2327685121
+  data.tar.gz: a0e978fd7ea7a0959571d9c635cbecf667d319f14e3424cbd68bf90f4f936db6
 SHA512:
-  metadata.gz: 248e0b836f29e9145fd146907cb59c53d59d54ea3dcca8359368d93e9841d94108b418b7f2af23127f2ee5e9d4679c700ecab8a962b90d4fe7261d1178333912
-  data.tar.gz: 0024c156a0b2c334dc7c1dbd0fc235a1a98e33ccb838f1f28a118c13644f9feb00b6693941137ad746cb7ad7c98b419d972dcb8a54a50320e9395f8c5b7f4ff7
+  metadata.gz: 83bfda60244fda1c62876d2ea6f8a0d61f32e558c0492fd28ac4936d32fc601969c5b676ac18b21d9533796b4e21de9f57ff509b65acb253d0b5d635f52b2249
+  data.tar.gz: 15ec2cf69ea14409f2c852c3fc3c82ffb49dabaedaccccf93084b86d88099d328f6a2b8f03e57578acff9a2272d2782a4653dc42d46c8f76625ad287bf5ab0fb

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.0
   NewCops: disable
   SuggestExtensions: false
 
@@ -33,7 +33,7 @@ Metrics/PerceivedComplexity:
 
 Naming/FileName:
   Exclude:
-    - lib/sidekiq/sidekiq-tasks.rb
+    - lib/sidekiq-tasks.rb
 
 Naming/MemoizedInstanceVariableName:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## Changelog
 
+### [0.1.4] - 2025-03-23
+
+- Fix gem load error by moving the entrypoint to the correct path.
+- Support enabling/disabling all tasks in a namespace with a magic comment.
+- Improve task search to allow more flexible and intuitive matching.
+- Fix deprecation warning by avoiding direct access to `params` (Sidekiq 8 compatibility).
+
+### [0.1.3] - 2025-03-22
+
+- Change required Ruby version to 3.0.0.
+- Add `DisableWithComment` rule to disable a specific task with a magic comment.
+
 ### [0.1.2] - 2025-03-22
 
 - Update plugin registration for Sidekiq 7.3+ compatibility.

data/README.md

@@ -47,7 +47,7 @@ By default, it comes with the `Sidekiq::Tasks::Strategies::RakeTask` strategy, w
 > - **`TaskFromLib`** Only tasks from the `lib` folder are loaded.
 > - **`EnableWithComment`** Only tasks explicitly enabled with a magic comment are loaded.
 
-Example of an available task in `lib/tasks/my_task.rake`:
+Example of an enabled task in `lib/tasks/my_task.rake`:
 
 ```ruby
 # sidekiq-tasks:enable
@@ -56,10 +56,35 @@ task :my_task do
 end
 ```
 
+Enable all tasks within a namespace:
+
+```ruby
+# sidekiq-tasks:enable
+namespace :my_namespace do
+  task :my_task do
+    puts "my_task"
+  end
+
+  task :another_task do
+    puts "another_task"
+  end
+end
+```
+
+You can also use `DisableWithComment` rule to selectively **disable** tasks. (see [strategies configuration](#strategies-configuration))
+It works similarly to `EnableWithComment`, but with inverted logic. Example of a disabled task:
+
+```ruby
+# sidekiq-tasks:disable
+task :my_task do
+  puts "my_task"
+end
+```
+
 ## Strategies configuration
 
 Strategies can be configured through the `config.strategies` option.
-For example if you want to remove the `EnableWithComment` rule from the default strategy and enable all tasks from the `lib` folder:
+For example if you want to enable all tasks in the lib folder and disable a few specific ones manually:
 
 ```ruby
 Sidekiq::Tasks.configure do |config|
@@ -67,6 +92,7 @@ Sidekiq::Tasks.configure do |config|
     Sidekiq::Tasks::Strategies::RakeTask.new(
       rules: [
         Sidekiq::Tasks::Strategies::Rules::TaskFromLib.new,
+        Sidekiq::Tasks::Strategies::Rules::DisableWithComment.new,
       ]
     )
   ]

data/lib/sidekiq/tasks/set.rb

@@ -9,7 +9,12 @@ module Sidekiq
 
       def self.match?(object, attributes)
         attributes.any? do |attribute, value|
-          [nil, ""].include?(value) || object.public_send(attribute)&.match?(value)
+          next true if [nil, ""].include?(value)
+
+          object_value = object.public_send(attribute).to_s.downcase.gsub(/[^a-z0-9]/, "")
+          search_fragments = value.to_s.downcase.gsub(/[^a-z0-9\s]/, "").split
+
+          search_fragments.all? { |fragment| object_value.include?(fragment) }
         end
       end
 

data/lib/sidekiq/tasks/strategies/rules/disable_with_comment.rb

@@ -0,0 +1,19 @@
+module Sidekiq
+  module Tasks
+    module Strategies
+      module Rules
+        class DisableWithComment < EnableWithComment
+          def respected?(task)
+            !super
+          end
+
+          protected
+
+          def magic_comment_regex
+            /sidekiq-tasks:disable/
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/tasks/strategies/rules/enable_with_comment.rb

@@ -3,24 +3,55 @@ module Sidekiq
     module Strategies
       module Rules
         class EnableWithComment < Base
-          MAGIC_COMMENT_REGEX = /sidekiq-tasks:enable/
-
           def respected?(task)
-            file, start_line = task.locations.first.split(":")
-            start_line_counting_desc = start_line.to_i > 2 ? start_line.to_i - 3 : 0
-            lines = File.read(file).split("\n")[start_line_counting_desc..start_line_counting_desc + 1].reverse
+            file, line_number = task.locations.first.split(":")
+            line_number = line_number.to_i
+
+            lines = read_file_lines(file)
+
+            return false if lines.nil?
+
+            return true if task_has_magic_comment?(lines, line_number)
+
+            namespace_line_index = find_namespace_line_index(lines, task)
+            return false unless namespace_line_index
 
-            valid_magic_comment_line?(lines)
+            namespace_has_magic_comment?(lines, namespace_line_index)
+          end
+
+          protected
+
+          def magic_comment_regex
+            /sidekiq-tasks:enable/
+          end
+
+          private
+
+          def read_file_lines(file)
+            File.read(file).split("\n")
           rescue Errno::ENOENT
             raise ArgumentError, "File '#{file}' not found"
           end
 
-          private
+          def task_has_magic_comment?(lines, task_line)
+            context_range = (task_line - 3..task_line).to_a.select { |i| i >= 0 }
+            context_range.reverse.any? do |i|
+              lines[i]&.strip&.match?(magic_comment_regex)
+            end
+          end
+
+          def find_namespace_line_index(lines, task)
+            namespace = namespace_name(task)
+            lines.find_index { |line| line.strip.match?(/^namespace\s+:#{Regexp.escape(namespace)}/) }
+          end
 
-          def valid_magic_comment_line?(lines)
-            return false if lines.first.match?(/namespace/)
+          def namespace_has_magic_comment?(lines, namespace_line_index)
+            comment_line = lines[namespace_line_index - 1]&.strip
+            comment_line&.match?(magic_comment_regex)
+          end
 
-            lines.any? { |line| line.strip.match?(MAGIC_COMMENT_REGEX) }
+          def namespace_name(task)
+            task.name.split(":").first
           end
         end
       end

data/lib/sidekiq/tasks/strategies/rules.rb

@@ -5,6 +5,7 @@ module Sidekiq
         autoload :Base, "sidekiq/tasks/strategies/rules/base"
         autoload :TaskFromLib, "sidekiq/tasks/strategies/rules/task_from_lib"
         autoload :EnableWithComment, "sidekiq/tasks/strategies/rules/enable_with_comment"
+        autoload :DisableWithComment, "sidekiq/tasks/strategies/rules/disable_with_comment"
       end
     end
   end

data/lib/sidekiq/tasks/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Tasks
-    VERSION = "0.1.2"
+    VERSION = "0.1.4"
   end
 end

data/lib/sidekiq/tasks/web/extension.rb

@@ -15,7 +15,7 @@ module Sidekiq
           app.helpers(Sidekiq::Tasks::Web::Helpers::PaginationHelper)
 
           app.get "/tasks" do
-            @search = Sidekiq::Tasks::Web::Search.new(params.transform_keys(&:to_sym))
+            @search = Sidekiq::Tasks::Web::Search.new(fetch_params(:count, :page, :filter))
 
             erb(read_view(:tasks), locals: {search: @search})
           end
@@ -29,12 +29,12 @@ module Sidekiq
           end
 
           app.post "/tasks/:name/enqueue" do
-            if params["env_confirmation"] != current_env
+            if fetch_param("env_confirmation") != current_env
               throw :halt, [400, {Rack::CONTENT_TYPE => "text/plain"}, ["Invalid confirm"]]
             end
 
             task = find_task!(env["rack.route_params"][:name])
-            args = Sidekiq::Tasks::Web::Params.new(task, params["args"]).permit!
+            args = Sidekiq::Tasks::Web::Params.new(task, fetch_param("args")).permit!
 
             task.enqueue(args)
 

data/lib/sidekiq/tasks/web/helpers/application_helper.rb

@@ -12,6 +12,18 @@ module Sidekiq
           def current_env
             ENV["RAILS_ENV"] || ENV["RACK_ENV"]
           end
+
+          def fetch_param(key)
+            if Sidekiq::Tasks::Web::SIDEKIQ_GTE_8_0_0
+              url_params(key.to_s)
+            else
+              params[key.to_s]
+            end
+          end
+
+          def fetch_params(*keys)
+            keys.to_h { |key| [key.to_sym, fetch_param(key)] }
+          end
         end
       end
     end

data/lib/sidekiq/tasks/web.rb

@@ -7,6 +7,7 @@ module Sidekiq
 
       ROOT = File.expand_path("../../../web", File.dirname(__FILE__))
       SIDEKIQ_GTE_7_3_0 = Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("7.3.0")
+      SIDEKIQ_GTE_8_0_0 = Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("8.0.0")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-tasks
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Victor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-22 00:00:00.000000000 Z
+date: 2025-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -238,7 +238,7 @@ files:
 - README.md
 - Rakefile
 - docs/task.png
-- lib/sidekiq/sidekiq-tasks.rb
+- lib/sidekiq-tasks.rb
 - lib/sidekiq/tasks.rb
 - lib/sidekiq/tasks/config.rb
 - lib/sidekiq/tasks/errors.rb
@@ -250,6 +250,7 @@ files:
 - lib/sidekiq/tasks/strategies/rake_task.rb
 - lib/sidekiq/tasks/strategies/rules.rb
 - lib/sidekiq/tasks/strategies/rules/base.rb
+- lib/sidekiq/tasks/strategies/rules/disable_with_comment.rb
 - lib/sidekiq/tasks/strategies/rules/enable_with_comment.rb
 - lib/sidekiq/tasks/strategies/rules/task_from_lib.rb
 - lib/sidekiq/tasks/task.rb
@@ -293,7 +294,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="