metanorma-plugin-lutaml 0.4.18.2 → 0.4.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 064d8f98bd52afff8e006ba4fa16f4a008465409cd5e817f30d797b728354a02
-  data.tar.gz: ef86f1cb94f2b384cba57a2621f35826381e88ec4565ca0821f001d7836a044b
+  metadata.gz: e771e99cf0ac118f04aa3b40610b0e071ff98d78ebaa34b7ac4516636a2e1808
+  data.tar.gz: 17ae5e488c425071a80aaa0799736b1f336611ef0caa68e2eebaa0788df86383
 SHA512:
-  metadata.gz: 6ea24f0034a859174c135f3a3682f3891933a0b274921a3a7976ca9b089dc6751a3c0697a488add414a7d2bc2b3f538fb356e2a4a3b60e967e6176a8713ace18
-  data.tar.gz: 2d7a47613ee5c1460c66070f2eb8a3d145ea691e1b1e63ff4520f14e69bcc194f1a8ead7b93c7fe4c55fb9bac84be59441773631d1690a8f2c70ad5382ebfe13
+  metadata.gz: 8260ba15824b2e1838e34e3ba3f5d954ee3dfaf6b697821ce55972aa8b428ea12a932b6eafb71275e5958b971f65a30481431c86a34f1de9e6b1a28d7c68010c
+  data.tar.gz: '008027e782ef69b19b6132a6fd139b8f04cd7dd5cc6e7ada361ef4c70c36923023213d3eccc4b30118c64421574700d1cf83677969047d99bceaf440e08bd8e4'

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

@@ -1,5 +1,5 @@
 {% for package in context.packages %}
