Class: RuboCop::Cop::Style::MutableConstant
- Extended by:
- AutoCorrector
- Includes:
- ConfigurableEnforcedStyle, FrozenStringLiteral
- Defined in:
- lib/rubocop/cop/style/mutable_constant.rb
Overview
This cop checks whether some constant value isn't a mutable literal (e.g. array or hash).
Strict mode can be used to freeze all constants, rather than just literals. Strict mode is considered an experimental feature. It has not been updated with an exhaustive list of all methods that will produce frozen objects so there is a decent chance of getting some false positives. Luckily, there is no harm in freezing an already frozen object.
NOTE: Regexp and Range literals are frozen objects since Ruby 3.0.
Constant Summary collapse
- MSG =
'Freeze mutable objects assigned to constants.'
Constants included from FrozenStringLiteral
FrozenStringLiteral::FROZEN_STRING_LITERAL, FrozenStringLiteral::FROZEN_STRING_LITERAL_ENABLED, FrozenStringLiteral::FROZEN_STRING_LITERAL_TYPES
Constants inherited from Base
Instance Attribute Summary
Attributes inherited from Base
Instance Method Summary collapse
Methods included from AutoCorrector
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_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected
Methods included from FrozenStringLiteral
frozen_string_literal_comment_exists?
Methods inherited from Base
#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version
Methods included from ExcludeLimit
Methods included from AutocorrectLogic
#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?
Methods included from IgnoredNode
#ignore_node, #ignored_node?, #part_of_ignored_node?
Methods included from Util
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#on_casgn(node) ⇒ Object
62 63 64 65 |
# File 'lib/rubocop/cop/style/mutable_constant.rb', line 62 def on_casgn(node) _scope, _const_name, value = *node on_assignment(value) end |
#on_or_asgn(node) ⇒ Object
67 68 69 70 71 72 73 |
# File 'lib/rubocop/cop/style/mutable_constant.rb', line 67 def on_or_asgn(node) lhs, value = *node return unless lhs&.casgn_type? on_assignment(value) end |