relaton-ogc 1.16.2 → 1.17.0

data/grammars/basicdoc.rng

@@ -346,6 +346,8 @@
           <ref name="keyword"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </oneOrMore>
     </element>
@@ -623,6 +625,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -636,6 +640,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -648,6 +654,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -655,7 +663,11 @@
   <define name="keyword">
     <element name="keyword">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -676,7 +688,11 @@
   <define name="strike">
     <element name="strike">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>

data/grammars/biblio.rng

@@ -942,6 +942,7 @@
       <value>obsoleted</value>
       <value>confirmed</value>
       <value>updated</value>
+      <value>corrected</value>
       <value>issued</value>
       <value>transmitted</value>
       <value>copied</value>

data/lib/relaton_ogc/document_type.rb

@@ -0,0 +1,22 @@
+module RelatonOgc
+  class DocumentType < RelatonBib::DocumentType
+    DOCTYPES = %w[
+      abstract-specification-topic best-practice
+      change-request-supporting-document
+      community-practice community-standard discussion-paper engineering-report
+      other policy reference-model release-notes standard user-guide white-paper
+      test-suite draft-standard
+    ].freeze
+
+    def initialize(type:, abbreviation: nil)
+      check_type type
+      super
+    end
+
+    def check_type(type)
+      unless DOCTYPES.include? type
+        Util.warn "WARNING: invalid doctype: `#{type}`"
+      end
+    end
+  end
+end

data/lib/relaton_ogc/hash_converter.rb

@@ -1,20 +1,25 @@
 module RelatonOgc
-  class HashConverter < RelatonBib::HashConverter
-    class << self
-      private
+  module HashConverter
+    include RelatonBib::HashConverter
+    extend self
 
-      # @param ret [Hash]
-      def editorialgroup_hash_to_bib(ret)
-        eg = ret[:editorialgroup]
-        return unless eg
+    private
 
-        ret[:editorialgroup] = EditorialGroup.new(
-          committee: eg[:committee],
-          subcommittee: eg[:subcommittee],
-          workgroup: eg[:workgroup],
-          secretariat: eg[:secretariat],
-        )
-      end
+    # @param ret [Hash]
+    def editorialgroup_hash_to_bib(ret)
+      eg = ret[:editorialgroup]
+      return unless eg
+
+      ret[:editorialgroup] = EditorialGroup.new(
+        committee: eg[:committee],
+        subcommittee: eg[:subcommittee],
+        workgroup: eg[:workgroup],
+        secretariat: eg[:secretariat],
+      )
+    end
+
+    def create_doctype(**args)
+      DocumentType.new(**args)
     end
   end
 end

data/lib/relaton_ogc/ogc_bibliographic_item.rb

@@ -1,13 +1,5 @@
 module RelatonOgc
   class OgcBibliographicItem < RelatonBib::BibliographicItem
