reek 3.3.1 → 3.4.0

data/lib/reek/context/method_context.rb

@@ -5,15 +5,9 @@ module Reek
     #
     # A context wrapper for any method definition found in a syntax tree.
     #
-    # @api private
     class MethodContext < CodeContext
       attr_reader :refs
 
-      def envious_receivers
-        return {} if refs.self_is_max?
-        refs.most_popular
-      end
-
       def references_self?
         exp.depends_on_instance?
       end
@@ -22,6 +16,7 @@ module Reek
         local_nodes(:lvar).find { |node| node.var_name == param.to_sym }
       end
 
+      # :reek:FeatureEnvy
       def unused_params
         exp.arguments.select do |param|
           next if param.anonymous_splat?

data/lib/reek/context/module_context.rb

@@ -6,7 +6,6 @@ module Reek
     #
     # A context wrapper for any module found in a syntax tree.
     #
-    # @api private
     class ModuleContext < CodeContext
       def node_instance_methods
         local_nodes(:def)

data/lib/reek/context/root_context.rb

@@ -5,7 +5,6 @@ module Reek
     #
     # A context wrapper representing the root of an abstract syntax tree.
     #
-    # @api private
     class RootContext < CodeContext
       def initialize(exp)
         super(nil, exp)

data/lib/reek/context/singleton_method_context.rb

@@ -5,7 +5,6 @@ module Reek
     #
     # A context wrapper for any singleton method definition found in a syntax tree.
     #
-    # @api private
     class SingletonMethodContext < MethodContext
       def envious_receivers
         {}

data/lib/reek/examiner.rb

@@ -13,6 +13,9 @@ module Reek
   #
   # Applies all available smell detectors to a source.
   #
+  # @public
+  #
+  # :reek:TooManyInstanceVariables: { max_instance_variables: 6 }
   class Examiner
     #
     # Creates an Examiner which scans the given +source+ for code smells.
@@ -26,27 +29,32 @@ module Reek
     #
     # @param configuration [Configuration::AppConfiguration]
     #   The configuration for this Examiner.
+    #
+    # @public
     def initialize(source,
                    filter_by_smells = [],
                    configuration: Configuration::AppConfiguration.default)
       @source        = Source::SourceCode.from(source)
       @configuration = configuration
       @collector     = CLI::WarningCollector.new
-      @smell_types   = eligible_smell_types(filter_by_smells)
+      @smell_types   = Smells::SmellRepository.eligible_smell_types(filter_by_smells)
 
       run
     end
 
+    # FIXME: Should be named "origin"
     #
     # @return [String] description of the source being analysed
     #
+    # @public
     def description
-      @description ||= source.description
+      @description ||= source.origin
     end
 
     #
     # @return [Array<SmellWarning>] the smells found in the source
     #
+    # @public
     def smells
       @smells ||= collector.warnings
     end
@@ -54,6 +62,7 @@ module Reek
     #
     # @return [Integer] the number of smells found in the source
     #
+    # @public
     def smells_count
       smells.length
     end
@@ -61,6 +70,7 @@ module Reek
     #
     # @return [Boolean] true if and only if there are code smells in the source.
     #
+    # @public
     def smelly?
       !smells.empty?
     end
@@ -70,22 +80,12 @@ module Reek
     private_attr_reader :configuration, :collector, :smell_types, :source
 
     def run
-      smell_repository = Smells::SmellRepository.new(source_description: description,
-                                                     smell_types: smell_types,
-                                                     configuration: configuration)
+      smell_repository = Smells::SmellRepository.new(
+        smell_types: smell_types,
+        configuration: configuration.directive_for(description))
       syntax_tree = source.syntax_tree
       TreeWalker.new(smell_repository, syntax_tree).walk if syntax_tree
       smell_repository.report_on(collector)
     end
-
-    def eligible_smell_types(filter_by_smells = [])
-      if filter_by_smells.any?
-        Smells::SmellRepository.smell_types.select do |klass|
-          filter_by_smells.include? klass.smell_type
-        end
-      else
-        Smells::SmellRepository.smell_types
-      end
-    end
   end
 end

data/lib/reek/rake/task.rb

@@ -12,6 +12,7 @@ module Reek
   # (Classes here will be configured via the Rakefile, and therefore will
   # possess a :reek:attribute or two.)
   #
+  # @public
   module Rake
     # A Rake task that runs reek on a set of source files.
     #
@@ -33,32 +34,43 @@ module Reek
     #   rake reek REEK_SRC=just_one_file.rb      # checks a single source file
     #   rake reek REEK_OPTS=-s                   # sorts the report by smell
     #
+    # @public
+    #
+    # :reek:TooManyInstanceVariables: { max_instance_variables: 6 }
+    # :reek:Attribute
     class Task < ::Rake::TaskLib
       # Name of reek task. Defaults to :reek.
