relaton-ietf 1.5.0 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e833387c3a25a940b436ab64dd8ed498c5418240fe02a371a97ffd49a62de1c7
-  data.tar.gz: e7470c46a46172373d273c08243d9831ac6eb57efb5007ed3d1c0896d8b645df
+  metadata.gz: fe0909b3d346a37c7e6363a2c1b4c2822464b1b8bcaa589e3b9efad9148b24a8
+  data.tar.gz: b1a22b2905d52f0f014a27ea7eb11abe049ec62c2e6918818c6ca5cf3e2af843
 SHA512:
-  metadata.gz: 10ba8e35c6ddf329ce0aebeade61c8ed71973f8c86b7665b3bdf8aa5b7164e9bb76f3669d6da8258265fb86d3e47d0bacff749fb5b1fdc0549a521d0a071a4d6
-  data.tar.gz: 43a839c670c248d1293c978b9bdfa9f06a2cf1b0cbe287e2b3a115b7144ec7779b689eecaec783e27a1f3b1a3810bf2bf6781a9754f943ba9894206e6bf4cfb2
+  metadata.gz: 151fddd3a5168eb80b1fcd0f86a33f58ab222993457c2c1eb8b24a03ccf976b4048b01e7a7ff182957c846a258fe77602114f2de394b285b6291e16baca2cd35
+  data.tar.gz: '08ed81561c2737cc7852c868990064e4bf23bfd270c24f55ecb6948b6b97e7bcff09274baebab5d4003797c0babc1fc1c4dfabbd19e72cfd33e73f05533b4e13'

data/.github/workflows/macos.yml

@@ -26,6 +26,8 @@ jobs:
       - name: Update gems
         run: |
           sudo gem install bundler --force
+          ruby -v | grep 2.5 && bundle config set build.debase --with-cflags="-Wno-error=implicit-function-declaration"
+          ruby -v | grep 2.5 && bundle config set build.ruby-debug-ide --with-cflags="-Wno-error=implicit-function-declaration"
           bundle install --jobs 4 --retry 3
       - name: Run specs
         run: |

data/grammars/isodoc.rng

@@ -24,6 +24,14 @@
     <start>
       <ref name="standard-document"/>
     </start>
+    <define name="doctype">
+      <element name="doctype">
+        <optional>
+          <attribute name="abbreviation"/>
+        </optional>
+        <ref name="DocumentType"/>
+      </element>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -141,6 +149,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -1164,49 +1177,7 @@
   </define>
   <define name="annex">
     <element name="annex">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="language"/>
-      </optional>
-      <optional>
-        <attribute name="script"/>
-      </optional>
-      <optional>
-        <attribute name="inline-header">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <attribute name="obligation">
-        <choice>
-          <value>normative</value>
-          <value>informative</value>
-        </choice>
-      </attribute>
-      <optional>
-        <ref name="section-title"/>
-      </optional>
-      <group>
-        <group>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
-        <zeroOrMore>
-          <choice>
-            <ref name="annex-subsection"/>
-            <ref name="terms"/>
-            <ref name="definitions"/>
-            <ref name="references"/>
-          </choice>
-        </zeroOrMore>
-      </group>
+      <ref name="Annex-Section"/>
     </element>
   </define>
   <define name="terms">

data/lib/relaton_ietf.rb

@@ -6,11 +6,6 @@ require "relaton_ietf/ietf_bibliographic_item"
 require "relaton_ietf/xml_parser"
 require "relaton_ietf/hash_converter"
 
-# if defined? Relaton
-#   require_relative "relaton_ietf/processor"
-#   Relaton::Registry.instance.register(RelatonIetf::Processor)
-# end
-
 require "relaton/provider_ietf"
 
 module RelatonIetf
@@ -22,4 +17,4 @@ module RelatonIetf
     grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
     Digest::MD5.hexdigest grammars
   end
-end
+end

data/lib/relaton_ietf/hash_converter.rb

