reek 4.4.2 → 4.5.0

data/lib/reek/report.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
-require_relative 'report/report'
+require_relative 'report/code_climate'
+require_relative 'report/html_report'
+require_relative 'report/json_report'
+require_relative 'report/text_report'
+require_relative 'report/xml_report'
+require_relative 'report/yaml_report'
 require_relative 'report/formatter'
-require_relative 'report/heading_formatter'
 
 module Reek
   # Reek reporting functionality.
@@ -16,19 +20,24 @@ module Reek
     }.freeze
 
     LOCATION_FORMATTERS = {
-      single_line: SingleLineLocationFormatter,
-      plain: BlankLocationFormatter,
-      numbers: DefaultLocationFormatter
+      single_line: Formatter::SingleLineLocationFormatter,
+      plain: Formatter::BlankLocationFormatter,
+      numbers: Formatter::DefaultLocationFormatter
     }.freeze
 
     HEADING_FORMATTERS = {
-      verbose: HeadingFormatter::Verbose,
-      quiet: HeadingFormatter::Quiet
+      verbose: Formatter::VerboseHeadingFormatter,
+      quiet: Formatter::QuietHeadingFormatter
+    }.freeze
+
+    PROGRESS_FORMATTERS = {
+      dots: Formatter::ProgressFormatter::Dots,
+      quiet: Formatter::ProgressFormatter::Quiet
     }.freeze
 
     WARNING_FORMATTER_CLASSES = {
-      wiki_links: WikiLinkWarningFormatter,
-      simple: SimpleWarningFormatter
+      wiki_links: Formatter::WikiLinkWarningFormatter,
+      simple: Formatter::SimpleWarningFormatter
     }.freeze
 
     # Map report format symbol to a report class.
@@ -61,6 +70,16 @@ module Reek
       HEADING_FORMATTERS.fetch(heading_format)
     end
 
+    # Map progress format symbol to a report class.
+    #
+    # @param [Symbol] progress_format The format to map
+    #
+    # @return The mapped progress class
+    #
+    def self.progress_formatter(progress_format)
+      PROGRESS_FORMATTERS.fetch(progress_format)
+    end
+
     # Map warning format symbol to a report class.
     #
     # @param [Symbol] warning_format The format to map

data/lib/reek/report/base_report.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+require 'json'
+require 'pathname'
+require 'rainbow'
+
+require_relative 'formatter'
+
+module Reek
+  # @public
+  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.
+    #
+    # @public
+    #
+    # :reek:TooManyInstanceVariables: { max_instance_variables: 7 }
+    class BaseReport
+      NO_WARNINGS_COLOR = :green
+      WARNINGS_COLOR = :red
+
+      # @public
+      #
+      # :reek:BooleanParameter
+      def initialize(heading_formatter: Formatter::QuietHeadingFormatter,
+                     report_formatter: Formatter,
+                     sort_by_issue_count: false,
+                     warning_formatter: Formatter::SimpleWarningFormatter.new,
+                     progress_formatter: Formatter::ProgressFormatter::Quiet.new(0))
+        @examiners           = []
+        @heading_formatter   = heading_formatter.new(report_formatter)
+        @report_formatter    = report_formatter
+        @progress_formatter  = progress_formatter
+        @sort_by_issue_count = sort_by_issue_count
+        @total_smell_count   = 0
+        @warning_formatter   = warning_formatter
+      end
+
+      # Add Examiner to report on. The report will output results for all
+      # added examiners.
+      #
+      # @param [Reek::Examiner] examiner object to report on
+      #
+      # @public
+      def add_examiner(examiner)
+        self.total_smell_count += examiner.smells_count
+        examiners << examiner
+        self
+      end
+
+      # Render the report results on STDOUT
+      #
+      # @public
+      def show
+        raise NotImplementedError
+      end
+
+      def smells?
+        total_smell_count > 0
+      end
+
+      def smells
+        examiners.map(&:smells).flatten
+      end
+
+      protected
+
+      attr_accessor :total_smell_count
+
+      private
+
+      attr_reader :examiners, :heading_formatter, :report_formatter,
+                  :sort_by_issue_count, :warning_formatter, :progress_formatter
+    end
+  end
+end

