Class: Jsapi::Meta::BaseReference

Inherits:

Base

• Object
• Base
• Jsapi::Meta::BaseReference

Defined in:

lib/jsapi/meta/base_reference.rb

Direct Known Subclasses

Example::Reference, OpenAPI::Callback::Reference, OpenAPI::Link::Reference, Parameter::Reference, RequestBody::Reference, Response::Reference, Schema::Reference

Class Method Summary

• .lookup_method_name ⇒ Object

  Returns the name of the method to be invoked to look up the referred object in a Definitions instance.

Instance Method Summary

• #ref ⇒ Object

  :attr: ref The name of the referred object.

• #reference? ⇒ Boolean

  :nodoc:.

• #resolve(definitions) ⇒ Object

  Resolves ref by looking up the object with that name in definitions.

Methods inherited from Base

#initialize, #inspect

Methods included from Attributes::ClassMethods

#attribute, #attribute_names

Constructor Details

This class inherits a constructor from Jsapi::Meta::Base

Class Method Details

.lookup_method_name ⇒ Object

Returns the name of the method to be invoked to look up the referred object in a Definitions instance.

# File 'lib/jsapi/meta/base_reference.rb', line 13

def self.lookup_method_name
  @lookup_method_name ||=
    name.delete_suffix('::Reference').demodulize.underscore
end

Instance Method Details

#ref ⇒ Object

:attr: ref The name of the referred object.

# File 'lib/jsapi/meta/base_reference.rb', line 9

attribute :ref, String

#reference? ⇒ Boolean

:nodoc:

Returns:

• (Boolean)

# File 'lib/jsapi/meta/base_reference.rb', line 18

def reference? # :nodoc:
  true
end

#resolve(definitions) ⇒ Object

Resolves ref by looking up the object with that name in definitions.

Raises a ReferenceError if ref could not be resolved.

Raises:

• (ReferenceError)

# File 'lib/jsapi/meta/base_reference.rb', line 25

def resolve(definitions)
  object = definitions.send(self.class.lookup_method_name, ref)
  raise ReferenceError, ref if object.nil?

  object.resolve(definitions)
end