tailor 1.3.1 → 1.4.0

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

@@ -0,0 +1,89 @@
+class Tailor
+  module Rulers
+    class IndentationSpacesRuler < Tailor::Ruler
+
+      # XXX: Reproducing the ast querying functions from foodcritic here. We
+      # either need to re-implement the queries not to rely on these functions
+      # or extract these functions to a shared gem.
+      module AstXml
+
+        def xml_array_node(doc, xml_node, child)
+          n = xml_create_node(doc, child)
+          xml_node.add_child(build_xml(child, doc, n))
+        end
+
+        def xml_create_node(doc, c)
+          Nokogiri::XML::Node.new(c.first.to_s.gsub(/[^a-z_]/, ''), doc)
+        end
+
+        def xml_document(doc, xml_node)
+          if doc.nil?
+            doc = Nokogiri::XML('<opt></opt>')
+            xml_node = doc.root
+          end
+          [doc, xml_node]
+        end
+
+        def xml_hash_node(doc, xml_node, child)
+          child.each do |c|
+            n = xml_create_node(doc, c)
+            c.drop(1).each do |a|
+              xml_node.add_child(build_xml(a, doc, n))
+            end
+          end
+        end
+
+        def xml_position_node(doc, xml_node, child)
+          pos = Nokogiri::XML::Node.new('pos', doc)
+          pos['line'] = child.first.to_s
+          pos['column'] = child[1].to_s
+          xml_node.add_child(pos)
+        end
+
+        def ast_hash_node?(node)
+          node.first.respond_to?(:first) and node.first.first == :assoc_new
+        end
+
+        def ast_node_has_children?(node)
+          node.respond_to?(:first) and ! node.respond_to?(:match)
+        end
+
+        # If the provided node is the line / column information.
+        def position_node?(node)
+          node.respond_to?(:length) and node.length == 2 and
+          node.respond_to?(:all?) and node.all? do |child|
+            child.respond_to?(:to_i)
+          end
+        end
+
+        def build_xml(node, doc = nil, xml_node=nil)
+          doc, xml_node = xml_document(doc, xml_node)
+
+          if node.respond_to?(:each)
+            # First child is the node name
+            node.drop(1) if node.first.is_a?(Symbol)
+            node.each do |child|
+              if position_node?(child)
+                xml_position_node(doc, xml_node, child)
+              else
+                if ast_node_has_children?(child)
+                  # The AST structure is different for hashes so we have to treat
+                  # them separately.
+                  if ast_hash_node?(child)
+                    xml_hash_node(doc, xml_node, child)
+                  else
+                    xml_array_node(doc, xml_node, child)
+                  end
+                else
+                  xml_node['value'] = child.to_s unless child.nil?
+                end
+              end
+            end
+          end
+          xml_node
+        end
+
+      end
+    end
+  end
+end

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

@@ -33,9 +33,6 @@ class Tailor
           on_rparen: :on_lparen
         }
 
-        # Allows for updating the indent expectation for the current line.
-        attr_accessor :amount_to_change_this
-
         # @return [Fixnum] The actual number of characters the current line is
         #   indented.
         attr_reader :actual_indentation
@@ -52,7 +49,6 @@ class Tailor
           @proper = { this_line: 0, next_line: 0 }
           @actual_indentation = 0
           @indent_reasons = []
-          @amount_to_change_this = 0
 
           start
         end
@@ -79,20 +75,12 @@ class Tailor
           end
         end
 
-        # Sets up expectations in +@proper+ based on the number of +/- reasons
-        # to change this and next lines, given in +@amount_to_change_this+.
-        def set_up_line_transition
-          log "Amount to change this line: #{@amount_to_change_this}"
-          decrease_this_line if @amount_to_change_this < 0
-        end
-
         # Should be called just before moving to the next line.  This sets the
         # expectation set in +@proper[:next_line]+ to
         # +@proper[:this_line]+.
         def transition_lines
           if started?
             log 'Resetting change_this to 0.'
