lutaml-uml 0.2.1 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 988b726887b8bd5f85e4cff7f56bfac405c6ea287f80d0a2222adf994ced4f70
-  data.tar.gz: 2d2aa85fcc8c25fc64ecd2a4cecbe028e54eeebe79f78e6615298ef095de667e
+  metadata.gz: 6ba839d8caa2f9221a6b0464da0a92d8598bdb2390924725852b57b9be76ad29
+  data.tar.gz: 881666eb3a5069ab5895b062a305fbd042110ac1371fd94683bd697ae41df1d1
 SHA512:
-  metadata.gz: 6d068ec140b4a284c0a1f0f7762c86b03bdaa1ad667c96a614f1009007e9fb064a8b5df787bf0d06185169ca0b0b8afebda70d82ae62bfd52fcb01c4f79f012f
-  data.tar.gz: bdebc9b1068f9f98eb2fc2da7b03d3d389231440064964e518169e1acd4c73d1f5e509ed53aad92d734afa58bddd0882cbc63802d6280068d400784e773105f3
+  metadata.gz: d088c3842b978978adc82074ba4fe9a0fe722bc5435f8879f33400f2a2e2bb25733381af7e888d3fd564e0870c727e7a6dbb85bc5847c986820093a97c0a102f
+  data.tar.gz: 5b456a84cc38d6fdc6e9f685ef4b6b2b135a000f83e7c620d95d5246f87b25ddf2b23da2c9d39fe76b69e6231423a995325a47d4e927d8518c7d7ff82a0e2394

data/.github/workflows/macos.yml

@@ -31,6 +31,8 @@ jobs:
         run: |
           sudo gem install bundler --force
           bundle install --jobs 4 --retry 3
+      - name: Install Grpahviz macOS
+        run: brew install graphviz
       - name: Run specs
         run: |
           bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -33,6 +33,8 @@ jobs:
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
+      - name: Install Grpahviz Ubuntu
+        run: sudo apt-get install graphviz
       - name: Run specs
         run: |
           bundle exec rake

data/.github/workflows/windows.yml

@@ -36,6 +36,16 @@ jobs:
           gem install bundler
           bundle config --local path vendor/bundle
           bundle install --jobs 4 --retry 3
+      - name: Install graphviz
+        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
+        run: |
+          dot -?
       - name: Run specs
         run: |
           bundle exec rake

data/LUTAML.adoc

@@ -110,6 +110,20 @@ class Relationship {
 class Element {}
 ----
 
+== Class' multiline "definition" property
+
+=== Definition
+
+Full syntax:
+
+[source,java]
+----
+definition
+  inner text
+end definition
+----
+
+
 == Attributes/entries
 
 === Definition
@@ -118,7 +132,7 @@ Full syntax:
 
 [source,java]
 ----
-[visibility][/][attribute] name [:type][multiplicity][=initial value][{property string}]
+[visibility][/][attribute] name [:type][multiplicity][=initial value][{attribute body}]
 ----
 
 where:
@@ -128,11 +142,7 @@ where:
 * `/` - symbolizes a derived attribute.
 * `multiplicity` -  Multiplicity is in square brackets (e.g. [1..*]).
 * `initial value` - Default value specifies the initial value of the attribute.
-* `property string` - Property string indicates a modifier that applies to the attribute:
-  ** {readonly}: the property can be read but not changed.
-  ** {union}: the property is a union of subsets.
-  ** {subsets <property>}: the property is a subset of <property>.
-  ** {redefines <property>}: the property is a new definition of <property> (overwritten by inheritance).
+* `{attribute body}` - Body of attribute, additional properties for attribute
 
 
 One can use explicit or implicit syntax for attribute definition
@@ -186,6 +196,21 @@ class Figure {
 }
 ----
 
+=== Additional attribute' properties
+
+example:
+
+[source,java]
+----
+class Figure {
+  + radius {
+    definition
+      Radius of the Figure
+    end definition
+  }
+}
+----
+
 == Methods
 
 Syntax for defining methods:

data/bin/plantuml2lutaml

@@ -6,7 +6,7 @@
 # Usage: bin/plantuml2lutaml /path/to/plantuml.wsd
 
 file_path = ARGV[0]
-FILE_NAME = File.basename(file_path, '.wsd')
+FILE_NAME = File.basename(file_path, ".wsd")
 wsd_file = File.new(ARGV[0])
 
 def sync_puts(line, level = 0)
@@ -18,36 +18,36 @@ SKIPPED_LINES_REGEXP = /^(@startuml|'\*{7}|note|@enduml|\!|'\/)/
 COMMENT_START = /\/'/
 COMMENT_END = /'\//
 ASSOCIATION_MAPPINGS = {
-  /-\|>/ => ',inheritance',
-  /<\|-/ => 'inheritance,',
-  /->/ => ',direct',
-  /<-/ => 'direct,'
-}
+  /-\|>/ => ",inheritance",
+  /<\|-/ => "inheritance,",
+  /->/ => ",direct",
+  /<-/ => "direct,",
+}.freeze
 
 in_comment_block = false
 
 def transform_line(line)
   return sync_puts(line, 2) if ASSOCIATION_MAPPINGS.keys.none? { |key| line =~ key }
 
