reek 4.7.1 → 5.0.0

data/spec/reek/tree_dresser_spec.rb

@@ -1,17 +1,15 @@
-require_lib 'reek/cli/silencer'
-Reek::CLI::Silencer.silently do
-  require 'parser/ruby22'
-end
-
 require_relative '../spec_helper'
+Reek::CLI::Silencer.without_warnings { require 'parser/ruby25' }
 require_lib 'reek/tree_dresser'
 
 RSpec.describe Reek::TreeDresser do
-  let(:dresser) { described_class.new }
-  let(:sexp) do
-    Parser::Ruby22.parse('class Klazz; def meth(argument); argument.call_me; end; end')
-  end
-  let(:dressed_ast) do
+  describe '#dress' do
+    let(:dresser) { described_class.new }
+    let(:sexp) do
+      Parser::Ruby25.parse('class Klazz; def meth(argument); argument.call_me; end; end')
+    end
+    let(:dressed_ast) { dresser.dress(sexp, {}) }
+
     # The dressed AST looks like this:
     #   (class
     #     (const nil :Klazz) nil
@@ -20,14 +18,11 @@ RSpec.describe Reek::TreeDresser do
     #         (arg :argument))
     #       (send
     #         (lvar :argument) :call_me)))
-    dresser.dress(sexp, {})
-  end
-  let(:const_node) { dressed_ast.children.first }
-  let(:def_node) { dressed_ast.children.last }
-  let(:args_node) { def_node.children[1] }
-  let(:send_node) { def_node.children[2] }
+    let(:const_node) { dressed_ast.children.first }
+    let(:def_node) { dressed_ast.children.last }
+    let(:args_node) { def_node.children[1] }
+    let(:send_node) { def_node.children[2] }
 
-  context 'dresses the given sexp' do
     it 'dresses `const` nodes properly' do
       expect(const_node).to be_a Reek::AST::SexpExtensions::ConstNode
     end

data/spec/spec_helper.rb

@@ -8,15 +8,13 @@ require_relative '../lib/reek/configuration/app_configuration'
 
 require_relative '../samples/paths'
 
-Reek::CLI::Silencer.silently do
-  begin
-    require 'pry-byebug'
-  rescue LoadError # rubocop:disable Lint/HandleExceptions
-  end
+begin
+  Reek::CLI::Silencer.without_warnings { require 'pry-byebug' }
+rescue LoadError # rubocop:disable Lint/HandleExceptions
 end
 
-require 'factory_girl'
-FactoryGirl.find_definitions
+require 'factory_bot'
+FactoryBot.find_definitions
 
 # Simple helpers for our specs.
 module Helpers
@@ -76,7 +74,7 @@ end
 RSpec.configure do |config|
   config.filter_run :focus
   config.run_all_when_everything_filtered = true
-  config.include FactoryGirl::Syntax::Methods
+  config.include FactoryBot::Syntax::Methods
   config.include Helpers
 
   config.disable_monkey_patching!
@@ -85,15 +83,6 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
     mocks.verify_doubled_constant_names = true
   end
-
-  # Avoid infinitely running tests. This is mainly useful when running a
-  # mutation tester. Set the DEBUG environment variable to something truthy
-  # like '1' to disable this and allow using pry without specs failing.
-  unless ENV['DEBUG']
-    config.around(:each) do |example|
-      Timeout.timeout(5, &example)
-    end
-  end
 end
 
 RSpec::Matchers.define_negated_matcher :not_reek_of, :reek_of

data/tasks/configuration.rake

@@ -1,15 +1,18 @@
 require_relative '../lib/reek/detector_repository'
+require_relative '../lib/reek/configuration/rake_task_converter'
+require_relative '../lib/reek/configuration/app_configuration'
+
 require 'yaml'
 
 namespace :configuration do
   desc 'Updates the default configuration file when smell defaults change'
   task :update_default_configuration do
-    DEFAULT_SMELL_CONFIGURATION = 'defaults.reek'.freeze
+    DEFAULT_SMELL_CONFIGURATION = 'docs/defaults.reek.yml'.freeze
     content = Reek::DetectorRepository.smell_types.each_with_object({}) do |klass, hash|
-      hash[klass.smell_type] = klass.default_config
+      hash[klass.smell_type] = Reek::Configuration::RakeTaskConverter.convert klass.default_config
+    end
+    File.open(DEFAULT_SMELL_CONFIGURATION, 'w') do |file|
+      YAML.dump({ Reek::Configuration::AppConfiguration::DETECTORS_KEY => content }, file)
     end