-{% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" %}
+{% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" | replace: "-", "_" %}
 {% if additional_context.before and additional_context.before.size > 0 %}
 {% for before in additional_context.before %}
 {% if before.text %}

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

@@ -67,13 +67,13 @@
 {% endfor %}
 {% endif %}
 
-.Metadata of {{ package.name }} ({{ package.stereotype }})
+.Metadata of {{ package.name }} {% if package.stereotype %}(«{{package.stereotype}}»){% endif %}
 [cols="1a,4a"]
 |===
 
-h|Description:    | {{ package.definition | replace: '|', '\|' }}
+h|Description:    | {{ package.definition | replace: '|', '\|' | html2adoc }}
 h|Parent package: | {{ context.name }}
-h|Stereotype:     | «{{ package.stereotype }}»
+h|Stereotype:     | {% if package.stereotype %}«{{package.stereotype}}»{% else %}None{% endif %}
 
 |===
 
@@ -139,12 +139,12 @@ None.
 [[section-{{ data_type.xmi_id }}]]
 {{equalsigns}}== {{ data_type.name }}
 
-.Metadata of {{ data_type.name }} ({{ data_type.stereotype }})
+.Metadata of {{ data_type.name }} {% if data_type.stereotype %}(«{{data_type.stereotype}}»){% endif %}
 [cols="1a,4a"]
 |===
-h|Definition:  | {{ data_type.definition | replace: '|', '\|' }}
+h|Definition:  | {{ data_type.definition | replace: '|', '\|' | html2adoc }}
 h|Subclass of: | {% if generalizations.size > 0 %}{{ generalizations }}{% else %}None{% endif %}
-h|Stereotype:  | «{{ data_type.stereotype }}»
+h|Stereotype:  | {% if data_type.stereotype %}«{{data_type.stereotype}}»{% else %}None{% endif %}
 
 {% if data_type.constraints.size > 0 %}
 {% for constraint in data_type.constraints %}
@@ -167,7 +167,7 @@ h| Constraint:
 {% capture cardinality %}[{% case assoc.member_end_cardinality.min %}{% when "C" %}0{% when "M" %}1{% else %}{{assoc.member_end_cardinality.min}}{% endcase %}..{{ assoc.member_end_cardinality.max }}]{% endcapture %}
 | {{ assoc.member_end_attribute_name }}
 {% if additional_context.external_classes[assoc.member_end] %}| <<{{ additional_context.external_classes[assoc.member_end] }},{{assoc.member_end}}>> {{ cardinality }}{% else %}| <<section-{{ assoc.member_end_xmi_id }},{{assoc.member_end}}>> {{ cardinality }}{% endif %}
-| {{ assoc.definition | replace: '|', '\|' }}
+| {{ assoc.definition | replace: '|', '\|' | html2adoc }}
 {% endif %}
 {% endfor %}
 {% endcapture %}
@@ -196,7 +196,7 @@ h| Constraint:
 {% capture cardinality %}&#91;{% case attr.cardinality.min %}{% when 'C' %}0{% when 'M' %}1{% else %}{{ attr.cardinality.min }}{% endcase %}..{{ attr.cardinality.max }}&#93;{% endcapture %}
 | {{ attr.name }}
 {% if additional_context.external_classes[attr.type] %}| <<{{ additional_context.external_classes[attr.type] }},{{ attr.type }}>> {{ cardinality }}{% else %}| <<section-{{ attr.xmi_id }},{{ attr.type }}>> {{ cardinality }}{% endif %}
-| {{ attr.definition | replace: '|', '\|' }}
+| {{ attr.definition | replace: '|', '\|' | html2adoc }}
 
 {% endfor %}
 |===
@@ -223,7 +223,7 @@ None.
 .Metadata of {{ enum.name }} (Enumeration)
 [cols="1a,4a"]
 |===
-h|Definition: | {{ enum.definition | replace: '|', '\|' }}
+h|Definition: | {{ enum.definition | replace: '|', '\|' | html2adoc }}
 h|Stereotype: | «Enumeration»
 |===
 
@@ -235,7 +235,7 @@ h|Stereotype: | «Enumeration»
 
 {% for val in enum.values %}
 | {{ val.name }}
-| {{ val.definition | replace: '|', '\|' }}
+| {{ val.definition | replace: '|', '\|' | html2adoc }}
 
 {% endfor %}
 

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

@@ -4,12 +4,26 @@
 {{equalsigns}} {{ klass.name }}
 {%comment%}(inside class: depth is {{ depth }}, equalsigns {{equalsigns}}){%endcomment%}
 
-.Metadata of {{ klass.name }} ({{klass.stereotype}})
+.Metadata of {{ klass.name }} {% if klass.stereotype %}(«{{klass.stereotype}}»){% endif %}
 [cols="1a,4a"]
 |===
-h| Definition:  | {{ klass.definition | replace: '|', '\|' }}
-h| Subclass of: | {% if generalizations.size > 0 %}{{ generalizations }}{% else %}None{% endif %}
-h| Stereotype:  | «{{ klass.stereotype }}»
+h| Definition:
+|
+{% if klass.definition %}
+{{ klass.definition | replace: '|', '\|' | html2adoc }}
+{% endif %}
+
+h| Subclass of:
+|
+{% if generalizations.size > 0 %}{{ generalizations }}{% else %}None{% endif %}
+
+h| Stereotype:
+|
+{% if klass.stereotype %}
+«{{ klass.stereotype }}»
+{% else %}
+None
+{% endif %}
 
 {% if klass.constraints.size > 0 %}
 {% for constraint in klass.constraints %}
@@ -32,7 +46,7 @@ h| Constraint:
 {% capture cardinality %}[{% case assoc.member_end_cardinality.min %}{% when "C" %}0{% when "M" %}1{% else %}{{assoc.member_end_cardinality.min}}{% endcase %}..{{ assoc.member_end_cardinality.max }}]{% endcapture %}
 | {{ assoc.member_end_attribute_name }}
 {% if additional_context.external_classes[assoc.member_end] %}| <<{{ additional_context.external_classes[assoc.member_end] }},{{assoc.member_end}}>> {{ cardinality }}{% else %}| <<section-{{ assoc.member_end_xmi_id }},{{ assoc.member_end }}>> {{ cardinality }}{% endif %}
-| {{ assoc.definition | replace: '|', '\|' }}
+| {{ assoc.definition | replace: '|', '\|' | html2adoc }}
 {% endif %}
 {% endfor %}
 {% endcapture %}
@@ -60,7 +74,7 @@ h| Constraint:
 {% capture cardinality %}&#91;{% case attr.cardinality.min %}{% when 'C' %}0{% when 'M' %}1{% else %}{{ attr.cardinality.min }}{% endcase %}..{{ attr.cardinality.max }}&#93;{% endcapture %}
 | {{ attr.name }}
 {% if additional_context.external_classes[attr.type] %}| <<{{ additional_context.external_classes[attr.type] }},{{ attr.type }}>> {{ cardinality }}{% else %}| <<section-{{ attr.xmi_id }},{{ attr.type }}>> {{ cardinality }}{% endif %}
-| {{ attr.definition | replace: '|', '\|' }}
+| {{ attr.definition | replace: '|', '\|' | html2adoc }}
 
 {% endfor %}
 |===

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

@@ -12,24 +12,38 @@ module Metanorma
     module Lutaml
       # Class for processing Lutaml files
       class LutamlPreprocessor < Asciidoctor::Extensions::Preprocessor
-        REMARKS_ATTRIBUTE = "remarks".freeze
+        REMARKS_ATTRIBUTE = "remarks"
 
         def process(document, reader)
           input_lines = reader.readlines.to_enum
+          has_lutaml = !input_lines.select { |x| lutaml?(x) }.empty?
           express_indexes = Utils.parse_document_express_indexes(
             document,
-            input_lines
+            input_lines,
           )
-          result_content = processed_lines(document, input_lines, express_indexes)
-          result_reader = Asciidoctor::PreprocessorReader.new(document, result_content)
-          result_reader
+          result_content = processed_lines(document, input_lines,
+                                           express_indexes)
+          has_lutaml and log(document, result_content)
+          Asciidoctor::PreprocessorReader.new(document, result_content)
         end
 
         protected
 
+        def log(document, result)
+          File.open("#{document.attr('docfile')}.lutaml.log.txt",
+                    "w:UTF-8") do |f|
+            f.write(result.join("\n"))
+          end
+        end
+
+        def lutaml?(line)
+          line.match(/^\[(?:\blutaml\b|\blutaml_express\b),([^,]+)?,?([^,]+)?,?([^,]+)?\]/)
+        end
+
         def content_from_files(document, file_paths)
           file_list = file_paths.map do |file_path|
-            File.new(Utils.relative_file_path(document, file_path), encoding: "UTF-8")
+            File.new(Utils.relative_file_path(document, file_path),
+                     encoding: "UTF-8")
           end
           ::Lutaml::Parser.parse(file_list)
         end
@@ -43,7 +57,7 @@ module Metanorma
               .push(*process_text_blocks(
                 document,
                 input_lines,
-                express_indexes
+                express_indexes,
               ))
           end
           result
@@ -51,7 +65,7 @@ module Metanorma
 
         def process_text_blocks(document, input_lines, express_indexes)
           line = input_lines.next
-          block_match = line.match(/^\[(?:\blutaml\b|\blutaml_express\b),([^,]+)?,?([^,]+)?,?([^,]+)?\]/)
+          block_match = lutaml?(line)
           return [line] if block_match.nil?
 
           end_mark = input_lines.next
@@ -97,7 +111,8 @@ module Metanorma
           result
         end
 
-        def parse_template(document, current_block, block_match, express_indexes)
+        def parse_template(document, current_block, block_match,
+express_indexes)
           options = parse_options(block_match[3])
           contexts_items(block_match, document, express_indexes)
             .map do |items|
@@ -112,9 +127,9 @@ module Metanorma
                                   context_items: items,
                                   context_name: block_match[2].strip)
             end.flatten
-          rescue StandardError => e
-            document.logger.warn("Failed to parse lutaml block: #{e.message}")
-            []
+        rescue StandardError => e
+          document.logger.warn("Failed to parse lutaml block: #{e.message}")
+          []
         end
 
         def parse_options(options_string)
@@ -155,7 +170,7 @@ module Metanorma
             template_string: context_lines.join("\n"),
             context_items: context_items,
             context_name: context_name,
-            document: document
+            document: document,
           )
           Utils.notify_render_errors(document, errors)
           render_result.split("\n")

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

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

data/metanorma-plugin-lutaml.gemspec

@@ -17,7 +17,9 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -30,10 +32,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "relaton-cli"
   spec.add_dependency "reverse_adoc"
 
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml"
   spec.add_development_dependency "metanorma-standoc"
-  spec.add_development_dependency "pry", "~> 0.12.2"
   spec.add_development_dependency "rake", "~> 13"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "= 0.54.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.4.18.2
+  version: 0.4.20
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,20 +136,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -316,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Metanorma plugin for LutaML