From 4fc0c3bcc09875f82add1864c7cf20135e8ff893 Mon Sep 17 00:00:00 2001
From: Rafael <rafaeelaudibert@gmail.com>
Date: Fri, 21 Jul 2023 03:42:42 -0300
Subject: [PATCH] :sparkles: Allow to configure if raises with no limits

---
 lib/clock/limiter/configuration.rb | 18 +++++++++++++++
 lib/clock/limiter/limiter.rb       |  9 ++++++--
 test/clock/limiter_test.rb         | 35 ++++++++++++++++++++++++++++++
 3 files changed, 60 insertions(+), 2 deletions(-)

diff --git a/lib/clock/limiter/configuration.rb b/lib/clock/limiter/configuration.rb
index 5949ff0..5f51c9e 100644
--- a/lib/clock/limiter/configuration.rb
+++ b/lib/clock/limiter/configuration.rb
@@ -14,6 +14,7 @@ def redis=(redis)
         @redis = redis
       end
 
+      # @return [::Redis]
       def redis
         raise ConfigurationError, 'Redis not configured' if @redis.nil?
 
@@ -27,11 +28,28 @@ def time_provider=(time_provider)
         @time_provider = time_provider
       end
 
+      # @return [Proc]
       def time_provider
         raise ConfigurationError, 'Time provider not configured' if @time_provider.nil?
 
         @time_provider
       end
+
+      # @param fail_with_empty_limits [Boolean]
+      def fail_with_empty_limits=(fail_with_empty_limits)
+        unless [true, false].include?(fail_with_empty_limits)
+          raise ConfigurationError, '`fail_with_empty_limits` must be a boolean'
+        end
+
+        @fail_with_empty_limits = fail_with_empty_limits
+      end
+
+      # @return [Boolean] - true by default
+      def fail_with_empty_limits?
+        return @fail_with_empty_limits unless @fail_with_empty_limits.nil?
+
+        true
+      end
     end
   end
 end
diff --git a/lib/clock/limiter/limiter.rb b/lib/clock/limiter/limiter.rb
index 7d3b65c..5547db6 100644
--- a/lib/clock/limiter/limiter.rb
+++ b/lib/clock/limiter/limiter.rb
@@ -63,9 +63,9 @@ def on_clock_limit_failure(&block)
     # @raise [NoLimitsError] If no limits have been set
     # @raise [Clock::Limiter::Period::InvalidError] If an invalid period has been set
     def with_clock_limiter(limit_key = self.class.name)
-      raise NoLimitsError if self.class.clock_limits.nil? || self.class.clock_limits.empty?
+      raise NoLimitsError if fail_with_empty_limits?
 
-      self.class.clock_limits.each do |limit|
+      self.class.clock_limits&.each do |limit|
         next if within_limit?(limit, limit_key)
 
         return self.class.on_clock_limit_failure_block&.call(limit, limit_key)
@@ -76,6 +76,11 @@ def with_clock_limiter(limit_key = self.class.name)
 
     private
 
+    def fail_with_empty_limits?
+      Clock::Limiter.configuration.fail_with_empty_limits? &&
+        (self.class.clock_limits.nil? || self.class.clock_limits.empty?)
+    end
+
     # Increments the value of the key and returns true if the limit has not
     # been reached. If the limit has been reached, false will be returned.
     #
diff --git a/test/clock/limiter_test.rb b/test/clock/limiter_test.rb
index 00ed0ee..0032c98 100644
--- a/test/clock/limiter_test.rb
+++ b/test/clock/limiter_test.rb
@@ -91,12 +91,47 @@ def call
     assert_equal ['key_b'], failed_groups
   end
 
+  def test_fails_with_empty_limit
+    configure_gem
+
+    my_class = Class.new do
+      include Clock::Limiter
+
+      def call
+        with_clock_limiter {}
+      end
+    end
+
+    assert_raises(Clock::Limiter::NoLimitsError) { my_class.new.call }
+  end
+
+  def test_doesnt_fail_with_empty_limit_if_properly_configured
+    configure_gem
+
+    Clock::Limiter.configure do |config|
+      config.fail_with_empty_limits = false
+    end
+
+    my_class = Class.new do
+      include Clock::Limiter
+
+      def call
+        with_clock_limiter {}
+      end
+    end
+
+    my_class.new.call
+
+    assert true
+  end
+
   private
 
   def configure_gem
     Clock::Limiter.configure do |config|
       config.redis = Redis.new
       config.time_provider = -> { Time.now }
+      config.fail_with_empty_limits = true
     end
   end
 end