-  owner_type, member_type = ASSOCIATION_MAPPINGS.find { |(key,value)| line =~ key }.last.split(',')
-  blocks = line.split(' ')
+  owner_type, member_type = ASSOCIATION_MAPPINGS.detect { |(key, _value)| line =~ key }.last.split(",")
+  blocks = line.split(" ")
   owner = blocks.first
   member = blocks.last
   sync_puts("association {", 2)
   sync_puts("owner #{owner}", 4)
   sync_puts("member #{member}", 4)
-  sync_puts("owner_type #{owner_type}", 4) if owner_type.to_s.length > 0
-  sync_puts("member_type #{member_type}", 4) if member_type.to_s.length > 0
+  sync_puts("owner_type #{owner_type}", 4) if !owner_type.to_s.empty?
+  sync_puts("member_type #{member_type}", 4) if !member_type.to_s.empty?
   sync_puts("}", 2)
 end
 
 sync_puts("diagram #{FILE_NAME} {")
 wsd_file.readlines.each do |line|
-  if line =~ COMMENT_START
+  if line.match?(COMMENT_START)
     in_comment_block = true
   end
 
-  if line =~ COMMENT_END
+  if line.match?(COMMENT_END)
     in_comment_block = false
   end
 
@@ -55,4 +55,4 @@ wsd_file.readlines.each do |line|
 
   transform_line(line)
 end
-sync_puts("}")
+sync_puts("}")

data/bin/yaml2lutaml

@@ -75,6 +75,7 @@ def process_association(owner, values, encountered_relations)
 end
 sync_puts("diagram #{File.basename(ARGV[0], 'yml')[0..-2]} {")
 sync_puts("title '#{view_yaml['title']}'", 2)
+sync_puts("caption '#{view_yaml['caption']}'", 2)
 
 # Class associations notations
 view_yaml["relations"]&.each do |values|
@@ -83,20 +84,55 @@ end
 
 view_yaml["imports"].keys.each do |entry|
   import = YAML.safe_load(File.read(File.join(models_path, "#{entry}.yml")))
-  import_name = import["name"] ||  File.basename(entry)
+  import_name = import["name"] || File.basename(entry)
   # Class notation
   sync_puts("#{import['modelType']} #{import_name} {", 2)
+  if import["definition"]
+    definition = <<~TEXT
+      definition
+        #{import['definition']}
+      end definition
+    TEXT
+    sync_puts(definition, 4)
+  end
   import["values"]&.each_pair do |key, values|
-    sync_puts("#{key}", 4)
+    result_string = key
+    if values["definition"]
+      result_string += <<~TEXT
+        {
+          definition
+          #{values['definition']}
+          end definition
+        }
+      TEXT
+    end
+    sync_puts(result_string, 4)
   end
   import["attributes"]&.each_pair do |key, values|
+    definition = values["definition"]
     cardinality = if values["cardinality"]
                     cardinality_val = values["cardinality"]
                     "[#{cardinality_val['min']}..#{cardinality_val['max']}]"
                   else
                     ""
                   end
-    sync_puts("+#{key}: #{values['type']} #{cardinality}", 4)
+    result_string = "+#{key}"
+    if values["type"]
+      result_string += ": #{values['type']}"
+    end
+    if cardinality
+      result_string += " #{cardinality}"
+    end
+    if definition
+      result_string += <<~TEXT
+        {
+          definition
+          #{definition}
+          end definition
+        }
+      TEXT
+    end
+    sync_puts(result_string, 4)
   end
   sync_puts("}", 2)
 

data/lib/lutaml/layout/graph_viz_engine.rb

@@ -7,21 +7,12 @@ module Lutaml
   module Layout
     class GraphVizEngine < Engine
       def render(type)
-        parse_graphviz_string
-          .output(type => String)
-      end
-
-      private
-
-      # GraphViz#parse_string and GraphViz#parse crush with no reason
-      # with seg fault, this lead to nil return value.
-      # Try to recall method several time
-      def parse_graphviz_string(attempts = 10)
-        raise('Cannot parse input string, `gvpr` segmentation fault?') if attempts == 0
-        res = GraphViz.parse_string(input)
-        return res if res
-
-        parse_graphviz_string(attempts - 1)
+        Open3.popen3("dot -T#{type}") do |stdin, stdout, _stderr, _wait|
+          stdin.puts(input)
+          stdin.close
+          # unless (err = stderr.read).empty? then raise err end
+          stdout.read
+        end
       end
     end
   end

