Class: Lutaml::Xml::Decisions::Rules::ElementFormDefaultRule

Inherits:
DecisionRule
  • Object
show all
Defined in:
lib/lutaml/xml/decisions/rules/element_form_default_rule.rb

Overview

Priority 4.5: Element form default qualified

When namespace has element_form_default :qualified, elements should be namespace-qualified. This can be achieved with either default format (xmlns=“…”) or prefix format (xmlns:p=“…” with p:element).

RATIONALE:

  • Both prefix format and default format are W3C compliant

  • Default format is cleaner (no prefix needed)

  • Prefer default format unless there’s a specific reason to use prefix

  • Prefix format is needed when multiple namespaces are involved

IMPORTANT: This rule does NOT override input format preservation (Priority 1). It only applies when no input format exists (programmatically created models).

W3C COMPLIANCE: elementFormDefault=“qualified” means local elements must be namespace-qualified. This can be satisfied by either:

  1. Default namespace: <element xmlns=“example.com”>

  2. Prefixed namespace: <p:element xmlns:p=“example.com”>

Instance Method Summary collapse

Methods inherited from DecisionRule

#<=>, #name

Instance Method Details

#applies?(context) ⇒ Boolean

Applies when:

  1. Element has a namespace

  2. Namespace has element_form_default :qualified

  3. No input format preserved (programmatic creation, not parsed XML)

Returns:

  • (Boolean) 


38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/lutaml/xml/decisions/rules/element_form_default_rule.rb', line 38

def applies?(context)
  return false unless context.has_namespace?

  ns_class = context.namespace_class
  return false unless ns_class

  # Check if namespace has element_form_default :qualified
  return false unless ns_class.element_form_default == :qualified

  # Only apply if no input format preserved (not from parsed XML)
  # If input format exists, FormatPreservationRule (Priority 1) handles it
  context.preserved_input_format.nil?
end

#decide(context) ⇒ Object

Decision: Prefer default format (cleaner, no prefix) The actual namespace qualification is handled by the namespace_class. Default format is preferred for cleaner output.



55
56
57
58
59
60
61
 
# File 'lib/lutaml/xml/decisions/rules/element_form_default_rule.rb', line 55

def decide(context)
  ns_class = context.namespace_class
  Decision.default(
    namespace_class: ns_class,
    reason: "Priority 4.5: element_form_default :qualified - prefer default format for cleaner output",
  )
end

#priority ⇒ Object

Priority 4.5 (between attribute usage and default preference)



30
31
32
 
# File 'lib/lutaml/xml/decisions/rules/element_form_default_rule.rb', line 30

def priority
  4.5
end