relaton-iho 1.2.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_iho.rb

@@ -0,0 +1,22 @@
+require "digest/md5"
+require "relaton_bib"
+require "relaton_iho/version"
+require "relaton_iho/iho_bibliography"
+require "relaton_iho/hash_converter"
+require "relaton_iho/xml_parser"
+require "relaton_iho/editorial_group"
+require "relaton_iho/comment_periond"
+require "relaton_iho/iho_bibliographic_item"
+
+module RelatonIho
+  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_iho/comment_periond.rb

@@ -0,0 +1,31 @@
+module RelatonIho
+  class CommentPeriond
+    # @return [Date]
+    attr_reader :from
+
+    # @return [Date, NilClass]
+    attr_reader :to
+
+    # @param from [String] date
+    # @parma to [String, NilClass] date
+    def initialize(from:, to: nil)
+      @from = Date.parse from
+      @to = Date.parse to if to
+    end
+
+    # @param builder [Nokogiri::XML::builder]
+    def to_xml(builder)
+      builder.commentperiod do
+        builder.from from.to_s
+        builder.to to.to_s if to
+      end
+    end
+
+    # @return [Hash]
+    def to_hash
+      hash = { "from" => from.to_s }
+      hash["to"] = to.to_s if to
+      hash
+    end
+  end
+end

data/lib/relaton_iho/editorial_group.rb

@@ -0,0 +1,59 @@
+module RelatonIho
+  class EditorialGroupCollection
+    extend Forwardable
+    include RelatonBib
+
+    def_delegators :@collection, :first, :any?
+
+    # @return [Array<RelatonIho::editorialgroup]
+    attr_reader :collection
+
+    # @param collection [Array<RelatonIho::EditorialGroup>]
+    def initialize(collection)
+      @collection = collection
+    end
+
+    # @param builder [Nokogiro::XML::Builder]
+    def to_xml(builder)
+      collection.each { |eg| eg.to_xml builder }
+    end
+
+    # @return [Hash]
+    def to_hash
+      single_element_array collection
+    end
+
+    # @return [Boolean]
+    def presence?
+      any?
+    end
+  end
+
+  class EditorialGroup
+    # @return [String]
+    attr_reader :committee, :workgroup
+
+    # @parma committee [String]
+    # @param workgroup [String]
+    def initialize(committee:, workgroup:)
+      unless %[hssc ircc].include? committee
+        warn "[relaton-iho] WARNING: invalid committee: #{committee}"
+      end
+      @committee = committee
+      @workgroup = workgroup
+    end
+
+    # @param builder [Nokogiro::XML::Builder]
+    def to_xml(builder)
+      builder.editorialgroup do
+        builder.committee committee
+        builder.workgroup workgroup
+      end
+    end
+
+    # @return [Hash]
+    def to_hash
+      { "committee" => committee, "workgroup" => workgroup }
+    end
+  end
+end

data/lib/relaton_iho/hash_converter.rb

@@ -0,0 +1,33 @@
+module RelatonIho
+  class HashConverter < RelatonBib::HashConverter
+    class << self
+      # @override RelatonIsoBib::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?
+
+        commentperiod_hash_to_bib ret
+        ret
+      end
+
+      private
+
+      # @param ret [Hash]
+      def commentperiod_hash_to_bib(ret)
+        ret[:commentperiod] &&= CommentPeriond.new(ret[:commentperiod])
+      end
+
+      # @param ret [Hash]
+      def editorialgroup_hash_to_bib(ret)
+        eg = ret[:editorialgroup]
+        return unless eg.is_a?(Hash) || eg&.any?
+
+        collection = array(eg).map { |g| EditorialGroup.new g }
+        ret[:editorialgroup] = EditorialGroupCollection.new collection
+      end
+    end
+  end
+end

data/lib/relaton_iho/hit_collection.rb

