rubocop-elegant 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a4408943315c5a59e194dcb473bc2b48e7d1b2c07182a155a27ce613bc7bef5
-  data.tar.gz: a4f9028d7cd0b076315f65b9e00a0ee0c204f395a821957a036795bcf14234ff
+  metadata.gz: 07050b077e5266437a527369312875e178be1df47c24f2792fd5945060fe0e26
+  data.tar.gz: 04ad13719f726d00a61a5cd287573813ce6d2780ef4ef7e8ea4092ed02a24af2
 SHA512:
-  metadata.gz: 1489006295818667d80b86717b323f179e739cc7a5cf5ff4716d8c07cac67aa6f1ab3d8236a35636f290ea147315f1e19461a1cb17f50461a48d5e48e6b1e098
-  data.tar.gz: 0c42fda07e77a2ac808325c596e57a207d1cdc19ac05d7807d2318d69d1ca91822144c75c97c14d4fcbb6656bb92fe36c3d7ea0616480c5daf388393a254b8f7
+  metadata.gz: 384fa71d95456e0515d5bb4a518a65af285f6e9774289163595e3f1a1885473dab1f85f931ce731e5376d6fa73029991f7cd5624771736e5650dec8e06b845ab
+  data.tar.gz: d9d7248056d93b0c1c0d81afd0e7c96c709e314e944eeb95365ef1affe3d4f1342607f84b6da874a2e3a68ae3eb21fa0064e9163449935f1a695906f2da5fae4

data/README.md

@@ -22,6 +22,7 @@ The custom cops add the following restrictions:
 
 * Classes must live inside a module; top-level classes are forbidden.
 * A class nested in a module must use compact namespace syntax.
+* Only one non-empty top-level class per file; empty forward declarations are allowed.
 * Method names must be single lowercase verbs.
 * Variable names must be single lowercase nouns.
 * Each indentation step must add exactly two spaces.

data/config/default.yml

@@ -43,6 +43,13 @@ Elegant/NoClassInModule:
   Exclude:
     - '**/*Test.rb'
     - '**/test_*.rb'
+Elegant/OneClassPerFile:
+  Description: 'Allows only one non-empty top-level class per file; empty forward declarations are treated as namespace scaffolding'
+  Enabled: true
+  VersionAdded: '0.4.0'
+  Exclude:
+    - '**/*Test.rb'
+    - '**/test_*.rb'
 Elegant/IndentationLadder:
   Description: 'Requires the indentation step to be exactly two spaces when a line indents to the right of the previous one'
   Enabled: true
@@ -102,6 +109,10 @@ Style/MultilineBlockChain:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
+Style/OneClassPerFile:
+  Enabled: false
+Lint/EmptyClass:
+  Enabled: false
 Lint/NestedMethodDefinition:
   Enabled: false
 Metrics/ParameterLists:

data/lib/rubocop/cop/elegant/no_redundant_variable.rb

@@ -19,7 +19,19 @@
 # whether or when the right-hand side is evaluated. A variable that
 # is reassigned, read more than once, or never read is left alone
 # too.
+#
+# Auto-correct inlines the redundant assignment: it replaces the
+# single +lvar+ read with the source of the assignment's right-hand
+# side, then removes the whole assignment line including its leading
+# indent and trailing newline. The right-hand side is wrapped in
+# parentheses unless it is already a primary expression (literal,
+# variable, parenthesized expression, or method call with parentheses
+# or no arguments), so that operator precedence at the read site is
+# preserved.
 class RuboCop::Cop::Elegant::NoRedundantVariable < RuboCop::Cop::Base
+  extend RuboCop::Cop::AutoCorrector
+  include RuboCop::Cop::RangeHelp
+
   MSG = 'Variable "%<name>s" is redundant and must be inlined: it is read only once'
   public_constant :MSG
 
@@ -35,6 +47,12 @@ class RuboCop::Cop::Elegant::NoRedundantVariable < RuboCop::Cop::Base
   ALWAYS_HOIST_TYPES = %i[rescue resbody ensure].freeze
   public_constant :ALWAYS_HOIST_TYPES
 
+  PRIMARY_TYPES = %i[
+    int float str sym dstr dsym xstr true false nil array hash regexp
+    lvar ivar cvar gvar const self nth_ref back_ref
+  ].freeze
+  public_constant :PRIMARY_TYPES
+
   def on_def(node)
     check(node.body)
   end
@@ -56,10 +74,52 @@ class RuboCop::Cop::Elegant::NoRedundantVariable < RuboCop::Cop::Base
       next unless nodes.size == 1
       next unless reads[name].size == 1
       next if hoisted?(reads[name].first, nodes.first)
-      add_offense(nodes.first, message: format(MSG, name: name))
+      register(nodes.first, reads[name].first, name)
+    end
+  end
+
+  def register(assign, read, name)
+    return add_offense(assign, message: format(MSG, name: name)) unless solo?(assign)
+    add_offense(assign, message: format(MSG, name: name)) do |corrector|
+      corrector.replace(read.source_range, inlined(assign.children.last, read))
+      corrector.remove(range_by_whole_lines(assign.source_range, include_final_newline: true))
     end
   end
 
