relaton-nist 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c27ee448a739133b46c5b46073a5370b8407ff9389deab931df5a450586a2694
-  data.tar.gz: 6a53926d3e09a53e53d37de7b45c62b72111c85e30d9cc1cf4d97a838d7c4980
+  metadata.gz: a3697bb0d3737e3f29c9b68d2395013762ed2d5b56b8003325f495f67f670532
+  data.tar.gz: 8e41e1180ea1fb3403546eb5493df7a7588b5fff934a453f33d9f60ed1730a7f
 SHA512:
-  metadata.gz: a12935d087796f27121b84bc8d78bae367533da85e89487643f13bb4cffbd81c1dc104f6f05f4f77298b7a8940b82ca5e237e17522541bd1bbfd48449257ca64
-  data.tar.gz: a602a206c6d2dcdcade816ef4596c4c374984b5b2eb8a45fce161102d31709706c33b7c783b7f2eb3be0bdeff183356ce484ad4c7d5e154f7b7db9673a8ad5c4
+  metadata.gz: 42c02c151388863e207012f6cc2dae9fc796ef18abf5f6ebf73f9683b0e7322f35bde10471fe357515593c492db136a0b9514103fdb127fb53096b75c6197eea
+  data.tar.gz: d085edddc926b57e6e8613886c661e7296e23ab121861fe880e61044d0d25c1dd3ca9474da89356aa3861b5426a749d3f737ad8b4d20c95c5839d9ea284da85b

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

@@ -39,11 +39,10 @@ Or install it yourself as:
 require 'relaton_nist'
 
 hit_collection = RelatonNist::NistBibliography.search("8200")
-=> [<RelatonNist::Hit:0x007f82b9b2b298 @text="8200" @fetched="false" @fullIdentifier="" @title="8200">,
- <RelatonNist::Hit:0x007f82b9b2a1e0 @text="8200" @fetched="false" @fullIdentifier="" @title="8200">]
+=> <RelatonNist::HitCollection:0x007fc069d19da0 @ref=8200 @fetched=false>
 
  item = hit_collection[1].fetch
- => #<RelatonNist::NistBibliographicItem:0x007f82b986e668
+=> #<RelatonNist::NistBibliographicItem:0x007fc049aa6778
  ...
 ----
 
@@ -71,9 +70,6 @@ item.to_xml bibdata: true
     ...
     <ext>
       <doctype>stadard</doctype>
-      <keyword>cybersecurity</keyword>
-      <keyword>cybersecurity objectives</keyword>
-      ...
       <commentperiod>
         <from>2018-02-01</from>
         <to>2018-04-18</to>
@@ -86,8 +82,9 @@ item.to_xml bibdata: true
 [source,ruby]
 ----
 RelatonNist::NistBibliography.get("8200", "2018", {})
-fetching 8200...
-=> #<RelatonNist::NistBibliographicItem:0x007f82bb3370a8
+[relaton-nist] ("8200") fetching...
+[relaton-nist] ("8200") found NISTIR 8200
+=> #<RelatonNist::NistBibliographicItem:0x007fc06aa2b480
 ...
 ----
 
@@ -110,9 +107,10 @@ NIST FIPS {docnumber}
 ----
 [source,ruby]
 ----
-RelatonNist::NistBibliography.get("8200", "2018", {})
-fetching 8200...
-=> #<RelatonNist::NistBibliographicItem:0x007f82bb3370a8
+RelatonNist::NistBibliography.get("SP 800-205 (February 2019) (PD)")
+[relaton-nist] ("SP 800-205") fetching...
+[relaton-nist] ("SP 800-205") found SP 800-205 (Draft)
+=> #<RelatonNist::NistBibliographicItem:0x007fc059934768
 ...
 ----
 

data/grammars/isodoc.rng

@@ -42,8 +42,11 @@
     </define>
     <define name="xref">
       <element name="xref">
+        <!-- attribute target { xsd:IDREF }, -->
         <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 +64,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -578,6 +586,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +671,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 +717,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>
