relaton-ietf 1.2.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b582d89c8f44fb110d82a47cd477f50be19667cd4482de9753280d9b6ba8a84
-  data.tar.gz: 3da49d99a2b3fa8880b603b252eea0d551e3f1457c8b8486d0256df957f227a1
+  metadata.gz: e833387c3a25a940b436ab64dd8ed498c5418240fe02a371a97ffd49a62de1c7
+  data.tar.gz: e7470c46a46172373d273c08243d9831ac6eb57efb5007ed3d1c0896d8b645df
 SHA512:
-  metadata.gz: ea84e7f6f05e5b95aaaf1668cd9502b6e781409b9f899efafcb757bce60056e5f292e5147f5564c49662a016286300f198de9504427beec1e4677d9ca1eb7f24
-  data.tar.gz: 0c5fcefc0c2e17233f874f252d2b66e488867dd6b0af77f5043a90e2f547a2237a0ba2302bbcd4d723b3330cba8976c1bf272062ea12f948fc3c12b5b9d08316
+  metadata.gz: 10ba8e35c6ddf329ce0aebeade61c8ed71973f8c86b7665b3bdf8aa5b7164e9bb76f3669d6da8258265fb86d3e47d0bacff749fb5b1fdc0549a521d0a071a4d6
+  data.tar.gz: 43a839c670c248d1293c978b9bdfa9f06a2cf1b0cbe287e2b3a115b7144ec7779b689eecaec783e27a1f3b1a3810bf2bf6781a9754f943ba9894206e6bf4cfb2

data/.github/workflows/ubuntu.yml

@@ -29,4 +29,5 @@ jobs:
           bundle install --jobs 4 --retry 3
       - name: Run specs
         run: |
+          unset JAVA_TOOL_OPTIONS
           bundle exec rake

data/.rubocop.yml

@@ -5,6 +5,6 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 Rails:
-  Enabled: true
+  Enabled: false

data/README.adoc

@@ -45,7 +45,7 @@ item = RelatonIetf::IetfBibliography.search 'RFC 8341'
 
 # Return nil if document doesn't exist.
 RelatonIetf::IetfBibliography.search '1111'
-1111.xml: not recognised for RFC
+RelatonBib::RequestError: 1111: not recognised for RFC
 => nil
 ----
 
@@ -59,48 +59,9 @@ item.to_xml
   <title format="text/plain" language="en" script="Latn">Network Configuration Access Control Model</title>
   <uri type="src">https://www.rfc-editor.org/info/rfc8341</uri>
   <docidentifier type="IETF">RFC 8341</docidentifier>
+  <docidentifier type=\"rfc-anchor\">RFC8341</docidentifier>
   <docidentifier type="DOI">10.17487/RFC8341</docidentifier>
-  <date type="published">
-    <on>2018-03</on>
-  </date>
-  <contributor>
-    <role type="author"/>
-    <person>
-      <name>
-        <completename language="en">A. Bierman</completename>
-      </name>
-      <affiliation>
-        <organization>
-          <name>IETF</name>
-          <abbreviation>IETF</abbreviation>
-        </organization>
-      </affiliation>
-    </person>
-  </contributor>
-  <contributor>
-    <role type="author"/>
-    <person>
-      <name>
-        <completename language="en">M. Bjorklund</completename>
-      </name>
-      <affiliation>
-        <organization>
-          <name>IETF</name>
-          <abbreviation>IETF</abbreviation>
-        </organization>
-      </affiliation>
-    </person>
-  </contributor>
-  <language>en</language>
-  <script>Latn</script>
-  <series type="main">
-    <title format="text/plain" language="en" script="Latn">STD</title>
-    <number>91</number>
-  </series>
-  <series type="main">
-    <title format="text/plain" language="en" script="Latn">RFC</title>
-    <number>8341</number>
-  </series>
+  ....
 </bibitem>"
 ----
 With `bibdata: true` option XML output wrapped with `bibdata` element and `ext` element added.
@@ -122,13 +83,16 @@ item.to_xml bibdata: true
 
 [source,ruby]
 ----
-item = Relaton::Provider::Ietf.from_rfcxml File.read("rfc.xml")
+item = Relaton::Provider::Ietf.from_rfcxml File.read("spec/examples/rfc.xml")
 => #<RelatonIetf::IetfBibliographicItem:0x007fa8cda79ab8
 ...
 
 item.to_xml bibdata: true
 =>"<bibdata>