data/lib/reek/report/code_climate.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require_relative 'code_climate/code_climate_fingerprint'
+require_relative 'code_climate/code_climate_formatter'
+require_relative 'code_climate/code_climate_report'

data/lib/reek/report/code_climate/code_climate_fingerprint.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+module Reek
+  module Report
+    # Generates a string to uniquely identify a smell
+    class CodeClimateFingerprint
+      NON_IDENTIFYING_PARAMETERS = [:count, :depth].freeze
+
+      def initialize(warning)
+        @warning = warning
+      end
+
+      def compute
+        return unless warning_uniquely_identifiable?
+
+        identify_warning
+
+        identifying_aspects.hexdigest
+      end
+
+      private
+
+      attr_reader :warning
+
+      def identify_warning
+        identifying_aspects << warning.source
+        identifying_aspects << warning.smell_type
+        identifying_aspects << warning.context
+        identifying_aspects << parameters
+      end
+
+      def identifying_aspects
+        @identifying_aspects ||= Digest::MD5.new
+      end
+
+      def parameters
+        warning.parameters.except(*NON_IDENTIFYING_PARAMETERS).sort.to_s
+      end
+
+      def warning_uniquely_identifiable?
+        # These could be identifiable if they had parameters
+        ![
+          'ManualDispatch',
+          'NilCheck'
+        ].include?(warning.smell_type)
+      end
+    end
+  end
+end

data/lib/reek/report/code_climate/code_climate_formatter.rb

@@ -15,6 +15,7 @@ module Reek
                             categories: categories,
                             location: location,
                             remediation_points: remediation_points,
+                            fingerprint: fingerprint,
                             content: content).render
       end
 
@@ -45,6 +46,10 @@ module Reek
         configuration[warning.smell_type].fetch('remediation_points')
       end
 
+      def fingerprint
+        CodeClimateFingerprint.new(warning).compute
+      end
+
       def content
         configuration[warning.smell_type].fetch('content')
       end

data/lib/reek/report/code_climate/code_climate_report.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require_relative '../base_report'
+
+module Reek
+  module Report
+    #
+    # Displays a list of smells in Code Climate engine format
+    # (https://github.com/codeclimate/spec/blob/master/SPEC.md)
+    # JSON with empty array for 0 smells
+    #
+    class CodeClimateReport < BaseReport
+      def show(out = $stdout)
+        smells.map do |smell|
+          out.print warning_formatter.format_code_climate_hash(smell)
+        end
+      end
+    end
+  end
+end

data/lib/reek/report/formatter.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
-require_relative 'location_formatter'
 require_relative 'code_climate/code_climate_formatter'
+require_relative 'formatter/heading_formatter'
+require_relative 'formatter/location_formatter'
+require_relative 'formatter/progress_formatter'
+require_relative 'formatter/simple_warning_formatter'
+require_relative 'formatter/wiki_link_warning_formatter'
 
 module Reek
   module Report
@@ -24,60 +28,5 @@ module Reek
         result
       end
     end
-
-    #
-    # Basic formatter that just shows a simple message for each warning,
-    # prepended with the result of the passed-in location formatter.
-    #
-    class SimpleWarningFormatter
-      def initialize(location_formatter: BlankLocationFormatter)
-        @location_formatter = location_formatter
-      end
-
-      def format(warning)
-        "#{location_formatter.format(warning)}#{warning.base_message}"
-      end
-
-      # :reek:UtilityFunction
-      def format_hash(warning)
-        warning.yaml_hash
-      end
-
-      # :reek:UtilityFunction
-      def format_code_climate_hash(warning)
-        CodeClimateFormatter.new(warning).render
-      end
-
-      private
-
-      attr_reader :location_formatter
-    end
-
-    #
-    # Formatter that adds a link to the wiki to the basic message from
-    # SimpleWarningFormatter.
-    #
-    class WikiLinkWarningFormatter < SimpleWarningFormatter
-      BASE_URL_FOR_HELP_LINK = 'https://github.com/troessner/reek/blob/master/docs/'.freeze
-
-      def format(warning)
-        "#{super} [#{explanatory_link(warning)}]"
-      end
-
-      def format_hash(warning)
-        super.merge('wiki_link' => explanatory_link(warning))
-      end
-
-      private
-
-      def explanatory_link(warning)
-        "#{BASE_URL_FOR_HELP_LINK}#{class_name_to_param(warning.smell_type)}.md"
-      end
-
-      # :reek:UtilityFunction
-      def class_name_to_param(name)
-        name.split(/(?=[A-Z])/).join('-')
-      end
-    end
   end
 end

