Merge pull request #49 from Shopify/rubocop

fix rubocop warnings

.rubocop.yml

@@ -1,5 +1,3 @@
-inherit_from: .rubocop_todo.yml
-
 inherit_gem:
   rubocop-shopify: rubocop.yml
 
@@ -10,3 +8,7 @@ require:
 AllCops:
   NewCops: enable
   TargetRubyVersion: 3.2
+
+Naming/FileName:
+  Exclude:
+    - 'lib/ruby-limiter.rb'

Gemfile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

Rakefile

@@ -10,4 +10,4 @@ Rake::TestTask.new(:test) do |t|
   t.warning = true
 end
 
-task default: :test
+task default: :test

bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'limiter'
+require "bundler/setup"
+require "limiter"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'limiter'
 # require 'pry'
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

bin/rake

@@ -9,8 +9,10 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

lib/limiter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'limiter/clock'
-require 'limiter/mixin'
-require 'limiter/rate_queue'
-require 'limiter/version'
+require "limiter/clock"
+require "limiter/mixin"
+require "limiter/rate_queue"
+require "limiter/version"

lib/limiter/clock.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'singleton'
-require 'forwardable'
+require "singleton"
+require "forwardable"
 
 module Limiter
   class Clock

lib/limiter/mixin.rb

@@ -16,7 +16,7 @@ def limit_method(method, rate:, interval: 60, balanced: false, &b)
         queue.reset
       end
 
-      prepend mixin
+      prepend(mixin)
     end
   end
 end

lib/limiter/rate_queue.rb

@@ -43,7 +43,8 @@ def shift
     def sleep_until(time)
       interval = time - clock.time
       return unless interval.positive?
-      @blk.call if @blk
+
+      @blk&.call
       clock.sleep(interval)
     end
 

lib/limiter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Limiter
-  VERSION = '2.3.0'
+  VERSION = "2.3.0"
 end

lib/ruby-limiter.rb

@@ -1 +1,3 @@
-require 'limiter'
+# frozen_string_literal: true
+
+require "limiter"

limiter.gemspec

@@ -1,41 +1,41 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'limiter/version'
+require "limiter/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'ruby-limiter'
+  spec.name          = "ruby-limiter"
   spec.version       = Limiter::VERSION
-  spec.authors       = ['S. Brent Faulkner']
-  spec.email         = ['brent.faulkner@shopify.com']
+  spec.authors       = ["S. Brent Faulkner"]
+  spec.email         = ["brent.faulkner@shopify.com"]
 
-  spec.summary       = 'Simple Ruby rate limiting mechanism.'
-  spec.homepage      = 'https://github.com/Shopify/limiter'
-  spec.license       = 'MIT'
+  spec.summary       = "Simple Ruby rate limiting mechanism."
+  spec.homepage      = "https://github.com/Shopify/limiter"
+  spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = %x(git ls-files -z).split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = %w(lib)
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'minitest', '~> 5.20'
-  spec.add_development_dependency 'minitest-focus', '~> 1.4'
-  spec.add_development_dependency 'mocha', '~> 2.1'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rubocop', '~> 1.57'
-  spec.add_development_dependency 'code-scanning-rubocop', '~> 0.6.1'
-  spec.add_development_dependency 'rubocop-shopify', '~> 2.14'
-  spec.add_development_dependency 'rubocop-minitest', '~> 0.33.0'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  spec.add_development_dependency("bundler")
+  spec.add_development_dependency("code-scanning-rubocop", "~> 0.6.1")
+  spec.add_development_dependency("minitest", "~> 5.20")
+  spec.add_development_dependency("minitest-focus", "~> 1.4")
+  spec.add_development_dependency("mocha", "~> 2.1")
+  spec.add_development_dependency("rake", "~> 13.0")
+  spec.add_development_dependency("rubocop", "~> 1.57")
+  spec.add_development_dependency("rubocop-minitest", "~> 0.33.0")
+  spec.add_development_dependency("rubocop-rake", "~> 0.6.0")
+  spec.add_development_dependency("rubocop-shopify", "~> 2.14")
 end

test/limiter/clock_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'test_helper'
+require "test_helper"
 
 module Limiter
   class ClockTest < Minitest::Test
@@ -10,7 +10,7 @@ def setup
     end
 
     def test_clock_is_advancing
-      assert Clock.time > @start_time
+      assert_operator(Clock.time, :>, @start_time)
     end
   end
 end

test/limiter/mixin_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'test_helper'
+require "test_helper"
 
 module Limiter
   class MixinTest < Minitest::Test
@@ -15,8 +15,8 @@ class MixinTestClass
 
       @limited = 0
 
-      def self.limited
-        @limited
+      class << self
+        attr_reader :limited
       end
 
       limit_method :tick, rate: RATE, interval: INTERVAL
@@ -89,25 +89,27 @@ def test_original_method_is_called
         @object.tick
       end
 
-      assert_equal COUNT, @object.ticks
+      assert_equal(COUNT, @object.ticks)
     end
 
     def test_arguments_are_passed
-      @object.tick 123
-      assert_equal 123, @object.ticks
+      @object.tick(123)
+
+      assert_equal(123, @object.ticks)
     end
 
     def test_default_keyword_arguments_are_passed
       COUNT.times do
         @object.tock
       end
 
-      assert_equal COUNT, @object.ticks
+      assert_equal(COUNT, @object.ticks)
     end
 
     def test_keyword_arguments_are_passed
       @object.tock(count: 321)
-      assert_equal 321, @object.ticks
+
+      assert_equal(321, @object.ticks)
     end
 
     def test_block_was_called_on_rate_limit