metaschema 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60b00aaab348d3f988738d342131af2960af449c6476284f372017a884b609ea
-  data.tar.gz: 3d1105245b18f7db1269698ee5aaf68bc7f0c2cb40dde4efd00a6d7ba068bfc0
+  metadata.gz: 8430ee05ae7a85561689c25a0404d06ec3484b6ce006fad3ac194fee3bf909ed
+  data.tar.gz: 986832e20e5a6c492b766187183f88f498ab62f04d914c25b1853ff01791420e
 SHA512:
-  metadata.gz: d15f2fb39b07d584bbcbb30ea497281ea9f38068ca978a746ed1afc00889e2823b89101259edb3b3c27a010b671f9c6992daed8c0db081726a1b33219fe09797
-  data.tar.gz: 0cbe2b526a88045f7ea3cb8d75165bf00fa4c7d52cf64ea830bfd69755cedae2d77d24d7b891c9df981b32e5ce31df49294d9e62bf5c59daeca55d6c1d85dfc0
+  metadata.gz: a9e6dfbf033a45d9ab7d92db610a4afd2a74c3e2101bc2ce47522dbf77207762122356fddc3390267679a5e45ac3a1e478bc8162b1dedd8e24737fb05502c47d
+  data.tar.gz: 6cff0e8d3fd500ad980ae84d2a1b7f1f5db53f76151004c84dc55c4b06e038fd21f9beccfddbab567cacd04855db62250807764439fbaa47492fdf40af5ccd5a

data/.rubocop.yml

@@ -1 +1,19 @@
-inherit_from: .rubocop_todo.yml
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+  - .rubocop_todo.yml
+
+inherit_mode:
+  merge:
+    - Exclude
+
+# local repo-specific modifications
+# ...
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0

data/.rubocop_todo.yml

@@ -1,18 +1,70 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-01-06 00:55:21 UTC using RuboCop version 1.69.2.
+# on 2026-04-14 10:25:31 UTC using RuboCop version 1.86.1.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# Offense count: 1
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'metaschema.gemspec'
+
+# Offense count: 14
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
+  Exclude:
+    - 'lib/metaschema.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/metaschema.rb'
+
+# Offense count: 16
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'lib/metaschema.rb'
+    - 'spec/metaschema_spec.rb'
+
+# Offense count: 14
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/metaschema.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 44
+  Max: 28
+
+# Offense count: 2
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 10
+
+# Offense count: 1
+# Configuration parameters: AllowedPatterns.
+# AllowedPatterns: ^expect_, ^assert_
+RSpec/NoExpectationExample:
+  Exclude:
+    - 'spec/metaschema_spec.rb'
 
-# Offense count: 66
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Enabled: false
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/metaschema.rb'

data/CLAUDE.md

@@ -0,0 +1,78 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+This is a Ruby gem implementing a parser and generator for the [NIST Metaschema Information Modeling Framework](https://pages.nist.gov/metaschema). It parses Metaschema XML files and can round-trip them (parse to Ruby objects and back to XML).
+
+## Common Commands
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests
+bundle exec rake spec
+
+# Run a single test file
+bundle exec rspec spec/metaschema_spec.rb
+
+# Run tests with specific format
+bundle exec rspec spec/metaschema_spec.rb --format documentation
+
+# Run linting
+bundle exec rake rubocop
+
+# Auto-correct linting issues
+bundle exec rake rubocop:autocorrect_all
+
+# Build the gem
+bundle exec rake build
+```
+
+## Architecture
+
+The gem uses **lutaml-model** with **Nokogiri** for XML serialization/deserialization. All model classes inherit from `Lutaml::Model::Serializable`.
+
+### Entry Point
+
+`lib/metaschema/root.rb` - The `Metaschema::Root` class is the top-level model representing a complete Metaschema XML document. It contains:
+- `schema_name`, `schema_version`, `short_name`, `namespace`, `json_base_uri`
+- Top-level definitions: `define_assembly`, `define_field`, `define_flag`
+- Imports and namespace bindings
+
+### Type System
+
+The `lib/metaschema/` directory contains ~74 type classes. Key patterns:
+
+- **Definition types** (e.g., `GlobalAssemblyDefinitionType`, `GlobalFieldDefinitionType`) - Define schema structures with `name`, `formal_name`, `description`, `model`, `constraint`
+- **Reference types** (e.g., `AssemblyReferenceType`, `FieldReferenceType`) - Reference definitions by name
+- **Inline definition types** (e.g., `InlineAssemblyDefinitionType`) - Definitions nested within other definitions
+- **Constraint types** (e.g., `DefineAssemblyConstraintsType`, `AllowedValuesType`) - Validation constraints
+- **Value types** (e.g., `MarkupLineDatatype`, `FormalName`) - Simple value wrappers
+
+Each type class uses the lutaml-model XML DSL:
+```ruby
+xml do
+  element "ElementName"
+  ordered  # children must appear in defined order
+  namespace ::Metaschema::Namespace
+  map_attribute "attr", to: :attr_name
+  map_element "child-element", to: :child_attr
+end
+```
+
+### Test Fixtures
+
+- `spec/fixtures/metaschema/` - Submoduled NIST Metaschema project containing test schemas
+- `spec/fixtures/metaschema/examples/` - Example Metaschema XML files (e.g., `computer-example.xml`)
+- `spec/fixtures/metaschema/test-suite/schema-generation/` - Feature-specific test cases
+
+### Loading a Metaschema File
+
+```ruby
+require 'metaschema'
+ms = Metaschema::Root.from_file("path/to/metaschema.xml")
+ms.to_xml  # Returns XML string
+```

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require 'rubocop/rake_task'
+require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 

data/exe/metaschema

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/metaschema'
-require_relative '../lib/metaschema/cli'
+require_relative "../lib/metaschema"
 
 Metaschema::Cli::Commands.start(ARGV)

data/lib/metaschema/allowed_value_type.rb

@@ -1,13 +1,5 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
-require_relative 'anchor_type'
-require_relative 'code_type'
-require_relative 'image_type'
-require_relative 'inline_markup_type'
-require_relative 'insert_type'
-
 module Metaschema
   class AllowedValueType < Lutaml::Model::Serializable
     attribute :content, :string
@@ -27,24 +19,25 @@ module Metaschema
     attribute :img, ImageType, collection: true
 
     xml do
-      root 'AllowedValueType', mixed: true
-      namespace 'http://csrc.nist.gov/ns/oscal/metaschema/1.0'
+      element "AllowedValueType"
+      mixed_content
+      namespace ::Metaschema::Namespace
 
       map_content to: :content
-      map_attribute 'value', to: :value
-      map_attribute 'deprecated', to: :deprecated
-      map_element 'a', to: :a
-      map_element 'insert', to: :insert
-      map_element 'br', to: :br
-      map_element 'code', to: :code
-      map_element 'em', to: :em
-      map_element 'i', to: :i
-      map_element 'b', to: :b
-      map_element 'strong', to: :strong
-      map_element 'sub', to: :sub
-      map_element 'sup', to: :sup
-      map_element 'q', to: :q
-      map_element 'img', to: :img
+      map_attribute "value", to: :value
+      map_attribute "deprecated", to: :deprecated
+      map_element "a", to: :a
+      map_element "insert", to: :insert
+      map_element "br", to: :br
+      map_element "code", to: :code
+      map_element "em", to: :em
+      map_element "i", to: :i
+      map_element "b", to: :b
+      map_element "strong", to: :strong
+      map_element "sub", to: :sub
+      map_element "sup", to: :sup
+      map_element "q", to: :q
+      map_element "img", to: :img
     end
   end
 end

data/lib/metaschema/allowed_values_type.rb

@@ -1,37 +1,30 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
-require_relative 'allowed_value_type'
-require_relative 'markup_line_datatype'
-require_relative 'property_type'
-require_relative 'remarks_type'
-
 module Metaschema
   class AllowedValuesType < Lutaml::Model::Serializable
     attribute :id, :string
-    attribute :level, :string, default: -> { 'ERROR' }
-    attribute :allow_other, :string, default: -> { 'no' }
-    attribute :extensible, :string, default: -> { 'external' }
-    attribute :formal_name, :string
+    attribute :level, :string, default: -> { "ERROR" }
+    attribute :allow_other, :string, default: -> { "no" }
+    attribute :extensible, :string, default: -> { "external" }
+    attribute :formal_name, FormalName
     attribute :description, MarkupLineDatatype
     attribute :prop, PropertyType, collection: true
     attribute :enum, AllowedValueType, collection: true
     attribute :remarks, RemarksType
 
     xml do
-      root 'AllowedValuesType'
-      namespace 'http://csrc.nist.gov/ns/oscal/metaschema/1.0'
+      element "AllowedValuesType"
+      namespace ::Metaschema::Namespace
 
-      map_attribute 'id', to: :id
-      map_attribute 'level', to: :level
-      map_attribute 'allow-other', to: :allow_other
-      map_attribute 'extensible', to: :extensible
-      map_element 'formal-name', to: :formal_name
-      map_element 'description', to: :description
-      map_element 'prop', to: :prop
-      map_element 'enum', to: :enum
-      map_element 'remarks', to: :remarks
+      map_attribute "id", to: :id
+      map_attribute "level", to: :level
+      map_attribute "allow-other", to: :allow_other
+      map_attribute "extensible", to: :extensible
+      map_element "formal-name", to: :formal_name
+      map_element "description", to: :description
+      map_element "prop", to: :prop
+      map_element "enum", to: :enum
+      map_element "remarks", to: :remarks
     end
   end
 end

data/lib/metaschema/anchor_type.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
-require_relative 'code_type'
-require_relative 'image_type'
-require_relative 'inline_markup_type'
-
 module Metaschema
   class AnchorType < Lutaml::Model::Serializable
     attribute :content, :string
@@ -22,21 +16,22 @@ module Metaschema
     attribute :img, ImageType, collection: true
 
     xml do
-      root 'anchorType', mixed: true
-      namespace 'http://csrc.nist.gov/ns/oscal/metaschema/1.0'
+      element "anchorType"
+      mixed_content
+      namespace ::Metaschema::Namespace
 
       map_content to: :content
-      map_attribute 'href', to: :href
-      map_attribute 'title', to: :title
-      map_element 'code', to: :code
-      map_element 'em', to: :em
-      map_element 'i', to: :i
-      map_element 'b', to: :b
-      map_element 'strong', to: :strong
-      map_element 'sub', to: :sub
-      map_element 'sup', to: :sup
-      map_element 'q', to: :q
-      map_element 'img', to: :img
+      map_attribute "href", to: :href
+      map_attribute "title", to: :title
+      map_element "code", to: :code
+      map_element "em", to: :em
+      map_element "i", to: :i
+      map_element "b", to: :b
+      map_element "strong", to: :strong
+      map_element "sub", to: :sub
+      map_element "sup", to: :sup
+      map_element "q", to: :q
+      map_element "img", to: :img
     end
   end
 end

data/lib/metaschema/any_type.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
 module Metaschema
   class AnyType < Lutaml::Model::Serializable
     xml do
-      root 'AnyType'
-      namespace 'http://csrc.nist.gov/ns/oscal/metaschema/1.0'
+      element "AnyType"
+      namespace ::Metaschema::Namespace
     end
   end
 end

data/lib/metaschema/assembly.rb

@@ -1,44 +1,35 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
-require_relative 'constraint_let_type'
-require_relative 'remarks_type'
-require_relative 'targeted_allowed_values_constraint_type'
-require_relative 'targeted_expect_constraint_type'
-require_relative 'targeted_has_cardinality_constraint_type'
-require_relative 'targeted_index_constraint_type'
-require_relative 'targeted_index_has_key_constraint_type'
-require_relative 'targeted_key_constraint_type'
-require_relative 'targeted_matches_constraint_type'
-
 module Metaschema
   class Assembly < Lutaml::Model::Serializable
     attribute :target, :string
     attribute :let, ConstraintLetType, collection: true
-    attribute :allowed_values, TargetedAllowedValuesConstraintType, collection: true
+    attribute :allowed_values, TargetedAllowedValuesConstraintType,
+              collection: true
     attribute :matches, TargetedMatchesConstraintType, collection: true
-    attribute :index_has_key, TargetedIndexHasKeyConstraintType, collection: true
+    attribute :index_has_key, TargetedIndexHasKeyConstraintType,
+              collection: true
     attribute :expect, TargetedExpectConstraintType, collection: true
     attribute :index, TargetedIndexConstraintType, collection: true
     attribute :is_unique, TargetedKeyConstraintType, collection: true
-    attribute :has_cardinality, TargetedHasCardinalityConstraintType, collection: true
+    attribute :has_cardinality, TargetedHasCardinalityConstraintType,
+              collection: true
     attribute :remarks, RemarksType
 
     xml do
-      root 'assembly'
-      namespace 'http://csrc.nist.gov/ns/oscal/metaschema/1.0'
+      element "assembly"
+      namespace ::Metaschema::Namespace
 
-      map_attribute 'target', to: :target
-      map_element 'let', to: :let
-      map_element 'is-unique', to: :is_unique
-      map_element 'allowed-values', to: :allowed_values
-      map_element 'matches', to: :matches
-      map_element 'index-has-key', to: :index_has_key
-      map_element 'expect', to: :expect
-      map_element 'index', to: :index
-      map_element 'has-cardinality', to: :has_cardinality
-      map_element 'remarks', to: :remarks
+      map_attribute "target", to: :target
+      map_element "let", to: :let
+      map_element "is-unique", to: :is_unique
+      map_element "allowed-values", to: :allowed_values
+      map_element "matches", to: :matches
+      map_element "index-has-key", to: :index_has_key
+      map_element "expect", to: :expect
+      map_element "index", to: :index
+      map_element "has-cardinality", to: :has_cardinality
+      map_element "remarks", to: :remarks
     end
   end
 end

data/lib/metaschema/assembly_model_type.rb

@@ -1,15 +1,5 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
-require_relative 'any_type'
-require_relative 'assembly_reference_type'
-require_relative 'choice_type'
-require_relative 'field_reference_type'
-require_relative 'grouped_choice_type'
-require_relative 'inline_assembly_definition_type'
-require_relative 'inline_field_definition_type'
-
 module Metaschema
   class AssemblyModelType < Lutaml::Model::Serializable
     attribute :assembly, AssemblyReferenceType, collection: true
@@ -21,16 +11,17 @@ module Metaschema
     attribute :any, AnyType
 
     xml do
-      root 'AssemblyModelType', ordered: true
-      namespace 'http://csrc.nist.gov/ns/oscal/metaschema/1.0'
+      element "AssemblyModelType"
+      ordered
+      namespace ::Metaschema::Namespace
 
-      map_element 'field', to: :field
-      map_element 'define-assembly', to: :define_assembly
-      map_element 'assembly', to: :assembly
-      map_element 'define-field', to: :define_field
-      map_element 'choice', to: :choice
-      map_element 'choice-group', to: :choice_group
-      map_element 'any', to: :any
+      map_element "field", to: :field
+      map_element "define-assembly", to: :define_assembly
+      map_element "assembly", to: :assembly
+      map_element "define-field", to: :define_field
+      map_element "choice", to: :choice
+      map_element "choice-group", to: :choice_group
+      map_element "any", to: :any
     end
   end
 end

data/lib/metaschema/assembly_reference_type.rb

@@ -1,21 +1,13 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
-require_relative 'group_as_type'
-require_relative 'markup_line_datatype'
-require_relative 'property_type'
-require_relative 'remarks_type'
-require_relative 'use_name_type'
-
 module Metaschema
   class AssemblyReferenceType < Lutaml::Model::Serializable
     attribute :ref, :string
     attribute :index, :integer
-    attribute :min_occurs, :integer, default: -> { '0' }
-    attribute :max_occurs, :string, default: -> { '1' }
+    attribute :min_occurs, :integer, default: -> { "0" }
+    attribute :max_occurs, :string, default: -> { "1" }
     attribute :deprecated, :string
-    attribute :formal_name, :string
+    attribute :formal_name, FormalName
     attribute :description, MarkupLineDatatype
     attribute :prop, PropertyType, collection: true
     attribute :use_name, UseNameType
@@ -23,20 +15,20 @@ module Metaschema
     attribute :remarks, RemarksType
 
     xml do
-      root 'AssemblyReferenceType'
-      namespace 'http://csrc.nist.gov/ns/oscal/metaschema/1.0'
+      element "AssemblyReferenceType"
+      namespace ::Metaschema::Namespace
 
-      map_attribute 'ref', to: :ref
-      map_attribute 'index', to: :index
-      map_attribute 'min-occurs', to: :min_occurs
-      map_attribute 'max-occurs', to: :max_occurs
-      map_attribute 'deprecated', to: :deprecated
-      map_element 'formal-name', to: :formal_name
-      map_element 'description', to: :description
-      map_element 'prop', to: :prop
-      map_element 'use-name', to: :use_name
-      map_element 'group-as', to: :group_as
-      map_element 'remarks', to: :remarks
+      map_attribute "ref", to: :ref
+      map_attribute "index", to: :index
+      map_attribute "min-occurs", to: :min_occurs
+      map_attribute "max-occurs", to: :max_occurs
+      map_attribute "deprecated", to: :deprecated
+      map_element "formal-name", to: :formal_name
+      map_element "description", to: :description
+      map_element "prop", to: :prop
+      map_element "use-name", to: :use_name
+      map_element "group-as", to: :group_as
+      map_element "remarks", to: :remarks
     end
   end
 end

data/lib/metaschema/block_quote_type.rb

@@ -1,14 +1,5 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
-require_relative 'image_type'
-require_relative 'inline_markup_type'
-require_relative 'list_type'
-require_relative 'ordered_list_type'
-require_relative 'preformatted_type'
-require_relative 'table_type'
-
 module Metaschema
   class BlockQuoteType < Lutaml::Model::Serializable
     attribute :h1, InlineMarkupType, collection: true
@@ -27,23 +18,24 @@ module Metaschema
     attribute :img, ImageType, collection: true
 
     xml do
-      root 'blockQuoteType', mixed: true
-      namespace 'http://csrc.nist.gov/ns/oscal/metaschema/1.0'
+      element "blockQuoteType"
+      mixed_content
+      namespace ::Metaschema::Namespace
 
-      map_element 'h1', to: :h1
-      map_element 'h2', to: :h2
-      map_element 'h3', to: :h3
-      map_element 'h4', to: :h4
-      map_element 'h5', to: :h5
-      map_element 'h6', to: :h6
-      map_element 'ul', to: :ul
-      map_element 'ol', to: :ol
-      map_element 'pre', to: :pre
-      map_element 'hr', to: :hr
-      map_element 'blockquote', to: :blockquote
-      map_element 'p', to: :p
-      map_element 'table', to: :table
-      map_element 'img', to: :img
+      map_element "h1", to: :h1
+      map_element "h2", to: :h2
+      map_element "h3", to: :h3
+      map_element "h4", to: :h4
+      map_element "h5", to: :h5
+      map_element "h6", to: :h6
+      map_element "ul", to: :ul
+      map_element "ol", to: :ol
+      map_element "pre", to: :pre
+      map_element "hr", to: :hr
+      map_element "blockquote", to: :blockquote
+      map_element "p", to: :p
+      map_element "table", to: :table
+      map_element "img", to: :img
     end
   end
 end

data/lib/metaschema/choice_type.rb

@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
-require_relative 'assembly_reference_type'
-require_relative 'field_reference_type'
-require_relative 'inline_assembly_definition_type'
-require_relative 'inline_field_definition_type'
-
 module Metaschema
   class ChoiceType < Lutaml::Model::Serializable
     attribute :assembly, AssemblyReferenceType, collection: true
@@ -15,13 +8,13 @@ module Metaschema
     attribute :define_field, InlineFieldDefinitionType, collection: true
 
     xml do
-      root 'ChoiceType'
-      namespace 'http://csrc.nist.gov/ns/oscal/metaschema/1.0'
+      element "ChoiceType"
+      namespace ::Metaschema::Namespace
 
-      map_element 'field', to: :field
-      map_element 'define-assembly', to: :define_assembly
-      map_element 'assembly', to: :assembly
-      map_element 'define-field', to: :define_field
+      map_element "field", to: :field
+      map_element "define-assembly", to: :define_assembly
+      map_element "assembly", to: :assembly
+      map_element "define-field", to: :define_field
     end
   end
 end