@@ -1,23 +1,14 @@
 module RelatonIetf
   class HashConverter < RelatonBib::HashConverter
     class << self
-      # @override RelatonBib::HashConverter.hash_to_bib
-      # @param args [Hash]
-      # @param nested [TrueClass, FalseClass]
-      # @return [Hash]
-      # def hash_to_bib(args, nested = false)
-      #   ret = super
-      #   return if ret.nil?
-
-      #   doctype_hash_to_bib(ret)
-      #   ret
-      # end
-
-      # private
-
-      # def doctype_hash_to_bib(ret)
-      #   ret
-      # end
+      #
+      # Ovverides superclass's method
+      #
+      # @param item [Hash]
+      # @retirn [RelatonIec::IecBibliographicItem]
+      def bib_item(item)
+        IetfBibliographicItem.new(item)
+      end
     end
   end
 end

data/lib/relaton_ietf/scrapper.rb

@@ -10,44 +10,31 @@ module RelatonIetf
 
   # Scrapper module
   module Scrapper
-    RFC_URI_PATTERN = "https://xml2rfc.tools.ietf.org/public/rfc/bibxml"
-    # ID_URI_PATTERN = "https://xml2rfc.tools.ietf.org/public/rfc/bibxml-ids/reference.CODE"
+    GH_URL = "https://raw.githubusercontent.com/relaton/relaton-data-ietf/master/data/reference."
     BCP_URI_PATTERN = "https://www.rfc-editor.org/info/CODE"
 
     class << self
-      # rubocop:disable Metrics/MethodLength
-
       # @param text [String]
       # @param is_relation [TrueClass, FalseClass]
       # @return [RelatonIetf::IetfBibliographicItem]
       def scrape_page(text, is_relation = false)
         # Remove initial "IETF " string if specified
         ref = text.gsub(/^IETF /, "")
-
-        case ref
-        when /^RFC/ then rfc_item [""], ref, is_relation
-        when /^I-D/ then rfc_item ["3"], ref, is_relation
-        when /^W3C/ then rfc_item ["4", "2"], ref, is_relation
-        when /^(ANSI|CCITT|FIPS|IANA|ISO|ITU|NIST|OASIS|PKCS)/
-          rfc_item ["2"], ref, is_relation
-        when /^(3GPP|SDO-3GPP)/ then rfc_item ["5"], ref, is_relation
-        when /^IEEE/ then rfc_item ["6", "2"], ref, is_relation
-        when /^BCP/ then bcp_item BCP_URI_PATTERN.dup, ref
-        else
-          raise RelatonBib::RequestError, "#{ref}: not recognised for RFC"
-        end
+        /^(RFC|BCP|FYI|STD)\s(?<num>\d+)/ =~ ref
+        ref.sub! /(?<=^(?:RFC|BCP|FYI|STD)\s)(\d+)/, num.rjust(4, "0") if num
+        rfc_item ref, is_relation
       rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
              Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
              Net::ProtocolError, SocketError
         raise RelatonBib::RequestError, "No document found for #{ref} reference."
       end
 
-      # @param reference [String]
+      # @param reference [Nokogiri::XML::Element, nil]
       # @param is_relation [TrueClass, FalseClass]
       # @param url [String, NilClass]
       # @param ver [String, NilClass] Internet Draft version
       # @return [RelatonIetf::IetfBibliographicItem]
-      def fetch_rfc(reference, is_relation = false, url = nil, ver = nil)
+      def fetch_rfc(reference, is_relation = false, url = nil, ver = nil) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
         return unless reference
 
         ietf_item(
@@ -59,23 +46,24 @@ module RelatonIetf
           language: [language(reference)],
           link: link(reference, url, ver),
           title: titles(reference),
+          formattedref: formattedref(reference),
           abstract: abstracts(reference),
           contributor: contributors(reference),
+          relation: relations(reference),
           date: dates(reference),
           series: series(reference),
           place: ["Fremont, CA"],
           keyword: reference.xpath("front/keyword").map(&:text),
-          doctype: doctype(reference[:anchor]),
+          doctype: doctype(reference[:anchor])
         )
       end
