Messaging::Category Module

Messaging::Category is a module that's often mixed in to handler classes. The module is also included into a receiver class that includes the Messaging::StreamName module.

Messaging::Category Facts

  • The Messaging::Category module can be mixed into a class or can be used as a function library, with its methods invoked directly from the Messaging::Category

Messaging::Category Module

The Category module is a mixin and function library from the Messaging library and namespace.

The Category module provides:

  • The category macro for declaring the default category name to be used for uses of stream name composition utilities within the class where the category is declared
  • The normalize class method to coerce a category name string or symbol to camel case

Declaring the Category

Declares the category that a class will use predominantly when composing stream names.

category :some_entity

Parameters

NameDescriptionType
categoryThe category nameString or Symbol

The category class macro has the effect of defining getter and setter instance method named category that returns the camel cased string of the argument passed to the macro.

# In the class context
category :some_entity

# In the instance context
category
# => "someEntity"

self.category = :something_else
category
# => "somethingElse"

Normalizing the Category Name

Convert or coerce a category name to a camel case string.

self.normalize(category)

Returns

String

Parameters

NameDescriptionType
categoryThe category nameString or Symbol

The normalize method is callable from the Messaging::Category constant as a module method, and cannot be mixed in to a receiver.

Messaging::Category.normalize(:some_entity)
# => "someEntity"