tailor 1.2.1 → 1.3.0

data/lib/tailor/lexed_line.rb

@@ -202,7 +202,6 @@ class Tailor
     # observers that key off ending the line will never get triggered, and thus
     # style won't get checked for that line.
     #
-    # @param [Fixnum] column The column that the comment is at.
     # @param [String] file_text The whole file's worth of text.  Required in
     #   order to be able to reconstruct the context in which the line exists.
     # @return [LexedLine] The current lexed line, but with the trailing comment
@@ -235,7 +234,6 @@ class Tailor
 
     # Determines if the current lexed line is just the end of a tstring.
     #
-    # @param [Array] lexed_line_output The lexed output for the current line.
     # @return [Boolean] +true+ if the line contains a +:on_tstring_end+ and
     #   not a +:on_tstring_beg+.
     def end_of_multi_line_string?
@@ -269,8 +267,8 @@ class Tailor
     private
 
     def log(*args)
-      l = begin; lineno; rescue; "<EOF>"; end
-      c = begin; column; rescue; "<EOF>"; end
+      l = begin; lineno; rescue; '<EOF>'; end
+      c = begin; column; rescue; '<EOF>'; end
       subclass_name = self.class.to_s.sub(/^Tailor::/, '')
       args.first.insert(0, "<#{subclass_name}> #{l}[#{c}]: ")
       Tailor::Logger.log(*args)

data/lib/tailor/lexer.rb

@@ -23,7 +23,7 @@ class Tailor
         @file_name = file
         File.open(@file_name, 'r').read
       else
-        @file_name = "<notafile>"
+        @file_name = '<notafile>'
         file
       end
 
@@ -214,7 +214,7 @@ class Tailor
     #
     # @param [String] token The token that the lexer matched.
     def on_ignored_nl(token)
-      log "IGNORED_NL"
+      log 'IGNORED_NL'
 
       current_line = LexedLine.new(super, lineno)
       ignored_nl_changed
@@ -306,7 +306,7 @@ class Tailor
 
     # This is the first thing that exists on a new line--NOT the last!
     def on_nl(token)
-      log "NL"
+      log 'NL'
       current_line = LexedLine.new(super, lineno)
 
       nl_changed
@@ -560,17 +560,17 @@ class Tailor
     # with line-ending backslashes that break up statements.
     #
     # @param [String] file_text The file test to check.
-    # @param [String] The altered file text.
+    # @return [String] The altered file text.
     def sub_line_ending_backslashes(file_text)
-      backslash_replacement = "# TAILOR REMOVED BACKSLASH"
+      backslash_replacement = '# TAILOR REMOVED BACKSLASH'
       file_text.gsub!(/\\\s*\n?$/, backslash_replacement)
-      
+
       file_text
     end
-    
+
     def log(*args)
-      l = begin; lineno; rescue; "<EOF>"; end
-      c = begin; column; rescue; "<EOF>"; end
+      l = begin; lineno; rescue; '<EOF>'; end
+      c = begin; column; rescue; '<EOF>'; end
       subclass_name = self.class.to_s.sub(/^Tailor::/, '')
       args.first.insert(0, "<#{subclass_name}> #{l}[#{c}]: ")
       Tailor::Logger.log(*args)

data/lib/tailor/lexer/lexer_constants.rb

@@ -7,38 +7,38 @@ class Tailor
   # * https://github.com/ruby/ruby/blob/trunk/ext/ripper/eventids2.c
   # * https://github.com/ruby/ruby/blob/trunk/parse.y
   module LexerConstants
