metanorma-plugin-lutaml 0.7.23 → 0.7.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86941bc530959fd2a6023671bfac6d46e18ac1095db5903b67b3be22f411372d
-  data.tar.gz: f4cbcf8affd7ffffb7773ad3a9e7c6d008d176dfe3a507a2ba146cd38ba57e88
+  metadata.gz: ca6fb652af0690c22f2677cfe39f2546cecf24a46f539fe190b5d56023d942da
+  data.tar.gz: 99b7de7844b8e9f3e2fce736f7c931a8dd2a5b1c95bf93b57520b3261f5c2b3e
 SHA512:
-  metadata.gz: 3a2dc0a28276e48230002049ba5946821c81d231be38494f978e5ad7298836b3ea1852be10314a8cfe7a86f775a097407c67a541f6f3c633e4a1dc32d6206702
-  data.tar.gz: 0eda7cedc08c10bb6b0da49cfabb0f72e6a3a22355b784d9f633217be0f7bdec1946fe269deeb7d460a468f91d7004cc08df747018217239580e2d8566337791
+  metadata.gz: 754f952fbbad357aab40b9ab7e6d53af6e8195a797f8d3d4086265cfbb5d0360502b5f03bb68ce0ef02eeb51ff457931116e586273c60e2186fab49103dd33cc
+  data.tar.gz: '08cf1a352e910912d8d1c4323f5336e1e05da8fb30746a730ebd830e85e5adc07c55b23f8a01c048f4781de2b85f9295940c383b3057c2d502ec16fd0bef9745'

data/Gemfile

@@ -11,3 +11,17 @@ begin
 rescue StandardError
   nil
 end
+
+gem "debug"
+gem "equivalent-xml"
+gem "metanorma-standoc"
+gem "rake"
+gem "rspec"
+gem "rspec-html-matchers"
+gem "rubocop"
+gem "rubocop-performance"
+gem "simplecov"
+gem "timecop"
+gem "vcr"
+gem "webmock"
+gem "xml-c14n"

data/README.adoc

@@ -300,6 +300,25 @@ via Liquid:
 NOTE: This functionality is used in the ISO 10303 SRL to load the full schema
 set at once but only render the selected schemas in individual documents.
 
+=== Using `include_path`
+
+This functionality allows `[lutaml_express_liquid]` blocks to load templates
+from the paths other than the location of the document.
+
+[source,adoc]
+-----
+:lutaml-express-index: all_schemas; ../schemas_all.yaml;
+
+[lutaml_express_liquid,all_schemas,context,config_yaml=schemas.yaml,include_path=../templates]
+---
+{% assign selected = context.schemas | where: "selected" %}
+{% render "templates/resources/schema" for selected as schema %}
+----
+-----
+
+The resulting block adds the `include_path` to the Liquid renderer.  The path is
+resolved based on the location of the document.  You can add multiple paths by
+separating them with commas.
 
 == Usage with Lutaml-UML
 
@@ -871,7 +890,9 @@ that specifies:
 * What render style is desired;
 
 * Location of the root package (which package should the iterative process start
-  at).
+  at);
+
+* Which EA extensions to be loaded.
 
 The format for using the YAML configuration file:
 
@@ -887,6 +908,9 @@ packages:
   - skip: four
 render_style: entity_list | data_dictionary | default
 section_depth: 2
+ea_extension:
+  - "CityGML_MDG_Technology.xml"
+  - "xmi_definition_for_some_standard.xml"
 ----
 
 Where:
@@ -929,6 +953,12 @@ equal to 2, root package will be `one-1`.
 ]
 ----
 
+* `ea_extension` - optional, list of EA extensions to load. Some XMI files may
+contain elements that cannot be resolved by default, for example CityGML
+elements.  You can use `ea_extension` to load the definition of these elements
+in XML format (`CityGML_MDG_Technology.xml`) in order to resolve them.  The
+location of the xml files is relative to the config YAML file.
+
 Usage with command:
 
 [source,adoc]

data/lib/metanorma/plugin/lutaml/lutaml_preprocessor.rb

@@ -105,10 +105,11 @@ module Metanorma
         def gather_context_liquid_items( # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/ParameterLists
           index_names:, document:, indexes:, options: {}
         )
