turboladen/tailor

View on GitHub
lib/tailor/rulers/spaces_before_comma_ruler.rb

Summary

Maintainability
A
1 hr
Test Coverage
require_relative '../ruler'

class Tailor
  module Rulers

    # Checks for spaces before a ',' as given by +@config+.
    class SpacesBeforeCommaRuler < Tailor::Ruler
      def initialize(config, options)
        super(config, options)
        add_lexer_observers :comma, :comment, :ignored_nl, :nl
        @comma_columns = []
      end

      def comma_update(_, _, column)
        @comma_columns << column
      end

      def comment_update(token, lexed_line, _, lineno, column)
        if token =~ /\n$/
          log 'Found comment with trailing newline.'
          ignored_nl_update(lexed_line, lineno, column)
        end
      end

      # Checks to see if the number of spaces before a comma equals the value
      # at +@config+.
      #
      # @param [Fixnum] actual_spaces The number of spaces before the comma.
      # @param [Fixnum] lineno Line the potential problem is on.
      # @param [Fixnum] column Column the potential problem is on.
      def measure(actual_spaces, lineno, column)
        if actual_spaces != @config
          msg = "Line has #{actual_spaces} space(s) before a comma, "
          msg << "but should have #{@config}."

          @problems << Problem.new(problem_type, lineno, column - 1, msg,
            @options[:level])
        end
      end

      def check_spaces_before_comma(lexed_line, lineno)
        @comma_columns.each do |c|
          event_index = lexed_line.event_index(c)
          if event_index.nil?
            log 'Event index is nil.  Weird...'
            next
          end

          previous_event = lexed_line.at(event_index - 1)
          actual_spaces = if previous_event[1] != :on_sp
            0
          else
            previous_event.last.size
          end

          measure(actual_spaces, lineno, c)
        end

        @comma_columns.clear
      end

      def ignored_nl_update(lexed_line, lineno, _)
        check_spaces_before_comma(lexed_line, lineno)
      end

      def nl_update(lexed_line, lineno, column)
        ignored_nl_update(lexed_line, lineno, column)
      end
    end
  end
end