rubocop-elegant 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1262955aaa8770a1b4062070123e8031215c8b2911a6a2f52d071c9d6c158aa
-  data.tar.gz: 6ec9a7642d5b60757a9bd2ab3ee5d4cd6f1d84ec4bf4dfba8ae56b59822667d4
+  metadata.gz: 9f7c0aef0e7b019ddcf1407cbb966e2547ff955cca1ffe8d3ec78a8d22eda8e6
+  data.tar.gz: 66f52927f1f7259b0fcf8d2f901aa2926f40e5097e53a301468bc5b4c38e847d
 SHA512:
-  metadata.gz: 7eab52e45a6013c0141883ab378a4934e19c7c62ad17635371164f504aed2e587f037f2259d93d1b85d9026392faa8b41e635af8b432071388b9315c8e93e001
-  data.tar.gz: d7a6d666c477085ad0414e1ffb3dbb47006f8908e7b7f8e4b08ca447c738435df96ee8c09d727186d5e99b83162ffd6dae6f988be99ca214c13a3833e7e7a270
+  metadata.gz: f109d30c32086be17e951884f862da17a291de33b3a5cfc6a1327b1d6446ac4a4d207f68a9356d7c72f1c212f31cac81afa9f075666b471e0c75a9ffb8185460
+  data.tar.gz: 622118dad505c7affc71c01070734a7e370a30d967752a30c204c1b77267dbb6d48640c58e8df81f1c1922cd149e8a491bcb898a11efa5e191670153f2d633ae

data/Rakefile

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

data/config/default.yml

@@ -12,20 +12,29 @@ Elegant/NoEmptyLinesInMethods:
   Description: 'Disallows empty lines inside method bodies'
   Enabled: true
   VersionAdded: '0.0.2'
+Elegant/GoodVariableName:
+  Description: 'Checks that variable names match the configured pattern'
+  Enabled: true
+  VersionAdded: '0.0.3'
+  Pattern: '^(@|@@|\$|the_|test_|fake_)?[a-z]{1,16}$'
+Elegant/GoodMethodName:
+  Description: 'Checks that method names match the configured pattern'
+  Enabled: true
+  VersionAdded: '0.0.3'
+  Pattern: '^((fake_|the_)?[a-z]{1,16}[!?]?|test_[a-z_]+|on_[a-z_]+)$'
 
 Naming/VariableName:
-  AllowedPatterns:
-    - '^(@|@@|\$|the_|test_|fake_)?[a-z]{1,16}$'
-Metrics/MethodLength:
-  Max: 100
+  Enabled: false
+Naming/MethodName:
+  Enabled: false
 Metrics/ClassLength:
   Max: 300
+Metrics/MethodLength:
+  Max: 100
+Metrics/BlockLength:
+  Max: 50
 Metrics/AbcSize:
   Max: 50
-Naming/MethodName:
-  AllowedPatterns:
-    - '^(fake_|the_)?[a-z]{1,16}(!|\?)?$'
-    - '^test_[a-z_]+$'
 Style/IfUnlessModifier:
   Enabled: false
 Naming/FileName:
@@ -68,6 +77,8 @@ Style/StaticClass:
   Enabled: true
 Style/TopLevelMethodDefinition:
   Enabled: true
+  Exclude:
+    - 'Rakefile'
 Style/ImplicitRuntimeError:
   Enabled: true
 Style/DateTime:
@@ -78,3 +89,7 @@ Performance/ChainArrayAllocation:
   Enabled: true
 Performance/OpenStruct:
   Enabled: true
+Metrics/CyclomaticComplexity:
+  Max: 15
+Metrics/PerceivedComplexity:
+  Max: 15

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+module RuboCop
+  module Cop
+    module Elegant
+      class GoodMethodName < Base
+        MSG = 'Method name "%<name>s" does not match the required pattern'
+
+        def on_def(node)
+          check(node, node.method_name.to_s)
+        end
+
+        def on_defs(node)
+          check(node, node.method_name.to_s)
+        end
+
+        private
+
+        def check(node, name)
+          return if match?(name)
+          add_offense(node, message: format(MSG, name: name))
+        end
+
+        def match?(name)
+          pattern.match?(name)
+        end
+
+        def pattern
+          @pattern ||= Regexp.new(cop_config['Pattern'] || '^[a-z]+[!?]?$')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+module RuboCop
+  module Cop
+    module Elegant
+      class GoodVariableName < Base
+        MSG = 'Variable name "%<name>s" does not match the required pattern'
+
+        def on_lvasgn(node)
+          check(node, node.children.first.to_s)
+        end
+
+        def on_ivasgn(node)
+          check(node, node.children.first.to_s)
+        end
+
+        def on_cvasgn(node)
+          check(node, node.children.first.to_s)
+        end
+
+        def on_gvasgn(node)
+          check(node, node.children.first.to_s)
+        end
+
+        private
+
+        def check(node, name)
+          return if match?(name)
+          add_offense(node, message: format(MSG, name: name))
+        end
+
+        def match?(name)
+          pattern.match?(name)
+        end
+
+        def pattern
+          @pattern ||= Regexp.new(cop_config['Pattern'] || '^[a-z]+$')
+        end
+      end
+    end
+  end
+end

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