-          index_names.map do |path|
-            if indexes[path]
-              indexes[path][:liquid_drop] ||=
-                indexes[path][:model].to_liquid(options: options)
+          index_names.map do |path| # rubocop:disable Metrics/BlockLength
+            if indexes[path] && indexes[path][:model]
+              repo = indexes[path][:model]
+              repo = update_repo(options, repo)
+              indexes[path][:liquid_drop] ||= repo.to_liquid
             else
               full_path = Utils.relative_file_path(document, path)
               unless File.file?(full_path)
@@ -118,9 +119,10 @@ module Metanorma
                   "the full path.",
                 )
               end
-              express_model = load_express_lutaml_file(document, path)
+              repo = load_express_lutaml_file(document, path)
+              repo = update_repo(options, repo)
               indexes[path] = {
-                liquid_drop: express_model.to_liquid(options: options),
+                liquid_drop: repo.to_liquid,
               }
             end
 
@@ -128,7 +130,63 @@ module Metanorma
           end
         end
 
-        def read_config_yaml_file(document, file_path) # rubocop:disable Metrics/MethodLength
+        def update_repo(options, repo)
+          # Unwrap repo if it's a cache
+          repo = repo.content if repo.is_a? Expressir::Model::Cache
+
+          # Process each schema
+          repo.schemas.each do |schema|
+            update_schema_selection(schema, options)
+            options["relative_path_prefix"] =
+              relative_path_prefix(options, schema)
+            update_schema_remarks(schema, options)
+          end
+
+          repo
+        end
+
+        def update_schema_selection(schema, options)
+          return unless options["selected_schemas"]
+
+          schema.selected = options["selected_schemas"].include?(schema.file_basename) ||
+            options["selected_schemas"].include?(schema.id)
+        end
+
+        def update_schema_remarks(schema, options)
+          # Update schema-level remarks
+          schema.remarks = decorate_remarks(options, schema.remarks)
+
+          # Update remark items
+          return unless schema.remark_items
+
+          schema.remark_items.each do |ri|
+            ri.remarks = decorate_remarks(options, ri.remarks)
+          end
+        end
+
+        def relative_path_prefix(options, model)
+          return nil if options.nil? || options["document"].nil?
+
+          document = options["document"]
+          file_path = File.dirname(model.file)
+          docfile_directory = File.dirname(
+            document.attributes["docfile"] || ".",
+          )
+          document
+            .path_resolver
+            .system_path(file_path, docfile_directory)
+        end
+
+        def decorate_remarks(options, remarks)
+          return [] unless remarks
+
+          remarks.map do |remark|
+            ::Expressir::Express::ExpressRemarksDecorator
+              .call(remark, options)
+          end
+        end
+
+        def read_config_yaml_file(document, file_path)
           return {} if file_path.nil?
 
           relative_file_path = Utils.relative_file_path(document, file_path)
@@ -136,29 +194,24 @@ module Metanorma
             File.read(relative_file_path, encoding: "UTF-8"),
           )
 
-          options = {}
-          if config_yaml["schemas"]
-            unless config_yaml["schemas"].is_a?(Hash)
-              raise StandardError.new(
-                "[lutaml_express_liquid] attribute `config_yaml` must point " \
-                "to a YAML file that has the `schema` key containing a hash.",
-              )
-            end
+          return {} unless config_yaml["schemas"]
 
-            options["selected_schemas"] = config_yaml["schemas"].keys
+          unless config_yaml["schemas"].is_a?(Hash)
+            raise StandardError.new(
+              "[lutaml_express_liquid] attribute `config_yaml` must point " \
+              "to a YAML file that has the `schemas` key containing a hash.",
+            )
           end
 
-          options
+          { "selected_schemas" => config_yaml["schemas"].keys }
         end
 
         def render_liquid_template(document:, lines:, context_name:, # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/ParameterLists
-index_names:, options:, indexes:)
-          config_yaml_path = options.delete("config_yaml")
-          config = read_config_yaml_file(document, config_yaml_path)
-          if config["selected_schemas"]
-            options["selected_schemas"] = config["selected_schemas"]
-          end
+                      index_names:, options:, indexes:)
+          # Process options and configuration
+          options = process_options(document, options)
 
+          # Get all context items in one go
           all_items = gather_context_liquid_items(
             index_names: index_names,
             document: document,
@@ -166,19 +219,23 @@ index_names:, options:, indexes:)
             options: options.merge("document" => document),
           )
 
