metanorma-plugin-lutaml 0.2.0 → 0.2.4.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf1f2a866187d3c88f1948cfee8cac317fd17aa01a6ed3896470689b5dc644d1
-  data.tar.gz: 47752b4c4b8cd0fc9f086d83a00dbad165940650ef14353c860b3cbe8c22dd41
+  metadata.gz: 3d9bb01b3f5a13668f541d4119e0830655c524be8bcfa9414b41004b2f6fbcc4
+  data.tar.gz: a2851e63eece312d2b529aa3fe68de9fffa794768ab1e15a0eec97b86ca9c9f3
 SHA512:
-  metadata.gz: b2c871c4788077d0e853813452119c8639fc8d539103a312be1781f17d0e22968b29d28ac62f78f887fc4714123ff598f42b591c8747b14c48ae5c034f356c6a
-  data.tar.gz: f1545cb37a21c5ec2f00078b9e556bcba25197409a4e42902734cdc378d6b3e1a1822abf4d13f0e92d55c1ad22c58b87e60a90b3873bf088987dc47233404328
+  metadata.gz: 1dd880cc2ac6829e851ad8165150af8905f8a558fda49e610a03af6c720d592c25695c135b3acc4c6be415a76c402060a7813b1783f6e3f8a6d0c580a53d4a63
+  data.tar.gz: d78b7da3aad28bda7f8b2a1a891ca885068fe4b3261ad684a33e53afc83a5812a4bc13c30d7ef8ca34a0e3d6cc72a1482971ec63a5cec12b28283631cd455cc2

data/.github/workflows/rake.yml

@@ -1,5 +1,3 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
 name: rake
 
 on:
@@ -56,7 +54,7 @@ jobs:
           polling_interval_seconds: 5
           timeout_minutes: 5
           max_attempts: 3
-          command: choco install --no-progress graphviz --version 2.38.0.20190211
+          command: choco install --no-progress graphviz
 
       - name: Check dot command
         if: matrix.os == 'windows-latest'
@@ -65,17 +63,3 @@ jobs:
 
       - name: Run specs
         run: bundle exec rake
-
-  notify:
-    name: Trigger notify workflow
-    needs: rake
-    runs-on: ubuntu-latest
-    steps:
-      - name: Trigger notify workflow
-        uses: Sibz/github-status-action@v1
-        with:
-          authToken: ${{ secrets.GITHUB_TOKEN }}
-          context: 'tests-passed-successfully'
-          description: 'Tests passed successfully'
-          state: 'success'
-          sha: ${{ github.event.pull_request.head.sha || github.sha }}

data/.gitignore

@@ -1,3 +1,4 @@
 Gemfile.lock
 .rspec_status
-spec/assets/lutaml
+spec/assets/lutaml
+test.err

data/Gemfile

@@ -2,4 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in metanorma-plugin-lutaml.gemspec
 gemspec
-

data/README.adoc

@@ -60,6 +60,14 @@ And the `lutaml` macro block:
 ----
 -----
 
+Where:
+
+* content within the block is called the "`template`";
+
+* `{example.exp}` is the location of the exp schema file that contains data to be loaded. Location of the file is computed relative to the source directory that `[lutaml]` is used (e.g., if `[lutaml,example.exp,my_context]` is invoked in an `.adoc` file located at `/foo/bar/doc.adoc`, the data file is expected to be found at `/foo/bar/example.exp`);
+
+* `{my_context}` is the name where the EXPRESS Repository read from the .exp file can be accessed with. Context object is a serialized  Expressir::Model::Repository object with all variable names available. See https://github.com/lutaml/expressir[Expressir] docs for reference. `{my_context}` has `schemas` method to access Expressir https://github.com/lutaml/expressir/blob/master/lib/expressir/model/schema.rb[schemas]
+
 Will produce this output:
 
 [source,adoc]
@@ -75,7 +83,7 @@ Will produce this output:
 
 This macro also supports `.lutaml` files.
 
