relaton-ietf 1.16.1 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d38fb8a37a82452b362231a9c9c5b0424c736ed9b736590d89a486fad08b56e3
-  data.tar.gz: 0af04bcb2a9573b6548442a2182a476de630f19ad10c1c6a492a9271fe905251
+  metadata.gz: 4d0245047f274549b9323c06fe9d63a5150a2fe44ea57d0525aaad767d3c38b8
+  data.tar.gz: dfc5d69ee70eec62f5fe6b43791ab9578db892439dfe296574098c58ae6ca304
 SHA512:
-  metadata.gz: 28592296140fadf98b245fd0efdb62bf9e1c808a4487cd18e8025dcc1daf303cc90466ca0bf21b2c433652b4543265f866d0b83246a1764089be80e48dabb4e6
-  data.tar.gz: cae243d8e3af11d86d7de6969442fbbcf5e9c08cdaa0839237ec8a2dd6222da58a57132e3cfa8060daa1385fe0668767aae4223c2b6f0000ba77365ddbfd841f
+  metadata.gz: f119f7ac88ecefa74a6baabd10dd410bcd3ad6cae78fe1fc5afebf562cc325d28097174608dacf9a47cb33e08eea1f034442ff38235dc2b44d6721b197c034ee
+  data.tar.gz: 4b7767b7a07caf39cd7c37db98a03ea426149a5f848389d367ce8230c6afd2b92e2dd6e2272899a5726092a3a50f1c183e5e0e186e33e75f59a43fdf48a6ffab

data/README.adoc

@@ -33,31 +33,42 @@ Or install it yourself as:
 
 == Usage
 
-=== Fetching documents
+=== Configuration
+
+Configuration is optional. The available option is `logger` which is a `Logger` instance. By default, the logger is `Logger.new($stderr)` with `Logger::WARN` level. To change the logger level, use `RelatonIetf.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_ietf'
 => true
 
+RelatonIetf.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Fetching documents
+
+[source,ruby]
+----
 # Fetch RFC document
 item = RelatonIetf::IetfBibliography.get 'IETF RFC 8341'
-[relaton-ietf] ("IETF RFC 8341") fetching...
-[relaton-ietf] ("IETF RFC 8341") found RFC 8341
+[relaton-ietf] (IETF RFC 8341) Fetching from Relaton repository ...
+[relaton-ietf] (IETF RFC 8341) Found: `RFC 8341`
 => #<RelatonIetf::IetfBibliographicItem:0x007fd1875e7f58
 ...
 
 # Fetch Internet-Draft document
 RelatonIetf::IetfBibliography.get 'IETF I-D.draft-abarth-cake-01'
-[relaton-ietf] ("IETF I-D.draft-abarth-cake-01") fetching...
-[relaton-ietf] ("IETF I-D.draft-abarth-cake-01") found draft-abarth-cake-01
+[relaton-ietf] (IETF I-D.draft-abarth-cake-01) Fetching from Relaton repository ...
+[relaton-ietf] (IETF I-D.draft-abarth-cake-01) Found: `draft-abarth-cake-01`
 => #<RelatonIetf::IetfBibliographicItem:0x00007fdd129bbeb8
 ...
 
 # Return nil if a document doesn't exist.
 RelatonIetf::IetfBibliography.get 'IETF 1111'
-[relaton-ietf] ("IETF 1111") fetching...
-[relaton-ietf] ("IETF 1111") not found
+[relaton-ietf] (IETF 1111) Fetching from Relaton repository ...
+[relaton-ietf] (IETF 1111) Not found.
 => nil
 ----
 

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_ietf/document_type.rb

@@ -0,0 +1,16 @@
+module RelatonIetf
+  class DocumentType < RelatonBib::DocumentType
+    DOCTYPES = %w[rfc internet-draft].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_ietf/hash_converter.rb

@@ -1,36 +1,40 @@
 module RelatonIetf
-  class HashConverter < RelatonBib::HashConverter
-    class << self
-      def hash_to_bib(hash)
-        ret = super
-        return unless ret
+  module HashConverter
+    include RelatonBib::HashConverter
+    extend self
+    def hash_to_bib(hash)
+      ret = super
+      return unless ret
 
-        stream_hash_to_bib ret
-        ret
-      end
+      stream_hash_to_bib ret
+      ret
+    end
 
-      #
-      # Ovverides superclass's method
-      #
-      # @param item [Hash]
-      # @retirn [RelatonIetf::IetfBibliographicItem]
-      def bib_item(item)
-        IetfBibliographicItem.new(**item)
-      end
+    #
+    # Ovverides superclass's method
+    #
+    # @param item [Hash]
+    # @retirn [RelatonIetf::IetfBibliographicItem]
+    def bib_item(item)
+      IetfBibliographicItem.new(**item)
+    end
 
-      # @param ret [Hash]
-      def editorialgroup_hash_to_bib(ret)
-        return unless ret[:editorialgroup]
+    # @param ret [Hash]
+    def editorialgroup_hash_to_bib(ret)
+      return unless ret[:editorialgroup]
 
-        technical_committee = RelatonBib.array(ret[:editorialgroup]).map do |wg|
-          Committee.new RelatonBib::WorkGroup.new(**wg)
-        end
-        ret[:editorialgroup] = RelatonBib::EditorialGroup.new technical_committee
+      technical_committee = RelatonBib.array(ret[:editorialgroup]).map do |wg|
+        Committee.new RelatonBib::WorkGroup.new(**wg)
       end
+      ret[:editorialgroup] = RelatonBib::EditorialGroup.new technical_committee
+    end
 
-      def stream_hash_to_bib(ret)
-        ret[:stream] = ret[:ext][:stream] if ret[:ext]&.key? :stream
-      end
+    def stream_hash_to_bib(ret)
+      ret[:stream] = ret[:ext][:stream] if ret[:ext]&.key? :stream
+    end
+
+    def create_doctype(**args)
+      DocumentType.new(**args)
     end
   end
 end

data/lib/relaton_ietf/ietf_bibliographic_item.rb

@@ -1,20 +1,14 @@
 module RelatonIetf
   class IetfBibliographicItem < RelatonBib::BibliographicItem
-    DOCTYPES = %w[rfc internet-draft].freeze
-
     # @return [String, nil]
-    attr_reader :doctype, :stream
+    attr_reader :stream
 
     # @return [Array<String>]
     attr_reader :keyword
 
-    # @param doctype [String]
     # @param keyword [Array<String>]
     # @param stream [String, nil]
     def initialize(**args)
-      if args[:doctype] && !DOCTYPES.include?(args[:doctype])
-        Util.warn "WARNING: invalid doctype `#{args[:doctype]}`"
-      end
       @stream = args.delete(:stream)
       super
     end
