lutaml-lml 0.1.0

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'set'
+
+module Lutaml
+  module Formatter
+    class Graphviz < Base
+      autoload :HtmlBuilder, "lutaml/lml/formatter/graphviz/html_builder"
+      autoload :NodeFormatter, "lutaml/lml/formatter/graphviz/node_formatter"
+      autoload :RelationshipFormatter, "lutaml/lml/formatter/graphviz/relationship_formatter"
+      autoload :DocumentFormatter, "lutaml/lml/formatter/graphviz/document_formatter"
+
+      include HtmlBuilder
+      include NodeFormatter
+      include RelationshipFormatter
+      include DocumentFormatter
+
+      class Attributes < Hash
+        def to_s
+          to_a
+            .reject { |(_k, val)| val.nil? }
+            .map { |(a, b)| "#{a}=#{b.inspect}" }
+            .join(' ')
+        end
+      end
+
+      DEFAULT_CLASS_FONT = 'Helvetica'
+
+      VALID_TYPES = %i[
+        dot xdot ps pdf svg svgz fig png gif jpg jpeg json imap cmapx
+      ].freeze
+
+      def initialize(attributes = {})
+        super
+        setup_default_attributes
+        @type = :dot
+      end
+
+      attr_reader :graph, :edge, :node
+
+      def type=(value)
+        super
+        @type = :dot unless VALID_TYPES.include?(@type)
+      end
+
+      def format(node)
+        dot = super.lines.map(&:rstrip).join("\n")
+        generate_from_dot(dot)
+      end
+
+      def setup_default_attributes
+        @graph = build_graph_attrs
+        @edge = build_edge_attrs
+        @node = build_node_attrs
+      end
+
+      def build_graph_attrs
+        Attributes.new.tap do |g|
+          g['splines'] = 'ortho'
+          g['pad'] = '0.5'
+          g['ranksep'] = '1.2'
+          g['nodesep'] = '1.2'
+          g['rankdir'] = 'BT'
+        end
+      end
+
+      def build_edge_attrs
+        Attributes.new.tap { |e| e['color'] = 'gray50' }
+      end
+
+      def build_node_attrs
+        Attributes.new.tap { |n| n['shape'] = 'box' }
+      end
+
+      private :setup_default_attributes, :build_graph_attrs,
+              :build_edge_attrs, :build_node_attrs
+
+      protected
+
+      def generate_from_dot(input)
+        Lutaml::Layout::GraphVizEngine.new(input: input).render(@type)
+      end
+
+      def generate_graph_name(name)
+        name.gsub(/[^0-9a-zA-Z]/i, '')
+      end
+    end
+  end
+end

data/lib/lutaml/lml/formatter.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Formatter
+    autoload :Base, "lutaml/lml/formatter/base"
+    autoload :Graphviz, "lutaml/lml/formatter/graphviz"
+  end
+end

