metanorma-ogc 2.2.0 → 2.2.2

data/lib/isodoc/ogc/xref.rb

@@ -4,131 +4,6 @@ module IsoDoc
     end
 
     class Xref < IsoDoc::Xref
-      def initialize(lang, script, klass, labels, options)
-        @reqtlabels = {}
-        super
-      end
-
-      def reqtlabels
-        @reqtlabels
-      end
-
-      FIRST_LVL_REQ = IsoDoc::XrefGen::Blocks::FIRST_LVL_REQ
-
-      def sequential_permission_names(clause, klass, label)
-        c = Counter.new
-        clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
-          next if t["id"].nil? || t["id"].empty?
-
-          id = c.increment(t).print
-          @anchors[t["id"]] = anchor_struct(id, t, label, klass,
-                                            t["unnumbered"])
-          reqt_suffix_label(t)
-          permission_parts(t, label, klass)
-          sequential_permission_children(t, id)
-        end
-      end
-
-      def req_class_paths
-        { "class" => "@type = 'class'",
-          "test" => "@type = 'verification'",
-          "" => "not(@type = 'verification' or @type = 'class' or "\
-                "@type = 'abstracttest' or @type = 'conformanceclass')" }
-      end
-
-      def req_class_paths2
-        { "abstracttest" => "@type = 'abstracttest'",
-          "conformanceclass" => "@type = 'conformanceclass'" }
-      end
-
-      def reqt_suffix_label(reqt)
-        if l = reqt.at(ns("./label"))&.text
-          @reqtlabels[l] = reqt["id"]
-          @anchors[reqt["id"]][:xref] += ": <tt>#{l}</tt>"
-        end
-      end
-
-      def permission_parts(block, label, klass)
-        block.xpath(ns("./component[@class = 'part']"))
-          .each_with_index do |c, i|
-          next if c["id"].nil? || c["id"].empty?
-
-          @anchors[c["id"]] = anchor_struct((i + "A".ord).chr.to_s, c, label,
-                                            klass, c["unnumbered"])
-        end
-      end
-
-      REQS = %w(permission requirement recommendation).freeze
-
-      def sequential_permission_children(block, idx)
-        req_class_paths.each do |k, v|
-          REQS.each do |r|
-            sequential_permission_names1(block, idx, "#{r}[#{v}]",
-                                         @labels["#{r}#{k}"])
-          end
-        end
-        req_class_paths2.each do |k, v|
-          sequential_permission_names1(block, idx, "*[#{v}]", @labels[k])
-        end
-      end
-
-      def sequential_permission_names1(block, lbl, klass, label)
-        c = Counter.new
-        block.xpath(ns("./#{klass}")).each do |t|
-          next if t["id"].nil? || t["id"].empty?
-
-          id = "#{lbl}#{hierfigsep}#{c.increment(t).print}"
-          @anchors[t["id"]] = anchor_struct(id, t, label, klass,
-                                            t["unnumbered"])
-          permission_parts(t, label, klass)
-          sequential_permission_children(t, id)
-        end
-      end
-
-      def sequential_asset_names(clause)
-        sequential_table_names(clause)
-        sequential_figure_names(clause)
-        sequential_formula_names(clause)
-        req_class_paths.each do |k, v|
-          REQS.each do |r|
-            sequential_permission_names(clause, "#{r}[#{v}]",
-                                        @labels["#{r}#{k}"])
-          end
-        end
-        req_class_paths2.each do |k, v|
-          sequential_permission_names(clause, "*[#{v}]", @labels[k])
-        end
-      end
-
-      def hierarchical_asset_names(clause, num)
-        hierarchical_table_names(clause, num)
-        hierarchical_figure_names(clause, num)
-        hierarchical_formula_names(clause, num)
-        req_class_paths.each do |k, v|
-          REQS.each do |r|
-            hierarchical_permission_names(clause, num, "#{r}[#{v}]",
-                                          @labels["#{r}#{k}"])
-          end
-        end
-        req_class_paths2.each do |k, v|
-          hierarchical_permission_names(clause, num, "*[#{v}]", @labels[k])
-        end
-      end
-
-      def hierarchical_permission_names(clause, num, klass, label)
-        c = Counter.new
-        clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
-          next if t["id"].nil? || t["id"].empty?
-
-          lbl = "#{num}#{hiersep}#{c.increment(t).print}"
-          @anchors[t["id"]] = anchor_struct(lbl, t, label, klass,
-                                            t["unnumbered"])
-          reqt_suffix_label(t)
-          permission_parts(t, label, klass)
-          sequential_permission_children(t, lbl)
-        end
-      end
-
       def initial_anchor_names(doc)
         if @parse_settings.empty? || @parse_settings[:clauses]
         preface_anchor_names(doc)

