metanorma-ietf 2.2.0 → 2.2.5

data/lib/isodoc/ietf/validation.rb

@@ -0,0 +1,191 @@
+require "jing"
+require "fileutils"
+
+module IsoDoc::Ietf
+  class RfcConvert < ::IsoDoc::Convert
+    def schema_validate(filename)
+      begin
+        errors = Jing.new(File.join(File.dirname(__FILE__), "v3.rng")).
+          validate(filename)
+        errors.each do |error|
+          warn "RFC XML: Line #{"%06d" % error[:line]}:#{error[:column]} "\
+            "#{error[:message]}"
+        end
+      rescue Jing::Error => e
+        abort "Jing failed with error: #{e}"
+      end
+    end
+
+    def content_validate(xml, filename)
+      err = []
+      err += numbered_sections_check(xml)
+      err += toc_sections_check(xml)
+      err += references_check(xml)
+      err += xref_check(xml)
+      err += metadata_check(xml)
+      return if err.empty?
+      FileUtils.mv(filename, "#{filename}.err")
+      err.each { |e| warn "RFC XML: #{e}" }
+      warn "Cannot continue processing"
+    end
+
+    def label(sect)
+      ret = sect&.at("./name")&.text ||
+        sect["name"] || sect["anchor"]
+    end
+
+    # 2.46.2.  "numbered" Attribute
+    def numbered_sections_check(xml)
+      ret = []
+      xml.xpath("//section[@numbered = 'false']").each do |s1|
+        s1.xpath("./section[not(@numbered) or @numbered = 'true']").
+          each do |s2|
+          ret << "Numbered section #{label(s2)} under unnumbered section "\
+            "#{label(s1)}"
+        end
+        s1.xpath("./following-sibling::*[name() = 'section']"\
+                 "[not(@numbered) or @numbered = 'true']").each do |s2|
+          ret << "Numbered section #{label(s2)} following unnumbered section "\
+            "#{label(s1)}"
+        end
+      end
+      ret
+    end
+
+    # 5.2.7.  Section "toc" attribute
+    def toc_sections_check(xml)
+      ret = []
+      xml.xpath("//section[@toc = 'exclude']").each do |s1|
+        s1.xpath(".//section[@toc = 'include']").each do |s2|
+          ret << "Section #{label(s2)} with toc=include is included in "\
+            "section #{label(s1)} with toc=exclude"
+        end
+      end
+      ret
+    end
+
+    #  5.4.3  <reference> "target" Insertion
+    #  5.4.2.4  "Table of Contents" Insertion
+    def references_check(xml)
+      ret = []
+      xml.xpath("//reference[not(@target)]").each do |s|
+        s.xpath(".//seriesInfo[@name = 'RFC' or @name = 'Internet-Draft' "\
+                   "or @name = 'DOI'][not(@value)]").each do |s1|
+          ret << "for reference #{s['anchor']}, the seriesInfo with "\
+            "name=#{s1['name']} has been given no value"
+        end
+      end
+      xml.xpath("//references | //section").each do |s|
+        s.at("./name") or ret << "Cannot generate table of contents entry "\
+          "for #{label(s)}, as it has no title"
+      end
+      ret
+    end
+
+    # 5.4.8.2.  "derivedContent" Insertion (without Content)
+    def xref_check(xml)
+      ret = []
+      xml.xpath("//xref | //relref").each do |x|
+        t = xml.at(".//*[@anchor = '#{x['target']}']") ||
+          xml.at(".//*[@pn = '#{x['target']}']") or
+          ret << "#{x.name} target #{x['target']} does not exist in the document"
+        next unless t
+        x.delete("relative") if x["relative"]&.empty?
+        x.delete("section") if x["section"]&.empty?
+        if x["format"] == "title" && t.name == "reference"
+          t.at("./front/title") or
+            ret << "reference #{t['anchor']} has been referenced by #{x.name} "\
+            "with format=title, but the reference has no title"
+        end
+        if x["format"] == "counter" && !%w(section table figure li 
+          reference references t dt).include?(t.name)
+          ret << "#{x.to_xml} with format=counter is only allowed for "\
+            "clauses, tables, figures, list entries, definition terms, "\
+            "paragraphs, bibliographies, and bibliographic entries"
+        end
+        if x["format"] == "counter" && t.name == "reference" && !x["section"]
+          ret << "reference #{t['anchor']} has been referenced by xref "\
+            "#{x.to_xml} with format=counter, which requires a "\
+            "section attribute"
+        end
+        if x["format"] == "counter" && t.name == "li" && t.parent.name != "ol"
+          ret << "#{x.to_xml} with format=counter refers to an unnumbered "\
+            "list entry"
+        end
+        if x["format"] == "title" && %w(u author contact).include?(t.name)
+          ret << "#{x.to_xml} with format=title cannot reference a "\
+            "<#{t.name}> element"
+        end
+        if x["relative"] && !x["section"]
+          ret << "#{x.to_xml} with relative attribute requires a section "\
+            "attribute"
+        end
+        if (x["section"]) && t.name != "reference"
+          ret << "#{x.to_xml} has a section attribute, but #{x['target']} "\
+            "points to a #{t.name}"
+        end
+        if (x["relative"]) && t.name != "reference"
+          ret << "#{x.to_xml} has a relative attribute, but #{x['target']} "\
+            "points to a #{t.name}"
+        end
+        if !x["relative"] && x["section"]
+          unless t.at(".//seriesInfo[@name = 'RFC' or @name = "\
+              "'Internet-Draft']")
+            ret << "#{x.to_xml} must use a relative attribute, "\
+              "since it does not point to a RFC or Internet-Draft reference"
+          end
+        end
+        if x["relative"] 
+          unless t.at(".//seriesInfo[@name = 'RFC' or @name = "\
+              "'Internet-Draft']") || t["target"]
+            ret << "need an explicit target= URL attribute in the reference "\
+              "pointed to by #{x.to_xml}"
+          end
+        end
+      end
+      ret
+    end
+
+    def metadata_check(xml)
+      ret = []
+      ret += link_check(xml)
+      ret += seriesInfo_check(xml)
+      ret += ipr_check(xml)
+      ret
+    end
+
+    # 5.6.3.  <link> Processing
+    def link_check(xml)
+      l = xml&.at("//link[@rel = 'convertedFrom']")&.text
+      !l || %r{^https://datatracker\.ietf\.org/doc/draft-}.match(l) or
+        return ["<link rel='convertedFrom'> (:derived-from: document "\
+                "attribute) must start with "\
+                "https://datatracker.ietf.org/doc/draft-"]
+      []
+    end
+
+    # 5.2.2.  "seriesInfo" Insertion
+    def seriesInfo_check(xml)
+      ret = []
+      xml.root["ipr"] == "none" and return []
+      rfcinfo = xml.at("//seriesInfo[@name = 'RFC']")
+      rfcnumber = xml.root["number"]
+      rfcinfo && rfcnumber && rfcnumber != rfcinfo["value"] and
+        ret << "Mismatch between <rfc number='#{rfcnumber}'> (:docnumber: NUMBER) "\
+        "and <seriesInfo name='RFC' value='#{rfcinfo['value']}'> "\
+        "(:intended-series: TYPE NUMBER)"
+      rfcinfo && !/^\d+$/.match(rfcnumber) and
+        ret << "RFC identifier <rfc number='#{rfcnumber}'> (:docnumber: NUMBER) "\
+        "must be a number"
+      ret
+    end
+
+    # 5.4.2.3.  "Copyright Notice" Insertion
+    def ipr_check(xml)
+      xml.root["ipr"] or return ["Missing ipr attribute on <rfc> element (:ipr:)"]
+      /trust200902$/.match(xml.root["ipr"]) or
+        return ["Unknown ipr attribute on <rfc> element (:ipr:): #{xml.root['ipr']}"]
+      []
+    end
+  end
+end

data/lib/metanorma/ietf/processor.rb

@@ -58,42 +58,31 @@ module Metanorma
           IsoDoc::Ietf::RfcConvert.new(options).convert(inname, isodoc_node, nil, outname)
           @done_rfc = true
 
-        when :txt
+        when :txt, :pdf, :html
           unless xml2rfc_present?
             warn "[metanorma-ietf] Error: unable to generate #{format}, the command `xml2rfc` is not found in path."
             return
           end
 
           rfcname = inname.sub(/\.xml$/, ".rfc.xml")
-          output(isodoc_node, inname, rfcname, :rfc, options) unless @done_rfc
-
-          outname ||= inname.sub(/\.xml$/, ".txt")
-          system("xml2rfc --text #{rfcname} -o #{outname}")
-
-        when :pdf
-          unless xml2rfc_present?
-            warn "[metanorma-ietf] Error: unable to generate #{format}, the command `xml2rfc` is not found in path."
-            return
+          unless @done_rfc && File.exist?(rfcname)
+            output(isodoc_node, inname, rfcname, :rfc, options)
           end
 
-          rfcname = inname.sub(/\.xml$/, ".rfc.xml")
-          output(isodoc_node, inname, rfcname, :rfc, options) unless @done_rfc
-
-          outname ||= inname.sub(/\.xml$/, ".pdf")
-          system("xml2rfc --pdf #{rfcname} -o #{outname}")
-
-        when :html
-          unless xml2rfc_present?
-            warn "[metanorma-ietf] Error: unable to generate #{format}, the command `xml2rfc` is not found in path."
-            return
+          outext = case format
+            when :txt then ".txt"
+            when :pdf then ".pdf"
+            when :html then ".html"
           end
 
-          rfcname = inname.sub(/\.xml$/, ".rfc.xml")
-          output(isodoc_node, inname, rfcname, :rfc, options) unless @done_rfc
-
-          outname ||= inname.sub(/\.xml$/, ".html")
-          system("xml2rfc --html #{rfcname} -o #{outname}")
+          outflag = case format
+            when :txt then "--text"
+            when :pdf then "--pdf"
+            when :html then "--html"
+          end
 
+          outname ||= inname.sub(/\.xml$/, outext)
+          system("xml2rfc #{outflag} #{rfcname} -o #{outname}")
         else
           super
         end

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-   VERSION = "2.2.0".freeze
+   VERSION = "2.2.5".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -35,8 +35,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 1.5.0"
-  spec.add_dependency "isodoc", "~> 1.2.0"
+  spec.add_dependency "metanorma-standoc", "~> 1.6.0"
+  spec.add_dependency "isodoc", "~> 1.3.0"
   spec.add_dependency "mathml2asciimath"
 
   spec.add_development_dependency "byebug"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: isodoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: mathml2asciimath
   requirement: !ruby/object:Gem::Requirement
@@ -223,9 +223,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/macos.yml"
-- ".github/workflows/ubuntu.yml"
-- ".github/workflows/windows.yml"
+- ".github/workflows/rake.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".oss-guides.rubocop.yml"
@@ -257,6 +255,7 @@ files:
 - lib/asciidoctor/ietf/isodoc.rng
 - lib/asciidoctor/ietf/reqt.rng
 - lib/asciidoctor/ietf/validate.rb
+- lib/isodoc/ietf/SVG-1.2-RFC.rng
 - lib/isodoc/ietf/blocks.rb
 - lib/isodoc/ietf/cleanup.rb
 - lib/isodoc/ietf/footnotes.rb
@@ -269,6 +268,8 @@ files:
 - lib/isodoc/ietf/section.rb
 - lib/isodoc/ietf/table.rb
 - lib/isodoc/ietf/terms.rb
+- lib/isodoc/ietf/v3.rng
+- lib/isodoc/ietf/validation.rb
 - lib/isodoc/ietf/xref.rb
 - lib/metanorma-ietf.rb
 - lib/metanorma/ietf.rb

data/.github/workflows/macos.yml

@@ -1,54 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: macos
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    paths-ignore:
-      - .github/workflows/ubuntu.yml
-      - .github/workflows/windows.yml
-
-jobs:
-  test-macos:
-    name: Test on Ruby ${{ matrix.ruby }} macOS
-    runs-on: macos-latest
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
-        experimental: [false]
-        include:
-          - ruby: '2.7'
-            experimental: true
-    steps:
-      - uses: actions/checkout@master
-      - name: Cache xml2rfc
-        id: cache-xml2rfc
-        uses: actions/cache@v1
-        with:
-          path: ~/.cache/xml2rfc
-          key: xml2rfc
-          restore-key: xml2rfc
-      - name: Use Ruby
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Update gems
-        run: |
-          sudo gem install bundler --force
-          bundle install --jobs 4 --retry 3
-      - name: Use Python
-        uses: actions/setup-python@v1
-        with:
-          python-version: '3.6'
-          architecture: 'x64'
-      - name: Install xml2rfc
-        run: |
-          pip install xml2rfc
-      - name: Run specs
-        run: |
-          bundle exec rake
-

data/.github/workflows/ubuntu.yml

@@ -1,52 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: ubuntu
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    paths-ignore:
-      - .github/workflows/macos.yml
-      - .github/workflows/windows.yml
-jobs:
-  test-linux:
-    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
-    runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
-        experimental: [false]
-        include:
-          - ruby: '2.7'
-            experimental: true
-    steps:
-      - uses: actions/checkout@master
-      - name: Cache xml2rfc
-        id: cache-xml2rfc
-        uses: actions/cache@v1
-        with:
-          path: ~/.cache/xml2rfc
-          key: xml2rfc
-          restore-key: xml2rfc
-      - name: Use Ruby
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Update gems
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-      - name: Use Python
-        uses: actions/setup-python@v1
-        with:
-          python-version: '3.6'
-          architecture: 'x64'
-      - name: Install xml2rfc
-        run: |
-          pip install xml2rfc
-      - name: Run specs
-        run: |
-          bundle exec rake