metaschema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96ded33102abf61d6bebf9eeb5ae94432fa3ef93317d7cc63fefeada76cf3e1b
+  data.tar.gz: fb9b812a3407d39927a7fb3d4955c902e3559338a393f0edeed8223212745803
+SHA512:
+  metadata.gz: d4e7ea5033073e84c24375688b351f59be2c9b2787968160ab79f71a5c4e46346262710ff5952647529d0927b88d982d8c76ec178bf9e0a5b974e60e218a5405
+  data.tar.gz: 6e3b3ee833410b6fa2398e7ada654e0f7ec3d3b1ff87a440d0cdef046b4d3379d28707799c1f0ed644ed6bb0a4ccefcf3a352f5c715c4a99bc14e85b0d9efac3

data/README.adoc

@@ -0,0 +1,128 @@
+= Metaschema
+
+image:https://img.shields.io/gem/v/metaschema.svg["Gem Version", link="https://rubygems.org/gems/metaschema"]
+image:https://github.com/lutaml/metaschema/workflows/rake/badge.svg["Build Status", link="https://github.com/lutaml/metaschema/actions?workflow=rake"]
+image:https://codeclimate.com/github/lutaml/metaschema/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/lutaml/metaschema"]
+
+== Purpose
+
+This Ruby gem implements a parser and generator for the
+https://pages.nist.gov/metaschema[NIST Metaschema Information Modeling Framework].
+
+Metaschema is a specification for defining information models in a structured
+format (currently via XML). It provides a way to define and manage information
+model schemas that can be converted into XML and JSON Schemas.
+
+This library can be used to parse and generate information schemas defined in
+the Metaschema XML format.
+
+This library can also be used to generate XML schemas and JSON Schemas from
+Metaschema XML files.
+
+NOTE: The Metaschema gem is a work in progress and may not yet support all
+features of the Metaschema specification.
+
+NOTE: The Metaschema gem will support the generation of data accessors for
+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.
+. Validate Metaschema-defined information models against the Metaschema XML
+  Schema
+
+== Installation
+
+To install the metaschema gem, use one of the following methods.
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'metaschema'
+----
+
+Then execute:
+
+[source,sh]
+----
+$ bundle install
+----
+
+Or install it directly using:
+
+[source,sh]
+----
+$ gem install metaschema
+----
+
+After installation, you can start using the metaschema gem in your Ruby projects
+or via the command-line interface.
+
+
+== Ruby API
+
+[source,ruby]
+----
+require 'metaschema'
+
+# Load a Metaschema file
+# Sample at spec/fixtures/metaschema/examples/computer-example.xml
+ms = Metaschema::Root.from_file("computer-example.xml")
+
+ms.to_xml
+# <METASCHEMA xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+#  xsi:schemaLocation="http://csrc.nist.gov/ns/oscal/metaschema/1.0 ../schema/xml/metaschema.xsd"
+#  xmlns="http://csrc.nist.gov/ns/oscal/metaschema/1.0">
+#     <schema-name>Computer Model</schema-name>
+#     <schema-version>0.0.5</schema-version>
+
+ms.schema_name
+# "Computer Model"
+
+ms.schema_version
+# "0.0.5"
+
+ms.assemblies
+# [Vendor, Computer, ...]
+----
+
+
+== Tests
+
+The `spec/fixtures` folder contains tests that the Metaschema gem needs to
+comply with.
+
+Including:
+
+`spec/fixtures/metaschema`:: the submoduled repository from the
+https://github.com/usnistgov/metaschema[Metaschema project]
+
+`spec/fixtures/metaschema/examples`:: examples of Metaschema XML files
+(for us to test round-tripping)
+
+`spec/fixtures/metaschema/test-suite`:: the test suite for the Metaschema
+project. TODO: This library is to be tested against these files.
+
+`spec/fixtures/metaschema/test-suite/schema-generation`:: these files test
+against individual features of Metaschema. TODO: This library needs to run RSpecs
+against every directory here each representing a separate feature.
+
+`spec/fixtures/metaschema/test-suite/worked-examples`:: these files are complete
+Metaschema XML examples that exercises all features of Metaschema. TODO: This
+library needs to run RSpecs against each of these files.
+
+
+
+== License
+
+Copyright Ribose.
+
+BSD-3 license.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/metaschema

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

data/lib/metaschema/allowed_value_type.rb

