metanorma-plugin-lutaml 0.4.15 → 0.4.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac83fb068848793194a604aa3da4a32bd1ee9cdc8a71bb1715fe2f44b230fded
-  data.tar.gz: 4b818c299336493cd3c1134165c1dacbef645ed648cc08322974ce5fb8678ccd
+  metadata.gz: b9de85f722161434bc11ef77517f1e739db67b01608aead2e935b8a38ff6594d
+  data.tar.gz: bf10f9594b2cf84b594c1dba9012e9979f1c3b3fd0339892f7302882039f7a9e
 SHA512:
-  metadata.gz: bc4635a30a4715c1adcc9fed82a76d7258646d435079bbb1003ce1ebc41edf980a66d77429a42111068fcfc106cb3dc9a872eaa00780dc07c13664d94dc62731
-  data.tar.gz: 7634e9dfafe63910b9a3b0e6c29b29db6ca894d3f71612db60e1b5c97913db116c95a624cbba6181ce55cd24acf2a84766868b017be3907b9b8eef0396a297c9
+  metadata.gz: e6125065c5246f84dee92b5894f0ffb5353c55cc1b8fc3e5355e738096b4db1b005a9ef5913070c6d2130cff77338c0913e3d8ba8bb93ef7a619415cfe2ae6a8
+  data.tar.gz: a77a4b168701ea0a425fd6bdf9cff83195926c16ff1be07db7bbb775e7d43d29a74d7754e9e43aeda508a16bd0d5096aee84c1dca5e1c4fa949de617cf5781a9

data/README.adoc

