metanorma-plugin-lutaml 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e854f55d18dbd63e113f74e940689320384a8840912ef16f7a6880e13672ee6
-  data.tar.gz: ebf477f3262b209fc4edad4b1908b911d7737d343c2eb42383207de0aeb30b2d
+  metadata.gz: cf1f2a866187d3c88f1948cfee8cac317fd17aa01a6ed3896470689b5dc644d1
+  data.tar.gz: 47752b4c4b8cd0fc9f086d83a00dbad165940650ef14353c860b3cbe8c22dd41
 SHA512:
-  metadata.gz: e530b0648b11116825ac6f1435f5c8d533102bbd212b6e4ab4d4c81d3378d67cb2c39ce32dffe5585d8801b34e2b8a647809fd2eafbdd879e27a01b975f3888e
-  data.tar.gz: 5a216d14209e1183b19c1301c7273639f379ab1d7e025a7ded83f135a46a5834568bb154335d8bd7cfc33c967825ae5d7b38c96289d0047c8c74cee3b9b2f0ca
+  metadata.gz: b2c871c4788077d0e853813452119c8639fc8d539103a312be1781f17d0e22968b29d28ac62f78f887fc4714123ff598f42b591c8747b14c48ae5c034f356c6a
+  data.tar.gz: f1545cb37a21c5ec2f00078b9e556bcba25197409a4e42902734cdc378d6b3e1a1822abf4d13f0e92d55c1ad22c58b87e60a90b3873bf088987dc47233404328

data/.github/workflows/rake.yml

