Module: Coradoc::ProcessorRegistry Private

Included in:
Input, Output
Defined in:
lib/coradoc/processor_registry.rb

Overview

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

Module adapter that gives a module Registry-backed processor methods.

Both Input and Output extend this module to get processor registration, lookup, and dispatch methods. All state is stored in a Registry instance.

Examples:

module Input
  extend ProcessorRegistry
  self.error_label = "input processor"
end

Instance Method Summary collapse

Instance Method Details

#define(processor, **options) ⇒ 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. 



25
26
27
 
# File 'lib/coradoc/processor_registry.rb', line 25

def define(processor, **options)
  registry.define(processor, **options)
end

#error_label=(label) ⇒ 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. 



17
18
19
 
# File 'lib/coradoc/processor_registry.rb', line 17

def error_label=(label)
  @error_label = label
end

#for_file(filename) ⇒ 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. 



42
43
44
 
# File 'lib/coradoc/processor_registry.rb', line 42

def for_file(filename)
  registry.for_file(filename)
end

#get(id) ⇒ Object Also known as: []

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. 



29
30
31
 
# File 'lib/coradoc/processor_registry.rb', line 29

def get(id)
  registry.get(id)
end

#process(content, options = {}) ⇒ 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. 



46
47
48
 
# File 'lib/coradoc/processor_registry.rb', line 46

def process(content, options = {})
  registry.process(content, options)
end

#processors ⇒ 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. 



38
39
40
 
# File 'lib/coradoc/processor_registry.rb', line 38

def processors
  registry.items
end

#registered?(id) ⇒ Boolean

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:

  • (Boolean) 


34
35
36
 
# File 'lib/coradoc/processor_registry.rb', line 34

def registered?(id)
  registry.registered?(id)
end

#registry ⇒ 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. 



21
22
23
 
# File 'lib/coradoc/processor_registry.rb', line 21

def registry
  @registry ||= Registry.new(error_label: @error_label)
end