-    File.open(DEFAULT_SMELL_CONFIGURATION, 'w') { |file| YAML.dump(content, file) }
   end
 end
-
-task 'test:spec' => 'configuration:update_default_configuration'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.7.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -27,40 +27,60 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: kwalify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0.0
+        version: 2.5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0.0
+        version: 2.5.0.0
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: Reek is a tool that examines Ruby classes, modules and methods and reports
   any code smells it finds.
 email:
@@ -76,6 +96,7 @@ files:
 - ".codeclimate.yml"
 - ".dockerignore"
 - ".gitignore"
+- ".reek.yml"
 - ".rubocop.yml"
 - ".simplecov"
 - ".travis.yml"
@@ -90,7 +111,6 @@ files:
 - ataru_setup.rb
 - bin/code_climate_reek
 - bin/reek
-- defaults.reek
 - docs/API.md
 - docs/Attribute.md
 - docs/Basic-Smell-Options.md
@@ -111,12 +131,13 @@ files:
 - docs/Long-Parameter-List.md
 - docs/Long-Yield-List.md
 - docs/Manual-Dispatch.md
+- docs/Missing-Safe-Method.md
 - docs/Module-Initialize.md
 - docs/Nested-Iterators.md
 - docs/Nil-Check.md
-- docs/Prima-Donna-Method.md
 - docs/RSpec-matchers.md
 - docs/Rake-Task.md
+- docs/Reek-4-to-Reek-5-migration.md
 - docs/Reek-Driven-Development.md
 - docs/Repeated-Conditional.md
 - docs/Simulated-Polymorphism.md
@@ -137,6 +158,7 @@ files:
 - docs/Utility-Function.md
 - docs/Versioning-Policy.md
 - docs/YAML-Reports.md
+- docs/defaults.reek.yml
 - docs/templates/default/docstring/html/public_api_marker.erb
 - docs/templates/default/docstring/setup.rb
 - docs/templates/default/fulldoc/html/css/common.css
@@ -155,17 +177,19 @@ files:
 - features/configuration_files/masking_smells.feature
 - features/configuration_files/mix_accept_reject_setting.feature
 - features/configuration_files/reject_setting.feature
+- features/configuration_files/schema_validation.feature
 - features/configuration_files/unused_private_method.feature
-- features/configuration_files/warn_about_multiple_configuration_files.feature
 - features/configuration_loading.feature
 - features/configuration_via_source_comments/erroneous_source_comments.feature
 - features/configuration_via_source_comments/well_formed_source_comments.feature
+- features/locales.feature
 - features/programmatic_access.feature
 - features/rake_task/rake_task.feature
 - features/reports/codeclimate.feature
 - features/reports/json.feature
 - features/reports/reports.feature
 - features/reports/yaml.feature
+- features/rspec_matcher.feature
 - features/samples.feature
 - features/step_definitions/.rubocop.yml
 - features/step_definitions/reek_steps.rb
@@ -208,11 +232,15 @@ files:
 - lib/reek/cli/status.rb
 - lib/reek/code_comment.rb
 - lib/reek/configuration/app_configuration.rb
+- lib/reek/configuration/configuration_converter.rb
 - lib/reek/configuration/configuration_file_finder.rb
 - lib/reek/configuration/configuration_validator.rb
 - lib/reek/configuration/default_directive.rb
 - lib/reek/configuration/directory_directives.rb
 - lib/reek/configuration/excluded_paths.rb
+- lib/reek/configuration/rake_task_converter.rb
+- lib/reek/configuration/schema.yml
+- lib/reek/configuration/schema_validator.rb
 - lib/reek/context/attribute_context.rb
 - lib/reek/context/class_context.rb
 - lib/reek/context/code_context.rb
@@ -227,11 +255,15 @@ files:
 - lib/reek/context/visibility_tracker.rb
 - lib/reek/context_builder.rb
 - lib/reek/detector_repository.rb
+- lib/reek/documentation_link.rb
 - lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb
 - lib/reek/errors/bad_detector_in_comment_error.rb
 - lib/reek/errors/base_error.rb
+- lib/reek/errors/config_file_error.rb
+- lib/reek/errors/encoding_error.rb
 - lib/reek/errors/garbage_detector_configuration_in_comment_error.rb
 - lib/reek/errors/incomprehensible_source_error.rb
+- lib/reek/errors/syntax_error.rb
 - lib/reek/examiner.rb
 - lib/reek/logging_error_handler.rb
 - lib/reek/rake/task.rb