-    TYPES = %w[
-      abstract-specification-topic best-practice
-      change-request-supporting-document
-      community-practice community-standard discussion-paper engineering-report
-      other policy reference-model release-notes standard user-guide white-paper
-      test-suite
-    ].freeze
-
     SUBTYPES = %w[
       conceptual-model conceptual-model-and-encoding
       conceptual-model-and-implementation encoding extension implementation
@@ -16,8 +8,7 @@ module RelatonOgc
 
     def initialize(**args)
       if args[:subdoctype] && !SUBTYPES.include?(args[:subdoctype])
-        warn "[relaton-ogc] WARNING: invalid document "\
-             "subtype: #{args[:subdoctype]}"
+        Util.warn "WARNING: Invalid document subtype: `#{args[:subdoctype]}`"
       end
 
       # @docsubtype = args.delete :docsubtype
@@ -57,7 +48,7 @@ module RelatonOgc
     def to_xml(**opts) # rubocop:disable Metrics/AbcSize
       super(**opts) do |b|
         ext = b.ext do
-          b.doctype doctype if doctype
+          doctype&.to_xml b
           b.subdoctype subdoctype if subdoctype
           editorialgroup&.to_xml b
           ics.each { |i| i.to_xml b }

data/lib/relaton_ogc/ogc_bibliography.rb

@@ -20,10 +20,11 @@ module RelatonOgc
       #
       # @return [String] Relaton XML serialisation of reference
       def get(code, year = nil, opts = {})
+        # id = year ? "`#{code}` year `#{year}`" : "#`{code}`"
         result = bib_search_filter(code, year, opts) || (return nil)
         ret = bib_results_filter(result, year)
         if ret[:ret]
-          Util.warn "(#{code}) found `#{ret[:ret].docidentifier.first.id}`"
+          Util.warn "(#{code}) Found: `#{ret[:ret].docidentifier.first.id}`"
           ret[:ret]
         else
           fetch_ref_err(code, year, ret[:years])
@@ -33,7 +34,7 @@ module RelatonOgc
       private
 
       def bib_search_filter(code, year, opts)
-        Util.warn "(#{code}) fetching..."
+        Util.warn "(#{code}) Fetching from Relaton repository ..."
         search(code, year, opts)
       end
 
@@ -67,9 +68,7 @@ module RelatonOgc
       # @param year [String]
       # @param missed_years [Array<Strig>]
       def fetch_ref_err(code, year, missed_years)
-        id = year ? "`#{code}` year `#{year}`" : "#`{code}`"
-        Util.warn "WARNING: no match found online for #{id}. " \
-                  "The code must be exactly like it is on the standards website."
+        Util.warn "(#{code}) Not found."
         unless missed_years.empty?
           Util.warn "There was no match for `#{year}`, though there " \
                     "were matches found for `#{missed_years.join('`, `')}`."

data/lib/relaton_ogc/scrapper.rb

@@ -41,7 +41,7 @@ module RelatonOgc
           title: fetch_title(hit["title"]),
           docid: fetch_docid(hit["identifier"]),
           link: fetch_link(hit["URL"]),
-          doctype: type[:type],
+          doctype: fetch_doctype(type[:type]),
           subdoctype: type[:subtype],
           docstatus: fetch_status(type[:stage]),
           edition: fetch_edition(hit["identifier"]),
@@ -75,9 +75,14 @@ module RelatonOgc
       # @param url [String]
       # @return [Array>RelatonBib::TypedUri>]
       def fetch_link(url)
+        # type = url.end_with?("pdf") ? "pdf" : "src"
         [RelatonBib::TypedUri.new(type: "obp", content: url)]
       end
 
+      def fetch_doctype(type)
+        DocumentType.new(type: type)
+      end
+
       # @param type [String]
       # @return [String]
       def fetch_type(type)

data/lib/relaton_ogc/version.rb

@@ -1,3 +1,3 @@
 module RelatonOgc
-  VERSION = "1.16.2".freeze
+  VERSION = "1.17.0".freeze
 end

data/lib/relaton_ogc.rb

@@ -3,6 +3,7 @@ require "relaton_iso_bib"
 require "relaton_ogc/version"
 require "relaton_ogc/config"
 require "relaton_ogc/util"
+require "relaton_ogc/document_type"
 require "relaton_ogc/ogc_bibliographic_item"
 require "relaton_ogc/ogc_bibliography"
 require "relaton_ogc/data_fetcher"

data/relaton_ogc.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday", "~> 2.7.0"
   spec.add_dependency "relaton-index", "~> 0.2.0"
-  spec.add_dependency "relaton-iso-bib", "~> 1.16.0"
+  spec.add_dependency "relaton-iso-bib", "~> 1.17.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ogc
 version: !ruby/object:Gem::Version
-  version: 1.16.2
+  version: 1.17.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-22 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
 description: 'RelatonOgc: retrieve OGC Standards for bibliographic use using the OgcBibliographicItem
   model'
 email:
@@ -72,6 +72,7 @@ files:
 - bin/console
 - bin/rspec
 - bin/setup
+- docs.json
 - grammars/basicdoc.rng
 - grammars/biblio-standoc.rng
 - grammars/biblio.rng
@@ -80,6 +81,7 @@ files:
 - lib/relaton_ogc.rb
 - lib/relaton_ogc/config.rb
 - lib/relaton_ogc/data_fetcher.rb
+- lib/relaton_ogc/document_type.rb
 - lib/relaton_ogc/editorial_group.rb
 - lib/relaton_ogc/hash_converter.rb
 - lib/relaton_ogc/hit.rb