metanorma-plugin-lutaml 0.7.31 → 0.7.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dda89cf25e4d97114f8285719533a301e4a932b36011212d07dc9c4e386eb8e0
-  data.tar.gz: b2f0d0296c064be11a5031643bc2ae4d4428b034f475beb6958f24f41d5e3760
+  metadata.gz: 249c6be1ae1a19967a906113b2142e3608e65ffc784e85bb990a7226b4818982
+  data.tar.gz: 405ea5857dab3f2750d0ab8c4a27c9a0abc119f97dccbe0b67f143cfe780e754
 SHA512:
-  metadata.gz: 8c16366f081e6c73776903a6eb930a1b08f0ad7332b6ed240d7318b4a9f2790740cedd20ae68845ffc6205bbb1bc3d629b21c096b7f99534b5b614a32c520d7f
-  data.tar.gz: 8c7488d45307134a5de8f84adabc88eba63572baa8f5dd19187d823a25a8e46183632e9b47e4e7932833ca291ece2e03db6e118cc533c30f6f3d862c2a049774
+  metadata.gz: 3008f74df51c0ed75b44a87acc302ac0fcecf5e4e2501e7c55de8aac6023a7e247df13e088d554b217280c3329049c826768e3d5557cddbd63570810262d7d45
+  data.tar.gz: bf0891bae566ccbeaacd9a98516e2495642d9629c8eed5adc8e9b4025338fe1fcfd7aa2c5555f2f0c4e2795d25a4e7ee98c760b7eaf486c16762efb4318533cb

data/docs/usages/json_yaml.adoc

@@ -604,6 +604,22 @@ dolor sit
 ====
 
 
+=== Error Handling
+
+==== Invalid JSON or YAML file
+
+If the specified file is an invalid JSON or YAML file, the block will raise an
+error when the document is processed. The error will be:
+`Metanorma::Plugin::Lutaml::ParseError`.
+
+Detailed error messages will also be provided for troubleshooting.
+
+==== Invalid path of file
+
+If the specified file path does not exist, the block will raise an
+error when the document is processed. The error will be:
+`Metanorma::Plugin::Lutaml::FileNotFoundError`.
+
 === Advanced usage
 
 ==== General

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

@@ -93,10 +93,6 @@ module Metanorma
             include_path: include_path,
             template_path: template_path,
           )
-        rescue StandardError => e
-          ::Metanorma::Util.log("Failed to parse #{config[:block_name]} \
-              block: #{e.message}", :error)
-          []
         end
 
         def resolve_context(document, block_match) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength

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

@@ -2,6 +2,8 @@
 
 require "json"
 require "yaml"
+require_relative "file_not_found_error"
+require_relative "parse_error"
 
 module Metanorma
   module Plugin
@@ -10,21 +12,15 @@ module Metanorma
         protected
 
         # https://ruby-doc.org/stdlib-2.5.1/libdoc/psych/rdoc/Psych.html#method-c-safe_load
-        def yaml_content_from_file(resolved_file_path) # rubocop:disable Metrics/MethodLength
-          unless File.exist?(resolved_file_path)
-            ::Metanorma::Util.log(
-              "YAML file referenced in [yaml2text] block not found: " \
-              "#{resolved_file_path}", :error
-            )
-            return
-          end
-
+        def yaml_content_from_file(resolved_file_path)
           YAML.safe_load(
             File.read(resolved_file_path, encoding: "UTF-8"),
             permitted_classes: [Date, Time, Symbol],
             permitted_symbols: [],
             aliases: true,
           )
+        rescue StandardError => e
+          raise_parsing_error(e, resolved_file_path, type: :yaml, from: :file)
         end
 
         def yaml_content_from_anchor(document, anchor)
@@ -34,14 +30,34 @@ module Metanorma
             permitted_symbols: [],
             aliases: true,
           )
+        rescue StandardError => e
+          raise_parsing_error(e, resolved_file_path, type: :yaml, from: :anchor)
         end
 
         def json_content_from_file(resolved_file_path)
           JSON.parse(File.read(resolved_file_path, encoding: "UTF-8"))
+        rescue StandardError => e
+          raise_parsing_error(e, resolved_file_path, type: :json, from: :file)
         end
 
         def json_content_from_anchor(document, anchor)
           JSON.parse(document.attributes["source_blocks"][anchor])