-=== Usage, `lutaml_datamodel_attributes_table` macro
+=== Usage, `lutaml_uml_attributes_table` macro
 
 This macro allows to quickly render datamodel attributes/values tables. Given `example.lutaml` file with the content:
 
@@ -101,11 +109,11 @@ diagram MyView {
 }
 ----
 
-And the `lutaml_datamodel_attributes_table` macro:
+And the `lutaml_uml_attributes_table` macro:
 
 [source,adoc]
 -----
-[lutaml_datamodel_attributes_table, example.lutaml, AttributeProfile]
+[lutaml_uml_attributes_table, example.lutaml, AttributeProfile]
 -----
 
 Will produce this output:
@@ -130,7 +138,7 @@ In case of "enumeration"(AddressClassProfile) entity:
 
 [source,adoc]
 -----
-[lutaml_datamodel_attributes_table, example.lutaml, AddressClassProfile]
+[lutaml_uml_attributes_table, example.lutaml, AddressClassProfile]
 -----
 
 Will produce this output:

data/lib/metanorma-plugin-lutaml.rb

@@ -1,6 +1,6 @@
 require "metanorma/plugin/lutaml/version"
 require "metanorma/plugin/lutaml/lutaml_preprocessor"
-require "metanorma/plugin/lutaml/lutaml_datamodel_attributes_table_preprocessor"
+require "metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_diagram_block"
 
 module Metanorma

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

