rubocop-elegant 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caefc6549542af9deff3c876e4f5820c45b1641a0006d797c05776123675a3d2
-  data.tar.gz: 59a23203e472ff8485a69e714f3085efa6a5a323381097f4fedb104df5363238
+  metadata.gz: 25c022ecd592d9b71642d845716275362e0175a24c1703046fa987dd5fac977b
+  data.tar.gz: 7e8df712bdc9326743e2baa33db7117742759f8bb685e42403ffce8b537b7b31
 SHA512:
-  metadata.gz: 553939a2d42896140b0b778faa879bdf4729a5411a60c22013b66313173d2b2785d5c7052bf68baf8ec2b223d450de7707393a73aa7a0a47bfa970283ae388ab
-  data.tar.gz: 8dbae33a180941efead52d5ed739f0f1ee349947769790d322a8ece2e224169ef79179fed362383f508bd05d5ab27b84935e3a552028b04a132c0077a3ee2a28
+  metadata.gz: 80858ff6896e4509151c4e6df75df9dc7559fa08154cd5b4ef890a57bcf6b3a9b33bb64ec59f98d8ec45dad7bcfd02a94402cd3b9d0943ac581d66e5e94be718
+  data.tar.gz: e7555aa1fb5a013dd33ed84959ff6e5bee69df1dd433625a48ab9a148159c9b525a3b9244807c5f769c6fa2ac68d705b085c85a1f4a91a6371618752a1e507fe

data/README.md

@@ -32,6 +32,7 @@ The custom cops add the following restrictions:
 * A method cannot return `nil` explicitly.
 * Local variables that are assigned once and read once must be inlined.
 * Brackets must be paired on the same line, or start/end their own line.
+* The SPDX header must sit above the code, with only comments before it.
 
 First, install it:
 

data/Rakefile

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'rake'
-require 'rake/clean'
 # SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
+require 'rake'
+require 'rake/clean'
 require 'rubygems'
 
 CLEAN.include('coverage')

data/config/default.yml

@@ -36,6 +36,10 @@ Elegant/ClassInModule:
   Exclude:
     - '**/*Test.rb'
     - '**/test_*.rb'
+    - '**/*_test.rb'
+    - '**/*_spec.rb'
+    - 'test/**/*'
+    - 'spec/**/*'
 Elegant/NoClassInModule:
   Description: 'Forbids declaring a class inside a module declaration; use compact namespace syntax instead'
   Enabled: true
@@ -43,6 +47,10 @@ Elegant/NoClassInModule:
   Exclude:
     - '**/*Test.rb'
     - '**/test_*.rb'
+    - '**/*_test.rb'
+    - '**/*_spec.rb'
+    - 'test/**/*'
+    - 'spec/**/*'
 Elegant/OneClassPerFile:
   Description: 'Allows only one non-empty top-level class per file; empty forward declarations are treated as namespace scaffolding'
   Enabled: true
@@ -50,6 +58,10 @@ Elegant/OneClassPerFile:
   Exclude:
     - '**/*Test.rb'
     - '**/test_*.rb'
+    - '**/*_test.rb'
+    - '**/*_spec.rb'
+    - 'test/**/*'
+    - 'spec/**/*'
 Elegant/MonotonicIndents:
   Description: 'Requires the indentation step to be exactly two spaces when a line indents to the right of the previous one'
   Enabled: true
@@ -66,6 +78,10 @@ Elegant/GoodMethodName:
   VersionAdded: '0.0.3'
   Pattern: '^(?=.{1,48}$)(((to|fake|the|with|without)_)?[a-z]{1,16}[!?]?|(on|test)_[a-z_]+)$'
   AllowedNames: []
+Elegant/SpdxOnTop:
+  Description: 'Requires the SPDX header to sit above the code, with only comments and blank lines before it'
+  Enabled: true
+  VersionAdded: '0.8.0'
 
 Style/RedundantException:
   Enabled: false
@@ -78,11 +94,19 @@ Metrics/ModuleLength:
   Exclude:
     - '**/*Test.rb'
     - '**/test_*.rb'