-      # rubocop:enable Metrics/MethodLength
 
       private
 
       # @param anchor [String]
       # @return [String]
       def doctype(anchor)
-        anchor =~ /I-D/ ? "internet-draft" : "rfc"
+        anchor&.include?("I-D") ? "internet-draft" : "rfc"
       end
 
       # @param reference [Nokogiri::XML::Element]
@@ -86,7 +74,7 @@ module RelatonIetf
         l = []
         l << { type: "xml", content: url } if url
         l << { type: "src", content: reference[:target] } if reference[:target]
-        if reference[:anchor] =~ /^I-D/
+        if /^I-D/.match? reference[:anchor]
           reference.xpath("format").each do |f|
             c = ver ? f[:target].sub(/(?<=-)\d{2}(?=\.)/, ver) : f[:target]
             l << { type: f[:type], content: c }
@@ -103,57 +91,30 @@ module RelatonIetf
         RelatonIetf::IetfBibliographicItem.new **attrs
       end
 
-      # @param uri_nums [Array<String>]
       # @param ref [String]
       # @return [RelatonIetf::IetfBibliographicItem]
-      def rfc_item(uri_nums, ref, is_relation)
-        uri = nil
-        error = nil
-        uri_nums.each do |n|
-          /(?<=-)(?<ver>\d{2})$/ =~ ref
-          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
-            doc = Nokogiri::XML get_page(uri)
-            resp = fetch_rfc doc.at("//reference"), is_relation, uri, ver
-            return resp if resp
-          rescue RelatonBib::RequestError => e
-            error = e
-          end
+      def rfc_item(ref, is_relation)
+        /(?<=-)(?<ver>\d{2})$/ =~ ref
+        if /^I-D/.match? ref
+          ref.sub! /-\d{2}/, "" if ver
+          ref.sub! /(?<=I-D\.)draft-/, ""
         end
-        raise error
-      end
 
-      # @param uri_template [String]
-      # @param reference [String]
-      # @return [RelatonIetf::IetfBibliographicItem]
-      def bcp_item(uri_template, reference)
-        uri = uri_template.sub "CODE", reference.sub(" ", "").downcase
-        doc = Nokogiri::HTML get_page(uri)
-        ietf_item(
-          id: reference,
-          title: [content: ""],
-          docid: [RelatonBib::DocumentIdentifier.new(type: "IETF", id: reference)],
-          language: ["en"],
-          link: [{ type: "src", content: uri }],
-          relation: fetch_relations(doc),
-          doctype: "rfc",
-        )
+        uri = "#{GH_URL}#{ref.sub(/\s|\u00a0/, '.')}.xml"
+        doc = Nokogiri::XML get_page(uri)
+        fetch_rfc doc.at("/referencegroup", "/reference"), is_relation, uri, ver
       end
 
-      def fetch_relations(doc)
-        doc.xpath("//table/tr/td/a[contains(., 'RFC')]").map do |r|
-          RelatonBib::DocumentRelation.new(
-            type: "merges",
-            bibitem: scrape_page(r.text, true),
-          )
+      # @param reference [Nokogiri::XML::Element]
+      # @return [Hash]
+      def relations(reference)
+        reference.xpath("reference").map do |ref|
+          { type: "includes", bibitem: fetch_rfc(ref, true) }
         end
       end
 
+      # @param uri [String]
+      # @return [String] HTTP response body
       def get_page(uri)
         res = Net::HTTP.get_response(URI(uri))
         if res.code != "200"
@@ -163,21 +124,30 @@ module RelatonIetf
         res.body
       end
 
-      # def make_uri(uri_template, reference)
-      #   uri_template.gsub("CODE", reference)
-      # end
-
+      # @param reference [Nokogiri::XML::Element]
       # @return [String]
       def language(reference)
         reference[:lang] || "en"
       end
 