+        rescue StandardError => e
+          raise_parsing_error(e, resolved_file_path, type: :json, from: :anchor)
+        end
+
+        def raise_parsing_error(error, file_or_anchor, type: :json, from: :file)
+          err_msg = "Error parsing #{type} from #{from} " \
+                    "#{file_or_anchor}: #{error.message}"
+          ::Metanorma::Util.log(err_msg, :error)
+          raise ::Metanorma::Plugin::Lutaml::ParseError.new err_msg
+        end
+
+        def raise_file_not_found_error(file_path)
+          err_msg = "File referenced in [{data|yaml|json}2text] block " \
+                    "not found: #{file_path}"
+          ::Metanorma::Util.log(err_msg, :error)
+          raise ::Metanorma::Plugin::Lutaml::FileNotFoundError.new err_msg
         end
 
         def content_from_file(document, file_path)
@@ -51,9 +67,7 @@ module Metanorma
 
         def load_content_from_file(resolved_file_path)
           unless File.exist?(resolved_file_path)
-            ::Metanorma::Util
-              .log("Failed to load content from file: #{resolved_file_path}",
-                   :error)
+            raise_file_not_found_error(resolved_file_path)
           end
 
           if json_file?(resolved_file_path)

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class FileNotFoundError < StandardError
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/lutaml/liquid/custom_filters/file_exist.rb