-            @amount_to_change_this = 0
             log 'Setting @proper[:this_line] = that of :next_line'
             @proper[:this_line] = @proper[:next_line]
             log "Transitioning @proper[:this_line] to #{@proper[:this_line]}"
@@ -286,10 +274,10 @@ 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
+            @proper[:this_line] = [0, @proper[:this_line] - @spaces].max
             msg = 'End multi-line statement. '
             msg < "change_this -= 1 -> #{@proper[:this_line]}."
             log msg

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

@@ -0,0 +1,58 @@
+require 'ripper'
+require_relative './ast_xml'
+
+class Tailor
+  module Rulers
+    class IndentationSpacesRuler < Tailor::Ruler
+
+      # Determines whether a line is a continuation of previous lines. For ease
+      # of implementation we use the s-exp support in Ripper, rather than trying
+      # to work it out solely from the token events on the ruler.
+      class LineContinuations
+
+        include AstXml
+
+        def initialize(file_name)
+          @ast = build_xml(Ripper::SexpBuilder.new(File.read(file_name)).parse)
+        end
+
+        # Is the specified line actually a previous line continuing?
+        def line_is_continuation?(lineno)
+          @continuations ||= begin
+            statements = @ast.xpath('//stmts_add/*[
+              preceding-sibling::stmts_new | preceding-sibling::stmts_add]')
+            statements.reject do |stmt|
+              s = stmt.xpath('ancestor::stmts_add').size
+              stmt.xpath("descendant::pos[count(ancestor::stmts_add) = #{s}]/
+                @line").map { |s| s.to_s.to_i }.uniq.size < 2
+            end.reject { |stmt| stmt.name == 'case' }.map do |stmt|
+              lines_nesting = lines_with_nesting_level(stmt)
+              lines_nesting.shift
+              min_level = lines_nesting.values.min
+              lines_nesting.reject { |_, n| n > min_level }.keys
+            end.flatten
+          end
+
+          @continuations.include?(lineno)
+        end
+
+        # Are there statements further nested below this line?
+        def line_has_nested_statements?(lineno)
+          @ast.xpath("//pos[@line='#{lineno}']/
+            ancestor::*[parent::stmts_add][1]/
+            descendant::stmts_add[descendant::pos[@line > #{lineno}]]").any?
+        end
+
+        private
+
+        # Returns a hash of line numbers => nesting level
+        def lines_with_nesting_level(node)
+          Hash[node.xpath('descendant::pos/@line').map do |ln|
+            [ln.to_s.to_i, ln.xpath('count(ancestor::stmts_add)').to_i]
+          end.sort.uniq]
+        end
+
+      end
+    end
+  end
+end

data/lib/tailor/rulers/max_code_lines_in_class_ruler.rb

@@ -4,7 +4,7 @@ require_relative '../lexer/lexer_constants'
 class Tailor
   module Rulers
     class MaxCodeLinesInClassRuler < Tailor::Ruler
-      include LexerConstants
+      include Tailor::LexerConstants
 
       def initialize(config, options)
         super(config, options)
@@ -14,7 +14,7 @@ class Tailor
         @end_last_class = false
       end
 
-      def ignored_nl_update(lexed_line, lineno, column)
+      def ignored_nl_update(lexed_line, _, _)
         return if @class_start_lines.empty?
         return if lexed_line.only_spaces?
         return if lexed_line.comment_line?
@@ -33,7 +33,7 @@ class Tailor
         end
       end
 
-      def kw_update(token, lexed_line, lineno, column)
+      def kw_update(token, _, lineno, column)
         if token == 'class' || token == 'module'
           @class_start_lines << { lineno: lineno, column: column, count: 0 }
           log "Class start lines: #{@class_start_lines}"

data/lib/tailor/rulers/max_code_lines_in_method_ruler.rb

@@ -4,7 +4,7 @@ require_relative '../lexer/lexer_constants'
 class Tailor
   module Rulers
     class MaxCodeLinesInMethodRuler < Tailor::Ruler
-      include LexerConstants
+      include Tailor::LexerConstants
 
       def initialize(config, options)
         super(config, options)
@@ -14,7 +14,7 @@ class Tailor
         @end_last_method = false
       end
 
-      def ignored_nl_update(lexed_line, lineno, column)
+      def ignored_nl_update(lexed_line, _, _)
         return if @method_start_lines.empty?
         return if lexed_line.only_spaces?
         return if lexed_line.comment_line?
@@ -33,7 +33,7 @@ class Tailor
         end
       end
 
-      def kw_update(token, lexed_line, lineno, column)
+      def kw_update(token, _, lineno, column)
         if token == 'def'
           @method_start_lines << { lineno: lineno, column: column, count: 0 }
           log "Method start lines: #{@method_start_lines}"

data/lib/tailor/rulers/spaces_after_comma_ruler.rb

@@ -14,18 +14,18 @@ class Tailor
         @comma_columns = []
       end
 
-      def comma_update(text_line, lineno, column)
+      def comma_update(_, _, column)
         @comma_columns << column
       end
 
-      def comment_update(token, lexed_line, file_text, lineno, column)
+      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
 
-      def ignored_nl_update(lexed_line, lineno, column)
+      def ignored_nl_update(lexed_line, lineno, _)
         check_spaces_after_comma(lexed_line, lineno)
       end
 

data/lib/tailor/rulers/spaces_after_conditional_ruler.rb

@@ -9,7 +9,7 @@ class Tailor
         add_lexer_observers :nl
       end
 
-      def nl_update(current_lexed_line, lineno, column)
+      def nl_update(current_lexed_line, lineno, _)
         measure(current_lexed_line, lineno)
       end
 
@@ -19,7 +19,7 @@ class Tailor
       # @param [Fixnum] lineno Line the problem was found on.
       def measure(lexed_line, lineno)
 
-        idx = lexed_line.index do |pos, token, name|
+        idx = lexed_line.index do |_, token, name|
           token == :on_kw and %w{if unless case}.include?(name)
         end
 
@@ -28,7 +28,7 @@ class Tailor
 
         if idx
           column = lexed_line[idx].first.last
-          pos, token, name = lexed_line[idx + 1]
+          pos, token, _ = lexed_line[idx + 1]
           spaces = case token
           when :on_lparen then 0
           when :on_sp

data/lib/tailor/rulers/spaces_after_lbrace_ruler.rb

@@ -15,18 +15,18 @@ class Tailor
         @lbrace_columns = []
       end
 
-      def comment_update(token, lexed_line, file_text, lineno, column)
+      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
 
-      def ignored_nl_update(lexed_line, lineno, column)
+      def ignored_nl_update(lexed_line, lineno, _)
         check_spaces_after_lbrace(lexed_line, lineno)
       end
 
-      def lbrace_update(lexed_line, lineno, column)
+      def lbrace_update(_, _, column)
         @lbrace_columns << column
       end
 

data/lib/tailor/rulers/spaces_after_lbracket_ruler.rb

@@ -15,18 +15,18 @@ class Tailor
         @lbracket_columns = []
       end
 
-      def comment_update(token, lexed_line, file_text, lineno, column)
+      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
 
-      def ignored_nl_update(lexed_line, lineno, column)
+      def ignored_nl_update(lexed_line, lineno, _)
         check_spaces_after_lbracket(lexed_line, lineno)
       end
 
-      def lbracket_update(lexed_line, lineno, column)
+      def lbracket_update(_, _, column)
         @lbracket_columns << column
       end
 

data/lib/tailor/rulers/spaces_after_lparen_ruler.rb

@@ -9,18 +9,18 @@ class Tailor
         @lparen_columns = []
       end
 
-      def comment_update(token, lexed_line, file_text, lineno, column)
+      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
 
-      def ignored_nl_update(lexed_line, lineno, column)
+      def ignored_nl_update(lexed_line, lineno, _)
         check_spaces_after_lparen(lexed_line, lineno)
       end
 
-      def lparen_update(lineno, column)
+      def lparen_update(_, column)
         @lparen_columns << column
       end
 

data/lib/tailor/rulers/spaces_before_comma_ruler.rb

@@ -11,11 +11,11 @@ class Tailor
         @comma_columns = []
       end
 
-      def comma_update(text_line, lineno, column)
+      def comma_update(_, _, column)
         @comma_columns << column
       end
 
-      def comment_update(token, lexed_line, file_text, lineno, column)
+      def comment_update(token, lexed_line, _, lineno, column)
         if token =~ /\n$/
           log 'Found comment with trailing newline.'
           ignored_nl_update(lexed_line, lineno, column)
@@ -59,7 +59,7 @@ class Tailor
         @comma_columns.clear
       end
 
-      def ignored_nl_update(lexed_line, lineno, column)
+      def ignored_nl_update(lexed_line, lineno, _)
         check_spaces_before_comma(lexed_line, lineno)
       end
 

data/lib/tailor/rulers/spaces_before_rbrace_ruler.rb

@@ -48,13 +48,13 @@ class Tailor
         previous_event.last.size
       end
 
-      def embexpr_beg_update(lexed_line, lineno, column)
+      def embexpr_beg_update(_, _, _)
         if RUBY_VERSION < '2.0.0'
           @lbrace_nesting << :embexpr_beg
         end
       end
 
-      def lbrace_update(lexed_line, lineno, column)
+      def lbrace_update(_, _, _)
         @lbrace_nesting << :lbrace
       end
 

data/lib/tailor/rulers/spaces_in_empty_braces_ruler.rb

@@ -40,11 +40,11 @@ class Tailor
         end
       end
 
-      def embexpr_beg_update(lexed_line, lineno, column)
+      def embexpr_beg_update(_, _, _)
         @lbrace_nesting << :embexpr_beg
       end
 
-      def lbrace_update(lexed_line, lineno, column)
+      def lbrace_update(_, _, _)
         @lbrace_nesting << :lbrace
       end
 

data/lib/tailor/tailorrc.erb

@@ -12,6 +12,17 @@
 # indentation_spaces      The number of spaces to consider a proper indent.
 #                         Default:      2
 #
+#                         Option: line_continuations
+#                         Indicates that a statement that spans multiple lines
+#                         should indent the second and subsequent lines.  Ex.:
+#                         style.indentation_spaces 2, level: :error, line_continuations: true
+#
+#                         Option: argument_align
+#                         Allowing you to specify that method declarations and
+#                         calls should indent to the first argument on
+#                         subsequent lines.  Ex.:
+#                         style.indentation_spaces 2, level: :error, argument_alignment: true
+#
 # max_line_length         The maximum number of characters in a line before
 #                         tailor complains.
 #                         Default:      80
@@ -79,6 +90,23 @@
 #                         the file.
 #                         Default:      1
 #
+#------------------------------------------------------------------------------
+# Common Syntax
+#------------------------------------------------------------------------------
+# allow_conditional_parentheses
+#                         Checks to see if a conditional is unnecessarily
+#                         wrapped in parentheses.
+#                         Default:      true
+#
+# allow_unnecessary_double_quotes
+#                         Checks for use of double-quotes when no interpolation
+#                         is used.
+#                         Default:      false
+#
+# allow_unnecessary_interpolation
+#                         Checks for unnecessary interpolation in strings.
+#                         Default:      false
+#
 Tailor.config do |config|
   config.formatters "<%= formatters.join(', ') %>"
   config.file_set '<%= file_list %>' do |style|<% style.each do |rule, value| %>