-    KEYWORDS_TO_INDENT = Set.new [
-      'begin',
-      'case',
-      'class',
-      'def',
-      'do',
-      'else',
-      'elsif',
-      'ensure',
-      'for',
-      'if',
-      'module',
-      'rescue',
-      'unless',
-      'until',
-      'when',
-      'while'
+    KEYWORDS_TO_INDENT = Set.new %w[
+      begin
+      case
+      class
+      def
+      do
+      else
+      elsif
+      ensure
+      for
+      if
+      module
+      rescue
+      unless
+      until
+      when
+      while
     ]
 
-    CONTINUATION_KEYWORDS = Set.new [
-      'elsif',
-      'else',
-      'ensure',
-      'rescue',
-      'when'
+    CONTINUATION_KEYWORDS = Set.new %w[
+      elsif
+      else
+      ensure
+      rescue
+      when
     ]
 
-    KEYWORDS_AND_MODIFIERS = Set.new [
-      'if',
-      'unless',
-      'until',
-      'while'
+    KEYWORDS_AND_MODIFIERS = Set.new %w[
+      if
+      unless
+      until
+      while
     ]
 
     MODIFIERS = {
@@ -68,10 +68,10 @@ class Tailor
       '~>'                              # gem_version op
     ]
 
-    LOOP_KEYWORDS = Set.new [
-      'for',
-      'until',
-      'while'
+    LOOP_KEYWORDS = Set.new %w[
+      for
+      until
+      while
     ]
   end
 end

data/lib/tailor/lexer/token.rb

@@ -40,7 +40,7 @@ class Tailor
       #
       # @return [Boolean]
       def do_is_for_a_loop?
-        self == "do" && @options[:loop_with_do]
+        self == 'do' && @options[:loop_with_do]
       end
 
       # @return [Boolean]
@@ -68,21 +68,21 @@ class Tailor
         line_of_text = @options[:full_line_of_text]
         log "Line of text: #{line_of_text}"
 
-        result = catch(:result) do
+        catch(:result) do
           sexp_line = Ripper.sexp(line_of_text)
 
           if sexp_line.nil?
-            msg = "sexp line was nil.  "
-            msg << "Perhaps that line is part of a multi-line statement?"
+            msg = 'sexp line was nil.  '
+            msg << 'Perhaps that line is part of a multi-line statement?'
             log msg
-            log "Trying again with the last char removed from the line..."
+            log 'Trying again with the last char removed from the line...'
             line_of_text.chop!
             sexp_line = Ripper.sexp(line_of_text)
           end
 
           if sexp_line.nil?
-            log "sexp line was nil again."
-            log "Trying 1 more time with the last char removed from the line..."
+            log 'sexp line was nil again.'
+            log 'Trying 1 more time with the last char removed from the line...'
             line_of_text.chop!
             sexp_line = Ripper.sexp(line_of_text)
           end
@@ -99,10 +99,8 @@ class Tailor
             end
           end
         end
-
-        result
       end
-      
+
       # @return [Boolean]
       def fake_backslash_line_end?
         self =~ /^# TAILOR REMOVED BACKSLASH\n?$/

data/lib/tailor/logger.rb

@@ -11,7 +11,7 @@ class Tailor
       @logger ||= ::Logger.new $stdout
 
       def @logger.format_message(level, time, progname, msg)
-        "[#{time.strftime("%Y-%m-%d %H:%M:%S")}]  #{msg}\n"
+        "[#{time.strftime('%Y-%m-%d %H:%M:%S')}]  #{msg}\n"
       end
 
       @logger

data/lib/tailor/problem.rb

@@ -9,7 +9,10 @@ class Tailor
     include LogSwitch::Mixin
 
     # @param [Symbol] type The problem type.
-    # @param [Binding] binding The context that the problem was discovered in.
+    # @param [Fixnum] line The line of the file the problem was found on.
+    # @param [Fixnum] column The column of the file line the problem was found on.
+    # @param [String] message The message to tell the user about the problem.
+    # @param [Fixnum] level The severity of the problem.
     def initialize(type, line, column, message, level)
       @type = type
       @line = line

data/lib/tailor/rake_task.rb

@@ -124,7 +124,10 @@ class Tailor
       configuration = Tailor::Configuration.new([],
         Tailor::CLI::Options.parse!(@tailor_opts))
       configuration.load!
-      configuration.formatters(formatters) unless formatters.nil? || formatters.empty?
+
+      unless formatters.nil? || formatters.empty?
+        configuration.formatters(formatters)
+      end
 
       configuration
     end

data/lib/tailor/reporter.rb

@@ -44,9 +44,9 @@ class Tailor
       @formatters.each do |formatter|
         summary = formatter.summary_report(all_problems)
         if formatter.respond_to?(:accepts_output_file) &&
-                         formatter.accepts_output_file &&
-                         !opts[:output_file].empty?
-          File.open(opts[:output_file], "w") { |f| f.puts summary }
+          formatter.accepts_output_file &&
+          !opts[:output_file].empty?
+          File.open(opts[:output_file], 'w') { |f| f.puts summary }
         end
       end
     end

data/lib/tailor/ruler.rb

@@ -27,7 +27,7 @@ class Tailor
   # to publish events (in this case, characters or string Ruby constructs) of
   # interest to its observers.  Rulers subscribe to those events so that they
   # can detect the problems they're looking for.  These are defined as a Set in
-  # @lexer_observers.  Adding to that list means the Ruler will subscribe to
+  # +@lexer_observers+.  Adding to that list means the Ruler will subscribe to
   # those events.
   #
   # Example:
@@ -78,7 +78,7 @@ class Tailor
     # Each ruler should redefine this for its needs.
     def measure(*args)
       raise RuntimeError,
-        "Ruler#measure called, but should be redefined by a real ruler."
+        'Ruler#measure called, but should be redefined by a real ruler.'
     end
 
     # Converts the {Tailor::Ruler} name to snake case.

data/lib/tailor/rulers/allow_camel_case_methods_ruler.rb

@@ -10,7 +10,7 @@ class Tailor
 
       def ident_update(token, lexed_line, lineno, column)
         ident_index = lexed_line.event_index(column)
-        find_event = lexed_line.find { |e| e[1] == :on_kw && e.last == "def" }
+        find_event = lexed_line.find { |e| e[1] == :on_kw && e.last == 'def' }
 
         if find_event && find_event.any?
           measure(token, lineno, column)
@@ -24,7 +24,7 @@ class Tailor
       # @param [Fixnum] column Column the problem was found on.
       def measure(token, lineno, column)
         if token.contains_capital_letter?
-          problem_message = "Camel-case method name found."
+          problem_message = 'Camel-case method name found.'
 
           @problems << Problem.new(problem_type, lineno, column,
             problem_message, @options[:level])

data/lib/tailor/rulers/allow_hard_tabs_ruler.rb

@@ -19,7 +19,7 @@ class Tailor
       # @param [Fixnum] column Column the problem was found on.
       def measure(token, lineno, column)
         if token.contains_hard_tab?
-          problem_message = "Hard tab found."
+          problem_message = 'Hard tab found.'
 
           @problems << Problem.new(problem_type, lineno, column,
             problem_message, @options[:level])

data/lib/tailor/rulers/allow_invalid_ruby_ruler.rb

@@ -16,7 +16,7 @@ class Tailor
 
       # @return [Boolean]
       def invalid_ruby?
-        log "Checking for valid Ruby..."
+        log 'Checking for valid Ruby...'
         result = `"#{Gem.ruby}" -c "#{@file_name}"`
 
         result.size.zero?

data/lib/tailor/rulers/allow_screaming_snake_case_classes_ruler.rb

@@ -16,7 +16,7 @@ class Tailor
         return if previous_event.nil?
 
         if previous_event[1] == :on_kw &&
-          (previous_event.last == "class" || previous_event.last == "module")
+          (previous_event.last == 'class' || previous_event.last == 'module')
           measure(token, lineno, column)
         end
       end
@@ -28,7 +28,7 @@ class Tailor
       # @param [Fixnum] column Column the potential problem is on.
       def measure(token, lineno, column)
         if token.screaming_snake_case?
-          problem_message = "Screaming-snake-case class/module found."
+          problem_message = 'Screaming-snake-case class/module found.'
 
           @problems << Problem.new(problem_type, lineno, column,
             problem_message, @options[:level])

data/lib/tailor/rulers/indentation_spaces_ruler.rb

@@ -31,14 +31,14 @@ class Tailor
 
       def comment_update(token, lexed_line, file_text, lineno, column)
         if token.fake_backslash_line_end?
-          log "Line was altered by tailor to accommodate trailing backslash"
+          log 'Line was altered by tailor to accommodate trailing backslash'
           @manager.add_indent_reason(:trailing_backslash, :trailing_backslash,
             lineno)
         end
 
         # trailing comment?
         if token.ends_with_newline?
-          log "Comment ends with newline.  Removing comment..."
+          log 'Comment ends with newline.  Removing comment...'
           log "Old lexed line: #{lexed_line.inspect}"
 
           new_lexed_line = lexed_line.remove_trailing_comment(file_text)
@@ -46,10 +46,10 @@ class Tailor
           log "New lexed line: #{new_lexed_line.inspect}"
 
           if new_lexed_line.ends_with_ignored_nl?
-            log "New lexed line ends with :on_ignored_nl."
+            log 'New lexed line ends with :on_ignored_nl.'
             ignored_nl_update(new_lexed_line, lineno, column)
           elsif new_lexed_line.ends_with_nl?
-            log "New lexed line ends with :on_nl."
+            log 'New lexed line ends with :on_nl.'
             nl_update(new_lexed_line, lineno, column)
           end
         end
@@ -69,11 +69,11 @@ class Tailor
         @embexpr_nesting.pop
 
         if @manager.multi_line_braces?(lineno)
-          log "End of multi-line braces!"
+          log 'End of multi-line braces!'
 
           if current_lexed_line.only_embexpr_end?
             @manager.amount_to_change_this -= 1
-            msg = "lonely embexpr_end.  "
+            msg = 'lonely embexpr_end.  '
             msg << "change_this -= 1 -> #{@manager.amount_to_change_this}"
             log msg
           end
@@ -86,21 +86,21 @@ class Tailor
         log "indent reasons on entry: #{@manager.indent_reasons}"
 
         if current_lexed_line.only_spaces?
-          log "Line of only spaces.  Moving on."
+          log 'Line of only spaces.  Moving on.'
           # todo: maybe i shouldn't return here? ...do transitions?
           return
         end
 
         if @manager.line_ends_with_single_token_indenter?(current_lexed_line)
-          log "Line ends with single-token indent token."
+          log 'Line ends with single-token indent token.'
 
           unless @manager.in_an_enclosure? &&
             current_lexed_line.ends_with_comma?
-            log "Line-ending single-token indenter found."
+            log 'Line-ending single-token indenter found.'
             token_event = current_lexed_line.last_non_line_feed_event
 
             unless @manager.line_ends_with_same_as_last token_event
-              msg = "Line ends with different type of single-token "
+              msg = 'Line ends with different type of single-token '
               msg << "indenter: #{token_event}"
               log msg
               @manager.add_indent_reason(token_event[1], token_event.last,
@@ -124,7 +124,7 @@ class Tailor
           return
         end
 
-        if token == "end"
+        if token == 'end'
           @manager.update_for_closing_reason(:on_kw, lexed_line)
           return
         end
@@ -166,7 +166,7 @@ class Tailor
           @manager.last_indent_reason_type != :on_lparen &&
           !@manager.last_indent_reason_type.nil?
           log "last indent reason type: #{@manager.last_indent_reason_type}"
-          log "I think this is a single-token closing line..."
+          log 'I think this is a single-token closing line...'
 
           @manager.update_for_closing_reason(@manager.indent_reasons.
             last[:event_type], current_lexed_line)
@@ -195,20 +195,22 @@ class Tailor
       def rbrace_update(current_lexed_line, lineno, column)
         # Is this an rbrace that should've been parsed as an embexpr_end?
         if in_embexpr? && RUBY_VERSION < '2.0.0'
-          msg = "Got :rbrace and @embexpr_beg is true. "
-          msg << " Must be at an @embexpr_end."
+          msg = 'Got :rbrace and @embexpr_beg is true. '
+          msg << ' Must be at an @embexpr_end.'
           log msg
           @embexpr_nesting.pop
-          @manager.update_for_closing_reason(:on_embexpr_end, current_lexed_line)
+          @manager.update_for_closing_reason(:on_embexpr_end,
+            current_lexed_line)
+
           return
         end
 
         if @manager.multi_line_braces?(lineno)
-          log "End of multi-line braces!"
+          log 'End of multi-line braces!'
 
           if current_lexed_line.only_rbrace?
             @manager.amount_to_change_this -= 1
-            msg = "lonely rbrace.  "
+            msg = 'lonely rbrace.  '
             msg << "change_this -= 1 -> #{@manager.amount_to_change_this}"
             log msg
           end
@@ -219,11 +221,11 @@ class Tailor
 
       def rbracket_update(current_lexed_line, lineno, column)
         if @manager.multi_line_brackets?(lineno)
-          log "End of multi-line brackets!"
+          log 'End of multi-line brackets!'
 
           if current_lexed_line.only_rbracket?
             @manager.amount_to_change_this -= 1
-            msg = "lonely rbracket.  "
+            msg = 'lonely rbracket.  '
             msg << "change_this -= 1 -> #{@manager.amount_to_change_this}"
             log msg
           end
@@ -234,11 +236,11 @@ class Tailor
 
       def rparen_update(current_lexed_line, lineno, column)
         if @manager.multi_line_parens?(lineno)
-          log "End of multi-line parens!"
+          log 'End of multi-line parens!'
 
           if current_lexed_line.only_rparen?
             @manager.amount_to_change_this -= 1
-            msg = "lonely rparen.  "
+            msg = 'lonely rparen.  '
             msg << "change_this -= 1 -> #{@manager.amount_to_change_this}"
             log msg
           end
@@ -275,7 +277,7 @@ class Tailor
       # @param [Fixnum] lineno The line the potential problem is on.
       # @param [Fixnum] column The column the potential problem is on.
       def measure(lineno, column)
-        log "Measuring..."
+        log 'Measuring...'
 
         if @manager.actual_indentation != @manager.should_be_at
           msg = "Line is indented to column #{@manager.actual_indentation}, "