lutaml-uml 0.1.0 → 0.2.0

data/{README.md → README.adoc}

@@ -1,28 +1,27 @@
 # Lutaml::Uml
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lutaml/uml`. To experiment with that code, run `bin/console` for an interactive prompt.
+Lutaml is a language for specifying UML class diagrams and a tool for converting it into various different formats.
 
-TODO: Delete this and the text above, and describe your gem
+## Install
 
-## Installation
+### Bundler: `gem "lutaml-uml"`
 
-Add this line to your application's Gemfile:
+### RubyGems: `gem install lutaml-uml`
 
-```ruby
-gem 'lutaml-uml'
-```
+## Executable
 
-And then execute:
+[source,sh]
+--
+# Convert example.lutaml to example.png
+$ lutaml-uml --type png --output . example.lutaml
 
-    $ bundle install
+# Display detailed help message
+$ lutaml-uml --help
+--
 
-Or install it yourself as:
+## Language
 
-    $ gem install lutaml-uml
-
-## Usage
-
-TODO: Write usage instructions here
+See link:LUTAML.adoc[LUTAML.adoc]
 
 ## Development
 
@@ -37,4 +36,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 ## Code of Conduct
 
-Everyone interacting in the Lutaml::Uml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lutaml-uml/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Lutaml::Uml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lutaml-uml/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "lutaml/uml"

data/bin/lutaml2dotpng

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Script to convert lutaml files into dot and png files
+# Usage: bin/lutaml2dotpng /path/to/lutaml/folder/
+require "bundler/setup"
+require "lutaml/uml"
+
+basedir = ARGV[0]
+Dir["#{basedir}/*.lutaml"].each do |filename|
+  puts(filename)
+  base_filename = File.basename(filename, '.lutaml')
+  File.open("#{basedir}/#{base_filename}.dot", 'w') do |file|
+    file
+      .puts(Lutaml::Uml::Formatter::Graphviz
+              .new
+              .format_document(
+                Lutaml::Uml::Parsers::Dsl
+                  .parse(File.read("#{basedir}/#{base_filename}.lutaml"))))
+  end
+  `dot -T png #{"#{basedir}/#{base_filename}.dot"} > "#{basedir}/#{base_filename}.png"`
+end