@@ -0,0 +1,13 @@
+module Metanorma
+  module Plugin
+    module Lutaml
+      module Liquid
+        module CustomFilters
+          def file_exist(path)
+            File.exist?(path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/plugin/lutaml/liquid_templates/_packages_class.liquid

@@ -8,74 +8,122 @@
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 
-h|Name: 7+| {{ klass.name }}
+h|Name 7+| {{ klass.name }}
 
-h|Definition: 7+| {{ klass.definition | html2adoc }}
+h|Definition 7+| {{ klass.definition | html2adoc }}
 
-h|Stereotype: 7+| {{ klass.stereotype | default: 'interface' }}
+h|Stereotype 7+| {{ klass.stereotype | default: 'interface' }}
 
 {% assign inherited = klass.associations | where: "member_end_type", "inheritance" %}
 {% if inherited.size > 0 %}
-h|Inheritance from: 7+| {{ inherited | map: 'member_end' | join: ", " }}
+h|Inherits from 7+| {{ inherited | map: 'member_end' | join: ", " }}
 {% endif %}
 
 {% assign generalizations = klass.associations | where: "member_end_type", "generalization" %}
 {% if generalizations.size > 0 %}
-h|Generalization of: 7+| {{ generalizations | map: 'member_end' | join: ", " }}
+h|Generalization of 7+| {{ generalizations | map: 'member_end' | join: ", " }}
 {% endif %}
 
-h|Abstract: 7+| {% if klass.is_abstract %}True{% else %}False{% endif %}
+h|Abstract 7+| {% if klass.is_abstract %}True{% else %}False{% endif %}
 {% assign aggregations = klass.associations | where: "member_end_type", "aggregation" %}
+
 {% if aggregations.size > 0 %}
-.{{aggregations.size | plus: 1}}+h|Associations:
-4+| _Association with_
-| _Obligation_
-| _Maximum occurrence_
-| _Provides_
+
+{% assign associations_colspan = aggregations.size | plus: 1 %}
+{% for assoc in aggregations %}
+{% if assoc.connector && assoc.connector.source %}
+{% assign associations_colspan = associations_colspan | plus: 1 %}
+{% endif %}
+{% if assoc.connector && assoc.connector.target %}
+{% assign associations_colspan = associations_colspan | plus: 1 %}
+{% endif %}
+{% endfor %}
+
+.{{associations_colspan}}+h|Associations
+2+h| _Name_
+2+h| _Type_
+3+h| _Definition_
 
 {% for assoc in aggregations %}
-4+| {{assoc.member_end}}
-| {% if assoc.member_end_cardinality %}{{ assoc.member_end_cardinality.min }}{% endif %}
-| {% if assoc.member_end_cardinality %}{{ assoc.member_end_cardinality.max }}{% endif %}
-| {{ assoc.member_end_attribute_name }}
+
+{% assign member_end_documentation_size = assoc.member_end.definition | size %}
+{% capture member_end_documentation %}{% if member_end_documentation_size > 0 %}{{ assoc.member_end.definition }}{% else %}(none){% endif %}{% endcapture %}
+
+2+| {{ assoc.member_end }}
+2+| {{ assoc.member_end_attribute_name }}
+3+| {{ member_end_documentation | html2adoc }}
+
+{% if assoc.connector && assoc.connector.source %}
+{% assign source_name_size = assoc.connector.source.name | size %}
+{% capture source_name %}{% if source_name_size > 0 %}{{ assoc.connector.source.name }}{% else %}(self){% endif %}{% endcapture %}
+{% assign source_documentation_size = assoc.connector.source.documentation | size %}
+{% capture source_documentation %}{% if source_documentation_size > 0 %}{{ assoc.connector.source.documentation }}{% else %}(none){% endif %}{% endcapture %}
+{% assign source_multiplicity_size = assoc.connector.source.multiplicity | size %}
+{% capture source_multiplicity %}{% if source_multiplicity_size > 0 %}[{{ assoc.connector.source.multiplicity }}]{% else %}[none]{% endif %}{% endcapture %}
+
+2+| source:{{ source_name }} {{ source_multiplicity }}
+2+| {{ assoc.connector.source.type }}
+3+| {{ source_documentation | html2adoc }}
+{% endif %}
+
+{% if assoc.connector && assoc.connector.target %}
+{% assign target_name_size = assoc.connector.target.name | size %}
+{% capture target_name %}{% if target_name_size > 0 %}{{ assoc.connector.target.name }}{% else %}(self){% endif %}{% endcapture %}
+{% assign target_documentation_size = assoc.connector.target.documentation | size %}
+{% capture target_documentation %}{% if target_documentation_size > 0 %}{{ assoc.connector.target.documentation }}{% else %}(none){% endif %}{% endcapture %}
+{% assign target_multiplicity_size = assoc.connector.target.multiplicity | size %}
+{% capture target_multiplicity %}{% if target_multiplicity_size > 0 %}[{{ assoc.connector.target.multiplicity }}]{% else %}[none]{% endif %}{% endcapture %}
+
+2+| target:{{ target_name }} {{ target_multiplicity }}
+2+| {{ assoc.connector.target.type }}
+3+| {{ target_documentation | html2adoc }}
+{% endif %}
 
 {% endfor %}
 {% else %}
-h| Associations: 7+| (none)
+h| Associations 7+| (none)
 {% endif %}
 
 {% if klass.attributes.size > 0 %}
-.{{klass.attributes.size | plus: 1}}+h|Public attributes:
-| _Name_
-2+| _Definition_
-| _Derived_
-| _Obligation_
-| _Maximum occurrence_
-| _Data type_
+.{{klass.attributes.size | plus: 1}}+h|Attributes
+2+h| _Name_
+2+h| _Type_
+3+h| _Definition_
 
 {% for attr in klass.attributes %}
-| {{attr.name}}
-2+| {{ attr.definition | html2adoc }}
-| {{ attr.is_derived }}
-| {{attr.cardinality.min}}
-| {{attr.cardinality.max}}
-| {{attr.type}}
+{% capture attr_cardinality %}[{{attr.cardinality.min}}..{{attr.cardinality.max}}]{% endcapture %}
+{% if attr_cardinality == "[*..*]" or attr_cardinality == "[0..*]" %}
+{% assign attr_cardinality = "[*]" %}
+{% endif %}
+{% if attr_cardinality == "[1..1]" %}
+{% assign attr_cardinality = "[1]" %}
+{% endif %}
+{% if attr_cardinality == "[..]" %}
+{% assign attr_cardinality = "[none]" %}
+{% endif %}
+
+{% assign attr_definition_size = attr.definition | size %}
+{% capture attr_definition %}{% if attr_definition_size > 0 %}{{ attr.definition }}{% else %}(none){% endif %}{% endcapture %}
+
+2+| {{ attr.name }} {{ attr_cardinality }}
+2+| {{ attr.type }}
+3+| {{ attr_definition | html2adoc }}
 
 {% endfor %}
 {% else %}
-h| Public attributes:
+h| Attributes
 7+| (none)
 {% endif %}
 
 {% if klass.constraints.size > 0 %}
-.{{ klass.constraints.size }}+h| Constraints:
+.{{ klass.constraints.size }}+h| Constraints
 {% for constraint in klass.constraints %}
 7+| `{{ constraint.body }}`: `{{ constraint.definition | replace: '|', '\|' }}`
 
 {% endfor %}
 {% else %}
 
-h|Constraints: 7+| (none)
+h|Constraints 7+| (none)
 {% endif %}
 
 |===

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

@@ -33,8 +33,6 @@ module Metanorma
                                                           reader.lines)
           input_lines = r.readlines.to_enum
 