data/lib/lutaml/lml/grammar/concerns/associations.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Lml
+    module Grammar
+      module Concerns
+        module Associations
+          include Parslet
+
+          rule(:association_keyword) { kw_association >> spaces }
+
+          %w[owner member].each do |association_end_type|
+            rule("#{association_end_type}_cardinality") do
+              spaces? >>
+                str("[") >>
+                cardinality_body_definition
+                  .as("#{association_end_type}_end_cardinality") >>
+                str("]")
+            end
+            rule("#{association_end_type}_cardinality?") do
+              public_send(:"#{association_end_type}_cardinality").maybe
+            end
+            rule("#{association_end_type}_attribute_name") do
+              str("#") >>
+                visibility? >>
+                spaces? >>
+                variable.as("#{association_end_type}_end_attribute_name") >>
+                spaces?
+            end
+            rule("#{association_end_type}_attribute_name?") do
+              public_send(:"#{association_end_type}_attribute_name").maybe
+            end
+            rule("#{association_end_type}_definition") do
+              public_send(:"kw_#{association_end_type}") >>
+                spaces >>
+                variable.as("#{association_end_type}_end") >>
+                public_send(:"#{association_end_type}_attribute_name?") >>
+                public_send(:"#{association_end_type}_cardinality?")
+            end
+            rule("#{association_end_type}_type") do
+              public_send(:"kw_#{association_end_type}_type") >>
+                spaces >>
+                variable.as("#{association_end_type}_end_type")
+            end
+          end
+
+          rule(:association_inner_definitions) do
+            owner_type |
+              member_type |
+              owner_definition |
+              member_definition |
+              comment_definition |
+              comment_multiline_definition
+          end
+          rule(:association_inner_definition) do
+            association_inner_definitions >> whitespace?
+          end
+          rule(:association_body) do
+            spaces? >>
+              str("{") >>
+              whitespace? >>
+              association_inner_definition.repeat.as(:members) >>
+              str("}")
+          end
+          rule(:association_definition) do
+            association_keyword >>
+              spaces? >>
+              variable.as(:name).maybe >>
+              spaces? >>
+              association_body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lutaml/lml/grammar/concerns/attributes.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Lml
+    module Grammar
+      module Concerns
+        module Attributes
+          include Parslet
+
+          rule(:attribute) do
+            comment_definition |
+              variable.as(:key) >> spaces? >> str("+").as(:add).maybe >> str("=").maybe >> spaces? >> attribute_value.as(:value)
+          end
+          rule(:attributes) do
+            (
+              attribute_line | whitespace
+            ).repeat.as(:attributes)
+          end
+          rule(:attribute_line) do
+            spaces? >> attribute >> (str(",").maybe >> whitespace).maybe
+          end
+          rule(:member_static) { (kw_static.as(:static) >> spaces).maybe }
+          rule(:visibility) do
+            kw_visibility_modifier.as(:visibility_modifier)
+          end
+          rule(:visibility?) { visibility.maybe }
+
+          rule(:method_abstract) { (kw_abstract.as(:abstract) >> spaces).maybe }
+          rule(:attribute_keyword) do
+            str("<<") >>
+              match['a-zA-Z0-9_\-\/'].repeat(1).as(:keyword) >>
+              str(">>")
+          end
+          rule(:attribute_keyword?) { attribute_keyword.maybe }
+          rule(:attribute_type) do
+            (str(":").maybe >>
+              spaces? >>
+              attribute_keyword? >>
+              spaces? >>
+              quotes? >>
+              match['a-zA-Z0-9_\- \/\+'].repeat(1).as(:type) >>
+              quotes? >>
+              spaces?
+            )
+          end
+          rule(:attribute_type?) do
+            attribute_type.maybe
+          end
+
+          rule(:attribute_name) { match['a-zA-Z0-9_\-\/\+'].repeat(1).as(:name) }
+          rule(:attribute_definition_name) do
+            (quotes >> match['a-zA-Z0-9_\- \/\+'].repeat(1).as(:name) >> quotes) |
+              attribute_name
+          end
+
+          rule(:attribute_definition) do
+            (visibility?.as(:visibility) >>
+              spaces? >>
+              attribute_definition_name >>
+              spaces? >>
+              attribute_type? >>
+              cardinality? >>
+              class_body?)
+              .as(:attributes)
+          end
+
+          rule(:keyword_type_argument) do
+            (
+              str("type") >>
+                spaces? >>
+                match["[^\s\n\r]"].repeat(1).as(:type) >>
+                whitespace?
+            )
+          end
+
+          rule(:keyword_cardinality_argument) do
+            (
+              str("cardinality") >>
+                spaces? >>
+                cardinality_body_definition.as(:cardinality) >>
+                whitespace?
+            )
+          end
+
+          rule(:keyword_any_argument) do
+            (
+              spaces? >>
+                match("[^\s\n\r]").repeat(1).as(:name) >>
+                spaces >>
+                str("=").maybe >>
+                spaces? >>
+                attribute_value.as(:value) >>
+                whitespace?
+            )
+          end
+
+          rule(:keyword_attribute_options) do
+            (
+              keyword_type_argument |
+                keyword_cardinality_argument |
+                keyword_any_argument.as(:properties)
+            ).repeat
+          end
+
+          rule(:keyword_attribute_body) do
+            str("{") >>
+              whitespace? >>
+              keyword_attribute_options >>
+              whitespace? >>
+              str("}")
+          end
+
+          rule(:keyword_attribute_definition) do
+            (
+              str("attribute") >>
+                spaces >>
+                attribute_name >>
+                spaces? >>
+                keyword_attribute_body
+            ).as(:attributes)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lutaml/lml/grammar/concerns/data_structures.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Lml
+    module Grammar
+      module Concerns
+        module DataStructures
+          include Parslet
+
+          rule(:attribute_value) { instance | list | key_value_map | value | match("[^\n]").repeat(1) }
+
+          rule(:list_item) { instance | value }
+          rule(:list) do
+            str("[") >> whitespace? >>
+              (list_item >> spaces? >> str(",").maybe >> whitespace?).repeat.as(:list) >> whitespace? >>
+              str("]")
+          end
+
+          rule(:collection) do
+            kw_collection >> spaces >> quoted_string.as(:name) >> spaces? >>
+              str("{") >> whitespace? >>
+              includes.maybe >> whitespace? >>
+              validation.maybe >> whitespace? >>
+              str("}") >> whitespace?
+          end
+
+          rule(:includes) do
+            kw_includes >> spaces? >> list.as(:includes)
+          end
+
+          rule(:validation) do
+            kw_validation >> spaces? >> str("{") >> whitespace? >>
+              condition.repeat.as(:validations) >>
+              str("}")
+          end
+
+          rule(:condition) do
+            kw_condition >> spaces >> quoted_string.as(:condition) >> whitespace?
+          end
+
+          rule(:import) do
+            kw_import >> spaces? >> str("{") >> whitespace? >>
+              import_definition.repeat.as(:imports) >>
+            str("}") >> whitespace?
+          end
+
+          rule(:import_definition) do
+            match("[^\s\n\r]").repeat(1).as(:format_type) >> spaces? >> quoted_string.as(:file) >> whitespace? >>
+              str("{") >> whitespace? >>
+              attributes >> whitespace? >>
+              str("}") >> whitespace?
+          end
+
+          rule(:instances) do
+            kw_instances >> whitespace? >>
+              str("{") >> whitespace? >>
+              instances_body.maybe >>
+              str("}") >> whitespace?
+          end
+
+          rule(:instances_body) do
+            (instances_member >> whitespace?).repeat.as(:instances)
+          end
+
+          rule(:instances_member) do
+            import | collection.as(:collections) | export | instance
+          end
+
+          rule(:export) do
+            kw_export >> whitespace? >> str("{") >> whitespace? >>
+              (export_format >> whitespace?).repeat.as(:exports) >>
+              str("}") >> whitespace?
+          end
+
+          rule(:export_format) do
+            kw_format >> spaces >> variable.as(:format_type) >> whitespace? >> str("{") >> whitespace? >>
+              attributes >>
+              str("}") >> whitespace?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lutaml/lml/grammar/concerns/definitions.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Lml
+    module Grammar
+      module Concerns
+        module Definitions
+          include Parslet
+
+          # -- Class
+          rule(:kw_class_modifier) { kw_abstract | kw_interface }
+
+          rule(:class_modifier) do
+            (kw_class_modifier.as(:modifier) >> spaces).maybe
+          end
+          rule(:class_keyword) { kw_class >> spaces }
+          rule(:class_inner_definitions) do
+            definition_body |
+              ((str("attribute") >> spaces).absent? >> attribute_definition) |
+              keyword_attribute_definition |
+              comment_definition |
+              comment_multiline_definition
+          end
+          rule(:class_inner_definition) do
+            class_inner_definitions >> whitespace?
+          end
+          rule(:class_body) do
+            spaces? >>
+              str("{") >>
+              whitespace? >>
+              class_inner_definition.repeat.as(:members) >>
+              str("}")
+          end
+          rule(:class_body?) { class_body.maybe }
+
+          rule(:parent_class) do
+            spaces? >> str("<") >> spaces? >> class_name_chars.as(:parent_class)
+          end
+
+          rule(:class_definition) do
+            class_modifier >>
+              class_keyword >>
+              class_name.as(:name) >>
+              parent_class.maybe >>
+              spaces? >>
+              attribute_keyword? >>
+              class_body?
+          end
+
+          # -- Definition
+          rule(:definition_body) do
+            spaces? >>
+              str("definition") >>
+              whitespace? >>
+              str("{") >>
+              ((str("\\") >> any) | (str("}").absent? >> any))
+                .repeat.maybe.as(:definition) >>
+              str("}")
+          end
+
+          # -- Enum
+          rule(:enum_keyword) { kw_enum >> spaces }
+          rule(:enum_inner_definitions) do
+            definition_body |
+              attribute_definition |
+              comment_definition |
+              comment_multiline_definition
+          end
+          rule(:enum_inner_definition) do
+            enum_inner_definitions >> whitespace?
+          end
+          rule(:enum_body) do
+            spaces? >>
+              str("{") >>
+              whitespace? >>
+              enum_inner_definition.repeat.as(:members) >>
+              str("}")
+          end
+          rule(:enum_body?) { enum_body.maybe }
+          rule(:enum_definition) do
+            enum_keyword >>
+              quotes? >>
+              class_name.as(:name) >>
+              quotes? >>
+              attribute_keyword? >>
+              enum_body?
+          end
+
+          # -- data_type
+          rule(:data_type_keyword) { kw_data_type >> spaces }
+          rule(:data_type_inner_definitions) do
+            definition_body |
+              attribute_definition |
+              comment_definition |
+              comment_multiline_definition
+          end
+          rule(:data_type_inner_definition) do
+            data_type_inner_definitions >> whitespace?
+          end
+          rule(:data_type_body) do
+            spaces? >>
+              str("{") >>
+              whitespace? >>
+              data_type_inner_definition.repeat.as(:members) >>
+              str("}")
+          end
+          rule(:data_type_body?) { data_type_body.maybe }
+          rule(:data_type_definition) do
+            data_type_keyword >>
+              quotes? >>
+              class_name.as(:name) >>
+              quotes? >>
+              attribute_keyword? >>
+              data_type_body?
+          end
+
+          # -- primitive
+          rule(:primitive_keyword) { kw_primitive >> spaces }
+          rule(:primitive_definition) do
+            primitive_keyword >>
+              quotes? >>
+              class_name.as(:name) >>
+              quotes?
+          end
+
+          # -- Diagram
+          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) |
+              primitive_definition.as(:primitives) |
+              data_type_definition.as(:data_types) |
+              association_definition.as(:associations) |
+              comment_definition |
+              comment_multiline_definition
+          end
+          rule(:diagram_inner_definition) do
+            diagram_inner_definitions >> whitespace?
+          end
+          rule(:diagram_body) do
+            spaces? >>
+              str("{") >>
+              whitespace? >>
+              diagram_inner_definition.repeat.as(:members) >>
+              str("}")
+          end
+          rule(:diagram_definition) do
+            diagram_keyword >>
+              spaces? >>
+              class_name.as(:name) >>
+              diagram_body >>
+              whitespace?
+          end
+          rule(:diagram_definitions) { diagram_definition >> whitespace? }
+
+          # -- View (extends diagram with import/show/hide)
+          rule(:view_keyword) { kw_view >> spaces? }
+          rule(:view_inner_definitions) do
+            title_definition |
+              caption_definition |
+              fontname_definition |
+              view_import.as(:view_imports) |
+              show_directive |
+              hide_directive |
+              class_definition.as(:classes) |
+              enum_definition.as(:enums) |
+              primitive_definition.as(:primitives) |
+              data_type_definition.as(:data_types) |
+              association_definition.as(:associations) |
+              comment_definition |
+              comment_multiline_definition
+          end
+          rule(:view_inner_definition) do
+            view_inner_definitions >> whitespace?
+          end
+          rule(:view_body) do
+            spaces? >>
+              str("{") >>
+              whitespace? >>
+              view_inner_definition.repeat.as(:members) >>
+              str("}")
+          end
+          rule(:view_definition) do
+            view_keyword >>
+              spaces? >>
+              class_name.as(:name) >>
+              view_body >>
+              whitespace?
+          end
+          rule(:view_definitions) { view_definition >> whitespace? }
+
+          # -- Metadata
+          rule(:title_keyword) { kw_title >> spaces }
+          rule(:title_text) do
+            quotes? >>
+              match['a-zA-Z0-9_\- ,.:;'].repeat(1).as(:title) >>
+              quotes?
+          end
+          rule(:title_definition) { title_keyword >> title_text }
+          rule(:caption_keyword) { kw_caption >> spaces }
+          rule(:caption_text) do
+            quotes? >>
+              match['a-zA-Z0-9_\- ,.:;'].repeat(1).as(:caption) >>
+              quotes?
+          end
+          rule(:caption_definition) { caption_keyword >> caption_text }
+
+          rule(:fontname_keyword) { kw_fontname >> spaces }
+          rule(:fontname_text) do
+            quotes? >>
+              match['a-zA-Z0-9_\- '].repeat(1).as(:fontname) >>
+              quotes?
+          end
+          rule(:fontname_definition) { fontname_keyword >> fontname_text }
+        end
+      end
+    end
+  end
+end

