betterlint 1.13.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c4835d2317f75072a423ec551933a1eaccccf5e9e625f98973a0c7750d9a8a8
-  data.tar.gz: c40e7571c5cab59a0fbe006b8cd8dc8117bc16010ec9a0a7c33798e62c550f4a
+  metadata.gz: 834ddcd8893844db2ccbff0a1c0379f40e47f12fbbff9859831c342df1266d34
+  data.tar.gz: 8b8b7c4d49d7a961f042fc6941f6f55085b77a502441eb1c6ba7dfb8aa1af9cc
 SHA512:
-  metadata.gz: e1fd9a6bfdcbc7fa683bee7200f6ff8d097b655f18757023f011ddffd9205d33b93649d721825f209e106f98bc2a1e1e32632e8ee98ab3bf4e26e62db875410b
-  data.tar.gz: 781b01893ca3ad33f4b64842fc48d27577cc0d16401d29f135d0f596a570ece65f6e37dc7aeb06f45ccd50fea846d9266a8eeb1ed199d99daff62f3a30fd1f42
+  metadata.gz: d1db7904622a80b0271e05f33f36c4667f720a9fd13253422dba34c70ecd2ef0f6973255d5506475cd942e3ab72b353a61121da4ed4fa871d2b546228881324f
+  data.tar.gz: 3cf27adfc7561156c5a11a5a54c58b1bb471e5e944aed955220aaa8c383bf0e155eeb56aa514d537da317e08943ac9b330bb510d8fcf85cc8f6bbe6d7dcbc1dc

data/README.md

@@ -101,6 +101,15 @@ Betterment/UnscopedFind:
     - ZipCode
 ```
 
+### Betterment/DirectDelayedEnqueue
+
+This cop flags code that uses `Object#delay` or `Delayed::Job.enqueue`. Please use `ActiveJob` instead.
+
+```ruby
+user.delay.save!
+Delayed::Job.enqueue(MyJob.new)
+```
+
 ### Betterment/DynamicParams
 
 This cop flags code that accesses parameters whose names may be dynamically generated, such as a list of parameters in an a global variable or a return value from a method. In some cases, dynamically accessing parameter names can obscure what the client is expected to send and may make it difficult to reason about the code, both manually and programmatically. For example:
