rubocop-dev_doc 0.10.3 → 0.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ba7422e97cc011bf4700f5f6bfd1c87fd7e358c9c707baf73b5360abbf40129
-  data.tar.gz: 10ced56ec89a8d05f3897c76ff85df357cb52a9dc97d155f7caf11b1917faaa6
+  metadata.gz: b11d7c80b04d4ef7ecbff606f3920260773ae1767ffcacab78e99663920ca9d7
+  data.tar.gz: eaae1ebc845ca76bc72a878916d1f096c5495ce16b9238734c823875b0ba2323
 SHA512:
-  metadata.gz: 403c116d677b765d86ef3a8852b1087ffa5821a12a1db76f59343d067cfd6c942c4fe1ae69c65a67ae1ad24a07922e7312f2a4f2a84b5164e379f8928c90a57c
-  data.tar.gz: 4bd0b0fb718cf6ac10540735e49077da57e0d34b54111dcc5fe9da0a531383546eb83a9300503a10612f7bb0f90b6f6434acf0b307ea6125316202563bd89a52
+  metadata.gz: 0c227078e2a29302744d3b14cd3058f5912b50831221b82d7ab8cb13885ffaf4bca0eb7e8784745bd470533190e6c522d3f69b28f7e64cc18f183d2a39d6dd19
+  data.tar.gz: b7f474e88689ce7bd672e735458b5b8e45c5c47448b44461b673a46b8ac4b74c997ccebf548b02b33460095214c2d6920211ffb621a82eca3e231d8f65898f4d

data/config/default.yml

@@ -170,7 +170,7 @@ DevDoc/Rails/NoPerformLaterInModel:
     - "app/models/**/*.rb"
 
 DevDoc/Rails/EnumMustBeSymbolized:
-  Description: "Pair every `enum :foo` with `enum_symbolize :foo` so the reader returns a symbol."
+  Description: "Declare enums with `enum_symbolize :foo, { … }` instead of a bare `enum`, so the attribute type is set before the enum and the reader returns a symbol."
   Enabled: true
   Include:
     - "app/models/**/*.rb"
@@ -436,6 +436,18 @@ Rails/SaveBang:
   Exclude:
     - "app/controllers/**/*"
 
+# MySQL-oriented performance cop: it wants multiple ALTER TABLE operations on
+# one table combined into `change_table :t, bulk: true` to avoid repeated
+# full-table rewrites. That payoff is real on MySQL/MariaDB but marginal on
+# PostgreSQL, where ALTER sub-commands are cheap metadata ops — and our projects
+# run PostgreSQL. It also contradicts our own doctrine: the `bulk: true` form it
+# demands trips DevDoc/Migration/AvoidColumnDefault (on the backfill `default:`)
+# and Rails/ReversibleMigration (on `t.change_default`), neither disable-able
+# inline, for the standard add-column-then-drop-default backfill — making the
+# three rules mutually unsatisfiable. Off for all projects.
+Rails/BulkChangeTable:
+  Enabled: false
+
 # Superseded by DevDoc/Style/CaseElseDecision below: same detection, but the
 # offense message carries the raise/report/fall-through decision framework
 # instead of upstream's "Missing else statement" (which teaches the wrong

data/lib/rubocop/cop/dev_doc/rails/enum_must_be_symbolized.rb

@@ -2,44 +2,51 @@ module RuboCop
   module Cop
     module DevDoc
       module Rails
-        # Every Rails `enum` declaration must be paired with `enum_symbolize`
-        # so the reader returns a symbol instead of Rails' default string form.
+        # Rails `enum` must never be declared directly — use glib-web's
+        # `enum_symbolize :name, { … }` declaring form instead.
         #
         # ## Rationale
-        # Strings and symbols are not equal in Ruby (`:foo == 'foo'` is `false`).
-        # Rails' `enum` macro defines a reader that returns the string form, so
-        # downstream comparisons like `record.status == :active` silently fail.
-        # Pairing `enum :status, …` with `enum_symbolize :status` overrides the
-        # reader to hand back a symbol, eliminating the footgun.
+        # Two problems with a bare `enum`:
+        #
+        # 1. **Type.** `enum` resolves its attribute type by introspecting the
+        #    DB column. When the column doesn't exist yet — a not-yet-migrated
+        #    column loaded on deploy, eager-loaded CI, or an un-migrated local
+        #    DB — Rails raises "Undeclared attribute type for enum". Declaring
+        #    the attribute up front (which `enum_symbolize` does, from the enum's
+        #    own values) removes that dependency on the column.
+        # 2. **Reader.** `enum` defines a reader that returns the string form, so
+        #    `record.status == :active` silently fails (`:foo == 'foo'` is
+        #    false). `enum_symbolize` overrides the reader to return a symbol.
+        #
+        # The `enum_symbolize :name, { … }` form does both in one call — it
+        # declares the attribute, defines the enum, adds a presence validation,
+        # and symbolizes the reader — so neither footgun can be reintroduced by
+        # forgetting a pairing line.
         #
         # See `best_practices/backend/en/01a_defensive_programming.md` item 7.
         #
         #   ❌
         #   class Order < ApplicationRecord
         #     enum :payment_status, { draft: 0, pending: 1, finalized: 2 }
