Class: Metanorma::Compile
- Inherits:
-
Object
- Object
- Metanorma::Compile
- Defined in:
- lib/metanorma/compile.rb,
lib/metanorma/extract.rb,
lib/metanorma/compile_options.rb,
lib/metanorma/compile_validate.rb
Constant Summary collapse
- REQUIREMENT_XPATH =
"//requirement | //xmlns:requirement | //recommendation | "\ "//xmlns:recommendation | //permission | //xmlns:permission".freeze
Instance Attribute Summary collapse
- #errors ⇒ Array<String> readonly
- #processor ⇒ Array<String> readonly
Instance Method Summary collapse
- #clean_sourcecode(xml) ⇒ Object
- #compile(filename, options = {}) ⇒ Object
- #export_output(fname, content, **options) ⇒ Object
- #extract(isodoc, dirname, extract_types) ⇒ Object
- #extract_extensions(options) ⇒ Object
- #font_install(opt) ⇒ Object
- #font_install_override(opt) ⇒ Object
- #gather_and_install_fonts(file, options, extensions) ⇒ Object
- #get_extensions(options) ⇒ Object
- #image_export(xml, dirname) ⇒ Object
-
#initialize ⇒ Compile
constructor
A new instance of Compile.
- #options_extract(filename, options) ⇒ Object
- #process_ext(ext, file, isodoc, fnames, options) ⇒ Object
- #process_ext_simple(ext, isodoc, fnames, options, isodoc_options) ⇒ Object
-
#process_exts(filename, extensions, file, isodoc, options) ⇒ Object
isodoc is Raw Metanorma XML.
- #process_exts1(ext, fnames, isodoc, options, isodoc_options) ⇒ Object
- #process_exts_run(fnames, file, isodoc, extensions, options) ⇒ Object
- #process_input(filename, options) ⇒ Object
- #process_input_adoc(filename, options) ⇒ Object
- #process_input_xml(filename, _options) ⇒ Object
- #process_output_threaded(ext, fnames1, options1, isodoc_options1) ⇒ Object
- #process_output_unthreaded(ext, fnames, isodoc, isodoc_options) ⇒ Object
- #read_file(filename) ⇒ Object
- #relaton_export(isodoc, options) ⇒ Object
- #require_libraries(options) ⇒ Object
- #requirement_export(xml, dirname) ⇒ Object
-
#sectionsplit_convert(input_filename, file, output_filename = nil, opts = {}) ⇒ Object
assume we pass in Presentation XML, but we want to recover Semantic XML.
- #sourcecode_export(xml, dirname) ⇒ Object
- #validate_format(options) ⇒ Object
- #validate_options(options) ⇒ Object
- #validate_type(options) ⇒ Object
- #wrap_html(options, file_extension, outfilename) ⇒ Object
- #xml_options_extract(file) ⇒ Object
Constructor Details
Instance Attribute Details
#errors ⇒ Array<String> (readonly)
18 19 20 |
# File 'lib/metanorma/compile.rb', line 18 def errors @errors end |
#processor ⇒ Array<String> (readonly)
18 19 20 |
# File 'lib/metanorma/compile.rb', line 18 def processor @processor end |
Instance Method Details
#clean_sourcecode(xml) ⇒ Object
13 14 15 16 17 18 |
# File 'lib/metanorma/extract.rb', line 13 def clean_sourcecode(xml) xml.xpath(".//callout | .//annotation | .//xmlns:callout | "\ ".//xmlns:annotation").each(&:remove) xml.xpath(".//br | .//xmlns:br").each { |x| x.replace("\n") } HTMLEntities.new.decode(xml.children.to_xml) end |
#compile(filename, options = {}) ⇒ Object
27 28 29 30 31 32 33 34 35 36 37 |
# File 'lib/metanorma/compile.rb', line 27 def compile(filename, = {}) require_libraries() = (filename, ) () @processor = @registry.find_processor([:type].to_sym) extensions = get_extensions() or return nil (file, isodoc = process_input(filename, )) or return nil relaton_export(isodoc, ) extract(isodoc, [:extract], [:extract_type]) process_exts(filename, extensions, file, isodoc, ) end |
#export_output(fname, content, **options) ⇒ Object
83 84 85 86 |
# File 'lib/metanorma/compile.rb', line 83 def export_output(fname, content, **) mode = [:binary] ? "wb" : "w:UTF-8" File.open(fname, mode) { |f| f.write content } end |
#extract(isodoc, dirname, extract_types) ⇒ Object
20 21 22 23 24 25 26 27 28 29 30 31 32 |
# File 'lib/metanorma/extract.rb', line 20 def extract(isodoc, dirname, extract_types) return unless dirname extract_types.nil? || extract_types.empty? and extract_types = %i[sourcecode image requirement] FileUtils.rm_rf dirname FileUtils.mkdir_p dirname xml = Nokogiri::XML(isodoc) { |config| config.huge } sourcecode_export(xml, dirname) if extract_types.include? :sourcecode image_export(xml, dirname) if extract_types.include? :image extract_types.include?(:requirement) and requirement_export(xml, dirname) end |
#extract_extensions(options) ⇒ Object
48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/metanorma/compile_options.rb', line 48 def extract_extensions() [:extension_keys].reduce([]) do |memo, e| if @processor.output_formats[e] then memo << e else = "[metanorma] Error: #{e} format is not supported " \ "for this standard." @errors << Util.log(, :error) memo end end end |
#font_install(opt) ⇒ Object
61 62 63 64 65 66 67 68 |
# File 'lib/metanorma/compile_options.rb', line 61 def font_install(opt) FontistUtils.install_fonts(@processor, opt) unless @fontist_installed @fontist_installed = true !opt[:fonts] || opt[:fontlicenseagreement] == "continue-without-fonts" and return @font_overrides ||= [] font_install_override(opt) end |
#font_install_override(opt) ⇒ Object
70 71 72 73 74 75 76 77 |
# File 'lib/metanorma/compile_options.rb', line 70 def font_install_override(opt) confirm = opt[:fontlicenseagreement] == "no-install-fonts" ? "no" : "yes" CSV.parse_line(opt[:fonts], col_sep: ";").map(&:strip).each do |f| @font_overrides.include?(f) and next Fontist::Font.install(f, confirmation: confirm) @font_overrides << f end end |
#gather_and_install_fonts(file, options, extensions) ⇒ Object
116 117 118 119 120 121 |
# File 'lib/metanorma/compile.rb', line 116 def gather_and_install_fonts(file, , extensions) Util.sort_extensions_execution(extensions).each do |ext| = (file, , ext) font_install(.merge()) end end |
#get_extensions(options) ⇒ Object
36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/metanorma/compile_options.rb', line 36 def get_extensions() [:extension_keys] ||= @processor.output_formats.reduce([]) { |memo, (k, _)| memo << k } extensions = extract_extensions() if !extensions.include?(:presentation) && extensions.any? do |e| @processor.use_presentation_xml(e) end extensions << :presentation end extensions end |
#image_export(xml, dirname) ⇒ Object
44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/metanorma/extract.rb', line 44 def image_export(xml, dirname) xml.at("//image | //xmlns:image") or return FileUtils.mkdir_p "#{dirname}/image" xml.xpath("//image | //xmlns:image").each_with_index do |s, i| next unless /^data:image/.match? s["src"] %r{^data:image/(?<imgtype>[^;]+);base64,(?<imgdata>.+)$} =~ s["src"] fn = s["filename"] || sprintf("image-%<num>04d.%<name>s", num: i, name: imgtype) export_output("#{dirname}/image/#{fn}", Base64.strict_decode64(imgdata), binary: true) end end |
#options_extract(filename, options) ⇒ Object
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
# File 'lib/metanorma/compile_options.rb', line 19 def (filename, ) content = read_file(filename) o = Metanorma::Input::Asciidoc.new.(content) .merge((content)) [:type] ||= o[:type]&.to_sym t = @registry.alias([:type]) and [:type] = t dir = filename.sub(%r(/[^/]+$), "/") [:relaton] ||= File.join(dir, o[:relaton]) if o[:relaton] [:sourcecode] ||= File.join(dir, o[:sourcecode]) if o[:sourcecode] [:extension_keys] ||= o[:extensions]&.split(/, */)&.map(&:to_sym) [:extension_keys] = nil if [:extension_keys] == [:all] [:format] ||= :asciidoc [:filename] = filename [:fontlicenseagreement] ||= "no-install-fonts" end |
#process_ext(ext, file, isodoc, fnames, options) ⇒ Object
123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/metanorma/compile.rb', line 123 def process_ext(ext, file, isodoc, fnames, ) fnames[:ext] = @processor.output_formats[ext] fnames[:out] = fnames[:f].sub(/\.[^.]+$/, ".#{fnames[:ext]}") = (file, , ext) thread = true unless process_ext_simple(ext, isodoc, fnames, , ) thread = process_exts1(ext, fnames, isodoc, , ) end thread end |
#process_ext_simple(ext, isodoc, fnames, options, isodoc_options) ⇒ Object
135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/metanorma/compile.rb', line 135 def process_ext_simple(ext, isodoc, fnames, , ) if ext == :rxl relaton_export(isodoc, .merge(relaton: fnames[:out])) elsif [:passthrough_presentation_xml] && ext == :presentation f = File.exist?(fnames[:f]) ? fnames[:f] : fnames[:orig_filename] FileUtils.cp f, fnames[:presentationxml] elsif ext == :html && [:sectionsplit] sectionsplit_convert(fnames[:xml], isodoc, fnames[:out], ) else return false end true end |
#process_exts(filename, extensions, file, isodoc, options) ⇒ Object
isodoc is Raw Metanorma XML
98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/metanorma/compile.rb', line 98 def process_exts(filename, extensions, file, isodoc, ) f = File.(change_output_dir()) fnames = { xml: f.sub(/\.[^.]+$/, ".xml"), f: f, orig_filename: File.(filename), presentationxml: f.sub(/\.[^.]+$/, ".presentation.xml") } @queue = ::Metanorma::WorkersPool .new(ENV["METANORMA_PARALLEL"]&.to_i || 3) gather_and_install_fonts(file, .dup, extensions) process_exts_run(fnames, file, isodoc, extensions, ) @queue.shutdown end |
#process_exts1(ext, fnames, isodoc, options, isodoc_options) ⇒ Object
149 150 151 152 153 154 155 156 157 158 |
# File 'lib/metanorma/compile.rb', line 149 def process_exts1(ext, fnames, isodoc, , ) if @processor.use_presentation_xml(ext) @queue.schedule(ext, fnames.dup, .dup, .dup) do |a, b, c, d| process_output_threaded(a, b, c, d) end else process_output_unthreaded(ext, fnames, isodoc, ) end end |
#process_exts_run(fnames, file, isodoc, extensions, options) ⇒ Object
110 111 112 113 114 |
# File 'lib/metanorma/compile.rb', line 110 def process_exts_run(fnames, file, isodoc, extensions, ) Util.sort_extensions_execution(extensions).each do |ext| process_ext(ext, file, isodoc, fnames, ) or break end end |
#process_input(filename, options) ⇒ Object
39 40 41 42 43 44 45 46 47 48 |
# File 'lib/metanorma/compile.rb', line 39 def process_input(filename, ) case extname = File.extname(filename) when ".adoc" then process_input_adoc(filename, ) when ".xml" then process_input_xml(filename, ) else Util.log("[metanorma] Error: file extension #{extname} " \ "is not supported.", :error) nil end end |
#process_input_adoc(filename, options) ⇒ Object
50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/metanorma/compile.rb', line 50 def process_input_adoc(filename, ) Util.log("[metanorma] Processing: AsciiDoc input.", :info) file = read_file(filename) [:asciimath] and file.sub!(/^(=[^\n]+\n)/, "\\1:mn-keep-asciimath:\n") dir = File.dirname(filename) dir != "." and file = file.gsub(/^include::/, "include::#{dir}/") .gsub(/^embed::/, "embed::#{dir}/") [file, @processor.input_to_isodoc(file, filename, )] end |
#process_input_xml(filename, _options) ⇒ Object
62 63 64 65 66 67 |
# File 'lib/metanorma/compile.rb', line 62 def process_input_xml(filename, ) Util.log("[metanorma] Processing: Metanorma XML input.", :info) # TODO NN: this is a hack -- we should provide/bridge the # document attributes in Metanorma XML ["", read_file(filename)] end |
#process_output_threaded(ext, fnames1, options1, isodoc_options1) ⇒ Object
160 161 162 163 164 165 166 167 |
# File 'lib/metanorma/compile.rb', line 160 def process_output_threaded(ext, fnames1, , ) @processor.output(nil, fnames1[:presentationxml], fnames1[:out], ext, ) wrap_html(, fnames1[:ext], fnames1[:out]) rescue StandardError => e strict = ext == :presentation || [:strict] == true isodoc_error_process(e, strict, false) end |
#process_output_unthreaded(ext, fnames, isodoc, isodoc_options) ⇒ Object
169 170 171 172 173 174 175 176 177 |
# File 'lib/metanorma/compile.rb', line 169 def process_output_unthreaded(ext, fnames, isodoc, ) @processor.output(isodoc, fnames[:xml], fnames[:out], ext, ) true # return as Thread rescue StandardError => e strict = ext == :presentation || [:strict] == "true" isodoc_error_process(e, strict, true) ext != :presentation end |
#read_file(filename) ⇒ Object
69 70 71 |
# File 'lib/metanorma/compile.rb', line 69 def read_file(filename) File.read(filename, encoding: "utf-8").gsub("\r\n", "\n") end |
#relaton_export(isodoc, options) ⇒ Object
73 74 75 76 77 78 79 80 81 |
# File 'lib/metanorma/compile.rb', line 73 def relaton_export(isodoc, ) return unless [:relaton] xml = Nokogiri::XML(isodoc) { |config| config.huge } bibdata = xml.at("//bibdata") || xml.at("//xmlns:bibdata") # docid = bibdata&.at("./xmlns:docidentifier")&.text || options[:filename] # outname = docid.sub(/^\s+/, "").sub(/\s+$/, "").gsub(/\s+/, "-") + ".xml" File.open([:relaton], "w:UTF-8") { |f| f.write bibdata.to_xml } end |
#require_libraries(options) ⇒ Object
5 6 7 |
# File 'lib/metanorma/compile_options.rb', line 5 def require_libraries() &.dig(:require)&.each { |r| require r } end |
#requirement_export(xml, dirname) ⇒ Object
62 63 64 65 66 67 68 69 70 |
# File 'lib/metanorma/extract.rb', line 62 def requirement_export(xml, dirname) xml.at(REQUIREMENT_XPATH) or return FileUtils.mkdir_p "#{dirname}/requirement" xml.xpath(REQUIREMENT_XPATH).each_with_index do |s, i| fn = s["filename"] || sprintf("%<name>s-%<num>04d.xml", name: s.name, num: i) export_output("#{dirname}/requirement/#{fn}", s) end end |
#sectionsplit_convert(input_filename, file, output_filename = nil, opts = {}) ⇒ Object
assume we pass in Presentation XML, but we want to recover Semantic XML
180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/metanorma/compile.rb', line 180 def sectionsplit_convert(input_filename, file, output_filename = nil, opts = {}) @isodoc ||= IsoDoc::PresentationXMLConvert.new({}) input_filename += ".xml" unless input_filename.match?(/\.xml$/) File.exist?(input_filename) or File.open(input_filename, "w:UTF-8") { |f| f.write(file) } presxml = File.read(input_filename, encoding: "utf-8") _xml, filename, dir = @isodoc.convert_init(presxml, input_filename, false) Sectionsplit.new(input: input_filename, isodoc: @isodoc, xml: presxml, base: File.basename(output_filename || filename), output: output_filename || filename, dir: dir, compile_opts: opts).build_collection end |
#sourcecode_export(xml, dirname) ⇒ Object
34 35 36 37 38 39 40 41 42 |
# File 'lib/metanorma/extract.rb', line 34 def sourcecode_export(xml, dirname) xml.at("//sourcecode | //xmlns:sourcecode") or return FileUtils.mkdir_p "#{dirname}/sourcecode" xml.xpath("//sourcecode | //xmlns:sourcecode").each_with_index do |s, i| filename = s["filename"] || sprintf("sourcecode-%04d.txt", i) export_output("#{dirname}/sourcecode/#{filename}", clean_sourcecode(s.dup)) end end |
#validate_format(options) ⇒ Object
17 18 19 20 21 22 |
# File 'lib/metanorma/compile_validate.rb', line 17 def validate_format() unless [:format] == :asciidoc Util.log("[metanorma] Error: Only source file format currently "\ "supported is 'asciidoc'.", :fatal) end end |
#validate_options(options) ⇒ Object
3 4 5 6 |
# File 'lib/metanorma/compile_validate.rb', line 3 def () validate_type() validate_format() end |
#validate_type(options) ⇒ Object
8 9 10 11 12 13 14 15 |
# File 'lib/metanorma/compile_validate.rb', line 8 def validate_type() unless [:type] Util.log("[metanorma] Error: Please specify a standard type: "\ "#{@registry.supported_backends}.", :fatal) end stdtype = [:type].to_sym load_flavor(stdtype) end |
#wrap_html(options, file_extension, outfilename) ⇒ Object
88 89 90 91 92 93 94 95 |
# File 'lib/metanorma/compile.rb', line 88 def wrap_html(, file_extension, outfilename) if [:wrapper] && /html$/.match(file_extension) outfilename = outfilename.sub(/\.html$/, "") FileUtils.mkdir_p outfilename FileUtils.mv "#{outfilename}.html", outfilename FileUtils.mv "#{outfilename}_images", outfilename, force: true end end |
#xml_options_extract(file) ⇒ Object
9 10 11 12 13 14 15 16 17 |
# File 'lib/metanorma/compile_options.rb', line 9 def (file) xml = Nokogiri::XML(file, &:huge) if xml.root @registry..each do |k, v| return { type: k } if v == xml.root.name end end {} end |