sidekiq-tasks 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66094bc7c16bfcdf4a54af810f3cc6b277ec26f16c45644bd87d234fcf5108fa
-  data.tar.gz: 5f7858178970a54368b222deabeb83221015bd2a7ff7d591d0368f4cda4366cb
+  metadata.gz: b815ea42b8cc57ba73f3711e735fda709755b75c282e200dc18ab5287eadfdd6
+  data.tar.gz: 3e3e652e28ae9ee632452e89bab64bf34db9d4961a6b1eb7e5ff05914cfca3e3
 SHA512:
-  metadata.gz: 248e0b836f29e9145fd146907cb59c53d59d54ea3dcca8359368d93e9841d94108b418b7f2af23127f2ee5e9d4679c700ecab8a962b90d4fe7261d1178333912
-  data.tar.gz: 0024c156a0b2c334dc7c1dbd0fc235a1a98e33ccb838f1f28a118c13644f9feb00b6693941137ad746cb7ad7c98b419d972dcb8a54a50320e9395f8c5b7f4ff7
+  metadata.gz: 53cb0abf54140641134acaf350bf51bf989f3b8d454359fe2b3f32a9ad1937d6257b06de3a000e602f3a63a217e475c4229c23712a88987731a27cab73485d29
+  data.tar.gz: 854ef40802df6e3d3cd6eda1eae39df3aff31efc8d1e82c69ae201b1ca3576060fcd9dd3bb71e7bfc6b1c8275f6db7169c61fcaabd84da18be121b3a9c0e55d6

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.0
   NewCops: disable
   SuggestExtensions: false
 

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### [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

@@ -56,10 +56,20 @@ task :my_task do
 end
 ```
 
+You can also use `DisableWithComment` rule to selectively **exclude** 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 +77,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/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,28 @@ 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
+            lines = relevant_lines(task)
 
-            valid_magic_comment_line?(lines)
-          rescue Errno::ENOENT
-            raise ArgumentError, "File '#{file}' not found"
+            return false if lines.first.match?(/namespace/)
+
+            lines.any? { |line| line.strip.match?(magic_comment_regex) }
           end
 
-          private
+          protected
 
-          def valid_magic_comment_line?(lines)
-            return false if lines.first.match?(/namespace/)
+          def magic_comment_regex
+            /sidekiq-tasks:enable/
+          end
+
+          private
 
-            lines.any? { |line| line.strip.match?(MAGIC_COMMENT_REGEX) }
+          def relevant_lines(task)
+            file, start_line = task.locations.first.split(":")
+            start_line_counting_desc = start_line.to_i > 2 ? start_line.to_i - 3 : 0
+            File.read(file).split("\n")[start_line_counting_desc..start_line_counting_desc + 1].reverse
+          rescue Errno::ENOENT
+            raise ArgumentError, "File '#{file}' not found"
           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.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-tasks
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Victor
@@ -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:
   - - ">="