tailor 1.2.1 → 1.3.0

data/lib/tailor/rulers/indentation_spaces_ruler/indentation_manager.rb

@@ -2,6 +2,7 @@ require_relative '../../ruler'
 require_relative '../../logger'
 require_relative '../../lexer/lexer_constants'
 
+
 class Tailor
   module Rulers
     class IndentationSpacesRuler < Tailor::Ruler
@@ -74,7 +75,7 @@ class Tailor
             log "@proper[:this_line] = #{@proper[:this_line]}"
             log "@proper[:next_line] = #{@proper[:next_line]}"
           else
-            log "#decrease_this_line called, but checking is stopped."
+            log '#decrease_this_line called, but checking is stopped.'
           end
         end
 
@@ -90,20 +91,20 @@ class Tailor
         # +@proper[:this_line]+.
         def transition_lines
           if started?
-            log "Resetting change_this to 0."
+            log 'Resetting change_this to 0.'
             @amount_to_change_this = 0
-            log "Setting @proper[:this_line] = that of :next_line"
+            log 'Setting @proper[:this_line] = that of :next_line'
             @proper[:this_line] = @proper[:next_line]
             log "Transitioning @proper[:this_line] to #{@proper[:this_line]}"
           else
-            log "Skipping #transition_lines; checking is stopped."
+            log 'Skipping #transition_lines; checking is stopped.'
           end
         end
 
         # Starts the process of increasing/decreasing line indentation
         # expectations.
         def start
-          log "Starting indentation ruling."
+          log 'Starting indentation ruling.'
           log "Next check should be at #{should_be_at}"
           @do_measurement = true
         end
@@ -132,7 +133,7 @@ class Tailor
         # @param [Array] lexed_line_output The lexed output for the current line.
         def update_actual_indentation(lexed_line_output)
           if lexed_line_output.end_of_multi_line_string?
-            log "Found end of multi-line string."
+            log 'Found end of multi-line string.'
             return
           end
 
@@ -237,7 +238,7 @@ class Tailor
         # not an opening or closing reason, such as +elsif+, +rescue+, +when+
         # (in a +case+ statement), etc.
         #
-        # @param [Symbol] event_type The event type that is the opening reason.
+        # @param [Symbol] token
         # @param [Tailor::LexedLine] lexed_line
         # @param [Fixnum] lineno The line number the opening reason was found
         #   on.
@@ -285,11 +286,11 @@ class Tailor
 
           log "Updated :next after closing; it's now #{@proper[:next_line]}"
 
-          meth = "only_#{event_type.to_s.sub("^on_", '')}?"
+          meth = "only_#{event_type.to_s.sub('^on_', '')}?"
 
           if lexed_line.send(meth.to_sym) || lexed_line.to_s =~ /^\s*end\n?$/
             @proper[:this_line] = @proper[:this_line] - @spaces
-            msg = "End multi-line statement. "
+            msg = 'End multi-line statement. '
             msg < "change_this -= 1 -> #{@proper[:this_line]}."
             log msg
           end
@@ -337,7 +338,6 @@ class Tailor
           end
         end
 
-
         # Returns the last matching opening event that corresponds to the
         # +closing_event_type+.
         #
@@ -375,9 +375,9 @@ class Tailor
         def method_missing(meth, *args, &blk)
           if meth.to_s =~ /^multi_line_(.+)\?$/
             token = case $1
-            when "brackets" then '['
-            when "braces" then '{'
-            when "parens" then '('
+            when 'brackets' then '['
+            when 'braces' then '{'
+            when 'parens' then '('
             else
               super(meth, *args, &blk)
             end

data/lib/tailor/rulers/max_code_lines_in_class_ruler.rb

@@ -34,7 +34,7 @@ class Tailor
       end
 
       def kw_update(token, lexed_line, lineno, column)
-        if token == "class" || token == "module"
+        if token == 'class' || token == 'module'
           @class_start_lines << { lineno: lineno, column: column, count: 0 }
           log "Class start lines: #{@class_start_lines}"
         end
@@ -47,7 +47,7 @@ class Tailor
           log "Keyword start lines: #{@kw_start_lines}"
         end
 
-        if token == "end"
+        if token == 'end'
           log "Got 'end' of class/module."
 
           unless @class_start_lines.empty?