@@ -0,0 +1,73 @@
+module Metanorma
+  module Plugin
+    module Lutaml
+      class ExpressRemarksDecorator
+        RELATIVE_PREFIX_MACRO_REGEXP = /^(\* <<express.+?>>;|link|image|video|audio|include)(:+)?(?![^\/:]+:\/\/|[A-Z]:\/|\/)([^:\[]+)(\[.*\])?$/.freeze
+
+        attr_reader :remark, :options
+
+        def self.call(remark, options)
+          new(remark, options).call
+        end
+
+        def initialize(remark, options)
+          @remark = remark
+          @options = options
+        end
+
+        def call
+          result = remark
+          if options["leveloffset"]
+            result = process_remark_offsets(result, options["leveloffset"].to_i)
+          end
+          if options["relative_path_prefix"]
+            result = update_relative_paths(result,
+                                           options["relative_path_prefix"])
+          end
+          result
+        end
+
+        private
+
+        def update_relative_paths(string, path_prefix)
+          string
+            .split("\n")
+            .map do |line|
+              if line.match?(RELATIVE_PREFIX_MACRO_REGEXP)
+                prefix_relative_paths(line, path_prefix)
+              else
+                line
+              end
+            end
+            .join("\n")
+        end
+
+        def prefix_relative_paths(line, path_prefix)
+          line.gsub(RELATIVE_PREFIX_MACRO_REGEXP) do |_match|
+            prefixed_path = File.join(path_prefix, $3.strip)
+            "#{$1}#{$2}#{prefixed_path}#{$4}"
+          end
+        end
+
+        def process_remark_offsets(string, offset)
+          string
+            .split("\n")
+            .map do |line|
+              if line.match?(/^=/)
+                set_string_offsets(line, offset)
+              else
+                line
+              end
+            end
+            .join("\n")
+        end
+
+        def set_string_offsets(string, offset)
+          return "#{'=' * offset}#{string}" if offset.positive?
+
+          string.gsub(/^={#{offset * -1}}/, "")
+        end
+      end
+    end
+  end
+end

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

@@ -22,7 +22,8 @@ module Metanorma
           create_listing_block(
             parent,
             reader.source,
-            attrs.reject { |k, v| k == 1 })
+            attrs.reject { |k, _v| k == 1 }
+          )
         end
 
         def process(parent, reader, attrs)
@@ -32,35 +33,35 @@ module Metanorma
           through_attrs["target"] = filename
           through_attrs["title"] = uml_document.caption
           create_image_block(parent, through_attrs)
-        rescue => e
+        rescue StandardError => e
           abort(parent, reader, attrs, e.message)
         end
 
         private
 
         def lutaml_temp(reader)
-          temp_file = Tempfile.new(['lutaml', '.lutaml'])
+          temp_file = Tempfile.new(["lutaml", ".lutaml"])
           temp_file.puts(reader.read)
           temp_file.rewind
           temp_file
         end
 
         # if no :imagesdir: leave image file in lutaml
-        def generate_file(parent, reader, uml_document)
+        def generate_file(parent, _reader, uml_document)
           formatter = ::Lutaml::Uml::Formatter::Graphviz.new
           formatter.type = :png
 
-          imagesdir = if parent.document.attr('imagesdir')
-                        File.join(parent.document.attr('imagesdir'), 'lutaml')
+          imagesdir = if parent.document.attr("imagesdir")
+                        File.join(parent.document.attr("imagesdir"), "lutaml")
                       else
-                        'lutaml'
+                        "lutaml"
                       end
           result_path = Utils.relative_file_path(parent.document, imagesdir)
           result_pathname = Pathname.new(result_path)
           result_pathname.mkpath
-          File.writable?(result_pathname) or raise "Destination path #{result_path} not writable for Lutaml!"
+          File.writable?(result_pathname) || raise("Destination path #{result_path} not writable for Lutaml!")
 
-          outfile = Tempfile.new(['lutaml', '.png'])
+          outfile = Tempfile.new(["lutaml", ".png"])
           outfile.binmode
           outfile.puts(formatter.format(uml_document))
 
@@ -74,11 +75,11 @@ module Metanorma
         end
 
         def generate_attrs(attrs)
-          through_attrs = %w(id align float title role width height alt).
-            inject({}) do |memo, key|
-            memo[key] = attrs[key] if attrs.has_key? key
-            memo
-          end
+          %w(id align float title role width height alt)
+            .reduce({}) do |memo, key|
+              memo[key] = attrs[key] if attrs.has_key? key
+              memo
+            end
         end
       end
     end

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

@@ -5,16 +5,24 @@ require "asciidoctor"
 require "asciidoctor/reader"
 require "lutaml"
 require "metanorma/plugin/lutaml/utils"
+require "metanorma/plugin/lutaml/utils"
+require "metanorma/plugin/lutaml/express_remarks_decorator"
 
 module Metanorma
   module Plugin
     module Lutaml
       # Class for processing Lutaml files
       class LutamlPreprocessor < Asciidoctor::Extensions::Preprocessor
+        REMARKS_ATTRIBUTE = "remarks".freeze
 
         def process(document, reader)
           input_lines = reader.readlines.to_enum
-          Asciidoctor::Reader.new(processed_lines(document, input_lines))
+          express_indexes = Utils.parse_document_express_indexes(
+            document,
+            input_lines
+          )
+          Asciidoctor::Reader
+            .new(processed_lines(document, input_lines, express_indexes))
         end
 
         protected
@@ -27,17 +35,22 @@ module Metanorma
 
         private
 
-        def processed_lines(document, input_lines)
+        def processed_lines(document, input_lines, express_indexes)
           result = []
           loop do
-            result.push(*process_text_blocks(document, input_lines))
+            result
+              .push(*process_text_blocks(
+                document,
+                input_lines,
+                express_indexes
+              ))
           end
           result
         end
 
-        def process_text_blocks(document, input_lines)
+        def process_text_blocks(document, input_lines, express_indexes)
           line = input_lines.next
-          block_match = line.match(/^\[lutaml,(.+?),(.+?)\]/)
+          block_match = line.match(/^\[lutaml,([^,]+)?,?([^,]+)?,?([^,]+)?\]/)
           return [line] if block_match.nil?
 
           end_mark = input_lines.next
@@ -45,7 +58,8 @@ module Metanorma
                          collect_internal_block_lines(document,
                                                       input_lines,
                                                       end_mark),
-                         block_match)
+                         block_match,
+                         express_indexes)
         end
 
         def collect_internal_block_lines(_document, input_lines, end_mark)
@@ -56,19 +70,62 @@ module Metanorma
           current_block
         end
 
