Module: IsoDoc::Function::Utils

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

Constant Summary collapse

NOKOHEAD =

add namespaces for Word fragments

<<~HERE
  <!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">'
CLAUSE_ANCESTOR = 
".//ancestor::*[local-name() = 'annex' or "\
"local-name() = 'definitions' or "\
"local-name() = 'acknowledgements' or local-name() = 'term' 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"
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() = 'acknowledgements' or local-name() = 'term' 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"

Instance Method Summary collapse

Instance Method Details

#attr_code(attributes) ⇒ Object 



39
40
41
42
43
 
# File 'lib/isodoc/function/utils.rb', line 39

def attr_code(attributes)
  attributes.compact.transform_values do |v|
    v.is_a?(String) ? HTMLEntities.new.decode(v) : v
  end
end

#cleanup_entities(text) ⇒ Object 



216
217
218
219
220
221
222
 
# File 'lib/isodoc/function/utils.rb', line 216

def cleanup_entities(text)
  c = HTMLEntities.new
  text.split(/([<>])/).each_slice(4).map do |a|
    a[0] = c.encode(c.decode(a[0]), :hexadecimal)
    a
  end.join
end

#date_range(date) ⇒ Object 



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

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

#emf?(type) ⇒ Boolean

Returns:

  • (Boolean) 


211
212
213
214
 
# File 'lib/isodoc/function/utils.rb', line 211

def emf?(type)
  %w(application/emf application/x-emf image/x-emf image/x-mgx-emf
     application/x-msmetafile image/x-xbitmap).include? type
end

#empty2nil(str) ⇒ Object 



159
160
161
162
163
 
# File 'lib/isodoc/function/utils.rb', line 159

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

  str
end

#external_path(path) ⇒ Object 



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/isodoc/function/utils.rb', line 224

def external_path(path)
  win = !!((RUBY_PLATFORM =~ /(win|w)(32|64)$/) ||
           (RUBY_PLATFORM =~ /mswin|mingw/))
  if win
    path.gsub!(%{/}, "\\")
    path[/\s/] ? "\"#{path}\"" : path
  else
    path
  end
end

#extract_delims(text) ⇒ Object

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



120
121
122
123
124
125
126
127
128
 
# File 'lib/isodoc/function/utils.rb', line 120

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

#from_xhtml(xml) ⇒ Object 



77
78
79
 
# File 'lib/isodoc/function/utils.rb', line 77

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

#get_clause_id(node) ⇒ Object 



89
90
91
92
 
# File 'lib/isodoc/function/utils.rb', line 89

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

#get_note_container_id(node) ⇒ Object 



103
104
105
106
 
# File 'lib/isodoc/function/utils.rb', line 103

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

#header_strip(hdr) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/isodoc/function/utils.rb', line 130

def header_strip(hdr)
  h1 = to_xhtml_fragment(hdr.to_s.gsub(%r{<br\s*/>}, " ")
    .gsub(/<\/?h[123456][^>]*>/, "").gsub(/<\/?b[^>]*>/, "").dup)
  h1.traverse do |x|
    if x.name == "span" && /mso-tab-count/.match(x["style"])
      x.replace(" ")
    elsif header_strip_elem?(x) then x.remove
    elsif x.name == "a" then x.replace(x.children)
    end
  end
  from_xhtml(h1)
end

#header_strip_elem?(elem) ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
146
147
148
 
# File 'lib/isodoc/function/utils.rb', line 143

def header_strip_elem?(elem)
  elem.name == "img" ||
    elem.name == "span" && elem["class"] == "MsoCommentReference" ||
    elem.name == "a" && elem["class"] == "FootnoteRef" ||
    elem.name == "span" && /mso-bookmark/.match(elem["style"])
end

#image_localfile(img) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/isodoc/function/utils.rb', line 189

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

#insert_tab(out, count) ⇒ Object 



14
15
16
17
 
# File 'lib/isodoc/function/utils.rb', line 14

def insert_tab(out, count)
  tab = %w(Hans Hant).include?(@script) ? "&#x3000;" : "&nbsp; "
  [1..count].each { out << tab }
end

#labelled_ancestor(node) ⇒ Object 



206
207
208
209
 
# File 'lib/isodoc/function/utils.rb', line 206

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

#liquid(doc) ⇒ Object 



150
151
152
153
154
155
156
157
 
# File 'lib/isodoc/function/utils.rb', line 150

def liquid(doc)
  # unescape HTML escapes in doc
  doc = doc.split(%r<(\{%|%\})>).each_slice(4).map do |a|
    a[2] = a[2].gsub(/&lt;/, "<").gsub(/&gt;/, ">") if a.size > 2
    a.join
  end.join
  Liquid::Template.parse(doc)
end

#noko(&block) ⇒ Object

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



30
31
32
33
34
35
36
37
 
# File 'lib/isodoc/function/utils.rb', line 30

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 



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

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

#populate_template(docxml, _format = nil) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/isodoc/function/utils.rb', line 165

def populate_template(docxml, _format = nil)
  meta = @meta
    .get
    .merge(@labels ? { labels: @labels } : {})
    .merge(@meta.labels ? { labels: @meta.labels } : {})
    .merge(fonts_options || {})
  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 



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/isodoc/function/utils.rb', line 176

def save_dataimage(uri, _relative_dir = true)
  %r{^data:(?<imgclass>image|application)/(?<imgtype>[^;]+);(charset=[^;]+;)?base64,(?<imgdata>.+)$} =~ uri
  imgtype = "emf" if emf?("#{imgclass}/#{imgtype}")
  imgtype = imgtype.sub(/\+[a-z0-9]+$/, "") # svg+xml
  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 



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/isodoc/function/utils.rb', line 108

def sentence_join(array)
  return "" if array.nil? || array.empty?

  if array.length == 1 then array[0]
  else
    @i18n.l10n("#{array[0..-2].join(', ')} "\
               "#{@i18n.and} #{array.last}",
               @lang, @script)
  end
end

#to_xhtml(xml) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/isodoc/function/utils.rb', line 48

def to_xhtml(xml)
  xml = to_xhtml_prep(xml)
  begin
    Nokogiri::XML.parse(xml, &:strict)
  rescue Nokogiri::XML::SyntaxError => e
    File.open("#{@filename}.#{@format}.err", "w:UTF-8") do |f|
      f.write xml
    end
    abort "Malformed Output XML for #{@format}: #{e} "\
          "(see #{@filename}.#{@format}.err)"
  end
end

#to_xhtml_fragment(xml) ⇒ Object 



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

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

#to_xhtml_prep(xml) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/isodoc/function/utils.rb', line 61

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