relaton-ietf 1.14.4 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dd0e3485bf64d666190d66b48f5ade9d4e23ede1537ccf01f388b09fbec2a42
-  data.tar.gz: 01c1334f4730bbb0d636b15ebead6e28d54b524cb834c1d12d6d1453c66e7e3e
+  metadata.gz: d6e85cde14717a5171d911a03dd3f069ab295314a9750a4795ee4a40694ad525
+  data.tar.gz: d5e62680f2a47c54131c8f9a14bcf03eacd00c86377d99f8a4f126e295afc03c
 SHA512:
-  metadata.gz: 933282984bd0231477efa96ec6711bcd732b8978942f441239ec005e202c9e0aeb85cfc26da480cda68796ae42b31d8e7aba2899f0583a448dfb0833f02cc1d3
-  data.tar.gz: 75475472dcd00bf9821daadd236313648f6a38573d6fed82afd1bd39c4dcaac70439f978f0f864b924a9a0226ab71ed26da09e419c16b60a65709707b7e5e2c1
+  metadata.gz: af082b142044e88a11d1580c8f1dc2cc8a21a3cabd26a166622513125bcee6f5acd9212233dfabcf21a4a5bb0194ad27274a06577ce76f2e1afc2623d94d6a74
+  data.tar.gz: 608c4bcfb0cee144a867b8cdfc04ceda41554b73a744d43cb1d10e48d4ddca691ba756a62be457dbea0aea77e22d1e162ebc9d3db22349742b6f683584771b12

data/.github/workflows/release.yml

@@ -7,7 +7,8 @@ on:
     inputs:
       next_version:
         description: |
-          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
         required: true
         default: 'skip'
   repository_dispatch:

data/Gemfile

@@ -5,6 +5,10 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in relaton_ietf.gemspec
 gemspec
 
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+
+gem "equivalent-xml"
 gem "pry-byebug"
 gem "ruby-jing"
 gem "simplecov"

data/README.adoc

@@ -85,7 +85,7 @@ item.to_xml bibdata: true
       <docidentifier type="IETF" primary="true">RFC 8341</docidentifier>
       <docidentifier type="DOI">10.17487/RFC8341</docidentifier>
       ...
-      <ext schema-version="v1.0.0">
+      <ext schema-version="v1.0.1">
         <editorialgroup>
           <committee>netconf</committee>
         </editorialgroup>

data/grammars/biblio.rng

@@ -1283,7 +1283,7 @@
       <value>mergedInto</value>
       <value>splits</value>
       <value>splitInto</value>
-      <value>instance</value>
+      <value>instanceOf</value>
       <value>hasInstance</value>
       <value>exemplarOf</value>
       <value>hasExemplar</value>

data/grammars/relaton-ietf.rng

@@ -26,6 +26,9 @@
       <zeroOrMore>
         <ref name="area"/>
       </zeroOrMore>
+      <optional>
+        <ref name="stream"/>
+      </optional>
       <optional>
         <ref name="ipr"/>
       </optional>
@@ -315,4 +318,16 @@
       </optional>
     </element>
   </define>
+  <define name="stream">
+    <element name="stream">
+      <choice>
+        <value>IAB</value>
+        <value>IETF</value>
+        <value>Independent</value>
+        <value>IRTF</value>
+        <value>Legacy</value>
+        <value>Editorial</value>
+      </choice>
+    </element>
+  </define>
 </grammar>

data/lib/relaton_ietf/hash_converter.rb

@@ -1,6 +1,14 @@
 module RelatonIetf
   class HashConverter < RelatonBib::HashConverter
     class << self
+      def hash_to_bib(hash)
+        ret = super
+        return unless ret
+
+        stream_hash_to_bib ret
+        ret
+      end
+
       #
       # Ovverides superclass's method
       #
@@ -19,6 +27,10 @@ module RelatonIetf
         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
     end
   end
 end

data/lib/relaton_ietf/ietf_bibliographic_item.rb

@@ -2,18 +2,20 @@ module RelatonIetf
   class IetfBibliographicItem < RelatonBib::BibliographicItem
     DOCTYPES = %w[rfc internet-draft].freeze
 
-    # @return [String, NilClass]
-    attr_reader :doctype
+    # @return [String, nil]
+    attr_reader :doctype, :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])
         warn "[relaton-ietf] WARNING: invalid doctype #{args[:doctype]}"
       end