-          has_lutaml_liquid = input_lines.any? { |line| lutaml_liquid?(line) }
-
           express_indexes = Utils.parse_document_express_indexes(
             document,
             input_lines,
@@ -46,19 +44,11 @@ module Metanorma
             express_indexes: express_indexes,
           )
 
-          log(document, result_content) if has_lutaml_liquid
-
           Asciidoctor::PreprocessorNoIfdefsReader.new(document, result_content)
         end
 
         protected
 
-        def log(doc, text)
-          File.open("#{doc.attr('docfile')}.lutaml.log.txt", "w:UTF-8") do |f|
-            f.write(text.join("\n"))
-          end
-        end
-
         def lutaml_liquid?(line)
           line.match(EXPRESS_PREPROCESSOR_REGEX)
         end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class ParseError < StandardError
+      end
+    end
+  end
+end

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

@@ -7,6 +7,7 @@ require "metanorma/plugin/lutaml/liquid/custom_filters/html2adoc"
 require "metanorma/plugin/lutaml/liquid/custom_filters/values"
 require "metanorma/plugin/lutaml/liquid/custom_filters/replace_regex"
 require "metanorma/plugin/lutaml/liquid/custom_filters/loadfile"
+require "metanorma/plugin/lutaml/liquid/custom_filters/file_exist"
 
 module Metanorma
   module Plugin

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

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

data/metanorma-plugin-lutaml.gemspec

@@ -29,11 +29,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.7.0" # rubocop:disable Gemspec/RequiredRubyVersion
 
   spec.add_dependency "asciidoctor"
-  spec.add_dependency "coradoc", "~> 1.1.1"
-  spec.add_dependency "expressir", "~> 2.1.13"
+  spec.add_dependency "coradoc", "~> 1.1"
+  spec.add_dependency "expressir", "~> 2.1"
   spec.add_dependency "isodoc"
   spec.add_dependency "liquid"
-  spec.add_dependency "lutaml", "~> 0.9.32"
+  spec.add_dependency "lutaml", "~> 0.9"
   spec.add_dependency "ogc-gml", "~>1.0.0"
   spec.add_dependency "relaton-cli"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.31
+  version: 0.7.33
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-23 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: expressir
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.13
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.13
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: isodoc
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.32
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.32
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: ogc-gml
   requirement: !ruby/object:Gem::Requirement
@@ -158,8 +158,10 @@ files:
 - lib/metanorma/plugin/lutaml/content.rb
 - lib/metanorma/plugin/lutaml/data2_text_preprocessor.rb
 - lib/metanorma/plugin/lutaml/express_remarks_decorator.rb
+- lib/metanorma/plugin/lutaml/file_not_found_error.rb
 - lib/metanorma/plugin/lutaml/json2_text_preprocessor.rb
 - lib/metanorma/plugin/lutaml/liquid/custom_blocks/key_iterator.rb
+- lib/metanorma/plugin/lutaml/liquid/custom_filters/file_exist.rb
 - lib/metanorma/plugin/lutaml/liquid/custom_filters/html2adoc.rb
 - lib/metanorma/plugin/lutaml/liquid/custom_filters/loadfile.rb
 - lib/metanorma/plugin/lutaml/liquid/custom_filters/replace_regex.rb
@@ -193,6 +195,7 @@ files:
 - lib/metanorma/plugin/lutaml/lutaml_preprocessor.rb
 - lib/metanorma/plugin/lutaml/lutaml_table_inline_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor.rb
+- lib/metanorma/plugin/lutaml/parse_error.rb
 - lib/metanorma/plugin/lutaml/source_extractor.rb
 - lib/metanorma/plugin/lutaml/utils.rb
 - lib/metanorma/plugin/lutaml/version.rb