Module: Pubid::Oasis

Extended by:
PrefixesSupport
Defined in:
lib/pubid/oasis.rb,
lib/pubid/oasis/parser.rb,
lib/pubid/oasis/builder.rb,
lib/pubid/oasis/renderer.rb,
lib/pubid/oasis/identifier.rb,
lib/pubid/oasis/urn_parser.rb,
lib/pubid/oasis/identifiers.rb,
lib/pubid/oasis/urn_generator.rb,
lib/pubid/oasis/identifiers/standard.rb

Defined Under Namespace

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

Constant Summary collapse

PREFIXES =

Sole OASIS publisher token (see the parser's prefix rule). Everything after "OASIS " is a free-form slug, so there are no leading type tokens to exclude.

["OASIS"].freeze

Class Method Summary collapse

Methods included from PrefixesSupport

prefix_flavor_key, prefixes

Class Method Details

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

Build typed stage index from identifier types

Returns:



46
47
48
49
50
51
52
53
54
 
# File 'lib/pubid/oasis.rb', line 46

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

Returns:

  • (Array<Class>) —

    identifier classes that define a self.type Hash



37
38
39
40
41
42
 
# File 'lib/pubid/oasis.rb', line 37

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) ⇒ Pubid::Components::TypedStage?

Lookup: abbreviation -> typed stage

Parameters:

  • abbr (String, Symbol) —

    the abbreviation to find

Returns:



66
67
68
69
 
# File 'lib/pubid/oasis.rb', line 66

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



59
60
61
 
# File 'lib/pubid/oasis.rb', line 59

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

.parse(identifier) ⇒ Object

Parse an OASIS identifier string



21
22
23
24
25
26
27
28
29
 
# File 'lib/pubid/oasis.rb', line 21

def self.parse(identifier)
  # Reject pathological inputs before they reach the parser
  # (CodeQL rb/polynomial-redos barrier — inline .length by design).
  if identifier.length > Pubid::MAX_INPUT_LENGTH
    raise ArgumentError, Pubid::INPUT_TOO_LONG_MESSAGE
  end

  Identifier.parse(identifier)
end