sts 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4c33b0d9e555f39d6325c27b46bc0557bd21699c1c050f1f5aa7eaa322082df
-  data.tar.gz: 4427f44d8745804697c0d2a9a4f78f08c0552caa69079b88b50834a8645490bd
+  metadata.gz: d455b48722cdfb0fffba31a558bdb9a05780be424faf35ce94f7a67392d7b79f
+  data.tar.gz: 781388c40c4493ce7d0c8c1762f346fd231d42a7f9c8742721365d42561b2eaa
 SHA512:
-  metadata.gz: c450defe1889541f576c21ba203d09b872722583ef1f9843f5b9afea44d9b970ccd8a0deb99627c6f186643d188c1e77379dc62f6b634a3096d7c199a4e56c4d
-  data.tar.gz: 152d2ec43794d41885c5f8172f29b6cebf6039384808555c8b157349b1337df9e4e0b4c2a18a472dbab04d3dd8fe7fcdbfe81cd4f4981932765784f7f5232fab
+  metadata.gz: 71faa9669cef2e0f5d5f6143996e3654393edd8afd555d1bb1ae599a10a7bff58a21b31eb69d615e6bbb25de105747c430d20023f41016e11d4bf24bf7728d98
+  data.tar.gz: 82c5b2715f2d46894fde9bf9ef8a8b904df869d5cdf220ecca5ff094d3e4cdee93295f1f0416caaa66efd94b43051b60900c1748f6170ea0f23fbdd4624ceda9

data/.github/workflows/release.yml

@@ -2,12 +2,18 @@
 # See https://github.com/metanorma/cimas
 name: release
 
+permissions:
+  contents: write
+  packages: write
+  id-token: write
+
 on:
   workflow_dispatch:
     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/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-03-19 17:00:15 UTC using RuboCop version 1.74.0.
+# on 2026-04-01 11:46:24 UTC using RuboCop version 1.86.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -8,35 +8,17 @@
 
 # Offense count: 6
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
-# SupportedHashRocketStyles: key, separator, table
-# SupportedColonStyles: key, separator, table
-# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/HashAlignment:
-  Exclude:
-    - 'lib/sts/niso_sts/metadata_iso.rb'
-    - 'lib/sts/niso_sts/metadata_std.rb'
-    - 'lib/sts/niso_sts/standard_identification.rb'
-    - 'lib/sts/tbx_iso_tml/mfenced.rb'
-
-# Offense count: 7
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
   Exclude:
-    - 'lib/sts/niso_sts/metadata_iso.rb'
-    - 'lib/sts/niso_sts/metadata_std.rb'
-    - 'lib/sts/niso_sts/standard_identification.rb'
-    - 'lib/sts/tbx_iso_tml/mfenced.rb'
+    - 'lib/sts/niso_sts/term.rb'
+    - 'lib/sts/tbx_iso_tml/lang_set.rb'
     - 'lib/sts/tbx_iso_tml/term_type.rb'
+    - 'spec/spec_helper.rb'
 
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
-  Exclude:
-    - 'lib/sts/niso_sts/metadata_iso.rb'
-    - 'lib/sts/niso_sts/metadata_std.rb'
-    - 'lib/sts/niso_sts/standard_identification.rb'
-    - 'lib/sts/tbx_iso_tml/mfenced.rb'
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 27

data/Gemfile

@@ -5,10 +5,12 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in sts.gemspec
 gemspec
 
-gem "equivalent-xml"
+gem "canon"
+gem "lutaml-model", github: "lutaml/lutaml-model", branch: "main"
 gem "pry"
 gem "rake"
 gem "rspec"
 gem "rubocop"
 gem "rubocop-performance"
-gem "xml-c14n"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/lib/sts/namespaces.rb

@@ -0,0 +1,13 @@
+module Sts
+  module Namespaces
+    class MathmlNamespace < Lutaml::Xml::Namespace
+      uri "http://www.w3.org/1998/Math/MathML"
+      prefix_default "mml"
+    end
+
+    class TbxNamespace < Lutaml::Xml::Namespace
+      uri "urn:iso:std:iso:30042:ed-1"
+      prefix_default "tbx"
+    end
+  end
+end

data/lib/sts/niso_sts/adoption.rb

@@ -1,25 +1,21 @@
 # frozen_string_literal: true
 
-require_relative "standard"
-require_relative "adoption_front"
-
 module Sts
   module NisoSts
     class Adoption < Lutaml::Model::Serializable
-      attribute :front, AdoptionFront
-      attribute :back, Back
+      attribute :front, ::Sts::NisoSts::AdoptionFront
+      attribute :back, ::Sts::NisoSts::Back
       attribute :id, :string
