rubocop-nathank 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1cbe27ef830beab287c9fe5f094cb0779bd11624b305c70c5dc9cf213c06693
-  data.tar.gz: d2056f2799a73989349c29d89cde6437d79d4084043325176bb6162ddc55c20f
+  metadata.gz: 0cec356ff42dae5257d46997d1266931e657bacc97da9dc7f275d487782ab80e
+  data.tar.gz: 5dafe29111e93b1b6d4c6373076999e52ad60451b8160f840d7478194754a71f
 SHA512:
-  metadata.gz: f56ce9201f12e91a550d6024fdeffb1d7bef352e1424b1577ddc6b6cfa17cbfc6566d9ec2536cc12cea23c94df7e4f68b2cf20216fe1726e35dd3e7e0053fd62
-  data.tar.gz: b5c2e4a4460a4c06713cd78f98bd04688cac75acdce2faf4d08c13d4f598021720b69b4557ca9acae7aa022b193d133c92f6fdc61626cac251d2961dd98df6a9
+  metadata.gz: 1f3c75b4d53b7f1dad397a9f6a96e3510cbbce0cbf862b3d508eee4c3825893cc529eb59ab4cfff4853972ac937e5638456e258f6fffcd766df39a3d10f72c9a
+  data.tar.gz: 92bb4cbfdd73e40a589f4869a96d6a7c95d0fe633c8cbc0f001dd7cc383134b184c6213ab296a441e90ca54d1ded94be37effc7674f726e7b5af51e58cf6c640

data/CHANGELOG.md

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2026-10-29
+
+### Changed
+
+- The plugin sets `AllCops/DisabledByDefault`, which is what it was always for:
+  RuboCop's own cops are off and the house cops are on, so a project needs
+  nothing in its `.rubocop.yml` beyond the `plugins:` entry.
+- A project must no longer set `AllCops/DisabledByDefault` itself. Your config is
+  merged over the plugin's, so setting it again takes the house cops off along
+  with RuboCop's and the run reports nothing. Remove it, and remove the
+  `Nathank/*: Enabled: true` lines it made necessary.
+
+### Removed
+
+- `Nathank/SingleLineMethodsForEvents`. Endless methods are a matter of taste
+  rather than house style, and the cop raised on any file holding a method with
+  its own `rescue`, which took it out of the run without saying so. Remove any
+  `.rubocop.yml` entry for it.
+
+### Fixed
+
+- `prism_statements` reads the statements of a `BeginNode`, so a method with its
+  own `rescue` or `ensure` no longer raises `undefined method 'body'`.
+
 ## [1.0.0] - 2026-10-27
 
 ### Added
@@ -26,5 +50,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   lint_roller plugin class is now `RuboCop::Nathank::Plugin`, referenced by the
   gemspec's `default_lint_roller_plugin` metadata.
 
-[Unreleased]: https://github.com/n-at-han-k/rubocop-nathank/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/n-at-han-k/rubocop-nathank/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/n-at-han-k/rubocop-nathank/compare/v1.0.0...v2.0.0
 [1.0.0]: https://github.com/n-at-han-k/rubocop-nathank/releases/tag/v1.0.0

data/lib/rubocop/nathank/config.yaml

@@ -3,6 +3,10 @@
 # This is the default configuration file for rubocop-nathank.
 # You can override any of these settings in your .rubocop.yml file.
 
+# The whole point of the plugin: the house style is what these cops say, not what RuboCop's defaults say, so the defaults are off and the cops below are on. A project wanting one of the defaults back enables it by name in its own .rubocop.yml, which is merged over this. It must not set DisabledByDefault itself: that would take these cops off too.
+AllCops:
+  DisabledByDefault: true
+
 Nathank/BeginBlockAssignment:
   Description: "Bans assigning a `begin...end` expression; the assignment goes inside the block."
   Enabled: true
@@ -41,11 +45,6 @@ Nathank/NoReturn:
   Enabled: true
   VersionAdded: "0.1.0"
 
-Nathank/SingleLineMethodsForEvents:
-  Description: "A one-expression method body uses the endless form."
-  Enabled: true
-  VersionAdded: "0.1.0"
-
 Nathank/UseTap:
   Description: "Requires `tap` where a method assigns a local on its first line and returns it on its last."
   Enabled: true

data/lib/rubocop/nathank/support/prism_source.rb

