module RuboCop::Cop::TrailingComma
Common methods shared by Style/TrailingCommaInArguments and Style/TrailingCommaInLiteral
Constants
- MSG
Private Instance Methods
allowed_multiline_argument?(node)
click to toggle source
A single argument with the closing bracket on the same line as the end of the argument is not considered multiline, even if the argument itself might span multiple lines.
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 102 def allowed_multiline_argument?(node) elements(node).one? && !Util.begins_its_line?(node.loc.end) end
any_heredoc?(items)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 172 def any_heredoc?(items) items.any? { |item| heredoc?(item) } end
autocorrect_range(item)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 159 def autocorrect_range(item) expr = item.source_range ix = expr.source.rindex("\n") || 0 ix += expr.source[ix..-1] =~ /\S/ range_between(expr.begin_pos + ix, expr.end_pos) end
avoid_autocorrect?(_nodes)
click to toggle source
By default, there's no reason to avoid auto-correct.
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 168 def avoid_autocorrect?(_nodes) false end
avoid_comma(kind, comma_begin_pos, extra_info)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 131 def avoid_comma(kind, comma_begin_pos, extra_info) range = range_between(comma_begin_pos, comma_begin_pos + 1) article = kind =~ /array/ ? 'an' : 'a' msg = format( MSG, command: 'Avoid', unit: format(kind, article: article) + extra_info.to_s ) add_offense(range, location: range, message: msg) end
brackets?(node)
click to toggle source
Returns true if the node has round/square/curly brackets.
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 82 def brackets?(node) node.loc.end end
check(node, items, kind, begin_pos, end_pos)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 19 def check(node, items, kind, begin_pos, end_pos) after_last_item = range_between(begin_pos, end_pos) # If there is any heredoc in items, then match the comma succeeding # any whitespace (except newlines), otherwise allow for newlines comma_regex = any_heredoc?(items) ? /\A[^\S\n]*,/ : /\A\s*,/ comma_offset = after_last_item.source =~ comma_regex && after_last_item.source.index(',') if comma_offset && !inside_comment?(after_last_item, comma_offset) check_comma(node, kind, after_last_item.begin_pos + comma_offset) elsif should_have_comma?(style, node) put_comma(node, items, kind) end end
check_comma(node, kind, comma_pos)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 35 def check_comma(node, kind, comma_pos) return if should_have_comma?(style, node) avoid_comma(kind, comma_pos, extra_avoid_comma_info) end
check_literal(node, kind)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 41 def check_literal(node, kind) return if node.children.empty? # A braceless hash is the last parameter of a method call and will be # checked as such. return unless brackets?(node) check(node, node.children, kind, node.children.last.source_range.end_pos, node.loc.end.begin_pos) end
elements(node)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 106 def elements(node) return node.children unless %i[csend send].include?(node.type) node.arguments.flat_map do |argument| # For each argument, if it is a multi-line hash without braces, # then promote the hash elements to method arguments # for the purpose of determining multi-line-ness. if argument.hash_type? && argument.multiline? && !argument.braces? argument.children else argument end end end
extra_avoid_comma_info()
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 52 def extra_avoid_comma_info case style when :comma ', unless each item is on its own line' when :consistent_comma ', unless items are split onto multiple lines' else '' end end
heredoc?(node)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 176 def heredoc?(node) return false unless node.is_a?(RuboCop::AST::Node) return true if node.loc.respond_to?(:heredoc_body) return heredoc_send?(node) if node.send_type? # handle hash values # # some_method({ # 'auth' => <<-SOURCE # ... # SOURCE # }) if node.pair_type? || node.hash_type? return heredoc?(node.children.last) end false end
heredoc_send?(node)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 196 def heredoc_send?(node) # handle heredocs with methods # # some_method(<<-CODE.strip.chomp) # ... # CODE return heredoc?(node.children.first) if node.children.size == 2 # handle nested methods # # some_method( # another_method(<<-CODE.strip.chomp) # ... # CODE # ) return heredoc?(node.children.last) if node.children.size > 2 false end
inside_comment?(range, comma_offset)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 74 def inside_comment?(range, comma_offset) processed_source.comments.any? do |comment| comment_offset = comment.loc.expression.begin_pos - range.begin_pos comment_offset >= 0 && comment_offset < comma_offset end end
method_name_and_arguments_on_same_line?(node)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 93 def method_name_and_arguments_on_same_line?(node) %i[send csend].include?(node.type) && node.loc.selector.line == node.arguments.last.last_line && node.last_line == node.arguments.last.last_line end
multiline?(node)
click to toggle source
Returns true if the round/square/curly brackets of the given node are on different lines, each item within is on its own line, and the closing bracket is on its own line.
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 89 def multiline?(node) node.multiline? && !allowed_multiline_argument?(node) end
no_elements_on_same_line?(node)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 121 def no_elements_on_same_line?(node) items = elements(node).map(&:source_range) items << node.loc.end items.each_cons(2).none? { |a, b| on_same_line?(a, b) } end
on_same_line?(range1, range2)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 127 def on_same_line?(range1, range2) range1.last_line == range2.line end
put_comma(node, items, kind)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 143 def put_comma(node, items, kind) return if avoid_autocorrect?(elements(node)) last_item = items.last return if last_item.block_pass_type? range = autocorrect_range(last_item) msg = format( MSG, command: 'Put a', unit: format(kind, article: 'a multiline') ) add_offense(range, location: range, message: msg) end
should_have_comma?(style, node)
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 63 def should_have_comma?(style, node) case style when :comma multiline?(node) && no_elements_on_same_line?(node) when :consistent_comma multiline?(node) && !method_name_and_arguments_on_same_line?(node) else false end end
style_parameter_name()
click to toggle source
# File lib/rubocop/cop/mixin/trailing_comma.rb, line 15 def style_parameter_name 'EnforcedStyleForMultiline' end