tailor 1.0.0.alpha2 → 1.0.0

data/lib/tailor/rulers/max_code_lines_in_class_ruler.rb

@@ -1,13 +1,14 @@
 require_relative '../ruler'
-require_relative '../lexer_constants'
+require_relative '../lexer/lexer_constants'
 
 class Tailor
   module Rulers
     class MaxCodeLinesInClassRuler < Tailor::Ruler
       include LexerConstants
 
-      def initialize(config)
-        super(config)
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers(:ignored_nl, :kw, :nl)
         @class_start_lines = []
         @kw_start_lines = []
         @end_last_class = false
@@ -75,8 +76,11 @@ class Tailor
       # @param [Fixnum] column The column the potential problem is on.
       def measure(actual_count, lineno, column)
         if actual_count > @config
-          @problems << Problem.new(:code_lines_in_class, lineno, column,
-            { actual_count: actual_count, should_be_at: @config })
+          msg = "Class/module has #{actual_count} code lines, but "
+          msg << "should have no more than #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column, msg,
+            @options[:level])
         end
       end
     end

data/lib/tailor/rulers/max_code_lines_in_method_ruler.rb

@@ -1,13 +1,14 @@
 require_relative '../ruler'
-require_relative '../lexer_constants'
+require_relative '../lexer/lexer_constants'
 
 class Tailor
   module Rulers
     class MaxCodeLinesInMethodRuler < Tailor::Ruler
       include LexerConstants
 
-      def initialize(config)
-        super(config)
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers(:ignored_nl, :kw, :nl)
         @method_start_lines = []
         @kw_start_lines = []
         @end_last_method = false
@@ -75,8 +76,11 @@ class Tailor
       # @param [Fixnum] column The column the potential problem is on.
       def measure(actual_count, lineno, column)
         if actual_count > @config
-          @problems << Problem.new(:code_lines_in_method, lineno, column,
-            { actual_count: actual_count, should_be_at: @config })
+          msg = "Method has #{actual_count} code lines, but "
+          msg << "should have no more than #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column, msg,
+            @options[:level])
         end
       end
     end

data/lib/tailor/rulers/max_line_length_ruler.rb

@@ -3,6 +3,11 @@ require_relative '../ruler'
 class Tailor
   module Rulers
     class MaxLineLengthRuler < Tailor::Ruler
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :ignored_nl, :nl
+      end
+
       def ignored_nl_update(lexed_line, lineno, column)
         log "<#{self.class}> Line length: #{lexed_line.line_length}"
         measure(lexed_line, lineno, column)
@@ -19,11 +24,11 @@ class Tailor
       # @param [Fixnum] column Column the potential problem is on
       def measure(lexed_line, lineno, column)
         if lexed_line.line_length > @config
-          options = {
-            actual_length: lexed_line.line_length,
-            should_be_at: @config
-          }
-          @problems << Problem.new(:line_length, lineno, column, options)
+          msg = "Line is #{lexed_line.line_length} chars long, "
+          msg << "but should be #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column, msg,
+            @options[:level])
         end
       end
     end

data/lib/tailor/rulers/spaces_after_comma_ruler.rb

@@ -8,8 +8,9 @@ class Tailor
     # * the char after it is a '\n'.
     # * it's at the end of a line, followed by a trailing comment.
     class SpacesAfterCommaRuler < Tailor::Ruler
-      def initialize(config)
-        super(config)
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :comma, :comment, :ignored_nl, :nl
         @comma_columns = []
       end
 
@@ -40,8 +41,11 @@ class Tailor
       # @param [Fixnum] column Column the potential problem is on.
       def measure(actual_spaces, lineno, column)
         if actual_spaces != @config
-          @problems << Problem.new(:spaces_after_comma, lineno, column + 1,
-            { actual_spaces: actual_spaces, should_have: @config })
+          msg = "Line has #{actual_spaces} space(s) after a comma, "
+          msg << "but should have #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column + 1, msg,
+            @options[:level])
         end
       end
 
@@ -67,6 +71,11 @@ class Tailor
           end
 
           second_next_event = lexed_line.at(event_index + 2)
