reek 4.4.2 → 4.5.0

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Reek
+  module Report
+    module Formatter
+      #
+      # 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
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+require_relative 'simple_warning_formatter'
+
+module Reek
+  module Report
+    module Formatter
+      #
+      # 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
+end

data/lib/reek/report/html_report.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require_relative 'base_report'
+
+module Reek
+  module Report
+    #
+    # Saves the report as a HTML file
+    #
+    # @public
+    #
+    class HTMLReport < BaseReport
+      require 'erb'
+
+      # @public
+      def show
+        template_path = Pathname.new("#{__dir__}/html_report/html_report.html.erb")
+        puts ERB.new(template_path.read).result(binding)
+      end
+    end
+  end
+end

data/lib/reek/report/json_report.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require_relative 'base_report'
+
+module Reek
+  module Report
+    #
+    # Displays a list of smells in JSON format
+    # JSON with empty array for 0 smells
+    #
+    # @public
+    #
+    class JSONReport < BaseReport
+      def show(out = $stdout)
+        out.print ::JSON.generate smells.map { |smell| warning_formatter.format_hash(smell) }
+      end
+    end
+  end
+end

data/lib/reek/report/text_report.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require_relative 'base_report'
+
+module Reek
+  module Report
+    #
+    # Generates a sorted, text summary of smells in examiners
+    #
+    # @public
+    #
+    class TextReport < BaseReport
+      # @public
+      def initialize(*args)
+        super(*args)
+
+        print progress_formatter.header
+      end
+
+      # @public
+      def add_examiner(examiner)
+        print progress_formatter.progress examiner
+        super(examiner)
+      end
+
+      # @public
+      def show
+        sort_examiners if smells?
+        print progress_formatter.footer
+        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,
+                                                        formatter: 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
+        Rainbow("#{total_smell_count} total warning#{total_smell_count == 1 ? '' : 's'}\n").color(colour)
+      end
+    end
+  end
+end

data/lib/reek/report/xml_report.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+require_relative 'base_report'
+
+module Reek
+  module Report
+    #
+    # Generates a list of smells in XML format
+    #
+    # @public
+    #
+    class XMLReport < BaseReport
+      require 'rexml/document'
+
+      # @public
+      def show
+        document.write output: $stdout, indent: 2
+        $stdout.puts
+      end
+
+      private
+
+      def document
+        REXML::Document.new.tap do |document|
+          document << REXML::XMLDecl.new << checkstyle
+        end
+      end
+
+      def checkstyle
+        REXML::Element.new('checkstyle').tap do |checkstyle|
+          smells.group_by(&:source).each do |source, source_smells|
+            checkstyle << file(source, source_smells)
+          end
+        end
+      end
+
+      # :reek:FeatureEnvy
+      # :reek:NestedIterators: { max_allowed_nesting: 2 }
+      def file(name, smells)
+        REXML::Element.new('file').tap do |file|
+          file.add_attribute 'name', File.realpath(name)
+          smells.each do |smell|
+            smell.lines.each do |line|
+              file << error(smell, line)
+            end
+          end
+        end
+      end
+
+      # :reek:UtilityFunction
+      def error(smell, line)
+        REXML::Element.new('error').tap do |error|
+          error.add_attributes 'column' => 0,
+                               'line' => line,
+                               'message' => smell.message,
+                               'severity' => 'warning',
+                               'source' => smell.smell_type
+        end
+      end
+    end
+  end
+end

data/lib/reek/report/yaml_report.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require_relative 'base_report'
+
+module Reek
+  module Report
+    #
+    # Displays a list of smells in YAML format
+    # YAML with empty array for 0 smells
+    #
+    # @public
+    #
+    class YAMLReport < BaseReport
+      def show(out = $stdout)
+        out.print smells.map { |smell| warning_formatter.format_hash(smell) }.to_yaml
+      end
+    end
+  end
+end

data/lib/reek/smell_detectors.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require_relative 'smell_detectors/attribute'
+require_relative 'smell_detectors/boolean_parameter'
+require_relative 'smell_detectors/class_variable'
+require_relative 'smell_detectors/control_parameter'
+require_relative 'smell_detectors/data_clump'
+require_relative 'smell_detectors/duplicate_method_call'
+require_relative 'smell_detectors/feature_envy'
+require_relative 'smell_detectors/irresponsible_module'
+require_relative 'smell_detectors/instance_variable_assumption'
+require_relative 'smell_detectors/long_parameter_list'
+require_relative 'smell_detectors/long_yield_list'
+require_relative 'smell_detectors/manual_dispatch'
+require_relative 'smell_detectors/module_initialize'
+require_relative 'smell_detectors/nested_iterators'
+require_relative 'smell_detectors/nil_check'
+require_relative 'smell_detectors/prima_donna_method'
+require_relative 'smell_detectors/repeated_conditional'
+require_relative 'smell_detectors/subclassed_from_core_class'
+require_relative 'smell_detectors/too_many_instance_variables'
+require_relative 'smell_detectors/too_many_constants'
+require_relative 'smell_detectors/too_many_methods'
+require_relative 'smell_detectors/too_many_statements'
+require_relative 'smell_detectors/uncommunicative_method_name'
+require_relative 'smell_detectors/uncommunicative_module_name'
+require_relative 'smell_detectors/uncommunicative_parameter_name'
+require_relative 'smell_detectors/uncommunicative_variable_name'
+require_relative 'smell_detectors/unused_parameters'
+require_relative 'smell_detectors/unused_private_method'
+require_relative 'smell_detectors/utility_function'

