Class: RuboCop::Cop::Rails::SafeNavigation

Inherits:
Cop
  • Object
show all
Includes:
RuboCop::Cop::RangeHelp
Defined in:
lib/rubocop/cop/rails/safe_navigation.rb

Overview

This cop converts usages of ‘try!` to `&.`. It can also be configured to convert `try`. It will convert code to use safe navigation.

Examples:

# ConvertTry: false
  # bad
  foo.try!(:bar)
  foo.try!(:bar, baz)
  foo.try!(:bar) { |e| e.baz }

  foo.try!(:[], 0)

  # good
  foo.try(:bar)
  foo.try(:bar, baz)
  foo.try(:bar) { |e| e.baz }

  foo&.bar
  foo&.bar(baz)
  foo&.bar { |e| e.baz }

# ConvertTry: true
  # bad
  foo.try!(:bar)
  foo.try!(:bar, baz)
  foo.try!(:bar) { |e| e.baz }
  foo.try(:bar)
  foo.try(:bar, baz)
  foo.try(:bar) { |e| e.baz }

  # good
  foo&.bar
  foo&.bar(baz)
  foo&.bar { |e| e.baz }

Constant Summary collapse

MSG = 
'Use safe navigation (`&.`) instead of `%<try>s`.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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

#s

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 



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/rubocop/cop/rails/safe_navigation.rb', line 59

def autocorrect(node)
  method_node, *params = *node.arguments
  method = method_node.source[1..-1]

  range = range_between(node.loc.dot.begin_pos,
                        node.loc.expression.end_pos)

  lambda do |corrector|
    corrector.replace(range, replacement(method, params))
  end
end

#on_send(node) ⇒ Object 



50
51
52
53
54
55
56
57
 
# File 'lib/rubocop/cop/rails/safe_navigation.rb', line 50

def on_send(node)
  try_call(node) do |try_method, dispatch|
    return if try_method == :try && !cop_config['ConvertTry']
    return unless dispatch.sym_type? && dispatch.value =~ /\w+[=!?]?/

    add_offense(node, message: format(MSG, try: try_method))
  end
end