Class: Metanorma::Ietf::Converter

Inherits:
Standoc::Converter
  • Object
show all
Defined in:
lib/metanorma/ietf/log.rb,
lib/metanorma/ietf/front.rb,
lib/metanorma/ietf/blocks.rb,
lib/metanorma/ietf/converter.rb

Constant Summary collapse

IETF_LOG_MESSAGES = 
{
  # rubocop:disable Naming/VariableNumber
  "IETF_1": { category: "Crossrefences",
              error: "No matching annotation for cref:[%s]",
              severity: 1 },
  "IETF_2": { category: "Document Attributes",
              error: "Editorial stream must have Informational status",
              severity: 2 },
  "IETF_3": { category: "Images",
              error: "image %s is not SVG!",
              severity: 1 },
  "IETF_4": { category: "Document Attributes",
              error: "IETF: unrecognised working group %s",
              severity: 1 },
}.freeze
XML_ROOT_TAG = 
"ietf-standard".freeze
XML_NAMESPACE = 
"https://www.metanorma.org/ns/ietf".freeze

Instance Method Summary collapse

Constructor Details

#initialize(backend, opts) ⇒ Converter

Returns a new instance of Converter.



20
21
22
23
 
# File 'lib/metanorma/ietf/converter.rb', line 20

def initialize(backend, opts)
  super
  @libdir = File.dirname(__FILE__)
end

Instance Method Details

#acknowledgements_parse(attrs, xml, node) ⇒ Object

end



144
145
146
 
# File 'lib/metanorma/ietf/converter.rb', line 144

def acknowledgements_parse(attrs, xml, node)
  clause_parse(attrs, xml, node)
end

#annex_attrs_preprocess(attrs, node) ⇒ Object 



133
134
135
136
137
138
 
# File 'lib/metanorma/ietf/converter.rb', line 133

def annex_attrs_preprocess(attrs, node)
  attrs[:numbered] = node.attr("numbered")
  attrs[:removeInRFC] = node.attr("removeInRFC")
  attrs[:toc] = node.attr("toc")
  super
end

#bcp14(node, xml) ⇒ Object 



67
68
69
70
71
 
# File 'lib/metanorma/ietf/converter.rb', line 67

def bcp14(node, xml)
  xml.span **{ class: "bcp14" } do |s|
    s << node.text.upcase
  end
end

#cache_workgroup(_node) ⇒ Object 



32
33
34
 
# File 'lib/metanorma/ietf/converter.rb', line 32

def cache_workgroup(_node)
  Metanorma::Ietf::Data::WORKGROUPS
end

#clause_attrs_preprocess(attrs, node) ⇒ Object 



126
127
128
129
130
131
 
# File 'lib/metanorma/ietf/converter.rb', line 126

def clause_attrs_preprocess(attrs, node)
  attrs[:numbered] = node.attr("numbered")
  attrs[:removeInRFC] = node.attr("removeInRFC")
  attrs[:toc] = node.attr("toc")
  super
end

#default_publisher ⇒ Object 



15
16
17
 
# File 'lib/metanorma/ietf/front.rb', line 15

def default_publisher
  "IETF"
end

#default_svg_conform_profile ⇒ Object 



168
169
170
 
# File 'lib/metanorma/ietf/converter.rb', line 168

def default_svg_conform_profile
  :svg_1_2_rfc
end

#dl_attrs(node) ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'lib/metanorma/ietf/blocks.rb', line 34

def dl_attrs(node)
  attr_code(id_attr(node).merge(
              newline: node.attr("newline"),
              indent: node.attr("indent"),
              spacing: node.attr("spacing"),
              key: node.option?("key") ? "true" : nil,
            ))
end

#eref_text(node) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/metanorma/ietf/converter.rb', line 90

def eref_text(node)
  matched = /^(of|comma|parens|bare),(.*+)$/.match node.text
  if matched.nil?
    f = nil
    c = node&.text&.sub(/^fn: /, "")
  else
    f = matched[1]
    c = matched[2]
  end
  [f, c]
end

#html_extract_attributes(node) ⇒ Object 



172
173
174
 
# File 'lib/metanorma/ietf/converter.rb', line 172

def html_extract_attributes(node)
  super.merge(usexinclude: node.attr("use-xinclude"))
end

#image_attributes(node) ⇒ Object 



77
78
79
 
# File 'lib/metanorma/ietf/blocks.rb', line 77

def image_attributes(node)
  super.merge(attr_code(align: node.attr("align")))
end

#init_metadata(node) ⇒ Object 



41
42
43
44
 
