relaton-ietf 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d28ac0d8df8ab932cb60dfe07710ae8e1fdb7907fa532b33d6761d9add3d4c3
-  data.tar.gz: bbafccc58b4d149c343b77beebfe13670ec7aebbeb5aa3433cef029a33e97838
+  metadata.gz: 40f1573f12d0f2dfedd0210b9f3236173a71ffbb9dc9131ca9104364e1756ed2
+  data.tar.gz: 6315493dca67a75115d572a4b1f4768f7d888aa85955ba2c3ef88838084c50c3
 SHA512:
-  metadata.gz: 529415643a3b03eb4460c30b787bbffacf6012882c01d38ea5ad1104aa39c6f8985275ba84cfd4f6a098b636b34dbde830a780c88d05c4c2fb8e443f62439c66
-  data.tar.gz: 557158e95a38be647662be5e8c8eadb87092b066fae81164e30bd2505e35b48ea255062fbed54b436434bb462415d71f5ebf3cf56137e896d459e41469da33b8
+  metadata.gz: 8b26751fe163cc4f6a51111bee04408286532be84cac8bc48cb9ab1c0c6a19a9df83dae36fa705af66bed590c3455cc58b75f4e8a80e760bd2136487243796e1
+  data.tar.gz: a4b13883749c08236f5f2b7fbcaa478895a83b5dab121fc04a33f66c7014e05cc003c188a96ba7c23527aeabf03113a72e14885a2900c6d4d609086ab7bdadd1

data/CLAUDE.md

@@ -60,6 +60,7 @@ Bib::Converter::BibXml::FromRfcxml    # base: handles <reference> generically
 
 ## Testing Patterns
 
+- **Index fixture:** `spec/fixtures/index-v1.zip` is pre-loaded into `Relaton::Index` pool in `before(:suite)` (configured in `spec/support/webmock.rb`). Run `rake spec:update_index` to refresh from relaton-data-rfcs/rfcsubseries/ids.
 - **VCR cassettes** in `spec/vcr_cassettes/` record HTTP interactions; tests use `vcr: "cassette_name"` metadata
 - **WebMock** disables net connections by default
 - **Fixtures** in `spec/fixtures/` — XML/YAML expected outputs; many tests auto-generate fixtures on first run (`File.write file, xml unless File.exist? file`)

data/Gemfile

@@ -8,6 +8,7 @@ gemspec
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
+
 gem "equivalent-xml"
 gem "pry-byebug"
 gem "ruby-jing"

data/README.adoc

@@ -154,6 +154,10 @@ Done in: 1360 sec.
 
 Relaton::Ietf uses the relaton-logger gem for logging. By default, it logs to STDOUT. To change the log levels and add other loggers, read the https://github.com/relaton/relaton-logger#usage[relaton-logger] documentation.
 
+== Development
+
+To update the index test fixtures (used by tests), run `rake spec:update_index`. This downloads the latest index files from the https://github.com/relaton/relaton-data-rfcs[relaton-data-rfcs], https://github.com/relaton/relaton-data-rfcsubseries[relaton-data-rfcsubseries], and https://github.com/relaton/relaton-data-ids[relaton-data-ids] repositories.
+
 == Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/relaton-ietf.

data/Rakefile

@@ -4,3 +4,32 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+namespace :spec do
+  desc "Download latest IETF index fixtures from relaton-data repos"
+  task :update_index do
+    require "net/http"
+    require "uri"
+
+    indexes = {
+      "rfc-index-v1.zip" => "https://raw.githubusercontent.com/relaton/relaton-data-rfcs/data-v2/index-v1.zip",
+      "rss-index-v1.zip" => "https://raw.githubusercontent.com/relaton/relaton-data-rfcsubseries/data-v2/index-v1.zip",
+      "ids-index-v1.zip" => "https://raw.githubusercontent.com/relaton/relaton-data-ids/data-v2/index-v1.zip",
+    }
+
+    indexes.each do |filename, url|
+      dest = File.join(__dir__, "spec", "fixtures", filename)
+
+      puts "Downloading #{url} ..."
+      uri = URI.parse(url)
+      response = Net::HTTP.get_response(uri)
+
+      if response.is_a?(Net::HTTPSuccess)
+        File.binwrite(dest, response.body)
+        puts "Updated #{dest} (#{response.body.bytesize} bytes)"
+      else
+        abort "Failed to download #{filename}: HTTP #{response.code}"
+      end
+    end
+  end
+end

