Sha256: 6a73d4324c48b9c567c841c6b1496fc0555dd6e951382a8ec92c26021d77cac9

Contents?: true

Size: 1.73 KB

Versions: 13

Compression:

Stored size: 1.73 KB

Contents

# encoding: utf-8
# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # This cop checks whether the end keywords of method definitions are
      # aligned properly.
      #
      # Two modes are supported through the AlignWith configuration
      # parameter. If it's set to `start_of_line` (which is the default), the
      # `end` shall be aligned with the start of the line where the `def`
      # keyword is. If it's set to `def`, the `end` shall be aligned with the
      # `def` keyword.
      #
      # @example
      #
      #   private def foo
      #   end
      class DefEndAlignment < Cop
        include OnMethodDef
        include EndKeywordAlignment

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

        def on_method_def(node, _method_name, _args, _body)
          check_end_kw_in_node(node)
        end

        def on_send(node)
          return unless modifier_and_def_on_same_line?(node)
          _, _, method_def = *node
          expr = node.source_range

          line_start = Parser::Source::Range.new(expr.source_buffer,
                                                 expr.begin_pos,
                                                 method_def.loc.keyword.end_pos)
          align_with = {
            def: method_def.loc.keyword,
            start_of_line: line_start
          }

          check_end_kw_alignment(method_def, align_with)
          ignore_node(method_def) # Don't check the same `end` again.
        end

        private

        def autocorrect(node)
          if style == :start_of_line && node.parent && node.parent.send_type?
            align(node, node.parent)
          else
            align(node, node)
          end
        end
      end
    end
  end
end

Version data entries

13 entries across 13 versions & 2 rubygems

Version Path
fluent-plugin-detect-memb-exceptions-0.0.2 vendor/bundle/ruby/2.0.0/gems/rubocop-0.42.0/lib/rubocop/cop/lint/def_end_alignment.rb
fluent-plugin-detect-memb-exceptions-0.0.1 vendor/bundle/ruby/2.0.0/gems/rubocop-0.42.0/lib/rubocop/cop/lint/def_end_alignment.rb
rubocop-0.42.0 lib/rubocop/cop/lint/def_end_alignment.rb
rubocop-0.41.2 lib/rubocop/cop/lint/def_end_alignment.rb
rubocop-0.41.1 lib/rubocop/cop/lint/def_end_alignment.rb
rubocop-0.41.0 lib/rubocop/cop/lint/def_end_alignment.rb
rubocop-0.40.0 lib/rubocop/cop/lint/def_end_alignment.rb
rubocop-0.39.0 lib/rubocop/cop/lint/def_end_alignment.rb
rubocop-0.38.0 lib/rubocop/cop/lint/def_end_alignment.rb
rubocop-0.37.2 lib/rubocop/cop/lint/def_end_alignment.rb
rubocop-0.37.1 lib/rubocop/cop/lint/def_end_alignment.rb
rubocop-0.37.0 lib/rubocop/cop/lint/def_end_alignment.rb
rubocop-0.36.0 lib/rubocop/cop/lint/def_end_alignment.rb