lutaml-uml 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57797f5d5a65a5bb7e781509a44460e16877d85c9becb6b6147d43a6180a931c
-  data.tar.gz: caa53fbea010657d6dd53db86460ba5dd4a991076ab078bf08a72f553e5c40da
+  metadata.gz: dc9fee04e0d3f8bf1a741dcce56ebfac843c1207d5f9f4dc8b9f42869db728f6
+  data.tar.gz: 58b0ed6fb1e66d0a34aed9fefcf6d4625f52234bf100c93ad06f62297ec3e2cb
 SHA512:
-  metadata.gz: 0ec63f9b0992f1ebab8b2c3116e49514cd5753fe4d1e327a40465c001711e0c0bf86410eba964c6aea1514e8bba91297f19d8a615e9e352d296386ab348bd6fa
-  data.tar.gz: 3971b17f96585427e99b3e4000824e99560ed096bea8489dbb62dd7dcba44eca3acd5a5a6ebc55b224aafffae9a963c866f3ca12a365bdc8dd0c54985c93f52e
+  metadata.gz: df205676bcafcb09265a81491fbca4b78b2a1dfc59d18f080e20e4ddf633a3aed9601d09cd78b32fbd297c283027681b94276e5ceb68e1613dc8cb8dcd036243
+  data.tar.gz: 9191a9ba6db3db78aa785a685e4c75c4cd69f84441cb3420dde4fbc02dec885ddcaf18c12f263aa5852439721609bb3e11930b7cbfcaf8c20b461b517a1bc84c

data/exe/lutaml-wsd2uml