data/grammars/biblio.rng

@@ -2015,15 +2015,11 @@ provided that it is not the entire bibliographic item that is so related</a:docu
     <a:documentation>A version of the bibliographic item (within an edition). Can be used for drafts</a:documentation>
     <element name="version">
       <optional>
-        <ref name="revision-date">
-          <a:documentation>The date at which the current version of the bibliographic item was produced</a:documentation>
-        </ref>
-      </optional>
-      <optional>
-        <ref name="draft">
-          <a:documentation>The identifier for the current draft of the bibliographic item</a:documentation>
-        </ref>
+        <attribute name="type">
+          <a:documentation>Versioning scheme, in case of multiple versioning schemes</a:documentation>
+        </attribute>
       </optional>
+      <text/>
     </element>
   </define>
   <define name="vedition">

data/lib/relaton/ietf/bibdata.rb

@@ -1,6 +1,7 @@
 module Relaton
   module Ietf
     class Bibdata < Item
+      model ItemData
       include Bib::BibdataShared
     end
   end

data/lib/relaton/ietf/bibitem.rb

@@ -1,6 +1,7 @@
 module Relaton
   module Ietf
     class Bibitem < Item
+      model ItemData
       include Bib::BibitemShared
     end
   end

data/lib/relaton/ietf/bibxml_parser.rb

@@ -1,15 +1,6 @@
 module Relaton
   module Ietf
     module BibXMLParser # rubocop:disable Metrics/ModuleLength
-      # Workaround for rfcxml v0.2.1 circular dependency:
-      # Sup inherits Sub before Sub finishes declaring attributes,
-      # leaving Sup.attributes empty. Copy them over.
-      if defined?(Rfcxml::V3::Sup) && Rfcxml::V3::Sup.attributes.empty?
-        Rfcxml::V3::Sub.attributes.each do |name, attr|
-          Rfcxml::V3::Sup.attributes[name] = attr
-        end
-      end
-
       extend self
 
       def parse(xml)

data/lib/relaton/ietf/ext.rb

@@ -3,13 +3,8 @@ require_relative "processing_instructions"
 
 module Relaton
   module Ietf
-    class Ext < Lutaml::Model::Serializable
-      attribute :schema_version, method: :get_schema_version
+    class Ext < Bib::Ext
       attribute :doctype, Doctype