# File 'lib/metanorma/ietf/converter.rb', line 41

def init_metadata(node)
  super
  @default_doctype = "internet-draft"
end

#inline_anchor_xref(node) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/metanorma/ietf/converter.rb', line 73

def inline_anchor_xref(node)
  f, c = xref_text(node)
  f1, c = eref_text(node) if f.nil?
  t, rel = xref_rel(node)
  attrs = { target: t, type: "inline", displayFormat: f1, format: f,
            relative: rel }
  noko do |xml|
    xml.xref **attr_code(attrs) do |x|
      x << c
    end
  end
end

#inline_indexterm(node) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/metanorma/ietf/converter.rb', line 148

def inline_indexterm(node)
  noko do |xml|
    node.type == :visible and xml << node.text.sub(/^primary:(?=\S)/, "")
    terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
    if /^primary:\S/.match?(terms[0])
      terms[0].sub!(/^primary:/, "")
      has_primary = true
    end
    inline_indexterm1(has_primary, terms, xml)
  end
end

#inline_indexterm1(has_primary, terms, xml) ⇒ Object 



160
161
162
163
164
165
166
 
# File 'lib/metanorma/ietf/converter.rb', line 160

def inline_indexterm1(has_primary, terms, xml)
  xml.index **attr_code(primary: has_primary) do |i|
    i.primary { |x| x << terms[0] }
    a = terms[1] and i.secondary { |x| x << a }
    a = terms[2] and i.tertiary { |x| x << a }
  end
end

#inline_quoted(node) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/metanorma/ietf/converter.rb', line 46

def inline_quoted(node)
  noko do |xml|
    case node.type
    when :emphasis then xml.em { |s| s << node.text }
    when :strong then xml.strong { |s| s << node.text }
    when :monospaced then xml.tt { |s| s << node.text }
    when :double then xml << "\"#{node.text}\""
    when :single then xml << "'#{node.text}'"
    when :superscript then xml.sup { |s| s << node.text }
    when :subscript then xml.sub { |s| s << node.text }
    when :asciimath then stem_parse(node.text, xml, :asciimath, node)
    when :latexmath then stem_parse(node.text, xml, :latexmath, node)
    else
      case node.role
      when "bcp14" then bcp14(node, xml)
      else xml << node.text
      end
    end
  end
end

#isodoc(lang, script, locale, i18nyaml = nil) ⇒ Object 



180
181
182
183
184
185
186
 
# File 'lib/metanorma/ietf/converter.rb', line 180

def isodoc(lang, script, locale, i18nyaml = nil)
  conv = rfc_converter(::Metanorma::Standoc::EmptyAttr.new)
  conv.init_i18n({ i18nyaml:, language: lang, script:, locale: })
  i18n = conv.i18n_init(lang, script, locale, i18nyaml)
  conv.metadata_init(lang, script, locale, i18n)
  conv
end

#listing_attrs(node) ⇒ Object 



81
82
83
84
 
# File 'lib/metanorma/ietf/blocks.rb', line 81

def listing_attrs(node)
  super.merge(attr_code(markers: node.attr("markers"),
                        src: node.attr("src")))
end

#literal(node) ⇒ Object 



67
68
69
70
71
72
73
74
75
 
# File 'lib/metanorma/ietf/blocks.rb', line 67

def literal(node)
  noko do |xml|
    xml.figure **literal_attrs(node) do |f|
      block_title(node, f)
      f.pre node.lines.join("\n"),
            **attr_code(align: node.attr("align"), alt: node.attr("alt"))
    end
  end
end

#log_messages ⇒ Object

rubocop:enable Naming/VariableNumber



21
22
23
 
# File 'lib/metanorma/ietf/log.rb', line 21

def log_messages
  super.merge(IETF_LOG_MESSAGES)
end

#makexml(node) ⇒ Object 



25
26
27
28
29
30
 
# File 'lib/metanorma/ietf/converter.rb', line 25

def makexml(node)
  @workgroups = cache_workgroup(node)
  @bcp_bold = !node.attr?("no-rfc-bold-bcp14")
  @xinclude = node.attr?("use-xinclude")
  super
end

#metadata_author(node, xml) ⇒ Object 



8
9
10
11
 
# File 'lib/metanorma/ietf/front.rb', line 8

def metadata_author(node, xml)
  personal_author(node, xml)
  committee_contributors(node, xml, default_publisher, {})
end

#metadata_committee(node, xml) ⇒ Object 



53
54
55
56
57
58
 
# File 'lib/metanorma/ietf/front.rb', line 53

