Sha256: 882ba3570fc880a6645e7f72bf49931190878a47f85777a9899d645d1571d367
Contents?: true
Size: 1.96 KB
Versions: 24
Compression:
Stored size: 1.96 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# This cop checks for single-line method definitions that contain a body.
# It will accept single-line methods with no body.
#
# @example
# # bad
# def some_method; body end
# def link_to(url); {:name => url}; end
# def @table.columns; super; end
#
# # good
# def no_op; end
# def self.resource_class=(klass); end
# def @table.columns; end
#
class SingleLineMethods < Cop
include Alignment
MSG = 'Avoid single-line method definitions.'
def on_def(node)
return unless node.single_line?
return if allow_empty? && !node.body
add_offense(node)
end
alias on_defs on_def
def autocorrect(node)
lambda do |corrector|
each_part(node.body) do |part|
LineBreakCorrector.break_line_before(
range: part, node: node, corrector: corrector,
configured_width: configured_indentation_width
)
end
LineBreakCorrector.break_line_before(
range: node.loc.end, node: node, corrector: corrector,
indent_steps: 0, configured_width: configured_indentation_width
)
move_comment(node, corrector)
end
end
private
def allow_empty?
cop_config['AllowIfMethodIsEmpty']
end
def each_part(body)
return unless body
if body.begin_type?
body.each_child_node { |part| yield part.source_range }
else
yield body.source_range
end
end
def move_comment(node, corrector)
LineBreakCorrector.move_comment(
eol_comment: end_of_line_comment(node.source_range.line),
node: node, corrector: corrector
)
end
end
end
end
end
Version data entries
24 entries across 16 versions & 2 rubygems