expressir 2.4.11 → 2.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29d1099f121d8528e495476328a9388278187589c0358db455d57e231055a6dc
-  data.tar.gz: 6cadd85e6d2b1184ff1cc53883857698f5c3b0d8985ac2f6f962986ceeb84326
+  metadata.gz: 76901fb66e21e9752a5ba64f7b80c23e92a7fa54fac6df80ba221d46bee358e3
+  data.tar.gz: d02e64ac60b0b670f31f665e3834553e29dfd8abc9f7ff51c22bc33dbafcbe11
 SHA512:
-  metadata.gz: 82bd2f4cd92180180f6c9b831dd0964950cc8be5a71e51bd5e737a6538289dad0a7e7b0e91902e6462f7df5aa6878fa0b6ec58c99b019a88e8e8145322eec935
-  data.tar.gz: 6c60ea124de34b72f42107538fce8d527488361957eeec4b42e0b7a1b769ac2e4254e17f292fd1be151902ee8a0dab2328d583c71e9290582019f28fc92987ac
+  metadata.gz: c6c20c797b67efe96bf149207c2283b6e8ba3054e17feda55630fbccf92d337bdfc3322c0a77408262bf1066a60a30b2f137c5f2d4f5a62f78bcea69f818e567
+  data.tar.gz: 39f8f5f287a3d01df2f84cc3667afc00632de391415f9b6aad21538623f167330de9ea3b8857ebe25490d946113d7a85637b5884625ec445b52d3d4a2663b214

data/README.adoc

@@ -215,6 +215,8 @@ Commands:
   expressir flatten PATH                       # Flatten the interface closure into an ISO 10303-11:1994 longform schema
   expressir fix PATH                           # Rewrite self-schema-qualified references (#125)
   expressir format PATH                        # pretty print EXPRESS schema located at PATH
+  expressir mapping_validate PATH              # Validate <<express:...>> links in a module mapping.yaml against its ARM/MIM closure
+  expressir xsd PATH -o OUT.xsd                # Write an XML Schema rendering of the EXPRESS schema at PATH
   expressir help [COMMAND]                     # Describe available commands or one specific command
   expressir validate load *PATH                # validate EXPRESS schema located at PATH
   expressir validate ascii PATH                # Validate EXPRESS files for ASCII-only content (excluding remarks)
@@ -1266,7 +1268,38 @@ The default text output displays:
 This helps identify areas of your EXPRESS schemas that need documentation
 improvement.
 
-=== EXPRESS Changes files
+=== Schema hyperlinked source faces
+
+`Schema#source`, `Schema#source_hyperlinked`, and
+`Schema#formatted_hyperlinked(_adoc)` render a schema head or the full
+schema with cross-references either verbatim or as links (the adoc
+variant emits `<<schema.item,item>>` xref macros — render inside a
+`[source,subs="+macros"]` block for live links; see the
+`Expressir::Express::SmrlXml` and `Expressir::Express::Xsd` writers
+for the XML faces).
+
+== MIM mapping validation (mapping.yaml)
+
+`expressir mapping_validate PATH` loads a module `mapping.yaml`
+(lutaml-model typed: `Expressir::Mapping::Document`) and resolves every
+`<<express:SCHEMA.ITEM,ITEM>>` link against the ARM/MIM interface
+closure, reporting links whose schema or item is unknown.
+
+== XML faces
+
+- `Expressir::Express::SmrlXml.format(repository)` — the SMRL index
+  block per schema (eeng wo-smrl-xml shape).
+- `Expressir::Express::Xsd.format(schema)` — an XML Schema rendering
+  (entities as element/complexType, substitutionGroup for subtypes,
+  enumeration facets).
+
+== Lazy compiled-set access
+
+`Expressir::Express::Core.lazy_set(artifact)` lists a compiled set's
+wire paths without hydrating and hydrates individual files on demand —
+renderers that touch one schema per page hydrate one schema per page.
+
+== EXPRESS Changes files
 
 Expressir provides commands for working with EXPRESS Changes files that track
 schema modifications across versions.

data/ext/expressir_core/src/lib.rs

