rubocop 1.50.2 → 1.68.0

data/lib/rubocop/cop/util.rb

@@ -20,6 +20,10 @@ module RuboCop
 
       # @deprecated Use `ProcessedSource#line_with_comment?`, `contains_comment?` or similar
       def comment_lines?(node)
+        warn Rainbow(<<~WARNING).yellow, uplevel: 1
+          `comment_lines?` is deprecated. Use `ProcessedSource#line_with_comment?`, `contains_comment?` or similar instead.
+        WARNING
+
         processed_source[line_range(node)].any? { |line| comment_line?(line) }
       end
 
@@ -28,7 +32,7 @@ module RuboCop
       end
 
       def parentheses?(node)
-        node.loc.respond_to?(:end) && node.loc.end && node.loc.end.is?(')')
+        node.loc.respond_to?(:end) && node.loc.end&.is?(')')
       end
 
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
@@ -142,7 +146,7 @@ module RuboCop
       end
 
       def escape_string(string)
-        string.inspect[1..-2].tap { |s| s.gsub!(/\\"/, '"') }
+        string.inspect[1..-2].tap { |s| s.gsub!('\\"', '"') }
       end
 
       def to_string_literal(string)
@@ -173,7 +177,9 @@ module RuboCop
       def same_line?(node1, node2)
         line1 = line(node1)
         line2 = line(node2)
-        line1 && line2 && line1 == line2
+        return false unless line1 && line2
+
+        line1 == line2
       end
 
       def indent(node, offset: 0)

data/lib/rubocop/cop/utils/regexp_ranges.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Utils
+      # Helper to abstract complexity of building range pairs
+      # with octal escape reconstruction (needed for regexp_parser < 2.7).
+      class RegexpRanges
+        attr_reader :root
+
+        def initialize(root)
+          @root = root
+          @compound_token = []
+          @pairs = []
+          @populated = false
+        end
+
+        def compound_token
+          populate_all unless @populated
+
+          @compound_token
+        end
+
+        def pairs
+          populate_all unless @populated
+
+          @pairs
+        end
+
+        private
+
+        def populate_all
+          populate(@root)
+
+          # If either bound is a compound the first one is an escape
+          # and that's all we need to work with.
+          # If there are any cops that wanted to operate on the compound
+          # expression we could wrap it with a facade class.
+          @pairs.map! { |pair| pair.map(&:first) }
+
+          @populated = true
+        end
+
+        def populate(expr)
+          expressions = expr.expressions.to_a
+
+          until expressions.empty?
+            current = expressions.shift
+
+            if escaped_octal?(current)
+              @compound_token << current
+              @compound_token.concat(pop_octal_digits(expressions))
+              # If we have all the digits we can discard.
+            end
+
+            next unless current.type == :set
+
+            process_set(expressions, current)
+            @compound_token.clear
+          end
+        end
+
+        def process_set(expressions, current)
+          case current.token
+          when :range
+            @pairs << compose_range(expressions, current)
+          when :character
+            # Child expressions may include the range we are looking for.
+            populate(current)
+          when :intersection
+            # Each child expression could have child expressions that lead to ranges.
+            current.expressions.each do |intersected|
+              populate(intersected)
+            end
+          end
+        end
+
+        def compose_range(expressions, current)
+          range_start, range_end = current.expressions
+          range_start = if @compound_token.size.between?(1, 2) && octal_digit?(range_start.text)
+                          @compound_token.dup << range_start
+                        else
+                          [range_start]
+                        end
+          range_end = [range_end]
+          range_end.concat(pop_octal_digits(expressions)) if escaped_octal?(range_end.first)
+          [range_start, range_end]
+        end
+
+        def escaped_octal?(expr)
+          expr.text.valid_encoding? && expr.text =~ /^\\[0-7]$/
+        end
+
+        def octal_digit?(char)
+          ('0'..'7').cover?(char)
+        end
+
+        def pop_octal_digits(expressions)
+          digits = []
+
+          2.times do
+            next unless (next_child = expressions.first)
+            next unless next_child.type == :literal && next_child.text =~ /^[0-7]$/
+
+            digits << expressions.shift
+          end
+
+          digits
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/variable_force/assignment.rb

@@ -9,9 +9,10 @@ module RuboCop
 
         MULTIPLE_LEFT_HAND_SIDE_TYPE = :mlhs
 
-        attr_reader :node, :variable, :referenced, :references
+        attr_reader :node, :variable, :referenced, :references, :reassigned
 
         alias referenced? referenced
+        alias reassigned? reassigned
 
         def initialize(node, variable)
           unless VARIABLE_ASSIGNMENT_TYPES.include?(node.type)
@@ -24,6 +25,7 @@ module RuboCop
           @variable = variable
           @referenced = false
           @references = []
+          @reassigned = false
         end
 
         def name
@@ -39,14 +41,24 @@ module RuboCop
           @referenced = true
         end
 
+        def reassigned!
+          return if referenced?
+
+          @reassigned = true
+        end
+
         def used?
-          @variable.captured_by_block? || @referenced
+          (!reassigned? && @variable.captured_by_block?) || @referenced
         end
 
         def regexp_named_capture?
           @node.type == REGEXP_NAMED_CAPTURE_TYPE
         end
 
+        def exception_assignment?
+          node.parent&.resbody_type? && node.parent.exception_variable == node
+        end
+
         def operator_assignment?
           return false unless meta_assignment_node
 
@@ -59,6 +71,18 @@ module RuboCop
           meta_assignment_node.type == MULTIPLE_ASSIGNMENT_TYPE
         end
 
+        def rest_assignment?
+          return false unless meta_assignment_node
+
+          meta_assignment_node.type == REST_ASSIGNMENT_TYPE
+        end
+
+        def for_assignment?
+          return false unless meta_assignment_node
+
+          meta_assignment_node.for_type?
+        end
+
         def operator
           assignment_node = meta_assignment_node || @node
           assignment_node.loc.operator.source
@@ -66,7 +90,10 @@ module RuboCop
 
         def meta_assignment_node
           unless instance_variable_defined?(:@meta_assignment_node)
-            @meta_assignment_node = operator_assignment_node || multiple_assignment_node
+            @meta_assignment_node = operator_assignment_node ||
+                                    multiple_assignment_node ||
+                                    rest_assignment_node ||
+                                    for_assignment_node
           end
 
           @meta_assignment_node
@@ -83,13 +110,42 @@ module RuboCop
         end
 
         def multiple_assignment_node
-          grandparent_node = node.parent&.parent
-          return nil unless grandparent_node
+          return nil unless node.parent&.mlhs_type?
+          return nil unless (grandparent_node = node.parent&.parent)
+          if (node = find_multiple_assignment_node(grandparent_node))
+            return node
+          end
           return nil unless grandparent_node.type == MULTIPLE_ASSIGNMENT_TYPE
-          return nil unless node.parent.type == MULTIPLE_LEFT_HAND_SIDE_TYPE
 
           grandparent_node
         end
+
+        def rest_assignment_node
+          return nil unless node.parent
+          return nil unless node.parent.type == REST_ASSIGNMENT_TYPE
+
+          node.parent
+        end
+
+        def for_assignment_node
+          return unless (parent_node = node.parent)
+          return parent_node if parent_node.for_type?
+
+          grandparent_node = parent_node.parent
+          return grandparent_node if parent_node.mlhs_type? && grandparent_node&.for_type?
+
+          nil
+        end
+
+        def find_multiple_assignment_node(grandparent_node)
+          return unless grandparent_node.type == MULTIPLE_LEFT_HAND_SIDE_TYPE
+          return if grandparent_node.children.any?(&:splat_type?)
+
+          parent = grandparent_node.parent
+          return parent if parent.type == MULTIPLE_ASSIGNMENT_TYPE
+
+          find_multiple_assignment_node(parent)
+        end
       end
     end
   end

data/lib/rubocop/cop/variable_force/branch.rb

@@ -74,7 +74,7 @@ module RuboCop
           def parent
             return @parent if instance_variable_defined?(:@parent)
 
-            @branch = Branch.of(control_node, scope: scope)
+            @parent = Branch.of(control_node, scope: scope)
           end
 
           def each_ancestor(include_self: false, &block)

data/lib/rubocop/cop/variable_force/variable.rb

@@ -29,7 +29,11 @@ module RuboCop
         end
 
         def assign(node)
-          @assignments << Assignment.new(node, self)
+          assignment = Assignment.new(node, self)
+
+          @assignments.last&.reassigned! unless captured_by_block?
+
+          @assignments << assignment
         end
 
         def referenced?

data/lib/rubocop/cop/variable_force/variable_table.rb

@@ -61,8 +61,8 @@ module RuboCop
                   "at #{node.source_range}, #{node.inspect}"
           end
 
-          variable.assign(node)
           mark_variable_as_captured_by_block_if_so(variable)
+          variable.assign(node)
         end
 
         def reference_variable(name, node)
@@ -87,8 +87,8 @@ module RuboCop
           # So just skip.
           return unless variable
 
-          variable.reference!(node)
           mark_variable_as_captured_by_block_if_so(variable)
+          variable.reference!(node)
         end
 
         def find_variable(name)
@@ -113,14 +113,14 @@ module RuboCop
         def accessible_variables
           scope_stack.reverse_each.with_object([]) do |scope, variables|
             variables.concat(scope.variables.values)
-            break variables unless scope.node.block_type?
+            break variables unless scope.node.block_type? || scope.node.numblock_type?
           end
         end
 
         private
 
         def mark_variable_as_captured_by_block_if_so(variable)
-          return unless current_scope.node.block_type?
+          return unless current_scope.node.block_type? || current_scope.node.numblock_type?
           return if variable.scope == current_scope
 
           variable.capture_with_block!

data/lib/rubocop/cop/variable_force.rb

@@ -27,7 +27,10 @@ module RuboCop
     class VariableForce < Force # rubocop:disable Metrics/ClassLength
       VARIABLE_ASSIGNMENT_TYPE = :lvasgn
       REGEXP_NAMED_CAPTURE_TYPE = :match_with_lvasgn
-      VARIABLE_ASSIGNMENT_TYPES = [VARIABLE_ASSIGNMENT_TYPE, REGEXP_NAMED_CAPTURE_TYPE].freeze
+      PATTERN_MATCH_VARIABLE_TYPE = :match_var
+      VARIABLE_ASSIGNMENT_TYPES = [
+        VARIABLE_ASSIGNMENT_TYPE, REGEXP_NAMED_CAPTURE_TYPE, PATTERN_MATCH_VARIABLE_TYPE
+      ].freeze
 
       ARGUMENT_DECLARATION_TYPES = [
         :arg, :optarg, :restarg,
@@ -40,6 +43,7 @@ module RuboCop
       OPERATOR_ASSIGNMENT_TYPES = (LOGICAL_OPERATOR_ASSIGNMENT_TYPES + [:op_asgn]).freeze
 
       MULTIPLE_ASSIGNMENT_TYPE = :masgn
+      REST_ASSIGNMENT_TYPE = :splat
 
       VARIABLE_REFERENCE_TYPE = :lvar
 
@@ -111,6 +115,7 @@ module RuboCop
       NODE_HANDLER_METHOD_NAMES = [
         [VARIABLE_ASSIGNMENT_TYPE, :process_variable_assignment],
         [REGEXP_NAMED_CAPTURE_TYPE, :process_regexp_named_captures],
+        [PATTERN_MATCH_VARIABLE_TYPE, :process_pattern_match_variable],
         [MULTIPLE_ASSIGNMENT_TYPE, :process_variable_multiple_assignment],
         [VARIABLE_REFERENCE_TYPE, :process_variable_referencing],
         [RESCUE_TYPE, :process_rescue],
@@ -174,6 +179,14 @@ module RuboCop
         skip_children!
       end
 
+      def process_pattern_match_variable(node)
+        name = node.children.first
+
+        variable_table.declare_variable(name, node) unless variable_table.variable_exist?(name)
+
+        skip_children!
+      end
+
       def regexp_captured_names(node)
         regexp = node.to_regexp
 

data/lib/rubocop/cops_documentation_generator.rb

@@ -1,23 +1,49 @@
 # frozen_string_literal: true
 
 require 'fileutils'
+require 'yard'
 
 # Class for generating documentation of all cops departments
 # @api private
 class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   include ::RuboCop::Cop::Documentation
+  CopData = Struct.new(
+    :cop, :description, :example_objects, :safety_objects, :see_objects, :config, keyword_init: true
+  )
+
+  STRUCTURE = {
+    name:                  ->(data) { cop_header(data.cop) },
+    required_ruby_version: ->(data) { required_ruby_version(data.cop) },
+    properties:            ->(data) { properties(data.cop) },
+    description:           ->(data) { "#{data.description}\n" },
+    safety:                ->(data) { safety_object(data.safety_objects, data.cop) },
+    examples:              ->(data) { examples(data.example_objects, data.cop) },
+    configuration:         ->(data) { configurations(data.cop.department, data.config, data.cop) },
+    references:            ->(data) { references(data.cop, data.see_objects) }
+  }.freeze
+
   # This class will only generate documentation for cops that belong to one of
   # the departments given in the `departments` array. E.g. if we only wanted
   # documentation for Lint cops:
   #
   #   CopsDocumentationGenerator.new(departments: ['Lint']).call
   #
-  def initialize(departments: [])
+  # You can append additional information:
+  #
+  #   callback = ->(data) { required_rails_version(data.cop) }
+  #   CopsDocumentationGenerator.new(extra_info: { ruby_version: callback }).call
+  #
+  # This will insert the string returned from the lambda _after_ the section from RuboCop itself.
+  # See `CopsDocumentationGenerator::STRUCTURE` for available sections.
+  #
+  def initialize(departments: [], extra_info: {}, base_dir: Dir.pwd)
     @departments = departments.map(&:to_sym).sort!
+    @extra_info = extra_info
     @cops = RuboCop::Cop::Registry.global
     @config = RuboCop::ConfigLoader.default_configuration
-    @docs_path = "#{Dir.pwd}/docs/modules/ROOT/pages/"
-    FileUtils.mkdir_p(@docs_path)
+    @base_dir = base_dir
+    @docs_path = "#{base_dir}/docs/modules/ROOT"
+    FileUtils.mkdir_p("#{@docs_path}/pages")
   end
 
   def call
@@ -37,24 +63,21 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     cops.with_department(department).sort!
   end
 
-  def cops_body(cop, description, examples_objects, safety_objects, see_objects, pars) # rubocop:disable Metrics/AbcSize, Metrics/ParameterLists
-    check_examples_to_have_the_default_enforced_style!(examples_objects, cop)
-
-    content = h2(cop.cop_name)
-    content << required_ruby_version(cop)
-    content << properties(cop)
-    content << "#{description}\n"
-    content << safety_object(safety_objects) if safety_objects.any? { |s| !s.text.blank? }
-    content << examples(examples_objects) if examples_objects.any?
-    content << configurations(cop.department, pars)
-    content << references(cop, see_objects)
+  def cops_body(data)
+    check_examples_to_have_the_default_enforced_style!(data.example_objects, data.cop)
+
+    content = +''
+    STRUCTURE.each do |section, block|
+      content << instance_exec(data, &block)
+      content << @extra_info[section].call(data) if @extra_info[section]
+    end
     content
   end
 
-  def check_examples_to_have_the_default_enforced_style!(examples_object, cop)
-    return if examples_object.none?
+  def check_examples_to_have_the_default_enforced_style!(example_objects, cop)
+    return if example_objects.none?
 
-    examples_describing_enforced_style = examples_object.map(&:name).grep(/EnforcedStyle:/)
+    examples_describing_enforced_style = example_objects.map(&:name).grep(/EnforcedStyle:/)
     return if examples_describing_enforced_style.none?
 
     if examples_describing_enforced_style.index { |name| name.match?('default') }.nonzero?
@@ -66,16 +89,20 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     raise "Specify the default EnforcedStyle for #{cop.cop_name}"
   end
 
-  def examples(examples_object)
-    examples_object.each_with_object(h3('Examples').dup) do |example, content|
+  def examples(example_objects, cop)
+    return '' if example_objects.none?
+
+    example_objects.each_with_object(cop_subsection('Examples', cop).dup) do |example, content|
       content << "\n" unless content.end_with?("\n\n")
-      content << h4(example.name) unless example.name == ''
+      content << example_header(example.name, cop) unless example.name == ''
       content << code_example(example)
     end
   end
 
-  def safety_object(safety_object_objects)
-    safety_object_objects.each_with_object(h3('Safety').dup) do |safety_object, content|
+  def safety_object(safety_objects, cop)
+    return '' if safety_objects.all? { |s| s.text.blank? }
+
+    safety_objects.each_with_object(cop_subsection('Safety', cop).dup) do |safety_object, content|
       next if safety_object.text.blank?
 
       content << "\n" unless content.end_with?("\n\n")
@@ -97,7 +124,9 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
       'Version Changed'
     ]
     autocorrect = if cop.support_autocorrect?
-                    "Yes#{' (Unsafe)' unless cop.new(config).safe_autocorrect?}"
+                    context = cop.new.always_autocorrect? ? 'Always' : 'Command-line only'
+
+                    "#{context}#{' (Unsafe)' unless cop.new(config).safe_autocorrect?}"
                   else
                     'No'
                   end
@@ -113,22 +142,25 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   end
   # rubocop:enable Metrics/MethodLength
 
-  def h2(title)
+  def cop_header(cop)
     content = +"\n"
-    content << "== #{title}\n"
+    content << "[##{to_anchor(cop.cop_name)}]\n"
+    content << "== #{cop.cop_name}\n"
     content << "\n"
     content
   end
 
-  def h3(title)
+  def cop_subsection(title, cop)
     content = +"\n"
+    content << "[##{to_anchor(title)}-#{to_anchor(cop.cop_name)}]\n"
     content << "=== #{title}\n"
     content << "\n"
     content
   end
 
-  def h4(title)
-    content = +"==== #{title}\n"
+  def example_header(title, cop)
+    content = +"[##{to_anchor(title)}-#{to_anchor(cop.cop_name)}]\n"
+    content << "==== #{title}\n"
     content << "\n"
     content
   end
@@ -140,7 +172,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     content
   end
 
-  def configurations(department, pars)
+  def configurations(department, pars, cop)
     return '' if pars.empty?
 
     header = ['Name', 'Default value', 'Configurable values']
@@ -155,7 +187,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
       [configuration_name(department, name), default, configurable]
     end
 
-    h3('Configurable attributes') + to_table(header, content)
+    cop_subsection('Configurable attributes', cop) + to_table(header, content)
   end
 
   def configuration_name(department, name)
@@ -198,7 +230,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     table = ['|===', "| #{header.join(' | ')}\n\n"].join("\n")
     marked_contents = content.map do |plain_content|
       # Escape `|` with backslash to prevent the regexp `|` is not used as a table separator.
-      plain_content.map { |c| "| #{c.gsub(/\|/, '\|')}" }.join("\n")
+      plain_content.map { |c| "| #{c.gsub('|', '\|')}" }.join("\n")
     end
     table << marked_contents.join("\n\n")
     table << "\n|===\n"
@@ -216,7 +248,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
       else
         wrap_backtick(val.nil? ? '<none>' : val)
       end
-    value.gsub("#{Dir.pwd}/", '').rstrip
+    value.gsub("#{@base_dir}/", '').rstrip
   end
 
   def wrap_backtick(value)
@@ -233,7 +265,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     urls = RuboCop::Cop::MessageAnnotator.new(config, cop.name, cop_config, {}).urls
     return '' if urls.empty? && see_objects.empty?
 
-    content = h3('References')
+    content = cop_subsection('References', cop)
     content << urls.map { |url| "* #{url}" }.join("\n")
     content << "\n" unless urls.empty?
     content << see_objects.map { |see| "* #{see.name}" }.join("\n")
@@ -245,40 +277,52 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     return '' unless department == :Layout
 
     filename = "#{department_to_basename(department)}_footer.adoc"
-    file = "#{Dir.pwd}/docs/modules/ROOT/partials/#{filename}"
+    file = "#{docs_path}/partials/#{filename}"
     return '' unless File.exist?(file)
 
     "\ninclude::../partials/#{filename}[]\n"
   end
 
+  # rubocop:disable Metrics/MethodLength
   def print_cops_of_department(department)
     selected_cops = cops_of_department(department)
-    content = +"= #{department}\n"
+    content = +<<~HEADER
+      ////
+        Do NOT edit this file by hand directly, as it is automatically generated.
+
+        Please make any necessary changes to the cop documentation within the source files themselves.
+      ////
+
+      = #{department}
+    HEADER
     selected_cops.each { |cop| content << print_cop_with_doc(cop) }
     content << footer_for_department(department)
-    file_name = "#{docs_path}/#{department_to_basename(department)}.adoc"
+    file_name = "#{docs_path}/pages/#{department_to_basename(department)}.adoc"
     File.open(file_name, 'w') do |file|
       puts "* generated #{file_name}"
       file.write("#{content.strip}\n")
     end
   end
+  # rubocop:enable Metrics/MethodLength
 
   def print_cop_with_doc(cop) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
     cop_config = config.for_cop(cop)
     non_display_keys = %w[
-      Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
+      AutoCorrect Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
       VersionChanged
     ]
     pars = cop_config.reject { |k| non_display_keys.include? k }
     description = 'No documentation'
-    examples_object = safety_object = see_object = []
+    example_objects = safety_objects = see_objects = []
     cop_code(cop) do |code_object|
       description = code_object.docstring unless code_object.docstring.blank?
-      examples_object = code_object.tags('example')
-      safety_object = code_object.tags('safety')
-      see_object = code_object.tags('see')
+      example_objects = code_object.tags('example')
+      safety_objects = code_object.tags('safety')
+      see_objects = code_object.tags('see')
     end
-    cops_body(cop, description, examples_object, safety_object, see_object, pars)
+    data = CopData.new(cop: cop, description: description, example_objects: example_objects,
+                       safety_objects: safety_objects, see_objects: see_objects, config: pars)
+    cops_body(data)
   end
 
   def cop_code(cop)
@@ -294,7 +338,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     filename = "#{department_to_basename(department)}.adoc"
     content = +"=== Department xref:#{filename}[#{type_title}]\n\n"
     cops_of_department(department).each do |cop|
-      anchor = cop.cop_name.sub('/', '').downcase
+      anchor = to_anchor(cop.cop_name)
       content << "* xref:#{filename}##{anchor}[#{cop.cop_name}]\n"
     end
 
@@ -302,7 +346,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   end
 
   def print_table_of_contents
-    path = "#{docs_path}/cops.adoc"
+    path = "#{docs_path}/pages/cops.adoc"
 
     File.write(path, table_contents) and return unless File.exist?(path)
 
@@ -326,4 +370,13 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
 
     status == 'pending' ? 'Pending' : 'Enabled'
   end
+
+  # HTML anchor are somewhat limited in what characters they can contain, just
+  # accept a known-good subset. As long as it's consistent it doesn't matter.
+  #
+  # Style/AccessModifierDeclarations => styleaccessmodifierdeclarations
+  # OnlyFor: [] (default) => onlyfor_-__-_default_
+  def to_anchor(title)
+    title.delete('/').tr(' ', '-').gsub(/[^a-zA-Z0-9-]/, '_').downcase
+  end
 end

data/lib/rubocop/core_ext/string.rb

@@ -9,12 +9,8 @@ class String
     # @return [Boolean] true is the string is blank, false otherwise
     #
     # @example
-    #   ''.blank? #=> true
-    #
-    # @example
-    #   '    '.blank? #=> true
-    #
-    # @example
+    #   ''.blank?       #=> true
+    #   '    '.blank?   #=> true
     #   '  test'.blank? #=> false
     def blank?
       empty? || lstrip.empty?