metanorma-plugin-lutaml 0.7.31 → 0.7.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dda89cf25e4d97114f8285719533a301e4a932b36011212d07dc9c4e386eb8e0
-  data.tar.gz: b2f0d0296c064be11a5031643bc2ae4d4428b034f475beb6958f24f41d5e3760
+  metadata.gz: cd1f666910d8626ed3c60a6543c1d0922a1b988941acb672484757dc42e4e1d2
+  data.tar.gz: f40aa319451eaf3444f9bbb06a45aa2f28281fb81d9bc0db40fa5f2699c52d6d
 SHA512:
-  metadata.gz: 8c16366f081e6c73776903a6eb930a1b08f0ad7332b6ed240d7318b4a9f2790740cedd20ae68845ffc6205bbb1bc3d629b21c096b7f99534b5b614a32c520d7f
-  data.tar.gz: 8c7488d45307134a5de8f84adabc88eba63572baa8f5dd19187d823a25a8e46183632e9b47e4e7932833ca291ece2e03db6e118cc533c30f6f3d862c2a049774
+  metadata.gz: '096af413077b87f001e1746914fe05f833c83ff698d60383c57e7daf4aa88aae61244d034836ea01eb66bd787940065c4689210d2e9bf7de69b499e6ee96adf5'
+  data.tar.gz: 9873bf6b1a5439de6c1aa6480631fc820a0a857e079438fa7ee987cd3fa6a2d069976986d587345bd9e1f4a6466efcae087d06f88647316d3b1afbb46021c0ae

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/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/version.rb

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

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.32
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-23 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -158,6 +158,7 @@ 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/html2adoc.rb
@@ -193,6 +194,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