Contents

# frozen_string_literal: true

require_relative 'base_detector'

module Reek
  module SmellDetectors
    #
    # A Large Class is a class or module that has a large number of
    # instance variables, methods or lines of code.
    #
    # +TooManyInstanceVariables' reports classes having more than a
    # configurable number of instance variables.
    #
    # See {file:docs/Too-Many-Instance-Variables.md} for details.
    class TooManyInstanceVariables < BaseDetector
      # The name of the config field that sets the maximum number of instance
      # variables permitted in a class.
      MAX_ALLOWED_IVARS_KEY = 'max_instance_variables'.freeze
      DEFAULT_MAX_IVARS = 4

      def self.contexts
        [:class]
      end

      def self.default_config
        super.merge(
          MAX_ALLOWED_IVARS_KEY => DEFAULT_MAX_IVARS,
          EXCLUDE_KEY => [])
      end

      #
      # Checks +klass+ for too many instance variables.
      #
      # @return [Array<SmellWarning>]
      #
      def sniff
        variables = context.local_nodes(:ivasgn, [:or_asgn]).map(&:name)
        count = variables.uniq.size
        return [] if count <= max_allowed_ivars
        [smell_warning(
          context: context,
          lines: [source_line],
          message: "has at least #{count} instance variables",
          parameters: { count: count })]
      end

      private

      def max_allowed_ivars
        value(MAX_ALLOWED_IVARS_KEY, context)
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
reek-4.8.2	lib/reek/smell_detectors/too_many_instance_variables.rb
reek-4.8.1	lib/reek/smell_detectors/too_many_instance_variables.rb
reek-4.8.0	lib/reek/smell_detectors/too_many_instance_variables.rb
reek-4.7.3	lib/reek/smell_detectors/too_many_instance_variables.rb