gl_rubocop 0.2.9 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 598723d7094caaf313991dbda2d2d84e210756dcda15448be93911d49f2ba35d
-  data.tar.gz: 636eed90643e40868de9e50a0ffd1207f5618280e0012451b35ed25e03389242
+  metadata.gz: 19d65dcff9ece63e91e4214d0c4fb6bab5588c4ee97bdc1ef241ca32a3d9afb1
+  data.tar.gz: 96844a8560bce6c4b2d4a2a313f3f3c39625110a3abff73589c56787c171843d
 SHA512:
-  metadata.gz: 535039fab4b2b6e6681e6ff7f846de2163284540292102fe1926132063653d22e62e200c8cfbfd3c64bc684a16be078805098a7ebf3fec4028135da9ad9141cb
-  data.tar.gz: 2d7a66f9fa41fee0ea58d2cb0ff3cc5a942068d464413df9b080704f8223cd833cb26de8f2788d620b494461329a2fff9e9006202d014e1be8e4bc04337a1adb
+  metadata.gz: fa74fd13e08edc286e3009a6f66fa42e9b47a81c592708f29a3c1f8085e55e39c8b11d1d7166387864e95706a2bbc271b403dd9e34e05a0082874462e8278565
+  data.tar.gz: f8aebf2e5be28e44d38e92a8cd083ae9e7768e0105e31e63b989e5d90e3ece00fd494112b7af4fb865e1e3f48ad2ef4e1a20a77141027899b0be36798946da05

data/README.md

