betterlint 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 530a4f9e133d2b476275f42d7f58050eab86379908d1d7b1ebc0ac56c7c680f5
-  data.tar.gz: 497ef95c882dae58db33bf6b7d02c28a63909968f6a751a0ed9a29c97d12aa83
+  metadata.gz: 91782f59f8a8101bb7e6d431d0e5f6e095ae6c4beed07485534bbf11406a32e3
+  data.tar.gz: 4d336df923e86b2f2f820f073e8813779452512912122de398ee2fd19a8c9d8b
 SHA512:
-  metadata.gz: 150b06a5b965394c1c7f00b95c7f3d1bb78e58855d300fb3041f90ad828fc023ca6e0cca02faad01274d58b3d5263bbf05acf337691ce5b89e98482596f30241
-  data.tar.gz: 2524c76c7a7ea7101f3987f79e31270fe0e51091aabf1f8bc229b9854285757e01b4c335e09be348a5f850f7b2f5b1fe16f18d4ff0d72eda94496cc1a54a0b46
+  metadata.gz: cc5684ed82435f46ca36e99fa251073489ce870f15c9bb1484b43b4901049b1313fe6c5995fba020b0db717f0ebcac729ed09a68e889c25d4c148602da13a778
+  data.tar.gz: '08c7298e7cd72fff069fe3870b2f853816658ddafe9871b86c957eae8d5aa218e8893381db8fac530160c1cc7f920bcff1aabc67d4ab2bd2e9d77db6705ba8be'

data/README.md