+          if second_next_event.nil?
+            log "Second next event is nil."
+            next
+          end
+
           if second_next_event[1] == :on_comment
             log "Event + 2 is a comment."
             next

data/lib/tailor/rulers/spaces_after_lbrace_ruler.rb

@@ -9,8 +9,9 @@ class Tailor
     # * the next char is a '}'
     # * it's at the end of a line, followed by a trailing comment.
     class SpacesAfterLbraceRuler < Tailor::Ruler
-      def initialize(config)
-        super(config)
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :comment, :ignored_nl, :lbrace, :nl
         @lbrace_columns = []
       end
 
@@ -41,8 +42,11 @@ class Tailor
       # @param [Fixnum] column Column the potential problem is on.
       def measure(actual_spaces, lineno, column)
         if actual_spaces != @config
-          @problems << Problem.new(:spaces_after_lbrace, lineno, column + 1,
-            { actual_spaces: actual_spaces, should_have: @config })
+          msg = "Line has #{actual_spaces} space(s) after a {, "
+          msg << "but should have #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column + 1, msg,
+            @options[:level])
         end
       end
 

data/lib/tailor/rulers/spaces_after_lbracket_ruler.rb

@@ -9,8 +9,9 @@ class Tailor
     # * the char after it is a ']'.
     # * the char after it is space, then a '{'.
     class SpacesAfterLbracketRuler < Tailor::Ruler
-      def initialize(config)
-        super(config)
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :comment, :ignored_nl, :lbracket, :nl
         @lbracket_columns = []
       end
 
@@ -41,8 +42,11 @@ class Tailor
       # @param [Fixnum] column Column the problem was found on.
       def measure(actual_spaces, lineno, column)
         if actual_spaces != @config
-          @problems << Problem.new(:spaces_after_lbracket, lineno, column + 1,
-            { actual_spaces: actual_spaces, should_have: @config })
+          msg = "Line has #{actual_spaces} space(s) after a [, "
+          msg << "but should have #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column + 1, msg,
+            @options[:level])
         end
       end
 

data/lib/tailor/rulers/spaces_after_lparen_ruler.rb

@@ -3,8 +3,9 @@ require_relative '../ruler'
 class Tailor
   module Rulers
     class SpacesAfterLparenRuler < Tailor::Ruler
-      def initialize(config)
-        super(config)
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :comment, :ignored_nl, :lparen, :nl
         @lparen_columns = []
       end
 
@@ -35,8 +36,11 @@ class Tailor
       # @param [Fixnum] column Column the potential problem is on.
       def measure(actual_spaces, lineno, column)
         if actual_spaces != @config
-          @problems << Problem.new(:spaces_after_lparen, lineno, column + 1,
-            { actual_spaces: actual_spaces, should_have: @config })
+          msg = "Line has #{actual_spaces} space(s) after a (, "
+          msg << "but should have #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column + 1, msg,
+            @options[:level])
         end
       end
 

data/lib/tailor/rulers/spaces_before_comma_ruler.rb

@@ -5,8 +5,9 @@ class Tailor
 
     # Checks for spaces before a ',' as given by +@config+.
     class SpacesBeforeCommaRuler < Tailor::Ruler
-      def initialize(config)
-        super(config)
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :comma, :comment, :ignored_nl, :nl
         @comma_columns = []
       end
 
@@ -29,8 +30,11 @@ class Tailor
       # @param [Fixnum] column Column the potential problem is on.
       def measure(actual_spaces, lineno, column)
         if actual_spaces != @config