+  def solo?(assign)
+    range = assign.source_range
+    return false unless range.first_line == range.last_line
+    range.source_buffer.source_line(range.first_line).strip == range.source.strip
+  end
+
+  def inlined(rhs, read)
+    return "(#{braced(rhs)})" if wrap?(rhs, read)
+    braced(rhs)
+  end
+
+  def braced(rhs)
+    return "{ #{rhs.source} }" if rhs.hash_type? && rhs.loc.begin.nil?
+    rhs.source
+  end
+
+  def wrap?(rhs, read)
+    return true unless primary?(rhs)
+    rhs.hash_type? && bare?(read)
+  end
+
+  def primary?(node)
+    return true if PRIMARY_TYPES.include?(node.type)
+    return !node.loc.begin.nil? || node.arguments.empty? if node.send_type? || node.csend_type?
+    node.begin_type? && node.children.size == 1
+  end
+
+  def bare?(read)
+    parent = read.parent
+    return false if parent.nil?
+    return false unless parent.send_type? || parent.csend_type?
+    parent.loc.begin.nil? && parent.arguments.include?(read)
+  end
+
   def walk(node, assigns, reads, tainted)
     return unless node.is_a?(RuboCop::AST::Node)
     return if node.def_type? || node.defs_type?

data/lib/rubocop/cop/elegant/one_class_per_file.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+# Enforces one top-level class per file, treating empty class bodies as
+# namespace scaffolding rather than real classes. An empty top-level
+# +class Foo::Bar; end+ resolves a parent namespace so that the actual
+# class in the same file can use the compact-namespaced form required
+# by +Elegant/NoClassInModule+ without a circular require; it is not a
+# class definition in its own right. Only when two or more top-level
+# class bodies are non-empty does the cop register an offense, on every
+# such class after the first.
+class RuboCop::Cop::Elegant::OneClassPerFile < RuboCop::Cop::Base
+  MSG = 'Only one non-empty class per file is allowed; %<name>s is the extra one'
+  public_constant :MSG
+
+  def on_new_investigation
+    real = tops.reject { |node| node.body.nil? }
+    real.drop(1).each do |node|
+      add_offense(node, message: format(MSG, name: label(node)))
+    end
+  end
+
+  private
+
+  def tops
+    ast = processed_source.ast
+    return [] if ast.nil?
+    return [ast] if ast.class_type?
+    return [] unless ast.begin_type?
+    ast.children.select(&:class_type?)
+  end
+
+  def label(node)
+    node.children[0].source
+  end
+end

data/lib/rubocop/cop/elegant/paired_brackets.rb

@@ -9,8 +9,17 @@
 # closing). Brackets stranded in the middle of a multi-line expression
 # are forbidden because they hide the structure of the code.
 #
+# Auto-correct relocates the offending bracket onto its own line: an
+# opener that is not at end-of-line gets a newline and the opener-line
+# indent plus two spaces inserted right after it; a closer that is not
+# at start-of-line gets a newline and the opener-line indent inserted
+# right before it. Surrounding indentation may still need a follow-up
+# layout pass, but the brackets themselves end up paired.
+#
 # See https://www.yegor256.com/2014/10/23/paired-brackets-notation.html
 class RuboCop::Cop::Elegant::PairedBrackets < RuboCop::Cop::Base
+  extend RuboCop::Cop::AutoCorrector
+
   MSG = 'Bracket %<text>s must be paired on the same line, or start/end its line'
   public_constant :MSG
 
@@ -43,8 +52,9 @@ class RuboCop::Cop::Elegant::PairedBrackets < RuboCop::Cop::Base
   def check(duo)
     opener, closer = duo
     return if opener.line == closer.line
-    register(opener) unless ends?(opener)
-    register(closer) unless starts?(closer)
+    indent = leading(opener)
+    register(opener) { |corrector| corrector.insert_after(opener.pos, "\n#{indent}  ") } unless ends?(opener)
+    register(closer) { |corrector| corrector.insert_before(closer.pos, "\n#{indent}") } unless starts?(closer)
   end
 
   def starts?(tok)
@@ -56,7 +66,11 @@ class RuboCop::Cop::Elegant::PairedBrackets < RuboCop::Cop::Base
     after.empty? || after.start_with?('#')
   end
 
-  def register(tok)
-    add_offense(tok.pos, message: format(MSG, text: tok.text))
+  def leading(tok)
+    processed_source.lines[tok.line - 1][/\A[ \t]*/]
+  end
+
+  def register(tok, &block)
+    add_offense(tok.pos, message: format(MSG, text: tok.text), &block)
   end
 end

data/lib/rubocop/cop/elegant_cops.rb

@@ -15,4 +15,5 @@ require_relative 'elegant/no_empty_lines_in_blocks'
 require_relative 'elegant/no_empty_lines_in_methods'
 require_relative 'elegant/no_nil_return'
 require_relative 'elegant/no_redundant_variable'
+require_relative 'elegant/one_class_per_file'
 require_relative 'elegant/paired_brackets'

data/rubocop-elegant.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to?(:required_rubygems_version=)
   s.required_ruby_version = '>=2.2'
   s.name = 'rubocop-elegant'
-  s.version = '0.3.0'
+  s.version = '0.5.0'
   s.license = 'MIT'
   s.summary = 'Set of custom RuboCop cops for elegant Ruby coding'
   s.description =

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-elegant
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -63,6 +63,7 @@ files:
 - lib/rubocop/cop/elegant/no_empty_lines_in_methods.rb
 - lib/rubocop/cop/elegant/no_nil_return.rb
 - lib/rubocop/cop/elegant/no_redundant_variable.rb
+- lib/rubocop/cop/elegant/one_class_per_file.rb
 - lib/rubocop/cop/elegant/paired_brackets.rb
 - lib/rubocop/cop/elegant_cops.rb
 - lib/rubocop/elegant/plugin.rb