metanorma-plugin-lutaml 0.4.14 → 0.4.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d32e2622337e811833b81c4a3be6ff720d5b062807cd1e11532a4178e75a7f50
-  data.tar.gz: d048df682f6c5cc77770d74585b87644cf43d27e4bad65cfad6829fe3c75c2ad
+  metadata.gz: 6c9422de6e2f133c37c7cae0195312bf6ca63f763a544535fbe21f62f4c1b7ef
+  data.tar.gz: 4a88c4264ab7f8f6bca636902d3e06c17b0aa2ca349fb7c7f1ee9240eb4c13c2
 SHA512:
-  metadata.gz: 51972b3a3ca4fa2701813aefb8425cee81499725e8b488dd99098e446b1b37e8580cad84629e058ddab4ff8bd8db272558cd3f2666316623a9801407bd65ead6
-  data.tar.gz: 198d5703597a8c28a55e0d8c8845bc74738fbb3248fbc376d9c8488836c606f4d4e198bff24c24444d5c019455baa5f72ed970f51ef02f85845d1cc55c63f5a8
+  metadata.gz: '08e44fa7e98636dcabccc17c1f43bd7abec874328c5e8db2f6005bb9804e75e6b427aad4a2c41157f8fdb54a846014c3041b8aded4b4071f1802351ad2add5ae'
+  data.tar.gz: 32aa9bd9de63aa8c07517ed72425685f565c600f4f9e8996fcebbc5fbe8afdfcb77e130f4f499b0ba5dce36e85f9dfa6c33f5e8b52f103175d6ab8700e69ed6e

data/.github/workflows/rake.yml

@@ -10,34 +10,6 @@ on:
 
 jobs:
   rake:
-    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-    steps:
-      - uses: actions/checkout@master
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - uses: metanorma/metanorma-build-scripts/plantuml-setup-action@master
-
-      - run: bundle exec rake
-
-  tests-passed:
-    needs: rake
-    runs-on: ubuntu-latest
-    steps:
-      - uses: peter-evans/repository-dispatch@v1
-        with:
-          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
-          repository: ${{ github.repository }}
-          event-type: tests-passed
-          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
+    uses: metanorma/ci/.github/workflows/plantuml-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  push:
+    tags: [ v* ]
+
+jobs:
+  release:
+    uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+

data/.gitignore

@@ -1,4 +1,6 @@
 Gemfile.lock
 .rspec_status
 spec/assets/lutaml
-test.err
+test.err
+
+.rubocop-https--*

data/Gemfile

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

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

@@ -92,7 +92,7 @@
 {% if additional_context.external_classes[klass.name] %}
 | <<{{ additional_context.external_classes[klass.name] }},{{ klass.name }}>> «{{ klass.stereotype }}»
 {% else %}
-| | <<section-{{ klass.xmi_id }},{{ klass.name }}>> «{{ klass.stereotype }}»
+| <<section-{{ klass.xmi_id }},{{ klass.name }}>> «{{ klass.stereotype }}»
 {% endif %}
 | {{ klass.definition | replace: '|', '\|' }}
 
@@ -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
+          {% if definition.keyword == 'enumeration' %}
+          #{equalsigns(depth) + " Enumeration: {{ definition.name }}" unless skip_headers}
+          {% else %}
+          #{equalsigns(depth) + " Class: {{ definition.name }}" unless skip_headers}
+          {% endif %}
+
+          #{equalsigns(depth+1)} Description
+
+          {{ definition.definition }}
+
+          {% if definition.attributes %}
+          {% if definition.keyword == 'enumeration' %}
+          {% for item in definition.attributes %}
+          #{equalsigns(depth+1)} Enumeration value: {{item.name}}
+
+          {% if item.definition %}
+          {{ item.definition }}
+          {% endif %}
+
+          {% endfor %}
+
+          {% else %}
+
+          {% for item in definition.attributes %}
+          #{equalsigns(depth+1)} Attribute: {{item.name}}
+
+          {% if item.definition %}
+          {{ item.definition }}
+          {% endif %}
+
+          Value type and multiplicity:
+          {% if item.type -%}{{ item.type }}{% else -%}(no type specified){% endif %}
+          {% if item.cardinality.min -%}
+          {% if item.cardinality.max -%}
+          {blank}[{{item.cardinality.min}}..{{item.cardinality.max}}]
+          {% else -%}
+          {blank}[{{item.cardinality.min}}]
+          {% endif -%}
+          {% else -%}
+          (multiplicity unspecified)
+          {% endif %}
+
+          {% if item.origin %}
+          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.14".freeze
+      VERSION = "0.4.18".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

@@ -23,9 +23,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "asciidoctor"
+  spec.add_dependency "expressir"
   spec.add_dependency "liquid"
   spec.add_dependency "lutaml"
-  spec.add_dependency "metanorma"
   spec.add_dependency "relaton-cli"
   spec.add_dependency "reverse_adoc"
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.4.14
+  version: 0.4.18
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: liquid
+  name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: lutaml
+  name: expressir
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: metanorma
+  name: liquid
+  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: lutaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -242,6 +256,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/rake.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rubocop.yml"
@@ -277,11 +292,11 @@ 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
@@ -301,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.16
 signing_key:
 specification_version: 4
 summary: Metanorma plugin for LutaML