relaton-ieee 1.1.0

data/grammars/reqt.rng

@@ -0,0 +1,165 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Presupposes isodoc.rnc, is included in it
+    include "isodoc.rnc" { }
+  -->
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="recommendation">
+    <element name="recommendation">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="permission">
+    <element name="permission">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="RequirementType">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="unnumbered">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="subsequence"/>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <optional>
+      <ref name="subject"/>
+    </optional>
+    <optional>
+      <ref name="reqinherit"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+      </choice>
+    </zeroOrMore>
+    <optional>
+      <ref name="reqt_references"/>
+    </optional>
+    <zeroOrMore>
+      <choice>
+        <ref name="requirement"/>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="reqtitle">
+    <element name="title">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="label">
+    <element name="label">
+      <text/>
+    </element>
+  </define>
+  <define name="subject">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="inherit">
+      <text/>
+    </element>
+  </define>
+  <define name="measurementtarget">
+    <element name="measurement-target">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="specification">
+    <element name="specification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="verification">
+    <element name="verification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="import">
+    <element name="import">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="description">
+    <element name="description">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="reqt_references">
+    <element name="references">
+      <oneOrMore>
+        <ref name="bibitem"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="RequirementSubpart">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="exclude">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="ObligationType">
+    <choice>
+      <value>requirement</value>
+      <value>recommendation</value>
+      <value>permission</value>
+    </choice>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
+</grammar>

data/lib/relaton_ieee.rb

@@ -0,0 +1,25 @@
+require "digest/md5"
+require "yaml"
+require "relaton_bib"
+require "relaton_ieee/version"
+require "relaton_ieee/ieee_bibliography"
+require "relaton_ieee/hit_collection"
+require "relaton_ieee/hit"
+require "relaton_ieee/scrapper"
+require "relaton_ieee/ieee_bibliographic_item"
+require "relaton_ieee/committee"
+require "relaton_ieee/xml_parser"
+require "relaton_ieee/hash_converter"
+
+module RelatonIeee
+  class Error < StandardError; end
+
+  # Returns hash of XML reammar
+  # @return [String]
+  def self.grammar_hash
+    gem_path = File.expand_path "..", __dir__
+    grammars_path = File.join gem_path, "grammars", "*"
+    grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
+    Digest::MD5.hexdigest grammars
+  end
+end

data/lib/relaton_ieee/committee.rb

@@ -0,0 +1,33 @@
+module RelatonIeee
+  class Committee
+    # @return [String]
+    attr_reader :type, :name
+
+    # @return [String, NilClass]
+    attr_reader :chair
+
+    # @param type [String]
+    # @param name [String]
+    # @param chair [String, NilClass]
+    def initialize(type:, name:, chair: nil)
+      @type = type
+      @name = name
+      @chair = chair
+    end
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.committee type: type do |b|
+        b.name name
+        b.chair chair if chair
+      end
+    end
+
+    # @return [Hash]
+    def to_hash
+      hash = { "type" => type, "name" => name }
+      hash["chair"] = chair if chair
+      hash
+    end
+  end
+end

data/lib/relaton_ieee/hash_converter.rb

@@ -0,0 +1,29 @@
+module RelatonIeee
+  class HashConverter < RelatonBib::HashConverter
+    class << self
+      # @param args [Hash]
+      # @param neated [TrueClas, FalseClass] default true
+      # @return [Hash]
+      def hash_to_bib(args, nested = false)
+        hash = super
+        return nil unless hash.is_a?(Hash)
+
+        committee_hash_to_bib hash
+        hash
+      end
+
+      # @param item_hash [Hash]
+      # @return [RelatonIeee::IeeeBibliographicItem]
+      def bib_item(item_hash)
+        IeeeBibliographicItem.new item_hash
+      end
+
+      # @param hash [Hash]
+      def committee_hash_to_bib(hash)
+        return unless hash[:committee]
+
+        hash[:committee] = hash[:committee].map { |c| Committee.new c }
+      end
+    end
+  end
+end

data/lib/relaton_ieee/hit.rb

@@ -0,0 +1,9 @@
+module RelatonIeee
+  class Hit < RelatonBib::Hit
+    # Parse page.
+    # @return [RelatonIeee::IeeeBliographicItem]
+    def fetch
+      @fetch ||= Scrapper.parse_page hit
+    end
+  end
+end

data/lib/relaton_ieee/hit_collection.rb