def metadata_committee(node, xml)
  node.attr("workgroup") or return
  xml.editorialgroup do |a|
    committee_component("workgroup", node, a)
  end
end

#metadata_committee_types(_node) ⇒ Object 



19
20
21
 
# File 'lib/metanorma/ietf/front.rb', line 19

def metadata_committee_types(_node)
  %w(workgroup)
end

#metadata_ext(node, xml) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/metanorma/ietf/front.rb', line 60

def metadata_ext(node, xml)
  super
  x = node.attr("area") and x.split(/,\s*/).each do |a|
    add_noko_elem(xml, "area", a)
    # xml.area a
  end
  add_noko_elem(xml, "ipr", node.attr("ipr") || "trust200902")
  # xml.ipr (node.attr("ipr") || "trust200902")
  x = node.attr("consensus") and xml.consensus (x != "false")
  x = node.attr("index-include") and xml.indexInclude (x != "false")
  add_noko_elem(xml, "iprExtract", node.attr("ipr-extract"))
  # x = node.attr("ipr-extract") and xml.iprExtract x
  x = node.attr("sort-refs") and xml.sortRefs (x != "false")
  x = node.attr("sym-refs") and xml.symRefs (x != "false")
  x = node.attr("toc-include") and xml.tocInclude (x != "false")
  add_noko_elem(xml, "tocDepth", node.attr("toc-depth"))
  # x = node.attr("toc-depth") and xml.tocDepth x
  x = node.attr("show-on-front-page") and xml.showOnFrontPage (x != "false")
  xml.pi { |pi| set_pi(node, pi) }
end

#metadata_series(node, xml) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/metanorma/ietf/front.rb', line 27

def metadata_series(node, xml)
  xml.series **{ type: "stream" } do |s|
    add_noko_elem(s, "title", node.attr("submission-type") || "IETF")
    # s.title (node.attr("submission-type") || "IETF")
  end
  a = node.attr("intended-series") and
    xml.series **{ type: "intended" } do |s|
      parts = a.split(/ /)
      add_noko_elem(s, "title", parts[0])
      add_noko_elem(s, "number", parts[1..-1].join(" ")) if parts.size > 1
    end
end

#note(node) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/metanorma/ietf/blocks.rb', line 56

def note(node)
  noko do |xml|
    xml.note **attr_code(id_attr(node).merge(
                           removeInRFC: node.attr("remove-in-rfc"),
                         )) do |c|
      block_title(node, c)
      wrap_in_para(node, c)
    end
  end
end

#ol_attrs(node) ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'lib/metanorma/ietf/blocks.rb', line 24

def ol_attrs(node)
  attr_code(id_attr(node).merge(
              type: node.attr("format") || olist_style(node.style),
              group: node.attr("group"),
              spacing: node.attr("spacing"),
              indent: node.attr("indent"),
              start: node.attr("start"),
            ))
end

#org_abbrev ⇒ Object 



23
24
25
 
# File 'lib/metanorma/ietf/front.rb', line 23

def org_abbrev
  { "Internet Engineering Task Force" => "IETF" }
end

#org_author(node, xml) ⇒ Object 



13
 
# File 'lib/metanorma/ietf/front.rb', line 13

def org_author(node, xml); end

#outputs(node, ret) ⇒ Object 



36
37
38
39
 
# File 'lib/metanorma/ietf/converter.rb', line 36

def outputs(node, ret)
  File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
  rfc_converter(node).convert("#{@filename}.xml")
end

#para_attrs(node) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
 
# File 'lib/metanorma/ietf/blocks.rb', line 4

def para_attrs(node)
  attr_code(id_attr(node).merge(
              "keep-with-next": node.attr("keepWithNext") ||
                      node.attr("keep-with-next"),
              "keep-with-previous": node.attr("keepWithPrevious") ||
                     node.attr("keep-with-previous"),
              indent: node.attr("indent"),
              key: node.option?("key") ? "true" : nil,
            ))
end

#pi_code(rfc_pis, processing_instruction) ⇒ Object 



122
123
124
125
126
127
 
# File 'lib/metanorma/ietf/front.rb', line 122

def pi_code(rfc_pis, processing_instruction)
  rfc_pis.each_pair do |k, v|
    v.nil? and next
    processing_instruction.send k.to_s, v
  end
end

#relaton_relations ⇒ Object 



4
5
6
 
# File 'lib/metanorma/ietf/front.rb', line 4

def relaton_relations
  %w(included-in described-by derived-from instance-of obsoletes updates)
end

#rfc_converter(node) ⇒ Object 



176
177
178
 
# File 'lib/metanorma/ietf/converter.rb', line 176

