Class: RuboCop::Cop::Style::NestedModifier
- Inherits:
-
Cop
- Object
- Cop
- RuboCop::Cop::Style::NestedModifier
show all
- Includes:
- RangeHelp
- Defined in:
- lib/rubocop/cop/style/nested_modifier.rb
Overview
This cop checks for nested use of if, unless, while and until in their modifier form.
Constant Summary
collapse
- MSG =
'Avoid using nested modifiers.'
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
#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first
#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?
#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
Instance Method Details
#autocorrect(node) ⇒ Object
45
46
47
48
49
50
51
52
53
54
|
# File 'lib/rubocop/cop/style/nested_modifier.rb', line 45
def autocorrect(node)
return unless node.if_type? && node.parent.if_type?
range = range_between(node.loc.keyword.begin_pos,
node.parent.condition.source_range.end_pos)
lambda do |corrector|
corrector.replace(range, new_expression(node.parent, node))
end
end
|
#check(node) ⇒ Object
33
34
35
36
37
38
39
|
# File 'lib/rubocop/cop/style/nested_modifier.rb', line 33
def check(node)
return if part_of_ignored_node?(node)
return unless modifier?(node) && modifier?(node.parent)
add_offense(node, location: :keyword)
ignore_node(node)
end
|
#left_hand_operand(node, operator) ⇒ Object
68
69
70
71
72
73
|
# File 'lib/rubocop/cop/style/nested_modifier.rb', line 68
def left_hand_operand(node, operator)
expr = node.condition.source
expr = "(#{expr})" if node.condition.or_type? &&
operator == '&&'
expr
end
|
#modifier?(node) ⇒ Boolean
41
42
43
|
# File 'lib/rubocop/cop/style/nested_modifier.rb', line 41
def modifier?(node)
node&.basic_conditional? && node&.modifier_form?
end
|
#new_expression(outer_node, inner_node) ⇒ Object
56
57
58
59
60
61
62
|
# File 'lib/rubocop/cop/style/nested_modifier.rb', line 56
def new_expression(outer_node, inner_node)
operator = replacement_operator(outer_node.keyword)
lh_operand = left_hand_operand(outer_node, operator)
rh_operand = right_hand_operand(inner_node, outer_node.keyword)
"#{outer_node.keyword} #{lh_operand} #{operator} #{rh_operand}"
end
|
#on_if(node) ⇒ Object
29
30
31
|
# File 'lib/rubocop/cop/style/nested_modifier.rb', line 29
def on_if(node)
check(node)
end
|
#on_until(node) ⇒ Object
25
26
27
|
# File 'lib/rubocop/cop/style/nested_modifier.rb', line 25
def on_until(node)
check(node)
end
|
#on_while(node) ⇒ Object
21
22
23
|
# File 'lib/rubocop/cop/style/nested_modifier.rb', line 21
def on_while(node)
check(node)
end
|
#replacement_operator(keyword) ⇒ Object
64
65
66
|
# File 'lib/rubocop/cop/style/nested_modifier.rb', line 64
def replacement_operator(keyword)
keyword == 'if' ? '&&' : '||'
end
|
#requires_parens?(node) ⇒ Boolean
82
83
84
85
|
# File 'lib/rubocop/cop/style/nested_modifier.rb', line 82
def requires_parens?(node)
node.or_type? ||
!(RuboCop::AST::Node::COMPARISON_OPERATORS & node.children).empty?
end
|
#right_hand_operand(node, left_hand_keyword) ⇒ Object
75
76
77
78
79
80
|
# File 'lib/rubocop/cop/style/nested_modifier.rb', line 75
def right_hand_operand(node, left_hand_keyword)
expr = node.condition.source
expr = "(#{expr})" if requires_parens?(node.condition)
expr = "!#{expr}" unless left_hand_keyword == node.keyword
expr
end
|