@@ -855,7 +885,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -922,6 +952,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +994,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1022,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1044,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1072,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 +1216,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1447,11 +1486,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 +1535,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/grammars/nist.rng

@@ -9,6 +9,24 @@
     <start>
       <ref name="nist-standard"/>
     </start>
+    <define name="ol">
+      <element name="ol">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="class">
+            <value>steps</value>
+          </attribute>
+        </optional>
+        <oneOrMore>
+          <ref name="li"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="DocumentType">
       <value>standard</value>
     </define>
@@ -16,7 +34,7 @@
     <define name="preface">
       <element name="preface">
         <optional>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
         </optional>
         <optional>
           <ref name="foreword"/>

data/lib/relaton_nist/comment_period.rb

@@ -34,5 +34,16 @@ module RelatonNist
       hash["extended"] = extended.to_s if extended
       hash
     end
+
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix)
+      pref = prefix.empty? ? prefix : prefix + "."
+      pref += "commentperiod"
+      out = "#{pref}.from:: #{from}\n"
+      out += "#{pref}.to:: #{to}\n" if to
+      out += "#{pref}.extended:: #{extended}\n" if extended
+      out
+    end
   end
 end

data/lib/relaton_nist/document_relation.rb

@@ -0,0 +1,5 @@
+module RelatonNist
+  class DocumentRelation < RelatonBib::DocumentRelation
+    TYPES += %w[obsoletedBy supersedes supersededBy].freeze
+  end
+end

data/lib/relaton_nist/hash_converter.rb

@@ -26,6 +26,24 @@ module RelatonNist
 
         ret[:commentperiod] = CommentPeriod.new ret[:commentperiod]
       end
+
+      # @param ret [Hash]
+      def relations_hash_to_bib(ret)
+        super
+        return unless ret[:relation]
+
+        ret[:relation] = ret[:relation].map { |r| DocumentRelation.new r }
+
+        # ret[:relation] = array(ret[:relation])
+        # ret[:relation]&.each do |r|
+        #   if r[:description]
+        #     r[:description] = FormattedString.new r[:description]
+        #   end
+        #   relation_bibitem_hash_to_bib(r)
+        #   relation_locality_hash_to_bib(r)
+        #   relation_source_locality_hash_to_bib(r)
+        # end
+      end
     end
   end
 end

data/lib/relaton_nist/hit_collection.rb

@@ -17,10 +17,10 @@ module RelatonNist
     # @param year [String]
     # @param opts [Hash]
     # @option opts [String] :stage
-    def initialize(ref_nbr, year = nil, opts = {})
+    def initialize(ref_nbr, year = nil, opts = {}) # rubocop:disable Metrics/AbcSize
       super ref_nbr, year
 
-      /(?<docid>(SP|FIPS)\s[0-9-]+)/ =~ text
+      /(?<docid>(SP|FIPS)\s[0-9-]+\w?)/ =~ text
       @array = docid ? from_json(docid, **opts) : from_csrc(**opts)
 
       @array.sort! do |a, b|
@@ -45,28 +45,28 @@ module RelatonNist
         from = d.strftime "%m/%d/%Y"
         to   = d.next_year.prev_day.strftime "%m/%d/%Y"
       end
-      url  = "#{DOMAIN}/publications/search?keywords-lg=#{text}"
+      url = "#{DOMAIN}/publications/search?keywords-lg=#{text}"
       url += "&dateFrom-lg=#{from}" if from
       url += "&dateTo-lg=#{to}" if to
-      url += if /PD/ =~ opts[:stage]
+      url += if /PD/.match? opts[:stage]
                "&status-lg=Draft,Retired Draft,Withdrawn"
              else
                "&status-lg=Final,Withdrawn"
              end
 
-      doc  = Nokogiri::HTML OpenURI.open_uri(::Addressable::URI.parse(url).normalize)
+      doc = Nokogiri::HTML OpenURI.open_uri(::Addressable::URI.parse(url).normalize)
       doc.css("table.publications-table > tbody > tr").map do |h|
         link  = h.at("td/div/strong/a")
         serie = h.at("td[1]").text.strip
         code  = h.at("td[2]").text.strip
         title = link.text
