Module: IsoDoc::Function::Utils

Included in:
Common
Defined in:
lib/isodoc/function/utils.rb

Constant Summary collapse

NOKOHEAD =

add namespaces for Word fragments

<<~HERE.freeze
<!DOCTYPE html SYSTEM
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head> <title></title> <meta charset="UTF-8" /> </head>
<body> </body> </html>
HERE
DOCTYPE_HDR = 
'<!DOCTYPE html SYSTEM '\
'"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'.freeze
CLAUSE_ANCESTOR = 
".//ancestor::*[local-name() = 'annex' or "\
"local-name() = 'appendix' or local-name() = 'foreword' or "\
"local-name() = 'introduction' or local-name() = 'terms' or "\
"local-name() = 'clause' or local-name() = 'references']/@id".freeze
NOTE_CONTAINER_ANCESTOR = 
".//ancestor::*[local-name() = 'annex' or "\
"local-name() = 'foreword' or local-name() = 'appendix' or "\
"local-name() = 'introduction' or local-name() = 'terms' or "\
"local-name() = 'clause' or local-name() = 'references' or "\
"local-name() = 'figure' or local-name() = 'formula' or "\
"local-name() = 'table' or local-name() = 'example']/@id".freeze

Instance Method Summary collapse

Instance Method Details

#attr_code(attributes) ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/isodoc/function/utils.rb', line 35

def attr_code(attributes)
  attributes = attributes.reject { |_, val| val.nil? }.map
  attributes.map do |k, v|
    [k, (v.is_a? String) ? HTMLEntities.new.decode(v) : v]
  end.to_h
end

#date_range(date) ⇒ Object 



3
4
5
 
# File 'lib/isodoc/function/utils.rb', line 3

def date_range(date)
  self.class.date_range(date)
end

#empty2nil(v) ⇒ Object 



136
137
138
139
 
# File 'lib/isodoc/function/utils.rb', line 136

def empty2nil(v)
  return nil if !v.nil? && v.is_a?(String) && v.empty?
  v
end

#extract_delims(text) ⇒ Object