-        def parse_template(document, current_block, block_match)
-          context_items = content_from_file(document, block_match[1])
-          parse_context_block(document: document,
-                              context_lines: current_block,
-                              context_items: context_items,
-                              context_name: block_match[2].strip)
+        def contexts_items(block_match, document, express_indexes)
+          contexts_names = block_match[1].split(";").map(&:strip)
+          contexts_names.each_with_object([]) do |path, res|
+            if express_indexes[path]
+              res.push(*express_indexes[path])
+            else
+              res.push(content_from_file(document, path).to_liquid)
+            end
+          end
+        end
+
+        def parse_template(document, current_block, block_match, express_indexes)
+          options = parse_options(block_match[3])
+                      .merge("relative_path_prefix" => File.dirname(block_match[1]))
+          contexts_items(block_match, document, express_indexes)
+            .map do |context_items|
+              parse_context_block(document: document,
+                                  context_lines: current_block,
+                                  context_items: decorate_context_items(context_items, options),
+                                  context_name: block_match[2].strip)
+            end.flatten
         rescue StandardError => e
-          document.logger
-            .warn("Failed to parse lutaml \
-              block: #{e.message}")
+          document.logger.warn("Failed to parse lutaml block: #{e.message}")
           []
         end
 
+        def parse_options(options_string)
+          options_string
+            .to_s
+            .scan(/(.+?)=(\s?[^\s]+)/)
+            .map { |elem| elem.map(&:strip) }
+            .to_h
+        end
+
+        def decorate_context_items(context_items, options)
+          return context_items if !context_items.is_a?(Hash)
+
+          context_items
+            .map do |(key, val)|
+              if val.is_a?(Hash)
+                [key, decorate_context_items(val, options)]
+              elsif key == REMARKS_ATTRIBUTE
+                [key,
+                 val&.map do |remark|
+                   Metanorma::Plugin::Lutaml::ExpressRemarksDecorator
+                     .call(remark, options)
+                 end]
+              elsif val.is_a?(Array)
+                [key, val.map { |n| decorate_context_items(n, options) }]
+              else
+                [key, val]
+              end
+            end
+            .to_h
+        end
+
         def parse_context_block(context_lines:,
                                 context_items:,
                                 context_name:,

data/lib/metanorma/plugin/lutaml/{lutaml_datamodel_attributes_table_preprocessor.rb → lutaml_uml_attributes_table_preprocessor.rb}

@@ -11,10 +11,10 @@ module Metanorma
   module Plugin
     module Lutaml
       #  Macro for quick rendering of datamodel attributes/values table
-      #  @example [lutaml_datamodel_attributes_table,path/to/lutaml,EntityName]
-      class LutamlDatamodelAttributesTablePreprocessor < Asciidoctor::Extensions::Preprocessor
+      #  @example [lutaml_uml_attributes_table,path/to/lutaml,EntityName]
+      class LutamlUmlAttributesTablePreprocessor < Asciidoctor::Extensions::Preprocessor
         MARCO_REGEXP =
-          /\[lutaml_datamodel_attributes_table,([^,]+),?(.+)?,([^,]+),?(.+)?\]/
+          /\[lutaml_uml_attributes_table,([^,]+),?(.+)?,([^,]+),?(.+)?\]/
         # search document for block `datamodel_attributes_table`
         #  read include derectives that goes after that in block and transform
         #  into yaml2text blocks
@@ -29,10 +29,6 @@ module Metanorma
           ::Lutaml::Parser
             .parse(File.new(Utils.relative_file_path(document, file_path),
                             encoding: "UTF-8"))
-        rescue => e
-          require 'byebug'
-          byebug
-          i =10
         end
 
         def processed_lines(document, input_lines)
@@ -49,12 +45,12 @@ module Metanorma
 
         def parse_marco(lutaml_path, entity_name, document)
           lutaml_document = lutaml_document_from_file(document, lutaml_path)
-                              .serialized_document
-          entities = [lutaml_document['classes'], lutaml_document['enums']]
-                      .compact
-                      .flatten
-          entity_definition = entities.find do |klass|
-            klass['name'] == entity_name.strip
+            .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)
         end
