betterlint 1.18.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07e39ffdbd6630e753fcec9c3fd5cb25d0b1d5f071299b8f1f66f252cb76c901
-  data.tar.gz: da17e36192a8c847dd1597b48d7f2390ea3c6363563dba286a897f641d1775e7
+  metadata.gz: a8373ada8389173714d5f6086fd98f64e056340b8ddbd6c3b7e9cb78a3143b1f
+  data.tar.gz: bf710724c7163b0ef355cecfaad17bcf6af70c58fa50cdb81fd7d691d1e6e269
 SHA512:
-  metadata.gz: dfe7759c87fe74850dade98e961d7d36f4656500a91c9327612d778cae5953bb07d5daa56d448b1ed2e0c9140df799340c901cb086925b00275cd7b0d8a90e2f
-  data.tar.gz: 101ce64b3692608b1a7e92000e03c94f4c4f2b14548e4ae6aaa9139dfb925cd2ca304cc1d5df53a512fb74a740adbb92186dc25f3acb937df81535379d68ef2a
+  metadata.gz: 991c3a041583443b9e53e0c3baa7ace7354b76a5a07e322d85e82f73bea4a01b7252f203ccbbac1e6947675eb20940777cc4f6df72132ba40f64aab265fbbbf3
+  data.tar.gz: c52af40049be9780cbd719df55e3747902f5c51d7e0136340140aaecc1bab53b8a17f5ecc9f84843dc43e066a9a7df90b02ce751d46c8784d2b0f77baba6e47f

data/README.md

@@ -130,6 +130,27 @@ end
 ```
 
 All three `params.permit` calls will be flagged.
+
+### Betterment/EnvironmentConfiguration
+
+This cop identifies references to `ENV` outside of the config directory.
+
+Environment variables should be parsed at boot time. If an environment variable is missing or invalid,
+the application should fail to boot.
+
+If there isn't a better place to assign your environment variable, Rails provides the `config.x` namespace
+for [custom configuration](https://guides.rubyonrails.org/configuring.html#custom-configuration):
+
+```ruby
+config.x.whatever = ENV.fetch('WHATEVER')
+```
+
+Here's how you'd reference this configuration parameter at runtime:
+
+```ruby
+Rails.configuration.x.whatever
+```
+
 ### Betterment/InternalsProtection
 
 This cop is not enabled by default, and must be enabled from your `.rubocop.yml` file:

data/config/default.yml

@@ -40,6 +40,13 @@ Betterment/DirectDelayedEnqueue:
 Betterment/DynamicParams:
   StyleGuide: '#bettermentdynamicparams'
 
+Betterment/EnvironmentConfiguration:
+  StyleGuide: '#bettermentenvironmentconfiguration'
+  Exclude:
+    - config/**/*.rb
+    - spec/**/*.rb
+    - test/**/*.rb
+
 Betterment/HardcodedID:
   AutoCorrect: false
   Description: Detects hardcoded IDs in specs
@@ -371,6 +378,9 @@ Style/GuardClause:
 Style/IfUnlessModifier:
   Enabled: false
 
+Style/HashSyntax:
+  EnforcedShorthandSyntax: always
+
 Style/Lambda:
   Enabled: false
 

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Betterment
+      class EnvironmentConfiguration < Base
+        MSG =
+          "Environment variables should be parsed at boot time and assigned " \
+          "to `Rails.configuration` or some other configurable object."
+
+        # @!method env?(node)
+        def_node_matcher :env?, '(const nil? :ENV)'
+
+        def on_const(node)
+          add_offense(node) if env?(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/betterment.rb

@@ -6,6 +6,7 @@ require 'rubocop/cop/betterment/allowlist_blocklist'
 require 'rubocop/cop/betterment/authorization_in_controller'
 require 'rubocop/cop/betterment/direct_delayed_enqueue'
 require 'rubocop/cop/betterment/dynamic_params'
+require 'rubocop/cop/betterment/environment_configuration'
 require 'rubocop/cop/betterment/fetch_boolean'
 require 'rubocop/cop/betterment/hardcoded_id'
 require 'rubocop/cop/betterment/implicit_redirect_type'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: betterlint
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Development
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-28 00:00:00.000000000 Z
+date: 2025-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -110,6 +109,7 @@ files:
 - 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/environment_configuration.rb
 - lib/rubocop/cop/betterment/fetch_boolean.rb
 - lib/rubocop/cop/betterment/hardcoded_id.rb
 - lib/rubocop/cop/betterment/implicit_redirect_type.rb
@@ -136,12 +136,11 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/Betterment/betterlint
-  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.18.0
-  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.18.0/CHANGELOG.md
+  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.20.0
+  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.20.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/Betterment/betterlint/issues
-  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.18.0
+  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.20.0
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,8 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Betterment rubocop configuration
 test_files: []