@@ -243,15 +275,14 @@ files:
 - lib/reek/report/code_climate/code_climate_fingerprint.rb
 - lib/reek/report/code_climate/code_climate_formatter.rb
 - lib/reek/report/code_climate/code_climate_report.rb
-- lib/reek/report/formatter.rb
-- lib/reek/report/formatter/heading_formatter.rb
-- lib/reek/report/formatter/location_formatter.rb
-- lib/reek/report/formatter/progress_formatter.rb
-- lib/reek/report/formatter/simple_warning_formatter.rb
-- lib/reek/report/formatter/wiki_link_warning_formatter.rb
+- lib/reek/report/documentation_link_warning_formatter.rb
+- lib/reek/report/heading_formatter.rb
 - lib/reek/report/html_report.rb
 - lib/reek/report/html_report/html_report.html.erb
 - lib/reek/report/json_report.rb
+- lib/reek/report/location_formatter.rb
+- lib/reek/report/progress_formatter.rb
+- lib/reek/report/simple_warning_formatter.rb
 - lib/reek/report/text_report.rb
 - lib/reek/report/xml_report.rb
 - lib/reek/report/yaml_report.rb
@@ -270,13 +301,12 @@ files:
 - lib/reek/smell_detectors/long_parameter_list.rb
 - lib/reek/smell_detectors/long_yield_list.rb
 - lib/reek/smell_detectors/manual_dispatch.rb
+- lib/reek/smell_detectors/missing_safe_method.rb
 - lib/reek/smell_detectors/module_initialize.rb
 - lib/reek/smell_detectors/nested_iterators.rb
 - lib/reek/smell_detectors/nil_check.rb
-- lib/reek/smell_detectors/prima_donna_method.rb
 - lib/reek/smell_detectors/repeated_conditional.rb
 - lib/reek/smell_detectors/subclassed_from_core_class.rb
-- lib/reek/smell_detectors/syntax.rb
 - lib/reek/smell_detectors/too_many_constants.rb
 - lib/reek/smell_detectors/too_many_instance_variables.rb
 - lib/reek/smell_detectors/too_many_methods.rb
@@ -306,33 +336,32 @@ files:
 - logo/reek.text.svg
 - reek.gemspec
 - samples/checkstyle.xml
-- samples/clean.rb
+- samples/clean_source/clean.rb
+- samples/configuration/accepts_rejects_and_excludes_for_detectors.reek.yml
+- samples/configuration/accepts_rejects_and_excludes_for_directory_directives.reek.yml
 - samples/configuration/corrupt.reek
 - samples/configuration/empty.reek
 - samples/configuration/full_configuration.reek
 - samples/configuration/full_mask.reek
-- samples/configuration/more_than_one_configuration_file/regular.reek
-- samples/configuration/more_than_one_configuration_file/todo.reek
-- samples/configuration/non_public_modifiers_mask.reek
+- samples/configuration/home/home.reek.yml
 - samples/configuration/partial_mask.reek
-- samples/configuration/single_configuration_file/.reek
+- samples/configuration/regular_configuration/.reek.yml
+- samples/configuration/regular_configuration/empty_sub_directory/.gitignore
 - samples/configuration/with_excluded_paths.reek
-- samples/exceptions.reek
-- samples/inline.rb
-- samples/optparse.rb
+- samples/no_config_file/.keep
 - samples/paths.rb
-- samples/redcloth.rb
-- samples/smelly.rb
-- samples/smelly_with_inline_mask.rb
-- samples/smelly_with_modifiers.rb
+- samples/smelly_source/inline.rb
+- samples/smelly_source/optparse.rb
+- samples/smelly_source/redcloth.rb
+- samples/smelly_source/smelly.rb
 - samples/source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb
 - samples/source_with_exclude_paths/nested/ignore_me_as_well/irresponsible_module.rb
 - samples/source_with_exclude_paths/nested/uncommunicative_parameter_name.rb
-- samples/source_with_hidden_directories/.hidden/uncommunicative_method_name.rb
-- samples/source_with_hidden_directories/uncommunicative_parameter_name.rb
+- samples/source_with_hidden_directories/.hidden/hidden.rb
+- samples/source_with_hidden_directories/not_hidden.rb
 - samples/source_with_non_ruby_files/gibberish
 - samples/source_with_non_ruby_files/python_source.py
