betterlint 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1491e20e0716813156b261f5cd5a9cf253455c004fc1bd19b6b76145519a63ac
-  data.tar.gz: 235b8423ef33fa88e926e6ff174d179649d4a15b737a4dc3757a97e919267223
+  metadata.gz: 8ae56cca2ec6c902c0eb366462cdc80fafb3895c3ea56454bdc247f528694cfa
+  data.tar.gz: d70a646105175ee4c68a1098c7bc31dc8d06249484245f180ad2e2164aa720c3
 SHA512:
-  metadata.gz: 70410f02798546b16ec349134e18397794f52ba01341f7d5023514c9fdc6a6c52b2aa579c811d6cb66a0955e93f08330398c4b5846a89434464c72b9122f55b9
-  data.tar.gz: 9773586040f235b40766bccd931e7dcc14e0d9d6297f56e5bce6a155aaa0854cdb1f289dc4667cea0459007663c301bc12e00ca11a5682f0f517188e2c838e08
+  metadata.gz: cbde32295337b547e4b8a9fe128ebd0406573745a8e8a8acafb8c3bd8f10f6e052442c6ff36e1c915d559fc3a924f8ed7aa40914d78b3560e00c373f1019deaa
+  data.tar.gz: 709a0ea18f486e1489da86947951cf73d9d22341178a46c242d282d686eeafbce4986fbef7143305e20698e047478532dc0ce2556d781ad4b6b6fd093721ee05

data/README.md

@@ -210,3 +210,20 @@ This cop is capable of autocorrecting offenses, but it's not entirely safe. If y
 Betterment/HardcodedID:
   AutoCorrect: true
 ```
+
+### Betterment/RedirectStatus
+
+The `redirect_to` method defaults to a `302 Found`, but when redirecting a POST/PUT/PATCH/DELETE
+to a GET location, the correct response code is `303 See Other`.
+
+This cop requires you to explictly provide an HTTP status code when redirecting from the create,
+update, and destory actions. When autocorrecting, this will automatically add `status: :see_other`.
+
+### Betterment/RenderStatus
+
+The `render` method defaults to a `200 OK`. Calling `render` in the create, update, and destroy
+actions often indicates error handling (e.g. `422 Unprocessable Entity`).
+
+This cop requires you to explicitly provide an HTTP status code when rendering a response in the
+create, update, and destroy actions. When autocorrecting, this will automatically add
+`status: :unprocessable_entity` or `status: :ok` depending on what you're rendering.

data/config/default.yml

@@ -76,6 +76,18 @@ Betterment/UnsafeJob:
 Betterment/UnscopedFind:
   StyleGuide: '#bettermentunscopedfind'
 
+Betterment/RedirectStatus:
+  SafeAutoCorrect: false
+  Description: Detect missing status codes when redirecting POST, PUT, PATCH, or DELETE responses
+  Include:
+    - app/controllers/**/*.rb
+
+Betterment/RenderStatus:
+  SafeAutoCorrect: false
+  Description: Detect missing status codes when rendering POST, PUT, PATCH, or DELETE responses
+  Include:
+    - app/controllers/**/*.rb
+
 FactoryBot/ConsistentParenthesesStyle:
   Enabled: false
 

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'utils/response_status'
+
+module RuboCop
+  module Cop
+    module Betterment
+      class RedirectStatus < Base
+        extend AutoCorrector
+
+        include Utils::ResponseStatus
+
+        MSG = <<~MSG.gsub(/\s+/, " ")
+          Did you forget to specify an HTTP status code? The default is `status: :found`, which
+          is usually inappropriate in this situation. Use `status: :see_other` when redirecting a
+          POST, PUT, PATCH, or DELETE request to a GET resource.
+        MSG
+
+        def on_def(node)
+          each_offense(node, :redirect_to) do |responder|
+            add_offense(responder) do |corrector|
+              corrector.insert_after(responder, ", status: :see_other")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'utils/response_status'
+
+module RuboCop
+  module Cop
+    module Betterment
+      class RenderStatus < Base
+        extend AutoCorrector
+
+        include Utils::ResponseStatus
+
+        MSG = <<~MSG.gsub(/\s+/, " ")
+          Did you forget to specify an HTTP status code? The default is `status: :ok`, which might
+          be inappropriate in this situation. Rendering after a POST, PUT, PATCH or DELETE request
+          typically represents an error (e.g. `status: :unprocessable_entity`).
+        MSG
+
+        def on_def(node)
+          each_offense(node, :render) do |responder|
+            add_offense(responder) do |corrector|
+              corrector.insert_after(responder, ", status: #{infer_status(responder).inspect}")
+            end
+          end
+        end
+
+        private
+
+        def infer_status(responder)
+          case extract_template(responder).to_s
+            when 'new', 'edit'
+              :unprocessable_entity
+            else
+              :ok
+          end
+        end
+
+        # @!method extract_template(node)
+        def_node_matcher :extract_template, <<~PATTERN
+          (send nil? :render {(sym $_) (str $_)} ...)
+        PATTERN
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Betterment
+      module Utils
+        module ResponseStatus
+          extend RuboCop::NodePattern::Macros
+
+          UNSAFE_ACTIONS = %i(create update destroy).freeze
+
+          private
+
+          def each_offense(node, responder_name, &block)
+            if UNSAFE_ACTIONS.include?(node.method_name)
+              on_missing_status(node, responder_name, &block)
+            end
+          end
+
+          # @!method on_missing_status(node)
+          def_node_search :on_missing_status, <<~PATTERN
+            (send nil? %1 ... !(hash <(pair (sym :status) _) ...>))
+          PATTERN
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/betterment.rb

@@ -20,3 +20,5 @@ require 'rubocop/cop/betterment/server_error_assertion'
 require 'rubocop/cop/betterment/hardcoded_id'
 require 'rubocop/cop/betterment/vague_serialize'
 require 'rubocop/cop/betterment/fetch_boolean'
+require 'rubocop/cop/betterment/render_status'
+require 'rubocop/cop/betterment/redirect_status'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterlint
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Development
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -100,6 +100,8 @@ files:
 - lib/rubocop/cop/betterment/implicit_redirect_type.rb
 - lib/rubocop/cop/betterment/memoization_with_arguments.rb
 - lib/rubocop/cop/betterment/non_standard_actions.rb
+- lib/rubocop/cop/betterment/redirect_status.rb
+- lib/rubocop/cop/betterment/render_status.rb
 - lib/rubocop/cop/betterment/server_error_assertion.rb
 - lib/rubocop/cop/betterment/site_prism_loaded.rb
 - lib/rubocop/cop/betterment/spec_helper_required_outside_spec_dir.rb
@@ -109,6 +111,7 @@ files:
 - lib/rubocop/cop/betterment/utils/hardcoded_attribute.rb
 - lib/rubocop/cop/betterment/utils/method_return_table.rb
 - lib/rubocop/cop/betterment/utils/parser.rb
+- lib/rubocop/cop/betterment/utils/response_status.rb
 - lib/rubocop/cop/betterment/vague_serialize.rb
 homepage:
 licenses: