rubocop 0.75.1

data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks whether the rescue and ensure keywords are aligned
+      # properly.
+      #
+      # @example
+      #
+      #   # bad
+      #   begin
+      #     something
+      #     rescue
+      #     puts 'error'
+      #   end
+      #
+      #   # good
+      #   begin
+      #     something
+      #   rescue
+      #     puts 'error'
+      #   end
+      class RescueEnsureAlignment < Cop
+        include RangeHelp
+
+        MSG = '`%<kw_loc>s` at %<kw_loc_line>d, %<kw_loc_column>d is not ' \
+              'aligned with `%<beginning>s` at ' \
+              '%<begin_loc_line>d, %<begin_loc_column>d.'
+        ANCESTOR_TYPES = %i[kwbegin def defs class module].freeze
+        RUBY_2_5_ANCESTOR_TYPES = (ANCESTOR_TYPES + %i[block]).freeze
+        ANCESTOR_TYPES_WITH_ACCESS_MODIFIERS = %i[def defs].freeze
+        ALTERNATIVE_ACCESS_MODIFIERS = %i[public_class_method
+                                          private_class_method].freeze
+
+        def on_resbody(node)
+          check(node) unless modifier?(node)
+        end
+
+        def on_ensure(node)
+          check(node)
+        end
+
+        def autocorrect(node)
+          whitespace = whitespace_range(node)
+          # Some inline node is sitting before current node.
+          return nil unless whitespace.source.strip.empty?
+
+          alignment_node = alignment_node(node)
+          return false if alignment_node.nil?
+
+          new_column = alignment_node.loc.column
+          ->(corrector) { corrector.replace(whitespace, ' ' * new_column) }
+        end
+
+        def investigate(processed_source)
+          @modifier_locations =
+            processed_source.tokens.each_with_object([]) do |token, locations|
+              next unless token.rescue_modifier?
+
+              locations << token.pos
+            end
+        end
+
+        private
+
+        # Check alignment of node with rescue or ensure modifiers.
+
+        def check(node)
+          alignment_node = alignment_node(node)
+          return if alignment_node.nil?
+
+          alignment_loc = alignment_node.loc.expression
+          kw_loc        = node.loc.keyword
+
+          return if
+            alignment_loc.column == kw_loc.column ||
+            alignment_loc.line   == kw_loc.line
+
+          add_offense(
+            node,
+            location: kw_loc,
+            message: format_message(alignment_node, alignment_loc, kw_loc)
+          )
+        end
+
+        def format_message(alignment_node, alignment_loc, kw_loc)
+          format(
+            MSG,
+            kw_loc: kw_loc.source,
+            kw_loc_line: kw_loc.line,
+            kw_loc_column: kw_loc.column,
+            beginning: alignment_source(alignment_node, alignment_loc),
+            begin_loc_line: alignment_loc.line,
+            begin_loc_column: alignment_loc.column
+          )
+        end
+
+        def alignment_source(node, starting_loc)
+          ending_loc =
+            case node.type
+            when :block, :kwbegin
+              node.loc.begin
+            when :def, :defs, :class, :module,
+                 :lvasgn, :ivasgn, :cvasgn, :gvasgn, :casgn
+              node.loc.name
+            when :masgn
+              mlhs_node, = *node
+              mlhs_node.loc.expression
+            else
+              # It is a wrapper with access modifier.
+              node.child_nodes.first.loc.name
+            end
+
+          range_between(starting_loc.begin_pos, ending_loc.end_pos).source
+        end
+
+        # We will use ancestor or wrapper with access modifier.
+
+        def alignment_node(node)
+          ancestor_node = ancestor_node(node)
+
+          return ancestor_node if ancestor_node.nil? ||
+                                  ancestor_node.kwbegin_type?
+
+          assignment_node = assignment_node(ancestor_node)
+          return assignment_node if same_line?(ancestor_node, assignment_node)
+
+          access_modifier_node = access_modifier_node(ancestor_node)
+          return access_modifier_node unless access_modifier_node.nil?
+
+          ancestor_node
+        end
+
+        def ancestor_node(node)
+          ancestor_types =
+            if target_ruby_version >= 2.5
+              RUBY_2_5_ANCESTOR_TYPES
+            else
+              ANCESTOR_TYPES
+            end
+
+          node.each_ancestor(*ancestor_types).first
+        end
+
+        def assignment_node(node)
+          assignment_node = node.ancestors.first
+          return nil unless
+            assignment_node&.assignment?
+
+          assignment_node
+        end
+
+        def access_modifier_node(node)
+          return nil unless
+            ANCESTOR_TYPES_WITH_ACCESS_MODIFIERS.include?(node.type)
+
+          access_modifier_node = node.ancestors.first
+          return nil unless access_modifier?(access_modifier_node)
+
+          access_modifier_node
+        end
+
+        def modifier?(node)
+          return false unless @modifier_locations.respond_to?(:include?)
+
+          @modifier_locations.include?(node.loc.keyword)
+        end
+
+        def whitespace_range(node)
+          begin_pos      = node.loc.keyword.begin_pos
+          current_column = node.loc.keyword.column
+
+          range_between(begin_pos - current_column, begin_pos)
+        end
+
+        def access_modifier?(node)
+          return true if node.respond_to?(:access_modifier?) &&
+                         node.access_modifier?
+
+          return true if node.respond_to?(:method_name) &&
+                         ALTERNATIVE_ACCESS_MODIFIERS.include?(node.method_name)
+
+          false
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/space_after_colon.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks for colon (:) not followed by some kind of space.
+      # N.B. this cop does not handle spaces after a ternary operator, which are
+      # instead handled by Layout/SpaceAroundOperators.
+      #
+      # @example
+      #   # bad
+      #   def f(a:, b:2); {a:3}; end
+      #
+      #   # good
+      #   def f(a:, b: 2); {a: 3}; end
+      class SpaceAfterColon < Cop
+        MSG = 'Space missing after colon.'
+
+        def on_pair(node)
+          return unless node.colon?
+
+          colon = node.loc.operator
+
+          add_offense(colon, location: colon) unless followed_by_space?(colon)
+        end
+
+        def on_kwoptarg(node)
+          # We have no direct reference to the colon source range following an
+          # optional keyword argument's name, so must construct one.
+          colon = node.loc.name.end.resize(1)
+
+          add_offense(colon, location: colon) unless followed_by_space?(colon)
+        end
+
+        def autocorrect(range)
+          ->(corrector) { corrector.insert_after(range, ' ') }
+        end
+
+        private
+
+        def followed_by_space?(colon)
+          colon.source_buffer.source[colon.end_pos] =~ /\s/
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/space_after_comma.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks for comma (,) not followed by some kind of space.
+      #
+      # @example
+      #
+      #   # bad
+      #   [1,2]
+      #   { foo:bar,}
+      #
+      #   # good
+      #   [1, 2]
+      #   { foo:bar, }
+      class SpaceAfterComma < Cop
+        include SpaceAfterPunctuation
+
+        def autocorrect(comma)
+          PunctuationCorrector.add_space(comma)
+        end
+
+        def space_style_before_rcurly
+          cfg = config.for_cop('Layout/SpaceInsideHashLiteralBraces')
+          cfg['EnforcedStyle'] || 'space'
+        end
+
+        def kind(token)
+          'comma' if token.comma?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/space_after_method_name.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks for space between a method name and a left parenthesis in defs.
+      #
+      # @example
+      #
+      #   # bad
+      #   def func (x) end
+      #   def method= (y) end
+      #
+      #   # good
+      #   def func(x) end
+      #   def method=(y) end
+      class SpaceAfterMethodName < Cop
+        include RangeHelp
+
+        MSG = 'Do not put a space between a method name and the opening ' \
+              'parenthesis.'
+
+        def on_def(node)
+          args = node.arguments
+          return unless args.loc.begin&.is?('(')
+
+          expr = args.source_range
+          pos_before_left_paren = range_between(expr.begin_pos - 1,
+                                                expr.begin_pos)
+          return unless pos_before_left_paren.source.start_with?(' ')
+
+          add_offense(pos_before_left_paren, location: pos_before_left_paren)
+        end
+        alias on_defs on_def
+
+        def autocorrect(pos_before_left_paren)
+          ->(corrector) { corrector.remove(pos_before_left_paren) }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/space_after_not.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks for space after `!`.
+      #
+      # @example
+      #   # bad
+      #   ! something
+      #
+      #   # good
+      #   !something
+      class SpaceAfterNot < Cop
+        include RangeHelp
+
+        MSG = 'Do not leave space between `!` and its argument.'
+
+        def on_send(node)
+          return unless node.prefix_bang? && whitespace_after_operator?(node)
+
+          add_offense(node)
+        end
+
+        def whitespace_after_operator?(node)
+          node.receiver.loc.column - node.loc.column > 1
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(
+              range_between(node.loc.selector.end_pos,
+                            node.receiver.source_range.begin_pos)
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/space_after_semicolon.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks for semicolon (;) not followed by some kind of space.
+      #
+      # @example
+      #   # bad
+      #   x = 1;y = 2
+      #
+      #   # good
+      #   x = 1; y = 2
+      class SpaceAfterSemicolon < Cop
+        include SpaceAfterPunctuation
+
+        def autocorrect(semicolon)
+          PunctuationCorrector.add_space(semicolon)
+        end
+
+        def space_style_before_rcurly
+          cfg = config.for_cop('Layout/SpaceInsideBlockBraces')
+          cfg['EnforcedStyle'] || 'space'
+        end
+
+        def kind(token)
+          'semicolon' if token.semicolon?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/space_around_block_parameters.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks the spacing inside and after block parameters pipes. Line breaks
+      # inside parameter pipes are checked by `Layout/MultilineBlockLayout` and
+      # not by this cop.
+      #
+      # @example EnforcedStyleInsidePipes: no_space (default)
+      #   # bad
+      #   {}.each { | x,  y |puts x }
+      #   ->( x,  y ) { puts x }
+      #
+      #   # good
+      #   {}.each { |x, y| puts x }
+      #   ->(x, y) { puts x }
+      #
+      # @example EnforcedStyleInsidePipes: space
+      #   # bad
+      #   {}.each { |x,  y| puts x }
+      #   ->(x,  y) { puts x }
+      #
+      #   # good
+      #   {}.each { | x, y | puts x }
+      #   ->( x, y ) { puts x }
+      class SpaceAroundBlockParameters < Cop
+        include ConfigurableEnforcedStyle
+        include RangeHelp
+
+        def on_block(node)
+          arguments = node.arguments
+
+          return unless node.arguments? && pipes?(arguments)
+
+          check_inside_pipes(arguments)
+          check_after_closing_pipe(arguments) if node.body
+          check_each_arg(arguments)
+        end
+
+        # @param target [RuboCop::AST::Node,Parser::Source::Range]
+        def autocorrect(target)
+          lambda do |corrector|
+            if target.is_a?(RuboCop::AST::Node)
+              if target.parent.children.first == target
+                corrector.insert_before(target.source_range, ' ')
+              else
+                corrector.insert_after(target.source_range, ' ')
+              end
+            elsif target.source =~ /^\s+$/
+              corrector.remove(target)
+            else
+              corrector.insert_after(target, ' ')
+            end
+          end
+        end
+
+        private
+
+        def pipes(arguments)
+          [arguments.loc.begin, arguments.loc.end]
+        end
+
+        def pipes?(arguments)
+          pipes(arguments).none?(&:nil?)
+        end
+
+        def style_parameter_name
+          'EnforcedStyleInsidePipes'
+        end
+
+        def check_inside_pipes(arguments)
+          opening_pipe, closing_pipe = pipes(arguments)
+
+          if style == :no_space
+            check_no_space_style_inside_pipes(arguments.children,
+                                              opening_pipe,
+                                              closing_pipe)
+          elsif style == :space
+            check_space_style_inside_pipes(arguments.children,
+                                           opening_pipe,
+                                           closing_pipe)
+          end
+        end
+
+        def check_after_closing_pipe(arguments)
+          _opening_pipe, closing_pipe = pipes(arguments)
+          block = arguments.parent
+
+          check_space(closing_pipe.end_pos, block.body.source_range.begin_pos,
+                      closing_pipe, 'after closing `|`')
+        end
+
+        def check_no_space_style_inside_pipes(args, opening_pipe, closing_pipe)
+          first = args.first.source_range
+          last = args.last.source_range
+
+          check_no_space(opening_pipe.end_pos, first.begin_pos,
+                         'Space before first')
+          check_no_space(last_end_pos_inside_pipes(last.end_pos),
+                         closing_pipe.begin_pos, 'Space after last')
+        end
+
+        def check_space_style_inside_pipes(args, opening_pipe, closing_pipe)
+          check_opening_pipe_space(args, opening_pipe)
+          check_closing_pipe_space(args, closing_pipe)
+        end
+
+        def check_opening_pipe_space(args, opening_pipe)
+          first_arg = args.first
+          range = first_arg.source_range
+
+          check_space(opening_pipe.end_pos, range.begin_pos, range,
+                      'before first block parameter', first_arg)
+          check_no_space(opening_pipe.end_pos, range.begin_pos - 1,
+                         'Extra space before first')
+        end
+
+        def check_closing_pipe_space(args, closing_pipe)
+          last         = args.last.source_range
+          last_end_pos = last_end_pos_inside_pipes(last.end_pos)
+
+          check_space(last_end_pos, closing_pipe.begin_pos, last,
+                      'after last block parameter')
+          check_no_space(last_end_pos + 1, closing_pipe.begin_pos,
+                         'Extra space after last')
+        end
+
+        def last_end_pos_inside_pipes(pos)
+          processed_source.buffer.source[pos] == ',' ? pos + 1 : pos
+        end
+
+        def check_each_arg(args)
+          args.children.each do |arg|
+            check_arg(arg)
+          end
+        end
+
+        def check_arg(arg)
+          arg.children.each { |a| check_arg(a) } if arg.mlhs_type?
+
+          expr = arg.source_range
+          check_no_space(
+            range_with_surrounding_space(range: expr, side: :left).begin_pos,
+            expr.begin_pos - 1,
+            'Extra space before'
+          )
+        end
+
+        def check_space(space_begin_pos, space_end_pos, range, msg, node = nil)
+          return if space_begin_pos != space_end_pos
+
+          target = node || range
+          add_offense(target, location: range, message: "Space #{msg} missing.")
+        end
+
+        def check_no_space(space_begin_pos, space_end_pos, msg)
+          return if space_begin_pos >= space_end_pos
+
+          range = range_between(space_begin_pos, space_end_pos)
+          return if range.source.include?("\n")
+
+          add_offense(range, location: range,
+                             message: "#{msg} block parameter detected.")
+        end
+      end
+    end
+  end
+end