data/lib/tailor/rulers/max_code_lines_in_method_ruler.rb

@@ -34,7 +34,7 @@ class Tailor
       end
 
       def kw_update(token, lexed_line, lineno, column)
-        if token == "def"
+        if token == 'def'
           @method_start_lines << { lineno: lineno, column: column, count: 0 }
           log "Method start lines: #{@method_start_lines}"
         end
@@ -47,7 +47,7 @@ class Tailor
           log "Keyword start lines: #{@kw_start_lines}"
         end
 
-        if token == "end"
+        if token == 'end'
           log "Got 'end' of method."
 
           unless @method_start_lines.empty?

data/lib/tailor/rulers/spaces_after_comma_ruler.rb

@@ -20,7 +20,7 @@ class Tailor
 
       def comment_update(token, lexed_line, file_text, lineno, column)
         if token =~ /\n$/
-          log "Found comment with trailing newline."
+          log 'Found comment with trailing newline.'
           ignored_nl_update(lexed_line, lineno, column)
         end
       end
@@ -55,29 +55,29 @@ class Tailor
         @comma_columns.each do |c|
           event_index = lexed_line.event_index(c)
           if event_index.nil?
-            log "Event index is nil.  Weird..."
+            log 'Event index is nil.  Weird...'
             break
           end
 
           next_event = lexed_line.at(event_index + 1)
           if next_event.nil?
-            log "Looks like there is no next event (this is last in the line)."
+            log 'Looks like there is no next event (this is last in the line).'
             break
           end
 
           if next_event[1] == :on_nl || next_event[1] == :on_ignored_nl
-            log "Next event is a newline."
+            log 'Next event is a newline.'
             break
           end
 
           second_next_event = lexed_line.at(event_index + 2)
           if second_next_event.nil?
-            log "Second next event is nil."
+            log 'Second next event is nil.'
             next
           end
 
           if second_next_event[1] == :on_comment
-            log "Event + 2 is a comment."
+            log 'Event + 2 is a comment.'
             next
           end
 

data/lib/tailor/rulers/spaces_after_conditional_ruler.rb

@@ -0,0 +1,48 @@
+require_relative '../ruler'
+
+class Tailor
+  module Rulers
+    class SpacesAfterConditionalRuler < Tailor::Ruler
+
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :nl
+      end
+
+      def nl_update(current_lexed_line, lineno, column)
+        measure(current_lexed_line, lineno)
+      end
+
+      # Checks to see if spacing is present after conditionals
+      #
+      # @param [Array] lexed_line The lexed line with a conditional
+      # @param [Fixnum] lineno Line the problem was found on.
+      def measure(lexed_line, lineno)
+
+        idx = lexed_line.index do |pos, token, name|
+          token == :on_kw and %w{if unless case}.include?(name)
+        end
+
+        expected_spaces = @config
+        spaces = expected_spaces
+
+        if idx
+          column = lexed_line[idx].first.last
+          pos, token, name = lexed_line[idx + 1]
+          spaces = case token
+          when :on_lparen then 0
+          when :on_sp
+            next_token = lexed_line[idx + 2]
+            next_token.first.last - pos.last
+          end
+        end
+
+        if expected_spaces != spaces
+          @problems << Problem.new(problem_type, lineno, column,
+            "#{spaces} spaces after conditional at column #{column}, " +
+              "expected #{expected_spaces}.", @options[:level])
+        end
+      end
+    end
+  end
+end

data/lib/tailor/rulers/spaces_after_lbrace_ruler.rb

@@ -3,7 +3,7 @@ require_relative '../ruler'
 class Tailor
   module Rulers
 
-    # Checks for spaces after a '{' as given by +@config+.  It skips checking
+    # Checks for spaces after a +{+ as given by +@config+.  It skips checking
     # when:
     # * it's at the end of a line.
     # * the next char is a '}'
@@ -17,7 +17,7 @@ class Tailor
 
       def comment_update(token, lexed_line, file_text, lineno, column)
         if token =~ /\n$/
-          log "Found comment with trailing newline."
+          log 'Found comment with trailing newline.'
           ignored_nl_update(lexed_line, lineno, column)
         end
       end
@@ -57,8 +57,8 @@ class Tailor
           actual_spaces = count_spaces(lexed_line, column)
           next if actual_spaces.nil?
 