-- samples/source_with_non_ruby_files/uncommunicative_parameter_name.rb
+- samples/source_with_non_ruby_files/ruby.rb
 - spec/factories/factories.rb
 - spec/quality/reek_source_spec.rb
 - spec/reek/ast/node_spec.rb
@@ -343,12 +372,15 @@ files:
 - spec/reek/cli/command/report_command_spec.rb
 - spec/reek/cli/command/todo_list_command_spec.rb
 - spec/reek/cli/options_spec.rb
+- spec/reek/cli/silencer_spec.rb
 - spec/reek/code_comment_spec.rb
 - spec/reek/configuration/app_configuration_spec.rb
 - spec/reek/configuration/configuration_file_finder_spec.rb
 - spec/reek/configuration/default_directive_spec.rb
 - spec/reek/configuration/directory_directives_spec.rb
 - spec/reek/configuration/excluded_paths_spec.rb
+- spec/reek/configuration/rake_task_converter_spec.rb
+- spec/reek/configuration/schema_validator_spec.rb
 - spec/reek/context/code_context_spec.rb
 - spec/reek/context/ghost_context_spec.rb
 - spec/reek/context/method_context_spec.rb
@@ -357,6 +389,8 @@ files:
 - spec/reek/context/statement_counter_spec.rb
 - spec/reek/context_builder_spec.rb
 - spec/reek/detector_repository_spec.rb
+- spec/reek/documentation_link_spec.rb
+- spec/reek/errors/base_error_spec.rb
 - spec/reek/examiner_spec.rb
 - spec/reek/logging_error_handler_spec.rb
 - spec/reek/rake/task_spec.rb
@@ -364,10 +398,10 @@ files:
 - spec/reek/report/code_climate/code_climate_fingerprint_spec.rb
 - spec/reek/report/code_climate/code_climate_formatter_spec.rb
 - spec/reek/report/code_climate/code_climate_report_spec.rb
-- spec/reek/report/formatter/location_formatter_spec.rb
-- spec/reek/report/formatter/progress_formatter_spec.rb
 - spec/reek/report/html_report_spec.rb
 - spec/reek/report/json_report_spec.rb
+- spec/reek/report/location_formatter_spec.rb
+- spec/reek/report/progress_formatter_spec.rb
 - spec/reek/report/text_report_spec.rb
 - spec/reek/report/xml_report_spec.rb
 - spec/reek/report/yaml_report_spec.rb
@@ -386,13 +420,12 @@ files:
 - spec/reek/smell_detectors/long_parameter_list_spec.rb
 - spec/reek/smell_detectors/long_yield_list_spec.rb
 - spec/reek/smell_detectors/manual_dispatch_spec.rb
+- spec/reek/smell_detectors/missing_safe_method_spec.rb
 - spec/reek/smell_detectors/module_initialize_spec.rb
 - spec/reek/smell_detectors/nested_iterators_spec.rb
 - spec/reek/smell_detectors/nil_check_spec.rb
-- spec/reek/smell_detectors/prima_donna_method_spec.rb
 - spec/reek/smell_detectors/repeated_conditional_spec.rb
 - spec/reek/smell_detectors/subclassed_from_core_class_spec.rb
-- spec/reek/smell_detectors/syntax_spec.rb
 - spec/reek/smell_detectors/too_many_constants_spec.rb
 - spec/reek/smell_detectors/too_many_instance_variables_spec.rb
 - spec/reek/smell_detectors/too_many_methods_spec.rb
@@ -419,7 +452,7 @@ files:
 - tasks/reek.rake
 - tasks/rubocop.rake
 - tasks/test.rake
-homepage: https://github.com/troessner/reek/wiki
+homepage: https://github.com/troessner/reek
 licenses:
 - MIT
 metadata: {}
@@ -435,7 +468,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -443,7 +476,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.2
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby

data/defaults.reek

