Class: RuboCop::Cop::Lint::NestedMethodDefinition
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::RuboCop::Cop::Base ,
::RuboCop::ExcludeLimit ,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
Instance Chain:
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/lint/nested_method_definition.rb |
Overview
Checks for nested method definitions.
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/lint/nested_method_definition.rb', line 95'Method definitions must not be nested. Use `lambda` instead.'
::RuboCop::Cop::Base
- Inherited
Class Attribute Summary
::RuboCop::Cop::Base
- Inherited
.gem_requirements, .lint?, | |
.support_autocorrect? | Returns if class supports autocorrect. |
.support_multiple_source? | Override if your cop should be called repeatedly for multiple investigations Between calls to |
Class Method Summary
::RuboCop::Cop::Base
- Inherited
.autocorrect_incompatible_with | List of cops that should not try to autocorrect at the same time as this cop. |
.badge | Naming. |
.callbacks_needed, .cop_name, .department, | |
.documentation_url | Returns a url to view this cops documentation online. |
.exclude_from_registry | Call for abstract Cop classes. |
.inherited, | |
.joining_forces | Override and return the Force class(es) you need to join. |
.match? | Returns true if the cop name or the cop namespace matches any of the given names. |
.new, | |
.requires_gem | Register a version requirement for the given gem name. |
.restrict_on_send |
::RuboCop::ExcludeLimit
- Extended
exclude_limit | Sets up a configuration option to have an exclude limit tracked. |
transform |
Instance Attribute Summary
::RuboCop::Cop::AllowedPattern
- Included
::RuboCop::Cop::AllowedMethods
- Included
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_def(node) (also: #on_defs)
-
#on_defs(node)
Alias for #on_def.
- #allowed_method_name?(node) ⇒ Boolean private
- #eval_call?(node) private
- #exec_call?(node) private
- #scoping_method_call?(child) ⇒ Boolean private
::RuboCop::Cop::AllowedPattern
- Included
#allowed_line?, #allowed_patterns, #cop_config_deprecated_methods_values, #cop_config_patterns_values, #matches_allowed_pattern? |
::RuboCop::Cop::AllowedMethods
- Included
::RuboCop::Cop::Base
- Inherited
#add_global_offense | Adds an offense that has no particular location. |
#add_offense | Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense. |
#begin_investigation | Called before any investigation. |
#callbacks_needed, | |
#cop_config | Configuration Helpers. |
#cop_name, #excluded_file?, | |
#external_dependency_checksum | This method should be overridden when a cop’s behavior depends on state that lives outside of these locations: |
#inspect, | |
#message | Gets called if no message is specified when calling |
#name | Alias for Base#cop_name. |
#offenses, | |
#on_investigation_end | Called after all on_… |
#on_new_investigation | Called before all on_… |
#on_other_file | Called instead of all on_… |
#parse | There should be very limited reasons for a Cop to do it’s own parsing. |
#parser_engine, | |
#ready | Called between investigations. |
#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction, | |
#callback_argument | Reserved for Cop::Cop. |
#complete_investigation | Called to complete an investigation. |
#correct, #current_corrector, | |
#current_offense_locations | Reserved for Commissioner: |
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range, | |
#reset_investigation | Actually private methods. |
#use_corrector |
::RuboCop::Cop::AutocorrectLogic
- Included
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array? |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#allowed_method_name?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/lint/nested_method_definition.rb', line 120
def allowed_method_name?(node) name = node.method_name allowed_method?(name) || matches_allowed_pattern?(name) end
#eval_call?(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/lint/nested_method_definition.rb', line 127
def_node_matcher :eval_call?, <<~PATTERN ({block numblock} (send _ {:instance_eval :class_eval :module_eval} ...) ...) PATTERN
#exec_call?(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/lint/nested_method_definition.rb', line 132
def_node_matcher :exec_call?, <<~PATTERN ({block numblock} (send _ {:instance_exec :class_exec :module_exec} ...) ...) PATTERN
#on_def(node) Also known as: #on_defs
[ GitHub ]# File 'lib/rubocop/cop/lint/nested_method_definition.rb', line 97
def on_def(node) subject, = *node # rubocop:disable InternalAffairs/NodeDestructuring return if node.defs_type? && subject.variable? def_ancestor = node.each_ancestor(:def, :defs).first return unless def_ancestor within_scoping_def = node.each_ancestor(:block, :numblock, :sclass).any? do |ancestor| scoping_method_call?(ancestor) end add_offense(node) if def_ancestor && !within_scoping_def end
#on_defs(node)
Alias for #on_def.
# File 'lib/rubocop/cop/lint/nested_method_definition.rb', line 111
alias on_defs on_def
#scoping_method_call?(child) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/lint/nested_method_definition.rb', line 115
def scoping_method_call?(child) child.sclass_type? || eval_call?(child) || exec_call?(child) || child.class_constructor? || allowed_method_name?(child) end