-          # Allow includes for the template
-          include_paths = [
-            Utils.relative_file_path(document, ""),
-            options["include_path"],
-          ].compact
+          # Setup include paths for liquid templates
+          include_paths = [Utils.relative_file_path(document, "")]
+          options["include_path"]&.split(",")&.each do |path|
+            # resolve include_path relative to the document
+            include_paths.push(Utils.relative_file_path(document, path))
+          end
+
+          file_system = ::Metanorma::Plugin::Lutaml::Liquid::LocalFileSystem
+            .new(include_paths, ["%s.liquid", "_%s.liquid", "_%s.adoc"])
 
+          # Parse template once outside the loop
+          template = ::Liquid::Template.parse(lines.join("\n"))
+          template.registers[:file_system] = file_system
+
+          # Render for each item
           all_items.map do |item|
-            repo_drop = item[:liquid_drop]
-            template = ::Liquid::Template.parse(lines.join("\n"))
-            template.registers[:file_system] =
-              ::Metanorma::Plugin::Lutaml::Liquid::LocalFileSystem
-                .new(include_paths, ["%s.liquid", "_%s.liquid", "_%s.adoc"])
-            template.assigns[context_name] = repo_drop
+            template.assigns[context_name] = item[:liquid_drop]
             template.render
           end.flatten
         rescue StandardError => e
@@ -186,10 +243,21 @@ index_names:, options:, indexes:)
             "[LutamlPreprocessor] Failed to parse LutaML block: #{e.message}",
             :error,
           )
-          # [] # Return empty array to avoid breaking the document
           raise e
         end
 
+        def process_options(document, options)
+          # Process config file if specified
+          if (config_yaml_path = options.delete("config_yaml"))
+            config = read_config_yaml_file(document, config_yaml_path)
+            if config["selected_schemas"]
+              options["selected_schemas"] =
+                config["selected_schemas"]
+            end
+          end
+          options
+        end
+
         def parse_options(options_string)
           options_string
             .to_s

data/lib/metanorma/plugin/lutaml/version.rb

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Lutaml
-      VERSION = "0.7.23".freeze
+      VERSION = "0.7.24".freeze
     end
   end
 end

data/metanorma-plugin-lutaml.gemspec

@@ -27,23 +27,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor"
   spec.add_dependency "coradoc", "~> 1.1.1"
-  spec.add_dependency "expressir", "~> 2.1.11"
+  spec.add_dependency "expressir", "~> 2.1.13"
   spec.add_dependency "liquid"
   spec.add_dependency "lutaml", "~> 0.9.25"
-  spec.add_dependency "ogc-gml", "1.0.0"
+  spec.add_dependency "ogc-gml", "~>1.0.0"
   spec.add_dependency "relaton-cli"
-
-  spec.add_development_dependency "debug"
-  spec.add_development_dependency "equivalent-xml"
-  spec.add_development_dependency "metanorma-standoc", "~> 3.0"
-  spec.add_development_dependency "rake", "~> 13"
-  spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rspec-html-matchers"
-  spec.add_development_dependency "rubocop", "~> 1.58"
-  spec.add_development_dependency "rubocop-performance", "~> 1.19"
-  spec.add_development_dependency "simplecov", "~> 0.15"
-  spec.add_development_dependency "timecop", "~> 0.9"
-  spec.add_development_dependency "vcr", "~> 5.0.0"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "xml-c14n"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.23
+  version: 0.7.24
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-14 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.11
+        version: 2.1.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.11
+        version: 2.1.13
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +84,14 @@ dependencies:
   name: ogc-gml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
@@ -108,188 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: equivalent-xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: metanorma-standoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: rspec-html-matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.58'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.58'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.19'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.19'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: xml-c14n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Metanorma plugin for LutaML
 email:
 - open.source@ribose.com
@@ -303,10 +121,8 @@ files:
 - ".hound.yml"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
-- Dockerfile
 - Gemfile
 - LICENSE
-- Makefile
 - README.adoc
 - Rakefile
 - bin/console

data/Dockerfile

@@ -1,4 +0,0 @@
-FROM ruby:2.6
-COPY . .
-RUN gem install bundler:2.1.4
-RUN bundle install

data/Makefile

@@ -1,2 +0,0 @@
-fix-lint-staged:
-	git status --short | egrep '^(A|M)' | awk '{ print $$2}' | grep -v db/schema.rb | xargs bundle exec rubocop -a