data/lib/metanorma/ogc/biblio.rng

@@ -225,9 +225,9 @@
         <zeroOrMore>
           <ref name="forename"/>
         </zeroOrMore>
-        <zeroOrMore>
-          <ref name="initial"/>
-        </zeroOrMore>
+        <optional>
+          <ref name="formatted-initials"/>
+        </optional>
         <ref name="surname"/>
         <zeroOrMore>
           <ref name="addition"/>
@@ -247,8 +247,8 @@
       <ref name="LocalizedString"/>
     </element>
   </define>
-  <define name="initial">
-    <element name="initial">
+  <define name="formatted-initials">
+    <element name="formatted-initials">
       <ref name="LocalizedString"/>
     </element>
   </define>
@@ -264,6 +264,9 @@
   </define>
   <define name="forename">
     <element name="forename">
+      <optional>
+        <attribute name="initial"/>
+      </optional>
       <ref name="LocalizedString"/>
     </element>
   </define>

data/lib/metanorma/ogc/cleanup.rb

@@ -85,78 +85,6 @@ module Metanorma
                       @i18n&.termsdef, true)
       end
 
-      def requirement_metadata_component_tags
-        %w(test-purpose test-method test-method-type conditions part description
-           reference step requirement permission recommendation)
-      end
-
-      def requirement_metadata1(reqt, dlist, ins)
-        ins1 = super
-        dlist.xpath("./dt").each do |e|
-          tag = e&.text&.gsub(/ /, "-")&.downcase
-          next unless requirement_metadata_component_tags.include? tag
-
-          ins1.next = requirement_metadata1_component(e, tag)
-          ins1 = ins1.next
-        end
-      end
-
-      def requirement_metadata1_component(term, tag)
-        val = term.at("./following::dd")
-        val.name = tag
-        val.xpath("./dl").each do |d|
-          requirement_metadata1(val, d, d)
-          d.remove
-        end
-        if %w(requirement permission
-              recommendation).include?(term.text) && !val.text.empty?
-          val["label"] = val.text.strip
-          val.children.remove
-        end
-        val
-      end
-
-      def requirement_metadata(xmldoc)
-        super
-        xmldoc.xpath(REQRECPER).each do |r|
-          requirement_metadata_to_component(r)
-          requirement_metadata_to_requirement(r)
-          requirement_subparts_to_blocks(r)
-          requirement_target_identifiers(r)
-        end
-      end
-
-      def requirement_target_identifiers(reqt)
-        reqt.xpath("./classification[tag = 'target']/value[link]").each do |v|
-          v.children = v.at("./link/@target").text
-        end
-      end
-
-      def requirement_metadata_to_component(reqt)
-        reqt.xpath(".//test-method | .//test-purpose | .//conditions | "\
-                   ".//part | .//test-method-type | .//step | .//reference")
-          .each do |c|
-          c["class"] = c.name
-          c.name = "component"
-        end
-      end
-
-      def requirement_metadata_to_requirement(reqt)
-        reqt.xpath("./requirement | ./permission | ./recommendation")
-          .each do |c|
-          c["id"] = Metanorma::Utils::anchor_or_uuid
-        end
-      end
-
-      def requirement_subparts_to_blocks(reqt)
-        reqt.xpath(".//component | .//description").each do |c|
-          next if %w(p ol ul dl table component description)
-            .include?(c&.elements&.first&.name)
-
-          c.children = "<p>#{c.children.to_xml}</p>"
-        end
-      end
-
       def termdef_cleanup(xmldoc)
         super
         termdef_subclause_cleanup(xmldoc)
@@ -172,31 +100,6 @@ module Metanorma
         end
       end
 
