Module: Asciidoctor::Standoc::Blocks

Included in:
Converter
Defined in:
lib/asciidoctor/standoc/reqt.rb,
lib/asciidoctor/standoc/blocks.rb,
lib/asciidoctor/standoc/blocks_notes.rb

Instance Method Summary collapse

Instance Method Details

#admonition(node) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/asciidoctor/standoc/blocks_notes.rb', line 76

def admonition(node)
  return termnote(node) if in_terms?
  return note(node) if node.attr("name") == "note"
  return todo(node) if node.attr("name") == "todo"
  noko do |xml|
    xml.admonition **admonition_attrs(node) do |a|
      node.title.nil? or a.name { |name| name << node.title }
      wrap_in_para(node, a)
    end
  end.join("\n")
end

#admonition_attrs(node) ⇒ Object 



67
68
69
70
71
72
73
74
 
# File 'lib/asciidoctor/standoc/blocks_notes.rb', line 67

def admonition_attrs(node)
  name = node.attr("name")
  a = node.attr("type") and ["danger", "safety precautions"].each do |t|
    name = t if a.casecmp(t).zero?
  end
  attr_code(keep_attrs(node).merge(id: Utils::anchor_or_uuid(node), type: name,
            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
end

#example(node) ⇒ Object 



71
72
73
74
75
76
77
78
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 71

def example(node)
  return term_example(node) if in_terms?
  role = node.role || node.attr("style")
  %w(recommendation requirement permission).include?(role) and
    return requirement(node, role)
  return pseudocode_example(node) if role == "pseudocode"
  example_proper(node)
end

#example_attrs(node) ⇒ Object 



91
92
93
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 91

def example_attrs(node)
  attr_code(id_unnum_attrs(node).merge(keep_attrs(node)))
end

#example_proper(node) ⇒ Object 



95
96
97
98
99
100
101
102
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 95

def example_proper(node)
  noko do |xml|
    xml.example **example_attrs(node) do |ex|
      node.title.nil? or ex.name { |name| name << node.title }
      wrap_in_para(node, ex)
    end
  end.join("\n")
end

#figure_attrs(node) ⇒ Object 



109
110
111
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 109

def figure_attrs(node)
  attr_code(id_unnum_attrs(node).merge(keep_attrs(node)))
end

#figure_title(node, f) ⇒ Object 



104
105
106
107
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 104

def figure_title(node, f)
  return if node.title.nil?
  f.name { |name| name << node.title }
end

#formula_attrs(node) ⇒ Object 



19
20
21
22
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 19

def formula_attrs(node)
  attr_code(id_unnum_attrs(node).merge(keep_attrs(node).merge(
    inequality: node.option?("inequality") ? "true" : nil)))
end

#id_attr(node = nil) ⇒ Object 



8
9
10
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 8

def id_attr(node = nil)
  { id: Utils::anchor_or_uuid(node) }
end

#id_unnum_attrs(node) ⇒ Object 



12
13
14
15
16
17
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 12

def id_unnum_attrs(node)
  attr_code( id: Utils::anchor_or_uuid(node),
            unnumbered: node.option?("unnumbered") ? "true" : nil,
            number: node.attr("number"),
            subsequence: node.attr("subsequence") )
end

#image(node) ⇒ Object 



113
114
115
116
117
118
119
120
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 113

def image(node)
  noko do |xml|
    xml.figure **figure_attrs(node) do |f|
      figure_title(node, f)
      f.image **(image_attributes(node))
    end
  end
end

#keep_attrs(node) ⇒ Object 



24
25
26
27
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 24

def keep_attrs(node)
  { "keep-with-next": node.attr("keep-with-next"),
    "keep-lines-together": node.attr("keep-lines-together") }
end

#listing(node) ⇒ Object

NOTE: html escaping is performed by Nokogiri



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 170

def listing(node)
  fragment = ::Nokogiri::XML::Builder.new do |xml|
    xml.sourcecode **(listing_attrs(node)) do |s|
      figure_title(node, s)
      s << node.content
    end
  end
  fragment.to_xml(encoding: "US-ASCII", save_with:
                  Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
end

#listing_attrs(node) ⇒ Object 



161
162
163
164
165
166
167
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 161

def listing_attrs(node)
  attr_code(keep_attrs(node).merge(lang: node.attr("language"),
                                  id: Utils::anchor_or_uuid(node),
                                  unnumbered: node.option?("unnumbered") ? "true" : nil,
                                  number: node.attr("number"),
                                  filename: node.attr("filename")))
end

#literal(node) ⇒ Object 



44
45
46
47
48
49
50
51
52
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 44

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

#literal_attrs(node) ⇒ Object 



40
41
42
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 40

def literal_attrs(node)
  attr_code(id_attr(node).merge(keep_attrs(node)))
end

#note(n) ⇒ Object 



59
60
61
62
63
64
65
 
# File 'lib/asciidoctor/standoc/blocks_notes.rb', line 59

def note(n)
  noko do |xml|
    xml.note **note_attrs(n) do |c|
      wrap_in_para(n, c)
    end
  end.join("\n")
end

#note_attrs(node) ⇒ Object 



14
15
16
17
18
 
# File 'lib/asciidoctor/standoc/blocks_notes.rb', line 14

def note_attrs(node)
  attr_code(termnote_attrs(node).merge(
    type: node.attr("type"),
    beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
end

#open(node) ⇒ Object

We append each contained block to its parent



30
31
32
33
34
35
36
37
38
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 30

def open(node)
  role = node.role || node.attr("style")
  Utils::reqt_subpart(role) and return requirement_subpart(node)
  result = []
  node.blocks.each do |b|
    result << send(b.context, b)
  end
  result
end

#para_attrs(node) ⇒ Object 



122
123
124
125
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 122

def para_attrs(node)
  attr_code(keep_attrs(node).merge(align: node.attr("align"), 
                                  id: Utils::anchor_or_uuid(node)))
end

#paragraph(node) ⇒ Object 



127
128
129
130
131
132
133
134
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 127

def paragraph(node)
  return termsource(node) if node.role == "source"
  noko do |xml|
    xml.p **para_attrs(node) do |xml_t|
      xml_t << node.content
    end
  end.join("\n")
end

#pass(node) ⇒ Object 



181
182
183
184
185
186
187
188
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 181

def pass(node)
  noko do |xml|
    xml.passthrough **attr_code(formats: 
                                node.attr("format") || "metanorma") do |p|
      p << HTMLEntities.new.encode(node.content, :basic, :hexadecimal)
    end
  end
end

#pseudocode_example(node) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 80

def pseudocode_example(node)
  # prevent A's and other subs inappropriate for pseudocode
  node.blocks.each { |b| b.remove_sub(:replacements) }
  noko do |xml|
    xml.figure **example_attrs(node).merge(class: "pseudocode") do |ex|
      figure_title(node, ex)
      wrap_in_para(node, ex)
    end
  end.join("\n")
end

#quote(node) ⇒ Object 



152
153
154
155
156
157
158
159
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 152

def quote(node)
  noko do |xml|
    xml.quote **(quote_attrs(node)) do |q|
      quote_attribution(node, q)
      wrap_in_para(node, q)
    end
  end.join("\n")
end

#quote_attribution(node, out) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 141

def quote_attribution(node, out)
  if node.attr("citetitle")
    m = /^(?<cite>[^,]+)(,(?<text>.*$))?$/m.match node.attr("citetitle")
    out.source **attr_code(target: m[:cite], type: "inline") do |s|
      s <<  m[:text]
    end
  end
  node.attr("attribution") and
    out.author { |a| a << node.attr("attribution") }
end

#quote_attrs(node) ⇒ Object 



136
137
138
139
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 136

def quote_attrs(node)
  attr_code(keep_attrs(node).merge(align: node.attr("align"), 
                                  id: Utils::anchor_or_uuid(node)))
end

#req_classif_parse(classif) ⇒ Object 



23
24
25
26
27
28
29
30
31
 
# File 'lib/asciidoctor/standoc/reqt.rb', line 23

def req_classif_parse(classif)
  ret = []
  HTMLEntities.new.decode(classif).split(/;\s*/).each do |c|
    c1 = c.split(/:\s*/)
    next unless c1.size == 2
    c1[1].split(/,\s*/).each { |v| ret << [ c1[0], v ] }
  end
  ret
end

#reqt_attrs(node) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/asciidoctor/standoc/reqt.rb', line 42

def reqt_attrs(node)
  attr_code(keep_attrs(node).merge(id_unnum_attrs(node)).merge(
    id: Utils::anchor_or_uuid(node),
    unnumbered: node.option?("unnumbered") ? "true" : nil,
    number: node.attr("number"),
    subsequence: node.attr("subsequence"),
    obligation: node.attr("obligation"),
    filename: node.attr("filename"),
    type: node.attr("type"),
    model: node.attr("model"),
  ))
end

#reqt_subpart_attrs(node) ⇒ Object 



9
10
11
12
 
# File 'lib/asciidoctor/standoc/reqt.rb', line 9

def reqt_subpart_attrs(node)
  attr_code(keep_attrs(node).merge(exclude: node.option?("exclude"),
                               type: node.attr("type")))
end

#requirement(node, obligation) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/asciidoctor/standoc/reqt.rb', line 55

def requirement(node, obligation)
  classif = node.attr("classification")
  noko do |xml|
    xml.send obligation, **reqt_attrs(node) do |ex|
      node.title and ex.title { |t| t << node.title }
      node.attr("label") and ex.label { |l| l << node.attr("label") }
      node.attr("subject") and ex.subject { |s| s << node.attr("subject") }
      i = HTMLEntities.new.decode(node.attr("inherit"))
      i&.split(/;\s*/)&.each do |i|
        ex.inherit { |inh| inh << i }
      end
      requirement_classification(classif, ex) if classif
      wrap_in_para(node, ex)
    end
  end.join("\n")
end

#requirement_classification(classif, ex) ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/asciidoctor/standoc/reqt.rb', line 33

def requirement_classification(classif, ex)
  req_classif_parse(classif).each do |r|
    ex.classification do |c|
      c.tag { |t| t << r[0] }
      c.value { |v| v << r[1] }
    end
  end
end

#requirement_subpart(node) ⇒ Object 



14
15
16
17
18
19
20
21
 
# File 'lib/asciidoctor/standoc/reqt.rb', line 14

def requirement_subpart(node)
  name = node.role || node.attr("style")
  noko do |xml|
    xml.send name, **reqt_subpart_attrs(node) do |o|
      o << node.content
    end
  end
end

#sidebar(node) ⇒ Object 



25
26
27
28
29
30
31
32
 
# File 'lib/asciidoctor/standoc/blocks_notes.rb', line 25

def sidebar(node)
  return unless draft?
  noko do |xml|
    xml.review **(sidebar_attrs(node)) do |r|
      wrap_in_para(node, r)
    end
  end
end

#sidebar_attrs(node) ⇒ Object 



20
21
22
23
 
# File 'lib/asciidoctor/standoc/blocks_notes.rb', line 20

def sidebar_attrs(node)
  todo_attrs(node).merge(attr_code(
    from: node.attr("from"), to: node.attr("to") || node.attr("from") ))
end

#stem(node) ⇒ Object

NOTE: html escaping is performed by Nokogiri



55
56
57
58
59
60
61
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 55

def stem(node)
  noko do |xml|
    xml.formula **formula_attrs(node) do |s|
      stem_parse(node.lines.join("\n"), s, node.style.to_sym)
    end
  end
end

#term_example(node) ⇒ Object 



63
64
65
66
67
68
69
 
# File 'lib/asciidoctor/standoc/blocks.rb', line 63

def term_example(node)
  noko do |xml|
    xml.termexample **id_attr(node) do |ex|
      wrap_in_para(node, ex)
    end
  end.join("\n")
end

#termnote(n) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/asciidoctor/standoc/blocks_notes.rb', line 51

def termnote(n)
  noko do |xml|
    xml.termnote **termnote_attrs(n) do |ex|
      wrap_in_para(n, ex)
    end
  end.join("\n")
end

#termnote_attrs(node) ⇒ Object 



4
5
6
7
8
9
10
11
12
 
# File 'lib/asciidoctor/standoc/blocks_notes.rb', line 4

def termnote_attrs(node)
  attr_code(id_attr(node).merge(
    unnumbered: node.attr("unnumbered"),
    number: node.attr("number"),
    subsequence: node.attr("subsequence"),
    "keep-with-next": node.attr("keep-with-next"),
    "keep-lines-together": node.attr("keep-with-next"),
    "keep-separate": node.attr("keep-separate")))
end

#todo(node) ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/asciidoctor/standoc/blocks_notes.rb', line 43

def todo(node)
  noko do |xml|
    xml.review **(todo_attrs(node)) do |r|
      wrap_in_para(node, r)
    end
  end
end

#todo_attrs(node) ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'lib/asciidoctor/standoc/blocks_notes.rb', line 34

def todo_attrs(node)
  date = node.attr("date") || Date.today.iso8601.gsub(/\+.*$/, "")
  date += "T00:00:00Z" unless /T/.match date
  attr_code(
    id: Utils::anchor_or_uuid(node),
    reviewer: node.attr("reviewer") || node.attr("source") || "(Unknown)",
    date: date )
end