lib/yard/handlers/ruby/module_function_handler.rb


# frozen_string_literal: true
# Handles module_function calls to turn methods into public class methods.
# Also creates a private instance copy of the method.
class YARD::Handlers::Ruby::ModuleFunctionHandler < YARD::Handlers::Ruby::Base
  include YARD::Handlers::Ruby::DecoratorHandlerMethods

  handles method_call(:module_function)
  namespace_only

  process do
    return if statement.jump(:ident) == statement
    case statement.type
    when :var_ref, :vcall
      self.scope = :module
    when :fcall, :command
      statement[1].traverse do |node|
        case node.type
        when :def
          process_decorator do |instance_method|
            make_module_function(instance_method, namespace)
          end
          break
        when :symbol; name = node.first.source
        when :string_content; name = node.source
        else next
        end

        instance_method = MethodObject.new(namespace, name)
        make_module_function(instance_method, namespace)
      end
    end
  end

  def make_module_function(instance_method, namespace)
    class_method = MethodObject.new(namespace, instance_method.name, :module)
    instance_method.copy_to(class_method)
    class_method.visibility = :public
  end
end