Class: OpenGraphReader::Object::Registry Private

Inherits:

Object

• Object
• OpenGraphReader::Object::Registry

Extended by:

Forwardable

Includes:

Singleton

Defined in:

lib/open_graph_reader/object/registry.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Global registry of namespaces and their representing classes. Also tracks which verticals are defined.

API:

• private

Instance Attribute Summary

• #verticals ⇒ Object readonly private

Class Method Summary

• .[](namespace) ⇒ Class private

  Fetch the class associated with the given namespace.

• .register(namespace, klass) ⇒ Object private

  Register a new namespace in the registry.

• .registered?(namespace) ⇒ Bool private

  Check whether a namespace is registered.

• .verticals ⇒ Set<String>

  All known verticals.

Instance Method Summary

• #[](namespace) ⇒ Object private
• #initialize ⇒ Registry constructor private

  A new instance of Registry.

Constructor Details

#initialize ⇒ Registry

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Registry.

API:

• private

# File 'lib/open_graph_reader/object/registry.rb', line 51

def initialize
  @namespaces = {}
  @verticals = Set.new
end

Instance Attribute Details

#verticals ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:

• verticals

API:

• private

# File 'lib/open_graph_reader/object/registry.rb', line 49

def verticals
  @verticals
end

Class Method Details

.[](namespace) ⇒ Class

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Fetch the class associated with the given namespace

Parameters:

• The namespace in colon separated form, for example og:image.

Returns:

• The matching class.

Raises:

• If the given namespace wasn’t registered.

API:

• private

# File 'lib/open_graph_reader/object/registry.rb', line 41

def_delegators :instance, :register, :registered?, :[], :verticals

.register(namespace, klass) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Register a new namespace in the registry.

Parameters:

• The namespace in colon separated form, for example og:image.

• The class to register. It should include OpenGraphReader::Object.

API:

• private

# File 'lib/open_graph_reader/object/registry.rb', line 41

def_delegators :instance, :register, :registered?, :[], :verticals

.registered?(namespace) ⇒ Bool

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Check whether a namespace is registered.

Parameters:

• The namespace in colon separated form, for example og:image.

Returns:

API:

• private

# File 'lib/open_graph_reader/object/registry.rb', line 41

def_delegators :instance, :register, :registered?, :[], :verticals

.verticals ⇒ Set<String>

All known verticals

Returns:

# File 'lib/open_graph_reader/object/registry.rb', line 41

def_delegators :instance, :register, :registered?, :[], :verticals

Instance Method Details

#[](namespace) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:

See Also:

• []

API:

• private

# File 'lib/open_graph_reader/object/registry.rb', line 57

def [] namespace
  raise UnknownNamespaceError, "#{namespace} is not a registered namespace" unless registered? namespace
  @namespaces[namespace]
end