Module: Pubid::Tgpp

Extended by:
PrefixesSupport
Defined in:
lib/pubid/tgpp.rb,
lib/pubid/tgpp/parser.rb,
lib/pubid/tgpp/builder.rb,
lib/pubid/tgpp/renderer.rb,
lib/pubid/tgpp/identifier.rb,
lib/pubid/tgpp/urn_parser.rb,
lib/pubid/tgpp/identifiers.rb,
lib/pubid/tgpp/urn_generator.rb,
lib/pubid/tgpp/identifiers/technical_report.rb,
lib/pubid/tgpp/identifiers/technical_specification.rb

Overview

3GPP (3rd Generation Partnership Project) flavor.

The Ruby constant is Pubid::Tgpp because a constant may not begin with a digit, but the external contract stays "3gpp": the registry key is "3gpp", the polymorphic _type is pubid:3gpp:…, and URNs use the urn:3gpp: namespace. Only the on-disk file names (lib/pubid/tgpp/…) follow the module.

Defined Under Namespace

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

Constant Summary collapse

PREFIXES =

Sole routing token. 3GPP references are printed as "3GPP TS 23.207:…"; the bare document types (TR/TS) are ambiguous (JIS uses them too) and are excluded. The parser still accepts an optional leading "3GPP ".

["3GPP"].freeze

Class Method Summary collapse

Methods included from PrefixesSupport

prefix_flavor_key, prefixes

Class Method Details

.all_typed_stagesArray<Pubid::Components::TypedStage>

Build typed stage index from identifier types

Returns:



50
51
52
53
54
55
56
57
58
# File 'lib/pubid/tgpp.rb', line 50

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_typesArray<Class>

Auto-discover all identifier types from the Identifiers namespace

Returns:

  • (Array<Class>)

    identifier classes that define a self.type Hash



41
42
43
44
45
46
# File 'lib/pubid/tgpp.rb', line 41

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:



70
71
72
73
# File 'lib/pubid/tgpp.rb', line 70

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



63
64
65
# File 'lib/pubid/tgpp.rb', line 63

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

.parse(identifier) ⇒ Object

Parse a 3GPP identifier string



27
28
29
30
31
32
33
# File 'lib/pubid/tgpp.rb', line 27

def self.parse(identifier)
  if identifier.length > Pubid::MAX_INPUT_LENGTH
    raise ArgumentError, Pubid::INPUT_TOO_LONG_MESSAGE
  end

  Identifier.parse(identifier)
end