Module: IsoDoc::Function::Utils
Constant Summary collapse
- DOCTYPE_HDR =
"<!DOCTYPE html SYSTEM " \ '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'.freeze
- HUGESTRICT =
Nokogiri::XML::ParseOptions::HUGE | Nokogiri::XML::ParseOptions::STRICT
- 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".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() = '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".freeze
Instance Method Summary collapse
- #attr_code(attributes) ⇒ Object
- #cleanup_entities(text, is_xml: true) ⇒ Object
- #date_range(date) ⇒ Object
- #emf?(type) ⇒ Boolean
- #empty2nil(str) ⇒ Object
- #eps?(type) ⇒ Boolean
- #external_path(path) ⇒ Object
-
#extract_delims(text) ⇒ Object
avoid ‘; avoid {{ (Liquid Templates); avoid [[ (Javascript).
- #from_xhtml(xml) ⇒ Object
- #get_clause_id(node) ⇒ Object
-
#get_note_container_id(node, type) ⇒ Object
no recursion on references.
- #header_strip(hdr) ⇒ Object
- #header_strip_elem?(elem) ⇒ Boolean
- #image_localfile(img) ⇒ Object
- #insert_tab(out, count) ⇒ Object
- #labelled_ancestor(node) ⇒ Object
- #liquid(doc) ⇒ Object
- #noko(&block) ⇒ Object
- #ns(xpath) ⇒ Object
- #numeric_escapes(xml) ⇒ Object
- #populate_template(docxml, _format = nil) ⇒ Object
- #save_dataimage(uri, _relative_dir = true) ⇒ Object
- #save_svg(img) ⇒ Object
- #sentence_join(array) ⇒ Object
- #start_of_sentence(node) ⇒ Object
- #to_xhtml(xml) ⇒ Object
- #to_xhtml_fragment(xml) ⇒ Object
- #to_xhtml_prep(xml) ⇒ Object
- #to_xml(node) ⇒ Object
Instance Method Details
#attr_code(attributes) ⇒ Object
31 32 33 34 35 |
# File 'lib/isodoc/function/utils.rb', line 31 def attr_code(attributes) attributes.compact.transform_values do |v| v.is_a?(String) ? HTMLEntities.new.decode(v) : v end end |
#cleanup_entities(text, is_xml: true) ⇒ Object
219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/isodoc/function/utils.rb', line 219 def cleanup_entities(text, is_xml: true) c = HTMLEntities.new if is_xml text.split(/([<>])/).each_slice(4).map do |a| a[0] = c.encode(c.decode(a[0]), :hexadecimal) a end.join else c.encode(c.decode(text), :hexadecimal) end end |
#date_range(date) ⇒ Object
10 11 12 |
# File 'lib/isodoc/function/utils.rb', line 10 def date_range(date) self.class.date_range(date) end |
#emf?(type) ⇒ Boolean
210 211 212 213 |
# File 'lib/isodoc/function/utils.rb', line 210 def emf?(type) %w(application/emf application/x-emf image/x-emf image/x-mgx-emf application/x-msmetafile image/x-xbitmap image/emf).include? type end |
#empty2nil(str) ⇒ Object
158 159 160 161 |
# File 'lib/isodoc/function/utils.rb', line 158 def empty2nil(str) !str.nil? && str.is_a?(String) && str.empty? and return nil str end |
#eps?(type) ⇒ Boolean
215 216 217 |
# File 'lib/isodoc/function/utils.rb', line 215 def eps?(type) %w(application/postscript image/x-eps).include? type end |
#external_path(path) ⇒ Object
231 232 233 234 235 236 237 238 239 |
# File 'lib/isodoc/function/utils.rb', line 231 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)
118 119 120 121 122 123 124 125 126 |
# File 'lib/isodoc/function/utils.rb', line 118 def extract_delims(text) @openmathdelim = "(#(" @closemathdelim = ")#)" while text.include?(@openmathdelim) || text.include?(@closemathdelim) @openmathdelim += "(" @closemathdelim += ")" end [@openmathdelim, @closemathdelim] end |
#from_xhtml(xml) ⇒ Object
71 72 73 74 |
# File 'lib/isodoc/function/utils.rb', line 71 def from_xhtml(xml) numeric_escapes(to_xml(xml) .sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, "")) end |
#get_clause_id(node) ⇒ Object
84 85 86 |
# File 'lib/isodoc/function/utils.rb', line 84 def get_clause_id(node) node.xpath(CLAUSE_ANCESTOR)&.last&.text || nil end |
#get_note_container_id(node, type) ⇒ Object
no recursion on references
98 99 100 101 102 103 104 |
# File 'lib/isodoc/function/utils.rb', line 98 def get_note_container_id(node, type) xpath = NOTE_CONTAINER_ANCESTOR.dup %w(figure table example).include?(type) and xpath.sub!(%r[ or local-name\(\) = '#{type}'], "") container = node.xpath(xpath) container&.last&.text || nil end |
#header_strip(hdr) ⇒ Object
128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/isodoc/function/utils.rb', line 128 def header_strip(hdr) h1 = to_xhtml_fragment(hdr.to_s.gsub(%r{<br\s*/>}, " ") .gsub(%r{</?p(\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
142 143 144 145 146 147 |
# File 'lib/isodoc/function/utils.rb', line 142 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
195 196 197 198 199 200 201 202 203 |
# File 'lib/isodoc/function/utils.rb', line 195 def image_localfile(img) img.name == "svg" && !img["src"] and return save_svg(img) case img["src"] when /^data:/ then save_dataimage(img["src"], false) when %r{^([A-Z]:)?/} then img["src"] else File.join(@localdir, img["src"]) end end |
#insert_tab(out, count) ⇒ Object
22 23 24 25 |
# File 'lib/isodoc/function/utils.rb', line 22 def insert_tab(out, count) tab = %w(Hans Hant).include?(@script) ? " " : "  " [1..count].each { out << tab } end |
#labelled_ancestor(node) ⇒ Object
205 206 207 208 |
# File 'lib/isodoc/function/utils.rb', line 205 def labelled_ancestor(node) !node.ancestors("example, requirement, recommendation, permission, " \ "note, table, figure, sourcecode").empty? end |
#liquid(doc) ⇒ Object
149 150 151 152 153 154 155 156 |
# File 'lib/isodoc/function/utils.rb', line 149 def liquid(doc) # unescape HTML escapes in doc doc = doc.split(%r<(\{%|%\})>).each_slice(4).map do |a| a[2] = a[2].gsub(/</, "<").gsub(/>/, ">") if a.size > 2 a.join end.join Liquid::Template.parse(doc) end |
#noko(&block) ⇒ Object
27 28 29 |
# File 'lib/isodoc/function/utils.rb', line 27 def noko(&block) Metanorma::Utils::noko_html(&block) end |
#ns(xpath) ⇒ Object
14 15 16 |
# File 'lib/isodoc/function/utils.rb', line 14 def ns(xpath) self.class.ns(xpath) end |
#numeric_escapes(xml) ⇒ Object
57 58 59 |
# File 'lib/isodoc/function/utils.rb', line 57 def numeric_escapes(xml) Metanorma::Utils::numeric_escapes(xml) end |
#populate_template(docxml, _format = nil) ⇒ Object
163 164 165 166 167 168 169 170 171 172 |
# File 'lib/isodoc/function/utils.rb', line 163 def populate_template(docxml, _format = nil) = @meta .get .merge(@labels ? { labels: @labels } : {}) .merge(@meta.labels ? { labels: @meta.labels } : {}) .merge( || {}) template = liquid(docxml) template.render(.map { |k, v| [k.to_s, empty2nil(v)] }.to_h) .gsub("<", "<").gsub(">", ">").gsub("&", "&") end |
#save_dataimage(uri, _relative_dir = true) ⇒ Object
174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/isodoc/function/utils.rb', line 174 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 |
#save_svg(img) ⇒ Object
187 188 189 190 191 192 193 |
# File 'lib/isodoc/function/utils.rb', line 187 def save_svg(img) Tempfile.open(["image", ".svg"]) do |f| f.write(img.to_xml) @tempfile_cache << f # persist to the end f.path end end |
#sentence_join(array) ⇒ Object
106 107 108 109 110 111 112 113 114 115 |
# File 'lib/isodoc/function/utils.rb', line 106 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 |
#start_of_sentence(node) ⇒ Object
18 19 20 |
# File 'lib/isodoc/function/utils.rb', line 18 def start_of_sentence(node) self.class.start_of_sentence(node) end |
#to_xhtml(xml) ⇒ Object
44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/isodoc/function/utils.rb', line 44 def to_xhtml(xml) xml = to_xhtml_prep(xml) begin Nokogiri::XML.parse(xml, nil, nil, HUGESTRICT) 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
67 68 69 |
# File 'lib/isodoc/function/utils.rb', line 67 def to_xhtml_fragment(xml) Metanorma::Utils::to_xhtml_fragment(xml) end |
#to_xhtml_prep(xml) ⇒ Object
61 62 63 64 65 |
# File 'lib/isodoc/function/utils.rb', line 61 def to_xhtml_prep(xml) xml.gsub!(/<\?xml[^>]*>/, "") /<!DOCTYPE /.match(xml) || (xml = DOCTYPE_HDR + xml) numeric_escapes(xml) end |
#to_xml(node) ⇒ Object
6 7 8 |
# File 'lib/isodoc/function/utils.rb', line 6 def to_xml(node) self.class.to_xml(node) end |