-...
+  <fetched>2020-09-15</fetched>
+  <title format="text/plain" language="en" script="Latn">ACVP Secure Hash Algorithm (SHA) JSON Specification</title>
+  ...
+</bibdata>"
 ----
 
 === Create bibliographic item form YAML

data/grammars/ietf.rng

@@ -868,6 +868,13 @@
   </define>
   <define name="ietf-standard">
     <element name="ietf-standard">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <zeroOrMore>
         <ref name="termdocsource"/>

data/grammars/isodoc.rng

@@ -43,7 +43,9 @@
     <define name="xref">
       <element name="xref">
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -61,6 +63,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -578,6 +585,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +670,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -697,6 +716,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -834,6 +863,13 @@
   </define>
   <define name="standard-document">
     <element name="standard-document">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <optional>
         <ref name="boilerplate"/>
@@ -855,7 +891,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -922,6 +958,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +1000,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1028,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1050,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1078,24 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1180,6 +1222,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1447,11 +1492,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>
@@ -1501,4 +1541,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>

data/lib/relaton_ietf/ietf_bibliographic_item.rb

@@ -15,29 +15,17 @@ module RelatonIetf
         warn "[relaton-ietf] WARNING: invalid doctype #{args[:doctype]}"
       end
       super
-      # @doctype = args[:doctype]
     end
 
-    # @param builder
     # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
+    # @option opts [Boolean] :bibdata
     # @option opts [Symbol, NilClass] :date_format (:short), :full
-    def to_xml(builder = nil, **opts)
+    # @option opts [String, Symbol] :lang language
+    # @return [String] XML
+    def to_xml(**opts)
       opts[:date_format] ||= :short
-      super builder, **opts do |b|
-        if opts[:bibdata] && doctype
-          b.ext do
-            b.doctype doctype if doctype
-          end
-        end
-      end
-    end
-
-    # @return [Hash]
-    def to_hash
-      hash = super
-      hash["doctype"] = doctype if doctype
-      # hash["keyword"] = single_element_array(keyword) if keyword&.any?
-      hash
+      super **opts
     end
   end
 end

data/lib/relaton_ietf/scrapper.rb

@@ -111,7 +111,10 @@ module RelatonIetf
         error = nil
         uri_nums.each do |n|
           /(?<=-)(?<ver>\d{2})$/ =~ ref
-          ref.sub! /-\d{2}/, "" if ver && n == "3"
+          if n == "3"
+            ref.sub! /-\d{2}/, "" if ver
+            ref.sub! /(?<=I-D\.)draft-/, ""
+          end
 
           uri = "#{RFC_URI_PATTERN}#{n}/reference.#{ref.sub(/\s|\u00a0/, ".")}.xml"
           begin

data/lib/relaton_ietf/version.rb

@@ -1,3 +1,3 @@
 module RelatonIetf
-  VERSION = "1.2.0".freeze
+  VERSION = "1.5.0".freeze
 end

data/lib/relaton_ietf/xml_parser.rb

@@ -3,17 +3,6 @@ require "nokogiri"
 module RelatonIetf
   class XMLParser < RelatonBib::XMLParser
     class << self
-      # def from_xml(xml)
-      #   doc = Nokogiri::XML(xml)
-      #   doc.remove_namespaces!
-      #   ietfitem = doc.at("/bibitem|/bibdata")
-      #   if ietfitem
-      #     RelatonIetf::IetfBibliographicItem.new(item_data(ietfitem))
-      #   elsif
-      #     warn "[relato-ietf] can't find bibitem or bibdata element in the XML"
-      #   end
-      # end
-
       private
 
       # override RelatonBib::BibliographicItem.bib_item method
@@ -22,15 +11,6 @@ module RelatonIetf
       def bib_item(item_hash)
         IetfBibliographicItem.new item_hash
       end
-
-      def item_data(ietfitem)
-        data = super
-        ext = ietfitem.at "./ext"
-        return data unless ext
-
-        data[:doctype] = ext.at("./doctype")&.text
-        data
-      end
     end
   end
 end

data/relaton_ietf.gemspec

@@ -40,5 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "relaton-bib", "~> 1.2.0"
+  spec.add_dependency "relaton-bib", "~> 1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.5.0
 description: "RelatonIetf: retrieve IETF Standards for bibliographic use \nusing the
   BibliographicItem model.\n\nFormerly known as rfcbib.\n"
 email:
@@ -205,7 +205,7 @@ homepage: https://github.com/metanorma/relaton-ietf
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: 'RelatonIetf: retrieve IETF Standards for bibliographic use using the BibliographicItem
   model'