lutaml-uml 0.1.0 → 0.2.0

data/spec/fixtures/dsl/diagram_data_types.lutaml

@@ -0,0 +1,24 @@
+diagram MyView {
+  title "my diagram"
+
+  enum MyEnum {}
+
+  enum AddressClassProfile {
+    +addressClassProfile: CharacterString
+  }
+
+  data_type "Banking Information" {
+    "art code"
+    "CCT Number"
+  }
+
+  primitive Integer
+
+  enum Profile {
+    imlicistAttributeProfile: CharacterString
+    +attributeProfile: CharacterString
+    -privateAttributeProfile: CharacterString
+    ~friendlyAttributeProfile: CharacterString
+    #protectedAttributeProfile: CharacterString
+  }
+}

data/spec/fixtures/dsl/diagram_includes.lutaml

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

data/spec/fixtures/dsl/diagram_multiply_classes.lutaml

@@ -0,0 +1,7 @@
+diagram MyView {
+  title "my diagram"
+  class Foo {}
+  class Doo {}
+  class Koo {}
+  class NamespacedClass <<MyNamespace>> {}
+}

data/spec/fixtures/dsl/shared.lutaml

@@ -0,0 +1,3 @@
+class Foo {}
+class Doo {}
+class Koo {}

data/spec/fixtures/dsl/shared1.lutaml

@@ -0,0 +1,4 @@
+class AttributeProfile {
+  imlicistAttributeProfile: CharacterString [0..1]
+  +attributeProfile: <<BasicDocument>> LocalizedString [0..1]
+}

data/spec/fixtures/generated_dot/AddressClassProfile.dot

@@ -0,0 +1,170 @@
+digraph G {
+  graph [splines="ortho" pad=0.5 ranksep="1.2.equally" nodesep="1.2.equally"]
+  edge [color="gray50"]
+  node [shape="box" fontname="Helvetica-bold"]
+
+  AddressProfile [
+    shape="plain"
+    fontname="Helvetica"
+    label=<<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
+    <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="CENTER"><B>AddressProfile</B></TD></TR>
+  </TABLE>
+  </TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  </TABLE>>]
+  
+  AddressClassProfile [
+    shape="plain"
+    fontname="Helvetica"
+    label=<<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
+    <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="CENTER"><B>AddressClassProfile</B></TD></TR>
+  </TABLE>
+  </TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  </TABLE>>]
+  
+  AddressComponentProfile [
+    shape="plain"
+    fontname="Helvetica"
+    label=<<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
+    <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="CENTER"><B>AddressComponentProfile</B></TD></TR>
+  </TABLE>
+  </TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  </TABLE>>]
+  
+  AttributeProfile [
+    shape="plain"
+    fontname="Helvetica"
+    label=<<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
+    <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="CENTER"><B>AttributeProfile</B></TD></TR>
+  </TABLE>
+  </TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  </TABLE>>]
+  
+  ProfileCompliantAddress [
+    shape="plain"
+    fontname="Helvetica"
+    label=<<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
+    <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="CENTER"><B>ProfileCompliantAddress</B></TD></TR>
+  </TABLE>
+  </TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  </TABLE>>]
+  
+  InterchangeAddressClassProfile [
+    shape="plain"
+    fontname="Helvetica"
+    label=<<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
+    <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="CENTER"><B>InterchangeAddressClassProfile</B></TD></TR>
+  </TABLE>
+  </TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  </TABLE>>]
+
+  AddressProfile -> AddressComponentProfile [dir="back" label="defines ▶" arrowtail="onormal" arrowhead="odiamond" taillabel="+componentProfile 0..*"]
+  AddressProfile -> AddressClassProfile [dir="back" label="defines ▶" arrowtail="onormal" arrowhead="odiamond" taillabel="+addressProfile 0..*"]
+  AddressClassProfile -> AttributeProfile [dir="both" headlabel="+addressClassProfile" taillabel="+attributeProfile" arrowtail="odiamond" arrowhead="vee"]
+  AddressClassProfile -> ProfileCompliantAddress [dir="direct" label="◀ compliesWith" headlabel="+profile 1..1" arrowtail="onormal" arrowhead="vee"]
+  AddressComponentProfile -> AddressClassProfile [dir="direct" label="◀ uses" taillabel="+componentProfile" arrowtail="onormal" arrowhead="odiamond"]
+  AddressComponentProfile -> AttributeProfile [dir="both" headlabel="+addressClassProfile" taillabel="+attributeProfile" arrowtail="odiamond" arrowhead="vee"]
+  
+  
+  
+  InterchangeAddressClassProfile -> AddressClassProfile [dir="direct" arrowtail="onormal" arrowhead="onormal"]
+  
+  
+  
+  
+}

