rubocop-elegant 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0441b4d9f29a02a65680ffc46fb56985251723336a076999f7867ad7eb92185d
-  data.tar.gz: 92771eff5ed80253a14a85fd96ecaace40e7ce0476f2e26c6cb42372a26b9706
+  metadata.gz: 400170a3fda22ccd3c629d58a47a9c142da2ebd38bd34c292fc702fc47e3fc51
+  data.tar.gz: c82766e8b09239583a125b2d769e01a356330a83210e113dfdf43031a81a59ec
 SHA512:
-  metadata.gz: b1fd06eba3ce66013593a26400d81698fa3eeb01725890aa3ae5e0f78d086729b6b633f9d6a0551e61e2c1118ad844a12daba2ab97da5306ff13b8feb48a3d2b
-  data.tar.gz: 7595e8287a2f7f3904d643c98c1bafc412c2bfebcf4eb2de364ae13af4badf491985eba022f86cf93362efb997d0df57a171068a3ecc1ffb0b27d0c0cbf6e028
+  metadata.gz: 1c2d09a8e4d0ffa82a2371396310bdd2d1cb0fa1308b87333f13edb30d9b3551a769309fe8e7a311806c221319c89b4be3160261115e92d9935ace180b878974
+  data.tar.gz: 7200ec078d268fe5baadd7ba8627f3b20c705273444cdd7ad81b73d63009ffa93f9ae91be1fc267ae46b17b551519c5c93d4adfbabbfa228e7a0b78945dfaa18

data/README.md

@@ -22,10 +22,11 @@ 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.
-* Comments are forbidden, except SPDX, magic, RuboCop directives, and class docblocks.
+* Comments are forbidden, except SPDX, magic, RuboCop, PDD puzzles, docblocks.
 * Empty lines inside block bodies are forbidden.
 * Empty lines inside method bodies are forbidden.
 * A method cannot return `nil` explicitly.

data/config/default.yml

@@ -6,7 +6,7 @@ Elegant:
   Enabled: true
   DocumentationBaseURL: https://github.com/yegor256/rubocop-elegant
 Elegant/NoComments:
-  Description: 'Disallows comments in source code, except SPDX license comments'
+  Description: 'Disallows comments in source code, except SPDX, magic, rubocop directives, PDD puzzles, and docblocks'
   Enabled: true
   VersionAdded: '0.0.1'
 Elegant/NoEmptyLinesInMethods:
@@ -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_comments.rb

@@ -6,7 +6,7 @@
 class RuboCop::Cop::Elegant::NoComments < RuboCop::Cop::Base
   extend RuboCop::Cop::AutoCorrector
 
-  MSG = 'Comment is not allowed, unless it is SPDX, magic, rubocop directive, or docblock'
+  MSG = 'Comment is not allowed, unless it is SPDX, magic, rubocop directive, PDD puzzle, or docblock'
   public_constant :MSG
 
   def on_new_investigation
@@ -18,7 +18,11 @@ class RuboCop::Cop::Elegant::NoComments < RuboCop::Cop::Base
   private
 
   def allowed?(comment)
-    spdx?(comment) || magic?(comment) || rubocop?(comment) || (gemspec? && docblock?(comment))
+    spdx?(comment) || magic?(comment) || rubocop?(comment) || puzzle?(comment) || (gemspec? && docblock?(comment))
+  end
+
+  def puzzle?(comment)
+    comment.text.match?(/@todo\b/i)
   end
 
   def spdx?(comment)

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_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.4.0'
+  s.version = '0.5.1'
   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.4.0
+  version: 0.5.1
 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