@@ -304,6 +304,45 @@ fn set_count(_ruby: &Ruby, reader: &SetReader) -> usize {
     reader.set.files.len()
 }
 
+/// Every wire path in the artifact, in artifact order — no hydration.
+fn set_wire_paths(_ruby: &Ruby, reader: &SetReader) -> Result<magnus::Value, Error> {
+    let paths = RArray::with_capacity(reader.set.files.len());
+    for file in &reader.set.files {
+        paths.push(ruby_str(_ruby, &file.wire_path))?;
+    }
+    Ok(paths.as_value())
+}
+
+fn ruby_str(ruby: &Ruby, s: &str) -> magnus::Value {
+    ruby.str_new(s).as_value()
+}
+
+/// `[wire_path, model]` for ONE file, addressed by wire path — the
+/// lazy-access path (M2): callers hydrate only the schemas a render
+/// touches instead of the whole set.
+fn set_hydrate_one(ruby: &Ruby, reader: &SetReader, wire_path: String) -> Result<magnus::Value, Error> {
+    let file = reader
+        .set
+        .files
+        .iter()
+        .find(|f| f.wire_path == wire_path)
+        .ok_or_else(|| {
+            Error::new(
+                ruby.exception_runtime_error(),
+                format!("wire path {wire_path} not in compiled set"),
+            )
+        })?;
+    let wire = file.wire().map_err(|e| {
+        Error::new(ruby.exception_runtime_error(), format!("{}: {e}", file.wire_path))
+    })?;
+    let mut cache = reader.cache.lock().expect("class cache");
+    let model = value_to_ruby(ruby, &mut cache, &wire)?;
+    let pair = RArray::with_capacity(2);
+    pair.push(ruby.str_new(&file.wire_path))?;
+    pair.push(model)?;
+    Ok(pair.as_value())
+}
+
 /// `[wire_path, model]` for the next file in artifact order, nil at
 /// the end.
 fn set_next(ruby: &Ruby, reader: &SetReader) -> Result<magnus::Value, Error> {
@@ -441,6 +480,8 @@ fn init(ruby: &Ruby) -> Result<(), Error> {
     set_class.define_method("digest", method!(set_digest, 0))?;
     set_class.define_method("count", method!(set_count, 0))?;
     set_class.define_method("next", method!(set_next, 0))?;
+    set_class.define_method("wire_paths", method!(set_wire_paths, 0))?;
+    set_class.define_method("hydrate_one", method!(set_hydrate_one, 1))?;
     set_class.define_method("matches_sources", method!(set_matches_sources, 1))?;
     Ok(())
 }

data/lib/expressir/cli.rb

@@ -99,6 +99,18 @@ module Expressir
       Expressir::Commands::BenchmarkCache.new(options).run(path)
     end
 
+    desc "mapping_validate PATH", "Validate <<express:...>> links in a module mapping.yaml against its ARM/MIM closure"
+    def mapping_validate(path)
+      Expressir::Commands::MappingValidate.new(options).run(path)
+    end
+
+    desc "xsd PATH", "Write an XML Schema rendering of the EXPRESS schema at PATH"
+    method_option :output, type: :string, aliases: "-o",
+                           desc: "Output file path (defaults to stdout)"
+    def xsd(path)
+      Expressir::Commands::Xsd.new(options).run(path)
+    end
+
     desc "validate SUBCOMMAND", "EXPRESS schema validation commands"
     subcommand "validate", Expressir::Commands::Validate
 

data/lib/expressir/commands/mapping_validate.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Expressir
+  module Commands
+    # `expressir mapping validate` (#88): load a module mapping.yaml
+    # and resolve every <<express:...>> link against the ARM/MIM
+    # interface closure. Exits 1 when unknown links remain.
+    class MappingValidate < Base
+      def run(path)
+        document = Expressir::Mapping.load_file(path)
+        unknown = Expressir::Mapping.unknown_links(document, repository_for(path))
+
+        if unknown.empty?
+          say "all links resolve"
+          return
+        end
+
+        unknown.each do |link|
+          say "unknown: #{link.text}"
+        end
+        raise Thor::Error, "#{unknown.size} unknown link(s)"
+      end
+
+      private
+
+      def repository_for(path)
+        dir = File.dirname(File.expand_path(path))
+        arm = Dir[File.join(dir, "arm.exp")].first
+        mim = Dir[File.join(dir, "mim.exp")].first
+        roots = [arm, mim].compact
+        raise Thor::Error, "no arm.exp/mim.exp next to #{path}" if roots.empty?
+
+        files = roots.flat_map do |root|
+          ParityInputs.closure_paths(root)
+        end.uniq.select { |f| File.exist?(f) }
+        Expressir::Express::Parser.from_files(files)
+      end
+    end
+  end
+end

data/lib/expressir/commands/xsd.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Expressir
+  module Commands
+    # `expressir xsd` (#276): write the XML Schema rendering of the
+    # schema at PATH.
+    class Xsd < Base
+      def run(path)
+        repo = Expressir::Express::Parser.from_file(path)
+        schema = repo.schemas.first
+        raise Thor::Error, "no schema in #{path}" unless schema
+
+        xml = Expressir::Express::Xsd.format(schema)
+        if options[:output]
+          File.write(options[:output], xml)
+          say "written to #{options[:output]}"
+        else
+          $stdout.write(xml)
+        end
+      end
+    end
+  end
+end

data/lib/expressir/commands.rb

@@ -24,5 +24,7 @@ module Expressir
     autoload :Version, "#{__dir__}/commands/version"
     autoload :Package, "#{__dir__}/commands/package"
     autoload :Manifest, "#{__dir__}/commands/manifest"
+    autoload :MappingValidate, "#{__dir__}/commands/mapping_validate"
+    autoload :Xsd, "#{__dir__}/commands/xsd"
   end
 end

data/lib/expressir/express/core.rb

@@ -43,6 +43,24 @@ module Expressir
         ::Expressir::Core.parse_to_model(source, path)
       end
 
+      # Lazy handle over a compiled-set artifact (M2): `wire_paths`
+      # lists the set's files without hydrating anything; `hydrate_one`
+      # builds a single file's model on demand. Renderers that touch
+      # one schema per page hydrate one schema per page instead of the
+      # whole repository.
+      def self.lazy_set(path)
+        unless NATIVE_AVAILABLE
+          raise NotImplementedError,
+                "lazy set unavailable without the native extension"
+        end
+        unless ::Expressir::Core.const_defined?(:Set) &&
+            ::Expressir::Core::Set.method_defined?(:hydrate_one)
+          raise NotImplementedError, "lazy set unavailable; ext too old"
+        end
+
+        ::Expressir::Core::Set.open(path)
+      end
+
       # Compile many files concurrently: jobs are [read_path,
       # wire_path] pairs; the block receives (wire_path, model, error)
       # per job in completion order. Workers run on native threads, so

data/lib/expressir/version.rb

@@ -3,6 +3,6 @@ module Expressir
   # autoload it (Ruby autoload only works for module/class constants, not
   # for string constants like `Expressir::VERSION`).
   module Version
-    VERSION = "2.4.11".freeze
+    VERSION = "2.4.12".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: expressir
 version: !ruby/object:Gem::Version
-  version: 2.4.11
+  version: 2.4.12
 platform: ruby
 authors:
 - Ribose Inc.
@@ -425,6 +425,7 @@ files:
 - lib/expressir/commands/flatten.rb
 - lib/expressir/commands/format.rb
 - lib/expressir/commands/manifest.rb
+- lib/expressir/commands/mapping_validate.rb
 - lib/expressir/commands/non_ascii_character.rb
 - lib/expressir/commands/non_ascii_violation_collection.rb
 - lib/expressir/commands/package.rb
@@ -433,6 +434,7 @@ files:
 - lib/expressir/commands/validate_ascii.rb
 - lib/expressir/commands/validate_load.rb
 - lib/expressir/commands/version.rb
+- lib/expressir/commands/xsd.rb
 - lib/expressir/config.rb
 - lib/expressir/coverage.rb
 - lib/expressir/eengine.rb