gl_rubocop 0.2.10 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0baf6ecdb13c78d20380b520c6c0860c9ce7e46b9990efed418e326e38dc097
-  data.tar.gz: 8851722324daf55c6a779efdb862da9a4a9217494a459e74ed39113839a4550d
+  metadata.gz: 55107732ab588f104a0a8047cd22d55634bf9f237785b6198ea7e7e74b7d0683
+  data.tar.gz: 9ca9496cea775139741b2d3dfe50c886b423481ed9ef74adf830f829db70d80e
 SHA512:
-  metadata.gz: 47da7a6d8766b9c402ec326e64a20be7497f01c55e0507d55f243b0ef9a1f0bd9a6447a250150430bc4c67b911632c85bd452b7f3a4182067834cdeafc80d992
-  data.tar.gz: f38866b90c118322ca57aa4fa4b5b8476d10037d5247d2a69baef6af9c4390ded0ded29691e5d13e64427de11430474d498a9b82f1ea23cc4a01135a87b5baf8
+  metadata.gz: 6fdc8bf1a8612adcda9a5d98edf5a26d4c99936e4e388c961bff0b5dd092bb86a6b8087be567e451cde9dfc1aa0de49d043ed73445e48920f2f98da6a16c54e2
+  data.tar.gz: 9803a8d9a9122090726be40f0a66dca0d69b9a5424e29776cdf719020bc3d701cf79fb3f17ce13a07b98e99b78f2df79a08ea5fb2fc949814f7ac3f7f89bde8c

data/default.yml

@@ -5,8 +5,9 @@ require:
   - rubocop-magic_numbers
   - rubocop-haml
   - rubocop-rake
-  - ./lib/gl_rubocop/gl_cops/interactor_inherits_from_interactor_base.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
@@ -27,12 +28,21 @@ 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:
+GLCops/NoStubbingPerformAsync:
   Enabled: true
 
 GLCops/PreventErbFiles:
@@ -51,67 +61,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/**/*"
     - "**/spec/**/*"
-  Enabled: false
+  PermittedValues:
+    - 0
+    - 1
+
+MagicNumbers/NoAssignment:
   AllowedAssignments:
     - instance_variables
     - class_variables
     - global_variables
-
-MagicNumbers/NoArgument:
+  Enabled: false
   Exclude:
     - "spec/**/*"
     - "**/spec/**/*"
-  Enabled: true
-  PermittedValues:
-    - 0
-    - 1
 
 MagicNumbers/NoDefault:
+  Enabled: true
   Exclude:
     - "spec/**/*"
     - "**/spec/**/*"
-  Enabled: true
   PermittedValues:
     - 0
     - 1
 
 MagicNumbers/NoReturn:
+  Enabled: true
   Exclude:
     - "spec/**/*"
     - "**/spec/**/*"
-  Enabled: true
   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:
@@ -122,134 +127,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:
@@ -261,54 +289,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.10'.freeze
+  VERSION = '0.2.12'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.12
 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