@@ -98,11 +98,16 @@ module RuboCop
 
       # The statements of a body, whether it holds one or many.
       #
-      # @parameter body [Prism::StatementsNode | nil] the body of a method, module, or block.
+      # A method with its own `rescue` has a BeginNode body, whose statements are one level in.
+      #
+      # @parameter body [Prism::Node | Nil] the body of a method, module, or block.
       # @returns [Array(Prism::Node)] its statements, which is empty when there is no body.
       def prism_statements(body)
-        if body.nil?
+        case body
+        when nil
           []
+        when ::Prism::BeginNode
+          self.prism_statements(body.statements)
         else
           body.body
         end

data/lib/rubocop/nathank/version.rb

@@ -5,6 +5,6 @@
 
 module RuboCop
   module Nathank
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/rubocop/nathank.rb

@@ -12,7 +12,6 @@ require_relative "nathank/comment_structure"
 require_relative "nathank/no_conditional_assignment"
 require_relative "nathank/no_modifier_if"
 require_relative "nathank/no_return"
-require_relative "nathank/single_line_methods_for_events"
 require_relative "nathank/use_tap"
 
 # @namespace

data/readme.md

@@ -16,6 +16,30 @@ plugins:
   - rubocop-nathank
 ```
 
+That is the whole configuration. The plugin sets `AllCops/DisabledByDefault`, so RuboCop's own
+cops are off and the ones below are on: the house style is what these cops say rather than what
+the defaults say, and a project does not have to list them to get them.
+
+A default you want back is enabled by name, and a house cop you do not want is disabled the same
+way, because your `.rubocop.yml` is merged over the plugin's:
+
+``` yaml
+# .rubocop.yml
+plugins:
+  - rubocop-nathank
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Nathank/NoReturn:
+  Enabled: false
+```
+
+What you must not do is set `AllCops/DisabledByDefault` yourself. The plugin already sets it, and
+your file is merged over the plugin's: setting it again takes the plugin's own cops off along with
+RuboCop's, and you get a run which inspects every file and reports nothing.
+
 ## Available Cops
 
 * `Nathank/BeginBlockAssignment` - no assigning a `begin...end`; the assignment goes inside.
@@ -23,7 +47,6 @@ plugins:
 * `Nathank/NoModifierIf` - no modifier `if` / `unless`, so a guard cannot hide off the right edge.
 * `Nathank/NoReturn` - no `return`; the last expression is the return value.
 * `Nathank/UseTap` - `tap` where a method assigns a local and returns it.
-* `Nathank/SingleLineMethodsForEvents` - a one-expression body uses the endless form.
 * `Nathank/CommentStructure` - how a comment is built: unwrapped paragraphs, a summary no longer
   than the code earns, and annotations on a documented interface.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-nathank
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Nathan Kidd
@@ -81,7 +81,6 @@ files:
 - lib/rubocop/nathank/no_modifier_if.rb
 - lib/rubocop/nathank/no_return.rb
 - lib/rubocop/nathank/plugin.rb
-- lib/rubocop/nathank/single_line_methods_for_events.rb
 - lib/rubocop/nathank/support/prism_source.rb
 - lib/rubocop/nathank/use_tap.rb
 - lib/rubocop/nathank/version.rb

data/lib/rubocop/nathank/single_line_methods_for_events.rb

@@ -1,168 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the Apache License, Version 2.0.
-# Copyright, 2026, by General Intelligence Systems.
-
-require_relative "support/prism_source"
-
-module RuboCop
-  module Nathank
-    # Requires a method whose body is a single expression to use the endless method form.
-    #
-    # @example
-    #   # bad
-    #   def event_type
-    #     "m.room.message"
-    #   end
-    #   # good
-    #   def event_type = "m.room.message"
-    class SingleLineMethodsForEvents < ::RuboCop::Cop::Base
-      include PrismSource
-      extend ::RuboCop::Cop::AutoCorrector
-
-      MSG = "A method whose body is one expression must use the endless form: `def name = expression`."
-
-      # Expressions which can follow ` = ` unchanged. Anything with its own `end`, or with lower precedence than the assignment, is left as a block: what it would parse as is not what it says as a body.
-      ACCEPTED_BODIES = [
-        ::Prism::ArrayNode,
-        ::Prism::CallNode,
-        ::Prism::ClassVariableReadNode,
-        ::Prism::ConstantPathNode,
-        ::Prism::ConstantReadNode,
-        ::Prism::FalseNode,
-        ::Prism::FloatNode,
-        ::Prism::GlobalVariableReadNode,
-        ::Prism::HashNode,
-        ::Prism::ImaginaryNode,
-        ::Prism::InstanceVariableReadNode,
-        ::Prism::IntegerNode,
-        ::Prism::InterpolatedStringNode,
-        ::Prism::InterpolatedSymbolNode,
-        ::Prism::InterpolatedXStringNode,
-        ::Prism::LocalVariableReadNode,
-        ::Prism::NilNode,
-        ::Prism::RangeNode,
-        ::Prism::RationalNode,
-        ::Prism::RegularExpressionNode,
-        ::Prism::SelfNode,
-        ::Prism::StringNode,
-        ::Prism::SymbolNode,
-        ::Prism::TrueNode,
-        ::Prism::XStringNode,
-      ].freeze
-
-      def on_new_investigation
-        self.prism_each(::Prism::DefNode).each do |node|
-          if self.rewriteable?(node)
-            self.report(node)
-          end
-        end
-      end
-
-      private
-
-      # The one expression a method's body is, when that is what it is.
-      def sole_expression(node)
-        statements = self.prism_statements(node.body)
-
-        if statements.size == 1
-          statements.first
-        else
-          nil
-        end
-      end
-
-      # A method is rewritten only when it is not endless, not a setter, and has one non-heredoc body expression on one line.
-      def rewriteable?(node)
-        body = self.sole_expression(node)
-
-        !self.endless?(node) &&
-          !self.setter?(node.name) &&
-          !body.nil? &&
-          ACCEPTED_BODIES.any?{|klass| body.is_a?(klass)} &&
-          self.single_line?(node, body) &&
-          !self.prism_heredoc?(body)
-      end
-
-      # An endless method is written with `=` rather than a body closed by `end`.
-      def endless?(node)
-        !node.equal_loc.nil?
-      end
-
-      # The offense is reported either way; the correction is withheld when a comment sits inside the method, since replacing the method would take the comment with it.
-      def report(node)
-        range = self.prism_node_range(node)
-
-        if self.comment?(node)
-          add_offense(range)
-        else
-          add_offense(range) do |corrector|
-            corrector.replace(range, self.endless_form(node))
-          end
-        end
-      end
-
-      # `def foo=(value)` and `def []=(key, value)` have no endless form.
-      def setter?(name)
-        name == :[]= || /\A[a-zA-Z_]\w*=\z/.match?(name.to_s)
-      end
-
-      # The body on one line, and the signature on one line too, so that the rewritten method is still a single line.
-      def single_line?(node, body)
-        body.location.start_line == body.location.end_line &&
-          !self.signature_source(node).include?("\n")
-      end
-
-      # The source of the signature, e.g. `def build(**fields)`, without the gap before the body.
-      def signature_source(node)
-        source = processed_source.buffer.source
-
-        # byteslice, because every offset here is one of Prism's and those count bytes, where `String#[]` counts characters.
-        source.byteslice(node.location.start_offset...self.signature_end(node))
-      end
-
-      def signature_end(node)
-        ending = node.name_loc.end_offset
-
-        if parameters = node.parameters
-          [ending, parameters.location.end_offset].max
-        else
-          ending
-        end
-      end
-
-      def comment?(node)
-        self.prism_comments.any? do |comment|
-          (node.location.start_line..node.location.end_line).cover?(comment.location.start_line)
-        end
-      end
-
-      def endless_form(node)
-        "#{self.signature(node)} = #{self.prism_source(self.sole_expression(node))}"
-      end
-
-      def signature(node)
-        "#{self.receiver_prefix(node)}#{node.name}#{self.arguments_suffix(node)}"
-      end
-
-      def receiver_prefix(node)
-        if node.receiver
-          "def #{self.prism_source(node.receiver)}."
-        else
-          "def "
-        end
-      end
-
-      # Bare arguments are ambiguous before ` = `; parenthesize them.
-      def arguments_suffix(node)
-        parameters = node.parameters
-
-        if parameters.nil?
-          ""
-        else
-          "(#{self.prism_source(parameters)})"
-        end
-      end
-    end
-  end
-end