-          if @do_measurement == false
-            log "Skipping measurement."
+          if !@do_measurement
+            log 'Skipping measurement.'
           else
             measure(actual_spaces, lineno, column)
           end
@@ -79,7 +79,7 @@ class Tailor
         event_index = lexed_line.event_index(column)
 
         if event_index.nil?
-          log "No lbrace in this line.  Moving on..."
+          log 'No lbrace in this line.  Moving on...'
           @do_measurement = false
           return
         end
@@ -87,7 +87,7 @@ class Tailor
         next_event = lexed_line.at(event_index + 1)
 
         if next_event.nil?
-          log "lbrace must be at the end of the line.  Moving on."
+          log 'lbrace must be at the end of the line.  Moving on.'
           @do_measurement = false
           return 0
         end
@@ -99,14 +99,14 @@ class Tailor
         end
 
         if next_event[1] == :on_rbrace
-          log "lbrace is followed by an rbrace.  Moving on."
+          log 'lbrace is followed by an rbrace.  Moving on.'
           @do_measurement = false
           return 0
         end
 
         second_next_event = lexed_line.at(event_index + 2)
         if second_next_event[1] == :on_comment
-          log "Event + 2 is a comment."
+          log 'Event + 2 is a comment.'
           @do_measurement = false
           return next_event.last.size
         end

data/lib/tailor/rulers/spaces_after_lbracket_ruler.rb

@@ -17,7 +17,7 @@ class Tailor
 
       def comment_update(token, lexed_line, file_text, lineno, column)
         if token =~ /\n$/
-          log "Found comment with trailing newline."
+          log 'Found comment with trailing newline.'
           ignored_nl_update(lexed_line, lineno, column)
         end
       end
@@ -59,8 +59,8 @@ class Tailor
           actual_spaces = count_spaces(lexed_line, column)
           next if actual_spaces.nil?
 
-          if @do_measurement == false
-            log "Skipping measurement."
+          if !@do_measurement
+            log 'Skipping measurement.'
           else
             measure(actual_spaces, lineno, column)
           end
@@ -81,7 +81,7 @@ class Tailor
         event_index = lexed_line.event_index(column)
 
         if event_index.nil?
-          log "No lbracket in this line.  Moving on..."
+          log 'No lbracket in this line.  Moving on...'
           @do_measurement = false
           return
         end
@@ -90,7 +90,7 @@ class Tailor
         log "Next event: #{next_event}"
 
         if next_event.nil?
-          log "lbracket must be at the end of the line."
+          log 'lbracket must be at the end of the line.'
           @do_measurement = false
           return 0
         end
@@ -104,7 +104,7 @@ class Tailor
         end
 
         if next_event[1] == :on_rbracket
-          log "lbracket is followed by a rbracket.  Moving on."
+          log 'lbracket is followed by a rbracket.  Moving on.'
           @do_measurement = false
           return 0
         end

data/lib/tailor/rulers/spaces_after_lparen_ruler.rb

@@ -11,7 +11,7 @@ class Tailor
 
       def comment_update(token, lexed_line, file_text, lineno, column)
         if token =~ /\n$/
-          log "Found comment with trailing newline."
+          log 'Found comment with trailing newline.'
           ignored_nl_update(lexed_line, lineno, column)
         end
       end
@@ -53,8 +53,8 @@ class Tailor
           actual_spaces = count_spaces(lexed_line, column)
           next if actual_spaces.nil?
 
-          if @do_measurement == false
-            log "Skipping measurement."
+          if !@do_measurement
+            log 'Skipping measurement.'
           else
             measure(actual_spaces, lineno, column)
           end
@@ -75,7 +75,7 @@ class Tailor
         event_index = lexed_line.event_index(column)
 
         if event_index.nil?
-          log "No lparen in this line.  Moving on..."
+          log 'No lparen in this line.  Moving on...'
           @do_measurement = false
           return
         end
@@ -84,7 +84,7 @@ class Tailor
         log "Next event: #{next_event}"
 
         if next_event.nil?
-          log "lparen must be at the end of the line."
+          log 'lparen must be at the end of the line.'
           @do_measurement = false
           return 0
         end
@@ -97,7 +97,7 @@ class Tailor
         end
 
         if next_event[1] == :on_rparen