+    - '**/*_test.rb'
+    - '**/*_spec.rb'
+    - 'test/**/*'
+    - 'spec/**/*'
 Metrics/ClassLength:
   Max: 300
   Exclude:
     - '**/*Test.rb'
     - '**/test_*.rb'
+    - '**/*_test.rb'
+    - '**/*_spec.rb'
+    - 'test/**/*'
+    - 'spec/**/*'
 Metrics/MethodLength:
   Max: 100
 Metrics/BlockLength:
@@ -103,6 +127,8 @@ Layout/EndOfLine:
   EnforcedStyle: lf
 Layout/ParameterAlignment:
   Enabled: false
+Layout/ArrayAlignment:
+  EnforcedStyle: with_fixed_indentation
 Layout/LineLength:
   Max: 120
 Style/MultilineBlockChain:

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

@@ -4,10 +4,13 @@
 # SPDX-License-Identifier: MIT
 
 # Enforces that every class be defined inside a module. A class declared
-# at the top level, or nested only inside another class, pollutes the
-# global namespace and breaks modular design. The compact namespaced
-# form +class Foo::Bar+ is allowed because its name already resolves
-# into an enclosing namespace.
+# at the top level pollutes the global namespace and breaks modular
+# design. The compact namespaced form +class Foo::Bar+ is allowed
+# because its name already resolves into an enclosing namespace, and so
+# is a class nested inside another class, since the enclosing class
+# names it too: +class Foo::Bar; class Baz+ defines +Foo::Bar::Baz+.
+# A class declared with an explicit root scope, +class ::Baz+, is global
+# whatever encloses it lexically, so it is reported wherever it sits.
 class RuboCop::Cop::Elegant::ClassInModule < RuboCop::Cop::Base
   MSG = 'Class %<name>s must be defined inside a module, not globally'
   public_constant :MSG
@@ -21,12 +24,17 @@ class RuboCop::Cop::Elegant::ClassInModule < RuboCop::Cop::Base
   private
 
   def namespaced?(node)
-    scope = node.children[0].children[0]
+    scope = outer(node)
     !scope.nil? && scope.type != :cbase
   end
 
   def scoped?(node)
-    node.each_ancestor(:module).any?
+    return false unless outer(node).nil?
+    node.each_ancestor(:module, :class).any?
+  end
+
+  def outer(node)
+    node.children[0].children[0]
   end
 
   def label(node)

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

@@ -18,11 +18,16 @@ class RuboCop::Cop::Elegant::GoodMethodName < RuboCop::Cop::Base
   private
 
   def check(node, name)
+    return unless identifier?(name)
     return if allowed?(name)
     return if match?(name)
     add_offense(node, message: format(MSG, name: name))
   end
 
+  def identifier?(name)
+    /\A[a-zA-Z_]/.match?(name)
+  end
+
   def match?(name)
     pattern.match?(name)
   end

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

@@ -23,7 +23,10 @@
 # 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
+# indent and trailing newline. When the read is the value of a Ruby
+# 3.1 shorthand pair, such as the +ids+ of +call(ids:)+, key and
+# value share one range, so the whole pair is rewritten into its
+# long form +ids: <rhs>+ instead. 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
@@ -81,11 +84,26 @@ class RuboCop::Cop::Elegant::NoRedundantVariable < RuboCop::Cop::Base
   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.replace(*rewrite(assign.children.last, read))
       corrector.remove(range_by_whole_lines(assign.source_range, include_final_newline: true))
     end
   end
 
+  def rewrite(rhs, read)
+    pair = shorthand(read)
+    return [read.source_range, inlined(rhs, read)] if pair.nil?
+    [pair.source_range, "#{pair.children.first.source}: #{inlined(rhs, read)}"]
+  end
+
+  def shorthand(read)
+    parent = read.parent
+    return if parent.nil? || !parent.pair_type?
+    key, value = parent.children
+    return unless value.equal?(read)
+    return unless key.source_range == value.source_range
+    parent
+  end
+
   def solo?(assign)
     range = assign.source_range
     return false unless range.first_line == range.last_line

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