+      # @public
       attr_writer :name
 
       # Path to reek's config file.
       # Setting the REEK_CFG environment variable overrides this.
+      # @public
       attr_accessor :config_file
 
       # Glob pattern to match source files.
       # Setting the REEK_SRC environment variable overrides this.
       # Defaults to 'lib/**/*.rb'.
+      # @public
       attr_reader :source_files
 
       # String containing commandline options to be passed to Reek.
       # Setting the REEK_OPTS environment variable overrides this value.
       # Defaults to ''.
+      # @public
       attr_accessor :reek_opts
 
       # Whether or not to fail Rake when an error occurs (typically when smells are found).
       # Defaults to true.
+      # @public
       attr_writer :fail_on_error
 
       # Use verbose output. If this is set to true, the task will print
       # the reek command to stdout. Defaults to false.
+      # @public
       attr_writer :verbose
 
+      # @public
       def initialize(name = :reek)
         @config_file   = ENV['REEK_CFG']
         @name          = name
@@ -71,6 +83,7 @@ module Reek
         define_task
       end
 
+      # @public
       def source_files=(files)
         raise ArgumentError, no_string_given_for_file_list_warning unless files.is_a?(String)
         @source_files = FileList[files]
@@ -101,6 +114,7 @@ module Reek
           reject(&:empty?)
       end
 
+      # :reek:UtilityFunction
       def sys_call_failed?
         !$CHILD_STATUS.success?
       end

data/lib/reek/report.rb

@@ -7,7 +7,6 @@ module Reek
   module Report
     module_function
 
-    # @api private
     REPORT_CLASSES = {
       yaml: YAMLReport,
       json: JSONReport,
@@ -16,19 +15,16 @@ module Reek
       text: TextReport
     }
 
-    # @api private
     LOCATION_FORMATTERS = {
       single_line: SingleLineLocationFormatter,
       plain: BlankLocationFormatter,
       numbers: DefaultLocationFormatter
     }
 
-    # @api private
     HEADING_FORMATTERS = {
       verbose: HeadingFormatter::Verbose,
       quiet: HeadingFormatter::Quiet }
 
