rubocop-elegant 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07050b077e5266437a527369312875e178be1df47c24f2792fd5945060fe0e26
-  data.tar.gz: 04ad13719f726d00a61a5cd287573813ce6d2780ef4ef7e8ea4092ed02a24af2
+  metadata.gz: 60367f0f72f86e055af5d89d7120871578083d2812c4996e6fa027fb6d3b6cae
+  data.tar.gz: 72077f0159044736a87ebb84c818c72d8280182d8fc6fcbf42f09d776d9c0775
 SHA512:
-  metadata.gz: 384fa71d95456e0515d5bb4a518a65af285f6e9774289163595e3f1a1885473dab1f85f931ce731e5376d6fa73029991f7cd5624771736e5650dec8e06b845ab
-  data.tar.gz: d9d7248056d93b0c1c0d81afd0e7c96c709e314e944eeb95365ef1affe3d4f1342607f84b6da874a2e3a68ae3eb21fa0064e9163449935f1a695906f2da5fae4
+  metadata.gz: 6f906093f750d1a9c5db831efb8ddc769d00a6449b62432a6ca645c6dc256f62944b9af2d45688f028cc5b242001ff9fa634a261ecbec928399233f2ba25b93e
+  data.tar.gz: 6f1e7b0f76573edea8582d3607c4e5deaae6b8944bfa133ed58d121cf9a2d4afc38dc6eb26d87fb4a388ded4a1bb355c9d7e56da380448f70b33d7baa35ab9e5

data/README.md

@@ -26,7 +26,7 @@ The custom cops add the following restrictions:
 * 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:
@@ -50,7 +50,7 @@ Elegant/OneClassPerFile:
   Exclude:
     - '**/*Test.rb'
     - '**/test_*.rb'
-Elegant/IndentationLadder:
+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
   VersionAdded: '0.1.0'

data/lib/rubocop/cop/elegant/{indentation_ladder.rb → monotonic_indents.rb}

@@ -3,7 +3,7 @@
 # SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
-# Enforces the "indentation ladder" rule: when a line is indented further
+# Enforces the "monotonic indentation" rule: when a line is indented further
 # to the right than the previous non-empty line, the extra indentation
 # must be exactly two spaces. Larger jumps (or odd ones, such as a single
 # space or three spaces) break the visual rhythm of the code and make
@@ -11,7 +11,7 @@
 # de-indent by any amount, are not affected. Lines that belong to the
 # body of a heredoc are ignored, because their whitespace is part of the
 # literal value rather than program structure.
-class RuboCop::Cop::Elegant::IndentationLadder < RuboCop::Cop::Base
+class RuboCop::Cop::Elegant::MonotonicIndents < RuboCop::Cop::Base
   MSG = 'Indentation step of %<step>d spaces is not allowed; use 2 spaces'
   public_constant :MSG
 

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_cops.rb

@@ -8,7 +8,7 @@ module RuboCop::Cop::Elegant; end
 require_relative 'elegant/class_in_module'
 require_relative 'elegant/good_method_name'
 require_relative 'elegant/good_variable_name'
-require_relative 'elegant/indentation_ladder'
+require_relative 'elegant/monotonic_indents'
 require_relative 'elegant/no_class_in_module'
 require_relative 'elegant/no_comments'
 require_relative 'elegant/no_empty_lines_in_blocks'

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.5.0'
+  s.version = '0.6.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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -56,7 +56,7 @@ files:
 - lib/rubocop/cop/elegant/class_in_module.rb
 - lib/rubocop/cop/elegant/good_method_name.rb
 - lib/rubocop/cop/elegant/good_variable_name.rb
-- lib/rubocop/cop/elegant/indentation_ladder.rb
+- lib/rubocop/cop/elegant/monotonic_indents.rb
 - lib/rubocop/cop/elegant/no_class_in_module.rb
 - lib/rubocop/cop/elegant/no_comments.rb
 - lib/rubocop/cop/elegant/no_empty_lines_in_blocks.rb