-      def requirement_cleanup(xmldoc)
-        requirement_type(xmldoc)
-        super
-      end
-
-      def requirement_type(xmldoc)
-        xmldoc.xpath(REQRECPER).each do |r|
-          next unless r["type"]
-
-          requirement_type1(r)
-        end
-      end
-
-      def requirement_type1(reqt)
-        reqt["type"] = case reqt["type"]
-                       when "requirement", "recommendation", "permission"
-                         "general"
-                       when "requirements_class" then "class"
-                       when "conformance_test" then "verification"
-                       when "conformance_class" then "conformanceclass"
-                       when "abstract_test" then "abstracttest"
-                       else reqt["type"]
-                       end
-      end
-
       def normref_cleanup(xmldoc)
         r1 = xmldoc.at("//references[title[translate(text(), 'R', 'r') = "\
                        "'Normative references']]")
@@ -233,6 +136,74 @@ module Metanorma
           last.previous = rev.remove
         last.remove
       end
+
+      def sort_biblio(bib)
+        bib.sort do |a, b|
+          sort_biblio_key(a) <=> sort_biblio_key(b)
+        end
+      end
+
+      PUBLISHER = "./contributor[role/@type = 'publisher']/organization".freeze
+
+      OTHERIDS = "@type = 'DOI' or @type = 'metanorma' or @type = 'ISSN' or "\
+                 "@type = 'ISBN'".freeze
+
+      def pub_class(bib)
+        return 1 if bib.at("#{PUBLISHER}[abbreviation = 'OGC']")
+        return 1 if bib.at("#{PUBLISHER}[name = 'Open Geospatial "\
+                           "Consortium']")
+        return 2 if bib.at("./docidentifier[@type][not(#{OTHERIDS})]")
+
+        3
+      end
+
+      # sort by: doc class (OGC, other standard (not DOI &c), other
+      # then standard class (docid class other than DOI &c)
+      # then if OGC, doc title else if other, authors
+      # then docnumber if present, numeric sort
+      #      else alphanumeric metanorma id (abbreviation)
+      # then doc part number if present, numeric sort
+      # then doc id (not DOI &c)
+      # then title
+      def sort_biblio_key(bib)
+        pubclass = pub_class(bib)
+        ids = sort_biblio_ids_key(bib)
+        title = title_key(bib)
+        sortkey3 = author_title_key(pubclass, title, bib)
+        num = if ids[:num].nil? then ids[:abbrid]
+              else sprintf("%09d", ids[:num].to_i)
+              end
+        "#{pubclass} :: #{ids[:type]} :: #{sortkey3} :: #{num} :: "\
+          "#{sprintf('%09d', ids[:partid])} :: #{ids[:id]} :: #{title}"
+      end
+
+      def author_title_key(pubclass, title, bib)
+        case pubclass
+        when 1, 2 then title
+        when 3
+          cite = ::Relaton::Render::General.new
+            .render_all("<references>#{bib.to_xml}</references>")
+          cite[:author]
+        end
+      end
+
+      def title_key(bib)
+        title = bib.at("./title[@type = 'main']") ||
+          bib.at("./title") || bib.at("./formattedref")
+        title&.text&.sub!(/^(OGC|Open Geospatial Consortium)\b/, "")
+      end
+
+      def sort_biblio_ids_key(bib)
+        id = bib.at("./docidentifier[@primary]") ||
+          bib.at("./docidentifier[not(#{OTHERIDS})]")
+        metaid = bib.at("./docidentifier[@type = 'metanorma']")&.text
+        /\d-(?<partid>\d+)/ =~ id&.text
+        { id: id&.text,
+          num: bib.at("./docnumber")&.text,
+          abbrid: /^\[\d+\]$/.match?(metaid) ? metaid : nil,
+          partid: partid&.to_i || 0,
+          type: id ? id["type"] : nil }
+      end
     end
   end
 end

data/lib/metanorma/ogc/converter.rb

@@ -26,6 +26,10 @@ module Metanorma
       # ignore, we generate ToC outside of asciidoctor
       def toc(value); end
 
+      def default_requirement_model
+        "ogc"
+      end
+
       def makexml(node)
         @draft = node.attributes.has_key?("draft")
         super
@@ -131,16 +135,6 @@ module Metanorma
         xml.hi { |s| s << text }
       end
 
-      def example(node)
-        role = node.role || node.attr("style")
-        if %w(requirements_class conformance_test conformance_class
-              abstract_test).include?(role)
-          node.set_attr("type", role)
-          return requirement(node, "requirement")
-        end
-        super
-      end
-
       def set_obligation(attrs, node)
         if node.attr("style") == "appendix" && node.level == 1
           attrs[:obligation] = if node.attributes.has_key?("obligation")