+      # @param reference [Nokogiri::XML::Element]
       # @return [Array<Hash>]
       def titles(reference)
-        title = reference.at("./front/title")
-        [{ content: title.text, language: language(reference), script: "Latn" }]
+        reference.xpath("./front/title").map do |title|
+          { content: title.text, language: language(reference), script: "Latn" }
+        end
+      end
+
+      # @param reference [Nokogiri::XML::Element]
+      # @return [RelatonBib::FormattedRef, nil]
+      def formattedref(reference)
+        return if reference.at "./fornt/title"
+
+        cont = (reference[:anchor] || reference[:docName] || reference[:number])
+        RelatonBib::FormattedRef.new content: cont, language: language(reference), script: "Latn" if cont
       end
 
+      # @param reference [Nokogiri::XML::Element]
       # @return [Array<RelatonBib::FormattedString>]
       def abstracts(ref)
         ref.xpath("./front/abstract").map do |a|
@@ -188,24 +158,27 @@ module RelatonIetf
         end
       end
 
+      # @param reference [Nokogiri::XML::Element]
       # @return [Array<Hash>]
       def contributors(reference)
         persons(reference) + organizations(reference)
       end
 
+      # @param reference [Nokogiri::XML::Element]
       # @return [Array<Hash{Symbol=>RelatonBib::Person,Symbol=>Array<String>}>]
       def persons(reference)
-        reference.xpath("./front/author[@surname]|./front/author[@fullname]").
-          map do |author|
+        reference.xpath("./front/author[@surname]|./front/author[@fullname]")
+          .map do |author|
           entity = RelatonBib::Person.new(
             name: full_name(author, reference),
             affiliation: [affiliation(author)],
-            contact: contacts(author.at("./address")),
+            contact: contacts(author.at("./address"))
           )
           { entity: entity, role: [contributor_role(author)] }
         end
       end
 
+      # @param reference [Nokogiri::XML::Element]
       # @return [Array<Hash{Symbol=>RelatonBib::Organization,Symbol=>Array<String>}>]
       def organizations(reference)
         publisher = { entity: new_org, role: [type: "publisher"] }
@@ -215,21 +188,21 @@ module RelatonIetf
           mem << { entity: new_org(si[:stream], nil), role: [type: "author"] }
         end
         orgs + reference.xpath(
-          "front/author[not(@surname)][not(@fullname)]/organization",
+          "front/author[not(@surname)][not(@fullname)]/organization"
         ).map do |org|
           { entity: new_org(org.text, nil), role: [type: "author"] }
         end
       end
 
-      # @param author [Nokogiri::XML::Document]
-      # @param ref [Nokogiri::XML::Document]
+      # @param author [Nokogiri::XML::Element]
+      # @param ref [Nokogiri::XML::Element]
       # @return [RelatonBib::FullName]
       def full_name(author, ref)
         lang = language ref
         RelatonBib::FullName.new(
           completename: localized_string(author[:fullname], lang),
           initial: [localized_string(author[:initials], lang)].compact,
-          surname: localized_string(author[:surname], lang),
+          surname: localized_string(author[:surname], lang)
         )
       end
 
@@ -242,7 +215,7 @@ module RelatonIetf
         RelatonBib::LocalizedString.new(content, lang)
       end
 
-      # @param postal [Nokogiri::XML::Document]
+      # @param postal [Nokogiri::XML::Element]
       # @return [Array<RelatonBib::Address, RelatonBib::Phone>]
       def contacts(addr)
         contacts = []
@@ -256,15 +229,15 @@ module RelatonIetf
         contacts
       end
 
-      # @param postal [Nokogiri::XML::Document]
+      # @param postal [Nokogiri::XML::Element]
       # @rerurn [RelatonBib::Address]