@@ -0,0 +1,73 @@
+require "faraday"
+require "yaml"
+require "fileutils"
+
+module RelatonIho
+  class HitCollection < RelatonBib::HitCollection
+    ENDPOINT = "https://raw.githubusercontent.com/relaton/relaton-data-iho/master/data/".freeze
+
+    # @param ref [Strig]
+    # @param year [String]
+    # @param opts [Hash]
+    def initialize(ref, year = nil)
+      super
+      @array = from_yaml(ref).sort_by do |hit|
+        hit.hit["revdate"] ? Date.parse(hit.hit["revdate"]) : Date.new
+      end.reverse
+    end
+
+    private
+
+    #
+    # Fetch data form yaml
+    #
+    # @param docid [String]
+    def from_yaml(docid, **_opts)
+      data["root"]["items"].select do |doc|
+        doc["docid"] && doc["docid"]["id"].include?(docid)
+      end.map { |h| Hit.new(h, self) }
+    end
+
+    #
+    # Fetches YAML data
+    #
+    # @return [Hash]
+    def data
+      FileUtils.mkdir_p DATADIR
+      ctime = File.ctime DATAFILE if File.exist? DATAFILE
+      fetch_data if !ctime || ctime.to_date < Date.today
+      @data ||= YAML.safe_load File.read(DATAFILE, encoding: "UTF-8")
+    end
+
+    #
+    # fetch data form server and save it to file.
+    #
+    def fetch_data
+      resp = Faraday.new(ENDPOINT, headers: { "If-None-Match" => etag }).get
+      # return if there aren't any changes since last fetching
+      return unless resp.status == 200
+
+      self.etag = resp[:etag]
+      @data = YAML.safe_load resp.body
+      File.write DATAFILE, @data.to_yaml, encoding: "UTF-8"
+    end
+
+    #
+    # Read ETag form file
+    #
+    # @return [String, NilClass]
+    def etag
+      @etag ||= if File.exist? ETAGFILE
+                  File.read ETAGFILE, encoding: "UTF-8"
+                end
+    end
+
+    #
+    # Save ETag to file
+    #
+    # @param tag [String]
+    def etag=(e_tag)
+      File.write ETAGFILE, e_tag, encoding: "UTF-8"
+    end
+  end
+end

data/lib/relaton_iho/iho_bibliographic_item.rb

@@ -0,0 +1,40 @@
+module RelatonIho
+  class IhoBibliographicItem < RelatonBib::BibliographicItem
+    TYPES = %w[policy-and-procedures best-practices supporting-document
+               report legal directives proposal standard].freeze
+
+    # @return [RelatonIho::CommentPeriod, NilClass]
+    attr_reader :commentperiod
+
+    # @param editorialgroup [RelatonIho::EditorialGroupCollection]
+    # @param commentperiod [RelatonIho::CommentPeriod, NilClass]
+    def initialize(**args)
+      @commentperiod = args.delete :commentperiod
+      super
+    end
+
+    # @param builder [Nokogiri::XML::Builder]
+    # @param bibdata [TrueClasss, FalseClass, NilClass]
+    def to_xml(builer = nil, **opts)
+      opts[:ext] = !commentperiod.nil?
+      super do |b|
+        if opts[:bibdata] && (doctype || editorialgroup&.presence? ||
+                              ics.any? || commentperiod)
+          b.ext do
+            b.doctype doctype if doctype
+            editorialgroup&.to_xml b
+            ics.each { |i| i.to_xml b }
+            commentperiod&.to_xml b
+          end
+        end
+      end
+    end
+
+    # @return [Hash]
+    def to_hash
+      hash = super
+      hash["commentperiod"] = commentperiod.to_hash if commentperiod
+      hash
+    end
+  end
+end

data/lib/relaton_iho/iho_bibliography.rb

@@ -0,0 +1,41 @@
+module RelatonIho
+  class IhoBibliography
+    ENDPOINT = "https://raw.githubusercontent.com/relaton/relaton-data-iho/"\
+               "master/data/".freeze
+
+    class << self
+      # @param text [String]
+      # @return [RelatonIho::IhoBibliographicItem]
+      def search(text, _year = nil, _opts = {})
+        warn "[relaton-iho] (\"#{text}\") fetching..."
+        ref = text.sub(/^IHO\s/, "").downcase
+        uri = URI("#{ENDPOINT}#{ref}.yaml")
+        resp = Net::HTTP.get_response uri
+        returm unless resp.code == "200"
+
+        hash = HashConverter.hash_to_bib YAML.safe_load(resp.body, [Date])
+        item = IhoBibliographicItem.new hash
+        warn "[relaton-iho] (\"#{text}\") found #{item.docidentifier.first.id}"
+        item
+      rescue SocketError, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+             Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+             Net::ProtocolError, Net::ReadTimeout, OpenSSL::SSL::SSLError,
+             Errno::ETIMEDOUT => e
+        raise RelatonBib::RequestError, "Could not access #{uri}: #{e.message}"
+      end
+
+      # @param ref [String] the IHO standard Code to look up (e..g "IHO B-11")
+      # @param year [String] the year the standard was published (optional)
+      #
+      # @param opts [Hash] options
+      # @option opts [TrueClass, FalseClass] :all_parts restricted to all parts
+      #   if all-parts reference is required
+      # @option opts [TrueClass, FalseClass] :bibdata
+      #
+      # @return [RelatonIho::IhoBibliographicItem]
+      def get(ref, year = nil, opts = {})
+        search(ref, year, opts)
+      end
+    end
+  end
+end