Contents

# encoding: utf-8

module RuboCop
  module Cop
    # Functions for checking the alignment of the `end` keyword.
    module EndKeywordAlignment
      include ConfigurableEnforcedStyle

      MSG = '`end` at %d, %d is not aligned with `%s` at %d, %d.'

      private

      def check_offset_of_node(node)
        check_offset(node, node.loc.keyword.source, 0)
      end

      def check_offset(node, alignment_base, offset)
        return if ignored_node?(node)

        end_loc = node.loc.end
        return unless end_loc # Discard modifier forms of if/while/until.

        kw_loc = node.loc.keyword

        if kw_loc.line != end_loc.line &&
           kw_loc.column != end_loc.column + offset
          add_offense(node, end_loc,
                      format(MSG, end_loc.line, end_loc.column,
                             alignment_base, kw_loc.line, kw_loc.column)) do
            opposite_style_detected
          end
        else
          correct_style_detected
        end
      end

      def parameter_name
        'AlignWith'
      end

      def variable_alignment?(whole_expression, rhs, end_alignment_style)
        end_alignment_style == :variable &&
          !line_break_before_keyword?(whole_expression, rhs)
      end

      def line_break_before_keyword?(whole_expression, rhs)
        rhs.loc.line > whole_expression.line
      end

      def align(node, alignment_node)
        source_buffer = node.loc.expression.source_buffer
        begin_pos = node.loc.end.begin_pos
        whitespace = Parser::Source::Range.new(source_buffer,
                                               begin_pos - node.loc.end.column,
                                               begin_pos)
        return false unless whitespace.source.strip.empty?

        column = alignment_node ? alignment_node.loc.expression.column : 0

        ->(corrector) { corrector.replace(whitespace, ' ' * column) }
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
rubocop-0.35.1	lib/rubocop/cop/mixin/end_keyword_alignment.rb
rubocop-0.35.0	lib/rubocop/cop/mixin/end_keyword_alignment.rb
rubocop-0.34.2	lib/rubocop/cop/mixin/end_keyword_alignment.rb
rubocop-0.34.1	lib/rubocop/cop/mixin/end_keyword_alignment.rb
rubocop-0.34.0	lib/rubocop/cop/mixin/end_keyword_alignment.rb