Class: RuboCop::Cop::Style::SpecialGlobalVars

Inherits:
Cop
  • Object
show all
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, ' \
'or `%s` over `%s`.'.freeze
MSG_ENGLISH = 
'Prefer `%s` from the stdlib \'English\' module ' \
'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::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX





  
Instance Attribute Summary

  
  
Attributes inherited from Cop

  
#config, #corrections, #offenses, #processed_source



  
    

      Instance Method Summary
      collapse
    


    
  


  
  
  
  
  
  
  
  
  
Methods included from ConfigurableEnforcedStyle

  
#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #supported_styles, #unexpected_style_detected


  
  
  
  
  
  
  
  
  
Methods inherited from Cop

  
#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version


  
  
  
  
  
  
  
  
  
Methods included from Sexp

  
#s


  
  
  
  
  
  
  
  
  
Methods included from NodePattern::Macros

  
#def_node_matcher, #def_node_search, #node_search_body


  
  
  
  
  
  
  
  
  
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?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?


  
  
  
  
  
  
  
  
  
Methods included from PathUtil

  
absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path



  
Constructor Details

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

  




  

    
Instance Method Details


    
      

  

  
    #autocorrect(node)  ⇒ Object 
  

  

  




  

    
      


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

    		
    
      
# File 'lib/rubocop/cop/style/special_global_vars.rb', line 99

def autocorrect(node)
  lambda do |corrector|
    global_var, = *node

    while node.parent && node.parent.begin_type? &&
          node.parent.children.one?
      node = node.parent
    end
    parent_type = node.parent && node.parent.type

    if [:dstr, :xstr, :regexp].include?(parent_type)
      if style == :use_english_names
        corrector.replace(node.source_range,
                          "{#{preferred_names(global_var).first}}")
      else
        corrector.replace(node.source_range,
                          "##{preferred_names(global_var).first}")
      end
    else
      corrector.replace(node.source_range,
                        preferred_names(global_var).first.to_s)
    end
  end
end

    		
  





    
      

  

  
    #message(node)  ⇒ Object 
  

  

  




  

    
      


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

    		
    
      
# File 'lib/rubocop/cop/style/special_global_vars.rb', line 73

def message(node)
  global_var, = *node

  if style == :use_english_names
    regular, english = ENGLISH_VARS[global_var].partition do |var|
      NON_ENGLISH_VARS.include? var
    end

    # For now, we assume that lists are 2 items or less. Easy grammar!
    regular_msg = regular.join('` or `')
    english_msg = english.join('` or `')

    if !regular.empty? && !english.empty?
      format(MSG_BOTH, english_msg, regular_msg, global_var)
    elsif !regular.empty?
      format(MSG_REGULAR, regular_msg, global_var)
    elsif !english.empty?
      format(MSG_ENGLISH, english_msg, global_var)
    else
      raise 'Bug in SpecialGlobalVars - global var w/o preferred vars!'
    end
  else
    format(MSG_REGULAR, preferred_names(global_var).first, global_var)
  end
end

    		
  





    
      

  

  
    #on_gvar(node)  ⇒ Object 
  

  

  




  

    
      


60
61
62
63
64
65
66
67
68
69
70
71

    		
    
      
# File 'lib/rubocop/cop/style/special_global_vars.rb', line 60

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