officer_neetzsche 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a43403b5afe1dda6db1ada7ebcbed1edfcedf20b74310ae26418ad2476caaa4
-  data.tar.gz: 2852001bdaba6f54726cba1ff1381a001a78827c201ec3a0fb91da9b181da443
+  metadata.gz: 22890bd97c3719ada7fdb61dd55402c68b110045cdfc75e99961e85efbe6d2b6
+  data.tar.gz: 61c8a23f85804cfda9b60f5f7b86e79c5afb872d1b42ef72125ff9a364683dcb
 SHA512:
-  metadata.gz: b6306713c14f1fc76bbb93341985a1de4e98a6ef49d5a168bb14ab9373cfd381ca0c0d0efab2ce866fc8f36df15090fdb95534561e9e9bbacf4fefe337b832b3
-  data.tar.gz: cedd62f5afe1fc618b2da479f3b93fc39f4d585008fd41d1bc5dda9a73601c1df160d159407b7cd85ce8fccaf6f4cbf56329e1f368b0e2177a1645d213436efb
+  metadata.gz: 64d16df6a4336e4b0c39f7db504659e565831f581cc3dcbd135a17a034717e5ed75ff3be2c6da1ee2110c3c373c453fae707e393ab5e59b135fac9beaab759b7
+  data.tar.gz: 6dc9fcedae06886c4c967d5d74ff7091dbf12264f073b326dfb0c64932c42f0da05f5544051d7ef32b12d88005f6e2cb84e28166613a41172d209dfc2589afa0

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## 0.3.0 (unreleased)
+## 0.4.0 (unreleased)
+
+### Added
+
+- `NEETzsche/MultilineConditionalBody`: flags an `if`, `unless`, `elsif`, `else`, `while`, or `until` whose body is more than one statement, or one statement that spans lines, and asks for the body to be a method of its own. With `NEETzsche/StatementModifier`, that leaves a conditional two shapes: a modifier, or a block whose branches are one statement each. No autocorrect, since the method needs a name.
+
+## 0.3.0 (2026-09-15)
 
 ### Added
 

data/README.md

@@ -9,6 +9,7 @@ RuboCop cops that enforce NEETzsche-isms. Every cop ships enabled: register the
 | Cop | Enforces | Autocorrect |
 | --- | --- | --- |
 | `NEETzsche/GeneratedMigrationTimestamp` | Migration timestamps come from `bin/rails generate migration`, not a keyboard. | No |
+| `NEETzsche/MultilineConditionalBody` | An `if`, `unless`, `while`, or `until` body of more than one statement, or more than one line, is a method of its own. | No |
 | `NEETzsche/NoComments` | No comments. The code explains itself. | Yes |
 | `NEETzsche/StatementModifier` | An `if`, `unless`, `while`, `until`, or `rescue` around one statement is a modifier. | Yes |
 
@@ -108,6 +109,67 @@ Projects that set `config.active_record.timestamped_migrations = false` number t
 
 There is no autocorrect. The fix is to delete the file and run `bin/rails generate migration` again.
 
+## NEETzsche/MultilineConditionalBody
+
+Flags an `if`, `unless`, `elsif`, `else`, `while`, or `until` whose body is more than one statement, or one statement that spans lines. The fix is to name what the body does and move it into a method of its own, after which `NEETzsche/StatementModifier` rewrites the call site as a modifier. Between them, the two cops leave a conditional two shapes: a modifier, or a block whose branches are one statement each.
+
+```ruby
+# bad
+if condition?
+  do_this
+  do_that
+end
+
+while queue.any?
+  item = queue.pop
+  item.call
+end
+
+if condition?
+  items.each do |item|
+    item.call
+  end
+end
+
+# good
+do_stuff if condition?
+work_one_item while queue.any?
+call_items if condition?
+
+def do_stuff
+  do_this
+  do_that
+end
+
+def work_one_item
+  item = queue.pop
+  item.call
+end
+
+def call_items
+  items.each { |item| item.call }
+end
+
+# good, because each branch is one statement
+if condition?
+  do_this
+else
+  do_that
+end
+```
+
+The offense sits on the keyword of the branch: `if`, `unless`, `elsif`, `else`, `while`, or `until`. Each branch is judged on its own, so an `if` with a two-statement body and a one-statement `else` gets one offense, on the `if`. A heredoc counts as the lines it spans. A modifier whose body spans lines, such as `begin ... end if condition?`, is flagged too. A conditional nested inside another is flagged at every level whose body spans lines, and fixing the innermost usually clears the rest.
+
+Left alone:
+
+- A body of one statement on one line, which is `NEETzsche/StatementModifier`'s to rewrite.
+- Ternaries, empty bodies, and `begin ... end while` loops.
+- A condition that spans lines. Only the body is measured.
+
+There is no autocorrect. The method needs a name that says what the body does, and that is a decision for a person. Moving the body by hand also means deciding what it reads and writes: a local variable the body uses becomes a parameter, one it assigns for later use becomes the return value, and a `return`, `break`, or `next` inside it means something else once it sits in another method. Once the body is one call, `NEETzsche/StatementModifier` turns the block into a modifier under `rubocop --autocorrect`.
+
+`Style/GuardClause` and `Style/Next` may flag the same block with a different fix. Either fix satisfies this cop too, since a guard clause or a `next` leaves no block behind. Under `rubocop --autocorrect`, `Layout/LineLength` may wrap the arguments of a long modifier line and `Style/MultilineIfModifier` then restore the block form, which this cop flags. The way out is a method.
+
 ## NEETzsche/NoComments
 
 Flags every comment. On autocorrect, a comment on its own line is deleted along with the line, and a trailing comment is deleted along with the whitespace before it.