-      attribute :lang, :string
-      attribute :adoptions, Adoption, collection: true
-      attribute :standard, Standard
+      attribute :lang, Lutaml::Xml::W3c::XmlLangType
+      attribute :adoptions, ::Sts::NisoSts::Adoption, collection: true
+      attribute :standard, ::Sts::NisoSts::Standard
 
       xml do
-        root "adoption", mixed: true
+        element "adoption"
+        mixed_content
 
         map_attribute "id", to: :id
-        map_attribute "lang", to: :lang,
-                              namespace: "http://www.w3.org/XML/1998/namespace",
-                              prefix: "xml"
+        map_attribute "lang", to: :lang
         map_element "adoption-front", to: :front
         map_element "back", to: :back
         map_element "adoption", to: :adoptions

data/lib/sts/niso_sts/adoption_front.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "front"
-
 module Sts
   module NisoSts
     class AdoptionFront < Front
       xml do
-        root "adoption-front"
+        element "adoption-front"
         map_element "iso-meta", to: :iso_meta
         map_element "std-meta", to: :std_meta
         map_element "sec", to: :sec

data/lib/sts/niso_sts/app.rb

@@ -1,35 +1,24 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "section"
-require_relative "title"
-require_relative "paragraph"
-require_relative "non_normative_note"
-require_relative "figure"
-require_relative "reference_list"
-require_relative "../tbx_iso_tml/table_wrap"
-
 module Sts
   module NisoSts
-    class Title < Lutaml::Model::Serializable; end
-    class ReferenceList < Lutaml::Model::Serializable; end
-
     class App < Lutaml::Model::Serializable
       attribute :id, :string
       attribute :content_type, :string
-      attribute :label, Label
+      attribute :label, ::Sts::NisoSts::Label
       attribute :annex_type, :string
-      attribute :title, Title
-      attribute :fig, Figure, collection: true
-      attribute :sec, Section, collection: true
-      attribute :paragraph, Paragraph, collection: true
-      attribute :ref_list, ReferenceList, collection: true
-      attribute :non_normative_note, NonNormativeNote, collection: true
-      attribute :table_wrap, Sts::TbxIsoTml::TableWrap, collection: true
+      attribute :title, ::Sts::NisoSts::Title
+      attribute :fig, ::Sts::NisoSts::Figure, collection: true
+      attribute :sec, ::Sts::NisoSts::Section, collection: true
+      attribute :paragraph, ::Sts::NisoSts::Paragraph, collection: true
+      attribute :ref_list, ::Sts::NisoSts::ReferenceList, collection: true
+      attribute :non_normative_note, ::Sts::NisoSts::NonNormativeNote,
+                collection: true
+      attribute :table_wrap, ::Sts::TbxIsoTml::TableWrap, collection: true
 
       xml do
-        root "app", mixed: true
+        element "app"
+        mixed_content
 
         map_attribute "id", to: :id
         map_attribute "content-type", to: :content_type

data/lib/sts/niso_sts/app_group.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "app"
-
 module Sts
   module NisoSts
     class AppGroup < Lutaml::Model::Serializable
       attribute :app, Sts::NisoSts::App, collection: true
 
       xml do
-        root "app-group"
+        element "app-group"
 
         map_element "app", to: :app
       end

data/lib/sts/niso_sts/back.rb

@@ -1,22 +1,15 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "reference_list"
-require_relative "section"
-require_relative "app_group"
-require_relative "fn_group"
-
 module Sts
   module NisoSts
     class Back < Lutaml::Model::Serializable
-      attribute :ref_list, ReferenceList
-      attribute :app_group, AppGroup
-      attribute :sec, Section
-      attribute :fn_group, FnGroup
+      attribute :ref_list, ::Sts::NisoSts::ReferenceList
+      attribute :app_group, ::Sts::NisoSts::AppGroup
+      attribute :sec, ::Sts::NisoSts::Section
+      attribute :fn_group, ::Sts::NisoSts::FnGroup
 
       xml do
-        root "back"
+        element "back"
 
         map_element "ref-list", to: :ref_list
         map_element "app-group", to: :app_group

data/lib/sts/niso_sts/body.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "section"
-
 module Sts
   module NisoSts
     class Body < Lutaml::Model::Serializable
-      attribute :sec, Section, collection: true
+      attribute :sec, ::Sts::NisoSts::Section, collection: true
 
       xml do
-        root "body"
+        element "body"
         map_element "sec", to: :sec
       end
     end

data/lib/sts/niso_sts/caption.rb

@@ -1,9 +1,3 @@
-require "lutaml/model"
-
-require_relative "paragraph"
-require_relative "title"
-require_relative "non_normative_note"
-
 # rubocop:disable Layout/LineLength
 # <caption>
 #   <title>Overview of risk assessment/risk reduction</title>
@@ -31,12 +25,14 @@ require_relative "non_normative_note"
 module Sts
   module NisoSts
     class Caption < Lutaml::Model::Serializable
