rubocop-hq/rubocop

View on GitHub
lib/rubocop/cop/layout/space_after_colon.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
# 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 < Base
        extend AutoCorrector

        MSG = 'Space missing after colon.'

        def on_pair(node)
          return if !node.colon? || node.value_omission?

          colon = node.loc.operator

          register_offense(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)

          register_offense(colon) unless followed_by_space?(colon)
        end

        private

        def register_offense(colon)
          add_offense(colon) { |corrector| corrector.insert_after(colon, ' ') }
        end

        def followed_by_space?(colon)
          /\s/.match?(colon.source_buffer.source[colon.end_pos])
        end
      end
    end
  end
end