class RuboCop::Cop::Style::ClassMethodsDefinitions
end
end
end
# …
def class_method
class << self
class SomeClass
# good
end
end
# …
def self.class_method
class SomeClass
# bad
@example EnforcedStyle: self_class
end
end
end
# …
def private_class_method
private
attr_accessor :class_accessor
class << self
class SomeClass
# good - contains private method
end
end
attr_accessor :class_accessor
class << self
end
# …
def self.class_method
class SomeClass
# good
end
end
end
# …
def class_method
attr_accessor :class_accessor
class << self
class SomeClass
# bad
@example EnforcedStyle: def_self (default)
Enforces using ‘def self.method_name` or `class << self` to define class methods.
def all_methods_public?(sclass_node)
def all_methods_public?(sclass_node) def_nodes = def_nodes(sclass_node) return false if def_nodes.empty? def_nodes.all? { |def_node| node_visibility(def_node) == :public } end
def autocorrect_sclass(node, corrector)
def autocorrect_sclass(node, corrector) rewritten_defs = [] def_nodes(node).each do |def_node| next unless node_visibility(def_node) == :public range, source = extract_def_from_sclass(def_node, node) corrector.remove(range) rewritten_defs << source end if sclass_only_has_methods?(node) corrector.remove(node) rewritten_defs.first&.strip! else corrector.insert_after(node, "\n") end corrector.insert_after(node, rewritten_defs.join("\n")) end
def def_nodes(sclass_node)
def def_nodes(sclass_node) sclass_def = sclass_node.body return [] unless sclass_def if sclass_def.def_type? [sclass_def] elsif sclass_def.begin_type? sclass_def.each_child_node(:def).to_a else [] end end
def def_self_style?
def def_self_style? style == :def_self end
def extract_def_from_sclass(def_node, sclass_node)
def extract_def_from_sclass(def_node, sclass_node) range = source_range_with_comment(def_node) source = range.source.sub!( "def #{def_node.method_name}", "def self.#{def_node.method_name}" ) source = source.gsub(/^ {#{indentation_diff(def_node, sclass_node)}}/, '') [range, source.chomp] end
def indentation_diff(node1, node2)
def indentation_diff(node1, node2) node1.loc.column - node2.loc.column end
def on_defs(node)
def on_defs(node) return if def_self_style? return unless node.receiver.self_type? message = format(MSG, preferred: 'class << self') add_offense(node, message: message) end
def on_sclass(node)
def on_sclass(node) return unless def_self_style? return unless node.identifier.self_type? return unless all_methods_public?(node) add_offense(node, message: MSG_SCLASS) do |corrector| autocorrect_sclass(node, corrector) end end
def sclass_only_has_methods?(node)
def sclass_only_has_methods?(node) node.body.def_type? || node.body.each_child_node.all?(&:def_type?) end