+      @stream = args.delete(:stream)
       super
     end
 
@@ -36,12 +38,39 @@ module RelatonIetf
     # @param opts [Hash]
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [Boolean] :bibdata
-    # @option opts [Symbol, NilClass] :date_format (:short), :full
+    # @option opts [Symbol, nil] :date_format (:short), :full
     # @option opts [String, Symbol] :lang language
     # @return [String] XML
-    def to_xml(**opts)
+    def to_xml(**opts) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
       opts[:date_format] ||= :short
-      super(**opts)
+      super(**opts) do |builder|
+        if opts[:bibdata] && (doctype || editorialgroup || ics&.any? ||
+          structuredidentifier&.presence? || stream)
+          ext = builder.ext do |b|
+            b.doctype doctype if doctype
+            b.subdoctype subdoctype if subdoctype
+            editorialgroup&.to_xml b
+            ics.each { |i| i.to_xml b }
+            b.stream stream if stream
+            structuredidentifier&.to_xml b
+          end
+          ext["schema-version"] = ext_schema if !opts[:embedded] && respond_to?(:ext_schema)
+        end
+      end
+    end
+
+    #
+    # Render hash
+    #
+    # @return [Hash] docunent hash representation
+    #
+    def to_hash(embedded: false)
+      hash = super
+      return hash unless stream
+
+      hash["ext"] ||= {}
+      hash["ext"]["stream"] = stream
+      hash
     end
 
     #

data/lib/relaton_ietf/rfc_entry.rb

@@ -41,6 +41,7 @@ module RelatonIetf
         relation: parse_relation,
         status: parse_status,
         series: parse_series,
+        stream: @doc.at("./xmlns:stream")&.text,
         editorialgroup: parse_editorialgroup,
       )
     end
@@ -52,7 +53,7 @@ module RelatonIetf
     #
     def parse_series
       title = RelatonBib::TypedTitleString.new(content: "RFC")
-      series_is_also + seires_stream + [RelatonBib::Series.new(title: title, number: docnum)]
+      series_is_also + [RelatonBib::Series.new(title: title, number: docnum)] + seires_stream
     end
 
     def series_is_also
@@ -134,7 +135,7 @@ module RelatonIetf
     #
     # Create link
     #
-    # @return [Array<RelatonBib::TypedUri>] 
+    # @return [Array<RelatonBib::TypedUri>]
     #
     def parse_link
       url = "https://www.rfc-editor.org/info/rfc#{docnum}"

data/lib/relaton_ietf/rfc_index_entry.rb

@@ -10,7 +10,7 @@ module RelatonIetf
     def initialize(doc, doc_id, is_also)
       @doc = doc
       @name = doc.name.split("-").first
-      @shortnum = doc_id[-4..-1].sub(/^0+/, "")
+      @shortnum = doc_id[-4..].sub(/^0+/, "")
       @doc_id = doc_id
       @is_also = is_also
     end
@@ -47,6 +47,7 @@ module RelatonIetf
         formattedref: formattedref,
         relation: parse_relation,
         series: parse_series,
+        stream: @doc.at("./xmlns:stream")&.text,
       )
     end
 

data/lib/relaton_ietf/version.rb

@@ -1,3 +1,3 @@
 module RelatonIetf
-  VERSION = "1.14.4".freeze
+  VERSION = "1.16.0".freeze
 end

data/lib/relaton_ietf/xml_parser.rb

@@ -5,6 +5,12 @@ module RelatonIetf
     class << self
       private
 
+      def item_data(doc)
+        data = super
+        data[:stream] = doc.at("ext/stream")&.text
+        data
+      end
+
       # override RelatonBib::BibliographicItem.bib_item method
       # @param item_hash [Hash]
       # @return [RelatonIetf::IetfBibliographicItem]

data/relaton_ietf.gemspec

@@ -29,10 +29,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-
-  spec.add_dependency "relaton-bib", "~> 1.14.0"
-  spec.add_dependency "relaton-index", "~> 0.2.0"
+  spec.add_dependency "relaton-bib", "~> 1.16.0"
+  spec.add_dependency "relaton-index", "~> 0.2.3"
 end

metadata

@@ -1,85 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 1.14.4
+  version: 1.16.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-22 00:00:00.000000000 Z
+date: 2023-09-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: equivalent-xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.3
 description: |
   RelatonIetf: retrieve IETF Standards for bibliographic use
   using the BibliographicItem model.