+        #     enum_symbolize :payment_status
         #   end
         #
         #   ✔
         #   class Order < ApplicationRecord
-        #     enum :payment_status, { draft: 0, pending: 1, finalized: 2 }
-        #
-        #     enum_symbolize :payment_status
+        #     enum_symbolize :payment_status, { draft: 0, pending: 1, finalized: 2 }
         #   end
         #
-        # `enum_symbolize` accepts multiple names so several enums can be
-        # paired in one call:
+        # Enum options pass straight through:
         #
         #   ✔
-        #   enum_symbolize :payment_status, :finalize_intent
+        #   enum_symbolize :finalize_intent, { unknown: 0, charge: 1 }, prefix: true
         #
         # Enums declared inside a concern's `included do` block are checked the
-        # same way — the pairing must live in the same `included do` block,
-        # which is also where it belongs so every includer gets both:
+        # same way:
         #
         #   ✔
         #   included do
-        #     enum :discount_type, DISCOUNT_TYPES
-        #     enum_symbolize :discount_type
+        #     enum_symbolize :discount_type, DISCOUNT_TYPES
         #   end
         #
         # @example
@@ -47,20 +54,16 @@ module RuboCop
         #   enum :status, { active: 0, archived: 1 }
         #
         #   # good
-        #   enum :status, { active: 0, archived: 1 }
-        #   enum_symbolize :status
+        #   enum_symbolize :status, { active: 0, archived: 1 }
         class EnumMustBeSymbolized < Base
-          MSG = 'Pair `enum :%<name>s` with `enum_symbolize :%<name>s` so the reader returns a symbol ' \
-                '(see backend/01a_defensive_programming.md item 7).'.freeze
+          MSG = 'Declare enums with `enum_symbolize :%<name>s, { … }` instead of `enum`, so the ' \
+                'attribute type is set before the enum (surviving a not-yet-migrated column) and the ' \
+                'reader returns a symbol (see backend/01a_defensive_programming.md item 7).'.freeze
 
           def_node_matcher :enum_call, <<~PATTERN
             (send nil? :enum (sym $_) ...)
           PATTERN
 
-          def_node_matcher :enum_symbolize_call, <<~PATTERN
-            (send nil? :enum_symbolize $...)
-          PATTERN
-
           def_node_matcher :included_block?, <<~PATTERN
             (block (send nil? :included) (args) _)
           PATTERN
@@ -83,28 +86,15 @@ module RuboCop
             return unless body
 
             statements = body.begin_type? ? body.children : [body]
-            enum_decls, symbolized = scan(statements)
+            statements.each do |stmt|
+              next unless stmt.respond_to?(:send_type?) && stmt.send_type?
 
-            enum_decls.each do |name, decl|
-              next if symbolized.include?(name)
+              name = enum_call(stmt)
+              next unless name
 
-              add_offense(decl, message: format(MSG, name: name))
+              add_offense(stmt, message: format(MSG, name: name))
             end
           end
-
-          def scan(statements)
-            sends = statements.select { |stmt| stmt.respond_to?(:send_type?) && stmt.send_type? }
-            enum_decls = sends.filter_map { |stmt| (name = enum_call(stmt)) && [name, stmt] }
-            symbolized = sends.flat_map { |stmt| symbolized_names(stmt) }
-            [enum_decls, symbolized]
-          end
-
-          def symbolized_names(stmt)
-            args = enum_symbolize_call(stmt)
-            return [] unless args
-
-            args.select(&:sym_type?).map(&:value)
-          end
         end
       end
     end

data/lib/rubocop/dev_doc/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module DevDoc
-    VERSION = "0.10.3".freeze
+    VERSION = "0.10.4".freeze
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-dev_doc
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.10.4
 platform: ruby
 authors:
 - dev-doc contributors
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -79,6 +80,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.29'
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -157,10 +160,12 @@ files:
 - lib/rubocop/dev_doc.rb
 - lib/rubocop/dev_doc/plugin.rb
 - lib/rubocop/dev_doc/version.rb
+homepage:
 licenses: []
 metadata:
   default_lint_roller_plugin: RuboCop::DevDoc::Plugin
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -175,7 +180,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: RuboCop cops enforcing dev-doc best practices
 test_files: []