data/lib/lutaml/lml/grammar/concerns/instance_rules.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Lml
+    module Grammar
+      module Concerns
+        module InstanceRules
+          include Parslet
+
+          rule(:instance) do
+            keyword_instance | class_instance
+          end
+
+          rule(:keyword_instance) do
+            (
+              kw_instance >> (spaces >> namespaced_identifier.as(:instance_type)).maybe >> spaces? >>
+              str("{") >> whitespace? >>
+              ((spaces? >> instance) | attributes) >>
+              str("}")
+            ).as(:instance) >> whitespace?
+          end
+
+          rule(:class_instance) do
+            (variable.as(:instance_type) >> whitespace? >> quoted_string.as(:name) >> whitespace? >>
+              (kw_extends >> whitespace? >> quoted_string.as(:parent) >> whitespace?).maybe >>
+               str("{") >> whitespace? >>
+              lml_instance_body.maybe >>
+              str("}")).as(:instance) >> whitespace?
+          end
+
+          rule(:lml_instance_body) do
+            (lml_instance_members >> whitespace?)
+          end
+
+          rule(:instance_template) do
+            kw_template >> whitespace? >> str("{") >> whitespace? >>
+              attributes >> whitespace? >>
+              str("}") >> whitespace?
+          end
+
+          rule(:lml_instance_members) do
+            instance_template.as(:template) | attributes
+          end
+
+          rule(:models) do
+            kw_models >> whitespace? >>
+              variable.as(:name) >> whitespace? >> str("{") >>
+              model_body.repeat.as(:members) >>
+              str("}") >> whitespace?
+          end
+
+          rule(:model_body) do
+            (class_definition.as(:classes) | enum_definition.as(:enums)) >> whitespace?
+          end
+        end
+      end
+    end
+  end
+end