metanorma-plugin-lutaml 0.6.2 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56a196838fa30ab8585b1834d115bf6ff99b4b81d33176975b75dc7f5c5cd5bd
-  data.tar.gz: 458ce39ccac1e11b1dee74289e9e85a06a4ec5fa2faceaa78869ca18cc8dae77
+  metadata.gz: e52ac2333cb4e251e5d531e8909d1a763a6f05960ad886136741676639235e44
+  data.tar.gz: 7f3e2daffb58c5074928121da9f4951f85a704e1cb8d8e666e5cfcfcdff90e7c
 SHA512:
-  metadata.gz: 780fa1199a23d199cb8f04d1a1b9b79d416f8aed0a2b442f02baccd370830d76d80fee12c2061e9424c9dd294059f5709b50a0eac7ac9b24fd4b492f54caa839
-  data.tar.gz: 1582258a02474a3ee351b935afc686a78ed8c82f1cc72efefde7c003110bfaa8fd4189d979b2070e61509d5d4997208b7644daf529c6e221c9e187e4e3def057
+  metadata.gz: bc3b7a23fef7ba9b8b7537ea94d5b28c548b0f55409e4dbf6e8cac0d35742d2126d4831a9bc1747647ac5d9e3c3f4f1ed3d4b00eb0ffeeae0251b65d6301833e
+  data.tar.gz: e56cad378a1131c70ebc0a47e2d44cbdba2fda3bc4a56f866a4a3e3b45268eeb02fa859e02d48904a8b4b90fe0699fc99c607853e9509b41221953917ed2a0f0

data/Gemfile

@@ -6,8 +6,4 @@ git_source(:github) { |repo| "https://github.com/#{repo}" }
 
 gemspec
 
-begin
-  eval_gemfile("Gemfile.devel")
-rescue StandardError
-  nil
-end
+eval_gemfile("Gemfile.devel") rescue nil

data/README.adoc

@@ -154,11 +154,11 @@ per-block via a separate YAML file.
 
 [source,adoc]
 ----
-:lutaml-express-index: schemas_1; schemas_all.yaml;
+:lutaml-express-index: all_schemas; ../schemas_all.yaml;
 
-[lutaml_express,schemas_1,repo,leveloffset=+1,config_yaml=select.yaml]
+[lutaml_express,all_schemas,context,leveloffset=+1,config_yaml=schemas.yaml]
 ---
-{% assign selected = repo.schemas | where: "selected" %}
+{% assign selected = context.schemas | where: "selected" %}
 {% render "templates/resources/schema" for selected as schema %}
 ---
 ----
@@ -178,14 +178,16 @@ schemas:
 ...
 ----
 
-And `select.yaml` only selects 2 schemas:
+And `schemas.yaml` only selects 2 schemas:
 
 [source,yaml]
 ----
 ---
 schemas:
-  - action_schema
-  - application_context_schema
+  action_schema:
+    anything: ...
+  application_context_schema:
+    anything: ...
 ----
 
 The resulting block adds the `select` attribute to every schema of the the

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

@@ -48,7 +48,7 @@ module Metanorma
             # When we are dealing with a relative path of a template:
             # ../path/to/file we need to transform it into
             # the absolute one because `image::` macro wont understand it other way
-            prefixed_path = File.absolute_path(prefixed_path) if prefixed_path.start_with?("../")
+            prefixed_path = File.absolute_path(prefixed_path) if prefixed_path.start_with?('../')
             full_path = File.expand_path(prefixed_path)
             "#{$1}#{$2}#{full_path}#{$4}"
           end

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

@@ -15,7 +15,7 @@ module Metanorma
           end
 
           def identify(input)
-            input.split(/(?=[A-Z])/).map(&:downcase).join("-")
+            input.split(/(?=[A-Z])/).map(&:downcase).join('-')
           end
         end
       end

data/lib/metanorma/plugin/lutaml/liquid/multiply_local_file_system.rb

@@ -22,41 +22,35 @@ module Metanorma
 
           def full_path(template_path)
             unless %r{\A[^./][a-zA-Z0-9_/]+\z}.match?(template_path)
-              raise ::Liquid::FileSystemError,
-                    "Illegal template name '#{template_path}'"
+              raise ::Liquid::FileSystemError, "Illegal template name '#{template_path}'"
             end
 