-          @problems << Problem.new(:spaces_before_comma, lineno, column - 1,
-            { actual_spaces: actual_spaces, should_have: @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
 

data/lib/tailor/rulers/spaces_before_lbrace_ruler.rb

@@ -3,7 +3,7 @@ require_relative '../ruler'
 class Tailor
   module Rulers
 
-    # Detects spaces before a '{' as given by +@config+.  It skips checking
+    # Detects spaces before a +{+ as given by +@config+.  It skips checking
     # when:
     # * it's the first char in the line.
     # * the char before it is a '#{'.
@@ -11,6 +11,10 @@ class Tailor
     # * the char before it is a '['.
     # * it's only preceded by spaces.
     class SpacesBeforeLbraceRuler < Tailor::Ruler
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :lbrace
+      end
 
       # Counts the spaces before the '{'.
       #
@@ -79,13 +83,16 @@ class Tailor
       # Checks to see if the counted spaces before an lbrace equals the value
       # at +@config+.
       #
-      # @param [Fixnum] count The number of spaces before the lbrace.
+      # @param [Fixnum] actual_spaces The number of spaces before the lbrace.
       # @param [Fixnum] lineno Line the potential problem is on.
       # @param [Fixnum] column Column the potential problem is on.
-      def measure(count, lineno, column)
-        if count != @config
-          @problems << Problem.new(:spaces_before_lbrace, lineno, column,
-            { actual_spaces: count, should_have: @config })
+      def measure(actual_spaces, lineno, column)
+        if actual_spaces != @config
+          msg = "Line has #{actual_spaces} space(s) before a {, "
+          msg << "but should have #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column, msg,
+            @options[:level])
         end
       end
     end

data/lib/tailor/rulers/spaces_before_rbrace_ruler.rb

@@ -3,14 +3,15 @@ require_relative '../ruler'
 class Tailor
   module Rulers
 
-    # Checks for spaces before a '}' as given by +@config+.  It skips checking
+    # Checks for spaces before a +}+ as given by +@config+.  It skips checking
     # 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 '{'.
     class SpacesBeforeRbraceRuler < Tailor::Ruler
-      def initialize(config)
-        super(config)
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :embexpr_beg, :lbrace, :rbrace
         @lbrace_nesting = []
       end
 
@@ -57,13 +58,16 @@ class Tailor
       # Checks to see if the number of spaces before an rbrace equals the value
       # at +@config+.
       #
-      # @param [Fixnum] count The number of spaces after the rbrace.
+      # @param [Fixnum] actual_spaces The number of spaces after the rbrace.
       # @param [Fixnum] lineno Line the problem was found on.
       # @param [Fixnum] column Column the problem was found on.
-      def measure(count, lineno, column)
-        if count != @config
-          @problems << Problem.new(:spaces_before_rbrace, lineno, column,
-            { actual_spaces: count, should_have: @config })
+      def measure(actual_spaces, lineno, column)
+        if actual_spaces != @config
+          msg = "Line has #{actual_spaces} space(s) before a }, "
+          msg << "but should have #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column, msg,
+            @options[:level])
         end
       end
 

data/lib/tailor/rulers/spaces_before_rbracket_ruler.rb

@@ -9,6 +9,10 @@ class Tailor
     # * it's directly preceded by a '['.
     # * it's directly preceded by spaces, then a '['.
     class SpacesBeforeRbracketRuler < Tailor::Ruler
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :rbracket
+      end
 
       # @param [LexedLine] lexed_line
       # @param [Fixnum] column
@@ -36,13 +40,16 @@ class Tailor
       # Checks to see if the counted spaces before an rbracket equals the value
       # at +@config+.
       #
-      # @param [Fixnum] count The number of spaces before the rbracket.
+      # @param [Fixnum] actual_spaces The number of spaces before the rbracket.
       # @param [Fixnum] lineno Line the potential problem is on.
       # @param [Fixnum] column Column the potential problem is on.
-      def measure(count, lineno, column)
-        if count != @config
-          @problems << Problem.new(:spaces_before_rbracket, lineno, column,
-            { actual_spaces: count, should_have: @config })
+      def measure(actual_spaces, lineno, column)
+        if actual_spaces != @config
+          msg = "Line has #{actual_spaces} space(s) before a ], "
+          msg << "but should have #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column, msg,
+            @options[:level])
         end
       end
 

data/lib/tailor/rulers/spaces_before_rparen_ruler.rb

@@ -3,12 +3,16 @@ require_relative '../ruler'
 class Tailor
   module Rulers
 