@@ -212,6 +212,80 @@ diagram MyView {
 ....
 ----
 
+=== Generating UML class and attributes: `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`.
+
 
 === `lutaml_uml_attributes_table`
 

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

@@ -101,7 +101,7 @@
 |===
 {% endunless %}
 
-{% assign non_unions = package.data_types | where: "stereotype", "DataType"  %}
+{% assign non_unions = package.data_types | where: "stereotype", "DataType" %}
 {% if non_unions.size > 0 %}
 {% include "packages_entity_list_classes", classes: non_unions, type: "Data types", depth: nested_depth %}
 {% endif %}

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

@@ -5,7 +5,6 @@ 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

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

@@ -17,7 +17,7 @@ module Metanorma
           xmi_id = parent.document.attributes['lutaml_entity_id'][entity_key]
           return unless xmi_id
 
-          %Q(<xref target="section-#{xmi_id}"></xref>)
+          %Q(<xref target="section-#{xmi_id}"/>)
         end
       end
     end

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

@@ -1,75 +1,20 @@
 # frozen_string_literal: true
 
-require "liquid"
-require "asciidoctor"
-require "asciidoctor/reader"
-require "lutaml"
-require "lutaml/uml"
-require "metanorma/plugin/lutaml/utils"
+require_relative "./lutaml_uml_class_preprocessor.rb"
 
 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 < Asciidoctor::Extensions::Preprocessor
-        MARCO_REGEXP =
+      class LutamlUmlAttributesTablePreprocessor < LutamlUmlClassPreprocessor
+        MACRO_REGEXP =
           /\[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
-        def process(document, reader)
-          input_lines = reader.readlines.to_enum
-          Asciidoctor::Reader.new(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
-
-        def processed_lines(document, input_lines)
-          input_lines.each_with_object([]) do |line, result|
-            if match = line.match(MARCO_REGEXP)
-              lutaml_path = match[1]
-              entity_name = match[2]
-              skip_headers = match[3]
-              result.push(*parse_marco(lutaml_path, entity_name, document, skip_headers))
-            else
-              result.push(line)
-            end
-          end
-        end
-
-        def parse_marco(lutaml_path, entity_name, document, skip_headers)
-          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, skip_headers)
-        end
-
-        def model_representation(entity_definition, document, skip_headers)
-          render_result, errors = Utils.render_liquid_string(
-            template_string: table_template(skip_headers),
-            context_items: entity_definition,
-            context_name: "definition",
-            document: document
-          )
-          Utils.notify_render_errors(document, errors)
-          render_result.split("\n")
-        end
 
         # rubocop:disable Layout/IndentHeredoc
-        def table_template(skip_headers)
+        def template(options)
+          skip_headers = options[:skip_headers]
+
           <<~TEMPLATE
           #{"=== {{ definition.name }}" unless skip_headers}
           {{ definition.definition }}
@@ -100,6 +45,7 @@ module Metanorma
         end
         # rubocop:enable Layout/IndentHeredoc
       end
+
     end
   end
 end

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

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require "liquid"
+require "asciidoctor"
+require "asciidoctor/reader"
+require "lutaml"
+require "lutaml/uml"
+require "metanorma/plugin/lutaml/utils"
+
+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,([^,]+),?([^,]+),?(.+?)?\]/
+
+        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)
+          input_lines = reader.readlines.to_enum
+          Asciidoctor::Reader.new(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
+        }
+        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_marco(lutaml_path, entity_name, document, options))
+            else
+              result.push(line)
+            end
+          end
+        end
+
+        def parse_marco(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
+          #{equalsigns(depth) + " {{ 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 %}
+          #{equalsigns(depth+1)} Attributes
+
+          {% for item in definition.attributes %}
+          #{equalsigns(depth+2)} {{item.name}}
+
+          {% if item.definition %}
+          {{ item.definition }}
+          {% endif %}
+
+          .Specification of `{{ definition.name }}.{{ item.name }}`
+          [cols="h,a"]
+          |===
+
+          h|Value type and multiplicity
+          |
+          `{{ item.type }}`
+          {% if item.cardinality.min -%}
+          {% if item.cardinality.max -%}
+          `[{{item.cardinality.min}}..{{item.cardinality.max}}]`
+          {% else -%}
+          `[{{item.cardinality.min}}]`
+          {% endif -%}
+          {% else -%}
+          (multiplicity unspecified)
+          {% endif %}
+
+          {% if item.origin %}
+          h|Origin
+          |<<{{ item.origin }}>>
+          {% endif %}
+
+          |===
+          {% endfor %}
+
+          {% endif %}
+          {% endif %}
+
+          TEMPLATE
+        end
+        # rubocop:enable Layout/IndentHeredoc
+      end
+    end
+  end
+end

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

@@ -14,7 +14,7 @@ module Metanorma
       #  @example [lutaml_uml_attributes_table,path/to/lutaml,EntityName]
       class LutamlUmlDatamodelDescriptionPreprocessor <
           Asciidoctor::Extensions::Preprocessor
-        MARCO_REGEXP =
+        MACRO_REGEXP =
           /\[lutaml_uml_datamodel_description,([^,]+),?(.+)?\]/
         LIQUID_INCLUDE_PATH = File.join(
           Gem.loaded_specs["metanorma-plugin-lutaml"].full_gem_path,
@@ -72,7 +72,7 @@ module Metanorma
 
         def process_text_blocks(document, input_lines)
           line = input_lines.next
-          block_match = line.match(MARCO_REGEXP)
+          block_match = line.match(MACRO_REGEXP)
           return [line] if block_match.nil?
 
           lutaml_document = lutaml_document_from_file_or_cache(document, block_match[1])
@@ -232,7 +232,7 @@ module Metanorma
         def model_representation(lutaml_document, document, additional_context, options)
           fill_in_entities_refs_attributes(document, lutaml_document, options)
           render_result, errors = Utils.render_liquid_string(
-            template_string: table_template(options['section_depth'] || 2, options['render_style'], options['include_root']),
+            template_string: template(options['section_depth'] || 2, options['render_style'], options['include_root']),
             context_items: create_context_object(lutaml_document,
                               additional_context,
                               options),
@@ -244,7 +244,7 @@ module Metanorma
           render_result.split("\n")
         end
 
-        def table_template(section_depth, render_style, include_root)
+        def template(section_depth, render_style, include_root)
           include_name = RENDER_STYLES_INCLUDES.fetch(render_style, DEFAULT_RENDER_INCLUDE)
           result = ""
           if include_root

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

@@ -1,3 +1,5 @@
+require "expressir"
+require "expressir/express/parser"
 require "expressir/express/cache"
 require "metanorma/plugin/lutaml/liquid/custom_filters"
 require "metanorma/plugin/lutaml/liquid/multiply_local_file_system"

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

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

data/lib/metanorma-plugin-lutaml.rb

@@ -1,5 +1,6 @@
 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_diagram_block"
@@ -12,4 +13,15 @@ module Metanorma
     module Lutaml
     end
   end
+
+  Asciidoctor::Extensions.register do
+    preprocessor Metanorma::Plugin::Lutaml::LutamlPreprocessor
+    preprocessor Metanorma::Plugin::Lutaml::LutamlUmlAttributesTablePreprocessor
+    preprocessor Metanorma::Plugin::Lutaml::LutamlUmlDatamodelDescriptionPreprocessor
+    preprocessor Metanorma::Plugin::Lutaml::LutamlUmlClassPreprocessor
+    inline_macro Metanorma::Plugin::Lutaml::LutamlFigureInlineMacro
+    inline_macro Metanorma::Plugin::Lutaml::LutamlTableInlineMacro
+    block_macro Metanorma::Plugin::Lutaml::LutamlDiagramBlockMacro
+    block Metanorma::Plugin::Lutaml::LutamlDiagramBlock
+  end
 end

data/metanorma-plugin-lutaml.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "metanorma"
   spec.add_dependency "relaton-cli"
   spec.add_dependency "reverse_adoc"
+  spec.add_dependency "expressir"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "equivalent-xml"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.4.15
+  version: 0.4.17
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-08 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: expressir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -278,16 +292,16 @@ files:
 - 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
 - metanorma-plugin-lutaml.gemspec
-- pkg/metanorma-plugin-lutaml-0.2.0.gem
 homepage: https://github.com/metanorma/metanorma-plugin-lutaml
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -302,8 +316,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Metanorma plugin for LutaML
 test_files: []