reek 4.4.2 → 4.5.0

data/features/smells/subclassed_from_core_class.feature

@@ -1,14 +0,0 @@
-Feature: Smell - SubclassedFromCoreClass
-  Scenario: Reports smell
-    Given a file named "my_hash.rb" with:
-      """
-      # The MyHash class
-      class MyHash < Hash
-      end
-      """
-    When I run `reek my_hash.rb`
-    Then it reports:
-    """
-    my_hash.rb -- 1 warning:
-      [2]:SubclassedFromCoreClass: MyHash inherits from core class 'Hash' [https://github.com/troessner/reek/blob/master/docs/Subclassed-From-Core-Class.md]
-    """

data/features/smells/too_many_constants.feature

@@ -1,19 +0,0 @@
-Feature: Smell - TooManyConstants
-  Scenario: Reports smell
-    Given a file named "my_class.rb" with:
-      """
-      class MyClass
-        A = 1
-        B = 2
-        C = 3
-        D = 4
-        E = 5
-        F = 6
-      end
-      """
-    When I run `reek my_class.rb`
-    Then it reports:
-    """
-    my_class.rb -- 1 warning:
-      [1]:TooManyConstants: MyClass has 6 constants [https://github.com/troessner/reek/blob/master/docs/Too-Many-Constants.md]
-    """

data/lib/reek/errors.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-module Reek
-  # Gets raised when trying to configure a detector which is unknown to us.
-  # This might happen for multiple reasons. The users might have a typo in
-  # his comment or he might use a detector that does not exist anymore.
-  class BadDetectorInCommentError < RuntimeError
-    UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-EOS.freeze
-
-      Error: You are trying to configure an unknown smell detector '%s' in one
-      of your source code comments.
-      The source is '%s' and the comment belongs to the expression starting in line %d.
-      Here's the original comment:
-
-      %s
-
-      Please see the Reek docs for:
-        * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
-        * what smell detectors are available: https://github.com/troessner/reek/blob/master/docs/Code-Smells.md
-      Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
-
-    EOS
-
-    def initialize(detector:, source:, line:, original_comment:)
-      message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,
-                       detector,
-                       source,
-                       line,
-                       original_comment)
-      super message
-    end
-  end
-end

data/lib/reek/report/location_formatter.rb

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

data/lib/reek/report/report.rb

@@ -1,229 +0,0 @@
-# frozen_string_literal: true
-require 'json'
-require 'pathname'
-require 'rainbow'
-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
-      NO_WARNINGS_COLOR = :green
-      WARNINGS_COLOR = :red
-
-      # @public
-      #
-      # :reek:BooleanParameter
-      def initialize(heading_formatter: HeadingFormatter::Quiet,
-                     report_formatter: Formatter, sort_by_issue_count: false,
-                     warning_formatter: SimpleWarningFormatter.new)
-        @examiners           = []
-        @heading_formatter   = heading_formatter.new(report_formatter)
-        @report_formatter    = report_formatter
-        @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
-        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
-    end
-
-    #
-    # Generates a sorted, text summary of smells in examiners
-    #
-    # @public
-    class TextReport < Base
-      # @public
-      def show
-        sort_examiners if smells?
-        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
-
-    #
-    # Displays a list of smells in YAML format
-    # YAML with empty array for 0 smells
-    #
-    # @public
-    class YAMLReport < Base
-      # @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
-      # @public
-      def show(out = $stdout)
-        out.print ::JSON.generate smells.map { |smell| warning_formatter.format_hash(smell) }
-      end
-    end
-
-    #
-    # 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 < Base
-      # @public
-      def show(out = $stdout)
-        smells.map do |smell|
-          out.print warning_formatter.format_code_climate_hash(smell)
-        end
-      end
-    end
-
-    #
-    # Saves the report as a HTML file
-    #
-    # @public
-    class HTMLReport < Base
-      require 'erb'
-
-      # @public
-      def show
-        template_path = Pathname.new("#{__dir__}/html_report.html.erb")
-        puts ERB.new(template_path.read).result(binding)
-      end
-    end
-
-    #
-    # 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
-      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/smells.rb

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

data/spec/reek/smells/smell_repository_spec.rb

@@ -1,22 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/smells/smell_detector'
-require_lib 'reek/smells/smell_repository'
-
-RSpec.describe Reek::Smells::SmellRepository do
-  describe '.smell_types' do
-    let(:smell_types) { described_class.smell_types }
-
-    it 'includes existing smell_types' do
-      expect(smell_types).to include(Reek::Smells::IrresponsibleModule).
-        and include(Reek::Smells::TooManyStatements)
-    end
-
-    it 'excludes the smell detector base class' do
-      expect(smell_types).not_to include(Reek::Smells::SmellDetector)
-    end
-
-    it 'returns the smell types in alphabetic order' do
-      expect(smell_types).to eq(smell_types.sort_by(&:name))
-    end
-  end
-end