Merge pull request #1 from prysmex/v0.3.1

fix specs, add rubocop

Author: patodevilla

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Test
+
+on: [pull_request]
+
+# permissions:
+#   contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    # env:
+    #   BUNDLE_ONLY: rubocop
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby 3.2.2
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2.2
+        bundler-cache: true
+
+    - name: Run Tests
+      run: bundle exec rake
+      # run: bundle exec rubocop --parallel

.gitignore

@@ -6,7 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
-.rspec_status
-.byebug_history
+Gemfile.lock

.rubocop-rspec.yml

@@ -0,0 +1,11 @@
+###########################################################
+#################### Rubocop Rspec ########################
+###########################################################
+
+# You can find all configuration options for rubocop-rspec here: https://docs.rubocop.org/rubocop-rspec/cops.html
+
+# RSpec/PendingWithoutReason:
+#   Enabled: false
+
+# RSpec/FilePath:
+#   Enabled: false

.rubocop.yml

@@ -0,0 +1,77 @@
+# see example at https://gist.github.com/jhass/a5ae80d87f18e53e7b56
+
+# <% unless ENV['BYPASS_RUBOCOP_TODO'] %>
+# inherit_from:
+# <% else %>
+# inherit_from:
+#   - '.rubocop-todo.yml'
+# <% end %>
+
+inherit_from:
+  - .rubocop_todo.yml
+  - .rubocop-rspec.yml
+
+require:
+  - rubocop-rspec
+  - rubocop-rake
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  # TargetRubyVersion: 2.7.8
+  # TargetRailsVersion: 6.1.4
+  # Exclude:
+  #   - 'Gemfile.lock'
+
+Naming/VariableNumber:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_special
+  Enabled: false
+
+Layout/TrailingEmptyLines:
+  Enabled: false
+  EnforcedStyle: final_blank_line
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/VariableName:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Layout/IndentationWidth:
+  Enabled: false
+
+Layout/EndAlignment:
+  Enabled: false
+
+Layout/ElseAlignment:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented

.rubocop_todo.yml

@@ -0,0 +1,46 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-03-19 18:55:09 UTC using RuboCop version 1.62.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 1
+RSpec/BeforeAfterAll:
+  Exclude:
+    - '**/spec/spec_helper.rb'
+    - '**/spec/rails_helper.rb'
+    - '**/spec/support/**/*.rb'
+    - 'spec/sidekiq_bouncer/bouncer_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 7
+
+# Offense count: 3
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 4
+
+# Offense count: 1
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/sidekiq_bouncer/bouncer_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/sidekiq_bouncer.rb'
+    - 'lib/sidekiq_bouncer/bounceable.rb'
+    - 'lib/sidekiq_bouncer/bouncer.rb'
+    - 'lib/sidekiq_bouncer/config.rb'

.travis.yml

@@ -1,4 +1,17 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sidekiq-bouncer.gemspec
 gemspec
+
+# gem 'bundler', '2.4.22'
+gem 'debug', '>= 1.0.0'
+gem 'rake', '~> 13.1'
+gem 'rspec', '~> 3.9'
+
+# rubocop
+gem 'rubocop', '~> 1.62'
+gem 'rubocop-performance', '~> 1.20'
+gem 'rubocop-rake', '~> 0.6'
+gem 'rubocop-rspec', '~> 2.27.1'

CHANGELOG.md

@@ -61,15 +61,15 @@ class FooWorker
   # The default delay is 60 seconds. You can optionally override it.
   register_bouncer(delay: optional_delay_override, delay_buffer: optional_delay_buffer_override)
 
-  def perform(param1, param2)
-    return unless self.class.bouncer.let_in?(param1, param2) #pass all args received from perform
+  def perform(param1, param2, debounce_key = nil)
+    return unless self.class.bouncer.let_in?(debounce_key) # last argument is added as debounce_key
 
     # Do your thing.
   end
 end
 
 # Call `.bouncer.debounce(...)` instead of `.perform_in/perform_async(...)`.
-FooWorker.bouncer.debounce(param1, param2)
+FooWorker.bouncer.debounce(param1, param2, key_or_args_indices: [0, 1])
 ```
 
 ## Development

Gemfile

@@ -1,6 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

Gemfile.lock

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "sidekiq_bouncer"
+require 'bundler/setup'
+require 'sidekiq_bouncer'
 
 # 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.
@@ -10,5 +11,5 @@ require "sidekiq_bouncer"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

README.md

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sidekiq_bouncer/config'
 require 'sidekiq_bouncer/version'
 require 'sidekiq_bouncer/bounceable'
@@ -13,7 +15,7 @@ def config
     end
 
     # Yield self to allow configuing in a block
-    def configure(&block)
+    def configure(&)
       yield config
     end
   end

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SidekiqBouncer
   module Bounceable