lutaml-lml 0.2.1 → 0.3.1

data/lib/lutaml/lml.rb

@@ -2,6 +2,7 @@
 
 require "lutaml/model"
 
+# Root namespace for the LutaML libraries.
 module Lutaml
   class Error < StandardError; end
 
@@ -11,6 +12,10 @@ module Lutaml
   autoload :Formatter, "lutaml/lml/formatter"
   autoload :Layout, "lutaml/lml/layout"
 
+  # LML — the LutaML Model Language: parses the text DSL into domain
+  # documents, compiles model definitions into Serializable classes,
+  # and renders diagrams. See the entry-point contract under .parse /
+  # .parse_document below.
   module Lml
     class Error < Lutaml::Error; end
     class ParsingError < Error; end
@@ -20,15 +25,25 @@ module Lutaml
       ModelCompiler.new(namespace: namespace).compile(input)
     end
 
-    # Full entry point: parse, then resolve view imports and enrich
-    # association labels.
+    # Entry-point contract:
+    #
+    #   parse           — Pipeline (preprocess, parse, transform, build)
+    #                     followed by ViewResolution: view-import
+    #                     expansion, show/hide filtering, and
+    #                     association-label enrichment. Use for
+    #                     documents consumed as diagrams or views.
+    #   parse_document  — Pipeline only; the document keeps raw
+    #                     collections and unresolved imports. Use for
+    #                     machine processing (ModelCompiler, Validator)
+    #                     where view semantics do not apply.
+    #
+    # Both return a Lutaml::Lml::Document.
     def self.parse(input)
       source = Source.wrap(input)
       document = Pipeline.call(source)
       ViewResolution.call(document, source.base_dir)
     end
 
-    # Parse only — no import resolution, no label enrichment.
     def self.parse_document(input)
       Pipeline.call(input)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lutaml-lml
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-10-08 00:00:00.000000000 Z
+date: 2026-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lutaml-model
@@ -108,6 +108,8 @@ files:
 - lib/lutaml/lml/formatter/graphviz/html_builder.rb
 - lib/lutaml/lml/formatter/graphviz/node_formatter.rb
 - lib/lutaml/lml/formatter/graphviz/relationship_formatter.rb
+- lib/lutaml/lml/formatter/svg_pdf.rb
+- lib/lutaml/lml/formatter/svg_pdf/path_parser.rb
 - lib/lutaml/lml/grammar.rb
 - lib/lutaml/lml/grammar/lml.artifact.json
 - lib/lutaml/lml/grammar/lml.parg
@@ -122,6 +124,11 @@ files:
 - lib/lutaml/lml/layout/graph_viz_engine.rb
 - lib/lutaml/lml/literal_value.rb
 - lib/lutaml/lml/model_compiler.rb
+- lib/lutaml/lml/model_compiler/enums.rb
+- lib/lutaml/lml/model_compiler/hydration.rb
+- lib/lutaml/lml/model_compiler/serialization_mappings.rb
+- lib/lutaml/lml/model_compiler/string_formats.rb
+- lib/lutaml/lml/model_compiler/validation.rb
 - lib/lutaml/lml/models/action.rb
 - lib/lutaml/lml/models/association.rb
 - lib/lutaml/lml/models/cardinality.rb