@@ -197,3 +197,16 @@ Betterment/NonStandardActions:
     - 'config/routes.rb'
     - 'config/other_routes.rb'
 ```
+
+### Betterment/HardcodedID
+
+This cop identifies hardcoded IDs in your specs. You should not hardcode IDs in specs because the spec may flake due to an ID collision, leading to false positives, unique constraint violations (e.g. `PG::UniqueViolation`), and more.
+
+Instead of hardcoding an ID, create the resource and reference its ID. If the ID refers to an identifier in an external system, consider using a [FactoryBot sequence](https://github.com/thoughtbot/factory_bot/blob/main/GETTING_STARTED.md#sequences).
+
+This cop is capable of autocorrecting offenses, but it's not entirely safe. If you want to opt-in, add the following config to your `rubocop.yml` and run with `rubocop -A`:
+
+```yaml
+Betterment/HardcodedID:
+  AutoCorrect: true
+```

data/config/default.yml

@@ -67,6 +67,12 @@ Betterment/NonStandardActions:
   Include:
     - 'config/routes.rb'
 
+Betterment/HardcodedID:
+  Description: 'Detects hardcoded IDs in specs'
+  StyleGuide: '#bettermenthardcodedid'
+  AutoCorrect: false
+  SafeAutoCorrect: false
+
 Layout/ParameterAlignment:
   Enabled: false
 

data/lib/rubocop/cop/betterment/active_job_performable.rb

@@ -2,7 +2,7 @@ module RuboCop
   module Cop
     module Betterment
       class ActiveJobPerformable < Cop
-        MSG = <<-DOC.freeze
+        MSG = <<~DOC.freeze
           Classes that are "performable" should be ActiveJobs
 
           class MyJob < ApplicationJob
@@ -23,16 +23,24 @@ module RuboCop
         PATTERN
 
         def on_class(node)
-          return unless has_perform_method?(node)
           return if subclasses_application_job?(node)
+          return unless has_perform_method?(node)
 
-          add_offense(node.children.first)
+          add_offense(node.identifier)
         end
 
         private
 
         def has_perform_method?(node)
-          node.descendants.find { |n| is_perform_method?(n) }
+          possible_methods_within(node).any? { |n| is_perform_method?(n) }
+        end
+
+        def possible_methods_within(node)
+          if node.body.begin_type?
+            node.body.children
+          else
+            [node.body]
+          end
         end
       end
     end

data/lib/rubocop/cop/betterment/hardcoded_id.rb

@@ -0,0 +1,101 @@
+module RuboCop
+  module Cop
+    module Betterment
+      class HardcodedID < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Hardcoded IDs cause flaky tests. Use a sequence instead.'.freeze
+
+        # @!method key(node)
+        def_node_matcher :key, '/^id$|_id$/'
+
+        # @!method value(node)
+        def_node_matcher :value, '{int | (str /^\d+$/)}'
+
+        # @!method pair(node, value_pattern)
+        def_node_matcher :pair, '(pair (sym #key) %1)'
+
+        # @!method hardcoded_id?(node)
+        def_node_matcher :hardcoded_id?, '#pair(#value)'
+
+        # @!method references_hardcoded_id?(node, method_name)
+        def_node_matcher :references_hardcoded_id?, '#pair((send nil? %1))'
+
+        # @!method on_factory(node)
+        def_node_matcher :on_factory, <<~PATTERN
+          (send (const nil? :FactoryBot) {:create | :create_list} _factory ... (hash $...))
+        PATTERN
+
+        # @!method on_let_id(node)
+        def_node_matcher :on_let_id, <<~PATTERN
+          (block (send nil? {:let | :let!} (sym $#key)) _block_args $#value)
+        PATTERN
+
+        def on_send(node)
+          each_factory_attribute(node) do |attribute_node|
+            next unless hardcoded_id?(attribute_node)
+
+            add_offense(attribute_node) do |corrector|
+              attribute = Utils::HardcodedAttribute.new(attribute_node)
+              correct_factory_usage(corrector, attribute) if attribute.correctable?
+            end
+          end
+        end
+
+        def on_block(node)
+          on_let_id(node) do |name, value|
+            node.parent&.each_descendant do |child|
+              each_factory_attribute(child) do |attribute_node|
+                next unless references_hardcoded_id?(attribute_node, name)
+
+                add_offense(node) do |corrector|
+                  attribute = Utils::HardcodedAttribute.new(attribute_node)
+                  corrector.replace(attribute.node.value, value.value.to_s) if attribute.correctable?
+                end
+              end
+            end
+          end
+        end
+        alias on_numblock on_block
+
+        private
+
+        def each_factory_attribute(node, &block)
+          on_factory(node) do |attributes|
+            attributes.each(&block)
+          end
+        end
+
+        def correct_factory_usage(corrector, attribute)
+          corrector.remove(with_comma(attribute.node))
+
+          attribute.each_integer_reference do |reference|
+            corrector.replace(reference, attribute.replacement)
+          end
+
+          attribute.each_string_reference do |reference|
+            attribute.each_range_within_string(reference) do |range|
+              corrector.replace(range, "\#{#{attribute.replacement}}")
+            end
+
+            ensure_double_quoted(corrector, reference)
+          end
+        end
+
+        def ensure_double_quoted(corrector, node)
+          if node.source.start_with?("'")
+            corrector.replace(node.loc.begin, '"')
+            corrector.replace(node.loc.end, '"')
+          end
+        end
+
+        def with_comma(attribute)
+          range = attribute.location.expression
+          range = range_with_surrounding_space(range)
+          range_with_surrounding_comma(range, :left)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/betterment/utils/hardcoded_attribute.rb

@@ -0,0 +1,75 @@
+module RuboCop
+  module Cop
+    module Utils
+      class HardcodedAttribute
+        extend RuboCop::NodePattern::Macros
+
+        attr_reader :node, :let_node, :let_name
+
+        def initialize(node)
+          @node = node
+          @let_node = node.parent&.parent&.parent
+          @let_name = extract_let_name(@let_node)
+        end
+
+        def correctable?
+          key == :id && !let_name.nil?
+        end
+
+        def replacement
+          "#{let_name}.#{key}"
+        end
+
+        def each_integer_reference
+          each_possible_reference(:int) do |ref|
+            yield ref if ref.value == value
+          end
+        end
+
+        def each_string_reference
+          each_possible_reference(:str) do |ref|
+            yield ref if ref.value.match?(value_pattern)
+          end
+        end
+
+        def each_range_within_string(reference)
+          reference.source.enum_for(:scan, value_pattern).each do
+            yield create_range(reference, Regexp.last_match)
+          end
+        end
+
+        private
+
+        def create_range(node, match)
+          range = node.loc.expression
+          begin_pos = range.begin_pos + match.begin(0)
+          end_pos = range.begin_pos + match.end(0)
+          range.with(begin_pos: begin_pos, end_pos: end_pos)
+        end
+
+        def key
+          node.key.value
+        end
+
+        def value
+          node.value.value.to_i
+        end
+
+        def value_pattern
+          /\b#{value}\b/
+        end
+
+        def each_possible_reference(type, &block)
+          let_node.parent.each_descendant(:block) do |block_node|
+            block_node.each_descendant(type, &block) unless block_node == let_node
+          end
+        end
+
+        # @!method extract_let_name(node)
+        def_node_matcher :extract_let_name, <<~PATTERN
+          (block (send nil? {:let | :let!} (sym $_let_name)) _block_args _block_body)
+        PATTERN
+      end
+    end
+  end
+end

data/lib/rubocop/cop/betterment.rb

@@ -1,6 +1,7 @@
 require 'rubocop'
 require 'rubocop/cop/betterment/utils/parser'
 require 'rubocop/cop/betterment/utils/method_return_table'
+require 'rubocop/cop/betterment/utils/hardcoded_attribute'
 require 'rubocop/cop/betterment/authorization_in_controller'
 require 'rubocop/cop/betterment/dynamic_params'
 require 'rubocop/cop/betterment/unscoped_find'
@@ -14,3 +15,4 @@ require 'rubocop/cop/betterment/implicit_redirect_type'
 require 'rubocop/cop/betterment/active_job_performable'
 require 'rubocop/cop/betterment/allowlist_blocklist'
 require 'rubocop/cop/betterment/server_error_assertion'
+require 'rubocop/cop/betterment/hardcoded_id'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterlint
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Development
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-17 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -137,6 +137,7 @@ files:
 - lib/rubocop/cop/betterment/allowlist_blocklist.rb
 - lib/rubocop/cop/betterment/authorization_in_controller.rb
 - lib/rubocop/cop/betterment/dynamic_params.rb
+- lib/rubocop/cop/betterment/hardcoded_id.rb
 - lib/rubocop/cop/betterment/implicit_redirect_type.rb
 - lib/rubocop/cop/betterment/memoization_with_arguments.rb
 - lib/rubocop/cop/betterment/non_standard_actions.rb
@@ -146,6 +147,7 @@ files:
 - lib/rubocop/cop/betterment/timeout.rb
 - lib/rubocop/cop/betterment/unsafe_job.rb
 - lib/rubocop/cop/betterment/unscoped_find.rb
+- lib/rubocop/cop/betterment/utils/hardcoded_attribute.rb
 - lib/rubocop/cop/betterment/utils/method_return_table.rb
 - lib/rubocop/cop/betterment/utils/parser.rb
 homepage: