reek 2.2.1 → 3.0.0

data/lib/reek/report/report.rb

@@ -0,0 +1,198 @@
+require 'rainbow'
+require 'json'
+require_relative 'formatter'
+require_relative 'heading_formatter'
+
+module Reek
+  module Report
+    #
+    # A report that contains the smells and smell counts following source code analysis.
+    #
+    # @abstract Subclass and override {#show} to create a concrete report class.
+    class Base
+      # @api private
+      NO_WARNINGS_COLOR = :green
+      # @api private
+      WARNINGS_COLOR = :red
+
+      def initialize(options = {})
+        @examiners           = []
+        @total_smell_count   = 0
+        @options             = options
+        @warning_formatter   = options.fetch :warning_formatter, SimpleWarningFormatter.new
+        @report_formatter    = options.fetch :report_formatter, Formatter
+        @sort_by_issue_count = options.fetch :sort_by_issue_count, false
+      end
+
+      # Add Examiner to report on. The report will output results for all
+      # added examiners.
+      #
+      # @param [Reek::Examiner] examiner object to report on
+      def add_examiner(examiner)
+        @total_smell_count += examiner.smells_count
+        @examiners << examiner
+        self
+      end
+
+      # Render the report results on STDOUT
+      def show
+        raise NotImplementedError
+      end
+
+      # @api private
+      def smells?
+        @total_smell_count > 0
+      end
+
+      # @api private
+      def smells
+        @examiners.map(&:smells).flatten
+      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 smell_summaries
+        @examiners.map { |ex| summarize_single_examiner(ex) }.reject(&:empty?)
+      end
+
+      def display_summary
+        smell_summaries.each { |smell| puts smell }
+      end
+
+      def display_total_smell_count
+        return unless @examiners.size > 1
+        print total_smell_count_message
+      end
+
+      def summarize_single_examiner(examiner)
+        result = heading_formatter.header(examiner)
+        if examiner.smelly?
+          formatted_list = @report_formatter.format_list(examiner.smells,
+                                                         @warning_formatter)
+          result += ":\n#{formatted_list}"
+        end
+        result
+      end
+
+      def sort_examiners
+        @examiners.sort_by!(&:smells_count).reverse! if @sort_by_issue_count
+      end
+
+      def total_smell_count_message
+        colour = smells? ? WARNINGS_COLOR : NO_WARNINGS_COLOR
+        s = @total_smell_count == 1 ? '' : 's'
+        Rainbow("#{@total_smell_count} total warning#{s}\n").color(colour)
+      end
+
+      def heading_formatter
+        @heading_formatter ||=
+          @options.fetch(:heading_formatter, HeadingFormatter::Quiet).new(@report_formatter)
+      end
+    end
+
+    #
+    # Displays a list of smells in YAML format
+    # YAML with empty array for 0 smells
+    class YAMLReport < Base
+      def show
+        print smells.map(&:yaml_hash).to_yaml
+      end
+    end
+
+    #
+    # Displays a list of smells in JSON format
+    # JSON with empty array for 0 smells
+    class JSONReport < Base
+      def show
+        print ::JSON.generate(
+          smells.map do |smell|
+            smell.yaml_hash(@warning_formatter)
+          end
+        )
+      end
+    end
+
+    #
+    # Saves the report as a HTML file
+    #
+    class HTMLReport < Base
+      require 'erb'
+
+      def show
+        path = File.expand_path('../../../../assets/html_output.html.erb',
+                                __FILE__)
+        File.open('reek.html', 'w+') do |file|
+          file.puts ERB.new(File.read(path)).result(binding)
+        end
+        print("Html file saved\n")
+      end
+    end
+
+    #
+    # Generates a list of smells in XML format
+    #
+    class XMLReport < Base
+      require 'rexml/document'
+
+      def show
+        checkstyle = REXML::Element.new('checkstyle', document)
+
+        smells.group_by(&:source).each do |file, file_smells|
+          file_to_xml(file, file_smells, checkstyle)
+        end
+
+        print_xml(checkstyle.parent)
+      end
+
+      private
+
+      def document
+        REXML::Document.new.tap do |doc|
+          doc << REXML::XMLDecl.new
+        end
+      end
+
+      def file_to_xml(file, file_smells, parent)
+        REXML::Element.new('file', parent).tap do |element|
+          element.attributes['name'] = File.realpath(file)
+          smells_to_xml(file_smells, element)
+        end
+      end
+
+      def smells_to_xml(smells, parent)
+        smells.each do |smell|
+          smell_to_xml(smell, parent)
+        end
+      end
+
+      def smell_to_xml(smell, parent)
+        REXML::Element.new('error', parent).tap do |element|
+          attributes = [
+            ['line', smell.lines.first],
+            ['column', 0],
+            ['severity', 'warning'],
+            ['message', smell.message],
+            ['source', smell.smell_type]
+          ]
+          element.add_attributes(attributes)
+        end
+      end
+
+      def print_xml(document)
+        formatter = REXML::Formatters::Default.new
+        puts formatter.write(document, '')
+      end
+    end
+  end
+end

data/lib/reek/smells.rb

@@ -1,13 +1,24 @@
-require 'pathname'
-
-(Pathname.new(__FILE__).dirname + 'smells').children.each do |path|
-  require_relative "smells/#{path.basename('.rb')}"
-end
-
-module Reek
-  #
-  # This module contains the various smell detectors.
-  #
-  module Smells
-  end
-end
+require_relative 'smells/attribute'
+require_relative 'smells/boolean_parameter'
+require_relative 'smells/class_variable'
+require_relative 'smells/control_parameter'
+require_relative 'smells/data_clump'
+require_relative 'smells/duplicate_method_call'
+require_relative 'smells/feature_envy'
+require_relative 'smells/irresponsible_module'
+require_relative 'smells/long_parameter_list'
+require_relative 'smells/long_yield_list'
+require_relative 'smells/module_initialize'
+require_relative 'smells/nested_iterators'
+require_relative 'smells/nil_check'
+require_relative 'smells/prima_donna_method'
+require_relative 'smells/repeated_conditional'
+require_relative 'smells/too_many_instance_variables'
+require_relative 'smells/too_many_methods'
+require_relative 'smells/too_many_statements'
+require_relative 'smells/uncommunicative_method_name'
+require_relative 'smells/uncommunicative_module_name'
+require_relative 'smells/uncommunicative_parameter_name'
+require_relative 'smells/uncommunicative_variable_name'
+require_relative 'smells/unused_parameters'
+require_relative 'smells/utility_function'

data/lib/reek/smells/attribute.rb

@@ -1,5 +1,6 @@
+require_relative 'smell_configuration'
 require_relative 'smell_detector'
-require_relative '../core/smell_configuration'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -12,9 +13,10 @@ module Reek
     # +attr_reader+, +attr_writer+ and +attr_accessor+ -- including those
     # that are private.
     #
-    # TODO: Catch attributes declared "by hand"
-    # See docs/Attribute for details.
+    # See {file:docs/Attribute.md} for details.
+    # @api private
     #
+    # TODO: Catch attributes declared "by hand"
     class Attribute < SmellDetector
       ATTR_DEFN_METHODS = [:attr, :attr_reader, :attr_writer, :attr_accessor]
       VISIBILITY_MODIFIERS = [:private, :public, :protected]
@@ -31,7 +33,7 @@ module Reek
       end
 
       def self.default_config
-        super.merge(Core::SmellConfiguration::ENABLED_KEY => false)
+        super.merge(SmellConfiguration::ENABLED_KEY => false)
       end
 
       #

data/lib/reek/smells/boolean_parameter.rb

@@ -1,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -10,7 +11,8 @@ module Reek
     # Currently Reek can only detect a Boolean parameter when it has a
     # default initializer.
     #
-    # See docs/Boolean-Parameter for details.
+    # See {file:docs/Boolean-Parameter.md} for details.
+    # @api private
     class BooleanParameter < SmellDetector
       def self.smell_category
         'ControlCouple'

data/lib/reek/smells/class_variable.rb

@@ -1,5 +1,6 @@
 require 'set'
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -11,7 +12,8 @@ module Reek
     # In particular, class variables can make it hard to set up tests (because
     # the context of the test includes all global state).
     #
-    # See docs/Class-Variable for details.
+    # See {file:docs/Class-Variable.md} for details.
+    # @api private
     class ClassVariable < SmellDetector
       def self.contexts # :nodoc:
         [:class, :module]

data/lib/reek/smells/control_parameter.rb

@@ -1,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -39,7 +40,8 @@ module Reek
     # that remains next to where the caller invokes it in
     # the source code.
     #
-    # See docs/Control-Parameter for details.
+    # See {file:docs/Control-Parameter.md} for details.
+    # @api private
     class ControlParameter < SmellDetector
       def self.smell_category
         'ControlCouple'

data/lib/reek/smells/data_clump.rb

@@ -1,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -14,7 +15,8 @@ module Reek
     # Currently Reek looks for a group of two or more parameters with
     # the same names that are expected by three or more methods of a class.
     #
-    # See docs/Data-Clump for details.
+    # See {file:docs/Data-Clump.md} for details.
+    # @api private
     class DataClump < SmellDetector
       #
       # The name of the config field that sets the maximum allowed

data/lib/reek/smells/duplicate_method_call.rb

@@ -1,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -15,7 +16,8 @@ module Reek
     #     @other.thing + @other.thing
     #   end
     #
-    # See docs/Duplicate-Method-Call for details.
+    # See {file:docs/Duplicate-Method-Call.md} for details.
+    # @api private
     class DuplicateMethodCall < SmellDetector
       # The name of the config field that sets the maximum number of
       # identical calls to be permitted within any single method.

data/lib/reek/smells/feature_envy.rb

@@ -1,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -32,7 +33,8 @@ module Reek
     # If the method doesn't reference self at all, +UtilityFunction+ is
     # reported instead.
     #
-    # See docs/Feature-Envy for details.
+    # See {file:docs/Feature-Envy.md} for details.
+    # @api private
     class FeatureEnvy < SmellDetector
       def self.smell_category
         'LowCohesion'

data/lib/reek/smells/irresponsible_module.rb

@@ -1,5 +1,5 @@
 require_relative 'smell_detector'
-require_relative '../core/code_comment'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -7,13 +7,14 @@ module Reek
     # It is considered good practice to annotate every class and module
     # with a brief comment outlining its responsibilities.
     #
-    # See docs/Irresponsible-Module for details.
+    # See {file:docs/Irresponsible-Module.md} for details.
+    # @api private
     class IrresponsibleModule < SmellDetector
       def self.contexts # :nodoc:
         [:class]
       end
 
-      def self.descriptive   # :nodoc:
+      def descriptive   # :nodoc:
         @descriptive ||= {}
       end
 
@@ -23,13 +24,17 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(ctx)
-        comment = Core::CodeComment.new(ctx.exp.comments)
-        return [] if self.class.descriptive[ctx.full_name] ||= comment.descriptive?
+        return [] if descriptive?(ctx)
+        expression = ctx.exp
         [SmellWarning.new(self,
                           context: ctx.full_name,
-                          lines: [ctx.exp.line],
+                          lines: [expression.line],
                           message: 'has no descriptive comment',
-                          parameters: {  name: ctx.exp.text_name })]
+                          parameters: {  name: expression.text_name })]
+      end
+
+      def descriptive?(ctx)
+        descriptive[ctx.full_name] ||= ctx.descriptively_commented?
       end
     end
   end

data/lib/reek/smells/long_parameter_list.rb

@@ -1,5 +1,6 @@
+require_relative 'smell_configuration'
 require_relative 'smell_detector'
-require_relative '../core/smell_configuration'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -11,7 +12,8 @@ module Reek
     # Currently +LongParameterList+ reports any method or block with too
     # many parameters.
     #
-    # See docs/Long-Parameter-List for details.
+    # See {file:docs/Long-Parameter-List.md} for details.
+    # @api private
     class LongParameterList < SmellDetector
       # The name of the config field that sets the maximum number of
       # parameters permitted in any method or block.
@@ -21,7 +23,7 @@ module Reek
       def self.default_config
         super.merge(
           MAX_ALLOWED_PARAMS_KEY => DEFAULT_MAX_ALLOWED_PARAMS,
-          Core::SmellConfiguration::OVERRIDES_KEY => {
+          SmellConfiguration::OVERRIDES_KEY => {
             'initialize' => { MAX_ALLOWED_PARAMS_KEY => 5 }
           }
         )

data/lib/reek/smells/long_yield_list.rb

@@ -1,4 +1,5 @@
 require_relative 'smell_detector'
+require_relative 'smell_warning'
 
 module Reek
   module Smells
@@ -6,7 +7,8 @@ module Reek
     # A variant on LongParameterList that checks the number of items
     # passed to a block by a +yield+ call.
     #
-    # See docs/Long-Yield-List for details.
+    # See {file:docs/Long-Yield-List.md} for details.
+    # @api private
     class LongYieldList < SmellDetector
       # The name of the config field that sets the maximum number of
       # parameters permitted in any method or block.