@@ -168,7 +230,7 @@ def call
   fetch rescue fallback
 end
 
-# good, because the body is more than one statement
+# left to NEETzsche/MultilineConditionalBody, because the body is more than one statement
 if condition?
   do_this
   do_that
@@ -179,7 +241,7 @@ The offense sits on the keyword. A `rescue` counts when it is the only clause, r
 
 Left alone, because the block form is the only correct one:
 
-- A body of more than one statement, a statement that spans lines, or a condition that spans lines.
+- A body of more than one statement, a statement that spans lines, or a condition that spans lines. The first two are for `NEETzsche/MultilineConditionalBody`.
 - `else`, `elsif`, ternaries, and `begin ... end while` loops.
 - A body that is itself an `if`, `unless`, `while`, `until`, `case`, or `rescue`, in either form. No chained modifiers.
 - A `rescue` that names another class, lists several, binds a variable, has several clauses, an `else`, or an empty body or handler.

data/config/default.yml

@@ -9,6 +9,11 @@ NEETzsche/GeneratedMigrationTimestamp:
     - "**/db/migrate/**/*.rb"
     - "**/db/*_migrate/**/*.rb"
 
+NEETzsche/MultilineConditionalBody:
+  Description: "Puts an `if`, `unless`, `elsif`, `else`, `while`, or `until` body that is more than one statement, or one statement over more than one line, in a method of its own."
+  Enabled: true
+  VersionAdded: "0.4.0"
+
 NEETzsche/NoComments:
   Description: "Forbids comments. Magic comments, shebangs, and rubocop directives are allowed."
   Enabled: true

data/lib/officer_neetzsche/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OfficerNEETzsche
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/rubocop/cop/neetzsche/multiline_conditional_body.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module NEETzsche
+      class MultilineConditionalBody < Base
+        MSG = "Move a multi-line `%<keyword>s` body into its own method."
+
+        HEREDOC_TYPES = %i[str dstr xstr].freeze
+
+        def on_if(node)
+          return if node.ternary?
+
+          check(node.if_branch, node.loc.keyword, node.keyword)
+          check(node.else_branch, node.loc.else, "else") if node.else? && !node.elsif_conditional?
+        end
+
+        def on_while(node)
+          check(node.body, node.loc.keyword, node.keyword)
+        end
+        alias on_until on_while
+
+        private
+
+        def check(body, keyword, name)
+          return if body.nil? || one_liner?(body)
+
+          add_offense(keyword, message: format(MSG, keyword: name))
+        end
+
+        def one_liner?(body)
+          !multiple_statements?(body) && body.first_line == last_line(body)
+        end
+
+        def multiple_statements?(body)
+          (body.begin_type? || body.kwbegin_type?) && body.children.size > 1
+        end
+
+        def last_line(body)
+          heredocs = body.each_node(*HEREDOC_TYPES).select(&:heredoc?)
+          [body.last_line, *heredocs.map { |heredoc| heredoc.loc.heredoc_end.line }].max
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/neetzsche_cops.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "neetzsche/generated_migration_timestamp"
+require_relative "neetzsche/multiline_conditional_body"
 require_relative "neetzsche/no_comments"
 require_relative "neetzsche/statement_modifier"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: officer_neetzsche
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - TheStranjer
@@ -52,6 +52,7 @@ files:
 - lib/officer_neetzsche/plugin.rb
 - lib/officer_neetzsche/version.rb
 - lib/rubocop/cop/neetzsche/generated_migration_timestamp.rb
+- lib/rubocop/cop/neetzsche/multiline_conditional_body.rb
 - lib/rubocop/cop/neetzsche/no_comments.rb
 - lib/rubocop/cop/neetzsche/statement_modifier.rb
 - lib/rubocop/cop/neetzsche_cops.rb