reek 4.7.3 → 5.0.0

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

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

@@ -1,42 +0,0 @@
-# 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

@@ -1,81 +0,0 @@
-# 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

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

@@ -1,35 +0,0 @@
-# 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

@@ -1,36 +0,0 @@
-# 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/formatter.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-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
-    #
-    # Formatter handling the formatting of the report at large.
-    # Formatting of the individual warnings is handled by the
-    # passed-in warning formatter.
-    #
-    module Formatter
-      module_function
-
-      def format_list(warnings, formatter: SimpleWarningFormatter.new)
-        warnings.map { |warning| "  #{formatter.format(warning)}" }.join("\n")
-      end
-
-      def header(examiner)
-        count = examiner.smells_count
-        result = Rainbow("#{examiner.description} -- ").cyan +
-          Rainbow("#{count} warning").yellow
-        result += Rainbow('s').yellow unless count == 1
-        result
-      end
-    end
-  end
-end

data/lib/reek/smell_detectors/syntax.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_detector'
-
-module Reek
-  module SmellDetectors
-    # Check syntax errors.
-    # Note: this detector is called by examiner directly unlike other detectors.
-    class Syntax < BaseDetector
-      # Context duck type for this atypical smell detector
-      DummyContext = Struct.new(:exp, :full_name)
-      # Exp duck type for this atypical smell detector
-      DummyExp = Struct.new(:source)
-
-      def self.contexts
-        []
-      end
-
-      def self.smells_from_source(source)
-        new.smells_from_source(source)
-      end
-
-      # :reek:FeatureEnvy
-      def smells_from_source(source)
-        context = DummyContext.new(
-          DummyExp.new(source.origin),
-          'This file')
-        source.diagnostics.map do |diagnostic|
-          smell_warning(
-            context: context,
-            lines: [diagnostic.location.line],
-            message: "has #{diagnostic.message}")
-        end
-      end
-    end
-  end
-end

data/samples/configuration/non_public_modifiers_mask.reek

@@ -1,3 +0,0 @@
----
-UtilityFunction:
-  public_methods_only: true

data/samples/smelly_with_inline_mask.rb

@@ -1,8 +0,0 @@
-# Smelly class
-# disables :reek:UncommunicativeVariableName
-class Smelly
-  # This will reek of UncommunicativeMethodName
-  def x
-    y = 10 # This will NOT reek of UncommunicativeVariableName
-  end
-end

data/samples/smelly_with_modifiers.rb

@@ -1,12 +0,0 @@
-# Smelly class for testing purposes
-#
-# Not necessary for the feature per se but for
-# removing distracting output. :reek:UnusedPrivateMethod
-#
-class Klass
-  def public_method(arg) arg.to_s; end
-  protected
-  def protected_method(arg) arg.to_s; end
-  private
-  def private_method(arg) arg.to_s; end
-end

data/samples/source_with_hidden_directories/.hidden/uncommunicative_method_name.rb

@@ -1,5 +0,0 @@
-# Klass comment.
-class Klass
-  def m
-  end
-end

data/samples/source_with_non_ruby_files/uncommunicative_parameter_name.rb

@@ -1,6 +0,0 @@
-# Klass comment
-class Klass
-  def method(a)
-    a + @x
-  end
-end

data/spec/reek/smell_detectors/syntax_spec.rb

@@ -1,17 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/smell_detectors/syntax'
-
-RSpec.describe Reek::SmellDetectors::Syntax do
-  it 'reports the right values' do
-    src = <<-EOS
-      class Alfa
-      edn
-    EOS
-
-    expect(src).to reek_of(:Syntax,
-                           lines: [3],
-                           context: 'This file',
-                           message: 'has unexpected token $end',
-                           source: 'string')
-  end
-end