RubyGems - metanorma-standoc - Versions diffs - 1.11.4 → 2.0.3 - Mend

metanorma-standoc 1.11.4 → 2.0.3

Files changed (150) hide show

checksums.yaml +4 -4
data/.github/workflows/rake.yml +3 -31
data/.gitignore +23 -0
data/Gemfile +0 -1
data/lib/asciidoctor/standoc/base.rb +2 -145
data/lib/asciidoctor/standoc/blocks.rb +2 -238
data/lib/asciidoctor/standoc/blocks_notes.rb +2 -100
data/lib/asciidoctor/standoc/cleanup.rb +2 -208
data/lib/asciidoctor/standoc/cleanup_amend.rb +2 -53
data/lib/asciidoctor/standoc/cleanup_block.rb +2 -172
data/lib/asciidoctor/standoc/cleanup_boilerplate.rb +2 -212
data/lib/asciidoctor/standoc/cleanup_footnotes.rb +2 -108
data/lib/asciidoctor/standoc/cleanup_image.rb +2 -69
data/lib/asciidoctor/standoc/cleanup_inline.rb +2 -189
data/lib/asciidoctor/standoc/cleanup_maths.rb +2 -221
data/lib/asciidoctor/standoc/cleanup_ref.rb +2 -169
data/lib/asciidoctor/standoc/cleanup_ref_dl.rb +2 -103
data/lib/asciidoctor/standoc/cleanup_reqt.rb +2 -110
data/lib/asciidoctor/standoc/cleanup_section.rb +2 -184
data/lib/asciidoctor/standoc/cleanup_section_names.rb +2 -91
data/lib/asciidoctor/standoc/cleanup_symbols.rb +2 -47
data/lib/asciidoctor/standoc/cleanup_table.rb +2 -67
data/lib/asciidoctor/standoc/cleanup_terms.rb +2 -139
data/lib/asciidoctor/standoc/cleanup_terms_designations.rb +2 -198
data/lib/asciidoctor/standoc/cleanup_text.rb +2 -95
data/lib/asciidoctor/standoc/cleanup_toc.rb +3 -0
data/lib/asciidoctor/standoc/cleanup_xref.rb +2 -106
data/lib/asciidoctor/standoc/converter.rb +2 -123
data/lib/asciidoctor/standoc/datamodel/attributes_table_preprocessor.rb +2 -56
data/lib/asciidoctor/standoc/datamodel/diagram_preprocessor.rb +2 -102
data/lib/asciidoctor/standoc/datamodel/plantuml_renderer.rb +3 -404
data/lib/asciidoctor/standoc/deprecated.rb +5 -0
data/lib/asciidoctor/standoc/front.rb +2 -223
data/lib/asciidoctor/standoc/front_contributor.rb +2 -191
data/lib/asciidoctor/standoc/inline.rb +2 -231
data/lib/asciidoctor/standoc/lists.rb +2 -119
data/lib/asciidoctor/standoc/macros.rb +2 -203
data/lib/asciidoctor/standoc/macros_form.rb +2 -62
data/lib/asciidoctor/standoc/macros_note.rb +2 -44
data/lib/asciidoctor/standoc/macros_plantuml.rb +2 -112
data/lib/asciidoctor/standoc/macros_terms.rb +2 -180
data/lib/asciidoctor/standoc/ref.rb +2 -251
data/lib/asciidoctor/standoc/ref_sect.rb +2 -153
data/lib/asciidoctor/standoc/ref_utility.rb +2 -0
data/lib/asciidoctor/standoc/render.rb +2 -114
data/lib/asciidoctor/standoc/reqt.rb +2 -89
data/lib/asciidoctor/standoc/section.rb +2 -207
data/lib/asciidoctor/standoc/table.rb +2 -84
data/lib/asciidoctor/standoc/term_lookup_cleanup.rb +2 -178
data/lib/asciidoctor/standoc/terms.rb +2 -159
data/lib/asciidoctor/standoc/utils.rb +2 -100
data/lib/asciidoctor/standoc/validate.rb +2 -157
data/lib/asciidoctor/standoc/validate_section.rb +2 -54
data/lib/isodoc/html/htmlstyle.css +25 -19
data/lib/isodoc/html/htmlstyle.scss +7 -2
data/lib/metanorma/standoc/base.rb +163 -0
data/lib/{asciidoctor → metanorma}/standoc/basicdoc.rng +5 -3
data/lib/{asciidoctor → metanorma}/standoc/biblio.rng +7 -5
data/lib/metanorma/standoc/blocks.rb +239 -0
data/lib/metanorma/standoc/blocks_notes.rb +101 -0
data/lib/metanorma/standoc/cleanup.rb +157 -0
data/lib/metanorma/standoc/cleanup_amend.rb +54 -0
data/lib/metanorma/standoc/cleanup_block.rb +173 -0
data/lib/metanorma/standoc/cleanup_boilerplate.rb +213 -0
data/lib/metanorma/standoc/cleanup_footnotes.rb +109 -0
data/lib/metanorma/standoc/cleanup_image.rb +184 -0
data/lib/metanorma/standoc/cleanup_inline.rb +190 -0
data/lib/metanorma/standoc/cleanup_maths.rb +222 -0
data/lib/metanorma/standoc/cleanup_ref.rb +170 -0
data/lib/metanorma/standoc/cleanup_ref_dl.rb +104 -0
data/lib/metanorma/standoc/cleanup_reqt.rb +111 -0
data/lib/metanorma/standoc/cleanup_section.rb +212 -0
data/lib/metanorma/standoc/cleanup_section_names.rb +92 -0
data/lib/metanorma/standoc/cleanup_symbols.rb +48 -0
data/lib/metanorma/standoc/cleanup_table.rb +68 -0
data/lib/metanorma/standoc/cleanup_terms.rb +140 -0
data/lib/metanorma/standoc/cleanup_terms_designations.rb +199 -0
data/lib/metanorma/standoc/cleanup_text.rb +74 -0
data/lib/metanorma/standoc/cleanup_toc.rb +98 -0
data/lib/metanorma/standoc/cleanup_xref.rb +114 -0
data/lib/metanorma/standoc/converter.rb +126 -0
data/lib/metanorma/standoc/datamodel/attributes_table_preprocessor.rb +57 -0
data/lib/metanorma/standoc/datamodel/diagram_preprocessor.rb +103 -0
data/lib/metanorma/standoc/datamodel/plantuml_renderer.rb +409 -0
data/lib/metanorma/standoc/front.rb +224 -0
data/lib/metanorma/standoc/front_contributor.rb +192 -0
data/lib/metanorma/standoc/inline.rb +232 -0
data/lib/{asciidoctor → metanorma}/standoc/isodoc.rng +108 -1
data/lib/metanorma/standoc/lists.rb +120 -0
data/lib/metanorma/standoc/macros.rb +205 -0
data/lib/metanorma/standoc/macros_embed.rb +72 -0
data/lib/metanorma/standoc/macros_form.rb +63 -0
data/lib/metanorma/standoc/macros_note.rb +45 -0
data/lib/metanorma/standoc/macros_plantuml.rb +113 -0
data/lib/metanorma/standoc/macros_terms.rb +194 -0
data/lib/metanorma/standoc/ref.rb +248 -0
data/lib/metanorma/standoc/ref_sect.rb +153 -0
data/lib/{asciidoctor/standoc/ref_date_id.rb → metanorma/standoc/ref_utility.rb} +45 -6
data/lib/metanorma/standoc/render.rb +115 -0
data/lib/metanorma/standoc/reqt.rb +90 -0
data/lib/{asciidoctor → metanorma}/standoc/reqt.rng +0 -0
data/lib/metanorma/standoc/section.rb +209 -0
data/lib/metanorma/standoc/table.rb +85 -0
data/lib/metanorma/standoc/term_lookup_cleanup.rb +181 -0
data/lib/metanorma/standoc/terms.rb +163 -0
data/lib/metanorma/standoc/utils.rb +101 -0
data/lib/metanorma/standoc/validate.rb +163 -0
data/lib/metanorma/standoc/validate_section.rb +55 -0
data/lib/metanorma/standoc/version.rb +1 -1
data/lib/{asciidoctor → metanorma}/standoc/views/datamodel/model_representation.adoc.erb +0 -0
data/lib/{asciidoctor → metanorma}/standoc/views/datamodel/plantuml_representation.adoc.erb +0 -0
data/lib/metanorma-standoc.rb +1 -1
data/metanorma-standoc.gemspec +1 -1
data/spec/assets/a1.adoc +8 -0
data/spec/assets/a2.adoc +8 -0
data/spec/assets/a3.adoc +9 -0
data/spec/assets/a4.adoc +4 -0
data/spec/{asciidoctor → metanorma}/base_spec.rb +453 -409
data/spec/{asciidoctor → metanorma}/blank_spec.rb +1 -1
data/spec/{asciidoctor → metanorma}/blocks_spec.rb +1 -1
data/spec/{asciidoctor → metanorma}/cleanup_blocks_spec.rb +137 -1
data/spec/{asciidoctor → metanorma}/cleanup_sections_spec.rb +1 -1
data/spec/{asciidoctor → metanorma}/cleanup_spec.rb +8 -8
data/spec/{asciidoctor → metanorma}/cleanup_terms_spec.rb +204 -204
data/spec/{asciidoctor → metanorma}/datamodel/attributes_table_preprocessor_spec.rb +1 -1
data/spec/{asciidoctor → metanorma}/datamodel/diagram_preprocessor_spec.rb +1 -1
data/spec/{asciidoctor → metanorma}/inline_spec.rb +1 -1
data/spec/{asciidoctor → metanorma}/isobib_cache_spec.rb +3 -3
data/spec/{asciidoctor → metanorma}/lists_spec.rb +1 -1
data/spec/{asciidoctor → metanorma}/macros_json2text_spec.rb +0 -0
data/spec/{asciidoctor → metanorma}/macros_plantuml_spec.rb +3 -3
data/spec/{asciidoctor → metanorma}/macros_spec.rb +158 -6
data/spec/{asciidoctor → metanorma}/macros_yaml2text_spec.rb +0 -0
data/spec/metanorma/refs_dl_spec.rb +863 -0
data/spec/{asciidoctor → metanorma}/refs_spec.rb +580 -66
data/spec/{asciidoctor → metanorma}/section_spec.rb +42 -17
data/spec/{asciidoctor → metanorma}/table_spec.rb +1 -1
data/spec/{asciidoctor → metanorma}/validate_spec.rb +2 -2
data/spec/vcr_cassettes/dated_iso_ref_joint_iso_iec.yml +46 -46
data/spec/vcr_cassettes/dated_iso_ref_joint_iso_iec1.yml +10 -10
data/spec/vcr_cassettes/hide_refs.yml +599 -0
data/spec/vcr_cassettes/isobib_get_123.yml +12 -12
data/spec/vcr_cassettes/isobib_get_123_1.yml +23 -23
data/spec/vcr_cassettes/isobib_get_123_1_fr.yml +85 -85
data/spec/vcr_cassettes/isobib_get_123_2001.yml +12 -12
data/spec/vcr_cassettes/isobib_get_124.yml +13 -13
data/spec/vcr_cassettes/rfcbib_get_rfc8341.yml +14 -14
data/spec/vcr_cassettes/separates_iev_citations_by_top_level_clause.yml +60 -50
metadata +88 -32
data/spec/asciidoctor/refs_dl_spec.rb +0 -864