@@ -27,7 +27,7 @@ ASSOCIATION_MAPPINGS = {
 in_comment_block = false
 
 def transform_line(line)
-  line = line.gsub(/^\s*'/, '** ').gsub(/\|[\sa-zA-Z]+$/, '')
+  line = line.gsub(/^\s*'/, '** ').gsub(/\|[\sa-zA-Z]+$/, '').gsub(/\r/, '')
   return sync_puts(line, 2) if ASSOCIATION_MAPPINGS.keys.none? { |key| line =~ key }
 
   owner_type, member_type = ASSOCIATION_MAPPINGS.detect { |(key, _value)| line =~ key }.last.split(",")

data/lib/lutaml/uml/package.rb

@@ -10,7 +10,7 @@ module Lutaml
 
       def initialize(attributes)
         update_attributes(attributes)
-        @children_packages ||= packages.map { |pkg| [pkg, pkg.packages.map(&:children_packages)] }.flatten
+        @children_packages ||= packages.map { |pkg| [pkg, pkg.packages, pkg.packages.map(&:children_packages)] }.flatten.uniq
       end
 
       def classes=(value)

data/lib/lutaml/uml/parsers/dsl.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "parslet"
+require "parslet/convenience"
 require "lutaml/uml/parsers/dsl_preprocessor"
 require "lutaml/uml/parsers/dsl_transform"
 require "lutaml/uml/node/document"
@@ -8,6 +9,7 @@ require "lutaml/uml/node/document"
 module Lutaml
   module Uml
     module Parsers
+      class ParsingError < StandardError; end
       # Class for parsing LutaML dsl into Lutaml::Uml::Document
       class Dsl < Parslet::Parser
         # @param [String] io - LutaML string representation
@@ -20,7 +22,15 @@ module Lutaml
 
         def parse(input_file, _options = {})
           data = Lutaml::Uml::Parsers::DslPreprocessor.call(input_file)
-          ::Lutaml::Uml::Document.new(DslTransform.new.apply(super(data)))
+          # https://kschiess.github.io/parslet/tricks.html#Reporter engines
+          # Parslet::ErrorReporter::Deepest allows more
+          # detailed display of error
+          reporter = Parslet::ErrorReporter::Deepest.new
+          ::Lutaml::Uml::Document
+            .new(DslTransform.new.apply(super(data, reporter: reporter)))
+        rescue Parslet::ParseFailed => e
+          raise(ParsingError,
+                "#{e.message}\ncause: #{e.parse_failure_cause.ascii_tree}")
         end
 
         KEYWORDS = %w[
@@ -292,9 +302,7 @@ module Lutaml
             str("definition") >>
             whitespace? >>
             str("{") >>
-            whitespace? >>
-            (match("[\n\s]}").absent? >> any).repeat.as(:definition) >>
-            whitespace? >>
+            ((str("\\") >> any) | (str("}").absent? >> any)).repeat.maybe.as(:definition) >>
             str('}')
         end
 
@@ -387,12 +395,11 @@ module Lutaml
             diagram_inner_definition.repeat.as(:members) >>
             str("}")
         end
-        rule(:diagram_body?) { diagram_body.maybe }
         rule(:diagram_definition) do
           diagram_keyword >>
             spaces? >>
             class_name.as(:name) >>
-            diagram_body? >>
+            diagram_body >>
             whitespace?
         end
         rule(:diagram_definitions) { diagram_definition >> whitespace? }

data/lib/lutaml/uml/parsers/dsl_preprocessor.rb

@@ -5,16 +5,28 @@ module Lutaml
     module Parsers
       # Class for preprocessing dsl ascii file special directives:
       # - include
-      module DslPreprocessor
-        module_function
+      class DslPreprocessor
+        attr_reader :input_file
 
-        def call(input_file)
+        def initialize(input_file)
+          @input_file = input_file
+        end
+
+        class << self
+          def call(input_file)
+            new(input_file).call
+          end
+        end
+
+        def call
           include_root = File.dirname(input_file.path)
           input_file.read.split("\n").reduce([]) do |res, line|
             res.push(*process_dsl_line(include_root, line))
           end.join("\n")
         end
 
+        private
+
         def process_dsl_line(include_root, line)
           process_include_line(include_root, process_comment_line(line))
         end
@@ -28,7 +40,7 @@ module Lutaml
 
         def process_include_line(include_root, line)
           include_path_match = line.match(/^\s*include\s+(.+)/)
-          return line if include_path_match.nil?
+          return line if include_path_match.nil? || line =~ /^\s\*\*/
 
           path_to_file = include_path_match[1].strip
           path_to_file = if path_to_file.match?(/^\//)
@@ -37,6 +49,9 @@ module Lutaml
                            File.join(include_root, path_to_file)
                          end
           File.read(path_to_file).split("\n")
+        rescue Errno::ENOENT
+          puts("No such file or directory @ rb_sysopen - #{path_to_file}, \
+            include file paths need to be supplied relative to the main document")
         end
       end
     end

data/lib/lutaml/uml/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Uml
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

data/lutaml-uml.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables   = %w[lutaml-wsd2uml lutaml-yaml2uml]
 
   spec.add_runtime_dependency "hashie", "~> 4.1.0"
-  spec.add_runtime_dependency "parslet", "~> 1.7.1"
+  spec.add_runtime_dependency "parslet", "~> 2.0.0"
   spec.add_runtime_dependency "ruby-graphviz", "~> 1.2"
   spec.add_runtime_dependency "thor", "~> 1.0"
   spec.add_runtime_dependency "nokogiri", "~> 1.10"

data/spec/fixtures/dsl/broken_diagram.lutaml

@@ -0,0 +1,34 @@
+diagram MyView {
+  title "my diagram"
+
+  class AddressClassProfile {
+    addressClassProfile
+  }
+  class AttributeProfile {
+    attributeProfile
+  }
+
+  association BidirectionalAsscoiation {
+    owner_type aggregation
+    member_type direct
+    owner AddressClassProfile#addressClassProfile
+    member AttributeProfile#attributeProfile [0..*]
+  }
+
+  association DirectAsscoiation {
+    member_type direct
+    owner AddressClassProfile
+    member AttributeProfile#attributeProfile
+  }
+
+  class Foo {
+    +structuredidentifier[0..*]: StructuredIdentifierType
+    +technicalcommittee[1..*]: TechnicalCommitteeType
+  }
+
+  association ReverseAsscoiation {
+    owner_type aggregation
+    owner AddressClassProfile#addressClassProfile
+    member AttributeProfile
+  }
+}

data/spec/fixtures/dsl/diagram_blank_definion.lutaml

@@ -0,0 +1,6 @@
+diagram MyView {
+  class ImageMapAreaType {
+    definition {
+    }
+  }
+}

data/spec/fixtures/dsl/diagram_blank_entities.lutaml

@@ -0,0 +1,8 @@
+diagram MyView {
+  class ImageMapAreaType {
+  }
+  enum SomeEnum { 
+  }
+  data_type SomeEnum {
+  }
+}

data/spec/fixtures/dsl/diagram_commented_includes.lutaml

@@ -0,0 +1,5 @@
+diagram MyView {
+  title "my diagram"
+
+  ** include ../models/bipm_document/BipmCommitteeAcronym.lutaml
+}

data/spec/fixtures/dsl/diagram_non_existing_include.lutaml

@@ -0,0 +1,6 @@
+diagram MyView {
+  fontname "Arial"
+  title "my diagram"
+  include none_existing.lutaml
+  include none_existing1.lutaml
+}

data/spec/lutaml/uml/parsers/dsl_spec.rb

@@ -287,5 +287,57 @@ RSpec.describe Lutaml::Uml::Parsers::Dsl do
 
       it_behaves_like "the correct graphviz formatting"
     end
+
+    context "when defninition is blank" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_blank_definion.lutaml"))
+      end
+
+      it "successfully renders" do
+        expect { parse }.to_not(raise_error)
+      end
+    end
+
+    context "when there are blank definitions" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_blank_entities.lutaml"))
+      end
+
+      it "successfully renders" do
+        expect { parse }.to_not(raise_error)
+      end
+    end
+
+    context "when its a non existing include file" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_non_existing_include.lutaml"))
+      end
+
+      it "successfully renders" do
+        expect { parse }.to_not(raise_error)
+      end
+    end
+
+    context "when there are commented preprocessor lines" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_commented_includes.lutaml"))
+      end
+
+      it "successfully renders" do
+        expect { parse }.to_not(raise_error)
+      end
+    end
+
+    context "when broken lutaml file passed" do
+      let(:content) do
+        File.new(fixtures_path("dsl/broken_diagram.lutaml"))
+      end
+
+      it "returns error object and prints line number" do
+        expect { described_class.parse(content, {}) }
+          .to(raise_error(Lutaml::Uml::Parsers::ParsingError,
+              /but got ":" at line 25 char 32/))
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lutaml-uml
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
@@ -279,16 +279,21 @@ files:
 - spec/fixtures/datamodel/views/AddressProfile.yml
 - spec/fixtures/datamodel/views/CommonModels.yml
 - spec/fixtures/datamodel/views/TopDown.yml
+- spec/fixtures/dsl/broken_diagram.lutaml
 - spec/fixtures/dsl/diagram.lutaml
 - spec/fixtures/dsl/diagram_attributes.lutaml
+- spec/fixtures/dsl/diagram_blank_definion.lutaml
+- spec/fixtures/dsl/diagram_blank_entities.lutaml
 - spec/fixtures/dsl/diagram_class_assocation.lutaml
 - spec/fixtures/dsl/diagram_class_fields.lutaml
+- spec/fixtures/dsl/diagram_commented_includes.lutaml
 - spec/fixtures/dsl/diagram_comments.lutaml
 - spec/fixtures/dsl/diagram_concept_model.lutaml
 - spec/fixtures/dsl/diagram_data_types.lutaml
 - spec/fixtures/dsl/diagram_definitions.lutaml
 - spec/fixtures/dsl/diagram_includes.lutaml
 - spec/fixtures/dsl/diagram_multiply_classes.lutaml
+- spec/fixtures/dsl/diagram_non_existing_include.lutaml
 - spec/fixtures/dsl/shared.lutaml
 - spec/fixtures/dsl/shared1.lutaml
 - spec/fixtures/generated_dot/AddressClassProfile.dot