data/lib/reek/report/{heading_formatter.rb → formatter/heading_formatter.rb}

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 module Reek
   module Report
-    module HeadingFormatter
+    module Formatter
       #
       # Base class for heading formatters.
       # Is responsible for formatting the heading emitted for each examiner
       #
       # @abstract Override {#show_header?} to implement a heading formatter.
-      class Base
+      class HeadingFormatterBase
         attr_reader :report_formatter
 
         def initialize(report_formatter)
@@ -31,7 +31,7 @@ module Reek
       #
       # Lists out each examiner, even if it has no smell
       #
-      class Verbose < Base
+      class VerboseHeadingFormatter < HeadingFormatterBase
         def show_header?(_examiner)
           true
         end
@@ -40,7 +40,7 @@ module Reek
       #
       # Lists only smelly examiners
       #
-      class Quiet < Base
+      class QuietHeadingFormatter < HeadingFormatterBase
         # :reek:UtilityFunction
         def show_header?(examiner)
           examiner.smelly?

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module Reek
+  module Report
+    module Formatter
+      #
+      # Formats the location of a warning as an empty string.
+      #
+      module BlankLocationFormatter
+        module_function
+
+        def format(_warning)
+          ''
+        end
+      end
+
+      #
+      # Formats the location of a warning as an array of line numbers.
+      #
+      module DefaultLocationFormatter
+        module_function
+
+        def format(warning)
+          "#{warning.lines.sort.inspect}:"
+        end
+      end
+
+      #
+      # Formats the location of a warning as a combination of source file name
+      # and line number. In this format, it is not possible to show more than
+      # one line number, so the first number is displayed.
+      #
+      module SingleLineLocationFormatter
+        module_function
+
+        def format(warning)
+          "#{warning.source}:#{warning.lines.sort.first}: "
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+module Reek
+  module Report
+    module Formatter
+      module ProgressFormatter
+        #
+        # Base class for progress formatters.
+        # Is responsible for formatting the progress emitted for each examiner
+        #
+        # @abstract Override {#header, #progress, #footer} to implement a progress formatter.
+        class Base
+          attr_reader :sources_count
+
+          def initialize(sources_count)
+            @sources_count = sources_count
+          end
+
+          def header
+            raise NotImplementedError
+          end
+
+          def progress(_examiner)
+            raise NotImplementedError
+          end
+
+          def footer
+            raise NotImplementedError
+          end
+        end
+
+        #
+        # Shows the status of each source as either a dot (.) or an S
+        #
+        class Dots < Base
+          NO_WARNINGS_COLOR = :green
+          WARNINGS_COLOR = :red
+
+          def header
+            "Inspecting #{sources_count} file(s):\n"
+          end
+
+          def progress(examiner)
+            examiner.smelly? ? display_smelly : display_clean
+          end
+
+          def footer
+            "\n\n"
+          end
+
+          private
+
+          def display_clean
+            Rainbow('.').color(NO_WARNINGS_COLOR)
+          end
+
+          def display_smelly
+            Rainbow('S').color(WARNINGS_COLOR)
+          end
+        end
+
+        #
+        # Does not show progress
+        #
+        class Quiet < Base
+          def header
+            ''
+          end
+
+          def progress(_examiner)
+            ''
+          end
+
+          def footer
+            ''
+          end
+        end
+      end
+    end
+  end
+end