data/lib/lutaml/uml/class.rb

@@ -16,6 +16,7 @@ module Lutaml
 
       attr_reader :associations,
                   :attributes,
+                  :definition,
                   :members,
                   :modifier
 
@@ -31,6 +32,10 @@ module Lutaml
         @modifier = value.to_s # TODO: Validate?
       end
 
+      def definition=(value)
+        @definition = value.to_s
+      end
+
       def attributes=(value)
         @attributes = value.to_a.map do |attr|
           TopElementAttribute.new(attr)

data/lib/lutaml/uml/data_type.rb

@@ -3,8 +3,11 @@
 module Lutaml
   module Uml
     class DataType < Class
-      def keyword
-        "dataType"
+      attr_reader :keyword
+
+      def initialize(attributes = {})
+        super
+        @keyword = "dataType"
       end
     end
   end

data/lib/lutaml/uml/enum.rb

@@ -12,7 +12,14 @@ module Lutaml
 
       attr_reader :attributes,
                   :members,
-                  :modifier
+                  :modifier,
+                  :definition,
+                  :keyword
+
+      def initialize(attributes = {})
+        super
+        @keyword = "enumeration"
+      end
 
       def attributes=(value)
         @attributes = value.to_a.map do |attr|
@@ -20,14 +27,14 @@ module Lutaml
         end
       end
 
+      def definition=(value)
+        @definition = value.to_s
+      end
+
       # TODO: reserved name, change
       def methods
         []
       end
-
-      def keyword
-        "enumeration"
-      end
     end
   end
 end

data/lib/lutaml/uml/formatter/graphviz.rb

@@ -322,12 +322,7 @@ module Lutaml
         end
 
         def generate_from_dot(input)
-          # https://github.com/glejeune/Ruby-Graphviz/issues/78
-          # Ruby-Graphviz has an old bug when html labels was not displayed
-          #  property because of `<` and `>` characters escape, add additional
-          #   `<` and `>` symbols to workaround it
-          escaped_dot = input.gsub("<<", "<<<").gsub(">>", ">>>")
-          Lutaml::Layout::GraphVizEngine.new(input: escaped_dot).render(@type)
+          Lutaml::Layout::GraphVizEngine.new(input: input).render(@type)
         end
 
         def generate_graph_name(name)

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

@@ -53,6 +53,7 @@ module Lutaml
           realizes
           static
           title
+          caption
         ].freeze
 
         KEYWORDS.each do |keyword|
@@ -132,7 +133,8 @@ module Lutaml
             attribute_name >>
             match['"\''].maybe >>
             attribute_type? >>
-            cardinality?)
+            cardinality? >>
+            class_body?)
             .as(:attributes)
         end
 
@@ -143,6 +145,13 @@ module Lutaml
             match['"\''].maybe
         end
         rule(:title_definition) { title_keyword >> title_text }
+        rule(:caption_keyword) { kw_caption >> spaces }
+        rule(:caption_text) do
+          match['"\''].maybe >>
+            match['a-zA-Z0-9_\- '].repeat(1).as(:caption) >>
+            match['"\''].maybe
+        end
+        rule(:caption_definition) { caption_keyword >> caption_text }
 
         rule(:fontname_keyword) { kw_fontname >> spaces }
         rule(:fontname_text) do
@@ -252,7 +261,8 @@ module Lutaml
         end
         rule(:class_keyword) { kw_class >> spaces }
         rule(:class_inner_definitions) do
-          attribute_definition |
+          definition_body |
+            attribute_definition |
             comment_definition |
             comment_multiline_definition
         end
@@ -276,10 +286,21 @@ module Lutaml
             class_body?
         end
 
+        # -- Definition
+        rule(:definition_body) do
+          spaces? >>
+            str("definition") >>
+            whitespace? >>
+            (str("end definition").absent? >> any).repeat.as(:definition) >>
+            whitespace? >>
+            str("end definition")
+        end
+
         # -- Enum
         rule(:enum_keyword) { kw_enum >> spaces }
         rule(:enum_inner_definitions) do
-          attribute_definition |
+          definition_body |
+            attribute_definition |
             comment_definition |
             comment_multiline_definition
         end
@@ -339,6 +360,7 @@ module Lutaml
         rule(:diagram_keyword) { kw_diagram >> spaces? }
         rule(:diagram_inner_definitions) do
           title_definition |
+            caption_definition |
             fontname_definition |
             class_definition.as(:classes) |
             enum_definition.as(:enums) |

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

