Module: RuboCop::Cop::Style::MethodCallWithArgsParentheses::OmitParentheses
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
|
|
Defined in: | lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb |
Overview
Style omit_parentheses Metrics/CyclomaticComplexity
Constant Summary
-
OMIT_MSG =
private
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 13'Omit parentheses for method calls with arguments.'
-
TRAILING_WHITESPACE_REGEX =
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 12/\s+\Z/.freeze
::RuboCop::Cop::RangeHelp
- Included
Instance Method Summary
- #allowed_camel_case_method_call?(node) ⇒ Boolean private
- #allowed_chained_call_with_parentheses?(node) ⇒ Boolean private
- #allowed_multiline_call_with_parentheses?(node) ⇒ Boolean private
- #allowed_string_interpolation_method_call?(node) ⇒ Boolean private
- #ambiguous_literal?(node) ⇒ Boolean private
- #assigned_before?(node, target) ⇒ Boolean private
- #assignment_in_condition?(node) ⇒ Boolean private
- #autocorrect(corrector, node) private
- #call_as_argument_or_chain?(node) ⇒ Boolean private
- #call_in_argument_with_block?(node) ⇒ Boolean private
- #call_in_literals?(node) ⇒ Boolean private
- #call_in_logical_operators?(node) ⇒ Boolean private
- #call_in_match_pattern?(node) ⇒ Boolean private
- #call_in_optional_arguments?(node) ⇒ Boolean private
- #call_in_single_line_inheritance?(node) ⇒ Boolean private
- #call_with_ambiguous_arguments?(node) ⇒ Boolean private
- #call_with_braced_block?(node) ⇒ Boolean private
- #forwards_anonymous_rest_arguments?(node) ⇒ Boolean private
- #hash_literal?(node) ⇒ Boolean private
- #hash_literal_in_arguments?(node) ⇒ Boolean private
- #inside_endless_method_def?(node) ⇒ Boolean private
- #inside_string_interpolation?(node) ⇒ Boolean private
-
#last_expression?(node) ⇒ Boolean
private
Require hash value omission be enclosed in parentheses to prevent the following issue: https://bugs.ruby-lang.org/issues/18396.
- #legitimate_call_with_parentheses?(node) ⇒ Boolean private
- #logical_operator?(node) ⇒ Boolean private
- #method_call_before_constant_resolution?(node) ⇒ Boolean private
- #offense_range(node) private
- #omit_parentheses(node) private
- #parentheses_at_the_end_of_multiline_call?(node) ⇒ Boolean private
- #regexp_slash_literal?(node) ⇒ Boolean private
- #require_parentheses_for_hash_value_omission?(node) ⇒ Boolean private
- #splat?(node) ⇒ Boolean private
- #super_call_without_arguments?(node) ⇒ Boolean private
- #syntax_like_method_call?(node) ⇒ Boolean private
- #ternary_if?(node) ⇒ Boolean private
- #unary_literal?(node) ⇒ Boolean private
::RuboCop::Cop::RangeHelp
- Included
#add_range, #column_offset_between, | |
#contents_range | A range containing only the contents of a literal with delimiters (e.g. |
#directions, | |
#effective_column | Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value. |
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range |
Instance Method Details
#allowed_camel_case_method_call?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 80
def allowed_camel_case_method_call?(node) node.camel_case_method? && (node.arguments.none? || cop_config['AllowParenthesesInCamelCaseMethod']) end
#allowed_chained_call_with_parentheses?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 184
def allowed_chained_call_with_parentheses?(node) return false unless cop_config['AllowParenthesesInChaining'] previous = node.descendants.first return false unless previous&.send_type? previous.parenthesized? || allowed_chained_call_with_parentheses?(previous) end
#allowed_multiline_call_with_parentheses?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 180
def allowed_multiline_call_with_parentheses?(node) cop_config['AllowParenthesesInMultilineCall'] && node.multiline? end
#allowed_string_interpolation_method_call?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 85
def allowed_string_interpolation_method_call?(node) cop_config['AllowParenthesesInStringInterpolation'] && inside_string_interpolation?(node) end
#ambiguous_literal?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 193
def ambiguous_literal?(node) splat?(node) || ternary_if?(node) || regexp_slash_literal?(node) || unary_literal?(node) end
#assigned_before?(node, target) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 222
def assigned_before?(node, target) node.assignment? && node.loc.operator.begin < target.loc.begin end
#assignment_in_condition?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 230
def assignment_in_condition?(node) parent = node.parent return false unless parent grandparent = parent.parent return false unless grandparent parent.assignment? && (grandparent.conditional? || grandparent.when_type?) end
#autocorrect(corrector, node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 34
def autocorrect(corrector, node) range = args_begin(node) if parentheses_at_the_end_of_multiline_call?(node) # Whitespace after line continuation (`\ `) is a syntax error with_whitespace = range_with_surrounding_space(range, side: :right, newlines: false) corrector.replace(with_whitespace, ' \\') else corrector.replace(range, ' ') end corrector.remove(node.loc.end) end
#call_as_argument_or_chain?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 161
def call_as_argument_or_chain?(node) node.parent && (node.parent.call_type? || node.parent.super_type? || node.parent.yield_type?) && !assigned_before?(node.parent, node) end
#call_in_argument_with_block?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 154
def call_in_argument_with_block?(node) parent = node.parent&.block_type? && node.parent.parent return false unless parent parent.call_type? || parent.super_type? || parent.yield_type? end
#call_in_literals?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 110
def call_in_literals?(node) parent = node.parent&.block_type? ? node.parent.parent : node.parent return false unless parent parent.pair_type? || parent.array_type? || parent.range_type? || splat?(parent) || ternary_if?(parent) end
#call_in_logical_operators?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 121
def call_in_logical_operators?(node) parent = node.parent&.block_type? ? node.parent.parent : node.parent return false unless parent logical_operator?(parent) || (parent.send_type? && parent.arguments.any? { |argument| logical_operator?(argument) }) end
#call_in_match_pattern?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 167
def call_in_match_pattern?(node) return false unless (parent = node.parent) parent.match_pattern_type? || parent.match_pattern_p_type? end
#call_in_optional_arguments?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 130
def call_in_optional_arguments?(node) node.parent && (node.parent.optarg_type? || node.parent.kwoptarg_type?) end
#call_in_single_line_inheritance?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 134
def call_in_single_line_inheritance?(node) node.parent&.class_type? && node.parent.single_line? end
#call_with_ambiguous_arguments?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 138
def call_with_ambiguous_arguments?(node) # rubocop:disable Metrics/PerceivedComplexity call_with_braced_block?(node) || call_in_argument_with_block?(node) || call_as_argument_or_chain?(node) || call_in_match_pattern?(node) || hash_literal_in_arguments?(node) || node.descendants.any? do |n| n.forwarded_args_type? || n.block_type? || n.numblock_type? || ambiguous_literal?(n) || logical_operator?(n) end end
#call_with_braced_block?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 150
def call_with_braced_block?(node) (node.call_type? || node.super_type?) && node.block_node&.braces? end
#forwards_anonymous_rest_arguments?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 240
def forwards_anonymous_rest_arguments?(node) return false unless (last_argument = node.last_argument) return true if last_argument.forwarded_restarg_type? last_argument.hash_type? && last_argument.children.first&.forwarded_kwrestarg_type? end
#hash_literal?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 209
def hash_literal?(node) node.hash_type? && node.braces? end
#hash_literal_in_arguments?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 173
def hash_literal_in_arguments?(node) node.arguments.any? do |n| hash_literal?(n) || (n.send_type? && node.descendants.any? { |descendant| hash_literal?(descendant) }) end end
#inside_endless_method_def?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 50
def inside_endless_method_def?(node) # parens are required around arguments inside an endless method node.each_ancestor(:def, :defs).any?(&:endless?) && node.arguments.any? end
#inside_string_interpolation?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 226
def inside_string_interpolation?(node) node.ancestors.drop_while { |a| !a.begin_type? }.any?(&:dstr_type?) end
#last_expression?(node) ⇒ Boolean
(private)
Require hash value omission be enclosed in parentheses to prevent the following issue: https://bugs.ruby-lang.org/issues/18396.
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 64
def last_expression?(node) !(node.parent&.assignment? ? node.parent.right_sibling : node.right_sibling) end
#legitimate_call_with_parentheses?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 97
def legitimate_call_with_parentheses?(node) # rubocop:disable Metrics/PerceivedComplexity call_in_literals?(node) || node.parent&.when_type? || call_with_ambiguous_arguments?(node) || call_in_logical_operators?(node) || call_in_optional_arguments?(node) || call_in_single_line_inheritance?(node) || allowed_multiline_call_with_parentheses?(node) || allowed_chained_call_with_parentheses?(node) || assignment_in_condition?(node) || forwards_anonymous_rest_arguments?(node) end
#logical_operator?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 205
def logical_operator?(node) node.operator_keyword? && node.logical_operator? end
#method_call_before_constant_resolution?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 72
def method_call_before_constant_resolution?(node) node.parent&.const_type? end
#offense_range(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 46
def offense_range(node) node.loc.begin.join(node.loc.end) end
#omit_parentheses(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 18
def omit_parentheses(node) # rubocop:disable Metrics/PerceivedComplexity return unless node.parenthesized? return if inside_endless_method_def?(node) return if require_parentheses_for_hash_value_omission?(node) return if syntax_like_method_call?(node) return if method_call_before_constant_resolution?(node) return if super_call_without_arguments?(node) return if legitimate_call_with_parentheses?(node) return if allowed_camel_case_method_call?(node) return if allowed_string_interpolation_method_call?(node) add_offense(offense_range(node), message: OMIT_MSG) do |corrector| autocorrect(corrector, node) end end
#parentheses_at_the_end_of_multiline_call?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 90
def parentheses_at_the_end_of_multiline_call?(node) node.multiline? && node.loc.begin.source_line .gsub(TRAILING_WHITESPACE_REGEX, '') .end_with?('(') end
#regexp_slash_literal?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 213
def regexp_slash_literal?(node) node.regexp_type? && node.loc.begin.source == '/' end
#require_parentheses_for_hash_value_omission?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 55
def require_parentheses_for_hash_value_omission?(node) # rubocop:disable Metrics/PerceivedComplexity return false unless (last_argument = node.last_argument) return false if !last_argument.hash_type? || !last_argument.pairs.last&.value_omission? node.parent&.conditional? || node.parent&.single_line? || !last_expression?(node) end
#splat?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 197
def splat?(node) node.splat_type? || node.kwsplat_type? || node.block_pass_type? end
#super_call_without_arguments?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 76
def super_call_without_arguments?(node) node.super_type? && node.arguments.none? end
#syntax_like_method_call?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 68
def syntax_like_method_call?(node) node.implicit_call? || node.operator_method? end
#ternary_if?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 201
def ternary_if?(node) node.if_type? && node.ternary? end
#unary_literal?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb', line 217
def unary_literal?(node) (node.numeric_type? && node.sign?) || (node.parent&.send_type? && node.parent.unary_operation?) end