@@ -47,7 +41,7 @@ module RelatonIetf
         if opts[:bibdata] && (doctype || editorialgroup || ics&.any? ||
           structuredidentifier&.presence? || stream)
           ext = builder.ext do |b|
-            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_ietf/ietf_bibliography.rb

@@ -18,13 +18,13 @@ module RelatonIetf
       #   reference is required
       # @return [RelatonIetf::IetfBibliographicItem] Relaton of reference
       def get(code, _year = nil, _opts = {})
-        Util.warn "(#{code}) fetching..."
+        Util.warn "(#{code}) Fetching from Relaton repository ..."
         result = search code
         if result
           docid = result.docidentifier.detect(&:primary) || result.docidentifier.first
-          Util.warn "(#{code}) found `#{docid.id}`"
+          Util.warn "(#{code}) Found: `#{docid.id}`"
         else
-          Util.warn "(#{code}) not found"
+          Util.warn "(#{code}) Not found."
         end
         result
       end

data/lib/relaton_ietf/version.rb

@@ -1,3 +1,3 @@
 module RelatonIetf
-  VERSION = "1.16.1".freeze
+  VERSION = "1.17.0".freeze
 end

data/lib/relaton_ietf.rb

@@ -6,6 +6,7 @@ require "relaton_bib"
 require "relaton_ietf/version"
 require "relaton_ietf/config"
 require "relaton_ietf/util"
+require "relaton_ietf/document_type"
 require "relaton_ietf/bibxml_parser"
 require "relaton_ietf/ietf_bibliography"
 require "relaton_ietf/xml_parser"

data/relaton_ietf.gemspec

@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  spec.add_dependency "relaton-bib", "~> 1.16.0"
+  spec.add_dependency "relaton-bib", "~> 1.17.0"
   spec.add_dependency "relaton-index", "~> 0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 1.16.1
+  version: 1.17.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: relaton-bib
@@ -16,14 +16,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
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +73,7 @@ files:
 - lib/relaton_ietf/committee.rb
 - lib/relaton_ietf/config.rb
 - lib/relaton_ietf/data_fetcher.rb
+- lib/relaton_ietf/document_type.rb
 - lib/relaton_ietf/hash_converter.rb
 - lib/relaton_ietf/ietf_bibliographic_item.rb
 - lib/relaton_ietf/ietf_bibliography.rb