@@ -0,0 +1,48 @@
+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
+    attribute :value, :string
+    attribute :deprecated, :string
+    attribute :a, AnchorType, collection: true
+    attribute :insert, InsertType, collection: true
+    attribute :br, :string, collection: true
+    attribute :code, CodeType, collection: true
+    attribute :em, InlineMarkupType, collection: true
+    attribute :i, InlineMarkupType, collection: true
+    attribute :b, InlineMarkupType, collection: true
+    attribute :strong, InlineMarkupType, collection: true
+    attribute :sub, InlineMarkupType, collection: true
+    attribute :sup, InlineMarkupType, collection: true
+    attribute :q, InlineMarkupType, collection: true
+    attribute :img, ImageType, collection: true
+
+    xml do
+      root "AllowedValueType"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      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
+    end
+  end
+end

data/lib/metaschema/allowed_values_type.rb

@@ -0,0 +1,35 @@
+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 :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"
+
+      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

@@ -0,0 +1,40 @@
+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
+    attribute :href, :string
+    attribute :title, :string
+    attribute :code, CodeType, collection: true
+    attribute :em, InlineMarkupType, collection: true
+    attribute :i, InlineMarkupType, collection: true
+    attribute :b, InlineMarkupType, collection: true
+    attribute :strong, InlineMarkupType, collection: true
+    attribute :sub, InlineMarkupType, collection: true
+    attribute :sup, InlineMarkupType, collection: true
+    attribute :q, InlineMarkupType, collection: true
+    attribute :img, ImageType, collection: true
+
+    xml do
+      root "anchorType"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      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
+    end
+  end
+end

data/lib/metaschema/any_type.rb

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

data/lib/metaschema/assembly.rb

@@ -0,0 +1,42 @@
+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 :matches, TargetedMatchesConstraintType, 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 :remarks, RemarksType
+
+    xml do
+      root "assembly"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      map_attribute "target", to: :target
+      map_element "let", to: :let
+      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 "is-unique", to: :is_unique
+      map_element "has-cardinality", to: :has_cardinality
+      map_element "remarks", to: :remarks
+    end
+  end
+end

data/lib/metaschema/assembly_model_type.rb

@@ -0,0 +1,34 @@
+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
+    attribute :field, FieldReferenceType, collection: true
+    attribute :define_assembly, InlineAssemblyDefinitionType, collection: true
+    attribute :define_field, InlineFieldDefinitionType, collection: true
+    attribute :choice, ChoiceType, collection: true
+    attribute :choice_group, GroupedChoiceType, collection: true
+    attribute :any, AnyType
+
+    xml do
+      root "AssemblyModelType"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      map_element "assembly", to: :assembly
+      map_element "field", to: :field
+      map_element "define-assembly", to: :define_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

@@ -0,0 +1,40 @@
+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 :deprecated, :string
+    attribute :formal_name, :string
+    attribute :description, MarkupLineDatatype
+    attribute :prop, PropertyType, collection: true
+    attribute :use_name, UseNameType
+    attribute :group_as, GroupAsType
+    attribute :remarks, RemarksType
+
+    xml do
+      root "AssemblyReferenceType"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      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

@@ -0,0 +1,47 @@
+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
+    attribute :h2, InlineMarkupType, collection: true
+    attribute :h3, InlineMarkupType, collection: true
+    attribute :h4, InlineMarkupType, collection: true
+    attribute :h5, InlineMarkupType, collection: true
+    attribute :h6, InlineMarkupType, collection: true
+    attribute :ul, ListType, collection: true
+    attribute :ol, OrderedListType, collection: true
+    attribute :pre, PreformattedType, collection: true
+    attribute :hr, :string, collection: true
+    attribute :blockquote, BlockQuoteType, collection: true
+    attribute :p, InlineMarkupType, collection: true
+    attribute :table, TableType, collection: true
+    attribute :img, ImageType, collection: true
+
+    xml do
+      root "blockQuoteType"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      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

@@ -0,0 +1,25 @@
+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
+    attribute :field, FieldReferenceType, collection: true
+    attribute :define_assembly, InlineAssemblyDefinitionType, collection: true
+    attribute :define_field, InlineFieldDefinitionType, collection: true
+
+    xml do
+      root "ChoiceType"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      map_element "assembly", to: :assembly
+      map_element "field", to: :field
+      map_element "define-assembly", to: :define_assembly
+      map_element "define-field", to: :define_field
+    end
+  end
+end

