space_after_comma.rb

module SCSSLint
  # Checks for spaces after commas in argument lists.
  class Linter::SpaceAfterComma < Linter
    include LinterRegistry

    def visit_mixindef(node)
      check_definition(node, :mixin)
      yield
    end

    def visit_mixin(node)
      check_invocation(node, :mixin)
      yield
    end

    def visit_function(node)
      check_definition(node, :function)
      yield
    end

    def visit_script_funcall(node)
      check_invocation(node, :function)
      yield
    end

    def visit_script_listliteral(node)
      check_commas_after_args(node.elements, 'lists') if node.separator == :comma
      yield
    end

  private

    # Check parameters of a function/mixin definition
    def check_definition(node, type)
      # Use the default value's source range if one is defined, since that will
      # be the item with the comma after it
      args = node.args.map { |name, default_value| default_value || name }
      args << node.splat if node.splat

      check_commas_after_args(args, "#{type} parameters")
    end

    # Check arguments passed to a function/mixin invocation
    def check_invocation(node, type)
      args = sort_args_by_position(node.args,
                                   node.splat,
                                   node.keywords.values,
                                   node.kwarg_splat)

      check_commas_after_args(args, "#{type} arguments")
    end

    # Since keyword arguments are not guaranteed to be in order, use the source
    # range to order arguments so we check them in the order they were declared.
    def sort_args_by_position(*args)
      args.flatten.compact.sort_by do |arg|
        pos = arg.source_range.end_pos
        [pos.line, pos.offset]
      end
    end

    EXPECTED_SPACES_AFTER_COMMA = 1

    # Check the comma after each argument in a list for a space following it,
    # reporting a lint using the given [arg_type].
    def check_commas_after_args(args, arg_type)
      # For each arg except the last, check the character following the comma
      args[0..-2].each do |arg|
        offset = 0

        # Find the comma following this argument.
        # The Sass parser is unpredictable in where it marks the end of the
        # source range. Thus we need to start at the indicated range, and check
        # left and right of that range, gradually moving further outward until
        # we find the comma.
        if character_at(arg.source_range.end_pos, offset) != ','
          loop do
            offset += 1
            break if character_at(arg.source_range.end_pos, offset) == ','
            offset = -offset
            break if character_at(arg.source_range.end_pos, offset) == ','
            offset = -offset
          end
        end

        # Check for space or newline after arg (we allow arguments to be split
        # up over multiple lines).
        spaces = 0
        while character_at(arg.source_range.end_pos, offset + 1) =~ / |\n/
          spaces += 1
          offset += 1
        end

        if spaces != EXPECTED_SPACES_AFTER_COMMA
          add_lint arg, "Commas in #{arg_type} should be followed by a single space"
        end
      end
    end
  end
end