@@ -1,131 +0,0 @@
----
-Attribute:
-  enabled: true
-  exclude: []
-BooleanParameter:
-  enabled: true
-  exclude: []
-ClassVariable:
-  enabled: true
-  exclude: []
-ControlParameter:
-  enabled: true
-  exclude: []
-DataClump:
-  enabled: true
-  exclude: []
-  max_copies: 2
-  min_clump_size: 2
-DuplicateMethodCall:
-  enabled: true
-  exclude: []
-  max_calls: 1
-  allow_calls: []
-FeatureEnvy:
-  enabled: true
-  exclude: []
-InstanceVariableAssumption:
-  enabled: true
-  exclude: []
-IrresponsibleModule:
-  enabled: true
-  exclude: []
-LongParameterList:
-  enabled: true
-  exclude: []
-  max_params: 3
-  overrides:
-    initialize:
-      max_params: 5
-LongYieldList:
-  enabled: true
-  exclude: []
-  max_params: 3
-ManualDispatch:
-  enabled: true
-  exclude: []
-ModuleInitialize:
-  enabled: true
-  exclude: []
-NestedIterators:
-  enabled: true
-  exclude: []
-  max_allowed_nesting: 1
-  ignore_iterators:
-  - tap
-NilCheck:
-  enabled: true
-  exclude: []
-PrimaDonnaMethod:
-  enabled: true
-  exclude: []
-RepeatedConditional:
-  enabled: true
-  exclude: []
-  max_ifs: 2
-SubclassedFromCoreClass:
-  enabled: true
-  exclude: []
-Syntax:
-  enabled: true
-  exclude: []
-TooManyConstants:
-  enabled: true
-  exclude: []
-  max_constants: 5
-TooManyInstanceVariables:
-  enabled: true
-  exclude: []
-  max_instance_variables: 4
-TooManyMethods:
-  enabled: true
-  exclude: []
-  max_methods: 15
-TooManyStatements:
-  enabled: true
-  exclude:
-  - initialize
-  max_statements: 5
-UncommunicativeMethodName:
-  enabled: true
-  exclude: []
-  reject:
-  - !ruby/regexp /^[a-z]$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-  accept: []
-UncommunicativeModuleName:
-  enabled: true
-  exclude: []
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  accept: []
-UncommunicativeParameterName:
-  enabled: true
-  exclude: []
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-  - !ruby/regexp /^_/
-  accept: []
-UncommunicativeVariableName:
-  enabled: true
-  exclude: []
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-  accept:
-  - !ruby/regexp /^_$/
-UnusedParameters:
-  enabled: true
-  exclude: []
-UnusedPrivateMethod:
-  enabled: false
-  exclude: []
-UtilityFunction:
-  enabled: true
-  exclude: []
-  public_methods_only: false

data/features/configuration_files/warn_about_multiple_configuration_files.feature

@@ -1,44 +0,0 @@
-Feature: Warn on multiple configuration files
-  Reek is designed for one configuration file and for one configuration file only.
-  We should make this clear to the user by warning him when we detect multiple
-  configuration files and then exiting the program.
-
-  Scenario: Warn on more than one configuration file
-    Given the smelly file 'smelly.rb'
-    And a file named "config.reek" with:
-      """
-      ---
-      UncommunicativeMethodName:
-        enabled: false
-      """
-    And a file named ".todo.reek" with:
-      """
-      ---
-      UtilityFunction:
-        enabled: false
-      """
-    When I run reek smelly.rb
-    Then it reports the error "Error: Found multiple configuration files '.todo.reek', 'config.reek'"
-    And it reports the error "Reek supports only one configuration file. You have 2 options now:"
-    And it reports the error "1) Remove all offending files"
-    And it reports the error "2) Be specific about which one you want to load via the -c switch"
-    And the exit status indicates an error
-
-  Scenario: Do not warn on more than one when we explicitly specify one configuration file
-    Given the smelly file 'smelly.rb'
-    And a file named "config.reek" with:
-      """
-      ---
-      UncommunicativeMethodName:
-        enabled: false
-      """
-    And a file named ".todo.reek" with:
-      """
-      ---
-      UtilityFunction:
-        enabled: false
-      """
-    When I run reek -c config.reek smelly.rb
-    Then the exit status indicates smells
-    And it reports no errors
-

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

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Reek
-  module Report
-    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 HeadingFormatterBase
-        attr_reader :report_formatter
-
-        def initialize(report_formatter)
-          @report_formatter = report_formatter
-        end
-
-        # :reek:UtilityFunction
-        def show_header?(_examiner)
-          raise NotImplementedError
-        end
-
-        def header(examiner)
-          if show_header?(examiner)
-            report_formatter.header examiner
-          else
-            ''
-          end
-        end
-      end
-
-      #
-      # Lists out each examiner, even if it has no smell
-      #
-      class VerboseHeadingFormatter < HeadingFormatterBase
-        def show_header?(_examiner)
-          true
-        end
-      end
-
-      #
-      # Lists only smelly examiners
-      #
-      class QuietHeadingFormatter < HeadingFormatterBase
-        # :reek:UtilityFunction
-        def show_header?(examiner)
-          examiner.smelly?
-        end
-      end
-    end
-  end
-end