reek 1.3.8 → 1.4.0

data/features/support/env.rb

@@ -1,17 +1,15 @@
-$:.unshift 'lib'
-
 require 'rubygems'
 require 'tempfile'
 require 'fileutils'
+require 'open3'
 require 'reek/cli/application'
 
 class ReekWorld
   def run(cmd)
-    stderr_file = Tempfile.new('reek-world')
-    stderr_file.close
-    @last_stdout = `#{cmd} 2> #{stderr_file.path}`
-    @last_exit_status = $?.exitstatus
-    @last_stderr = IO.read(stderr_file.path)
+    out, err, status = Open3.capture3(cmd)
+    @last_stdout = out
+    @last_stderr = err
+    @last_exit_status = status.exitstatus
   end
 
   def reek(args)
@@ -31,9 +29,9 @@ EOS
     rakefile = Tempfile.new('rake_task', '.')
     rakefile.puts(header + task_def)
     rakefile.close
-    run("RUBYOPT=rubygems rake -f #{rakefile.path} #{name}")
+    run("rake -f #{rakefile.path} #{name}")
     lines = @last_stdout.split("\n")
-    if lines.length > 0 and lines[0] =~ /^\(/
+    if lines.length > 0 && lines[0] =~ /^\(/
       @last_stdout = lines[1..-1].join("\n")
     end
   end

data/lib/reek/cli/application.rb

@@ -1,15 +1,13 @@
-require 'reek/cli/command_line'
+require 'reek/cli/options'
 
 module Reek
   module Cli
-
     #
     # Represents an instance of a Reek application.
     # This is the entry point for all invocations of Reek from the
     # command line.
     #
     class Application
-
       STATUS_SUCCESS = 0
       STATUS_ERROR   = 1
       STATUS_SMELLS  = 2
@@ -27,7 +25,7 @@ module Reek
           $stderr.puts "Error: #{error}"
           @status = STATUS_ERROR
         end
-        return @status
+        @status
       end
 
       def output(text)

data/lib/reek/cli/command.rb

@@ -0,0 +1,12 @@
+module Reek
+  module Cli
+    #
+    # Base class for all commands
+    #
+    class Command
+      def initialize(parser)
+        @parser = parser
+      end
+    end
+  end
+end

data/lib/reek/cli/help_command.rb

@@ -1,16 +1,13 @@
+require 'reek/cli/command'
 
 module Reek
   module Cli
-
     #
     # A command to display usage information for this application.
     #
-    class HelpCommand
-      def initialize(parser)
-        @parser = parser
-      end
+    class HelpCommand < Command
       def execute(view)
-        view.output(@parser.to_s)
+        view.output(@parser.help_text)
         view.report_success
       end
     end

data/lib/reek/cli/options.rb

@@ -0,0 +1,147 @@
+require 'optparse'
+require 'rainbow'
+require 'reek/cli/report/report'
+require 'reek/cli/report/formatter'
+require 'reek/cli/report/strategy'
+require 'reek/cli/reek_command'
+require 'reek/cli/help_command'
+require 'reek/cli/version_command'
+require 'reek/source'
+
+module Reek
+  module Cli
+    #
+    # Parses the command line
+    #
+    class Options
+      def initialize(argv)
+        @argv = argv
+        @parser = OptionParser.new
+        @colored = true
+        @report_class = Report::TextReport
+        @strategy = Report::Strategy::Quiet
+        @warning_formatter = Report::WarningFormatterWithLineNumbers
+        @command_class = ReekCommand
+        @config_files = []
+        @sort_by_issue_count = false
+        @smells_to_detect = []
+        set_options
+      end
+
+      def banner
+        progname = @parser.program_name
+        # SMELL:
+        # The following banner isn't really correct. Help, Version and Reek
+        # are really sub-commands (in the git/svn sense) and so the usage
+        # banner should show three different command-lines. The other
+        # options are all flags for the Reek sub-command.
+        #
+        # reek -h|--help           Display a help message
+        #
+        # reek -v|--version        Output the tool's version number
+        #
+        # reek [options] files     List the smells in the given files
+        #      -c|--config file    Specify file(s) with config options
+        #      -n|--line-number    Prefix smelly lines with line numbers
+        #      -q|-[no-]quiet      Only list files that have smells
+        #      files               Names of files or dirs to be checked
+        #
+        <<EOB
+Usage: #{progname} [options] [files]
+
+Examples:
+
+#{progname} lib/*.rb
+#{progname} -q lib
+cat my_class.rb | #{progname}
+
+See http://wiki.github.com/troessner/reek for detailed help.
+
+EOB
+      end
+
+      def set_options
+        @parser.banner = banner
+        @parser.separator 'Common options:'
+        @parser.on('-h', '--help', 'Show this message') do
+          @command_class = HelpCommand
+        end
+        @parser.on('-v', '--version', 'Show version') do
+          @command_class = VersionCommand
+        end
+
+        @parser.separator "\nConfiguration:"
+        @parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
+          @config_files << file
+        end
+        @parser.on('--smell SMELL', 'Detect smell SMELL (default is all enabled smells)') do |smell|
+          @smells_to_detect << smell
+        end
+
+        @parser.separator "\nReport formatting:"
+        @parser.on('-o', '--[no-]color', 'Use colors for the output (this is the default)') do |opt|
+          @colored = opt
+        end
+        @parser.on('-q', '--quiet', 'Suppress headings for smell-free source files (this is the default)') do |_opt|
+          @strategy = Report::Strategy::Quiet
+        end
+        @parser.on('-V', '--no-quiet', '--verbose', 'Show headings for smell-free source files') do |_opt|
+          @strategy = Report::Strategy::Verbose
+        end
+        @parser.on('-U', '--ultra-verbose', 'Be as explanatory as possible') do |_opt|
+          @warning_formatter = Report::UltraVerboseWarningFormattter
+        end
+        @parser.on('-n', '--no-line-numbers', 'Suppress line numbers from the output') do
+          @warning_formatter = Report::SimpleWarningFormatter
+        end
+        @parser.on('--line-numbers', 'Show line numbers in the output (this is the default)') do
+          @warning_formatter = Report::WarningFormatterWithLineNumbers
+        end
+        @parser.on('-s', '--single-line', 'Show IDE-compatible single-line-per-warning') do
+          @warning_formatter = Report::SingleLineWarningFormatter
+        end
+        @parser.on('-S', '--sort-by-issue-count', 'Sort by "issue-count", listing the "smelliest" files first') do
+          @sort_by_issue_count = true
+        end
+        @parser.on('-y', '--yaml', 'Report smells in YAML format') do
+          @report_class = Report::YamlReport
+        end
+        @parser.on('-H', '--html', 'Report smells in HTML format') do
+          @report_class = Report::HtmlReport
+        end
+      end
+
+      def parse
+        @parser.parse!(@argv)
+        Rainbow.enabled = @colored
+        @command_class.new(self)
+      end
+
+      attr_reader :config_files
+      attr_reader :smells_to_detect
+
+      def reporter
+        @reporter ||= @report_class.new(warning_formatter: @warning_formatter,
+                                        report_formatter: Report::Formatter,
+                                        sort_by_issue_count: @sort_by_issue_count,
+                                        strategy: @strategy)
+      end
+
+      def sources
+        if @argv.empty?
+          return [$stdin.to_reek_source('$stdin')]
+        else
+          return Source::SourceLocator.new(@argv).all_sources
+        end
+      end
+
+      def program_name
+        @parser.program_name
+      end
+
+      def help_text
+        @parser.to_s
+      end
+    end
+  end
+end

data/lib/reek/cli/reek_command.rb

@@ -1,29 +1,33 @@
+require 'reek/cli/command'
 require 'reek/examiner'
 
 module Reek
   module Cli
-
     #
     # A command to collect smells from a set of sources and write them out in
     # text report format.
     #
-    class ReekCommand
-      def self.create(sources, reporter, config_files = [])
-        new(reporter, sources, config_files)
+    class ReekCommand < Command
+      def execute(app)
+        @parser.sources.each do |source|
+          reporter.add_examiner(Examiner.new(source, config_files, smell_names))
+        end
+        reporter.smells? ? app.report_smells : app.report_success
+        reporter.show
+      end
+
+      private
+
+      def reporter
+        @reporter ||= @parser.reporter
       end
 
-      def initialize(reporter, sources, config_files = [])
-        @sources = sources
-        @reporter = reporter
-        @config_files = config_files
+      def smell_names
+        @smell_names ||= @parser.smells_to_detect
       end
 
-      def execute(app)
-        @sources.each do |source|
-          @reporter.add_examiner(Examiner.new(source, @config_files))
-        end
-        @reporter.has_smells? ? app.report_smells : app.report_success
-        @reporter.show
+      def config_files
+        @config_files ||= @parser.config_files
       end
     end
   end

data/lib/reek/cli/report/formatter.rb

@@ -0,0 +1,56 @@
+module Reek
+  module Cli
+    module Report
+      module Formatter
+        def self.format_list(warnings, formatter = SimpleWarningFormatter)
+          warnings.map do |warning|
+            "  #{formatter.format warning}"
+          end.join("\n")
+        end
+
+        def self.header(examiner)
+          count = examiner.smells_count
+          result = Rainbow("#{examiner.description} -- ").cyan + Rainbow("#{count} warning").yellow
+          result += Rainbow('s').yellow unless count == 1
+          result
+        end
+      end
+
+      module UltraVerboseWarningFormattter
+        BASE_URL_FOR_HELP_LINK = 'https://github.com/troessner/reek/wiki/'
+
+        module_function
+
+        def format(warning)
+          "#{WarningFormatterWithLineNumbers.format(warning)} [#{explanatory_link(warning)}]"
+        end
+
+        def explanatory_link(warning)
+          "#{BASE_URL_FOR_HELP_LINK}#{class_name_to_param(warning.subclass)}"
+        end
+
+        def class_name_to_param(name)
+          name.split(/(?=[A-Z])/).join('-')
+        end
+      end
+
+      module SimpleWarningFormatter
+        def self.format(warning)
+          "#{warning.context} #{warning.message} (#{warning.subclass})"
+        end
+      end
+
+      module WarningFormatterWithLineNumbers
+        def self.format(warning)
+          "#{warning.lines.inspect}:#{SimpleWarningFormatter.format(warning)}"
+        end
+      end
+
+      module SingleLineWarningFormatter
+        def self.format(warning)
+          "#{warning.source}:#{warning.lines.first}: #{SimpleWarningFormatter.format(warning)}"
+        end
+      end
+    end
+  end
+end

data/lib/reek/cli/report/report.rb

@@ -0,0 +1,106 @@
+require 'rainbow'
+
+module Reek
+  module Cli
+    module Report
+      #
+      # A report that contains the smells and smell counts following source code analysis.
+      #
+      class Base
+        DEFAULT_FORMAT = :text
+        NO_WARNINGS_COLOR = :green
+        WARNINGS_COLOR = :red
+
+        def initialize(options = {})
+          @warning_formatter   = options.fetch :warning_formatter, SimpleWarningFormatter
+          @report_formatter    = options.fetch :report_formatter, Formatter
+          @examiners           = []
+          @total_smell_count   = 0
+          @sort_by_issue_count = options.fetch :sort_by_issue_count, false
+          @strategy = options.fetch(:strategy, Strategy::Quiet)
+        end
+
+        def add_examiner(examiner)
+          @total_smell_count += examiner.smells_count
+          @examiners << examiner
+          self
+        end
+
+        def smells?
+          @total_smell_count > 0
+        end
+
+        def smells
+          @strategy.new(@report_formatter, @warning_formatter, @examiners).gather_results
+        end
+      end
+
+      #
+      # Generates a sorted, text summary of smells in examiners
+      #
+      class TextReport < Base
+        def show
+          sort_examiners if smells?
+          display_summary
+          display_total_smell_count
+        end
+
+        private
+
+        def display_summary
+          print smells.reject(&:empty?).join("\n")
+        end
+
+        def display_total_smell_count
+          return unless @examiners.size > 1
+          print "\n"
+          print total_smell_count_message
+        end
+
+        def sort_examiners
+          @examiners.sort! { |first, second| second.smells_count <=> first.smells_count } if @sort_by_issue_count
+        end
+
+        def total_smell_count_message
+          colour = smells? ? WARNINGS_COLOR : NO_WARNINGS_COLOR
+          Rainbow("#{@total_smell_count} total warning#{'s' unless @total_smell_count == 1 }\n").color(colour)
+        end
+      end
+
+      #
+      # Displays a list of smells in YAML format
+      # YAML with empty array for 0 smells
+      class YamlReport < Base
+        def initialize(options = {})
+          @options = options
+          super options.merge!(strategy: Strategy::Normal)
+        end
+
+        def show
+          print(smells.to_yaml)
+        end
+      end
+
+      #
+      # Saves the report as a HTML file
+      #
+      class HtmlReport < Base
+        def initialize(options = {})
+          @options = options
+          super @options.merge!(strategy: Strategy::Normal)
+        end
+
+        require 'erb'
+
+        TEMPLATE = File.read(File.expand_path('../../../../../assets/html_output.html.erb', __FILE__))
+
+        def show
+          File.open('reek.html', 'w+') do |file|
+            file.puts ERB.new(TEMPLATE).result(binding)
+          end
+          print("Html file saved\n")
+        end
+      end
+    end
+  end
+end