-      attribute :subdoctype, :string
-      attribute :flavor, :string
-      attribute :ics, Bib::ICS, collection: true
-      attribute :structuredidentifier, Bib::StructuredIdentifier, collection: true
       attribute :area, :string, collection: true, values: %W[
         apt gen int ops rtg sec tsv Applications\sand\sReal-Time General
         Internet Operations\sand\sManagement Routing Security Transport
@@ -27,12 +22,6 @@ module Relaton
       attribute :show_on_front_page, :string
 
       xml do
-        map_attribute "schema-version", to: :schema_version
-        map_element "doctype", to: :doctype
-        map_element "subdoctype", to: :subdoctype
-        map_element "flavor", to: :flavor
-        map_element "ics", to: :ics
-        map_element "structuredidentifier", to: :structuredidentifier
         map_element "area", to: :area
         map_element "stream", to: :stream
         map_element "ipr", to: :ipr
@@ -47,9 +36,28 @@ module Relaton
         map_element "showOnFrontPage", to: :show_on_front_page
       end
 
-      def get_schema_version
-        Relaton.schema_versions["relaton-model-ietf"]
+      key_value do
+        map_element "schema_version", to: :schema_version, render_default: true
+        map_element "doctype", to: :doctype
+        map_element "subdoctype", to: :subdoctype
+        map_element "flavor", to: :flavor
+        map_element "ics", to: :ics
+        map_element "structuredidentifier", to: :structuredidentifier
+        map_element "area", to: :area
+        map_element "stream", to: :stream
+        map_element "ipr", to: :ipr
+        map_element "pi", to: :pi
+        map_element "consensus", to: :consensus
+        map_element "index_include", to: :index_include
+        map_element "ipr_extract", to: :ipr_extract
+        map_element "sort_refs", to: :sort_refs
+        map_element "sym_refs", to: :sym_refs
+        map_element "toc_include", to: :toc_include
+        map_element "toc_depth", to: :toc_depth
+        map_element "show_on_front_page", to: :show_on_front_page
       end
+
+      def get_schema_version = Relaton.schema_versions["relaton-model-ietf"]
     end
   end
 end

data/lib/relaton/ietf/item.rb

@@ -9,3 +9,8 @@ module Relaton
     end
   end
 end
+
+require_relative "relation"
+
+Relaton::Ietf::Item.attribute :relation, Relaton::Ietf::Relation,
+                              collection: true, initialize_empty: true

data/lib/relaton/ietf/item_base.rb

@@ -1,9 +1,18 @@
-require_relative "ext"
-
 module Relaton
   module Ietf
-    class ItemBase < Item
-      include Bib::ItemBaseAttributes
+    class ItemBase < Lutaml::Model::Serializable
+      include Bib::NamespaceHelper
+
+      attr_accessor :type
+
+      model ItemData
+
+      instance_exec(&Bib::ItemShared::ATTRIBUTES)
+
+      xml do
+        map_attribute "type", to: :type
+        instance_exec(&Bib::ItemShared::XML_BODY)
+      end
     end
   end
 end

data/lib/relaton/ietf/relation.rb

@@ -0,0 +1,9 @@
+require_relative "item_base"
+
+module Relaton
+  module Ietf
+    class Relation < Bib::Relation
+      attribute :bibitem, ItemBase
+    end
+  end
+end

data/lib/relaton/ietf/rfc/abstract.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "rfc_index_namespace"
+
 module Relaton
   module Ietf
     module Rfc
@@ -8,7 +10,7 @@ module Relaton
 
         xml do
           root "abstract"
-          namespace "https://www.rfc-editor.org/rfc-index"
+          namespace RfcIndexNamespace
           map_element "p", to: :p
         end
       end

data/lib/relaton/ietf/rfc/author.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "rfc_index_namespace"
+
 module Relaton
   module Ietf
     module Rfc
@@ -9,7 +11,7 @@ module Relaton
 
         xml do
           root "author"
-          namespace "https://www.rfc-editor.org/rfc-index"
+          namespace RfcIndexNamespace
           map_element "name", to: :name
           map_element "title", to: :role_title
         end

data/lib/relaton/ietf/rfc/entry.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "rfc_index_namespace"
 require_relative "is_also"
 require_relative "author"
 require_relative "entry_date"
@@ -13,8 +14,6 @@ module Relaton
     module Rfc
       # Model for index entries (bcp-entry, fyi-entry, std-entry, rfc-entry)
       class Entry < Lutaml::Model::Serializable # rubocop:disable Metrics/ClassLength
-        NAMESPACE = "https://www.rfc-editor.org/rfc-index"
-
         TITLE_PREFIXES = {
           "bcp" => "Best Current Practice",
           "fyi" => "For Your Information",
@@ -47,7 +46,7 @@ module Relaton
 
         xml do
           root "bcp-entry"
-          namespace NAMESPACE
+          namespace RfcIndexNamespace
 
           map_element "doc-id", to: :doc_id
           map_element "title", to: :title

data/lib/relaton/ietf/rfc/entry_date.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "rfc_index_namespace"
+
 module Relaton
   module Ietf
     module Rfc
@@ -9,7 +11,7 @@ module Relaton
 
         xml do
           root "date"
-          namespace "https://www.rfc-editor.org/rfc-index"
+          namespace RfcIndexNamespace
           map_element "month", to: :month
           map_element "year", to: :year
         end

data/lib/relaton/ietf/rfc/format.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "rfc_index_namespace"
+
 module Relaton
   module Ietf
     module Rfc
@@ -8,7 +10,7 @@ module Relaton
 
         xml do
           root "format"
-          namespace "https://www.rfc-editor.org/rfc-index"
+          namespace RfcIndexNamespace
           map_element "file-format", to: :file_format
         end
       end

data/lib/relaton/ietf/rfc/index.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "rfc_index_namespace"
 require_relative "entry"
 
 module Relaton
@@ -7,8 +8,6 @@ module Relaton
     module Rfc
       # Model for the root <rfc-index> element
       class Index < Lutaml::Model::Serializable
-        NAMESPACE = "https://www.rfc-editor.org/rfc-index"
-
         attribute :bcp_entries, Entry, collection: true
         attribute :fyi_entries, Entry, collection: true
         attribute :std_entries, Entry, collection: true
@@ -16,7 +15,7 @@ module Relaton
 
         xml do
           root "rfc-index"
-          namespace NAMESPACE
+          namespace RfcIndexNamespace
 
           map_element "bcp-entry", to: :bcp_entries
           map_element "fyi-entry", to: :fyi_entries

data/lib/relaton/ietf/rfc/is_also.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "rfc_index_namespace"
+
 module Relaton
   module Ietf
     module Rfc
@@ -9,7 +11,7 @@ module Relaton
 
         xml do
           root "is-also"
-          namespace "https://www.rfc-editor.org/rfc-index"
+          namespace RfcIndexNamespace
 
           map_element "doc-id", to: :doc_id
         end

data/lib/relaton/ietf/rfc/keywords.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "rfc_index_namespace"
+
 module Relaton
   module Ietf
     module Rfc
@@ -8,7 +10,7 @@ module Relaton
 
         xml do
           root "keywords"
-          namespace "https://www.rfc-editor.org/rfc-index"
+          namespace RfcIndexNamespace
           map_element "kw", to: :kw
         end
       end

data/lib/relaton/ietf/rfc/rfc_index_namespace.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Ietf
+    module Rfc
+      class RfcIndexNamespace < Lutaml::Xml::W3c::XmlNamespace
+        uri "https://www.rfc-editor.org/rfc-index"
+      end
+    end
+  end
+end

data/lib/relaton/ietf/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Ietf
-    VERSION = "2.0.0".freeze
+    VERSION = "2.1.0".freeze
   end
 end

data/lib/relaton/ietf.rb

@@ -7,7 +7,6 @@ require_relative "ietf/version"
 require_relative "ietf/util"
 require_relative "ietf/item_data"
 require_relative "ietf/item"
-require_relative "ietf/item_base"
 require_relative "ietf/bibitem"
 require_relative "ietf/bibdata"
 require_relative "ietf/rfc/index"

data/{relaton_ietf.gemspec → relaton-ietf.gemspec}

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 3.2.0")
 
   spec.add_dependency "base64"
-  spec.add_dependency "relaton-bib", "~> 2.0.0"
+  spec.add_dependency "relaton-bib", "~> 2.1.0"
   spec.add_dependency "relaton-core", "~> 0.0.13"
   spec.add_dependency "relaton-index", "~> 0.2.3"
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ribose Inc.
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -29,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: relaton-core
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +109,7 @@ files:
 - lib/relaton/ietf/item_data.rb
 - lib/relaton/ietf/processing_instructions.rb
 - lib/relaton/ietf/processor.rb
+- lib/relaton/ietf/relation.rb
 - lib/relaton/ietf/rfc/abstract.rb
 - lib/relaton/ietf/rfc/author.rb
 - lib/relaton/ietf/rfc/entry.rb
@@ -116,15 +118,17 @@ files:
 - lib/relaton/ietf/rfc/index.rb
 - lib/relaton/ietf/rfc/is_also.rb
 - lib/relaton/ietf/rfc/keywords.rb
+- lib/relaton/ietf/rfc/rfc_index_namespace.rb
 - lib/relaton/ietf/scraper.rb
 - lib/relaton/ietf/util.rb
 - lib/relaton/ietf/version.rb
 - lib/relaton/ietf/wg_name_resolver.rb
-- relaton_ietf.gemspec
+- relaton-ietf.gemspec
 homepage: https://github.com/metanorma/relaton-ietf
 licenses:
 - BSD-2-Clause
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,7 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: 'Relaton::Ietf: retrieve IETF Standards for bibliographic use using the BibliographicItem
   model'