Class: RuboCop::Cop::Style::SpecialGlobalVars
- Includes:
- ConfigurableEnforcedStyle
- Defined in:
- lib/rubocop/cop/style/special_global_vars.rb
Overview
This cop looks for uses of Perl-style global variables.
Constant Summary collapse
- MSG_BOTH =
'Prefer `%s` from the stdlib \'English\' module ' \ '(don\'t forget to require it), or `%s` over `%s`.'.freeze
- MSG_ENGLISH =
'Prefer `%s` from the stdlib \'English\' module ' \ '(don\'t forget to require it) over `%s`.'.freeze
- MSG_REGULAR =
'Prefer `%s` over `%s`.'.freeze
- ENGLISH_VARS =
rubocop:disable Style/MutableConstant
{ # rubocop:disable Style/MutableConstant :$: => [:$LOAD_PATH], :$" => [:$LOADED_FEATURES], :$0 => [:$PROGRAM_NAME], :$! => [:$ERROR_INFO], :$@ => [:$ERROR_POSITION], :$; => [:$FIELD_SEPARATOR, :$FS], :$, => [:$OUTPUT_FIELD_SEPARATOR, :$OFS], :$/ => [:$INPUT_RECORD_SEPARATOR, :$RS], :$\ => [:$OUTPUT_RECORD_SEPARATOR, :$ORS], :$. => [:$INPUT_LINE_NUMBER, :$NR], :$_ => [:$LAST_READ_LINE], :$> => [:$DEFAULT_OUTPUT], :$< => [:$DEFAULT_INPUT], :$$ => [:$PROCESS_ID, :$PID], :$? => [:$CHILD_STATUS], :$~ => [:$LAST_MATCH_INFO], :$= => [:$IGNORECASE], :$* => [:$ARGV, :ARGV], :$& => [:$MATCH], :$` => [:$PREMATCH], :$' => [:$POSTMATCH], :$+ => [:$LAST_PAREN_MATCH] }
- PERL_VARS =
- NON_ENGLISH_VARS =
Anything not in this set is provided by the English library.
Set.new([ :$LOAD_PATH, :$LOADED_FEATURES, :$PROGRAM_NAME, :ARGV ]).freeze
Constants included from Util
Util::ASGN_NODES, Util::BYTE_ORDER_MARK, 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
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, #style_parameter_name, #supported_styles, #unexpected_style_detected
Methods inherited from Cop
#add_offense, all, 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_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?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?
Methods included from PathUtil
absolute?, match_path?, relative_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(node) ⇒ Object
84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/rubocop/cop/style/special_global_vars.rb', line 84 def autocorrect(node) lambda do |corrector| global_var, = *node while node.parent && node.parent.begin_type? && node.parent.children.one? node = node.parent end corrector.replace(node.source_range, replacement(node, global_var)) end end |
#message(node) ⇒ Object
74 75 76 77 78 79 80 81 82 |
# File 'lib/rubocop/cop/style/special_global_vars.rb', line 74 def (node) global_var, = *node if style == :use_english_names (global_var) else format(MSG_REGULAR, preferred_names(global_var).first, global_var) end end |
#on_gvar(node) ⇒ Object
61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/rubocop/cop/style/special_global_vars.rb', line 61 def on_gvar(node) global_var, = *node return unless (preferred = preferred_names(global_var)) if preferred.include?(global_var) correct_style_detected else opposite_style_detected add_offense(node, :expression) end end |