-      def address(postal)
+      def address(postal) # rubocop:disable Metrics/CyclomaticComplexity
         RelatonBib::Address.new(
           street: [(postal.at("./postalLine") || postal.at("./street"))&.text],
           city: postal.at("./city")&.text,
           postcode: postal.at("./code")&.text,
           country: postal.at("./country")&.text,
-          state: postal.at("./region")&.text,
+          state: postal.at("./region")&.text
         )
       end
 
@@ -276,7 +249,7 @@ module RelatonIetf
         contacts << RelatonBib::Contact.new(type: type, value: value.text)
       end
 
-      # @param author [Nokogiri::XML::Document]
+      # @param author [Nokogiri::XML::Element]
       # @return [RelatonBib::Affiliation]
       def affiliation(author)
         organization = author.at("./organization")
@@ -303,7 +276,7 @@ module RelatonIetf
 
       def month(mon)
         return 1 if !mon || mon.empty?
-        return mon if /^\d+$/ =~ mon
+        return mon if /^\d+$/.match? mon
 
         Date::MONTHNAMES.index(mon)
       end
@@ -311,6 +284,7 @@ module RelatonIetf
       #
       # Extract date from reference.
       #
+      # @param reference [Nokogiri::XML::Element]
       # @return [Array<RelatonBib::BibliographicDate>] published data.
       #
       def dates(reference)
@@ -322,8 +296,6 @@ module RelatonIetf
         [RelatonBib::BibliographicDate.new(type: "published", on: date)]
       end
 
-      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-
       #
       # Extract document identifiers from reference
       #
@@ -332,12 +304,12 @@ module RelatonIetf
       #
       # @return [Array<RelatonBib::DocumentIdentifier>]
       #
-      def docids(reference, ver)
+      def docids(reference, ver) # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/AbcSize
         id = (reference[:anchor] || reference[:docName] || reference[:number])
         ret = []
         if id
           ret << RelatonBib::DocumentIdentifier.new(
-            type: "IETF", id: id.sub(/^(RFC)/, "\\1 "),
+            type: "IETF", id: id.sub(/^(RFC)/, "\\1 ")
           )
         end
         if (id = reference[:anchor])
@@ -351,11 +323,10 @@ module RelatonIetf
           RelatonBib::DocumentIdentifier.new(id: id, type: si[:name])
         end.compact
       end
-      # enable Metrics/MethodLength, Metrics/AbcSize
 
       #
       # Extract series form reference
-      # @param reference [Nokogiri::XML::Document]
+      # @param reference [Nokogiri::XML::Element]
       #
       # @return [Array<RelatonBib::Series>]
       #
@@ -365,17 +336,17 @@ module RelatonIetf
 
           RelatonBib::Series.new(
             title: RelatonBib::TypedTitleString.new(
-              content: si[:name], language: language(reference), script: "Latn",
+              content: si[:name], language: language(reference), script: "Latn"
             ),
             number: si[:value],
-            type: "main",
+            type: "main"
           )
         end.compact
       end
 
       #
       # extract status
-      # @param reference [Nokogiri::XML::Document]
+      # @param reference [Nokogiri::XML::Element]
       #
       # @return [RelatonBib::DocumentStatus]
       #
@@ -383,9 +354,7 @@ module RelatonIetf
         st = reference.at("./seriesinfo[@status]")
         return unless st
 
-        RelatonBib::DocumentStatus.new(
-          stage: st[:status],
-        )
+        RelatonBib::DocumentStatus.new(stage: st[:status])
       end
     end
   end

data/lib/relaton_ietf/version.rb

@@ -1,3 +1,3 @@
 module RelatonIetf
-  VERSION = "1.5.0".freeze
+  VERSION = "1.7.2".freeze
 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.5.0"
+  spec.add_dependency "relaton-bib", "~> 1.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.7.0
 description: "RelatonIetf: retrieve IETF Standards for bibliographic use \nusing the
   BibliographicItem model.\n\nFormerly known as rfcbib.\n"
 email: