metaschema 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8430ee05ae7a85561689c25a0404d06ec3484b6ce006fad3ac194fee3bf909ed
-  data.tar.gz: 986832e20e5a6c492b766187183f88f498ab62f04d914c25b1853ff01791420e
+  metadata.gz: 13c76286aac4a084b992310573e600bff798224156cbbfb1ec5a27b80fdf9ec8
+  data.tar.gz: 509b4a6032bec02787b65783e7ff253133b16ffebc1398bc9470f96a53403258
 SHA512:
-  metadata.gz: a9e6dfbf033a45d9ab7d92db610a4afd2a74c3e2101bc2ce47522dbf77207762122356fddc3390267679a5e45ac3a1e478bc8162b1dedd8e24737fb05502c47d
-  data.tar.gz: 6cff0e8d3fd500ad980ae84d2a1b7f1f5db53f76151004c84dc55c4b06e038fd21f9beccfddbab567cacd04855db62250807764439fbaa47492fdf40af5ccd5a
+  metadata.gz: 6920a39f399434cbb2634f0395ae346af06bd80d95bebfba2cceba3ff08f4421cf483bc5b3078672d596b2df5b05c0d3a33afe595859e8df22052fc08b327c53
+  data.tar.gz: deaba8e56599fdab8902215b520eb7ba057b2fb82aab57126c5acea59a39b3916286dbd54d6563e4f7da7764b3a39a60c21b4f2f1d913b43d893980bf9acedb1

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-04-14 10:25:31 UTC using RuboCop version 1.86.1.
+# on 2026-04-24 02:52:57 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
@@ -11,48 +11,144 @@ 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:
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
   Exclude:
-    - 'lib/metaschema.rb'
+    - 'lib/metaschema/model_generator/assembly_factory.rb'
 
-# Offense count: 16
+# Offense count: 92
 # 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'
+    - 'lib/metaschema/constraint_validator.rb'
+    - 'lib/metaschema/json_schema_generator.rb'
+    - 'lib/metaschema/markdown_doc_generator.rb'
+    - 'lib/metaschema/metapath_evaluator.rb'
+    - 'lib/metaschema/model_generator.rb'
+    - 'lib/metaschema/model_generator/assembly_factory.rb'
+    - 'lib/metaschema/model_generator/field_factory.rb'
+    - 'lib/metaschema/model_generator/services/field_deserializer.rb'
+    - 'lib/metaschema/ruby_source_emitter.rb'
     - 'spec/metaschema_spec.rb'
+    - 'spec/model_generator_spec.rb'
+    - 'spec/ruby_source_emitter_spec.rb'
 
-# Offense count: 14
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
+# Offense count: 2
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
+Lint/DuplicateBranch:
+  Exclude:
+    - 'lib/metaschema/constraint_validator.rb'
+    - 'lib/metaschema/model_generator/assembly_factory.rb'
+
+# Offense count: 1
+Lint/IneffectiveAccessModifier:
   Exclude:
-    - 'lib/metaschema.rb'
+    - 'lib/metaschema/constraint_validator.rb'
 
 # Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
+# NotImplementedExceptions: NotImplementedError
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/metaschema/markdown_doc_generator.rb'
+
+# Offense count: 84
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/metaschema/constraint_validator.rb'
+    - 'lib/metaschema/json_schema_generator.rb'
+    - 'lib/metaschema/markdown_doc_generator.rb'
+    - 'lib/metaschema/metapath_evaluator.rb'
+    - 'lib/metaschema/model_generator.rb'
+    - 'lib/metaschema/model_generator/assembly_factory.rb'
+    - 'lib/metaschema/model_generator/field_factory.rb'
+    - 'lib/metaschema/model_generator/services/field_serializer.rb'
+    - 'lib/metaschema/ruby_source_emitter.rb'
+    - 'lib/metaschema/type_mapper.rb'
+
+# Offense count: 11
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 28
+  Max: 46
 
