renames DSL module to Dsl

Author: moofkit

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## [Unreleased]
 
+- Rename `Sidekiq::Rescue::DSL` to `Sidekiq::Rescue::Dsl`
+
 ## [0.1.0] - 2024-01-20
 
 - Initial release

README.md

@@ -37,7 +37,7 @@ end
 ```ruby
 class MyJob
   include Sidekiq::Job
-  include Sidekiq::Rescue::DSL
+  include Sidekiq::Rescue::Dsl
 
   sidekiq_rescue ExpectedError
 
@@ -54,7 +54,7 @@ You can configure the number of retries and the delay (in seconds) between retri
 ```ruby
 class MyJob
   include Sidekiq::Job
-  include Sidekiq::Rescue::DSL
+  include Sidekiq::Rescue::Dsl
 
   sidekiq_rescue ExpectedError, delay: 60, limit: 5
 

lib/sidekiq/rescue.rb

@@ -4,13 +4,13 @@ module Sidekiq
   # Sidekiq::Rescue is a Sidekiq plugin which allows you to easily handle
   # exceptions thrown by your jobs.
   #
-  # To use Sidekiq::Rescue, you need to include Sidekiq::Rescue::DSL module
+  # To use Sidekiq::Rescue, you need to include Sidekiq::Rescue::Dsl module
   # in your job class and use the sidekiq_rescue class method to define
   # exception handlers.
   #
   #     class MyJob
   #       include Sidekiq::Job
-  #       include Sidekiq::Rescue::DSL
+  #       include Sidekiq::Rescue::Dsl
   #
   #       sidekiq_rescue NetworkError, delay: 60, limit: 10
   #

lib/sidekiq/rescue/dsl.rb

@@ -2,15 +2,15 @@
 
 module Sidekiq
   module Rescue
-    # This module is included into the job class to provide the DSL for
+    # This module is included into the job class to provide the Dsl for
     # configuring rescue options.
-    module DSL
+    module Dsl
       def self.included(base)
         base.extend(ClassMethods)
         base.sidekiq_class_attribute(:sidekiq_rescue_options)
       end
 
-      # Module containing the DSL methods
+      # Module containing the Dsl methods
       module ClassMethods
         # Configure rescue options for the job.
         # @param error [StandardError] The error class to rescue.
@@ -62,5 +62,9 @@ def validate_limit_argument(limit)
         end
       end
     end
+    # Alias for Dsl; TODO: remove in 1.0.0
+    # @deprecated
+    # @see Dsl
+    DSL = Dsl
   end
 end

spec/sidekiq/rescue/dsl_spec.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-RSpec.describe Sidekiq::Rescue::DSL do
+RSpec.describe Sidekiq::Rescue::Dsl do
   let(:job_class) do
     Class.new do
       include Sidekiq::Job
-      include Sidekiq::Rescue::DSL
+      include Sidekiq::Rescue::Dsl
     end
   end
 

spec/support/jobs.rb

@@ -2,7 +2,7 @@
 
 class BaseJob
   include Sidekiq::Job
-  include Sidekiq::Rescue::DSL
+  include Sidekiq::Rescue::Dsl
 end
 
 class WithTestErrorJob < BaseJob