Class: RuboCop::Cop::Style::MutableConstant

Inherits:
Cop
  • Object
show all
Includes:
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).

Examples:

# bad
CONST = [1, 2, 3]

# good
CONST = [1, 2, 3].freeze

# good
CONST = <<~TESTING.freeze
This is a heredoc
TESTING

Constant Summary collapse

MSG =
'Freeze mutable objects assigned to constants.'.freeze

Constants included from FrozenStringLiteral

FrozenStringLiteral::FROZEN_STRING_LITERAL, FrozenStringLiteral::FROZEN_STRING_LITERAL_ENABLED, FrozenStringLiteral::FROZEN_STRING_LITERAL_TYPES

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from FrozenStringLiteral

frozen_string_literal_comment_exists?

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?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

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 AST::Sexp

#s

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, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/rubocop/cop/style/mutable_constant.rb', line 38

def autocorrect(node)
  expr = node.source_range

  lambda do |corrector|
    if node.array_type? && !node.bracketed?
      corrector.insert_before(expr, '[')
      corrector.insert_after(expr, '].freeze')
    elsif node.irange_type? || node.erange_type?
      corrector.insert_before(expr, '(')
      corrector.insert_after(expr, ').freeze')
    else
      corrector.insert_after(expr, '.freeze')
    end
  end
end

#on_casgn(node) ⇒ Object



25
26
27
28
# File 'lib/rubocop/cop/style/mutable_constant.rb', line 25

def on_casgn(node)
  _scope, _const_name, value = *node
  on_assignment(value)
end

#on_or_asgn(node) ⇒ Object



30
31
32
33
34
35
36
# File 'lib/rubocop/cop/style/mutable_constant.rb', line 30

def on_or_asgn(node)
  lhs, value = *node

  return unless lhs && lhs.casgn_type?

  on_assignment(value)
end