-      attribute :title, Title
-      attribute :paragraphs, Paragraph, collection: true
-      attribute :non_normative_note, NonNormativeNote, collection: true
+      attribute :title, ::Sts::NisoSts::Title
+      attribute :paragraphs, ::Sts::NisoSts::Paragraph, collection: true
+      attribute :non_normative_note, ::Sts::NisoSts::NonNormativeNote,
+                collection: true
 
       xml do
-        root "caption", mixed: true
+        element "caption"
+        mixed_content
 
         map_element "p", to: :paragraphs
         map_element "non-normative-note", to: :non_normative_note

data/lib/sts/niso_sts/custom_meta.rb

@@ -1,20 +1,16 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
 module Sts
   module NisoSts
     class CustomMeta < Lutaml::Model::Serializable
-      attribute :lang, :string
+      attribute :lang, Lutaml::Xml::W3c::XmlLangType
       attribute :meta_name, :string
       attribute :meta_value, :string
 
       xml do
-        root "custom-meta"
+        element "custom-meta"
 
-        map_attribute "lang", to: :lang,
-                              namespace: "http://www.w3.org/XML/1998/namespace",
-                              prefix: "xml"
+        map_attribute "lang", to: :lang
         map_element "meta-name", to: :meta_name
         map_element "meta-value", to: :meta_value
       end

data/lib/sts/niso_sts/custom_meta_group.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "custom_meta"
-
 module Sts
   module NisoSts
     class CustomMetaGroup < Lutaml::Model::Serializable
-      attribute :custom_meta, CustomMeta, collection: true
+      attribute :custom_meta, ::Sts::NisoSts::CustomMeta, collection: true
 
       xml do
-        root "custom-meta-group"
+        element "custom-meta-group"
 
         map_element "custom-meta", to: :custom_meta
       end

data/lib/sts/niso_sts/def.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "paragraph"
-
 module Sts
   module NisoSts
     class Def < Lutaml::Model::Serializable
-      attribute :paragraph, Paragraph
+      attribute :paragraph, ::Sts::NisoSts::Paragraph
 
       xml do
-        root "def"
+        element "def"
 
         map_element "p", to: :paragraph
       end

data/lib/sts/niso_sts/def_item.rb

@@ -1,19 +1,14 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "def"
-require_relative "../tbx_iso_tml/term"
-
 module Sts
   module NisoSts
     class DefItem < Lutaml::Model::Serializable
       attribute :specific_use, :string
-      attribute :term, TbxIsoTml::Term
-      attribute :definition, Def
+      attribute :term, ::Sts::NisoSts::Term
+      attribute :definition, ::Sts::NisoSts::Def
 
       xml do
-        root "def-item"
+        element "def-item"
 
         map_attribute "specific-use", to: :specific_use
         map_element "term", to: :term, render_nil: true

data/lib/sts/niso_sts/def_list.rb

@@ -1,20 +1,16 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "def_item"
-
 module Sts
   module NisoSts
     class DefList < Lutaml::Model::Serializable
       attribute :title, :string
       attribute :specific_use, :string
       attribute :list_type, :string
-      attribute :def_item, DefItem, collection: true
-      attribute :def_list, DefList
+      attribute :def_item, ::Sts::NisoSts::DefItem, collection: true
+      attribute :def_list, ::Sts::NisoSts::DefList
 
       xml do
-        root "def-list"
+        element "def-list"
 
         map_attribute "list-type", to: :list_type
         map_attribute "specific-use", to: :specific_use

data/lib/sts/niso_sts/display_formula.rb

@@ -1,24 +1,21 @@
 # frozen_string_literal: true
 
 require "lutaml/model"
-require_relative "../tbx_iso_tml/math"
 
 module Sts
   module NisoSts
     class DisplayFormula < Lutaml::Model::Serializable
       attribute :id, :string
-      attribute :label, Label
-      attribute :math, TbxIsoTml::Math
+      attribute :label, ::Sts::NisoSts::Label
+      attribute :math, ::Sts::TbxIsoTml::Math
 
       xml do
-        root "disp-formula"
+        element "disp-formula"
 
         map_attribute "id", to: :id
 
         map_element "label", to: :label
-        map_element "math", to: :math,
-                            namespace: "http://www.w3.org/1998/Math/MathML",
-                            prefix: "mml"
+        map_element "math", to: :math
       end
     end
   end

data/lib/sts/niso_sts/document_identification.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
 module Sts
   module NisoSts
     class DocumentIdentification < Lutaml::Model::Serializable
@@ -12,7 +10,7 @@ module Sts
       attribute :urn, :string
 
       xml do
-        root "doc-ident"
+        element "doc-ident"
 
         map_element "sdo", to: :sdo
         map_element "proj-id", to: :proj_id

data/lib/sts/niso_sts/ext_link.rb

@@ -1,23 +1,19 @@
 # frozen_striing_literal: true
 
-require "lutaml/model"
-
 module Sts
   module NisoSts
     class ExtLink < Lutaml::Model::Serializable
       attribute :ext_link_type, :string
-      attribute :href, :string
+      attribute :href, :xlink_href
       attribute :content, :string
 
       xml do
-        root "ext-link"
+        element "ext-link"
 
         map_content to: :content
 
         map_attribute "ext-link-type", to: :ext_link_type
-        map_attribute "href", to: :href,
-                              namespace: "http://www.w3.org/1999/xlink",
-                              prefix: "xlink"
+        map_attribute "href", to: :href
       end
     end
   end

data/lib/sts/niso_sts/figure.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "caption"
-require_relative "graphic"
-require_relative "def_list"
-
 # <fig id="fig-1" orientation="portrait">
 #   <label>Figure 1</label>
 #   <caption...>
@@ -14,18 +8,17 @@ require_relative "def_list"
 
 module Sts
   module NisoSts
-    class Caption < Lutaml::Model::Serializable; end
-
     class Figure < Lutaml::Model::Serializable
       attribute :id, :string
       attribute :orientation, :string
-      attribute :caption, Caption
-      attribute :def_list, DefList
-      attribute :label, Label
-      attribute :graphic, Graphic, collection: true
+      attribute :caption, ::Sts::NisoSts::Caption
+      attribute :def_list, ::Sts::NisoSts::DefList
+      attribute :label, ::Sts::NisoSts::Label
+      attribute :graphic, ::Sts::NisoSts::Graphic, collection: true
 
       xml do
-        root "fig", mixed: true
+        element "fig"
+        mixed_content
 
         map_attribute "id", to: :id
         map_attribute "orientation", to: :orientation

data/lib/sts/niso_sts/fn.rb

@@ -1,19 +1,14 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "label"
-require_relative "paragraph"
-
 module Sts
   module NisoSts
     class Fn < Lutaml::Model::Serializable
       attribute :id, :string
-      attribute :label, Label
-      attribute :paragraph, Paragraph
+      attribute :label, ::Sts::NisoSts::Label
+      attribute :paragraph, ::Sts::NisoSts::Paragraph
 
       xml do
-        root "fn"
+        element "fn"
 
         map_attribute "id", to: :id
 

data/lib/sts/niso_sts/fn_group.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "fn"
-
 module Sts
   module NisoSts
     class FnGroup < Lutaml::Model::Serializable
-      attribute :fn, Fn, collection: true
+      attribute :fn, ::Sts::NisoSts::Fn, collection: true
 
       xml do
-        root "fn-group"
+        element "fn-group"
 
         map_element "fn", to: :fn
       end

data/lib/sts/niso_sts/front.rb

@@ -1,20 +1,14 @@
 # frozen_string_literal: true
 
-require "lutaml/model"
-
-require_relative "metadata_iso"
-require_relative "metadata_std"
-require_relative "section"
-
 module Sts
   module NisoSts
     class Front < Lutaml::Model::Serializable
-      attribute :iso_meta, MetadataIso
-      attribute :std_meta, MetadataStd
-      attribute :sec, Section, collection: true
+      attribute :iso_meta, ::Sts::NisoSts::MetadataIso
+      attribute :std_meta, ::Sts::NisoSts::MetadataStd
+      attribute :sec, ::Sts::NisoSts::Section, collection: true
 
       xml do
-        root "front"
+        element "front"
         map_element "iso-meta", to: :iso_meta
         map_element "std-meta", to: :std_meta
         map_element "sec", to: :sec

data/lib/sts/niso_sts/graphic.rb

@@ -1,7 +1,3 @@
-require "lutaml/model"
-
-require_relative "object_id"
-
 # rubocop:disable Layout/LineLength
 # <graphic xlink:href="e1d18be9.001.gif">
 #   <object-id pub-id-type="fpi">+//ISO 9070/RA::A00007::GE::DIN German Institute for
@@ -13,16 +9,14 @@ require_relative "object_id"
 module Sts
   module NisoSts
     class Graphic < Lutaml::Model::Serializable
-      attribute :href, :string
-      attribute :object_id, ObjectId, collection: true
+      attribute :href, :xlink_href
+      attribute :sts_object_id, ::Sts::NisoSts::ObjectId, collection: true
 
       xml do
-        root "graphic"
+        element "graphic"
 
-        map_attribute "href", to: :href,
-                              namespace: "http://www.w3.org/1999/xlink",
-                              prefix: "xlink"
-        map_element "object-id", to: :object_id
+        map_attribute "href", to: :href
+        map_element "object-id", to: :sts_object_id
       end
     end
   end