data/lib/reek/{smells → smell_detectors}/attribute.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 require_relative 'smell_configuration'
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A class that publishes a getter or setter for an instance variable
     # invites client classes to become too intimate with its inner workings,
@@ -16,7 +16,7 @@ module Reek
     # See {file:docs/Attribute.md} for details.
     #
     # TODO: Catch attributes declared "by hand"
-    class Attribute < SmellDetector
+    class Attribute < BaseDetector
       def initialize(*args)
         super
       end

data/lib/reek/{smells/smell_detector.rb → smell_detectors/base_detector.rb}

@@ -3,7 +3,7 @@ require 'set'
 require_relative 'smell_configuration'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Shared responsibilities of all smell detectors.
     #
@@ -14,7 +14,7 @@ module Reek
     # for details.
     #
     # :reek:UnusedPrivateMethod: { exclude: [ smell_warning ] }
-    class SmellDetector
+    class BaseDetector
       attr_reader :config
       # The name of the config field that lists the names of code contexts
       # that should not be checked. Add this field to the config for each
@@ -102,7 +102,7 @@ module Reek
         end
 
         #
-        # Returns all descendants of SmellDetector
+        # Returns all descendants of BaseDetector
         #
         # @return [Array<Constant>], e.g.:
         #   [Reek::Smells::Attribute,

data/lib/reek/{smells → smell_detectors}/boolean_parameter.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A Boolean parameter effectively permits a method's caller
     # to decide which execution path to take. The
@@ -13,7 +13,7 @@ module Reek
     # default initializer.
     #
     # See {file:docs/Boolean-Parameter.md} for details.
-    class BooleanParameter < SmellDetector
+    class BooleanParameter < BaseDetector
       #
       # Checks whether the given method has any Boolean parameters.
       #

data/lib/reek/{smells → smell_detectors}/class_variable.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 require 'set'
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Class variables form part of the global runtime state, and as such make
     # it easy for one part of the system to accidentally or inadvertently
@@ -14,7 +14,7 @@ module Reek
     # the context of the test includes all global state).
     #
     # See {file:docs/Class-Variable.md} for details.
-    class ClassVariable < SmellDetector
+    class ClassVariable < BaseDetector
       def self.contexts # :nodoc:
         [:class, :module]
       end

data/lib/reek/{smells → smell_detectors}/control_parameter.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Control Coupling occurs when a method or block checks the value of
     # a parameter in order to decide which execution path to take. The
@@ -42,7 +42,7 @@ module Reek
     # the source code.
     #
     # See {file:docs/Control-Parameter.md} for details.
-    class ControlParameter < SmellDetector
+    class ControlParameter < BaseDetector
       #
       # Checks whether the given method chooses its execution path
       # by testing the value of one of its parameters.

data/lib/reek/{smells → smell_detectors}/data_clump.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A Data Clump occurs when the same two or three items frequently
     # appear together in classes and parameter lists, or when a group
@@ -17,7 +17,7 @@ module Reek
     # the same names that are expected by three or more methods of a class.
     #
     # See {file:docs/Data-Clump.md} for details.
-    class DataClump < SmellDetector
+    class DataClump < BaseDetector
       #
       # The name of the config field that sets the maximum allowed
       # copies of any clump. No group of common parameters will be

data/lib/reek/{smells/smell_repository.rb → smell_detectors/detector_repository.rb}

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
-require_relative '../smells'
-require_relative 'smell_detector'
+require_relative '../smell_detectors'
+require_relative 'base_detector'
 require_relative '../configuration/app_configuration'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
-    # Contains all the existing smells and exposes operations on them.
+    # Contains all the existing smell detectors and exposes operations on them.
     #
-    class SmellRepository
-      # @return [Array<Reek::Smells::SmellDetector>] All known SmellDetectors
+    class DetectorRepository
+      # @return [Array<Reek::SmellDetectors::BaseDetector>] All known SmellDetectors
       #         e.g. [Reek::Smells::BooleanParameter, Reek::Smells::ClassVariable].
       def self.smell_types
-        Reek::Smells::SmellDetector.descendants.sort_by(&:name)
+        Reek::SmellDetectors::BaseDetector.descendants.sort_by(&:name)
       end
 
       # @param filter_by_smells [Array<String>]
       #   List of smell types to filter by, e.g. "DuplicateMethodCall".
-      #   More precisely it should be whatever is returned by `SmellDetector`.smell_type.
+      #   More precisely it should be whatever is returned by `BaseDetector`.smell_type.
       #   This means that you can write the "DuplicateMethodCall" from above also like this:
       #     Reek::Smells::DuplicateMethodCall.smell_type
       #   if you want to make sure you do not fat-finger strings.
       #
-      # @return [Array<Reek::Smells::SmellDetector>] All SmellDetectors that we want to filter for
+      # @return [Array<Reek::SmellDetectors::BaseDetector>] All SmellDetectors that we want to filter for
       #         e.g. [Reek::Smells::Attribute].
       def self.eligible_smell_types(filter_by_smells = [])
         return smell_types if filter_by_smells.empty?