@@ -37,30 +37,30 @@ module RuboCop
 
         def register(comment)
           add_offense(comment) do |corrector|
-            corrector.remove(removal_range(comment))
+            corrector.remove(removal(comment))
           end
         end
 
-        def removal_range(comment)
-          range = comment.source_range
-          line_start = range.source_line[0, range.column]
-          return range_with_line(range) if line_start.strip.empty?
-          range_with_prefix(range, line_start)
+        def removal(comment)
+          target = comment.source_range
+          prefix = target.source_line[0, target.column]
+          return fullrange(target) if prefix.strip.empty?
+          prefixed(target, prefix)
         end
 
-        def range_with_line(range)
-          start_pos = range.begin_pos - range.column
-          end_pos = range.end_pos
-          end_pos += 1 if newline_after?(end_pos)
-          range.with(begin_pos: start_pos, end_pos: end_pos)
+        def fullrange(target)
+          start = target.begin_pos - target.column
+          ending = target.end_pos
+          ending += 1 if newline?(ending)
+          target.with(begin_pos: start, end_pos: ending)
         end
 
-        def range_with_prefix(range, prefix)
-          whitespace = prefix.match(/\s*$/)[0]
-          range.with(begin_pos: range.begin_pos - whitespace.length, end_pos: range.end_pos)
+        def prefixed(target, prefix)
+          spaces = prefix.match(/\s*$/)[0]
+          target.with(begin_pos: target.begin_pos - spaces.length, end_pos: target.end_pos)
         end
 
-        def newline_after?(pos)
+        def newline?(pos)
           processed_source.buffer.source[pos] == "\n"
         end
       end

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

@@ -23,40 +23,38 @@ module RuboCop
 
         def check(node)
           return if node.body.nil?
-          body_range = body_range(node)
-          return if body_range.nil?
-          find_empty_lines(body_range).each do |line_range|
-            register(line_range)
-          end
+          lines = range(node)
+          return if lines.nil?
+          empty(lines).each { |num| register(num) }
         end
 
-        def body_range(node)
-          first_line = node.body.first_line
-          last_line = node.body.last_line
-          return nil if first_line == last_line
-          (first_line..last_line)
+        def range(node)
+          first = node.body.first_line
+          last = node.body.last_line
+          return nil if first == last
+          (first..last)
         end
 
-        def find_empty_lines(line_range)
-          empty = []
-          line_range.each do |line_num|
-            line = processed_source.lines[line_num - 1]
-            empty << line_num if line.strip.empty?
+        def empty(lines)
+          result = []
+          lines.each do |num|
+            line = processed_source.lines[num - 1]
+            result << num if line.strip.empty?
           end
-          empty
+          result
         end
 
-        def register(line_num)
-          range = processed_source.buffer.line_range(line_num)
-          add_offense(range) do |corrector|
-            corrector.remove(line_with_newline(range))
+        def register(num)
+          target = processed_source.buffer.line_range(num)
+          add_offense(target) do |corrector|
+            corrector.remove(fullrange(target))
           end
         end
 
-        def line_with_newline(range)
-          end_pos = range.end_pos
-          end_pos += 1 if processed_source.buffer.source[end_pos] == "\n"
-          range.with(end_pos: end_pos)
+        def fullrange(target)
+          ending = target.end_pos
+          ending += 1 if processed_source.buffer.source[ending] == "\n"
+          target.with(end_pos: ending)
         end
       end
     end

data/lib/rubocop/cop/elegant_cops.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'elegant/good_method_name'
+require_relative 'elegant/good_variable_name'
 # SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 

data/lib/rubocop-elegant.rb

@@ -4,6 +4,6 @@
 # SPDX-License-Identifier: MIT
 
 require 'rubocop'
-require_relative 'rubocop/elegant/version'
-require_relative 'rubocop/elegant/plugin'
 require_relative 'rubocop/cop/elegant_cops'
+require_relative 'rubocop/elegant/plugin'
+require_relative 'rubocop/elegant/version'

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.0.6'
+  s.version = '0.0.7'
   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.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -53,6 +53,8 @@ files:
 - Rakefile
 - config/default.yml
 - lib/rubocop-elegant.rb
+- lib/rubocop/cop/elegant/good_method_name.rb
+- lib/rubocop/cop/elegant/good_variable_name.rb
 - lib/rubocop/cop/elegant/no_comments.rb
 - lib/rubocop/cop/elegant/no_empty_lines_in_methods.rb
 - lib/rubocop/cop/elegant_cops.rb