data/lib/metanorma/ogc/validate.rb

@@ -14,51 +14,6 @@ module Metanorma
       def content_validate(doc)
         super
         bibdata_validate(doc.root)
-        reqt_link_validate(doc.root)
-      end
-
-      def reqt_link_validate(docxml)
-        ids = reqt_links(docxml)
-        reqt_to_conformance(ids, "general", "verification", "Requirement",
-                            "Conformance test")
-        reqt_to_conformance(ids, "class", "conformanceclass",
-                            "Requirement class", "Conformance class test")
-        conformance_to_reqt(ids, "general", "verification", "Requirement",
-                            "Conformance test")
-        conformance_to_reqt(ids, "class", "conformanceclass",
-                            "Requirement class", "Conformance class test")
-      end
-
-      def reqt_to_conformance(ids, reqtclass, confclass, reqtlabel, conflabel)
-        ids[reqtclass]&.each do |r|
-          (r[:label] && ids[confclass]&.any? do |x|
-             x[:subject] == r[:label]
-           end) or
-            @log.add("Requirements", r[:elem],
-                     "#{reqtlabel} #{r[:label] || r[:id]} "\
-                     "has no corresponding #{conflabel}")
-        end
-      end
-
-      def conformance_to_reqt(ids, reqtclass, confclass, reqtlabel, conflabel)
-        ids[confclass]&.each do |x|
-          (x[:subject] && ids[reqtclass]&.any? do |r|
-             x[:subject] == r[:label]
-           end) or
-            @log.add("Requirements", x[:elem],
-                     "#{conflabel} #{x[:label] || x[:id]} "\
-                     "has no corresponding #{reqtlabel}")
-        end
-      end
-
-      def reqt_links(docxml)
-        docxml.xpath("//requirement | //recommendation | //permission")
-          .each_with_object({}) do |r, m|
-            type = r["type"] || "general"
-            m[type] ||= []
-            m[type] << { id: r["id"], elem: r, label: r.at("./identifier")&.text,
-                         subject: r.at("./classification[tag = 'target']/value")&.text }
-          end
       end
 
       def bibdata_validate(doc)

data/lib/metanorma/ogc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ogc
-    VERSION = "2.2.0".freeze
+    VERSION = "2.2.2".freeze
   end
 end

data/lib/metanorma-ogc.rb

@@ -1,7 +1,8 @@
 require "metanorma/ogc"
 require "asciidoctor"
 require "isodoc/ogc"
+require "metanorma"
 
-if defined? Metanorma
+if defined? Metanorma::Registry
   Metanorma::Registry.instance.register(Metanorma::Ogc::Processor)
 end

data/lib/relaton/render/config.yml

@@ -3,8 +3,32 @@ template:
   standard: "{% if creatornames %}{{ creatornames }} ({{role}}){%else%}{{ publisher_abbrev}}{%endif%} : {{standardidentifier|first}} {{draft}} , <em>{{ title }}</em>. {{ publisher }}{%if place%},{%endif%} {{ place }} ({{date}}). {{uri}}."
   misc: standard
   techreport: standard
+  book: "{{ creatornames }} ({{role}}) : <em>{{ title }}</em> . {{ publisher }}, {% if place %}{{place}}{%else%}{{ labels['no_place']}}{%endif%} ({{date}})."
+  booklet: book
+  manual: book
+  proceedings: book
+  software: book
+  electronic resource: book
+  website: book
+  webresource: book
+  unpublished: book
+  presentation: book
+  inbook: "{{ creatornames }} ({{role}}) : {{ title }} . {{ labels['in'] | capitalize }}: {{ host_creatornames}} ({{ host_role}}) : <em>{{host_title}}</em>. {{ extent}}. {{ publisher }}{%if place%},{%endif%} {{ place }} . ({{date}})." 
+  inproceedings: inbook
+  incollection: inbook
+  journal: "<em>{{ title}}</em> . {{ publisher }}{%if place%},{%endif%} {{ place }} . ({{date}})."
+  article: "{{ creatornames }} ({{role}}) : {{ title }}. {{ series }} {{ extent }} ({{date}})."
 nametemplate:
