module RuboCop::Cop::MultilineLiteralBraceLayout
Common functionality for checking the closing brace of a literal is either on the same line as the last contained elements, or a new line.
Public Instance Methods
autocorrect(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 19 def autocorrect(node) if closing_brace_on_same_line?(node) lambda do |corrector| corrector.insert_before(node.loc.end, "\n".freeze) end else # When a comment immediately before the closing brace gets in the way # of an easy correction, the offense is reported but not auto- # corrected. The user must handle the delicate decision of where to # put the comment. return if new_line_needed_before_closing_brace?(node) lambda do |corrector| corrector.remove(range_with_surrounding_space(node.loc.end, :left)) corrector.insert_after(last_element_range_with_trailing_comma(node), node.loc.end.source) end end end
check_brace_layout(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 9 def check_brace_layout(node) return if ignored_literal?(node) # If the last node is or contains a conflicting HEREDOC, we don't want # to adjust the brace layout because this will result in invalid code. return if last_line_heredoc?(node.children.last) check(node) end
Private Instance Methods
check(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 55 def check(node) case style when :symmetrical then check_symmetrical(node) when :new_line then check_new_line(node) when :same_line then check_same_line(node) end end
check_new_line(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 63 def check_new_line(node) return unless closing_brace_on_same_line?(node) add_offense(node, location: :end, message: self.class::ALWAYS_NEW_LINE_MESSAGE) end
check_same_line(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 71 def check_same_line(node) return if closing_brace_on_same_line?(node) add_offense(node, location: :end, message: self.class::ALWAYS_SAME_LINE_MESSAGE) end
check_symmetrical(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 79 def check_symmetrical(node) if opening_brace_on_same_line?(node) return if closing_brace_on_same_line?(node) add_offense(node, location: :end, message: self.class::SAME_LINE_MESSAGE) else return unless closing_brace_on_same_line?(node) add_offense(node, location: :end, message: self.class::NEW_LINE_MESSAGE) end end
children(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 120 def children(node) node.children end
closing_brace_on_same_line?(node)
click to toggle source
This method depends on the fact that we have guarded against implicit and empty literals.
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 132 def closing_brace_on_same_line?(node) node.loc.end.line == children(node).last.loc.last_line end
empty_literal?(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 101 def empty_literal?(node) children(node).empty? end
ignored_literal?(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 93 def ignored_literal?(node) implicit_literal?(node) || empty_literal?(node) || node.single_line? end
implicit_literal?(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 97 def implicit_literal?(node) !node.loc.begin end
last_element_range_with_trailing_comma(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 105 def last_element_range_with_trailing_comma(node) trailing_comma_range = last_element_trailing_comma_range(node) if trailing_comma_range children(node).last.source_range.join(trailing_comma_range) else children(node).last.source_range end end
last_element_trailing_comma_range(node)
click to toggle source
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 114 def last_element_trailing_comma_range(node) range = range_with_surrounding_space(children(node).last.source_range, :right).end.resize(1) range.source == ',' ? range : nil end
last_line_heredoc?(node, parent = nil)
click to toggle source
Starting with the parent node and recursively for the parent node's children, check if the node is a HEREDOC and if the HEREDOC ends below or on the last line of the parent node.
Example:
# node is `b: ...` parameter # last_line_heredoc?(node) => false foo(a, b: { a: 1, c: <<-EOM baz EOM } ) # node is `b: ...` parameter # last_line_heredoc?(node) => true foo(a, b: <<-EOM baz EOM )
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 160 def last_line_heredoc?(node, parent = nil) parent ||= node if node.respond_to?(:loc) && node.loc.respond_to?(:heredoc_end) && node.loc.heredoc_end.last_line >= parent.loc.last_line return true end return false unless node.respond_to?(:children) node.children.any? { |child| last_line_heredoc?(child, parent) } end
new_line_needed_before_closing_brace?(node)
click to toggle source
Returns true for the case
[a, b # comment ].some_method
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 47 def new_line_needed_before_closing_brace?(node) return unless node.chained? last_element_line = last_element_range_with_trailing_comma(node).last_line processed_source.comments.any? { |c| c.loc.line == last_element_line } end
opening_brace_on_same_line?(node)
click to toggle source
This method depends on the fact that we have guarded against implicit and empty literals.
# File lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb, line 126 def opening_brace_on_same_line?(node) node.loc.begin.line == children(node).first.loc.first_line end