@@ -0,0 +1,34 @@
+require "faraday"
+require "relaton_ieee/hit"
+require "fileutils"
+
+module RelatonIeee
+  class HitCollection < RelatonBib::HitCollection
+    DOMAIN = "https://standards.ieee.org".freeze
+    DATADIR = File.expand_path ".relaton/ogc/", Dir.home
+    DATAFILE = File.expand_path "bibliography.json", DATADIR
+    ETAGFILE = File.expand_path "etag.txt", DATADIR
+
+    # rubocop:disable Metrics/AbcSize
+
+    # @param ref [Strig]
+    # @param opts [Hash]
+    def initialize(ref)
+      super
+      code = ref.sub /^IEEE\s/, ""
+      search = CGI.escape({ data: { searchTerm: code } }.to_json)
+      url = "#{DOMAIN}/bin/standards/search?data=#{search}"
+      resp = Faraday.get url
+      resp_json = JSON.parse resp.body
+      json = JSON.parse resp_json["message"]
+      @array = json["response"]["searchResults"]["resultsMapList"].
+        reduce([]) do |s, hit|
+          /^(?<id>\d+)-(?<year>\d{4})/ =~ hit["record"]["recordTitle"]
+          next s unless id && code =~ %r{^#{id}}
+
+          s << Hit.new(hit["record"].merge(code: id, year: year.to_i), self)
+        end.sort_by { |h| h.hit[:year].to_s + h.hit["recordURL"] }.reverse
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/relaton_ieee/ieee_bibliographic_item.rb

@@ -0,0 +1,31 @@
+module RelatonIeee
+  class IeeeBibliographicItem < RelatonBib::BibliographicItem
+    # @return [Array<RelatonIeee::Committee>]
+    attr_reader :committee
+
+    # @param committee [Array<RelatonIeee::Committee>]
+    def initialize(**args)
+      @committee = args.delete :committee
+      super
+    end
+
+    # @param builder [Nokogiri::XML::Bilder]
+    # @parma bibdata [TrueClass, FalseClass, NilClass]
+    def to_xml(builder = nil, **opts)
+      super do |bldr|
+        if opts[:bibdata] && committee.any?
+          bldr.ext do |b|
+            committee.each { |c| c.to_xml b }
+          end
+        end
+      end
+    end
+
+    # @return [Hash]
+    def to_hash
+      hash = super
+      hash["committee"] = committee.map &:to_hash
+      hash
+    end
+  end
+end

data/lib/relaton_ieee/ieee_bibliography.rb

@@ -0,0 +1,72 @@
+module RelatonIeee
+  class IeeeBibliography
+    class << self
+      # @param text [String]
+      # @return [RelatonIeee::HitCollection]
+      def search(text)
+        HitCollection.new text
+      rescue Faraday::ConnectionFailed
+        raise RelatonBib::RequestError, "Could not access #{HitCollection::DOMAIN}"
+      end
+
+      # @param code [String] the IEEE standard Code to look up (e..g "528-2019")
+      # @param year [String] the year the standard was published (optional)
+      # @param opts [Hash] options
+      #
+      # @return [Hash, NilClass] returns { ret: RelatonBib::BibliographicItem }
+      #   if document is found else returns NilClass
+      def get(code, year = nil, _opts = {})
+        warn "[relaton-ieee] (\"#{code}\") fetching..."
+        result = search(code) || (return nil)
+        year ||= code.match(/(?<=-)\d{4}/)&.to_s
+        ret = bib_results_filter(result, year)
+        if ret[:ret]
+          item = ret[:ret].fetch
+          warn "[relaton-ieee] (\"#{code}\") found #{item.docidentifier.first.id}"
+          item
+        else
+          fetch_ref_err(code, year, ret[:years])
+        end
+      end
+
+      private
+
+      # Sort through the results from RelatonIeee, fetching them three at a time,
+      # and return the first result that matches the code,
+      # matches the year (if provided), and which # has a title (amendments do not).
+      # Only expects the first page of results to be populated.
+      # Does not match corrigenda etc (e.g. ISO 3166-1:2006/Cor 1:2007)
+      # If no match, returns any years which caused mismatch, for error reporting
+      #
+      # @param result [RelatonIeee::HitCollection]
+      # @param opts [Hash] options
+      #
+      # @return [Hash]
+      def bib_results_filter(result, year)
+        missed_years = []
+        result.each do |hit|
+          return { ret: hit } if !year
+
+          return { ret: hit } if year.to_i == hit.hit[:year]
+
+          missed_years << hit.hit[:year]
+        end
+        { years: missed_years.uniq }
+      end
+
+      # @param code [Strig]
+      # @param year [String]
+      # @param missed_years [Array<Strig>]
+      def fetch_ref_err(code, year, missed_years)
+        id = year ? "#{code} year #{year}" : code
+        warn "[relaton-ieee] WARNING: no match found online for #{id}. "\
+          "The code must be exactly like it is on the standards website."
+        unless missed_years.empty?
+          warn "[relaton-ieee] (There was no match for #{year}, though there were matches "\
+            "found for #{missed_years.join(', ')}.)"
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/relaton_ieee/processor.rb

@@ -0,0 +1,41 @@
+require "relaton/processor"
+
+module RelatonIeee
+  class Processor < Relaton::Processor
+    attr_reader :idtype
+
+    def initialize
+      @short = :relaton_ieee
+      @prefix = "IEEE"
+      @defaultprefix = %r{^IEEE\s}
+      @idtype = "IEEE"
+    end
+
+    # @param code [String]
+    # @param date [String, NilClass] year
+    # @param opts [Hash]
+    # @return [RelatonIeee::IeeeBibliographicItem]
+    def get(code, date, opts)
+      ::RelatonIeee::IeeeBibliography.get(code, date, opts)
+    end
+
+    # @param xml [String]
+    # @return [RelatonIeee::IeeeBibliographicItem]
+    def from_xml(xml)
+      ::RelatonIeee::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonIeee::IeeeBibliographicItem]
+    def hash_to_bib(hash)
+      item_hash = ::RelatonIeee::HashConverter.hash_to_bib(hash)
+      ::RelatonIeee::IeeeBibliographicItem.new item_hash
+    end
+
+    # Returns hash of XML grammar
+    # @return [String]
+    def grammar_hash
+      @grammar_hash ||= ::RelatonIeee.grammar_hash
+    end
+  end
+end