class Crowbar::Rules::Registry

Overview

Central registry for discovering, aliasing, and instantiating format rules.

crowbar/rules/registry.cr

.canonical_name(name : String) : String | Nil
Returns the canonical name for an alias or name
.catalog : Array(Entry)
Returns all registered rule entries in order of registration
.create!(name : String) : Rule
Instantiates a rule by canonical name or alias.
.create?(name : String) : Rule | Nil
Instantiates a rule by canonical name or alias.
.exists?(name : String) : Bool
Checks whether a given name or alias is registered
.names : Array(String)
Returns all canonical rule names
.register(name : String, description : String, aliases : Array(String) = [] of String, &block : -> Rule)
Registers a rule with its canonical name, description, aliases, and builder factory

def self.canonical_name(name : String) : String | Nil #

Returns the canonical name for an alias or name

def self.catalog : Array(Entry) #

Returns all registered rule entries in order of registration

def self.create!(name : String) : Rule #

Instantiates a rule by canonical name or alias. Raises ArgumentError if unknown.

def self.create?(name : String) : Rule | Nil #

Instantiates a rule by canonical name or alias. Returns nil if unknown.

def self.exists?(name : String) : Bool #

Checks whether a given name or alias is registered

def self.names : Array(String) #

Returns all canonical rule names

def self.register(name : String, description : String, aliases : Array(String) = [] of String, &block : -> Rule) #

Registers a rule with its canonical name, description, aliases, and builder factory