betterlint 1.14.0 → 1.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eba1c8a88e6cefd6fc8db168dfe4b9f41f30989c4716fdc0338e99614a40315d
-  data.tar.gz: 9b176cbf47cf1f1d65547624b44531dcb0328832a1dfc62c12b3f33c0222f1e3
+  metadata.gz: 3ae9168d5c43a437fe26c6b413ef1715c62f357dd6f7ff84cb0ee899029d6c89
+  data.tar.gz: 476ea6908ac443fc0433c798cdba841d4aee0f123db3244212a6d935fefefb00
 SHA512:
-  metadata.gz: 00b1ed1bdec96493c6c9332228a2cff4a1134926c27d72ea0c13439f454af5668258a1722ef53520ffa2786472c59b1c09e12ee5abdce8e7fdc1d1d91ecb09df
-  data.tar.gz: 7d159d6ee74e8a6f5b30f3e922e9d13ae1d5a26c779c12df0750daad6e82b68d2caecda1a8e473c7b983af45d96aca3635239906d03592e3e790fbf09952dec5
+  metadata.gz: 24a3717010784d06dbf2bc2768f58db63a8d2013889b1691d00859ee81173fac8827da3a3c44282c337cae0893b0a2984e03a517c024c1e9f180ecc6fc3890bb
+  data.tar.gz: 78f3f97c2ff547aad69e82d7b8d7f78c1dd076de06475b5f60bb1127a646d7fcd303dfdfa1834877297b8489a56ed071cddfa8c36dcae0c388588d6f9c260180

data/README.md

@@ -130,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

@@ -44,6 +44,11 @@ Betterment/HardcodedID:
   SafeAutoCorrect: false
   StyleGuide: '#bettermenthardcodedid'
 
+Betterment/InternalsProtection:
+  Description: Detects invalid references to Internals modules
+  StyleGuide: '#bettermentinternalsprotection'
+  Enabled: false
+
 Betterment/NonStandardActions:
   AdditionalAllowedActions: []
   Description: Detects non-standard controller actions.

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.rb

@@ -10,6 +10,7 @@ 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.14.0
+  version: 1.15.1
 platform: ruby
 authors:
 - Development
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 2024-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -113,6 +113,7 @@ files:
 - 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
@@ -133,10 +134,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/Betterment/betterlint
-  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.14.0
-  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.14.0/CHANGELOG.md
+  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.15.1
+  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.15.1/CHANGELOG.md
   bug_tracker_uri: https://github.com/Betterment/betterlint/issues
-  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.14.0
+  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.15.1
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Betterment rubocop configuration