data/lib/metaschema/code_type.rb

@@ -0,0 +1,45 @@
+require "lutaml/model"
+
+require_relative "anchor_type"
+require_relative "image_type"
+require_relative "inline_markup_type"
+require_relative "insert_type"
+
+module Metaschema
+  class CodeType < Lutaml::Model::Serializable
+    attribute :content, :string
+    attribute :class, :string
+    attribute :a, AnchorType, collection: true
+    attribute :insert, InsertType, collection: true
+    attribute :br, :string, collection: true
+    attribute :code, CodeType, collection: true
+    attribute :em, InlineMarkupType, collection: true
+    attribute :i, InlineMarkupType, collection: true
+    attribute :b, InlineMarkupType, collection: true
+    attribute :strong, InlineMarkupType, collection: true
+    attribute :sub, InlineMarkupType, collection: true
+    attribute :sup, InlineMarkupType, collection: true
+    attribute :q, InlineMarkupType, collection: true
+    attribute :img, ImageType, collection: true
+
+    xml do
+      root "codeType"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      map_content to: :content
+      map_attribute "class", to: :class
+      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/constraint_let_type.rb

@@ -0,0 +1,20 @@
+require "lutaml/model"
+
+require_relative "remarks_type"
+
+module Metaschema
+  class ConstraintLetType < Lutaml::Model::Serializable
+    attribute :var, :string
+    attribute :expression, :string
+    attribute :remarks, RemarksType
+
+    xml do
+      root "ConstraintLetType"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      map_attribute "var", to: :var
+      map_attribute "expression", to: :expression
+      map_element "remarks", to: :remarks
+    end
+  end
+end

data/lib/metaschema/define_assembly_constraints_type.rb

@@ -0,0 +1,40 @@
+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 DefineAssemblyConstraintsType < Lutaml::Model::Serializable
+    attribute :let, ConstraintLetType, collection: true
+    attribute :allowed_values, TargetedAllowedValuesConstraintType, collection: true
+    attribute :matches, TargetedMatchesConstraintType, 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 :remarks, RemarksType
+
+    xml do
+      root "DefineAssemblyConstraintsType"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      map_element "let", to: :let
+      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 "is-unique", to: :is_unique
+      map_element "has-cardinality", to: :has_cardinality
+      map_element "remarks", to: :remarks
+    end
+  end
+end

data/lib/metaschema/define_field_constraints_type.rb

@@ -0,0 +1,31 @@
+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_index_has_key_constraint_type"
+require_relative "targeted_matches_constraint_type"
+
+module Metaschema
+  class DefineFieldConstraintsType < Lutaml::Model::Serializable
+    attribute :let, ConstraintLetType, collection: true
+    attribute :allowed_values, TargetedAllowedValuesConstraintType, collection: true
+    attribute :matches, TargetedMatchesConstraintType, collection: true
+    attribute :index_has_key, TargetedIndexHasKeyConstraintType, collection: true
+    attribute :expect, TargetedExpectConstraintType, collection: true
+    attribute :remarks, RemarksType
+
+    xml do
+      root "DefineFieldConstraintsType"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      map_element "let", to: :let
+      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 "remarks", to: :remarks
+    end
+  end
+end

data/lib/metaschema/define_flag_constraints_type.rb

@@ -0,0 +1,31 @@
+require "lutaml/model"
+
+require_relative "allowed_values_type"
+require_relative "constraint_let_type"
+require_relative "expect_constraint_type"
+require_relative "index_has_key_constraint_type"
+require_relative "matches_constraint_type"
+require_relative "remarks_type"
+
+module Metaschema
+  class DefineFlagConstraintsType < Lutaml::Model::Serializable
+    attribute :let, ConstraintLetType, collection: true
+    attribute :allowed_values, AllowedValuesType, collection: true
+    attribute :matches, MatchesConstraintType, collection: true
+    attribute :index_has_key, IndexHasKeyConstraintType, collection: true
+    attribute :expect, ExpectConstraintType, collection: true
+    attribute :remarks, RemarksType
+
+    xml do
+      root "DefineFlagConstraintsType"
+      namespace "http://csrc.nist.gov/ns/oscal/metaschema/1.0"
+
+      map_element "let", to: :let
+      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 "remarks", to: :remarks
+    end
+  end
+end