-            result_path = if template_path.include?("/")
-                            roots
-                              .map do |root|
-                                patterns.map do |pattern|
-                                  File.join(root, File.dirname(template_path),
-                                            pattern % File.basename(template_path))
-                                end
-                              end
-                              .flatten
-                              .find { |path| File.file?(path) }
-                          else
-                            roots
-                              .map do |root|
-                                patterns.map do |pattern|
-                                  File.join(root, pattern % template_path)
-                                end
-                              end
-                              .flatten
-                              .find { |path| File.file?(path) }
-                          end
+            result_path = if template_path.include?('/')
+              roots
+                .map do |root|
+                  patterns.map do |pattern|
+                    File.join(root, File.dirname(template_path), pattern % File.basename(template_path))
+                  end
+                end
+                .flatten
+                .find { |path| File.file?(path) }
+            else
+              roots
+                .map do |root|
+                  patterns.map do |pattern|
+                    File.join(root, pattern % template_path)
+                  end
+                end
+                .flatten
+                .find { |path| File.file?(path) }
+            end
 
             if result_path.nil?
-              raise ::Liquid::FileSystemError,
-                    "No documents in template path '#{File.expand_path(template_path)}'"
+              raise ::Liquid::FileSystemError, "No documents in template path '#{File.expand_path(template_path)}'"
             end
 
-            unless roots.any? do |root|
-                     File.expand_path(result_path).start_with?(File.expand_path(root))
-                   end
-              raise ::Liquid::FileSystemError,
-                    "Illegal template path '#{File.expand_path(result_path)}'"
+            unless roots.any? { |root| File.expand_path(result_path).start_with?(File.expand_path(root)) }
+              raise ::Liquid::FileSystemError, "Illegal template path '#{File.expand_path(result_path)}'"
             end
 
             result_path

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

@@ -16,14 +16,14 @@ module Metanorma
         REMARKS_ATTRIBUTE = "remarks"
 
         def process(document, reader)
-          r = Asciidoctor::PreprocessorNoIfdefsReader.new(document,
-                                                          reader.lines)
+          r = Asciidoctor::PreprocessorNoIfdefsReader.new(document, reader.lines)
           input_lines = r.readlines.to_enum
 
           has_lutaml = input_lines.any? { |line| lutaml?(line) }
+
           express_indexes = Utils.parse_document_express_indexes(
             document,
-            input_lines,
+            input_lines
           )
 
           result_content = process_input_lines(
@@ -53,18 +53,18 @@ module Metanorma
           ::Lutaml::Parser.parse(
             File.new(
               Utils.relative_file_path(document, file_path),
-              encoding: "UTF-8",
-            ),
+              encoding: "UTF-8"
+            )
           )
         end
 
         private
 
         def process_input_lines(
-          document:,
+            document:,
             input_lines:,
             express_indexes:
-        )
+          )
 
           result = []
           loop do
@@ -73,7 +73,7 @@ module Metanorma
                 document,
                 input_lines,
                 express_indexes,
-              ),
+              )
             )
           end
           result
@@ -99,7 +99,7 @@ module Metanorma
             index_names: index_names,
             context_name: context_name,
             options: options,
-            indexes: express_indexes,
+            indexes: express_indexes
           )
         end
 
@@ -118,36 +118,63 @@ module Metanorma
             # TODO: decide how to handle expressir multiply file parse as one
             # object and lutaml
 
-            # Does this condition ever happen? That is only if the `lutaml-express-index` condition is not set
-            if indexes[path]
-              indexes[path][:serialized_hash] ||= indexes[path][:wrapper].to_liquid
-            else
+            # Does this condition ever happen? That is only if the
+            # `lutaml-express-index` condition is not set
+            unless indexes[path]
+
+              full_path = Utils.relative_file_path(document, path)
+              unless File.file?(full_path)
+                raise StandardError.new(
+                  "Unable to load EXPRESS index for `#{path}`, " \
+                  "please define it at `:lutaml-express-index:` or specify " \
+                  "the full path."
+                )
+              end
               wrapper = load_lutaml_file(document, path)
               indexes[path] = {
                 wrapper: wrapper,
-                serialized_hash: wrapper.to_liquid,
+                serialized_hash: wrapper.to_liquid
               }
