Class: SleepingKingStudios::Docs::Data::NamespaceObject

Parent Namespace

SleepingKingStudios::Docs::Data

Inherited Classes

SleepingKingStudios::Docs::Data::Base > Object

Defined In

lib/sleeping_king_studios/docs/data/namespace_object.rb

Table Of Contents

• Overview
  • See Also
• Direct Subclasses
• Constructor
• Instance Methods
  • as_json
  • class_attributes
  • class_methods
  • constants
  • defined_classes
  • defined_modules
  • initialize
  • instance_attributes
  • instance_methods
  • name
  • slug
  • type

Overview

Object representing a Ruby namespace.

Each namespace can define the following elements:

• Definitions (classes and modules).
• Constants.
• Class attributes.
• Class methods.
• Instance attributes.
• Instance methods.

In most cases, there should be one documented namespace, reflecting the top-level namespace, and in most cases should only include defined classes and/or modules. Top-level constants may be required on a case-by-case basis.

All other namespace properties (attributes and methods) should be reserved for classes and modules, whose representation inherits from NamespaceObject.

See Also

• SleepingKingStudios::Docs::Data::ClassObject
• SleepingKingStudios::Docs::Data::ModuleObject
• SleepingKingStudios::Docs::Data::RootObject

Back To Top

Direct Subclasses

SleepingKingStudios::Docs::Data::ModuleObject, SleepingKingStudios::Docs::Data::RootObject

Back To Top

Constructor

#initialize(native:) => Base

Inherited From

SleepingKingStudios::Docs::Data::Base

Parameters

• native (YARD::Tags::Tag) — the YARD object representing the documented object.

Returns

• (Base) — a new instance of Base

Back To Top

Instance Methods

#as_json => Hash{String => Object}

Generates a JSON-compatible representation of the namespace.

Returns a Hash with the following keys:

• ‘name’: The full, qualified name of the namespace.
• ‘slug’: The name of the namespace in url-safe format.

Additionally, the returned Hash will conditionally include the following keys, if the namespace defines at least one of the corresponding code objects.

• ‘class_attributes’: The class attributes, if any.
• ‘class_methods’: The class methods, if any.
• ‘constants’: The constants, if any.
• ‘defined_classes’: The defined Classes, if any.
• ‘defined_modules’: The defined Modules, if any.
• ‘instance_attributes’: The instance attributes, if any.
• ‘instance_methods’: The instance methods, if any.

Returns

• (Hash{String => Object}) — the representation of the namespace.

#class_attributes => Array<Hash>

Finds the class attributes defined for the namespace.

For each class attribute, it returns a Hash with the following keys:

• ‘name’: The name of the attribute.
• ‘read’: True if the attribute defines a reader method.
• ‘write’: True if the attribute defines a writer method.
• ‘path’: The path to the reader method data file, or the writer method data file if the attribute does not define a reader method.

Returns

• (Array<Hash>) — the class attributes.

#class_methods => Array<Hash{String => String}>

Finds the class methods defined for the namespace.

For each method, it returns a Hash with the following keys:

• ‘name’: The name of the method, including trailing characters such as =' or ?’.
• ‘path’: The path to the method data file.

Returns

• (Array<Hash{String => String}>) — the documented class methods.

#constants => Array<String>

Finds the names of the constants defined under this namespace.

Returns

• (Array<String>) — the names of the constants.

#defined_classes => Array<Hash>

Finds the Classes defined under this namespace, if any.

For each defined Class, it returns a Hash with the following keys:

• ‘name’: The name of the defined Class.
• ‘slug’: A url-safe, hyphen-separated representation of the name.

Examples

# Given a class LaunchWindow in the namespace Space::Operations:
namespace.name
#=> 'Space::Operations'
namespace.defined_classes
#=> [{ 'name' => 'LaunchWindow', 'slug' => 'launch-window' }]

Returns

• (Array<Hash>) — the defined classes.

#defined_modules => Array<Hash>

Finds the Modules defined under this namespace, if any.

For each defined Module, it returns a Hash with the following keys:

• ‘name’: The name of the defined Module.
• ‘slug’: A url-safe, hyphen-separated representation of the name.

Examples

# Given a class FuelConsumer in the namespace Space::Engineering:
namespace.name
#=> 'Space::Engineering'
namespace.defined_classes
#=> [{ 'name' => 'FuelConsumer', 'slug' => 'fuel-consumer' }]

Returns

• (Array<Hash>) — the defined modules.

#instance_attributes => Array<Hash>

Finds the instance attributes defined for the namespace.

For each instance attribute, it returns a Hash with the following keys:

• ‘name’: The name of the attribute.
• ‘read’: True if the attribute defines a reader method.
• ‘write’: True if the attribute defines a writer method.
• ‘path’: The path to the reader method data file, or the writer method data file if the attribute does not define a reader method.

Returns

• (Array<Hash>) — the instance attributes.

#instance_methods => Array<Hash{String => String}>

Finds the instance methods defined for the namespace.

For each method, it returns a Hash with the following keys:

• ‘name’: The name of the method, including trailing characters such as =' or ?’.
• ‘path’: The path to the method data file.

Returns

• (Array<Hash{String => String}>) — the documented instance methods.

#name => String

The full, qualified name of the namespace.

For the root namespace, should return an empty string. For a Class or a Module, should return the full name, e.g. “MyGem::MyModule::MyClass”.

Returns

• (String) — the qualified name.

#slug => String

The name of the namespace in url-safe format.

Returns

• (String) — the namespace name.

#type => String

Returns

• (String) — the type of the namespace.

Back To Top

---

Back to Documentation | Versions | 0.2 | Reference | SleepingKingStudios | SleepingKingStudios::Docs | SleepingKingStudios::Docs::Data