-# Offense count: 2
+# Offense count: 87
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/metaschema/constraint_validator.rb'
+    - 'lib/metaschema/json_schema_generator.rb'
+    - 'lib/metaschema/markdown_doc_generator.rb'
+    - 'lib/metaschema/metapath_evaluator.rb'
+    - 'lib/metaschema/model_generator.rb'
+    - 'lib/metaschema/model_generator/assembly_factory.rb'
+    - 'lib/metaschema/model_generator/field_factory.rb'
+    - 'lib/metaschema/model_generator/services/field_deserializer.rb'
+    - 'lib/metaschema/ruby_source_emitter.rb'
+
+# Offense count: 104
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 212
+
+# Offense count: 4
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 7
+
+# Offense count: 74
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/metaschema/constraint_validator.rb'
+    - 'lib/metaschema/json_schema_generator.rb'
+    - 'lib/metaschema/markdown_doc_generator.rb'
+    - 'lib/metaschema/metapath_evaluator.rb'
+    - 'lib/metaschema/model_generator.rb'
+    - 'lib/metaschema/model_generator/assembly_factory.rb'
+    - 'lib/metaschema/model_generator/field_factory.rb'
+    - 'lib/metaschema/model_generator/services/field_deserializer.rb'
+    - 'lib/metaschema/ruby_source_emitter.rb'
+
+# Offense count: 20
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/metaschema/json_schema_generator.rb'
+    - 'lib/metaschema/markdown_doc_generator.rb'
+    - 'lib/metaschema/metapath_evaluator.rb'
+
+# Offense count: 1
+RSpec/DescribeMethod:
+  Exclude:
+    - 'spec/model_generator_spec.rb'
+
+# Offense count: 15
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
-  Max: 10
+  Max: 20
+
+# Offense count: 1
+RSpec/MultipleDescribes:
+  Exclude:
+    - 'spec/services_spec.rb'
+
+# Offense count: 13
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 4
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 7
 
 # Offense count: 1
 # Configuration parameters: AllowedPatterns.
@@ -62,9 +158,40 @@ RSpec/NoExpectationExample:
     - 'spec/metaschema_spec.rb'
 
 # Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
+RSpec/RepeatedDescription:
+  Exclude:
+    - 'spec/type_mapper_spec.rb'
+
+# Offense count: 2
+RSpec/RepeatedExample:
+  Exclude:
+    - 'spec/type_mapper_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: CustomTransform, IgnoreMethods, IgnoreMetadata, InflectorPath, EnforcedInflector.
+# SupportedInflectors: default, active_support
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - 'spec/model_generator_spec.rb'
+    - 'spec/ruby_source_emitter_spec.rb'
+    - 'spec/type_mapper_spec.rb'
+
+# Offense count: 1
+Style/DocumentDynamicEvalDefinition:
+  Exclude:
+    - 'lib/metaschema/model_generator/utils.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/metaschema/model_generator/field_factory.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
   Exclude:
-    - 'lib/metaschema.rb'
+    - 'lib/metaschema/model_generator/utils.rb'
+    - 'lib/metaschema/ruby_source_emitter.rb'

data/README.adoc

@@ -28,15 +28,16 @@ Metaschema-defined information models in the future.
 
 == Features
 
-TODO: This list is a TODO list. None of them have been completed.
-
 . Parse, build and round-trip Metaschema XML files
 . Validate Metaschema XML files against the Metaschema XML Schema
 . Generate XML (XSD) and JSON Schemas from Metaschema XML files
-. Generate Lutaml::Model (Ruby) classes that allow access and manipulation of
-  Metaschema-defined information models.
+. Generate `Lutaml::Model::Serializable` Ruby classes from Metaschema XML
+  definitions, with full XML and JSON round-trip fidelity
 . Validate Metaschema-defined information models against the Metaschema XML
   Schema
+. Support for SINGLETON_OR_ARRAY field patterns via service object pipeline
+  (FieldSerializer / FieldDeserializer)
+. UNWRAPPED XML field handling with delegate mappings
 
 == Installation
 
@@ -94,6 +95,55 @@ ms.assemblies
 # [Vendor, Computer, ...]
 ----
 
