Class: RuboCop::Cop::Style::Alias
- Includes:
- ConfigurableEnforcedStyle
- Defined in:
- lib/rubocop/cop/style/alias.rb
Overview
This cop enforces the use of either ‘#alias` or `#alias_method` depending on configuration. It also flags uses of `alias :symbol` rather than `alias bareword`.
Constant Summary collapse
- MSG_ALIAS =
'Use `alias_method` instead of `alias`.'
- MSG_ALIAS_METHOD =
'Use `alias` instead of `alias_method` ' \ '%<current>s.'
- MSG_SYMBOL_ARGS =
'Use `alias %<prefer>s` instead of ' \ '`alias %<current>s`.'
Constants included from Util
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, 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 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, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character
Methods included from PathUtil
absolute?, chdir, 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
52 53 54 55 56 57 58 59 60 |
# File 'lib/rubocop/cop/style/alias.rb', line 52 def autocorrect(node) if node.send_type? correct_alias_method_to_alias(node) elsif scope_type(node) == :dynamic || style == :prefer_alias_method correct_alias_to_alias_method(node) else correct_alias_with_symbol_args(node) end end |
#on_alias(node) ⇒ Object
42 43 44 45 46 47 48 49 50 |
# File 'lib/rubocop/cop/style/alias.rb', line 42 def on_alias(node) return unless alias_method_possible?(node) if scope_type(node) == :dynamic || style == :prefer_alias_method add_offense(node, location: :keyword, message: MSG_ALIAS) elsif node.children.none? { |arg| (arg) } add_offense_for_args(node) end end |
#on_send(node) ⇒ Object
34 35 36 37 38 39 40 |
# File 'lib/rubocop/cop/style/alias.rb', line 34 def on_send(node) return unless node.command?(:alias_method) return unless style == :prefer_alias && alias_keyword_possible?(node) msg = format(MSG_ALIAS_METHOD, current: lexical_scope_type(node)) add_offense(node, location: :selector, message: msg) end |