@@ -0,0 +1,81 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ main ]
+    tags: [ v* ]
+  pull_request:
+
+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: [ '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '2.7'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'macos-latest'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Use Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Update gems
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Install Grpahviz Ubuntu
+        if: matrix.os == 'ubuntu-latest'
+        run: sudo apt-get install graphviz
+
+      - name: Install Grpahviz macOS
+        if: matrix.os == 'macos-latest'
+        run: brew install graphviz
+
+      - name: Install Grpahviz Windows
+        if: matrix.os == 'windows-latest'
+        uses: nick-invision/retry@v1
+        with:
+          polling_interval_seconds: 5
+          timeout_minutes: 5
+          max_attempts: 3
+          command: choco install --no-progress graphviz --version 2.38.0.20190211
+
+      - name: Check dot command
+        if: matrix.os == 'windows-latest'
+        run: |
+          dot -?
+
+      - 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,2 +1,3 @@
 Gemfile.lock
 .rspec_status
+spec/assets/lutaml

data/Gemfile

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

data/README.adoc

@@ -1,5 +1,7 @@
 = metanorma-plugin-lutaml
 
+image:https://github.com/metanorma/metanorma-plugin-lutaml/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-plugin-lutaml/actions?workflow=rake"]
+
 == Functionality
 
 Metanorma plugin that allows you to access lutaml objects from a Metanorma document
@@ -11,7 +13,7 @@ Metanorma plugin that allows you to access lutaml objects from a Metanorma docum
 $ gem install metanorma-plugin-lutaml
 ----
 
-=== Usage
+=== Usage, `lutaml` macro
 
 Given `example.exp` file with the content:
 
@@ -71,6 +73,82 @@ Will produce this output:
 === my_type5
 -----
 
+This macro also supports `.lutaml` files.
+
+=== Usage, `lutaml_datamodel_attributes_table` macro
+
+This macro allows to quickly render datamodel attributes/values tables. Given `example.lutaml` file with the content:
+
+[source,java]
+----
+diagram MyView {
+  title "my diagram"
+
+  enum AddressClassProfile {
+    imlicistAttributeProfile: CharacterString [0..1] {
+      definition
+        this is multiline with `ascidoc`
+      end definition
+    }
+  }
+
+  class AttributeProfile {
+    +addressClassProfile: CharacterString [0..1]
+    imlicistAttributeProfile: CharacterString [0..1] {
+      definition this is attribute definition
+    }
+  }
+}
+----
+
+And the `lutaml_datamodel_attributes_table` macro:
+
+[source,adoc]
+-----
+[lutaml_datamodel_attributes_table, example.lutaml, AttributeProfile]
+-----
+
+Will produce this output:
+
+[source,adoc]
+-----
+=== AttributeProfile
+
+
+.AttributeProfile attributes
+|===
+|Name |Definition |Mandatory/ Optional/ Conditional |Max Occur |Data Type
+
+|addressClassProfile |TODO: enum 's definition |M |1 | `CharacterString`
+
+|imlicistAttributeProfile |this is attribute definition with multiply lines |M |1 | `CharacterString`
+
+|===
+-----
+
+In case of "enumeration"(AddressClassProfile) entity:
+
+[source,adoc]
+-----
+[lutaml_datamodel_attributes_table, example.lutaml, AddressClassProfile]
+-----
+
+Will produce this output:
+
+[source,adoc]
+-----
+=== AddressClassProfile
+
+
+.AddressClassProfile values
+|===
+|Name |Definition
+
+|imlicistAttributeProfile |this is multiline with `ascidoc`
+
+|===
+-----
+
 == Documentation
 
 See https://www.metanorma.com.

data/lib/metanorma-plugin-lutaml.rb

@@ -1,5 +1,7 @@
 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_diagram_block"
 
 module Metanorma
   module Plugin

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

@@ -0,0 +1,104 @@
+# 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_datamodel_attributes_table,path/to/lutaml,EntityName]
+      class LutamlDatamodelAttributesTablePreprocessor < Asciidoctor::Extensions::Preprocessor
+        MARCO_REGEXP =
+          /\[lutaml_datamodel_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"))
+        rescue => e
+          require 'byebug'
+          byebug
+          i =10
+        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[3]
+              result.push(*parse_marco(lutaml_path, entity_name, document))
+            else
+              result.push(line)
+            end
+          end
+        end
+
+        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
+          end
+          model_representation(entity_definition, document)
+        end
+
+        def model_representation(entity_definition, document)
+          render_result, errors = Utils.render_liquid_string(
+            template_string: table_template,
+            context_items: entity_definition,
+            context_name: 'definition'
+          )
+          Utils.notify_render_errors(document, errors)
+          render_result.split("\n")
+        end
+
+        def table_template
+          <<~TEMPLATE
+          === {{ definition.name }}
+          {{ 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 %}
+          .{{ definition.name }} attributes
+          |===
+          |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 }}`
+          {% endfor %}
+          |===
+          {% endif %}
+          {% endif %}
+
+          TEMPLATE
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# 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
+      class LutamlDiagramBlock < Asciidoctor::Extensions::BlockProcessor
+        use_dsl
+        named :lutaml_diagram
+        on_context :literal
+        parse_content_as :raw
+
+        def abort(parent, reader, attrs, msg)
+          warn(msg)
+          attrs["language"] = "lutaml"
+          create_listing_block(
+            parent,
+            reader.source,
+            attrs.reject { |k, v| k == 1 })
+        end
+
+        def process(parent, reader, attrs)
+          uml_document = ::Lutaml::Uml::Parsers::Dsl.parse(lutaml_temp(reader))
+          filename = generate_file(parent, reader, uml_document)
+          through_attrs = generate_attrs(attrs)
+          through_attrs["target"] = filename
+          through_attrs["title"] = uml_document.caption
+          create_image_block(parent, through_attrs)
+        rescue => e
+          abort(parent, reader, attrs, e.message)
+        end
+
+        private
+
+        def lutaml_temp(reader)
+          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)
+          formatter = ::Lutaml::Uml::Formatter::Graphviz.new
+          formatter.type = :png
+
+          imagesdir = if parent.document.attr('imagesdir')
+                        File.join(parent.document.attr('imagesdir'), 'lutaml')
+                      else
+                        '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!"
+
+          outfile = Tempfile.new(['lutaml', '.png'])
+          outfile.binmode
+          outfile.puts(formatter.format(uml_document))
+
+          # Warning: metanorma/metanorma-standoc#187
+          # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
+          # This is why we need to copy and then unlink.
+          filename = File.basename(outfile.path)
+          FileUtils.cp(outfile, result_pathname) && outfile.unlink
+
+          File.join(result_pathname, filename)
+        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
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,7 @@ require "liquid"
 require "asciidoctor"
 require "asciidoctor/reader"
 require "lutaml"
+require "metanorma/plugin/lutaml/utils"
 
 module Metanorma
   module Plugin
@@ -20,7 +21,7 @@ module Metanorma
 
         def content_from_file(document, file_path)
           ::Lutaml::Parser
-            .parse(File.new(relative_file_path(document, file_path),
+            .parse(File.new(Utils.relative_file_path(document, file_path),
                             encoding: "UTF-8"))
         end
 
@@ -34,15 +35,6 @@ module Metanorma
           result
         end
 
-        def relative_file_path(document, file_path)
-          docfile_directory = File.dirname(
-            document.attributes["docfile"] || "."
-          )
-          document
-            .path_resolver
-            .system_path(file_path, docfile_directory)
-        end
-
         def process_text_blocks(document, input_lines)
           line = input_lines.next
           block_match = line.match(/^\[lutaml,(.+?),(.+?)\]/)
@@ -81,32 +73,14 @@ module Metanorma
                                 context_items:,
                                 context_name:,
                                 document:)
-          render_result, errors = render_liquid_string(
+          render_result, errors = Utils.render_liquid_string(
             template_string: context_lines.join("\n"),
             context_items: context_items,
             context_name: context_name
           )
-          notify_render_errors(document, errors)
+          Utils.notify_render_errors(document, errors)
           render_result.split("\n")
         end
-
-        def render_liquid_string(template_string:, context_items:,
-                                 context_name:)
-          liquid_template = Liquid::Template.parse(template_string)
-          rendered_string = liquid_template
-            .render(context_name => context_items,
-                    strict_variables: true,
-                    error_mode: :warn)
-          [rendered_string, liquid_template.errors]
-        end
-
-        def notify_render_errors(document, errors)
-          errors.each do |error_obj|
-            document
-              .logger
-              .warn("Liquid render error: #{error_obj.message}")
-          end
-        end
       end
     end
   end

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

@@ -0,0 +1,37 @@
+module Metanorma
+  module Plugin
+    module Lutaml
+      # Helpers for lutaml macroses
+      module Utils
+        module_function
+
+        def relative_file_path(document, file_path)
+          docfile_directory = File.dirname(
+            document.attributes["docfile"] || "."
+          )
+          document
+            .path_resolver
+            .system_path(file_path, docfile_directory)
+        end
+
+        def render_liquid_string(template_string:, context_items:,
+                                 context_name:)
+          liquid_template = Liquid::Template.parse(template_string)
+          rendered_string = liquid_template
+            .render(context_name => context_items,
+                    strict_variables: true,
+                    error_mode: :warn)
+          [rendered_string, liquid_template.errors]
+        end
+
+        def notify_render_errors(document, errors)
+          errors.each do |error_obj|
+            document
+              .logger
+              .warn("Liquid render error: #{error_obj.message}")
+          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.1.0".freeze
+      VERSION = "0.2.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -241,6 +241,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rake.yml"
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -250,7 +251,10 @@ files:
 - bin/console
 - bin/setup
 - lib/metanorma-plugin-lutaml.rb
+- lib/metanorma/plugin/lutaml/lutaml_datamodel_attributes_table_preprocessor.rb
+- lib/metanorma/plugin/lutaml/lutaml_diagram_block.rb
 - lib/metanorma/plugin/lutaml/lutaml_preprocessor.rb
+- lib/metanorma/plugin/lutaml/utils.rb
 - lib/metanorma/plugin/lutaml/version.rb
 - metanorma-plugin-lutaml.gemspec
 homepage: https://github.com/metanorma/metanorma-plugin-lutaml
@@ -272,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
 summary: Metanorma plugin for LutaML