-    # Checks for spaces before a ')' as given by +@config+.  It skips checking
+    # Checks for spaces before a +)+ as given by +@config+.  It skips checking
     # when:
     # * it's the first char in the line.
     # * it's directly preceded by a '('.
     # * it's directly preceded by spaces, then a '('.
     class SpacesBeforeRparenRuler < Tailor::Ruler
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :rparen
+      end
 
       # @param [LexedLine] lexed_line
       # @param [Fixnum] column
@@ -36,13 +40,16 @@ class Tailor
       # Checks to see if the counted spaces before an rparen equals the value
       # at +@config+.
       #
-      # @param [Fixnum] count The number of spaces before the rparen.
+      # @param [Fixnum] actual_spaces The number of spaces before the rparen.
       # @param [Fixnum] lineno Line the potential problem is on.
       # @param [Fixnum] column Column the potential problem is on.
-      def measure(count, lineno, column)
-        if count != @config
-          @problems << Problem.new(:spaces_before_rparen, lineno, column,
-            { actual_spaces: count, should_have: @config })
+      def measure(actual_spaces, lineno, column)
+        if actual_spaces != @config
+          msg = "Line has #{actual_spaces} space(s) before a ), "
+          msg << "but should have #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column, msg,
+            @options[:level])
         end
       end
 

data/lib/tailor/rulers/spaces_in_empty_braces_ruler.rb

@@ -3,11 +3,12 @@ require_relative '../ruler'
 class Tailor
   module Rulers
 
-    # Checks for spaces that exist between a '{' and '}' when there is only
+    # Checks for spaces that exist between a +{+ and +}+ when there is only
     # space in between them.
     class SpacesInEmptyBracesRuler < Tailor::Ruler
-      def initialize(config)
-        super(config)
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :embexpr_beg, :lbrace, :rbrace
         @lbrace_nesting = []
       end
 
@@ -54,18 +55,21 @@ class Tailor
       # Checks to see if the counted spaces between an lbrace and an rbrace
       # equals the value at +@config+.
       #
-      # @param [Fixnum] count The number of spaces before the lbrace.
+      # @param [Fixnum] actual_spaces The number of spaces before the lbrace.
       # @param [Fixnum] lineno Line the potential problem is on.
       # @param [Fixnum] column Column the potential problem is on.
-      def measure(count, lineno, column)
-        if count != @config
-          @problems << Problem.new(:spaces_in_empty_braces, lineno, column,
-            { actual_spaces: count, should_have: @config })
+      def measure(actual_spaces, lineno, column)
+        if actual_spaces != @config
+          msg = "Line has #{actual_spaces} space(s) in between empty "
+          msg << "braces, but should have #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column, msg,
+            @options[:level])
         end
       end
 
       # 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
+      # if the +{+ was an lbrace because Ripper doesn't scan the +}+ of an
       # embedded expression (embexpr_end) as such.
       #
       # @param [Tailor::LexedLine] lexed_line

data/lib/tailor/rulers/trailing_newlines_ruler.rb

@@ -4,6 +4,10 @@ require_relative '../ruler'
 class Tailor
   module Rulers
     class TrailingNewlinesRuler < Tailor::Ruler
+      def initialize(config, options)
+        super(config, options)
+        add_lexer_observers :file_end
+      end
 
       # Checks to see if the number of newlines at the end of the file is not
       # equal to the value at +@config+.
@@ -14,10 +18,11 @@ class Tailor
         if trailing_newline_count != @config
           lineno = "<EOF>"
           column = "<EOF>"
-          @problems << Problem.new(:trailing_newlines, lineno, column,
-            { actual_trailing_newlines: trailing_newline_count,
-              should_have: @config }
-          )
+          msg = "File has #{trailing_newline_count} trailing "
+          msg << "newlines, but should have #{@config}."
+
+          @problems << Problem.new(problem_type, lineno, column, msg,
+            @options[:level])
         end
       end
 
@@ -28,7 +33,7 @@ class Tailor
       # final line won't ever get caught).
       #
       # @param [Fixnum] trailing_newline_count
-      def file_update(trailing_newline_count)
+      def file_end_update(trailing_newline_count)
         measure(trailing_newline_count)
       end
     end