metanorma-plugin-lutaml 0.7.19 → 0.7.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d95bbbcc424c384a0c2d58374f647eda5e6efc60278c7a2e69b6eefec2e8b012
-  data.tar.gz: 00b430d79891b1f9143186a3af2a5eddabe01c8f89f77431b494908164c67bcb
+  metadata.gz: 7aeee60e0c387e0cd418623ff3c351097286d574235e6846e107f89d044b4342
+  data.tar.gz: 5010ee69d52a4ba1d06169224c876734111e9d035aa510565593a67bb997b0f5
 SHA512:
-  metadata.gz: 2f07e00a438eb808adda1c72985a15e5fca581e2afeff305acc78164cf698ec6942c57da3863b767f2551ede925fc8b1eb804977665ff15d07204bb4bf637a60
-  data.tar.gz: 9840d71a72679997ec0d6f9c11139c063a843cb1fa3f1920e7a770505d3357b026cde3e67270d8b216fefbeb0f6bfbd595b57e85007896490164f377ed27f2b3
+  metadata.gz: f0e6eade28bb226a39bb2af4adcf45aeb4ed5dbd61385224cfa4c74946990a25da00ce97083fca98903fcaeae4259a0ed20861b6372d81d128e9befa9f36a129
+  data.tar.gz: 762f6d288c6dad65aa3e9f73ba1c0185cb93c4af0308d8816f4c672f9d297d7ab764c32f3c6f6ed2b437bae3a5e355407267ac52447a7e6573e3eaaeb6387b50

data/README.adoc

@@ -295,7 +295,7 @@ via Liquid:
 {% assign selected = repo.schemas | where: "selected" %}
 ... do things with `selected` ...
 ---
------
+----
 
 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.