data/bin/yaml2lutaml

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Script to convert datamodel yaml files into LutaML syntax
+# Usage: bin/yaml2lutaml /path/to/datamodel/view/file.yml
+
+require "yaml"
+
+view_yaml = YAML.safe_load(File.read(ARGV[0]))
+models_path = File.expand_path("../../models", ARGV[0])
+
+def sync_puts(line, level = 0)
+  $stdout.puts("#{''.rjust(level)}#{line}")
+  $stdout.flush
+end
+
+encountered_relations = Hash.new { |h, key| h[key] = [] }
+# relations:
+# - target: AttributeProfile
+#   relationship:
+#     source:
+#       type: aggregation
+#       attribute:
+#         addressClassProfile:
+#     target:
+#       type: direct
+#       attribute:
+#         attributeProfile:
+#           cardinality:
+#             min: 0
+#             max: '*'
+def process_association(owner, values, encountered_relations)
+  target_name = values["target"]
+  return if encountered_relations[owner].include?(target_name)
+
+  encountered_relations[owner].push(target_name)
+  sync_puts("association {", 2)
+
+  relationship_block = values["relationship"] || {}
+
+  if relationship_block["source"] && relationship_block["source"]["type"]
+    source = relationship_block["source"]
+    sync_puts("owner_type #{source['type']}", 4)
+    if source["attribute"]
+      source_attribute_name = source["attribute"].keys.first
+      owner += "##{source_attribute_name}"
+      if source["attribute"][source_attribute_name]["cardinality"]
+        cardinality = source["attribute"][source_attribute_name]["cardinality"]
+        owner += " [#{cardinality['min']}..#{cardinality['max']}]"
+      end
+    end
+  end
+  sync_puts("owner #{owner}", 4)
+
+  member = target_name
+  if relationship_block["target"]
+    target = relationship_block["target"]
+    type = target["type"] || "direct"
+    sync_puts("member_type #{type}", 4)
+    if target["attribute"]
+      target_attribute_name = target["attribute"].keys.first
+      member += "##{target_attribute_name}"
+      if target["attribute"][target_attribute_name]["cardinality"]
+        cardinality = target["attribute"][target_attribute_name]["cardinality"]
+        member += " [#{cardinality['min']}..#{cardinality['max']}]"
+      end
+    end
+  else
+    sync_puts("member_type direct", 4)
+  end
+  sync_puts("member #{member}", 4)
+
+  sync_puts("}", 2)
+end
+sync_puts("diagram #{File.basename(ARGV[0], 'yml')[0..-2]} {")
+sync_puts("title '#{view_yaml['title']}'", 2)
+
+# Class associations notations
+view_yaml["relations"]&.each do |values|
+  process_association(values["source"], values, encountered_relations)
+end
+
+view_yaml["imports"].keys.each do |entry|
+  import = YAML.safe_load(File.read(File.join(models_path, "#{entry}.yml")))
+  import_name = import["name"]
+  # Class notation
+  sync_puts("#{import['modelType']} #{import['name']} {", 2)
+  import["values"]&.each_pair do |key, values|
+    sync_puts("#{key}", 4)
+  end
+  import["attributes"]&.each_pair do |key, values|
+    cardinality = if values["cardinality"]
+                    cardinality_val = values["cardinality"]
+                    "[#{cardinality_val['min']}..#{cardinality_val['max']}]"
+                  else
+                    ""
+                  end
+    sync_puts("+#{key}: #{values['type']} #{cardinality}", 4)
+  end
+  sync_puts("}", 2)
+
+  # Associations notations
+  import["relations"]&.each do |values|
+    process_association(import_name, values, encountered_relations)
+  end
+end
+sync_puts("}")

data/exe/lutaml-uml

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
+# frozen_string_literal: true
 
 # resolve bin path, ignoring symlinks
 require "pathname"
@@ -15,6 +16,6 @@ class Gem::Specification
   def this; self; end
 end
 
-# start up the CLI
-require "reeper"
-Reeper::Cli.start(ARGV)
+require "lutaml/uml/interface/command_line"
+
+Lutaml::Uml::Interface::CommandLine.run

data/lib/lutaml/layout/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Lutaml
+  class Engine
+    attr_accessor :input
+
+    def initialize(input:)
+      @input = input
+    end
+
+    def render(_type)
+      raise ArgumentError, "Implement render method"
+    end
+  end
+end

data/lib/lutaml/layout/graph_viz_engine.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "ruby-graphviz"
+require "lutaml/layout/engine"
+
+module Lutaml
+  module Layout
+    class GraphVizEngine < Engine
+      def render(type)
+        GraphViz
+          .parse_string(input)
+          .output(type => String)
+      end
+    end
+  end
+end

data/lib/lutaml/uml.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require "lutaml/uml/version"
+require "lutaml/uml/interface/command_line"
 
 module Lutaml
   module Uml

data/lib/lutaml/uml/abstraction.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 ##
 ## Behaviour metamodel
 ##
-module Lutaml::Uml
-
-class Abstraction < Dependency
-end
-
+module Lutaml
+  module Uml
+    class Abstraction < Dependency
+    end
+  end
 end

data/lib/lutaml/uml/activity.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 ##
 ## Behaviour metamodel
 ##
-module Lutaml::Uml
-
-class Activity < Behavior
+module Lutaml
+  module Uml
+    class Activity < Behavior
+    end
+  end
 end
-
-end

data/lib/lutaml/uml/actor.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 ##
 ## Behaviour metamodel
 ##
 