+            else
+              indexes[path][:serialized_hash] ||= indexes[path][:wrapper].to_liquid
             end
 
             indexes[path]
           end
         end
 
-        def parse_yaml_config_file(document, file_path)
-          return nil if file_path.nil?
+        def read_config_yaml_file(document, file_path)
+          return {} if file_path.nil?
 
           relative_file_path = Utils.relative_file_path(document, file_path)
-          YAML.safe_load(File.read(relative_file_path, encoding: "UTF-8"))
+          config_yaml = YAML.safe_load(
+            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] attribute `config_yaml` must point to a YAML " \
+                "file that has the `schema` key containing a hash."
+              )
+            end
+
+            options["selected_schemas"] = config_yaml["schemas"].keys
+          end
+
+          options
         end
 
-        def decorate_schema_object(schema:, document:, indexes:, index_names:,
-selected:, options:)
+        def decorate_schema_object(schema:, document:, indexes:, index_names:, selected:, options:)
           # Mark a schema as "selected" with `.selected`
           schema["selected"] = true if selected
 
           # Provide pretty-formatted code under `.formatted`
-          _, index_found_value = indexes.detect do |_k, _v|
-            _
+          index_found_key, index_found_value = indexes.detect do |k,v|
+            found = v[:wrapper].original_document.schemas.detect do |s|
+              s.id == schema["id"]
+            end
           end
 
           schema["formatted"] = index_found_value[:wrapper].original_document.schemas.detect do |s|
@@ -159,46 +186,44 @@ selected:, options:)
             schema,
             options.merge(
               "relative_path_prefix" =>
-                Utils.relative_file_path(document,
-                                         File.dirname(schema["file"])),
-            ),
+                Utils.relative_file_path(document, File.dirname(schema["file"]))
+            )
           ) || {}
         end
 
-        def render_template(document:, lines:, context_name:, index_names:,
-options:, indexes:)
-          config_yaml_path = options.delete("config_yaml")
-          config_yaml = if config_yaml_path
-                          parse_yaml_config_file(document, config_yaml_path)
-                        else
-                          {}
-                        end
+        def render_template(document:, lines:, context_name:, index_names:, options:, indexes:)
 
-          selected_schemas = config_yaml["schemas"]
+          config_yaml_path = options.delete("config_yaml")
+          config = read_config_yaml_file(document, config_yaml_path)
+          selected_schemas = config["selected_schemas"]
 
           gather_context_items(
             index_names: index_names,
             document: document,
-            indexes: indexes,
+            indexes: indexes
           ).map do |items|
+
             serialized_hash = items[:serialized_hash]
 
-            serialized_hash["schemas"]&.map! do |schema|
-              decorate_schema_object(
-                schema: schema,
-                document: document,
-                index_names: index_names,
-                indexes: indexes,
-                selected: selected_schemas && selected_schemas.include?(schema["id"]),
-                options: options,
-              )
+            if serialized_hash["schemas"]
+              serialized_hash["schemas"].map! do |schema|
+
+                decorate_schema_object(
+                  schema: schema,
+                  document: document,
+                  index_names: index_names,
+                  indexes: indexes,
+                  selected: selected_schemas && selected_schemas.include?(schema["id"]),
+                  options: options
+                )
+              end
             end
 
             render_block(
               document: document,
               block_lines: lines,
               context_items: serialized_hash,
-              context_name: context_name,
+              context_name: context_name
             )
           end.flatten
         rescue StandardError => e
@@ -221,8 +246,8 @@ options:, indexes:)
               key,
               val&.map do |remark|
                 Metanorma::Plugin::Lutaml::ExpressRemarksDecorator
-                    .call(remark, options)
-              end,
+                  .call(remark, options)
+              end
             ]
           end
 

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

@@ -9,7 +9,7 @@ module Metanorma
       #  @example [lutaml_uml_attributes_table,path/to/lutaml,EntityName]
       class LutamlUmlAttributesTablePreprocessor < LutamlUmlClassPreprocessor
         MACRO_REGEXP =
-          /\[lutaml_uml_attributes_table,([^,]+),?([^,]+),?(.+?)?\]/.freeze
+          /\[lutaml_uml_attributes_table,([^,]+),?([^,]+),?(.+?)?\]/
 
         # rubocop:disable Layout/IndentHeredoc
         def template(options)

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