+== Model Generation
+
+The `Metaschema::ModelGenerator` generates Ruby classes from Metaschema XML
+definitions. It uses a factory-based architecture:
+
+[horizontal]
+`ModelGenerator`:: Orchestrator — handles imports, augments, and delegates to factories
+`FieldFactory`:: Creates field classes from Metaschema field definitions
+`AssemblyFactory`:: Creates assembly classes with XML and JSON mappings
+`FieldSerializer`:: Service object for normalizing field values to JSON
+`FieldDeserializer`:: Service object for denormalizing JSON values to field instances
+`CollapsiblesCollapser`:: Groups collapsible fields by shared flag values
+`Utils`:: Shared naming and utility helpers
+
+=== Generating Ruby source
+
+[source,ruby]
+----
+# Generate a single Ruby file with all classes
+source = Metaschema::ModelGenerator.to_ruby_source(
+  "oscal_complete_metaschema.xml",
+  module_name: "Oscal"
+)
+
+# Generate split files (one per class)
+files = Metaschema::ModelGenerator.to_ruby_source(
+  "oscal_complete_metaschema.xml",
+  module_name: "Oscal",
+  split: true
+)
+----
+
+=== Type System
+
+The `TypeMapper` maps Metaschema data types to Ruby/Lutaml::Model types:
+
+[horizontal]
+`string`, `token`, `uri`, etc.:: `:string`
+`integer`:: `:integer`
+`boolean`:: `:boolean`
+`date`, `date-time`:: `:date`, `:date_time`
+`markup-line`:: `Metaschema::MarkupLineDatatype`
+`markup-multiline`:: `Metaschema::MarkupMultilineDatatype`
+
+=== Dependencies
+
+* `lutaml-model ~> 0.8.0` — serialization framework
+* `moxml >= 0.1.15` — XML adapter (uses `namespace_validation_mode=` API)
+
 
 == Tests
 

data/lib/metaschema/allowed_value_type.rb

@@ -2,7 +2,7 @@
 
 module Metaschema
   class AllowedValueType < Lutaml::Model::Serializable
-    attribute :content, :string
+    attribute :content, :string, collection: true
     attribute :value, :string
     attribute :deprecated, :string
     attribute :a, AnchorType, collection: true

data/lib/metaschema/anchor_type.rb

@@ -2,7 +2,7 @@
 
 module Metaschema
   class AnchorType < Lutaml::Model::Serializable
-    attribute :content, :string
+    attribute :content, :string, collection: true
     attribute :href, :string
     attribute :title, :string
     attribute :code, CodeType, collection: true

data/lib/metaschema/augment_type.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Metaschema
+  # Represents an <augment> element in a metaschema document.
+  # Augments add documentation, flags, or properties to definitions
+  # from imported modules without modifying the original module.
+  #
+  # Example:
+  #   <augment name="metadata">
+  #     <formal-name>Document Metadata</formal-name>
+  #     <description>Provides information about the document.</description>
+  #     <flag ref="document-id" />
+  #   </augment>
+  class AugmentType < Lutaml::Model::Serializable
+    attribute :name, :string
+    attribute :formal_name, FormalName
+    attribute :description, MarkupLineDatatype
+    attribute :prop, PropertyType, collection: true
+    attribute :remarks, RemarksType
+    attribute :example, ExampleType, collection: true
+    attribute :flag, FlagReferenceType, collection: true
+    attribute :define_flag, InlineFlagDefinitionType, collection: true
+
+    xml do
+      element "augment"
+      ordered
+      namespace ::Metaschema::Namespace
+
+      map_attribute "name", to: :name
+      map_element "formal-name", to: :formal_name
+      map_element "description", to: :description
+      map_element "prop", to: :prop
+      map_element "remarks", to: :remarks
+      map_element "example", to: :example
+      map_element "flag", to: :flag
+      map_element "define-flag", to: :define_flag
+    end
+  end
+end

data/lib/metaschema/code_type.rb

@@ -2,7 +2,7 @@
 
 module Metaschema
   class CodeType < Lutaml::Model::Serializable
-    attribute :content, :string
+    attribute :content, :string, collection: true
     attribute :klass, :string
     attribute :a, AnchorType, collection: true
     attribute :insert, InsertType, collection: true