-module Lutaml::Uml
-
-class Actor < Classifier
-	def initialize
-		@name = nil
-		@xmi_id = nil
-		@stereotype = []
-		@generalization = []
-		@namespace = nil
-	end
+module Lutaml
+  module Uml
+    class Actor < Classifier
+      def initialize
+        @name = nil
+        @xmi_id = nil
+        @stereotype = []
+        @generalization = []
+        @namespace = nil
+      end
+    end
+  end
 end
-
-end

data/lib/lutaml/uml/association.rb

@@ -1,15 +1,41 @@
-module Lutaml::Uml
-
-class Association < TopElement
-	attr_accessor :owned_end, :member_end
-	def initialize
-		@name = nil
-		@xmi_id = nil
-		@xmi_uuid = nil
-		@owned_end = []
-		@member_end = []
-		@namespace = nil
-	end
-end
+# frozen_string_literal: true
+
+module Lutaml
+  module Uml
+    class Association < TopElement
+      include HasMembers
+
+      attr_accessor :owner_end,
+                    :owner_end_attribute_name,
+                    :owner_end_cardinality,
+                    :owner_end_type,
+                    :member_end,
+                    :member_end_attribute_name,
+                    :member_end_cardinality,
+                    :member_end_type,
+                    :static,
+                    :action
 
-end
+      # TODO: move to Parslet::Transform
+      def members=(value)
+        value.group_by { |member| member.keys.first }
+          .each do |(type, group)|
+            if %w[owner_end member_end].include?(type)
+              group.each do |member|
+                member.each_pair do |key, member_value|
+                  public_send("#{associtaion_type(key)}=", member_value)
+                end
+              end
+              next
+            end
+            attribute_value = group.map(&:values).flatten
+            if attribute_value.length == 1 && !attribute_value.first.is_a?(Hash)
+              next public_send("#{associtaion_type(type)}=", attribute_value.first)
+            end
+
+            public_send("#{associtaion_type(type)}=", attribute_value)
+          end
+      end
+    end
+  end
+end

data/lib/lutaml/uml/behavior.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 ##
 ## Behaviour metamodel
 ##
-module Lutaml::Uml
-
-class Behavior < Class
+module Lutaml
+  module Uml
+    class Behavior < Class
+    end
+  end
 end
-
-end

data/lib/lutaml/uml/class.rb

@@ -1,17 +1,57 @@
-module Lutaml::Uml
-
-class Class < Classifier
-	attr_accessor :nested_classifier, :is_abstract
-	def initialize
-		@name = nil
-		@xmi_id = nil
-		@xmi_uuid = nil
-		@nested_classifier = []
-		@stereotype = []
-		@generalization = []
-		@namespace = nil
-		@is_abstract = false
-	end
-end
+# frozen_string_literal: true
+
+require "lutaml/uml/has_members"
+require "lutaml/uml/classifier"
+require "lutaml/uml/association"
+require "lutaml/uml/top_element_attribute"
+
+module Lutaml
+  module Uml
+    class Class < Classifier
+      include HasMembers
+
+      attr_accessor :nested_classifier,
+                    :is_abstract,
+                    :type
+
+      attr_reader :associations,
+                  :attributes,
+                  :members,
+                  :modifier
+
+      def initialize(attributes = {})
+        @nested_classifier = []
+        @stereotype = []
+        @generalization = []
+        @is_abstract = false
+        super
+      end
 
-end
+      def modifier=(value)
+        @modifier = value.to_s # TODO: Validate?
+      end
+
+      def attributes=(value)
+        @attributes = value.to_a.map do |attr|
+          TopElementAttribute.new(attr)
+        end
+      end
+
+      def associations=(value)
+        @associations = value.to_a.map do |attr|
+          Association.new(attr.to_h.merge(owner_end: name))
+        end
+      end
+
+      def methods
+        # @members&.select { |member| member.class == Method }
+        []
+      end
+
+      def relationships
+        # @members&.select { |member| member.class == ClassRelationship }
+        []
+      end
+    end
+  end
+end