-  one: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} {{initials[0]}}{% endif %}"
-  two: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} {{initials[0]}}{% endif %} , {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{surname[1]}} {{ initials[1]}}{% endif %}"
-  more: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} {{initials[0]}} {% endif %} , {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{surname[1]}} {{ initials[1]}} {% endif %} , {% if nonpersonal[2] %}{{ nonpersonal[2] }}{% else %}{{surname[2]}} {{initials[2]}}{% endif %}"
+  one: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} {{initials[0] | join: '' | remove: '.' | remove: '_' }}{% endif %}"
+  two: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} {{initials[0] | join: '' | remove: '.' | remove: '_' }}{% endif %} , {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{surname[1]}} {{ initials[1] | join: '' | remove: '.' | remove: '_' }}{% endif %}"
+  more: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} {{initials[0] | join: '' | remove: '.' | remove: '_' }} {% endif %} , {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{surname[1]}} {{ initials[1] | join: '' | remove: '.' | remove: '_' }} {% endif %} , {% if nonpersonal[2] %}{{ nonpersonal[2] }}{% else %}{{surname[2]}} {{initials[2] | join: '' | remove: '.' | remove: '_'}}{% endif %}"
+extenttemplate:
+  book: "{{ volume }}, {{ page }}"
+  booklet: book
+  proceedings: book
+  journal: book
+  standard: book
+  techreport: book
+  inbook: "{{ volume }}: {{ page }}"
+  misc: "{{ volume }} ({{issue}}) , {{ page }}, {{ duration }}"
 

data/metanorma-ogc.gemspec

@@ -37,4 +37,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sassc", "2.4.0"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
+  spec.add_development_dependency "vcr", "~> 6.1.0"
+  spec.add_development_dependency "webmock"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ogc
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iso-639
@@ -178,6 +178,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Metanorma for the Open Geospatial Consortium.
 
   '
@@ -188,6 +216,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/rake.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rubocop.yml"
@@ -202,28 +231,22 @@ files:
 - lib/isodoc/ogc.rb
 - lib/isodoc/ogc/base_convert.rb
 - lib/isodoc/ogc/biblio.rb
-- lib/isodoc/ogc/html/_coverpage.css
 - lib/isodoc/ogc/html/_coverpage.scss
 - lib/isodoc/ogc/html/header.html
 - lib/isodoc/ogc/html/header_wp.html
 - lib/isodoc/ogc/html/html_ogc_intro.html
 - lib/isodoc/ogc/html/html_ogc_titlepage.html
-- lib/isodoc/ogc/html/htmlstyle.css
 - lib/isodoc/ogc/html/htmlstyle.scss
 - lib/isodoc/ogc/html/logo.2021.svg
 - lib/isodoc/ogc/html/logo.png
-- lib/isodoc/ogc/html/ogc.css
 - lib/isodoc/ogc/html/ogc.scss
-- lib/isodoc/ogc/html/ogc_wp.css
 - lib/isodoc/ogc/html/ogc_wp.scss
 - lib/isodoc/ogc/html/scripts.html
 - lib/isodoc/ogc/html/word_ogc_intro.html
 - lib/isodoc/ogc/html/word_ogc_intro_wp.html
 - lib/isodoc/ogc/html/word_ogc_titlepage.html
 - lib/isodoc/ogc/html/word_ogc_titlepage_wp.html
-- lib/isodoc/ogc/html/wordstyle.css
 - lib/isodoc/ogc/html/wordstyle.scss
-- lib/isodoc/ogc/html/wordstyle_wp.css
 - lib/isodoc/ogc/html/wordstyle_wp.scss
 - lib/isodoc/ogc/html_convert.rb
 - lib/isodoc/ogc/i18n-en.yaml
@@ -247,8 +270,6 @@ files:
 - lib/isodoc/ogc/ogc.white-paper.xsl
 - lib/isodoc/ogc/pdf_convert.rb
 - lib/isodoc/ogc/presentation_xml_convert.rb
-- lib/isodoc/ogc/reqt.rb
-- lib/isodoc/ogc/reqt_helper.rb
 - lib/isodoc/ogc/sections.rb
 - lib/isodoc/ogc/word_convert.rb
 - lib/isodoc/ogc/xref.rb
@@ -276,7 +297,7 @@ homepage: https://github.com/metanorma/metanorma-ogc
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -291,8 +312,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Metanorma for the Open Geospatial Consortium.
 test_files: []