@@ -63,12 +59,13 @@ module Metanorma
           render_result, errors = Utils.render_liquid_string(
             template_string: table_template,
             context_items: entity_definition,
-            context_name: 'definition'
+            context_name: "definition"
           )
           Utils.notify_render_errors(document, errors)
           render_result.split("\n")
         end
 
+        # rubocop:disable Layout/IndentHeredoc
         def table_template
           <<~TEMPLATE
           === {{ definition.name }}
@@ -90,7 +87,7 @@ module Metanorma
           |Name |Definition |Mandatory/ Optional/ Conditional |Max Occur |Data Type
 
           {% for item in definition.attributes %}
-          |{{ item.name }} |{% if item.definition %}{{ item.definition }}{% else %}TODO: enum {{ key }}'s 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 }}`
+          |{{ item.name }} |{% if item.definition %}{{ item.definition }}{% else %}TODO: enum {{ key }}'s 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 %}
@@ -98,6 +95,7 @@ module Metanorma
 
           TEMPLATE
         end
+        # rubocop:enable Layout/IndentHeredoc
       end
     end
   end

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

@@ -31,7 +31,44 @@ module Metanorma
               .warn("Liquid render error: #{error_obj.message}")
           end
         end
+
+        def process_express_index(folder, name, idxs, document)
+          idxs[name] = []
+          Dir["#{Utils.relative_file_path(document, folder)}/*"].each do |path|
+            next if [".", ".."].include?(path)
+
+            begin
+              idxs[name]
+                .push(::Lutaml::Parser.parse(File.new(path, encoding: "UTF-8")).to_liquid)
+            rescue StandardError => e
+              document.logger.warn("Failed to load #{path}: #{e.message}")
+            end
+          end
+        end
+
+        def parse_document_express_indexes(document, input_lines)
+          express_indexes = {}
+          loop do
+            line = input_lines.next
+            break if line.length.zero?
+
+            _, name, folder = line.match(/^:lutaml-express-index:(.+?);(.+?)$/)&.to_a
+            if folder && name
+              process_express_index(
+                folder.strip.gsub(";", ""),
+                name.strip,
+                express_indexes,
+                document
+              )
+            end
+          end
+          express_indexes
+        rescue StopIteration
+          express_indexes
+        ensure
+          input_lines.rewind
+        end
       end
     end
   end
-end
+end

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

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Lutaml
-      VERSION = "0.2.0".freeze
+      VERSION = "0.2.4-alpha.1".freeze
     end
   end
 end

data/metanorma-plugin-lutaml.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "liquid"
-  spec.add_dependency "lutaml", "~> 0.3.0"
+  spec.add_dependency "lutaml", "0.4.1.pre.alpha.1"
   spec.add_dependency "lutaml-uml", "~> 0.2.0"
   spec.add_dependency "metanorma"
   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.2.0
+  version: 0.2.4.pre.alpha.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -28,16 +28,16 @@ dependencies:
   name: lutaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.1.pre.alpha.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.1.pre.alpha.1
 - !ruby/object:Gem::Dependency
   name: lutaml-uml
   requirement: !ruby/object:Gem::Requirement
@@ -251,12 +251,14 @@ files:
 - bin/console
 - bin/setup
 - lib/metanorma-plugin-lutaml.rb
-- lib/metanorma/plugin/lutaml/lutaml_datamodel_attributes_table_preprocessor.rb
+- lib/metanorma/plugin/lutaml/express_remarks_decorator.rb
 - lib/metanorma/plugin/lutaml/lutaml_diagram_block.rb
 - lib/metanorma/plugin/lutaml/lutaml_preprocessor.rb
+- lib/metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor.rb
 - lib/metanorma/plugin/lutaml/utils.rb
 - lib/metanorma/plugin/lutaml/version.rb
 - metanorma-plugin-lutaml.gemspec
+- pkg/metanorma-plugin-lutaml-0.2.0.gem
 homepage: https://github.com/metanorma/metanorma-plugin-lutaml
 licenses:
 - BSD-2-Clause
@@ -272,11 +274,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Metanorma plugin for LutaML