-    # @api private
     WARNING_FORMATTER_CLASSES = {
       wiki_links: WikiLinkWarningFormatter,
       simple: SimpleWarningFormatter
@@ -40,28 +36,24 @@ module Reek
     #
     # @return The mapped report class
     #
-    # @api private
     def report_class(report_format)
       REPORT_CLASSES.fetch(report_format) do
         raise "Unknown report format: #{report_format}"
       end
     end
 
-    # @api private
     def location_formatter(location_format)
       LOCATION_FORMATTERS.fetch(location_format) do
         raise "Unknown location format: #{location_format}"
       end
     end
 
-    # @api private
     def heading_formatter(heading_format)
       HEADING_FORMATTERS.fetch(heading_format) do
         raise "Unknown heading format: #{heading_format}"
       end
     end
 
-    # @api private
     def warning_formatter_class(warning_format)
       WARNING_FORMATTER_CLASSES.fetch(warning_format) do
         raise "Unknown warning format: #{warning_format}"

data/lib/reek/report/formatter.rb

@@ -8,7 +8,6 @@ module Reek
     # Formatting of the individual warnings is handled by the
     # passed-in warning formatter.
     #
-    # @api private
     module Formatter
       def self.format_list(warnings, formatter: SimpleWarningFormatter.new)
         warnings.map do |warning|
@@ -29,24 +28,20 @@ module Reek
     # Basic formatter that just shows a simple message for each warning,
     # prepended with the result of the passed-in location formatter.
     #
-    # @api private
     class SimpleWarningFormatter
       def initialize(location_formatter: BlankLocationFormatter)
         @location_formatter = location_formatter
       end
 
       def format(warning)
-        "#{location_formatter.format(warning)}#{base_format(warning)}"
+        "#{location_formatter.format(warning)}#{warning.base_message}"
       end
 
-      private
-
-      def base_format(warning)
-        "#{warning.context} #{warning.message} (#{warning.smell_type})"
+      # :reek:UtilityFunction
+      def format_hash(warning)
+        warning.yaml_hash
       end
 
-      private
-
       private_attr_reader :location_formatter
     end
 
@@ -54,19 +49,25 @@ module Reek
     # Formatter that adds a link to the wiki to the basic message from
     # SimpleWarningFormatter.
     #
-    # @api private
     class WikiLinkWarningFormatter < SimpleWarningFormatter
       BASE_URL_FOR_HELP_LINK = 'https://github.com/troessner/reek/blob/master/docs/'
 
       def format(warning)
         "#{super} " \
-          "[#{explanatory_link(warning)}.md]"
+          "[#{explanatory_link(warning)}]"
       end
 
+      def format_hash(warning)
+        super(warning).merge('wiki_link' => explanatory_link(warning))
+      end
+
+      private
+
       def explanatory_link(warning)
-        "#{BASE_URL_FOR_HELP_LINK}#{class_name_to_param(warning.smell_type)}"
+        "#{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

data/lib/reek/report/heading_formatter.rb

@@ -1,6 +1,5 @@
 module Reek
   module Report
-    # @api private
     module HeadingFormatter
       #
       # Base class for heading formatters.
@@ -14,6 +13,7 @@ module Reek
           @report_formatter = report_formatter
         end
 
+        # :reek:UtilityFunction
         def show_header?(_examiner)
           raise NotImplementedError
         end
@@ -40,6 +40,7 @@ module Reek
       # Lists only smelly examiners
       #
       class Quiet < Base
+        # :reek:UtilityFunction
         def show_header?(examiner)
           examiner.smelly?
         end

data/lib/reek/report/location_formatter.rb

@@ -3,7 +3,6 @@ module Reek
     #
     # Formats the location of a warning as an empty string.
     #
-    # @api private
     module BlankLocationFormatter
       def self.format(_warning)
         ''
@@ -13,7 +12,6 @@ module Reek
     #
     # Formats the location of a warning as an array of line numbers.
     #
-    # @api private
     module DefaultLocationFormatter
       def self.format(warning)
         "#{warning.lines.inspect}:"
@@ -25,7 +23,6 @@ module Reek
     # and line number. In this format, it is not possible to show more than
     # one line number, so the first number is displayed.
     #
-    # @api private
     module SingleLineLocationFormatter
       def self.format(warning)
         "#{warning.source}:#{warning.lines.first}: "

data/lib/reek/report/report.rb

@@ -5,17 +5,23 @@ require_relative 'formatter'
 require_relative 'heading_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: 6 }
     class Base
-      # @api private
       NO_WARNINGS_COLOR = :green
-      # @api private
       WARNINGS_COLOR = :red
 
+      # @public
+      #
+      # :reek:BooleanParameter
       def initialize(heading_formatter: HeadingFormatter::Quiet,
                      report_formatter: Formatter, sort_by_issue_count: false,
                      warning_formatter: SimpleWarningFormatter.new)
@@ -25,12 +31,16 @@ module Reek
         @sort_by_issue_count = sort_by_issue_count
         @total_smell_count   = 0
         @warning_formatter   = warning_formatter
+
+        # TODO: Only used in TextReport and YAMLReport
       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
@@ -38,16 +48,16 @@ module Reek
       end
 
       # Render the report results on STDOUT
+      #
+      # @public
       def show
         raise NotImplementedError
       end
 
-      # @api private
       def smells?
         total_smell_count > 0
       end
 
-      # @api private
       def smells
         examiners.map(&:smells).flatten
       end
@@ -65,7 +75,9 @@ module Reek
     #
     # Generates a sorted, text summary of smells in examiners
     #
+    # @public
     class TextReport < Base
+      # @public
       def show
         sort_examiners if smells?
         display_summary
@@ -103,39 +115,42 @@ module Reek
 
       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)
+        Rainbow("#{total_smell_count} total warning#{total_smell_count == 1 ? '' : 's'}\n").color(colour)
       end
     end
 
     #
     # Displays a list of smells in YAML format
     # YAML with empty array for 0 smells
+    #
+    # @public
     class YAMLReport < Base
-      def show
-        print smells.map(&:yaml_hash).to_yaml
+      # @public
+      def show(out = $stdout)
+        out.print smells.map { |smell| warning_formatter.format_hash(smell) }.to_yaml
       end
     end
 
     #
     # Displays a list of smells in JSON format
     # JSON with empty array for 0 smells
+    #
+    # @public
     class JSONReport < Base
-      def show
-        print ::JSON.generate(
-          smells.map do |smell|
-            smell.yaml_hash(warning_formatter)
-          end
-        )
+      # @public
+      def show(out = $stdout)
+        out.print ::JSON.generate smells.map { |smell| warning_formatter.format_hash(smell) }
       end
     end
 
     #
     # Saves the report as a HTML file
     #
+    # @public
     class HTMLReport < Base
       require 'erb'
 
+      # @public
       def show(target_path: Pathname.new('reek.html'))
         template_path = Pathname.new("#{__dir__}/html_report.html.erb")
         File.write target_path, ERB.new(template_path.read).result(binding)
@@ -146,9 +161,11 @@ module Reek
     #
     # Generates a list of smells in XML format
     #
+    # @public
     class XMLReport < Base
       require 'rexml/document'
 
+      # @public
       def show
         document.write output: $stdout, indent: 2
         $stdout.puts
@@ -170,6 +187,8 @@ module Reek
         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)
@@ -181,6 +200,7 @@ module Reek
         end
       end
 
+      # :reek:UtilityFunction
       def error(smell, line)
         REXML::Element.new('error').tap do |error|
           error.add_attributes 'column'   => 0,