@@ -15,7 +15,7 @@ module Metanorma
       #  @example [lutaml_uml_class,path/to/lutaml,EntityName]
       class LutamlUmlClassPreprocessor < ::Asciidoctor::Extensions::Preprocessor
         MACRO_REGEXP =
-          /\[lutaml_uml_class,([^,]+),?([^,]+),?(.+?)?\]/.freeze
+          /\[lutaml_uml_class,([^,]+),?([^,]+),?(.+?)?\]/
 
         def get_macro_regexp
           self.class.const_get(:MACRO_REGEXP)
@@ -109,9 +109,9 @@ module Metanorma
 
           <<~TEMPLATE
             {% if definition.keyword == 'enumeration' %}
-            #{"#{equalsigns(depth)} Enumeration: {{ definition.name }}" unless skip_headers}
+            #{equalsigns(depth) + ' Enumeration: {{ definition.name }}' unless skip_headers}
             {% else %}
-            #{"#{equalsigns(depth)} Class: {{ definition.name }}" unless skip_headers}
+            #{equalsigns(depth) + ' Class: {{ definition.name }}' unless skip_headers}
             {% endif %}
 
             #{equalsigns(depth + 1)} Description

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

@@ -16,7 +16,7 @@ module Metanorma
       class LutamlUmlDatamodelDescriptionPreprocessor <
           ::Asciidoctor::Extensions::Preprocessor
         MACRO_REGEXP =
-          /\[lutaml_uml_datamodel_description,([^,]+),?(.+)?\]/.freeze
+          /\[lutaml_uml_datamodel_description,([^,]+),?(.+)?\]/
         LIQUID_INCLUDE_PATH = File.join(
           Gem.loaded_specs["metanorma-plugin-lutaml"].full_gem_path,
           "lib", "metanorma", "plugin", "lutaml", "liquid_templates"
@@ -92,7 +92,7 @@ module Metanorma
         def fill_in_entities_refs_attributes(document, lutaml_document_wrapper,
 options)
           lutaml_document = lutaml_document_wrapper.original_document
-          options.fetch(RENDER_STYLE_ATTRIBUTE, "default")
+          render_style = options.fetch(RENDER_STYLE_ATTRIBUTE, "default")
           all_children_packages = lutaml_document.packages
             .map(&:children_packages).flatten
           package_flat_packages = lambda do |pks|

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

@@ -31,7 +31,7 @@ module Metanorma
           # Allow includes for the template
           include_paths = [
             Utils.relative_file_path(document, ""),
-            include_path,
+            include_path
           ].compact
 
           liquid_template.registers[:file_system] =
@@ -54,8 +54,8 @@ module Metanorma
           end
         end
 
-        def load_express_repositories(path:, cache_path:, document:,
-force_read: false)
+        def load_express_repositories(path:, cache_path:, document:, force_read: false)
+
           cache_full_path = cache_path &&
             Utils.relative_file_path(document, cache_path)
 
@@ -72,11 +72,12 @@ force_read: false)
             save_express_repo_to_cache(
               cache_full_path,
               lutaml_wrapper.original_document,
-              document,
+              document
             )
           end
 
           lutaml_wrapper
+
         rescue Expressir::Error
           FileUtils.rm_rf(cache_full_path)
 
@@ -84,8 +85,9 @@ force_read: false)
             path: path,
             cache_path: cache_path,
             document: document,
-            force_read: true,
+            force_read: true
           )
+
         rescue StandardError => e
           document.logger.warn("Failed to load #{full_path}: #{e.message}")
           raise e
@@ -131,6 +133,7 @@ force_read: false)
             File.new(Utils.relative_file_path(document, path),
                      encoding: "UTF-8")
           end
+
           ::Lutaml::Parser.parse(files_to_load)
         end
 
@@ -156,13 +159,13 @@ force_read: false)
             lutaml_expressir_wrapper = load_express_repositories(
               path: path,
               cache_path: cache,
-              document: document,
+              document: document
             )
 
             if lutaml_expressir_wrapper
               express_indexes[name] = {
                 wrapper: lutaml_expressir_wrapper,
-                serialized_hash: nil,
+                serialized_hash: nil
               }
             end
           end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor