relaton-bipm 1.4.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_bipm.rb

@@ -0,0 +1,24 @@
+require "relaton_bib"
+require "relaton_bipm/version"
+require "relaton_bipm/project_team"
+require "relaton_bipm/bibliographic_date"
+require "relaton_bipm/document_relation"
+require "relaton_bipm/comment_periond"
+require "relaton_bipm/document_status"
+require "relaton_bipm/bipm_bibliographic_item"
+require "relaton_bipm/bipm_bibliography"
+require "relaton_bipm/hash_converter"
+require "relaton_bipm/xml_parser"
+
+module RelatonBipm
+  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_bipm/bibliographic_date.rb

@@ -0,0 +1,5 @@
+module RelatonBipm
+  class BibliographicDate < RelatonBib::BibliographicDate
+    TYPES = superclass::TYPES + %w[effective supreseded]
+  end
+end

data/lib/relaton_bipm/bipm_bibliographic_item.rb

@@ -0,0 +1,69 @@
+module RelatonBipm
+  class BipmBibliographicItem < RelatonBib::BibliographicItem
+    include RelatonBib
+
+    TYPES = %w[brochure mise-en-pratique rapport monographie guide
+               meeting-report technical-report working-party-note strategy
+               cipm-mra resolutions].freeze
+
+    STATUSES = %w[draft-proposal draft-development in-force retired].freeze
+
+    # @return [Array<RelatonBipm::BipmProjectTeam>]
+    attr_reader :project_group
+
+    # @return [RelatonIho::CommentPeriod, NilClass]
+    attr_reader :commentperiod
+
+    # @param project_group [Array<RelatonBipm::ProjectTeam>]
+    # @param title [Array<RelatonBib::FormattedString>]
+    # @param date [Array<RelatonBipm::BibliographicDate>]
+    # @param relation [Array<RelatonBipm::DocumentRelation>]
+    # @param docstatus [RelatonBipm::DocumentStatus, nil]
+    # @param commentperiod [RelatonBipm::CommentPeriod, NilClass]
+    def initialize(**args)
+      if args[:docstatus] && !STATUSES.include?(args[:docstatus].status)
+        warn "[relaton-bipm] Warning: invalid docstatus #{args[:docstatus]}. "\
+        "It should be one of: #{STATUSES}"
+      end
+      @project_group = args.delete(:project_group) || []
+      # @status = args.delete :docstatus
+      @commentperiod = args.delete :commentperiod
+      super
+    end
+
+    # @param builder [Nokogiri::XML::Builder]
+    # @param bibdata [TrueClasss, FalseClass, NilClass]
+    def to_xml(builer = nil, **opts) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+      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 }
+            project_group.each { |pg| pg.to_xml b }
+            commentperiod&.to_xml b
+          end
+        end
+      end
+    end
+
+    # @return [Hash]
+    def to_hash
+      hash = super
+      hash["project_group"] = single_element_array project_group
+      hash["commentperiod"] = commentperiod.to_hash if commentperiod
+      hash
+    end
+
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix = "")
+      out = super
+      project_group.each { |p| out += p.to_asciibib prefix, project_group.size }
+      out += commentperiod.to_asciibib prefix if commentperiod
+      out
+    end
+  end
+end

data/lib/relaton_bipm/bipm_bibliography.rb

@@ -0,0 +1,43 @@
+require "net/http"
+
+module RelatonBipm
+  class BipmBibliography
+    ENDPOINT = "https://raw.githubusercontent.com/relaton/relaton-data-bipm/master/data/"
+      .freeze
+
+    class << self
+      # @param text [String]
+      # @return [RelatonBipm::BipmBibliographicItem]
+      def search(text, _year = nil, _opts = {}) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        warn "[relaton-bipm] (\"#{text}\") fetching..."
+        ref = text.sub(/^BIPM\s/, "").downcase # .sub /^([[:alpha:]]+)(\d+)/, '\1-\2'
+        uri = URI("#{ENDPOINT}#{ref}.yaml")
+        resp = Net::HTTP.get_response uri
+        return unless resp.code == "200"
+
+        hash = HashConverter.hash_to_bib YAML.safe_load(resp.body, [Date])
+        item = BipmBibliographicItem.new hash
+        warn "[relaton-bipm] (\"#{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 BIPM standard Code to look up (e..g "BIPM 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 [RelatonBipm::BipmBibliographicItem]
+      def get(ref, year = nil, opts = {})
+        search(ref, year, opts)
+      end
+    end
+  end
+end

data/lib/relaton_bipm/comment_periond.rb

@@ -0,0 +1,41 @@
+module RelatonBipm
+  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
+
+    # @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
+    end
+  end
+end

data/lib/relaton_bipm/document_relation.rb

@@ -0,0 +1,5 @@
+module RelatonBipm
+  class DocumentRelation < RelatonBib::DocumentRelation
+    TYPES = superclass::TYPES + %w[supersedes supersededBy]
+  end
+end

data/lib/relaton_bipm/document_status.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RelatonBipm
+  # Document status.
+  class DocumentStatus
+    # @return [String]
+    attr_reader :status
+
+    # @param status [String]
+    def initialize(status)
+      @status = status
+    end
+
+    # @param [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.status status
+    end
+
+    # @return [String]
+    def to_hash
+      status
+    end
+
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix = "")
+      pref = prefix.empty? ? prefix : prefix + "."
+      "#{pref}docstatus:: #{status}\n"
+    end
+  end
+end

data/lib/relaton_bipm/hash_converter.rb

@@ -0,0 +1,73 @@
+require "yaml"
+
+module RelatonBipm
+  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?
+
+        project_group_hash_to_bib ret
+        commentperiod_hash_to_bib ret
+        ret
+      end
+
+      private
+
+      # @param item_hash [Hash]
+      # @return [RelatonBib::BibliographicItem]
+      def bib_item(item_hash)
+        BipmBibliographicItem.new item_hash
+      end
+
+      # @param ret [Hash]
+      def title_hash_to_bib(ret)
+        ret[:title] &&= array(ret[:title]).map do |t|
+          if t.is_a? Hash
+            RelatonBib::FormattedString.new t
+          else
+            RelatonBib::FormattedString.new content: t
+          end
+        end
+      end
+
+      # @param ret [Hash]
+      def docstatus_hash_to_bib(ret)
+        ret[:docstatus] &&= DocumentStatus.new ret[:docstatus]
+      end
+
+      # @param ret [Hash]
+      def commentperiod_hash_to_bib(ret)
+        ret[:commentperiod] &&= CommentPeriond.new(ret[:commentperiod])
+      end
+
+      # @param ret [Hash]
+      def project_group_hash_to_bib(ret)
+        ret[:project_group] &&= array(ret[:project_group]).map do |pg|
+          wg = RelatonBib::FormattedString.new pg[:workgroup]
+          ProjectTeam.new(committee: pg[:committee], workgroup: wg)
+        end
+      end
+
+      # @param ret [Hash]
+      def dates_hash_to_bib(ret)
+        super
+        ret[:date] &&= ret[:date].map do |d|
+          BibliographicDate.new d
+        end
+      end
+
+      # @param ret [Hash]
+      def relations_hash_to_bib(ret)
+        super
+        ret[:relation] &&= ret[:relation].map do |r|
+          RelatonBipm::DocumentRelation.new r
+        end
+      end
+    end
+  end
+end