data/lib/metanorma/standoc/utils.rb ADDED Viewed

@@ -0,0 +1,101 @@
+require "date"
+require "nokogiri"
+require "htmlentities"
+require "json"
+require "pathname"
+require "uuidtools"
+module Metanorma
+  module Standoc
+    module Utils
+      def convert(node, transform = nil, opts = {})
+        transform ||= node.node_name
+        opts.empty? ? (send transform, node) : (send transform, node, opts)
+      end
+      def document_ns_attributes(_doc)
+        nil
+      end
+      NOKOHEAD = <<~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
+      # block for processing XML document fragments as XHTML,
+      # to allow for HTMLentities
+      # Unescape special chars used in Asciidoctor substitution processing
+      def noko(&block)
+        doc = ::Nokogiri::XML.parse(NOKOHEAD)
+        fragment = doc.fragment("")
+        ::Nokogiri::XML::Builder.with fragment, &block
+        fragment.to_xml(encoding: "US-ASCII", indent: 0).lines.map do |l|
+          l.gsub(/>\n$/, ">").gsub(/\s*\n$/m, " ").gsub("&#150;", "\u0096")
+            .gsub("&#151;", "\u0097").gsub("&#x96;", "\u0096")
+            .gsub("&#x97;", "\u0097")
+        end
+      end
+      def attr_code(attributes)
+        attributes.compact.transform_values do |v|
+          v.is_a?(String) ? HTMLEntities.new.decode(v) : v
+        end
+      end
+      # if the contents of node are blocks, output them to out;
+      # else, wrap them in <p>
+      def wrap_in_para(node, out)
+        if node.blocks? then out << node.content
+        else
+          out.p { |p| p << node.content }
+        end
+      end
+      SUBCLAUSE_XPATH = "//clause[not(parent::sections)]"\
+                        "[not(ancestor::boilerplate)]".freeze
+      def isodoc(lang, script, i18nyaml = nil)
+        conv = html_converter(EmptyAttr.new)
+        i18n = conv.i18n_init(lang, script, i18nyaml)
+        conv.metadata_init(lang, script, i18n)
+        conv
+      end
+      def dl_to_attrs(elem, dlist, name)
+        e = dlist.at("./dt[text()='#{name}']") or return
+        val = e.at("./following::dd/p") || e.at("./following::dd") or return
+        elem[name] = val.text
+      end
+      def dl_to_elems(ins, elem, dlist, name)
+        a = elem.at("./#{name}[last()]")
+        ins = a if a
+        dlist.xpath("./dt[text()='#{name}']").each do |e|
+          v = e.at("./following::dd")
+          e = v.elements and e.size == 1 && e.first.name == "p" and v = e.first
+          v.name = name
+          ins.next = v
+          ins = ins.next
+        end
+        ins
+      end
+      def term_expr(elem)
+        "<expression><name>#{elem}</name></expression>"
+      end
+      class EmptyAttr
+        def attr(_any_attribute)
+          nil
+        end
+        def attributes
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/validate.rb ADDED Viewed

