Class: Lutaml::Xml::TypeNamespace::Planner

Inherits:
Object
  • Object
show all
Defined in:
lib/lutaml/xml/type_namespace/planner.rb

Overview

Plans type namespace declarations for elements

Type namespaces are declared on PARENT elements and used by CHILD elements as prefixes. This planner determines where to declare each type namespace.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(register = nil) ⇒ Planner

Returns a new instance of Planner.



14
15
16
17
 
# File 'lib/lutaml/xml/type_namespace/planner.rb', line 14

def initialize(register = nil)
  @collector = Collector.new(register)
  @resolver = Resolver.new
end

Instance Attribute Details

#collector ⇒ Object (readonly)

Returns the value of attribute collector.



12
13
14
 
# File 'lib/lutaml/xml/type_namespace/planner.rb', line 12

def collector
  @collector
end

#resolver ⇒ Object (readonly)

Returns the value of attribute resolver.



12
13
14
 
# File 'lib/lutaml/xml/type_namespace/planner.rb', line 12

def resolver
  @resolver
end

Instance Method Details

#plan_for_element(mapping, mapper_class, element_namespace_class, existing_declarations = {}) ⇒ Array<Declaration>

Plan type namespace declarations for an element

Parameters:

  • mapping (Xml::Mapping) —

    The XML mapping

  • mapper_class (Class) —

    The model class

  • element_namespace_class (XmlNamespace, nil) —

    Element’s namespace

  • existing_declarations (Hash) (defaults to: {}) —

    Already declared namespaces => uri

Returns:

  • (Array<Declaration>) —

    Array of type namespace declarations



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/lutaml/xml/type_namespace/planner.rb', line 26

def plan_for_element(mapping, mapper_class, element_namespace_class,
    existing_declarations = {})
  # Collect type namespace references
  references = @collector.collect_from_mapping(mapping, mapper_class)

  # Resolve to namespace classes
  resolved = @collector.resolve_references(references)

  # Build declarations
  declarations = []

  # Process attribute type namespaces
  resolved[:attributes].each do |ns_class|
    next if already_declared?(ns_class, existing_declarations)
    next unless @resolver.needs_declaration?(ns_class,
                                             element_namespace_class)

    prefix = ns_class.prefix_default || generate_prefix("attr",
                                                        existing_declarations)

    declarations << Declaration.new(
      namespace_class: ns_class,
      prefix: prefix,
      declared_at: :parent,
      element_name: mapping&.root_element,
    )
  end

  # Process element type namespaces
  resolved[:elements].each do |ns_class|
    next if already_declared?(ns_class, existing_declarations)
    next unless @resolver.needs_declaration?(ns_class,
                                             element_namespace_class)

    prefix = ns_class.prefix_default || generate_prefix("elem",
                                                        existing_declarations)

    declarations << Declaration.new(
      namespace_class: ns_class,
      prefix: prefix,
      declared_at: :parent,
      element_name: mapping&.root_element,
    )
  end

  declarations
end

#plan_for_root(mapping, mapper_class, element_namespace_class) ⇒ Array<Declaration>

Plan type namespace declarations for root element

Parameters:

  • mapping (Xml::Mapping) —

    The XML mapping

  • mapper_class (Class) —

    The model class

  • element_namespace_class (XmlNamespace, nil) —

    Root’s namespace

Returns:

  • (Array<Declaration>) —

    Array of type namespace declarations



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/lutaml/xml/type_namespace/planner.rb', line 80

def plan_for_root(mapping, mapper_class, element_namespace_class)
  plan_for_element(mapping, mapper_class,
                   element_namespace_class).map do |decl|
    # Convert to root-level declarations
    Declaration.new(
      namespace_class: decl.namespace_class,
      prefix: decl.prefix,
      declared_at: :root,
      element_name: decl.element_name,
    )
  end
end