@@ -27,7 +27,7 @@ module Lutaml
         end
 
         def process_include_line(include_root, line)
-          include_path_match = line.match(/\s*include\s+(.+)/)
+          include_path_match = line.match(/^\s*include\s+(.+)/)
           return line if include_path_match.nil?
 
           path_to_file = include_path_match[1].strip

data/lib/lutaml/uml/primitive_type.rb

@@ -3,8 +3,11 @@
 module Lutaml
   module Uml
     class PrimitiveType < DataType
-      def keyword
-        "primitive"
+      attr_reader :keyword
+
+      def initialize(attributes = {})
+        super
+        @keyword = "primitive"
       end
     end
   end

data/lib/lutaml/uml/top_element_attribute.rb

@@ -4,6 +4,7 @@ module Lutaml
   module Uml
     class TopElementAttribute
       include HasAttributes
+      include HasMembers
 
       attr_accessor :name,
                     :visibility,

data/lib/lutaml/uml/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Uml
-    VERSION = "0.2.1"
+    VERSION = "0.2.6"
   end
 end

data/lutaml-uml.gemspec

@@ -24,17 +24,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.executables   = %w[lutaml-uml]
 
-  spec.add_runtime_dependency "activesupport", "~> 5.0"
   spec.add_runtime_dependency "hashie", "~> 4.1.0"
   spec.add_runtime_dependency "parslet", "~> 1.7.1"
   spec.add_runtime_dependency "ruby-graphviz", "~> 1.2"
   spec.add_runtime_dependency "thor", "~> 1.0"
 
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "nokogiri", "~> 1.10"
-  spec.add_development_dependency "rubocop", "~> 0.54.0"
-  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "pry", "~> 0.12.2"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.54.0"
 end

data/spec/fixtures/dsl/diagram_definitions.lutaml

@@ -0,0 +1,20 @@
+diagram MyView {
+  title "my diagram"
+
+  class AddressClassProfile {
+    definition
+      this is multiline with `ascidoc`
+      comments
+      and list
+    end definition
+    +addressClassProfile: CharacterString [0..1]
+  }
+
+  class AttributeProfile {
+    imlicistAttributeProfile: CharacterString [0..1] {
+      definition this is attribute definition
+      with multiply lines
+      end definition
+    }
+  }
+}

data/spec/lutaml/layout/graph_viz_engine_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Lutaml::Layout::GraphVizEngine do
+  describe "#render" do
+    subject(:render) do
+      described_class.new(input: input).render(type)
+    end
+    let(:input) do
+      File.read(fixtures_path("generated_dot/AddressClassProfile.dot"))
+    end
+
+    context "when png output type" do
+      let(:type) { "png" }
+      let(:png_header) { "\x89PNG" }
+
+      it "renders input as png binary string" do
+        expect(render[0..3]).to(eq(png_header))
+      end
+    end
+
+    context "when dot output type" do
+      let(:type) { "dot" }
+
+      it "renders input as dot string" do
+        expect(render).to(match("digraph G {"))
+      end
+    end
+  end
+end

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

@@ -248,5 +248,29 @@ RSpec.describe Lutaml::Uml::Parsers::Dsl do
 
       it_behaves_like "the correct graphviz formatting"
     end
+
+    context "when defninition directives included" do
+      let(:content) do
+        File.new(fixtures_path("dsl/diagram_definitions.lutaml"))
+      end
+      let(:class_definition) do
+        "this is multiline with `ascidoc`\n      comments\n      and list"
+      end
+      let(:attribute_definition) do
+        "this is attribute definition\n      with multiply lines"
+      end
+
+      it "create comments for document and classes" do
+        expect(by_name(parse.classes, "AddressClassProfile").definition)
+          .to(eq(class_definition))
+        expect(by_name(parse.classes, "AttributeProfile")
+                .attributes
+                .first
+                .definition)
+          .to(eq(attribute_definition))
+      end
+
+      it_behaves_like "the correct graphviz formatting"
+    end
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lutaml-uml
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-14 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -81,61 +67,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
 description: UML model module for LutaML.
 email:
 - open.source@ribose.com'
@@ -297,12 +283,14 @@ files:
 - 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/shared.lutaml
 - spec/fixtures/dsl/shared1.lutaml
 - spec/fixtures/generated_dot/AddressClassProfile.dot
 - spec/fixtures/generated_dot/AddressProfile.dot
+- spec/lutaml/layout/graph_viz_engine_spec.rb
 - spec/lutaml/uml/formatter/graphviz_spec.rb
 - spec/lutaml/uml/parsers/dsl_spec.rb
 - spec/lutaml/uml/parsers/yaml_spec.rb