@@ -54,3 +54,31 @@ documentation](https://docs.rubocop.org/rubocop/configuration.html#inheriting-co
 8. Following the authorization prompts listed by the gem command.
 
 9. Your changes have now been published to the rubygems registry.
+
+## Testing Locally
+It's likely the case you'll want to test your changes locally before opening a PR, getting approval, and publishing the gem.
+
+To do so, complete the following steps:
+
+1. Save the changes to whichever files you have modified.
+
+2. Run the command `gem build` to create the bundle (this may require you to have bumped the version number)
+
+3. Go to the Gemfile in whichever ruby-based repo you want to test your rubocop changes against
+
+4. Create an entry for gl_rubocop specifiying the *relative* path to your local `gl_rubocop` repo (ex. `../code/gl_rubocop`):
+
+```ruby
+gem 'gl_rubocop', '~> 0.2.9', path: '../path/to/your/local/gl_rubocop'
+```
+
+5. Within the same repo as the Gemfile you just updated run `bundle install`
+
+6. Finally add the following lines to your rubocop configuration file
+
+```yml
+ inherit_gem:
+    gl_rubocop: default.yml
+```
+
+7. Now you can test your rubocop changes local with the target repo.

data/default.yml

@@ -27,14 +27,20 @@ AllCops:
     - "vendor/**/*"
     - "bin/**/*"
 
+Capybara/ClickLinkOrButtonStyle:
+  EnforcedStyle: link_or_button
+
+Capybara/NegationMatcher:
+  EnforcedStyle: not_to
+
+GLCops/CallbackMethodNames:
+  Enabled: true
+
 GLCops/InteractorInheritsFromInteractorBase:
   Enabled: true
   Include:
     - "app/interactors/**/*"
 
-GLCops/CallbackMethodNames:
-  Enabled: true
-
 GLCops/PreventErbFiles:
   Enabled: true
 
@@ -51,63 +57,62 @@ GLCops/UniqueIdentifier:
   Include:
     - "app/components/**/*.haml"
 
+Layout/ClassStructure:
+  Enabled: true
+
 Layout/LineLength:
-  Max: 100
   AllowedPatterns:
     - "^ *#" # Ignores full lines starting with any indentation and a comment (#)
+  Max: 100
 
 Lint/MissingSuper:
   Exclude:
     - "app/components/**/*"
 
-MagicNumbers/NoAssignment:
+MagicNumbers/NoArgument:
+  Enabled: true
   Exclude:
     - "spec/**/*"
-  Enabled: false
+    - "**/spec/**/*"
+  PermittedValues:
+    - 0
+    - 1
+
+MagicNumbers/NoAssignment:
   AllowedAssignments:
     - instance_variables
     - class_variables
     - global_variables
-
-MagicNumbers/NoArgument:
+  Enabled: false
   Exclude:
     - "spec/**/*"
-  Enabled: true
-  PermittedValues:
-    - 0
-    - 1
+    - "**/spec/**/*"
 
 MagicNumbers/NoDefault:
+  Enabled: true
   Exclude:
     - "spec/**/*"
-  Enabled: true
+    - "**/spec/**/*"
   PermittedValues:
     - 0
     - 1
 
 MagicNumbers/NoReturn:
+  Enabled: true
   Exclude:
     - "spec/**/*"
-  Enabled: true
+    - "**/spec/**/*"
   PermittedReturnValues:
     - 0
     - 1
 
 Metrics/AbcSize:
-  Max: 17
   Exclude:
     - "db/**/*"
     - "spec/**/*"
     - "config/routes.rb"
     - "config/routes/*"
-
-Metrics/MethodLength:
-  Max: 15
-  Exclude:
-    - "app/mailers/**/*"
-    - "config/routes/**/*"
-    - "db/**/*"
-    - "lib/tasks/**/*"
+  Max: 17
 
 Metrics/BlockLength:
   Exclude:
@@ -118,134 +123,157 @@ Metrics/BlockLength:
     - "spec/**/*"
 
 Metrics/ClassLength:
-  Max: 150
   Exclude:
     - "db/seeds/**/*"
+  Max: 150
 
 Metrics/CyclomaticComplexity:
   Exclude:
     - "db/seeds/**/*"
 
-Metrics/PerceivedComplexity:
+Metrics/MethodLength:
   Exclude:
-    - "db/seeds/**/*"
+    - "app/mailers/**/*"
+    - "config/routes/**/*"
+    - "db/**/*"
+    - "lib/tasks/**/*"
+  Max: 15
 
 Metrics/ParameterLists:
   Exclude:
     - "db/seeds/**/*"
 
+Metrics/PerceivedComplexity:
+  Exclude:
+    - "db/seeds/**/*"
+
+Naming/MethodParameterName:
+  MinNameLength: 1
+
+Naming/VariableNumber:
+  AllowedIdentifiers:
+    - is_501c3
+    - last4
+    - line1
+    - line2
+    - address_line1
+    - address_line2
+    - google_oauth2
+    - s3
+    - shift4
+    - Shift4
+  EnforcedStyle: "snake_case"
+
 Performance/MapCompact:
   Enabled: false
 
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/AsciiComments:
+RSpec/AnyInstance:
   Enabled: false
 
-Naming/MethodParameterName:
-  MinNameLength: 1
+RSpec/DescribeClass:
+  Exclude:
+    - "spec/api/**/*"
+    - "spec/views/**/*"
+    - "spec/lib/tasks/**/*"
 
-Style/ClassAndModuleChildren:
+RSpec/EmptyExampleGroup:
   Exclude:
-    - "app/controllers/smart_donations_legacy/**/*"
+    - "spec/api/**/*"
 
-Style/Documentation:
-  Enabled: false
+RSpec/ExampleLength:
+  Exclude:
+    - "spec/lib/props_module_spec.rb"
+    - "spec/system/**/*"
+    - "spec/serializers/**/*"
+  Max: 30
 
-Style/FrozenStringLiteralComment:
-  Enabled: false
+RSpec/FilePath:
+  Enabled: true
+  Exclude:
+    - "packs/*/spec/**/*" # Because of automatic namespacing
 
-Rails/TimeZone:
-  Enabled: false
+RSpec/HookArgument:
+  Exclude:
+    - "spec/support/**/*"
 
-Rails/FindEach:
+RSpec/IndexedLet:
   Enabled: false
 
-Rails/I18nLocaleTexts:
+RSpec/InstanceVariable:
+  Exclude:
+    - "spec/workers/salesforce/**/*"
+    - "spec/views/**/*"
+    - "spec/services/salesforce/**/*"
+    - "spec/controllers/salesforce_controller_spec.rb"
+    - "spec/controllers/v1/**/*"
+
+RSpec/LetSetup:
   Enabled: false
 
-Rails/UnusedIgnoredColumns:
-  # This rule is incompatible with our split schema for datawarehouse models
-  # It is disabled by default in rubocop-rails
+RSpec/MessageSpies:
   Enabled: false
 
-Style/GlobalVars:
+RSpec/MultipleExpectations:
   Exclude:
-    - "spec/**/*"
+    - "spec/system/**/*"
+  Max: 5
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
 
 RSpec/NestedGroups:
-  Max: 6
   Exclude:
     - "spec/controllers/**/*"
     - "spec/requests/**/*"
+  Max: 6
 
-RSpec/MultipleExpectations:
-  Max: 5
-  Exclude:
-    - "spec/system/**/*"
-
-RSpec/ExampleLength:
-  Max: 30
-  Exclude:
-    - "spec/lib/props_module_spec.rb"
-    - "spec/system/**/*"
-    - "spec/serializers/**/*"
-
-RSpec/AnyInstance:
+RSpec/ReceiveMessages:
   Enabled: false
 
-RSpec/ReceiveMessages:
+RSpec/SortMetadata:
   Enabled: false
 
+RSpec/SpecFilePathFormat:
+  Enabled: true
+  Exclude:
+    - "packs/*/spec/**/*" # Because of automatic namespacing
+
+RSpec/VariableName:
+  AllowedPatterns:
+    - "Authorization" # used in RSwag specs
+
 RSpec/VerifiedDoubles:
   IgnoreSymbolicNames: true
 
-Rails/SkipsModelValidations:
+RSpecRails/InferredSpecType:
+  Enabled: false
+
+Rails/ApplicationRecord:
   Exclude:
-    - "spec/**/*"
-    - "db/**/*"
+    - "db/migrate/*"
 
-RSpec/MessageSpies:
+Rails/BulkChangeTable:
   Enabled: false
 
-RSpec/LetSetup:
+Rails/CreateTableWithTimestamps:
   Enabled: false
 
-Rails/Output:
-  Exclude:
-    - "db/seeds/**/*"
-
-RSpec/EmptyExampleGroup:
-  Exclude:
-    - "spec/api/**/*"
-
-RSpec/DescribeClass:
-  Exclude:
-    - "spec/api/**/*"
-    - "spec/views/**/*"
-    - "spec/lib/tasks/**/*"
+Rails/FindEach:
+  Enabled: false
 
-Rails/ApplicationRecord:
-  Exclude:
-    - "db/migrate/*"
+Rails/I18nLocaleTexts:
+  Enabled: false
 
-RSpec/HookArgument:
+Rails/Output:
   Exclude:
-    - "spec/support/**/*"
+    - "db/seeds/**/*"
 
-RSpec/InstanceVariable:
+Rails/SkipsModelValidations:
   Exclude:
-    - "spec/workers/salesforce/**/*"
-    - "spec/views/**/*"
-    - "spec/services/salesforce/**/*"
-    - "spec/controllers/salesforce_controller_spec.rb"
-    - "spec/controllers/v1/**/*"
-
-Rails/BulkChangeTable:
-  Enabled: false
+    - "spec/**/*"
+    - "db/**/*"
 
-Rails/CreateTableWithTimestamps:
+Rails/TimeZone:
   Enabled: false
 
 Rails/UnknownEnv:
@@ -257,54 +285,33 @@ Rails/UnknownEnv:
     - production
     - test
 
-Style/HashAsLastArrayItem:
-  Enabled: false
-
-Style/MultilineBlockChain:
+Rails/UnusedIgnoredColumns:
+  # This rule is incompatible with our split schema for datawarehouse models
+  # It is disabled by default in rubocop-rails
   Enabled: false
 
-Naming/VariableNumber:
-  EnforcedStyle: "snake_case"
-  AllowedIdentifiers:
-    - is_501c3
-    - last4
-    - line1
-    - line2
-    - address_line1
-    - address_line2
-    - google_oauth2
-    - s3
-    - shift4
-    - Shift4
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
 
-RSpec/MultipleMemoizedHelpers:
+Style/AsciiComments:
   Enabled: false
 
-RSpecRails/InferredSpecType:
-  Enabled: false
+Style/ClassAndModuleChildren:
+  Exclude:
+    - "app/controllers/smart_donations_legacy/**/*"
 
-RSpec/SortMetadata:
+Style/Documentation:
   Enabled: false
 
-RSpec/IndexedLet:
+Style/FrozenStringLiteralComment:
   Enabled: false
 
-RSpec/FilePath:
-  Enabled: true
-  Exclude:
-    - "packs/*/spec/**/*" # Because of automatic namespacing
-
-RSpec/SpecFilePathFormat:
-  Enabled: true
+Style/GlobalVars:
   Exclude:
-    - "packs/*/spec/**/*" # Because of automatic namespacing
-
-RSpec/VariableName:
-  AllowedPatterns:
-    - "Authorization" # used in RSwag specs
+    - "spec/**/*"
 
-Capybara/ClickLinkOrButtonStyle:
-  EnforcedStyle: link_or_button
+Style/HashAsLastArrayItem:
+  Enabled: false
 
-Capybara/NegationMatcher:
-  EnforcedStyle: not_to
+Style/MultilineBlockChain:
+  Enabled: false

data/lib/gl_rubocop/gl_cops/interactor_inherits_from_interactor_base.rb

@@ -1,14 +1,14 @@
 module GLRubocop
   module GLCops
     class InteractorInheritsFromInteractorBase < RuboCop::Cop::Cop
+      MSG = 'Interactor should inherit from InteractorBase'.freeze
+
       def on_class(klass)
         return unless klass.instance_of?(RuboCop::AST::ClassNode)
         return unless klass.parent_class.nil?
 
         add_offense(klass)
       end
-
-      MSG = 'Interactor should inherit from InteractorBase'.freeze
     end
   end
 end

data/lib/gl_rubocop/gl_cops/no_stubbing_perform_async.rb

@@ -0,0 +1,59 @@
+module GLRubocop
+  module GLCops
+    # This cop ensures that you don't stub perform_async. Stubbing prevents seeing errors from
+    # invalid argumens - because sidekiq arguments have to be valid JSON data types:
+    # github.com/sidekiq/sidekiq/wiki/Best-Practices#1-make-your-job-parameters-small-and-simple
+    #
+    # Good:
+    #   expect(ExampleWorker).to have_enqueued_sidekiq_job
+
+    #
+    # Bad:
+    #   allow(ExampleWorker).to receive(:perform_async)
+    #   expect(ExampleWorker).to receive(:perform_async)
+    #   expect(SomeWorker).not_to have_received(:perform_in)
+    class NoStubbingPerformAsync < RuboCop::Cop::Cop
+      MSG = "Don't stub perform async. Use the rspec-sidekick matchers instead: " \
+            'expect(JobClass).to have_enqueued_sidekiq_job'.freeze
+
+      # This pattern captures expectations for perform_async and perform_in
+      # expect(SomeWorker).not_to have_received(:perform_async)
+      # expect(SomeWorker).to have_received(:perform_async)
+      # expect(SomeWorker).to have_received(:perform_in)
+      def_node_matcher :perform_method_expectation?, <<~PATTERN
+        (send#{' '}
+          (send nil? :expect $_)#{' '}
+          {:not_to :to_not :to}#{' '}
+          (send nil? :have_received (sym {:perform_async :perform_in}) ...))
+      PATTERN
+
+      # This pattern captures allow statements for perform_async and perform_in
+      # allow(SomeWorker).to receive(:perform_async)
+      # allow(SomeWorker).to receive(:perform_in)
+      def_node_matcher :perform_method_allow?, <<~PATTERN
+        (send
+          (send nil? :allow $_)
+          :to
+          (send nil? :receive (sym {:perform_async :perform_in}) ...))
+      PATTERN
+
+      def on_send(node)
+        check_expectation(node) || check_allow(node)
+      end
+
+      private
+
+      def check_expectation(node)
+        perform_method_expectation?(node) { return add_offense(node) }
+
+        false
+      end
+
+      def check_allow(node)
+        perform_method_allow?(node) { return add_offense(node) }
+
+        false
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/sidekiq_inherits_from_sidekiq_job.rb

@@ -1,14 +1,14 @@
 module GLRubocop
   module GLCops
     class SidekiqInheritsFromSidekiqJob < RuboCop::Cop::Cop
+      MSG = 'All Sidekiq workers and jobs should inherit from SidekiqJob'.freeze
+
       def on_class(klass)
         return unless klass.instance_of?(RuboCop::AST::ClassNode)
         return if klass.parent_class.present? || klass.identifier.short_name == :SidekiqJob
 
         add_offense(klass)
       end
-
-      MSG = 'All Sidekiq workers and jobs should inherit from SidekiqJob'.freeze
     end
   end
 end

data/lib/gl_rubocop/version.rb

@@ -1,3 +1,3 @@
 module GLRubocop
-  VERSION = '0.2.9'.freeze
+  VERSION = '0.2.11'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.11
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-20 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -122,6 +122,7 @@ files:
 - lib/gl_rubocop.rb
 - lib/gl_rubocop/gl_cops/callback_method_names.rb
 - lib/gl_rubocop/gl_cops/interactor_inherits_from_interactor_base.rb
+- lib/gl_rubocop/gl_cops/no_stubbing_perform_async.rb
 - lib/gl_rubocop/gl_cops/prevent_erb_files.rb
 - lib/gl_rubocop/gl_cops/rails_cache.rb
 - lib/gl_rubocop/gl_cops/sidekiq_inherits_from_sidekiq_job.rb