data/spec/fixtures/generated_dot/AddressProfile.dot

@@ -0,0 +1,34 @@
+digraph G {
+  graph [splines="ortho" pad=0.5 ranksep="1.2.equally" nodesep="1.2.equally"]
+  edge [color="gray50"]
+  node [shape="box" fontname="Helvetica-bold"]
+
+  AddressProfile [
+    shape="plain"
+    fontname="Helvetica"
+    label=<<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
+    <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="CENTER"><B>AddressProfile</B></TD></TR>
+  </TABLE>
+  </TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+              <TR><TD ALIGN="LEFT">+country : iso3166Code&#91;0..*&#93;</TD></TR>
+  </TABLE>
+        </TD>
+  </TR>
+  
+  <TR>
+    <TD><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+    <TR><TD ALIGN="LEFT"></TD></TR>
+  </TABLE></TD>
+  </TR>
+  
+  </TABLE>>]
+
+  AddressProfile -> AddressComponentProfile [dir="back" label="defines ▶" arrowtail="onormal" arrowhead="odiamond" taillabel="+componentProfile 0..*"]
+  AddressProfile -> AddressClassProfile [dir="back" label="defines ▶" arrowtail="onormal" arrowhead="odiamond" taillabel="+addressProfile 0..*"]
+}

data/spec/lutaml/uml/formatter/graphviz_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Lutaml::Uml::Formatter::Graphviz do
+  describe ".format_document" do
+    subject(:format_document) do
+      described_class.new.format_document(input_document)
+    end
+
+    context "when simple aggregation" do
+      let(:input_document) do
+        Lutaml::Uml::Parsers::Yaml
+          .parse(fixtures_path("datamodel/views/AddressProfile.yml"))
+      end
+
+      let(:formatted_dot_content) do
+        File.read(fixtures_path("generated_dot/AddressProfile.dot"))
+      end
+
+      it "generates the correct relationship graph" do
+        expect(format_document).to eq(formatted_dot_content)
+      end
+    end
+
+    context "when aggregation with inheritance" do
+      let(:input_document) do
+        Lutaml::Uml::Parsers::Yaml
+          .parse(fixtures_path("datamodel/views/AddressClassProfile.yml"))
+      end
+
+      let(:formatted_dot_content) do
+        File.read(fixtures_path("generated_dot/AddressClassProfile.dot"))
+      end
+
+      it "generates the correct relationship graph" do
+        expect(format_document).to eq(formatted_dot_content)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Lutaml::Uml::Parsers::Dsl do
+  describe ".parse" do
+    subject(:parse) { described_class.parse(content) }
+    subject(:format_parsed_document) do
+      Lutaml::Uml::Formatter::Graphviz.new.format_document(parse)
+    end
+
+    shared_examples "the correct graphviz formatting" do
+      it "does not raise error on graphviz formatting" do
+        expect { format_parsed_document }.to_not raise_error
+      end
+    end
+
+    context "when simple diagram without attributes" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram.lutaml"))
+      end
+
+      it "creates Lutaml::Uml::Document object from supplied dsl" do
+        expect(parse).to be_instance_of(Lutaml::Uml::Document)
+      end
+
+      it_behaves_like "the correct graphviz formatting"
+    end
+
+    context "when diagram with attributes" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_attributes.lutaml"))
+      end
+
+      it "creates Lutaml::Uml::Document object and sets its attributes" do
+        expect(parse).to be_instance_of(Lutaml::Uml::Document)
+        expect(parse.title).to eq("my diagram")
+        expect(parse.fontname).to eq("Arial")
+      end
+
+      it_behaves_like "the correct graphviz formatting"
+    end
+
+    context "when multiply classes entries" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_multiply_classes.lutaml"))
+      end
+
+      it "creates Lutaml::Uml::Document object and creates dependent classes" do
+        classes = parse.classes
+        expect(parse).to be_instance_of(Lutaml::Uml::Document)
+        expect(parse.classes.length).to eq(4)
+        expect(by_name(classes, "NamespacedClass").keyword).to eq("MyNamespace")
+      end
+
+      it_behaves_like "the correct graphviz formatting"
+    end
+
+    context "when class with fields" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_class_fields.lutaml"))
+      end
+
+      it "creates the correct classes and sets the \
+          correct number of attributes" do
+        classes = parse.classes
+        expect(by_name(classes, "Component").attributes).to be_nil
+        expect(by_name(classes, "AddressClassProfile")
+                .attributes.length).to eq(1)
+        expect(by_name(classes, "AttributeProfile")
+                .attributes.length).to eq(7)
+      end
+
+      it "creates the correct attributes with the correct visibility" do
+        attributes = by_name(parse.classes, "AttributeProfile").attributes
+        expect(by_name(attributes, "imlicistAttributeProfile").visibility)
+          .to be_nil
+        expect(by_name(attributes, "imlicistAttributeProfile").keyword)
+          .to be_nil
+        expect(by_name(attributes, "attributeProfile").visibility)
+          .to eq("public")
+        expect(by_name(attributes, "attributeProfile").keyword)
+          .to eq("BasicDocument")
+        expect(by_name(attributes, "attributeProfile1").visibility)
+          .to eq("public")
+        expect(by_name(attributes, "attributeProfile1").keyword)
+          .to eq("BasicDocument")
+        expect(by_name(attributes, "privateAttributeProfile").visibility)
+          .to eq("private")
+        expect(by_name(attributes, "friendlyAttributeProfile").visibility)
+          .to eq("friendly")
+        expect(by_name(attributes, "friendlyAttributeProfile").keyword)
+          .to eq("Type")
+        expect(by_name(attributes, "protectedAttributeProfile").visibility)
+          .to eq("protected")
+      end
+
+      it_behaves_like "the correct graphviz formatting"
+    end
+
+    context "when association blocks exists" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_class_assocation.lutaml"))
+      end
+
+      it "creates the correct number of associations" do
+        expect(parse.associations.length).to eq(3)
+      end
+
+      context "when bidirectional asscoiation syntax " do
+        subject(:association) do
+          by_name(parse.associations, "BidirectionalAsscoiation")
+        end
+
+        it "creates associations with the correct attributes" do
+          expect(association.owner_end_type).to(eq("aggregation"))
+          expect(association.member_end_type).to(eq("direct"))
+          expect(association.owner_end).to(eq("AddressClassProfile"))
+          expect(association.owner_end_attribute_name)
+            .to(eq("addressClassProfile"))
+          expect(association.member_end).to(eq("AttributeProfile"))
+          expect(association.member_end_attribute_name)
+            .to(eq("attributeProfile"))
+          expect(association.member_end_cardinality).to(eq(min: "0", max: "*"))
+        end
+      end
+
+      context "when direct asscoiation syntax " do
+        subject(:association) do
+          by_name(parse.associations, "DirectAsscoiation")
+        end
+
+        it "creates associations with the correct attributes" do
+          expect(association.owner_end_type).to(be_nil)
+          expect(association.member_end_type).to(eq("direct"))
+          expect(association.owner_end).to(eq("AddressClassProfile"))
+          expect(association.owner_end_attribute_name).to(be_nil)
+          expect(association.member_end).to(eq("AttributeProfile"))
+          expect(association.member_end_attribute_name)
+            .to(eq("attributeProfile"))
+          expect(association.member_end_cardinality).to(be_nil)
+        end
+      end
+
+      context "when reverse asscoiation syntax " do
+        subject(:association) do
+          by_name(parse.associations, "ReverseAsscoiation")
+        end
+
+        it "creates associations with the correct attributes" do
+          expect(association.owner_end_type).to(eq("aggregation"))
+          expect(association.member_end_type).to(be_nil)
+          expect(association.owner_end).to(eq("AddressClassProfile"))
+          expect(association.owner_end_attribute_name)
+            .to(eq("addressClassProfile"))
+          expect(association.member_end).to(eq("AttributeProfile"))
+          expect(association.member_end_attribute_name).to(be_nil)
+          expect(association.member_end_cardinality).to(be_nil)
+        end
+      end
+    end
+
+    context "when data_types entries" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_data_types.lutaml"))
+      end
+
+      it "Generates the correct nodes for enums" do
+        enums = parse.enums
+        expect(by_name(enums, "MyEnum").attributes).to be_nil
+        expect(by_name(enums, "AddressClassProfile")
+                .attributes.length).to eq(1)
+        expect(by_name(enums, "Profile")
+                .attributes.length).to eq(5)
+      end
+
+      it "Generates the correct nodes for data_types" do
+        data_types = parse.data_types
+        expect(by_name(data_types, "Banking Information")
+                .attributes.map(&:name))
+          .to(eq(["art code", "CCT Number"]))
+      end
+
+      it "Generates the correct nodes for primitives" do
+        data_types = parse.primitives
+        expect(by_name(data_types, "Integer")).to_not be_nil
+      end
+
+      it_behaves_like "the correct graphviz formatting"
+    end
+
+    context "when concept model generated lutaml file" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_concept_model.lutaml"))
+      end
+
+      it "Generates the correct class/enums/associations list" do
+        document = parse
+        expect(document.classes.length).to(eq(9))
+        expect(document.enums.length).to(eq(3))
+        expect(document.associations.length).to(eq(16))
+      end
+
+      it "Generates the correct attributes list" do
+        attributes = by_name(parse.classes, "ExpressionDesignation").attributes
+        expect(attributes.length).to(eq(5))
+        expect(attributes.map(&:name))
+          .to(eq(%w[text language script pronunciation grammarInfo]))
+        expect(attributes.map(&:type))
+          .to(eq(["GlossaristTextElementType",
+                  "Iso639ThreeCharCode",
+                  "Iso15924Code",
+                  "LocalizedString",
+                  "GrammarInfo"]))
+      end
+
+      it_behaves_like "the correct graphviz formatting"
+    end
+
+    context "when include directives is used" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_includes.lutaml"))
+      end
+
+      it "includes supplied files into the document" do
+        expect(parse.classes.map(&:name))
+          .to(eq(%w[Foo Doo Koo AttributeProfile]))
+        expect(by_name(parse.classes, "AttributeProfile")
+                .attributes.map(&:name))
+          .to eq(["imlicistAttributeProfile", "attributeProfile"])
+      end
+
+      it_behaves_like "the correct graphviz formatting"
+    end
+
+    context "when include directives is used" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_comments.lutaml"))
+      end
+
+      it "create comments for document and classes" do
+        expect(parse.comments).to(eq(["My comment",
+                                      "this is multiline\n    comment with {} special\n    chars/\n\n    +-|/"]))
+        expect(parse.classes.last.comments)
+          .to(eq(["this is attribute comment",
+                  "this is another comment line\n    with multiply lines"]))
+      end
+
+      it_behaves_like "the correct graphviz formatting"
+    end
+  end
+end