Module: Pubid::Ansi

Defined in:
lib/pubid/ansi.rb,
lib/pubid/ansi/parser.rb,
lib/pubid/ansi/builder.rb,
lib/pubid/ansi/renderer.rb,
lib/pubid/ansi/identifier.rb,
lib/pubid/ansi/urn_parser.rb,
lib/pubid/ansi/identifiers.rb,
lib/pubid/ansi/urn_generator.rb,
lib/pubid/ansi/single_identifier.rb,
lib/pubid/ansi/identifiers/standard.rb,
lib/pubid/ansi/identifiers/american_national_standard.rb

Defined Under Namespace

Modules: Identifiers Classes: Builder, Identifier, Parser, Renderer, SingleIdentifier, UrnGenerator, UrnParser

Class Method Summary collapse

Class Method Details

.all_typed_stages ⇒ Array

ANSI does not define typed stages; typed_stage lookup is not used by the builder. Provided here for API consistency with other flavors.

Returns:

  • (Array) —

    always empty for ANSI



41
42
43
 
# File 'lib/pubid/ansi.rb', line 41

def self.all_typed_stages
  []
end

.identifier_types ⇒ Array<Class>

Auto-discover all identifier types from the Identifiers namespace

Returns:

  • (Array<Class>) —

    identifier classes that define a self.type Hash



31
32
33
34
35
36
 
# File 'lib/pubid/ansi.rb', line 31

def self.identifier_types
  @identifier_types ||= Identifiers.constants
    .filter_map { |c| begin; Identifiers.const_get(c); rescue NameError; nil; end }
    .select { |c| c.is_a?(Class) && c.singleton_methods(false).include?(:type) }
    .select { |c| c.type.is_a?(Hash) }
end

.locate_stage(_abbr) ⇒ nil

Lookup: abbreviation -> typed stage

Parameters:

  • _abbr (String, Symbol) —

    unused; ANSI has no typed stages

Returns:

  • (nil) —

    always nil for ANSI



55
56
57
 
# File 'lib/pubid/ansi.rb', line 55

def self.locate_stage(_abbr)
  nil
end

.locate_type(code) ⇒ Class?

Lookup: type code -> identifier class

Parameters:

  • code (String, Symbol) —

    the type key to find

Returns:

  • (Class, nil) —

    the matching identifier class



48
49
50
 
# File 'lib/pubid/ansi.rb', line 48

def self.locate_type(code)
  identifier_types.find { |t| t.type[:key].to_s == code.to_s }
end

.parse(identifier) ⇒ Identifier

Parse an ANSI identifier string

Parameters:

  • identifier (String) —

    the identifier string to parse

Returns:



17
18
19
20
21
22
23
 
# File 'lib/pubid/ansi.rb', line 17

def self.parse(identifier)
  parser = Parser.new
  builder = Builder.new

  parsed = parser.parse(identifier)
  builder.build(parsed)
end