rubocop-elegant 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8341c1ab1fa0a7363197452f41a6146ecff051b7f6f094386612cf3f27b5427
-  data.tar.gz: 229010b24b1fbafe803804f3b6615f9295727fe1f8e87bf79902dc9c2a0675d7
+  metadata.gz: d208aee894da49bf76dac6b393ecd907d137ce125f445903078f34def9435955
+  data.tar.gz: 2bb699562cc741372c3ab5f708a815cc2e046476d3a7646b267c72eb4c49ca98
 SHA512:
-  metadata.gz: f20ed17a83b4263d2c1336a9d5b1e1d44299c13014fba2a32220df5dd326794cbeda32e15fa1b68474661545b94744d58ed6e8400d894405329a51ad6ca0b965
-  data.tar.gz: 79975886caca7e40ac61a08a5a2737b9654c4dd4f43d6633a8a2a0a6047d01c1517094906b2d3920ebccd0e386d5a8afadaa784fc7cf5a5c87d5952f54ab9193
+  metadata.gz: 2c74ed34a71c7fc3b89799f80dc97a77afecf8c2d3d1220b27454b829b27ffd452937a9779a0b17bb562308ef023e9a93ecda0fb6a87c6d10413ef78abf69ca5
+  data.tar.gz: 472da807a9a7530dcdf5cb5147115b060a379a149d05adf53762134b07314d51d70fe57b855fdf8355a1c0190855a8f1ce59b663a7073ca7f0765aa24f716450

data/Gemfile

@@ -9,7 +9,7 @@ gemspec
 gem 'minitest', '~>6.0', require: false
 gem 'minitest-reporters', '~>1.7', require: false
 gem 'rake', '~>13.2', require: false
-gem 'rdoc', '7.1.0', require: false
+gem 'rdoc', '7.2.0', require: false
 gem 'rubocop', '~>1.74', require: false
 gem 'rubocop-minitest', '~>0.38', require: false
 gem 'rubocop-performance', '~>1.25', require: false

data/config/default.yml

@@ -17,6 +17,10 @@ Elegant/NoEmptyLinesInBlocks:
   Description: 'Disallows empty lines inside blocks (do/end, if/end, while, case, begin, etc.)'
   Enabled: true
   VersionAdded: '0.0.19'
+Elegant/NoNilReturn:
+  Description: 'Forbids a method or function from returning nil on any code path'
+  Enabled: true
+  VersionAdded: '0.1.0'
 Elegant/PairedBrackets:
   Description: 'Enforces the paired brackets notation: a bracket must pair on the same line, or start/end its line'
   Enabled: true

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

@@ -50,8 +50,7 @@ class RuboCop::Cop::Elegant::NoComments < RuboCop::Cop::Base
   def docblock?(comment)
     line = comment.location.line
     successor = codeline(line)
-    return false if successor.nil?
-    definition?(successor)
+    successor.positive? && definition?(successor)
   end
 
   def codeline(start)
@@ -63,7 +62,7 @@ class RuboCop::Cop::Elegant::NoComments < RuboCop::Cop::Base
       next if stripped.empty? || stripped.start_with?('#')
       return idx + 1
     end
-    nil
+    0
   end
 
   def definition?(line)

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+# Forbids a method from returning the literal +nil+ explicitly. The
+# cop flags two patterns: a +return nil+ statement anywhere inside
+# the method body, and a method whose tail expression is the literal
+# +nil+ (whether it stands alone or appears as the last statement of
+# a multi-statement body). Methods that omit +return+, use a bare
+# +return+ keyword, or merely happen to evaluate to +nil+ through
+# control flow are not flagged.
+class RuboCop::Cop::Elegant::NoNilReturn < RuboCop::Cop::Base
+  MSG = 'Method must not return nil explicitly'
+  public_constant :MSG
+
+  def on_def(node)
+    check(node)
+  end
+
+  def on_defs(node)
+    check(node)
+  end
+
+  private
+
+  def check(node)
+    return if node.body.nil?
+    explicit(node)
+    tail(node.body)
+  end
+
+  def explicit(node)
+    node.each_descendant(:return) do |ret|
+      next unless ret.each_ancestor(:def, :defs).first.equal?(node)
+      add_offense(ret) if void?(ret)
+    end
+  end
+
+  def void?(ret)
+    return false if ret.children.empty?
+    ret.children.all?(&:nil_type?)
+  end
+
+  def tail(node)
+    return add_offense(node) if node.nil_type?
+    tail(node.children.last) if node.begin_type? || node.kwbegin_type?
+  end
+end

data/lib/rubocop/cop/elegant_cops.rb

@@ -13,4 +13,5 @@ require_relative 'elegant/no_class_in_module'
 require_relative 'elegant/no_comments'
 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/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.1.0'
+  s.version = '0.2.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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -61,6 +61,7 @@ files:
 - lib/rubocop/cop/elegant/no_comments.rb
 - lib/rubocop/cop/elegant/no_empty_lines_in_blocks.rb
 - lib/rubocop/cop/elegant/no_empty_lines_in_methods.rb
+- lib/rubocop/cop/elegant/no_nil_return.rb
 - lib/rubocop/cop/elegant/paired_brackets.rb
 - lib/rubocop/cop/elegant_cops.rb
 - lib/rubocop/elegant/plugin.rb