-        doc_url   = DOMAIN + link[:href]
+        doc_url = DOMAIN + link[:href]
         status = h.at("td[4]").text.strip.downcase
         release_date = Date.strptime h.at("td[5]").text.strip, "%m/%d/%Y"
         Hit.new(
           {
-            code: code, serie: serie, title: title, url: doc_url, status: status,
-            release_date: release_date
+            code: code, serie: serie, title: title, url: doc_url,
+            status: status, release_date: release_date
           }, self
         )
       end
@@ -91,17 +91,18 @@ module RelatonNist
     # @param docid [String]
     # @param stage [String]
     # @return [Array<Hach>]
-    def select_data(docid, **opts)
+    def select_data(docid, **opts) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength,Metrics/PerceivedComplexity
       d = Date.strptime year, "%Y" if year
+      didrx = Regexp.new(docid)
       data.select do |doc|
         next unless match_year?(doc, d)
 
-        if /PD/ =~ opts[:stage]
+        if /PD/.match? opts[:stage]
           next unless %w[draft-public draft-prelim].include? doc["status"]
         else
           next unless doc["status"] == "final"
         end
-        doc["docidentifier"] =~ Regexp.new(docid)
+        doc["docidentifier"] =~ didrx
       end
     end
 
@@ -129,7 +130,9 @@ module RelatonNist
     #
     # @prarm ctime [Time, NilClass]
     def fetch_data(ctime)
-      resp = OpenURI.open_uri("https://csrc.nist.gov/CSRC/media/feeds/metanorma/pubs-export.meta")
+      resp = OpenURI.open_uri(
+        "https://csrc.nist.gov/CSRC/media/feeds/metanorma/pubs-export.meta"
+      )
       if !ctime || ctime < resp.last_modified
         @data = nil
         zip = OpenURI.open_uri "https://csrc.nist.gov/CSRC/media/feeds/metanorma/pubs-export.zip"

data/lib/relaton_nist/nist_bibliographic_item.rb

@@ -51,7 +51,7 @@ module RelatonNist
     # @option abstract [String] :script
     # @option abstract [String] :type
     #
-    # @param relation [Array<Hash>]
+    # @param relation [Array<Hash, RelatonNist::DocumentRelation>]
     # @option relation [String] :type
     # @option relation [RelatonBib::BibliographicItem] :bibitem
     # @option relation [Array<RelatonBib::BibItemLocality>] :bib_locality
@@ -83,5 +83,13 @@ module RelatonNist
       hash["commentperiod"] = commentperiod.to_hash if commentperiod
       hash
     end
+
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix = "")
+      out = super
+      out += commentperiod.to_asciibib prefix if commentperiod
+      out
+    end
   end
 end

data/lib/relaton_nist/nist_bibliography.rb

@@ -1,5 +1,6 @@
 require "relaton_bib"
 require "relaton_nist/nist_bibliographic_item"
+require "relaton_nist/document_relation"
 require "relaton_nist/scrapper"
 require "relaton_nist/hit_collection"
 require "relaton_nist/xml_parser"
@@ -120,7 +121,7 @@ module RelatonNist
       end
 
       def nistbib_search_filter(code, year, opts)
-        idregex = %r{[0-9-]{3,}}
+        idregex = %r{[0-9-]{3,}\w?}
         docid = code.match(idregex).to_s
         serie = code.match(%r{(FISP|SP|NISTIR)(?=\s)})
         warn "[relaton-nist] (\"#{code}\") fetching..."

data/lib/relaton_nist/scrapper.rb

@@ -235,15 +235,18 @@ module RelatonNist
             )
           end
           if contr["surname"]
