Module: Asciidoctor::Standoc::Base

Included in:
Converter
Defined in:
lib/asciidoctor/standoc/base.rb

Constant Summary collapse

XML_ROOT_TAG = 
"standard-document".freeze
XML_NAMESPACE = 
"https://www.metanorma.org/ns/standoc".freeze
TERM_REFERENCE_RE_STR = 
<<~REGEXP.freeze
  ^(?<xref><(xref|concept)[^>]+>([^<]*</(xref|concept)>)?)
         (,\s(?<text>.*))?
  $
REGEXP
TERM_REFERENCE_RE = 
Regexp.new(TERM_REFERENCE_RE_STR.gsub(/\s/, "").gsub(/_/, "\\s"),
Regexp::IGNORECASE | Regexp::MULTILINE)

Instance Method Summary collapse

Instance Method Details

#add_term_source(xml_t, seen_xref, m) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/asciidoctor/standoc/base.rb', line 220

def add_term_source(xml_t, seen_xref, m)
  if seen_xref.children[0].name == "concept"
    xml_t.origin { |o| o << seen_xref.children[0].to_xml }
  else
    xml_t.origin seen_xref.children[0].content,
      **attr_code(term_source_attr(seen_xref))
  end
  m[:text] && xml_t.modification do |mod|
    mod.p { |p| p << m[:text].sub(/^\s+/, "") }
  end
end

#content(node) ⇒ Object 



39
40
41
 
# File 'lib/asciidoctor/standoc/base.rb', line 39

def content(node)
  node.content
end

#default_fonts(node) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/asciidoctor/standoc/base.rb', line 153

def default_fonts(node)
  b = node.attr("body-font") ||
    (node.attr("script") == "Hans" ? '"SimSun",serif' :
     '"Cambria",serif')
  h = node.attr("header-font") ||
    (node.attr("script") == "Hans" ? '"SimHei",sans-serif' :
     '"Cambria",serif')
  m = node.attr("monospace-font") || '"Courier New",monospace'
  "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
end

#doc_converter(node) ⇒ Object 



95
96
97
 
# File 'lib/asciidoctor/standoc/base.rb', line 95

def doc_converter(node)
  IsoDoc::WordConvert.new(doc_extract_attributes(node))
end

#doc_extract_attributes(node) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/asciidoctor/standoc/base.rb', line 74

def doc_extract_attributes(node)
  {
    script: node.attr("script"),
    bodyfont: node.attr("body-font"),
    headerfont: node.attr("header-font"),
    monospacefont: node.attr("monospace-font"),
    i18nyaml: node.attr("i18nyaml"),
    scope: node.attr("scope"),
    wordstylesheet: node.attr("wordstylesheet"),
    standardstylesheet: node.attr("standardstylesheet"),
    header: node.attr("header"),
    wordcoverpage: node.attr("wordcoverpage"),
    wordintropage: node.attr("wordintropage"),
    ulstyle: node.attr("ulstyle"),
    olstyle: node.attr("olstyle"),
    htmltoclevels: node.attr("htmltoclevels") || node.attr("toclevels"),
    doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
    break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
  }
end

#doctype(node) ⇒ Object 



198
199
200
 
# File 'lib/asciidoctor/standoc/base.rb', line 198

def doctype(node)
  node.attr("doctype")
end

#document(node) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/asciidoctor/standoc/base.rb', line 164

def document(node)
  init(node)
  ret = makexml(node).to_xml(indent: 2)
  unless node.attr("nodoc") || !node.attr("docfile")
    File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
    html_converter(node).convert(@filename + ".xml")
    doc_converter(node).convert(@filename + ".xml")
  end
  @log.write(@localdir + @filename + ".err") unless @novalid
  @files_to_delete.each { |f| FileUtils.rm f }
  ret
end

#draft? ⇒ Boolean

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/asciidoctor/standoc/base.rb', line 194

def draft?
  @draft
end

#extract_termsource_refs(text, node) ⇒ Object 



241
242
243
244
245
246
 
# File 'lib/asciidoctor/standoc/base.rb', line 241

def extract_termsource_refs(text, node)
  matched = TERM_REFERENCE_RE.match text
  matched.nil? and
    @log.add("Asciidoctor Input", node, "term reference not in expected format: #{text}")
  matched
end

#front(node, xml) ⇒ Object 



202
203
204
205
206
 
# File 'lib/asciidoctor/standoc/base.rb', line 202

def front(node, xml)
  xml.bibdata **attr_code(type: "standard") do |b|
    metadata node, b
  end
end

#html_converter(node) ⇒ Object 



70
71
72
 
# File 'lib/asciidoctor/standoc/base.rb', line 70

def html_converter(node)
  IsoDoc::HtmlConvert.new(html_extract_attributes(node))
end

#html_extract_attributes(node) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/asciidoctor/standoc/base.rb', line 50

def html_extract_attributes(node)
  {
    script: node.attr("script"),
    bodyfont: node.attr("body-font"),
    headerfont: node.attr("header-font"),
    monospacefont: node.attr("monospace-font"),
    i18nyaml: node.attr("i18nyaml"),
    scope: node.attr("scope"),
    htmlstylesheet: node.attr("htmlstylesheet"),
    htmlcoverpage: node.attr("htmlcoverpage"),
    htmlintropage: node.attr("htmlintropage"),
    scripts: node.attr("scripts"),
    scripts_pdf: node.attr("scripts-pdf"),
    datauriimage: node.attr("data-uri-image"),
    htmltoclevels: node.attr("htmltoclevels") || node.attr("toclevels"),
    doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
    break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
  }
end

#init(node) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/asciidoctor/standoc/base.rb', line 99

def init(node)
  @fn_number ||= 0
  @draft = false
  @refids = Set.new
  @anchors = {}
  @draft = node.attributes.has_key?("draft")
  @novalid = node.attr("novalid")
  @smartquotes = node.attr("smartquotes") != "false"
  @keepasciimath = node.attr("mn-keep-asciimath") &&
    node.attr("mn-keep-asciimath") != "false"
  @fontheader = default_fonts(node)
  @files_to_delete = []
  @filename = node.attr("docfile") ?
    node.attr("docfile").gsub(/\.adoc$/, "").gsub(%r{^.*/}, "") : ""
  @localdir = Utils::localdir(node)
  @no_isobib_cache = node.attr("no-isobib-cache")
  @no_isobib = node.attr("no-isobib")
  @bibdb = nil
  @seen_headers = []
  @datauriimage = node.attr("data-uri-image")
  @boilerplateauthority = node.attr("boilerplate-authority")
  @log = Asciidoctor::Standoc::Log.new
  init_bib_caches(node)
  init_iev_caches(node)
  lang = (node.attr("language") || "en")
  script = (node.attr("script") || "en")
  i18n_init(lang, script)
end

#init_bib_caches(node) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/asciidoctor/standoc/base.rb', line 128

def init_bib_caches(node)
  return if @no_isobib
  global = !@no_isobib_cache && !node.attr("local-cache-only")
  local = node.attr("local-cache") || node.attr("local-cache-only")
  local = nil if @no_isobib_cache
  @bibdb = Relaton::DbCache.init_bib_caches(
    local_cache: local,
    flush_caches: node.attr("flush-caches"),
    global_cache: global)
end

#init_iev_caches(node) ⇒ Object 



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

def init_iev_caches(node)
  unless (@no_isobib_cache || @no_isobib)
    node.attr("local-cache-only") or
      @iev_globalname = global_ievcache_name
    @iev_localname = local_ievcache_name(node.attr("local-cache") ||
                                         node.attr("local-cache-only"))
    if node.attr("flush-caches")
      FileUtils.rm_f @iev_globalname unless @iev_globalname.nil?
      FileUtils.rm_f @iev_localname unless @iev_localname.nil?
    end
  end
  #@iev = Iev::Db.new(globalname, localname) unless @no_isobib
end

#makexml(node) ⇒ Object 



186
187
188
189
190
191
192
 
# File 'lib/asciidoctor/standoc/base.rb', line 186

def makexml(node)
  result = makexml1(node)
  ret1 = cleanup(Nokogiri::XML(result))
  ret1.root.add_namespace(nil, xml_namespace)
  validate(ret1) unless @novalid
  ret1
end

#makexml1(node) ⇒ Object 



177
178
179
180
181
182
183
184
 
# File 'lib/asciidoctor/standoc/base.rb', line 177

def makexml1(node)
  result = ["<?xml version='1.0' encoding='UTF-8'?>",
            "<#{xml_root_tag}>"]
  result << noko { |ixml| front node, ixml }
  result << noko { |ixml| middle node, ixml }
  result << "</#{xml_root_tag}>"
  textcleanup(result)
end

#middle(node, xml) ⇒ Object 



208
209
210
211
212
 
# File 'lib/asciidoctor/standoc/base.rb', line 208

def middle(node, xml)
  xml.sections do |s|
    s << node.content if node.blocks?
  end
end

#skip(node, name = nil) ⇒ Object 



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

def skip(node, name = nil)
  name = name || node.node_name
  w = "converter missing for #{name} node in Metanorma backend"
  @log.add("Asciidoctor Input", node, w)
  nil
end

#term_source_attr(seen_xref) ⇒ Object 



214
215
216
217
218
 
# File 'lib/asciidoctor/standoc/base.rb', line 214

def term_source_attr(seen_xref)
  { bibitemid: seen_xref.children[0]["target"],
    format: seen_xref.children[0]["format"],
    type: "inline" }
end

#termsource(node) ⇒ Object 



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/asciidoctor/standoc/base.rb', line 248

def termsource(node)
  matched = extract_termsource_refs(node.content, node) || return
  noko do |xml|
    attrs = { status: matched[:text] ? "modified" : "identical" }
    xml.termsource **attrs do |xml_t|
      seen_xref = Nokogiri::XML.fragment(matched[:xref])
      add_term_source(xml_t, seen_xref, matched)
    end
  end.join("\n")
end

#xml_namespace ⇒ Object 



35
36
37
 
# File 'lib/asciidoctor/standoc/base.rb', line 35

def xml_namespace
  self.class::XML_NAMESPACE
end

#xml_root_tag ⇒ Object 



31
32
33
 
# File 'lib/asciidoctor/standoc/base.rb', line 31

def xml_root_tag
  self.class::XML_ROOT_TAG
end