Class: Reek::Smells::TooManyMethods Private
- Inherits:
-
SmellDetector
- Object
- SmellDetector
- Reek::Smells::TooManyMethods
- Defined in:
- lib/reek/smells/too_many_methods.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
A Large Class is a class or module that has a large number of instance variables, methods or lines of code.
TooManyMethods
reports classes having more than a configurable number of methods. The method count includes public, protected and private methods, and excludes methods inherited from superclasses or included modules.
See Too-Many-Methods for details.
Constant Summary collapse
- MAX_ALLOWED_METHODS_KEY =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
The name of the config field that sets the maximum number of methods permitted in a class.
'max_methods'
- DEFAULT_MAX_METHODS =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
25
Constants inherited from SmellDetector
SmellDetector::DEFAULT_EXCLUDE_SET, SmellDetector::EXCLUDE_KEY
Instance Attribute Summary
Attributes inherited from SmellDetector
Class Method Summary collapse
-
.contexts ⇒ Object
private
:nodoc:.
- .default_config ⇒ Object private
- .smell_category ⇒ Object private
Instance Method Summary collapse
-
#examine_context(ctx) ⇒ Array<SmellWarning>
private
Checks
ctx
for too many methods.
Methods inherited from SmellDetector
#config_for, #configure_with, default_smell_category, descendants, #enabled?, #enabled_for?, #examine, #exception?, #initialize, #register, #report_on, #smell_category, smell_type, #smell_type, #value
Constructor Details
This class inherits a constructor from Reek::Smells::SmellDetector
Class Method Details
.contexts ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
:nodoc:
27 28 29 |
# File 'lib/reek/smells/too_many_methods.rb', line 27 def self.contexts # :nodoc: [:class] end |
.default_config ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
31 32 33 34 35 36 |
# File 'lib/reek/smells/too_many_methods.rb', line 31 def self.default_config super.merge( MAX_ALLOWED_METHODS_KEY => DEFAULT_MAX_METHODS, EXCLUDE_KEY => [] ) end |
.smell_category ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
23 24 25 |
# File 'lib/reek/smells/too_many_methods.rb', line 23 def self.smell_category 'LargeClass' end |
Instance Method Details
#examine_context(ctx) ⇒ Array<SmellWarning>
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Checks ctx
for too many methods
43 44 45 46 47 48 49 50 51 52 |
# File 'lib/reek/smells/too_many_methods.rb', line 43 def examine_context(ctx) @max_allowed_methods = value(MAX_ALLOWED_METHODS_KEY, ctx, DEFAULT_MAX_METHODS) actual = ctx.node_instance_methods.length return [] if actual <= @max_allowed_methods [SmellWarning.new(self, context: ctx.full_name, lines: [ctx.exp.line], message: "has at least #{actual} methods", parameters: { count: actual })] end |