Module: Pubid::Sae

Defined in:
lib/pubid/sae.rb,
lib/pubid/sae/parser.rb,
lib/pubid/sae/builder.rb,
lib/pubid/sae/renderer.rb,
lib/pubid/sae/components.rb,
lib/pubid/sae/identifier.rb,
lib/pubid/sae/urn_parser.rb,
lib/pubid/sae/identifiers.rb,
lib/pubid/sae/urn_generator.rb,
lib/pubid/sae/components/code.rb,
lib/pubid/sae/components/date.rb,
lib/pubid/sae/components/type.rb,
lib/pubid/sae/identifiers/base.rb

Defined Under Namespace

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

Class Method Summary collapse

Class Method Details

.all_typed_stages ⇒ Array<Pubid::Components::TypedStage>

Build typed stage index from identifier types

Returns:



29
30
31
32
33
34
35
36
37
 
# File 'lib/pubid/sae.rb', line 29

def self.all_typed_stages
  @all_typed_stages ||= identifier_types.flat_map do |klass|
    if klass.const_defined?(:TYPED_STAGES)
      klass.const_get(:TYPED_STAGES)
    else
      []
    end
  end
end

.identifier_types ⇒ Array<Class>

Auto-discover all identifier types from the Identifiers namespace. SAE has only one identifier class (Base), which IS the document type.

Returns:

  • (Array<Class>) —

    identifier classes (Pubid::Identifier subclasses)



21
22
23
24
25
 
# File 'lib/pubid/sae.rb', line 21

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 < Pubid::Identifier }
end

.locate_stage(abbr) ⇒ Pubid::Components::TypedStage?

Lookup: abbreviation -> typed stage

Parameters:

  • abbr (String, Symbol) —

    the abbreviation to find

Returns:



49
50
51
52
 
# File 'lib/pubid/sae.rb', line 49

def self.locate_stage(abbr)
  abbr_str = abbr.to_s.upcase
  all_typed_stages.find { |s| s.abbr.any? { |a| a.to_s.upcase == abbr_str } }
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



42
43
44
 
# File 'lib/pubid/sae.rb', line 42

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

.parse(input) ⇒ Object 



14
15
16
 
# File 'lib/pubid/sae.rb', line 14

def self.parse(input)
  Identifier.parse(input)
end