-          log "lparen is followed by an rparen.  Moving on."
+          log 'lparen is followed by an rparen.  Moving on.'
           @do_measurement = false
           return 0
         end

data/lib/tailor/rulers/spaces_before_comma_ruler.rb

@@ -17,7 +17,7 @@ class Tailor
 
       def comment_update(token, lexed_line, file_text, lineno, column)
         if token =~ /\n$/
-          log "Found comment with trailing newline."
+          log 'Found comment with trailing newline.'
           ignored_nl_update(lexed_line, lineno, column)
         end
       end
@@ -42,7 +42,7 @@ class Tailor
         @comma_columns.each do |c|
           event_index = lexed_line.event_index(c)
           if event_index.nil?
-            log "Event index is nil.  Weird..."
+            log 'Event index is nil.  Weird...'
             next
           end
 

data/lib/tailor/rulers/spaces_before_lbrace_ruler.rb

@@ -28,7 +28,7 @@ class Tailor
         log "Previous event: #{previous_event}"
 
         if column.zero? || previous_event.nil?
-          log "lbrace must be at the beginning of the line."
+          log 'lbrace must be at the beginning of the line.'
           @do_measurement = false
           return 0
         end
@@ -54,7 +54,7 @@ class Tailor
         return 0 if previous_event[1] != :on_sp
 
         if current_index - 2 < 0
-          log "lbrace comes at the beginning of an indented line."
+          log 'lbrace comes at the beginning of an indented line.'
           @do_measurement = false
           return previous_event.last.size
         end
@@ -71,8 +71,8 @@ class Tailor
         count = count_spaces(lexed_line, column)
         log "Found #{count} space(s) before lbrace."
 
-        if @do_measurement == false
-          log "Skipping measurement."
+        if !@do_measurement
+          log 'Skipping measurement.'
         else
           measure(count, lineno, column)
         end

data/lib/tailor/rulers/spaces_before_rbrace_ruler.rb

@@ -7,7 +7,7 @@ class Tailor
     # when:
     # * it's the first char in the line.
     # * it's the first char in the line, preceded by spaces.
-    # * it's directly preceded by a '{'.
+    # * it's directly preceded by a +{+.
     class SpacesBeforeRbraceRuler < Tailor::Ruler
       def initialize(config, options)
         super(config, options)
@@ -18,7 +18,7 @@ class Tailor
 
       # @param [LexedLine] lexed_line
       # @param [Fixnum] column
-      # @return [Fixnum] The number of spaces before the rbrace.
+      # @return [Fixnum] the number of spaces before the rbrace.
       def count_spaces(lexed_line, column)
         current_index = lexed_line.event_index(column)
         log "Current event index: #{current_index}"
@@ -26,7 +26,7 @@ class Tailor
         log "Previous event: #{previous_event}"
 
         if column.zero? || previous_event.nil?
-          log "rbrace is at the beginning of the line."
+          log 'rbrace is at the beginning of the line.'
           @do_measurement = false
           return 0
         end
@@ -40,7 +40,7 @@ class Tailor
         return 0 if previous_event[1] != :on_sp
 
         if current_index - 2 < 0
-          log "rbrace is at the beginning of an indented line.  Moving on."
+          log 'rbrace is at the beginning of an indented line.  Moving on.'
           @do_measurement = false
           return previous_event.last.size
         end
@@ -74,9 +74,9 @@ class Tailor
         end
       end
 
-      # For Ruby versions < 2.0.0-p0, this has to keep track of '{'s and only
-      # follow through with the check if the '{' was an lbrace because Ripper
-      # doesn't scan the '}' of an embedded expression (embexpr_end) as such.
+      # For Ruby versions < 2.0.0-p0, this has to keep track of +{+'s and only
+      # follow through with the check if the +{+ was an lbrace because Ripper
+      # doesn't scan the +}+ of an embedded expression (embexpr_end) as such.
       #
       # @param [Tailor::LexedLine] lexed_line
       # @param [Fixnum] lineno
@@ -92,8 +92,8 @@ class Tailor
         count = count_spaces(lexed_line, column)
         log "Found #{count} space(s) before rbrace."
 
-        if @do_measurement == false
-          log "Skipping measurement."
+        if !@do_measurement
+          log 'Skipping measurement.'
         else
           measure(count, lineno, column)
         end