@@ -374,155 +374,6 @@ diagram MyView {
 ....
 ----
 
-=== Generating a UML class and attributes clause: `lutaml_uml_class`
-
-This command allows rendering a definition clause for a UML class.
-
-Given `example.lutaml` with this content:
-
-[source,java]
-----
-class Register {
-  definition {
-    A register of information.
-  }
-
-  identifier: String[1] {
-    definition {
-      Unique identifier of the register.
-    }
-  }
-
-  concepts: Concept[0..*] {
-    definition {
-      Concepts.
-    }
-  }
-}
-----
-
-The command:
-
-[source,adoc]
-----
-[lutaml_uml_class,views/Register_Register.lutaml,Register]
-----
-
-Will produce this output:
-
-____
-== Register
-
-A register of information.
-
-=== Attributes
-
-==== identifier
-
-Unique identifier of the register.
-
-.Specification of `Register.identifier`
-|===
-h|Value type and multiplicity	| `String [1]`
-|===
-
-==== concepts
-
-Concepts.
-
-.Specification of `Register.concepts`
-|===
-h|Value type and multiplicity	| `Concepts [0..*]`
-|===
-
-____
-
-The command accepts two options:
-
-`skip_headers=true`:: (or just `skip_headers`) The initial heading (the UML class name)
-will not be generated. This is useful if additional content is to be supplied
-to the clause, such as diagrams that are defined outside the UML model.
-
-`depth={n}`:: (default: `2`) This determines the depth of the generated headings.
-A depth of `2` means the initial heading will have 2 equal signs, and so forth.
-The heading depth of the attributes are in relation to the initial depth, so
-a depth of `2` will have the "Attributes" section at depth `3`.
-
-
-=== Generating a UML attributes table: `lutaml_uml_attributes_table`
-
-This command allows rendering definition tables for a UML model.
-
-Given `example.lutaml` file with the content:
-
-[source,java]
-----
-diagram MyView {
-  title "my diagram"
-
-  enum AddressClassProfile {
-    imlicistAttributeProfile: CharacterString [0..1] {
-      definition
-        this is multiline with `ascidoc`
-      end definition
-    }
-  }
-
-  class AttributeProfile {
-    +addressClassProfile: CharacterString [0..1]
-    imlicistAttributeProfile: CharacterString [0..1] {
-      definition this is attribute definition
-    }
-  }
-}
-----
-
-And the `lutaml_uml_attributes_table` command:
-
-[source,adoc]
-----
-[lutaml_uml_attributes_table, example.lutaml, AttributeProfile]
-----
-
-Will produce this output:
-
-____
-=== AttributeProfile
-
-.AttributeProfile attributes
-|===
-|Name |Definition |Mandatory/ Optional/ Conditional |Max Occur |Data Type
-
-|addressClassProfile |TODO: enum's definition |M |1 | `CharacterString`
-
-|imlicistAttributeProfile |this is attribute definition with multiply lines |M |1 | `CharacterString`
-
-|===
-____
-
-
-In case of "enumeration" (AddressClassProfile) entity:
-
-[source,adoc]
-----
-[lutaml_uml_attributes_table, example.lutaml, AddressClassProfile]
-----
-
-Will produce this output:
-
-____
-=== AddressClassProfile
-
-.AddressClassProfile values
-|===
-|Name |Definition
-
-|imlicistAttributeProfile |this is multiline with `asciidoc`
-
-|===
-____
-
-
 == Usage with Enterprise Architect (UML in XMI)
 
 === General

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

@@ -177,9 +177,18 @@ 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
+
           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.render
           end.flatten

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

@@ -14,7 +14,7 @@ module Metanorma
   module Plugin
     module Lutaml
       #  Macro for quick rendering of datamodel attributes/values table
-      #  @example [lutaml_uml_attributes_table,path/to/lutaml,EntityName]
+      # TODO: merge with lutaml_ea_xmi
       class LutamlUmlDatamodelDescriptionPreprocessor <
           ::Asciidoctor::Extensions::Preprocessor
         include LutamlEaXmiBase
@@ -24,8 +24,11 @@ module Metanorma
 
         private
 
-        def parse_result_document(full_path, _guidance = nil)
-          ::Lutaml::Parser.parse(File.new(full_path, encoding: "UTF-8")).first
+        def parse_result_document(full_path, guidance)
+          ::Lutaml::XMI::Parsers::XML.serialize_xmi_to_liquid(
+            File.new(full_path, encoding: "UTF-8"),
+            guidance,
+          )
         end
       end
     end

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

@@ -41,7 +41,7 @@ module Metanorma
 
           liquid_template.registers[:file_system] =
             ::Metanorma::Plugin::Lutaml::Liquid::LocalFileSystem
-              .new(include_paths, ["_%s.liquid", "_%s.adoc"])
+              .new(include_paths, ["%s.liquid", "_%s.liquid", "_%s.adoc"])
 
           rendered_string = liquid_template
             .render(context_name => context_items,

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

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

data/lib/metanorma-plugin-lutaml.rb

@@ -1,7 +1,5 @@
 require "metanorma/plugin/lutaml/version"
 require "metanorma/plugin/lutaml/lutaml_preprocessor"
-require "metanorma/plugin/lutaml/lutaml_uml_class_preprocessor"
-require "metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_ea_xmi_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_diagram_block"

data/metanorma-plugin-lutaml.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml"
-  spec.add_development_dependency "metanorma-standoc"
+  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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.19
+  version: 0.7.21
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-05 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -140,16 +140,16 @@ dependencies:
   name: metanorma-standoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -343,8 +343,6 @@ files:
 - lib/metanorma/plugin/lutaml/lutaml_klass_table_block_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_preprocessor.rb
 - lib/metanorma/plugin/lutaml/lutaml_table_inline_macro.rb
-- lib/metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor.rb
-- lib/metanorma/plugin/lutaml/lutaml_uml_class_preprocessor.rb
 - lib/metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor.rb
 - lib/metanorma/plugin/lutaml/utils.rb
 - lib/metanorma/plugin/lutaml/version.rb

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require "metanorma/plugin/lutaml/asciidoctor/preprocessor"
-
-module Metanorma
-  module Plugin
-    module Lutaml
-      #  Macro for quick rendering of datamodel attributes/values table
-      #  @example [lutaml_uml_attributes_table,path/to/lutaml,EntityName]
-      class LutamlUmlAttributesTablePreprocessor < LutamlUmlClassPreprocessor
-        MACRO_REGEXP =
-          /\[lutaml_uml_attributes_table,([^,]+),?([^,]+),?(.+?)?\]/.freeze
-
-        # rubocop:disable Layout/IndentHeredoc
-        def template(options)
-          skip_headers = options[:skip_headers]
-
-          <<~TEMPLATE
-            #{'=== {{ definition.name }}' unless skip_headers}
-            {{ definition.definition }}
-
-            {% if definition.attributes %}
-            {% if definition.keyword == 'enumeration' %}
-            .{{ definition.name }} values
-            |===
-            |Name |Definition
-
-            {% for item in definition.attributes %}
-            |{{ item.name }} |{{ item.definition }}
-            {% endfor %}
-            |===
-            {% else %}
-            .{{ definition.name }} attributes
-            |===
-            |Name |Definition |Mandatory / Optional / Conditional |Max Occur |Data Type
-
-            {% for item in definition.attributes %}
-            |{{ item.name }} |{% if item.definition %}{{ item.definition }}{% endif %} |{% if item.cardinality.min == "0" %}O{% else %}M{% endif %} |{% if item.cardinality.max == "*" %}N{% else %}1{% endif %} |{% if item.origin %}<<{{ item.origin }}>>{% endif %} `{{ item.type }}`
-            {% endfor %}
-            |===
-            {% endif %}
-            {% endif %}
-
-          TEMPLATE
-        end
-        # rubocop:enable Layout/IndentHeredoc
-      end
-    end
-  end
-end

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

@@ -1,168 +0,0 @@
-# frozen_string_literal: true
-
-require "liquid"
-require "asciidoctor"
-require "asciidoctor/reader"
-require "lutaml"
-require "lutaml/uml"
-require "metanorma/plugin/lutaml/utils"
-require "metanorma/plugin/lutaml/asciidoctor/preprocessor"
-
-module Metanorma
-  module Plugin
-    module Lutaml
-      #  Macro for quick rendering of datamodel attributes/values table
-      #  @example [lutaml_uml_class,path/to/lutaml,EntityName]
-      class LutamlUmlClassPreprocessor < ::Asciidoctor::Extensions::Preprocessor
-        MACRO_REGEXP =
-          /\[lutaml_uml_class,([^,]+),?([^,]+),?(.+?)?\]/.freeze
-
-        def get_macro_regexp
-          self.class.const_get(:MACRO_REGEXP)
-        end
-
-        # search document for block `datamodel_attributes_table`
-        #  read include derectives that goes after that in block and transform
-        #  into yaml2text blocks
-        def process(document, reader)
-          r = Asciidoctor::PreprocessorNoIfdefsReader.new document, reader.lines
-          input_lines = r.readlines.to_enum
-          Asciidoctor::PreprocessorNoIfdefsReader
-            .new(document, processed_lines(document, input_lines))
-        end
-
-        private
-
-        def lutaml_document_from_file(document, file_path)
-          ::Lutaml::Parser.parse(
-            File.new(
-              Utils.relative_file_path(document, file_path),
-              encoding: "UTF-8",
-            ),
-          ).first
-        end
-
-        DEFAULT_OPTIONS = { depth: 2 }.freeze
-
-        def parse_options_to_hash(options_string)
-          return DEFAULT_OPTIONS.dup if options_string.nil? ||
-            options_string.empty?
-
-          opts = options_string.split(",").inject({}) do |acc, pair|
-            key, value = pair.split("=")
-            key = key.to_sym
-            value = true if value.nil?
-            value = value.to_i if key == :depth
-            acc[key] = value if key
-            acc
-          end
-
-          DEFAULT_OPTIONS.dup.merge(opts)
-        end
-
-        def processed_lines(document, input_lines)
-          input_lines.each_with_object([]) do |line, result|
-            if match = line.match(get_macro_regexp)
-              lutaml_path = match[1]
-              entity_name = match[2]
-              options = parse_options_to_hash(match[3])
-
-              result.push(*parse_macro(lutaml_path, entity_name, document,
-                                       options))
-            else
-              result.push(line)
-            end
-          end
-        end
-
-        def parse_macro(lutaml_path, entity_name, document, options)
-          lutaml_document = lutaml_document_from_file(document, lutaml_path)
-            .serialized_document
-          entities = [lutaml_document["classes"], lutaml_document["enums"]]
-            .compact
-            .flatten
-          entity_definition = entities.detect do |klass|
-            klass["name"] == entity_name.strip
-          end
-          model_representation(entity_definition, document, options)
-        end
-
-        def model_representation(entity_definition, document, options)
-          render_result, errors = Utils.render_liquid_string(
-            template_string: template(options),
-            context_items: entity_definition,
-            context_name: "definition",
-            document: document,
-          )
-          Utils.notify_render_errors(document, errors)
-          render_result.split("\n")
-        end
-
-        def equalsigns(depth)
-          "=" * depth
-        end
-
-        # rubocop:disable Layout/IndentHeredoc
-        def template(options)
-          skip_headers = options[:skip_headers]
-          depth = options[:depth]
-
-          <<~TEMPLATE
-            {% if definition.keyword == 'enumeration' %}
-            #{"#{equalsigns(depth)} Enumeration: {{ definition.name }}" unless skip_headers}
-            {% else %}
-            #{"#{equalsigns(depth)} Class: {{ definition.name }}" unless skip_headers}
-            {% endif %}
-
-            #{equalsigns(depth + 1)} Description
-
-            {{ definition.definition }}
-
-            {% if definition.attributes %}
-            {% if definition.keyword == 'enumeration' %}
-            {% for item in definition.attributes %}
-            #{equalsigns(depth + 1)} Enumeration value: {{item.name}}
-
-            {% if item.definition %}
-            {{ item.definition }}
-            {% endif %}
-
-            {% endfor %}
-
-            {% else %}
-
-            {% for item in definition.attributes %}
-            #{equalsigns(depth + 1)} Attribute: {{item.name}}
-
-            {% if item.definition %}
-            {{ item.definition }}
-            {% endif %}
-
-            Value type and multiplicity:
-            {% if item.type -%}{{ item.type }}{% else -%}(no type specified){% endif %}
-            {% if item.cardinality.min -%}
-            {% if item.cardinality.max -%}
-            {blank}[{{item.cardinality.min}}..{{item.cardinality.max}}]
-            {% else -%}
-            {blank}[{{item.cardinality.min}}]
-            {% endif -%}
-            {% else -%}
-            (multiplicity unspecified)
-            {% endif %}
-
-            {% if item.origin %}
-            Origin: <<{{ item.origin }}>>
-            {% endif %}
-
-            {% endfor %}
-
-            {% endif %}
-            {% endif %}
-
-          TEMPLATE
-        end
-        # rubocop:enable Layout/IndentHeredoc
-      end
-    end
-  end
-end