Class: Shaf::Yard::BaseMethodHandler

Inherits:
YARD::Handlers::Ruby::Base
  • Object
show all
Defined in:
lib/shaf/yard/base_method_handler.rb

Instance Method Summary collapse

Instance Method Details

#nameObject



14
15
16
17
18
19
# File 'lib/shaf/yard/base_method_handler.rb', line 14

def name
  call_params.first.yield_self do |name|
    # remove single colon. Sometimes symbols get the :, (e.g. :self)
    name.sub(/\A:(?!:)/, '')
  end
end

#objectObject

Raises:

  • (NotImplementedError)


21
22
23
# File 'lib/shaf/yard/base_method_handler.rb', line 21

def object
  raise NotImplementedError, "#{self} must implement #object"
end

#processObject



8
9
10
11
12
# File 'lib/shaf/yard/base_method_handler.rb', line 8

def process
  return unless serializer_namespace

  register object
end

#serializer_namespaceObject



25
26
27
# File 'lib/shaf/yard/base_method_handler.rb', line 25

def serializer_namespace
  @serializer_namespace ||= YARD::Registry.at ResourceObject.path(namespace)
end