@@ -0,0 +1,163 @@
+require "metanorma/standoc/utils"
+require_relative "./validate_section"
+require "nokogiri"
+require "jing"
+require "iev"
+module Metanorma
+  module Standoc
+    module Validate
+      SOURCELOCALITY = "./origin//locality[@type = 'clause']/"\
+                       "referenceFrom".freeze
+      def init_iev
+        return nil if @no_isobib
+        return @iev if @iev
+        @iev = Iev::Db.new(@iev_globalname, @iev_localname) unless @no_isobib
+        @iev
+      end
+      def iev_validate(xmldoc)
+        @iev = init_iev or return
+        xmldoc.xpath("//term").each do |t|
+          t.xpath(".//termsource").each do |src|
+            (/^IEC 60050-/.match(src&.at("./origin/@citeas")&.text) &&
+          loc = src.xpath(SOURCELOCALITY)&.text) or next
+            iev_validate1(t, loc, xmldoc)
+          end
+        end
+      end
+      def iev_validate1(term, loc, xmldoc)
+        iev = @iev.fetch(loc,
+                         xmldoc&.at("//language")&.text || "en") or return
+        pref = term.xpath("./preferred//name").inject([]) do |m, x|
+          m << x&.text&.downcase
+        end
+        pref.include?(iev.downcase) or
+          @log.add("Bibliography", term, %(Term "#{pref[0]}" does not match ) +
+                   %(IEV #{loc} "#{iev}"))
+      end
+      def content_validate(doc)
+        @fatalerror = []
+        xref_validate(doc)
+        section_validate(doc)
+        norm_ref_validate(doc)
+        repeat_id_validate(doc.root)
+        iev_validate(doc.root)
+        concept_validate(doc, "concept", "refterm")
+        concept_validate(doc, "related", "preferred//name")
+        @fatalerror.empty? or clean_abort(@fatalerror.join("\n"), doc.to_xml)
+      end
+      def norm_ref_validate(doc)
+        found = false
+        doc.xpath("//references[@normative = 'true']/bibitem").each do |b|
+          next unless docid = b.at("./docidentifier[@type = 'metanorma']")
+          next unless /^\[\d+\]$/.match?(docid.text)
+          @log.add("Bibliography", b,
+                   "Numeric reference in normative references")
+          found = true
+        end
+        found and @fatalerror << "Numeric reference in normative references"
+      end
+      def concept_validate(doc, tag, refterm)
+        found = false
+        doc.xpath("//#{tag}/xref").each do |x|
+          next if doc.at("//term[@id = '#{x['target']}']")
+          next if doc.at("//definitions//dt[@id = '#{x['target']}']")
+          ref = x&.at("../#{refterm}")&.text
+          @log.add("Anchors", x,
+                   "#{tag.capitalize} #{ref} is pointing to "\
+                   "#{x['target']}, which is not a term or symbol")
+          found = true
+        end
+        found and
+          @fatalerror << "#{tag.capitalize} not cross-referencing term or symbol"
+      end
+      def repeat_id_validate1(ids, elem)
+        if ids[elem["id"]]
+          @log.add("Anchors", elem, "Anchor #{elem['id']} has already been "\
+                                    "used at line #{ids[elem['id']]}")
+          @fatalerror << "Multiple instances of same ID: #{elem['id']}"
+        else
+          ids[elem["id"]] = elem.line
+        end
+        ids
+      end
+      def repeat_id_validate(doc)
+        ids = {}
+        doc.xpath("//*[@id]").each do |x|
+          ids = repeat_id_validate1(ids, x)
+        end
+      end
+      def schema_validate(doc, schema)
+        Tempfile.open(["tmp", ".xml"], encoding: "UTF-8") do |f|
+          schema_validate1(f, doc, schema)
+        rescue Jing::Error => e
+          clean_abort("Jing failed with error: #{e}", doc.to_xml)
+        ensure
+          f.close!
+        end
+      end
+      def schema_validate1(file, doc, schema)
+        file.write(doc.to_xml)
+        file.close
+        errors = Jing.new(schema, encoding: "UTF-8").validate(file.path)
+        warn "Syntax Valid!" if errors.none?
+        errors.each do |e|
+          @log.add("Metanorma XML Syntax",
+                   "XML Line #{'%06d' % e[:line]}:#{e[:column]}", e[:message])
+        end
+      end
+      SVG_NS = "http://www.w3.org/2000/svg".freeze
+      # RelaxNG cannot cope well with wildcard attributes. So we strip
+      # any attributes from FormattedString instances (which can contain
+      # xs:any markup, and are signalled with @format) before validation.
+      def formattedstr_strip(doc)
+        doc.xpath("//*[@format] | //stem | //bibdata//description | "\
+                  "//formattedref | //bibdata//note | //bibdata/abstract | "\
+                  "//bibitem/abstract | //bibitem/note | //misc-container",
+                  "m" => SVG_NS).each do |n|
+          n.elements.each do |e|
+            e.traverse do |e1|
+              e1.element? and e1.each { |k, _v| e1.delete(k) }
+            end
+          end
+        end
+        doc.xpath("//m:svg", "m" => SVG_NS).each do |n|
+          n.replace("<svg/>")
+        end
+        doc
+      end
+      # manually check for xref/@target, xref/@to integrity
+      def xref_validate(doc)
+        ids = doc.xpath("//*/@id").each_with_object({}) { |x, m| m[x.text] = 1 }
+        doc.xpath("//xref/@target | //xref/@to").each do |x|
+          next if ids[x.text]
+          @log.add("Anchors", x.parent,
+                   "Crossreference target #{x.text} is undefined")
+        end
+      end
+      def validate(doc)
+        content_validate(doc)
+        schema_validate(formattedstr_strip(doc.dup),
+                        File.join(File.dirname(__FILE__), "isodoc.rng"))
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/validate_section.rb ADDED Viewed

@@ -0,0 +1,55 @@
+require "nokogiri"
+module Metanorma
+  module Standoc
+    module Validate
+      def section_validate(doc)
+        sourcecode_style(doc.root)
+        hanging_para_style(doc.root)
+        asset_style(doc.root)
+      end
+      def sourcecode_style(root)
+        root.xpath("//sourcecode").each do |x|
+          callouts = x.elements.select { |e| e.name == "callout" }
+          annotations = x.elements.select { |e| e.name == "annotation" }
+          if callouts.size != annotations.size
+            @log.add("AsciiDoc Input", x,
+                     "mismatch of callouts and annotations")
+          end
+        end
+      end
+      def style_warning(node, msg, text = nil)
+        w = msg
+        w += ": #{text}" if text
+        @log.add("Metanorma XML Style Warning", node, w)
+      end
+      def asset_title_style(root)
+        root.xpath("//figure[image][not(name)]").each do |node|
+          style_warning(node, "Figure should have title", nil)
+        end
+        root.xpath("//table[not(name)]").each do |node|
+          style_warning(node, "Table should have title", nil)
+        end
+      end
+      def asset_style(root)
+        asset_title_style(root)
+      end
+      def hanging_para_style(root)
+        root.xpath("//clause | //annex | //foreword | //introduction | "\
+                   "//acknowledgements").each do |c|
+          next unless c.at("./clause")
+          next if c.elements.reject do |n|
+                    %w(clause title).include? n.name
+                  end.empty?
+          style_warning(c, "Hanging paragraph in clause")
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/version.rb CHANGED Viewed

@@ -19,6 +19,6 @@ module Metanorma
   end
   module Standoc
-    VERSION = "1.11.4".freeze
+    VERSION = "2.0.3".freeze
   end
 end

data/lib/{asciidoctor → metanorma}/standoc/views/datamodel/model_representation.adoc.erb RENAMED Viewed

File without changes

data/lib/{asciidoctor → metanorma}/standoc/views/datamodel/plantuml_representation.adoc.erb RENAMED Viewed

File without changes

data/lib/metanorma-standoc.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 require "asciidoctor" unless defined? Asciidoctor::Converter
 require_relative "isodoc/pdf_convert"
-require_relative "asciidoctor/standoc/converter"
+require_relative "metanorma/standoc/converter"
 require_relative "metanorma/standoc/version"
 require "asciidoctor/extensions"

data/metanorma-standoc.gemspec CHANGED Viewed

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "iev", "~> 0.3.0"
-  spec.add_dependency "isodoc", "~> 1.8.0"
+  spec.add_dependency "isodoc", "~> 2.0.0"
   spec.add_dependency "metanorma-plugin-datastruct"
   spec.add_dependency "metanorma-plugin-lutaml"
   spec.add_dependency "ruby-jing"

data/spec/assets/a1.adoc ADDED Viewed

@@ -0,0 +1,8 @@
+= X
+A
+== Clause 1
+X
+embed::spec/assets/a2.adoc[]

data/spec/assets/a2.adoc ADDED Viewed

@@ -0,0 +1,8 @@
+= X
+A
+== Clause 2
+X
+embed::spec/assets/a3.adoc[]

data/spec/assets/a3.adoc ADDED Viewed

@@ -0,0 +1,9 @@
+= X
+A
+== Clause 3
+X
+include::spec/assets/a4.adoc[]

data/spec/assets/a4.adoc ADDED Viewed

@@ -0,0 +1,4 @@
+== Clause 4
+X