Class: RuboCop::Cop::Naming::MemoizedInstanceVariableName
- Includes:
- ConfigurableEnforcedStyle
- Defined in:
- lib/rubocop/cop/naming/memoized_instance_variable_name.rb
Overview
This cop checks for memoized methods whose instance variable name does not match the method name.
This cop can be configured with the EnforcedStyleForLeadingUnderscores directive. It can be configured to allow for memoized instance variables prefixed with an underscore. Prefixing ivars with an undersscore is a convention that is used to implicitly indicate that an ivar should not be set or referencd outside of the memoization method.
Constant Summary collapse
- MSG =
'Memoized variable `%<var>s` does not match ' \ 'method name `%<method>s`. Use `@%<suggested_var>s` instead.'.freeze
- UNDERSCORE_REQUIRED =
'Memoized variable `%<var>s` does not start ' \ 'with `_`. Use `@%<suggested_var>s` instead.'.freeze
Constants included from Util
Util::ASGN_NODES, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
- #on_def(node) ⇒ Object (also: #on_defs)
Methods included from ConfigurableEnforcedStyle
#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #supported_styles, #unexpected_style_detected
Methods inherited from Cop
#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version
Methods included from AST::Sexp
Methods included from NodePattern::Macros
#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first
Methods included from AutocorrectLogic
#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?
Methods included from IgnoredNode
#ignore_node, #ignored_node?, #part_of_ignored_node?
Methods included from Util
begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens
Methods included from PathUtil
absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#on_def(node) ⇒ Object Also known as: on_defs
93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/rubocop/cop/naming/memoized_instance_variable_name.rb', line 93 def on_def(node) (method_name, ivar_assign) = memoized?(node) return if matches?(method_name, ivar_assign) msg = format( (ivar_assign.children.first.to_s), var: ivar_assign.children.first.to_s, suggested_var: suggested_var(method_name), method: method_name ) add_offense(node, location: ivar_assign.source_range, message: msg) end |