@@ -10,11 +10,14 @@
 # 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.
+# opener that is not at end-of-line is followed by a newline and the
+# opener-line indent plus two spaces; a closer that is not at
+# start-of-line is preceded by a newline and the opener-line indent.
+# The whitespace already sitting next to the bracket is consumed by
+# the rewrite rather than left in place, so the moved code lands on
+# the intended column instead of drifting right by that much.
+# 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
@@ -29,6 +32,9 @@ class RuboCop::Cop::Elegant::PairedBrackets < RuboCop::Cop::Base
   CLOSERS = %i[tRPAREN tRBRACK tRCURLY].freeze
   private_constant :CLOSERS
 
+  BLANKS = [' ', "\t"].freeze
+  private_constant :BLANKS
+
   def on_new_investigation
     super
     pair.each { |duo| check(duo) }
@@ -53,8 +59,22 @@ class RuboCop::Cop::Elegant::PairedBrackets < RuboCop::Cop::Base
     opener, closer = duo
     return if opener.line == closer.line
     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)
+    register(opener) { |corrector| corrector.replace(trailing(opener), "\n#{indent}  ") } unless ends?(opener)
+    register(closer) { |corrector| corrector.replace(preceding(closer), "\n#{indent}") } unless starts?(closer)
+  end
+
+  def trailing(tok)
+    text = processed_source.buffer.source
+    stop = tok.pos.end_pos
+    stop += 1 while BLANKS.include?(text[stop])
+    tok.pos.end.resize(stop - tok.pos.end_pos)
+  end
+
+  def preceding(tok)
+    text = processed_source.buffer.source
+    from = tok.pos.begin_pos
+    from -= 1 while from.positive? && BLANKS.include?(text[from - 1])
+    tok.pos.begin.adjust(begin_pos: from - tok.pos.begin_pos)
   end
 
   def starts?(tok)

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+# Requires the SPDX header to sit above the code. The header is the
+# license declaration of the file, and REUSE keeps it in the first
+# few lines so that scanners, editors and reviewers read the license
+# without parsing past unrelated code. Only blank lines and comments
+# may precede it: a shebang, a magic comment, a RuboCop directive.
+# A file that carries no SPDX comment at all is left alone, because
+# checking that the tags exist is the job of +reuse lint+ and not of
+# this plugin. Only the first SPDX comment counts, so the tags of a
+# multi-line header may be split by nothing but comments.
+class RuboCop::Cop::Elegant::SpdxOnTop < RuboCop::Cop::Base
+  MSG = 'SPDX header must be above the code, but this line comes before it'
+  public_constant :MSG
+
+  def on_new_investigation
+    header = spdx
+    return if header.nil?
+    line = intruder(header.location.line)
+    return if line.nil?
+    add_offense(processed_source.buffer.line_range(line))
+  end
+
+  private
+
+  def spdx
+    processed_source.comments.find { |comment| comment.text.match?(/^#\s*SPDX-/) }
+  end
+
+  def intruder(stop)
+    (1...stop).find { |idx| code?(processed_source.lines[idx - 1]) }
+  end
+
+  def code?(line)
+    text = line.strip
+    !text.empty? && !text.start_with?('#')
+  end
+end

data/lib/rubocop/cop/elegant_cops.rb

@@ -17,3 +17,4 @@ require_relative 'elegant/no_nil_return'
 require_relative 'elegant/no_redundant_variable'
 require_relative 'elegant/one_class_per_file'
 require_relative 'elegant/paired_brackets'
+require_relative 'elegant/spdx_on_top'

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.7.0'
+  s.version = '0.8.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.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -65,6 +65,7 @@ files:
 - 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/spdx_on_top.rb
 - lib/rubocop/cop/elegant_cops.rb
 - lib/rubocop/elegant/plugin.rb
 - lib/rubocop/elegant/version.rb