def rfc_converter(node)
  IsoDoc::Ietf::RfcConvert.new(html_extract_attributes(node))
end

#set_pi(node, pi) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/metanorma/ietf/front.rb', line 81

def set_pi(node, pi)
  rfc_pis = {
    artworkdelimiter: node.attr("artworkdelimiter"),
    artworklines: node.attr("artworklines"),
    authorship: node.attr("authorship"),
    autobreaks: node.attr("autobreaks"),
    background: node.attr("background"),
    colonspace: node.attr("colonspace"),
    comments: node.attr("comments"),
    docmapping: node.attr("docmapping"),
    editing: node.attr("editing"),
    emoticonic: node.attr("emoticonic"),
    footer: node.attr("footer"),
    header: node.attr("header"),
    inline: node.attr("inline"),
    iprnotified: node.attr("iprnotified"),
    linkmailto: node.attr("linkmailto"),
    linefile: node.attr("linefile"),
    notedraftinprogress: node.attr("notedraftinprogress"),
    private: node.attr("private"),
    refparent: node.attr("refparent"),
    rfcedstyle: node.attr("rfcedstyle"),
    slides: node.attr("slides"),
    "text-list-symbols": node.attr("text-list-symbols"),
    tocappendix: node.attr("tocappendix"),
    tocindent: node.attr("tocindent"),
    tocnarrow: node.attr("tocnarrow"),
    tocompact: node.attr("tocompact"),
    topblock: node.attr("topblock"),
    useobject: node.attr("useobject"),
    strict: node.attr("strict"),
    compact: node.attr("compact"),
    subcompact: node.attr("subcompact"),
    tocinclude: node.attr("toc-include") == "false" ? "no" : "yes",
    tocdepth: node.attr("toc-depth"),
    symrefs: node.attr("sym-refs"),
    sortrefs: node.attr("sort-refs"),
  }
  pi_code(rfc_pis, pi)
end

#sidebar(node) ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'lib/metanorma/ietf/blocks.rb', line 47

def sidebar(node)
  noko do |xml|
    xml.annotation **sidebar_attrs(node) do |r|
      block_title(node, r)
      wrap_in_para(node, r)
    end
  end
end

#sidebar_attrs(node) ⇒ Object 



43
44
45
 
# File 'lib/metanorma/ietf/blocks.rb', line 43

def sidebar_attrs(node)
  super.merge(attr_code(display: node.attr("display")))
end

#table_attrs(node) ⇒ Object 



86
87
88
 
# File 'lib/metanorma/ietf/converter.rb', line 86

def table_attrs(node)
  super.merge(align: node.attr("align"))
end

#title_fallback(node, xml) ⇒ Object 



40
41
42
43
44
 
# File 'lib/metanorma/ietf/front.rb', line 40

def title_fallback(node, xml)
  xml.parent.at("./title[not(normalize-space(.)='')]" \
    "[not(@type = 'abbrev' or @type = 'ascii')]") and return
  add_title_xml(xml, node.attr("doctitle"), @lang, "main")
end

#title_other(node, xml) ⇒ Object 



46
47
48
49
50
51
 
# File 'lib/metanorma/ietf/front.rb', line 46

def title_other(node, xml)
  a = node.attr("abbrev") and
    add_title_xml(xml, a, "en", "abbrev")
  a = node.attr("asciititle") and
    add_title_xml(xml, a, "en", "ascii")
end

#ul_attrs(node) ⇒ Object 



15
16
17
18
19
20
21
22
 
# File 'lib/metanorma/ietf/blocks.rb', line 15

def ul_attrs(node)
  attr_code(id_attr(node).merge(
              nobullet: node.attr("nobullet") || node.attr("empty"),
              indent: node.attr("indent"),
              bare: node.attr("bare"),
              spacing: node.attr("spacing"),
            ))
end

#xref_rel(node) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/metanorma/ietf/converter.rb', line 114

def xref_rel(node)
  matched = /^([^#]+)#(.+)$/.match node.target
  if matched.nil?
    t = node.target.sub(/^#/, "")
    rel = nil
  else
    t = matched[1].sub(/\.(xml|adoc)$/, "")
    rel = matched[2]
  end
  [t, rel]
end

#xref_text(node) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/metanorma/ietf/converter.rb', line 102

def xref_text(node)
  matched = /^format=(counter|title|none|default)(:.*+)?$/.match node.text
  if matched.nil?
    f = nil
    c = node&.text&.sub(/^fn: /, "")
  else
    f = matched[1]
    c = matched[2]&.sub(/^:/, "")
  end
  [f, c]
end