@@ -121,6 +130,50 @@ end
 ```
 
 All three `params.permit` calls will be flagged.
+### Betterment/InternalsProtection
+
+This cop is not enabled by default, and must be enabled from your `.rubocop.yml` file:
+
+```yaml
+Betterment/InternalsProtection:
+  Enabled: true
+```
+
+This cop enforces constants defined within `Internals` modules from being referenced from other modules.
+
+For example, if you have a `Widget` ActiveRecord class that you don't want to be used directly,
+you can place it into an Internals module such as:
+```ruby
+class Widgets::Internals::Widget < ApplicationRecord
+end
+```
+
+Code outside of the `Widgets` module will not be allowed to reference Widget:
+```ruby
+class WidgetsController < ApplicationController
+  def create
+    Widgets::Internals::Widget.create!
+    ^^^^^^^^^^^^^^^^^^ Internal constants may only be referenced from code within its containing module. [...]
+  end
+end
+```
+
+Non-Internal code within the module can be used to manage access.
+```ruby
+class Widgets::WidgetCreation
+  def save!
+    Widgets::Internals::Widget.create!
+  end
+end
+
+class WidgetsController < ApplicationController
+  def create
+    Widgets::WidgetCreation.new.save!
+  end
+end
+```
+
+This cop inspects all direct constant references, and the `class_name` attribute on ActiveRecord associations.
 
 ### Betterment/UnsafeJob
 

data/config/default.yml

@@ -32,6 +32,9 @@ Betterment/AuthorizationInController:
   Enabled: false
   StyleGuide: '#bettermentauthorizationincontroller'
 
+Betterment/DirectDelayedEnqueue:
+  StyleGuide: '#bettermentdirectdelayedenqueue'
+
 Betterment/DynamicParams:
   StyleGuide: '#bettermentdynamicparams'
 
@@ -98,15 +101,43 @@ FactoryBot/ConsistentParenthesesStyle:
 FactoryBot/SyntaxMethods:
   Enabled: false
 
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ArrayAlignment:
+  EnforcedStyle: with_fixed_indentation
+
 Layout/CaseIndentation:
-  IndentOneStep: true
+  EnforcedStyle: end
+  IndentOneStep: false
 
 Layout/ClosingParenthesisIndentation:
   Enabled: true
 
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+
 Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstParameterIndentation:
+  Enabled: false
+
+Layout/LineContinuationLeadingSpace:
+  Enabled: false
+
+Layout/LineContinuationSpacing:
+  Enabled: true
+
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: false
+
 Layout/LineLength:
   Max: 140
 
@@ -117,11 +148,11 @@ Layout/MultilineOperationIndentation:
   EnforcedStyle: indented
 
 Layout/ParameterAlignment:
-  Enabled: false
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
 
-# Disabling because of a bug in rubocop: https://github.com/rubocop-hq/rubocop/issues/6918
 Layout/RescueEnsureAlignment:
-  Enabled: false
+  Enabled: true
 
 Lint/AmbiguousBlockAssociation:
   Exclude:

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Betterment
+      class DirectDelayedEnqueue < Base
+        DELAY_MESSAGE = 'Please use Active Job instead of using `Object#delay`'
+        ENQUEUE_MESSAGE = 'Please use Active Job instead of using `Delayed::Job.enqueue`'
+
+        # @!method enqueue?(node)
+        def_node_matcher :enqueue?, <<-PATTERN
+          (send (const (const nil? :Delayed) :Job) :enqueue ...)
+        PATTERN
+
+        def on_send(node)
+          add_offense(node, message: DELAY_MESSAGE) if node.method?(:delay)
+          add_offense(node, message: ENQUEUE_MESSAGE) if enqueue?(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Betterment
+      class InternalsProtection < Base
+        MSG = <<~END.gsub(/\s+/, " ")
+          Internal constants may only be referenced from code within its containing module.
+          Constants defined within a module's Internals submodule may only be referenced by code in that module,
+          or nested classes and modules
+          (e.g. MyModule::Internals::MyClass may only be referenced from code in MyModule or MyModule::MyPublicClass).
+        END
+
+        # @!method association_with_class_name(node)
+        def_node_matcher :association_with_class_name, <<-PATTERN
+          (send nil? {:has_many :has_one :belongs_to} ... (hash <(pair (sym :class_name) ${str}) ...>))
+        PATTERN
+
+        # @!method rspec_describe(node)
+        def_node_matcher :rspec_describe, <<-PATTERN
+          (block (send (const nil? :RSpec) :describe ${const | str}) ...)
+        PATTERN
+
+        def on_const(node)
+          if node.children[1] == :Internals
+            module_path = const_path(node)
+
+            ensure_allowed_reference!(node, module_path)
+          end
+        end
+
+        def on_send(node)
+          class_name_node = association_with_class_name(node)
+          return unless class_name_node
+
+          full_path = string_path(class_name_node)
+          internals_index = full_path.find_index(:Internals)
+          if internals_index
+            module_path = full_path.take(internals_index)
+            ensure_allowed_reference!(class_name_node, module_path)
+          end
+        end
+
+        private
+
+        def ensure_allowed_reference!(node, module_path)
+          return if module_path.empty?
+
+          unless definition_context_path(node).each_cons(module_path.size).any?(module_path)
+            add_offense(node)
+          end
+        end
+
+        def const_path(const_node)
+          const_node.each_descendant(:const, :cbase).map { |n| n.children[1] }.reverse
+        end
+
+        def string_path(string_node)
+          string_node.children[0].split('::').map { |name| name == '' ? nil : name.to_sym }
+        end
+
+        def definition_context_path(node)
+          rspec_context_path(node) || module_class_definition_context_path(node)
+        end
+
+        def module_class_definition_context_path(node)
+          node.each_ancestor(:class, :module).flat_map { |anc|
+            anc.children[0].each_node(:const, :cbase).map { |c| c.children[1] }
+          }.push(nil).reverse
+        end
+
+        def rspec_context_path(node)
+          rspec_described_class = node.each_ancestor(:block).filter_map { |ancestor|
+            rspec_describe(ancestor)
+          }.first
+          case rspec_described_class&.type
+          when :const then const_path(rspec_described_class)
+          when :str then string_path(rspec_described_class)
+          else nil # rubocop:disable Style/EmptyElse
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -53,10 +53,10 @@ module RuboCop
           if route
             (path, param, value) = route
             action = case param
-                       when :to then value.first.split('#').last
-                       when :action then value.first
-                       else path
-                     end
+            when :to then value.first.split('#').last
+            when :action then value.first
+            else path
+            end
             add_offense(node, message: MSG_ROUTE_TO) unless allowed_action?(action)
             true
           end

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

@@ -26,10 +26,10 @@ module RuboCop
 
         def infer_status(responder)
           case extract_template(responder).to_s
-            when 'new', 'edit'
-              :unprocessable_entity
-            else
-              :ok
+          when 'new', 'edit'
+            :unprocessable_entity
+          else
+            :ok
           end
         end
 

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

@@ -39,25 +39,25 @@ module RuboCop
             return [node] if node.literal? || node.variable?
 
             case node.type
-              when :begin
-                get_return_values(node.children.last)
-              when :block
-                get_return_values(node.body)
-              when :if
-                if_rets = get_return_values(node.if_branch)
-                else_rets = get_return_values(node.else_branch)
-                if_rets + else_rets
-              when :case
-                cases = []
-                node.each_when do |block|
-                  cases += get_return_values(block.body)
-                end
+            when :begin
+              get_return_values(node.children.last)
+            when :block
+              get_return_values(node.body)
+            when :if
+              if_rets = get_return_values(node.if_branch)
+              else_rets = get_return_values(node.else_branch)
+              if_rets + else_rets
+            when :case
+              cases = []
+              node.each_when do |block|
+                cases += get_return_values(block.body)
+              end
 
-                cases + get_return_values(node.else_branch)
-              when :send
-                [node]
-              else
-                []
+              cases + get_return_values(node.else_branch)
+            when :send
+              [node]
+            else
+              []
             end
           end
 

data/lib/rubocop/cop/betterment.rb

@@ -5,10 +5,12 @@ 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/direct_delayed_enqueue'
 require 'rubocop/cop/betterment/dynamic_params'
 require 'rubocop/cop/betterment/unscoped_find'
 require 'rubocop/cop/betterment/unsafe_job'
 require 'rubocop/cop/betterment/timeout'
+require 'rubocop/cop/betterment/internals_protection'
 require 'rubocop/cop/betterment/memoization_with_arguments'
 require 'rubocop/cop/betterment/non_standard_actions'
 require 'rubocop/cop/betterment/site_prism_loaded'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterlint
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Development
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -108,10 +108,12 @@ files:
 - lib/rubocop/cop/betterment/active_job_performable.rb
 - lib/rubocop/cop/betterment/allowlist_blocklist.rb
 - lib/rubocop/cop/betterment/authorization_in_controller.rb
+- lib/rubocop/cop/betterment/direct_delayed_enqueue.rb
 - lib/rubocop/cop/betterment/dynamic_params.rb
 - lib/rubocop/cop/betterment/fetch_boolean.rb
 - lib/rubocop/cop/betterment/hardcoded_id.rb
 - lib/rubocop/cop/betterment/implicit_redirect_type.rb
+- lib/rubocop/cop/betterment/internals_protection.rb
 - lib/rubocop/cop/betterment/memoization_with_arguments.rb
 - lib/rubocop/cop/betterment/non_standard_actions.rb
 - lib/rubocop/cop/betterment/redirect_status.rb
@@ -132,10 +134,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/Betterment/betterlint
-  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.13.0
-  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.13.0/CHANGELOG.md
+  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.15.0
+  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.15.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/Betterment/betterlint/issues
-  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.13.0
+  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.15.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -152,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Betterment rubocop configuration