Merge pull request #148 from wecasa/rubocop

Rubocop setup

Author: deanpcmad

.github/workflows/ci.yml

@@ -36,6 +36,8 @@ jobs:
         bundler-cache: false
     - name: Bundle for Appraisal
       run: bundle
+    - name: Run Rubocop linting
+      run: bundle exec rubocop
     - name: Install Appraisal dependencies
       run: bundle exec appraisal sidekiq-${{ matrix.appraisal }} bundle
     - name: Run tests

.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'gemfiles/*'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'demo/Rakefile'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/sidekiq/limit_fetch/queues.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/sidekiq/limit_fetch/global/semaphore.rb'
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Naming/FileName:
+  Exclude:
+    - lib/sidekiq-limit_fetch.rb

Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise 'sidekiq-6.0' do
   gem 'sidekiq', '~> 6.0.0'
 end

Gemfile

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

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

bench/compare.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'benchmark'
 require 'sidekiq/cli'
 require 'sidekiq/api'
@@ -9,11 +11,11 @@
 if limit
   limit = nil if limit == 'nil'
 
-  $:.unshift File.expand_path '../lib'
+  $LOAD_PATH.unshift File.expand_path '../lib'
   require 'sidekiq-limit_fetch'
   Sidekiq::Queue['inline'].limit = limit
-  Sidekiq.redis {|it| it.del 'limit_fetch:probed:inline' }
-  Sidekiq::LimitFetch::Queues.send(:define_method, :set) {|*| }
+  Sidekiq.redis { |it| it.del 'limit_fetch:probed:inline' }
+  Sidekiq::LimitFetch::Queues.send(:define_method, :set) { |*| } # rubocop:disable Lint/EmptyBlock
 end
 
 Sidekiq::Queue.new('inline').clear
@@ -22,8 +24,8 @@ class FastJob
   include Sidekiq::Worker
   sidekiq_options queue: :inline
 
-  def perform(i)
-    puts "job N#{i} is finished"
+  def perform(index)
+    puts "job N#{index} is finished"
   end
 end
 
@@ -36,17 +38,19 @@ def perform
   end
 end
 
-total.times {|i| FastJob.perform_async i+1 }
+total.times { |i| FastJob.perform_async i + 1 }
 FinishJob.perform_async
 
 Sidekiq::CLI.instance.tap do |cli|
-  %w(validate! boot_system).each {|stub| cli.define_singleton_method(stub) {}}
+  %w[validate! boot_system].each { |stub| cli.define_singleton_method(stub) {} } # rubocop:disable Lint/EmptyBlock
   cli.parse ['-q inline', '-q other', "-c #{concurrency}"]
 
-  puts Benchmark.measure {
-    begin
-      cli.run
-    rescue Exception
-    end
-  }
+  # rubocop:disable Lint/RescueException
+  # rubocop:disable Lint/SuppressedException
+  puts Benchmark.measure do
+    cli.run
+  rescue Exception
+  end
+  # rubocop:enable Lint/SuppressedException
+  # rubocop:enable Lint/RescueException
 end

demo/Gemfile

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gem 'rails'
 gem 'launchy'
+gem 'rails'
 gem 'sidekiq', github: 'mperham/sidekiq'
 gem 'sidekiq-limit_fetch', path: '..'
-

demo/Rakefile

@@ -1,4 +1,6 @@
-require File.expand_path('../config/application', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('config/application', __dir__)
 Demo::Application.load_tasks
 
 namespace :demo do
@@ -63,7 +65,7 @@ namespace :demo do
   end
   def with_sidekiq_config(config)
     whitespace_offset = config[/\A */].size
-    config.gsub! /^ {#{whitespace_offset}}/, ''
+    config.gsub!(/^ {#{whitespace_offset}}/, '')
 
     puts "=> Use sidekiq config:\n#{config}"
     File.write 'config/sidekiq.yml', config
@@ -85,8 +87,8 @@ namespace :demo do
     require 'sidekiq/cli'
     cli = Sidekiq::CLI.instance
 
-    %w(validate! boot_system).each do |stub|
-      cli.define_singleton_method(stub) {}
+    %w[validate! boot_system].each do |stub|
+      cli.define_singleton_method(stub) {} # rubocop:disable Lint/EmptyBlock
     end
 
     with_sidekiq_config options[:config] do
@@ -96,4 +98,3 @@ namespace :demo do
     cli.run
   end
 end
-

demo/app/workers/a_worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AWorker
   include Sidekiq::Worker
   sidekiq_options queue: :a

demo/app/workers/b_worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class BWorker
   include Sidekiq::Worker
   sidekiq_options queue: :b