-            affiliation = RelatonBib::Affiliation.new organization: org
+            affiliation = []
+            affiliation << RelatonBib::Affiliation.new(organization: org) if org
             entity = RelatonBib::Person.new(
-              name: full_name(contr, lang, script), affiliation: [affiliation],
+              name: full_name(contr, lang, script), affiliation: affiliation,
             )
-          else
+          elsif org
             entity = org
           end
-          RelatonBib::ContributionInfo.new entity: entity, role: [type: role]
-        end
+          if entity
+            RelatonBib::ContributionInfo.new entity: entity, role: [type: role]
+          end
+        end.compact
       end
 
       # rubocop:disable Metrics/CyclomaticComplexity
@@ -373,7 +376,7 @@ module RelatonNist
 
       # Fetch relations.
       # @param doc [Nokogiri::HTML::Document]
-      # @return [Array<RelatonBib::DocumentRelation>]
+      # @return [Array<RelatonNist::DocumentRelation>]
       def fetch_relations(doc)
         relations = doc.xpath('//span[@id="pub-supersedes-container"]/a').map do |r|
           doc_relation "supersedes", r.text, DOMAIN + r[:href]
@@ -402,9 +405,9 @@ module RelatonNist
       # @param type [String]
       # @param ref [String]
       # @param uri [String]
-      # @return [RelatonBib::DocumentRelation]
+      # @return [RelatonNist::DocumentRelation]
       def doc_relation(type, ref, uri, lang = "en", script = "Latn")
-        RelatonBib::DocumentRelation.new(
+        DocumentRelation.new(
           type: type,
           bibitem: RelatonBib::BibliographicItem.new(
             formattedref: RelatonBib::FormattedRef.new(

data/lib/relaton_nist/version.rb

@@ -1,3 +1,3 @@
 module RelatonNist
-  VERSION = "1.2.0".freeze
+  VERSION = "1.4.0".freeze
 end

data/lib/relaton_nist/xml_parser.rb

@@ -1,28 +1,25 @@
 module RelatonNist
   class XMLParser < RelatonBib::XMLParser
     class << self
-      def from_xml(xml)
-        doc = Nokogiri::XML xml
-        doc.remove_namespaces!
-        nistitem = doc.at("/bibitem|/bibdata")
-        if nistitem
-          NistBibliographicItem.new(item_data(nistitem))
-        elsif
-          warn "[relaton-nist] can't find bibitem or bibdata element in the XML"
-        end
-      end
-
       private
 
-      def item_data(nistitem)
+      # @param intem [Nokogiri::XML::Document]
+      # @return [Hash]
+      def item_data(item)
         data = super
-        ext = nistitem.at "./ext"
+        ext = item.at "./ext"
         return data unless ext
 
         data[:commentperiod] = fetch_commentperiod(ext)
         data
       end
 
+      # @param item_hash [Hash]
+      # @return [RelatonNist::NistBibliographicItem]
+      def bib_item(item_hash)
+        NistBibliographicItem.new item_hash
+      end
+
       def fetch_status(item)
         status = item.at "./status"
         return unless status
@@ -43,6 +40,12 @@ module RelatonNist
           extended: cp.at("extended")&.text
         )
       end
+
+      # @param item [Nokogiri::XML::Element]
+      # @return [Array<RelatonBib::DocumentRelation>]
+      def fetch_relations(item)
+        super item, DocumentRelation
+      end
     end
   end
 end

data/relaton_nist.gemspec

@@ -34,6 +34,6 @@ 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.4.0"
   spec.add_dependency "rubyzip"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-nist
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-09-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.2.0
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -204,6 +204,7 @@ files:
 - grammars/reqt.rng
 - lib/relaton_nist.rb
 - lib/relaton_nist/comment_period.rb
+- lib/relaton_nist/document_relation.rb
 - lib/relaton_nist/document_status.rb
 - lib/relaton_nist/hash_converter.rb
 - lib/relaton_nist/hit.rb
@@ -219,7 +220,7 @@ homepage: https://github.com/metanorma/relaton-nist
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -235,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: 'RelatonNist: retrive NIST standards.'
 test_files: []