avoid ‘; avoid {{ (Liquid Templates); avoid [[ (Javascript)



100
101
102
103
104
105
106
107
108
 
# File 'lib/isodoc/function/utils.rb', line 100

def extract_delims(text)
  @openmathdelim = "(#("
  @closemathdelim = ")#)"
  while text.include?(@openmathdelim) || text.include?(@closemathdelim)
    @openmathdelim += "("
    @closemathdelim += ")"
  end
  [@openmathdelim, @closemathdelim]
end

#from_xhtml(xml) ⇒ Object 



61
62
63
 
# File 'lib/isodoc/function/utils.rb', line 61

def from_xhtml(xml)
  xml.to_xml.sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, "")
end

#get_clause_id(node) ⇒ Object 



71
72
73
74
 
# File 'lib/isodoc/function/utils.rb', line 71

def get_clause_id(node)
  clause = node.xpath(CLAUSE_ANCESTOR)
  clause&.last&.text || nil
end

#get_note_container_id(node) ⇒ Object 



84
85
86
87
 
# File 'lib/isodoc/function/utils.rb', line 84

def get_note_container_id(node)
  container = node.xpath(NOTE_CONTAINER_ANCESTOR)
  container&.last&.text || nil
end

#header_strip(h) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/isodoc/function/utils.rb', line 110

def header_strip(h)
  h = h.to_s.gsub(%r{<br/>}, " ").sub(/<\/?h[123456][^>]*>/, "")
  h1 = to_xhtml_fragment(h.dup)
  h1.traverse do |x|
    x.replace(" ") if x.name == "span" && /mso-tab-count/.match(x["style"])
    x.remove if x.name == "span" && x["class"] == "MsoCommentReference"
    x.remove if x.name == "a" && x["epub:type"] == "footnote"
    x.remove if x.name == "span" && /mso-bookmark/.match(x["style"])
    x.replace(x.children) if x.name == "a"
  end
  from_xhtml(h1)
end

#image_localfile(i) ⇒ Object 



170
171
172
173
174
175
176
177
178
 
# File 'lib/isodoc/function/utils.rb', line 170

def image_localfile(i)
  if /^data:image/.match i["src"]
    save_dataimage(i["src"], false)
  elsif %r{^([A-Z]:)?/}.match i["src"]
    i["src"]
  else
    File.join(@localdir, i["src"])
  end
end

#insert_tab(out, n) ⇒ Object 



11
12
13
 
# File 'lib/isodoc/function/utils.rb', line 11

def insert_tab(out, n)
  [1..n].each { out << "&nbsp; " }
end

#labelled_ancestor(node) ⇒ Object 



180
181
182
183
 
# File 'lib/isodoc/function/utils.rb', line 180

def labelled_ancestor(node)
  return !node.ancestors("example, requirement, recommendation, permission, "\
                         "table, figure, sourcecode").empty?
end

#liquid(doc) ⇒ Object 



123
124
125
 
# File 'lib/isodoc/function/utils.rb', line 123

def liquid(doc)
  self.class.liquid(doc)
end

#noko(&block) ⇒ Object

block for processing XML document fragments as XHTML, to allow for HTMLentities



26
27
28
29
30
31
32
33
 
# File 'lib/isodoc/function/utils.rb', line 26

def noko(&block)
  doc = ::Nokogiri::XML.parse(NOKOHEAD)
  fragment = doc.fragment("")
  ::Nokogiri::XML::Builder.with fragment, &block
  fragment.to_xml(encoding: "US-ASCII").lines.map do |l|
    l.gsub(/\s*\n/, "")
  end
end

#ns(xpath) ⇒ Object 



7
8
9
 
# File 'lib/isodoc/function/utils.rb', line 7

def ns(xpath)
  self.class.ns(xpath)
end

#populate_template(docxml, _format) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/isodoc/function/utils.rb', line 141

def populate_template(docxml, _format)
  meta = @meta.get.merge(@labels || {})
  docxml = docxml.
    gsub(/\[TERMREF\]\s*/, l10n("[#{@source_lbl}: ")).
    gsub(/\s*\[MODIFICATION\]\s*\[\/TERMREF\]/, l10n(", #{@modified_lbl} [/TERMREF]")).
    gsub(/\s*\[\/TERMREF\]\s*/, l10n("]")).
    gsub(/\s*\[MODIFICATION\]/, l10n(", #{@modified_lbl} &mdash; "))
  template = liquid(docxml)
  template.render(meta.map { |k, v| [k.to_s, empty2nil(v)] }.to_h).
    gsub('&lt;', '&#x3c;').gsub('&gt;', '&#x3e;').gsub('&amp;', '&#x26;')
end

#save_dataimage(uri, relative_dir = true) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/isodoc/function/utils.rb', line 153

def save_dataimage(uri, relative_dir = true)
  %r{^data:image/(?<imgtype>[^;]+);base64,(?<imgdata>.+)$} =~ uri
  #uuid = UUIDTools::UUID.random_create.to_s
  #fname = "#{uuid}.#{imgtype}"
  #new_file = File.join(tmpimagedir, fname)
  #@files_to_delete << new_file
  #File.open(new_file, "wb") { |f| f.write(Base64.strict_decode64(imgdata)) }
  #File.join(relative_dir ? rel_tmpimagedir : tmpimagedir, fname)
  imgtype = "png" unless /^[a-z0-9]+$/.match imgtype
  Tempfile.open(["image", ".#{imgtype}"]) do |f|
    f.binmode
    f.write(Base64.strict_decode64(imgdata))
    @tempfile_cache << f #persist to the end
    f.path
  end
end

#sentence_join(array) ⇒ Object 



89
90
91
92
93
94
95
96
97
 
# File 'lib/isodoc/function/utils.rb', line 89

def sentence_join(array)
  return "" if array.nil? || array.empty?
  if array.length == 1 then array[0]
  else
    IsoDoc::Function::I18n::l10n("#{array[0..-2].join(', ')} "\
                                 "#{@and_lbl} #{array.last}",
                                 @lang, @script)
  end
end

#to_xhtml(xml) ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'lib/isodoc/function/utils.rb', line 45

def to_xhtml(xml)
  xml.gsub!(/<\?xml[^>]*>/, "")
  /<!DOCTYPE /.match xml or xml = DOCTYPE_HDR + xml
  xml = xml.split(/(\&[^ \r\n\t#;]+;)/).map do |t|
    /^(\&[^ \t\r\n#;]+;)/.match(t) ? 
      HTMLEntities.new.encode(HTMLEntities.new.decode(t), :hexadecimal) : t
  end.join("")
  Nokogiri::XML.parse(xml)
end

#to_xhtml_fragment(xml) ⇒ Object 



55
56
57
58
59
 
# File 'lib/isodoc/function/utils.rb', line 55

def to_xhtml_fragment(xml)
  doc = ::Nokogiri::XML.parse(NOKOHEAD)
  fragment = doc.fragment(xml)
  fragment
end