archimate 1.1.0

data/lib/archimate/file_formats/archimate_v2.rb

@@ -0,0 +1,461 @@
+# frozen_string_literal: true
+
+module Archimate
+  module FileFormats
+    module ArchimateV2
+      LAYER_ENTITIES = {
+        "Business" => %w[
+          BusinessActor
+          BusinessCollaboration
+          BusinessEvent
+          BusinessFunction
+          BusinessInteraction
+          BusinessInterface
+          BusinessObject
+          BusinessProcess
+          BusinessRole
+          BusinessService
+          Contract
+          Location
+          Meaning
+          Value
+          Product
+          Representation
+        ].freeze,
+        "Application" => %w[
+          ApplicationCollaboration
+          ApplicationComponent
+          ApplicationFunction
+          ApplicationInteraction
+          ApplicationInterface
+          ApplicationService
+          DataObject
+        ].freeze,
+        "Technology" => %w[
+          Artifact
+          CommunicationPath
+          Device
+          InfrastructureFunction
+          InfrastructureInterface
+          InfrastructureService
+          Network
+          Node
+          SystemSoftware
+        ].freeze,
+        "Motivation" => %w[
+          Assessment
+          Constraint
+          Driver
+          Goal
+          Principle
+          Requirement
+          Stakeholder
+        ].freeze,
+        "Implementation and Migration" => %w[
+          Deliverable
+          Gap
+          Plateau
+          WorkPackage
+        ].freeze
+      }.freeze
+
+      ENTITIES = LAYER_ENTITIES.values.flatten.freeze
+
+      CORE_ELEMENTS = %w[Business Application Technology]
+                      .map { |layer| LAYER_ENTITIES[layer] }
+                      .inject([]) { |memo, obj| memo.concat(obj) }
+
+      CONNECTORS = %w[
+        AndJunction
+        Junction
+        OrJunction
+      ].freeze
+
+      RELATIONS = %w[
+        AccessRelationship
+        AggregationRelationship
+        AssignmentRelationship
+        AssociationRelationship
+        CompositionRelationship
+        FlowRelationship
+        InfluenceRelationship
+        RealisationRelationship
+        SpecialisationRelationship
+        TriggeringRelationship
+        UsedByRelationship
+      ].freeze
+
+      DEFAULT_RELATIONS = %w[
+        AccessRelationship
+        AggregationRelationship
+        AssignmentRelationship
+        AssociationRelationship
+        CompositionRelationship
+        FlowRelationship
+        RealisationRelationship
+        SpecialisationRelationship
+        TriggeringRelationship
+        UsedByRelationship
+      ].freeze
+
+      RELATION_VERBS = {
+        "AccessRelationship" => "accesses",
+        "AggregationRelationship" => "aggregates",
+        "AssignmentRelationship" => "is assigned to",
+        "AssociationRelationship" => "is associated with",
+        "CompositionRelationship" => "composes",
+        "FlowRelationship" => "flows to",
+        "InfluenceRelationship" => "influenecs",
+        "RealisationRelationship" => "realizes",
+        "SpecialisationRelationship" => "specializes",
+        "TriggeringRelationship" => "triggers",
+        "UsedByRelationship" => "is used by"
+      }.freeze
+
+      VIEWPOINTS = {
+        "Introductory" => { entities: CORE_ELEMENTS, relations: RELATIONS },
+        "Organization" => {
+          entities: CONNECTORS + %w[
+            BusinessActor
+            BusinessCollaboration
+            BusinessInterface
+            BusinessRole
+            Location
+          ],
+          relations: DEFAULT_RELATIONS - %w[AccessRelationship RealisationRelationship]
+        },
+        "Actor Co-operation" => {
+          entities: CONNECTORS + %w[
+            ApplicationComponent
+            ApplicationInterface
+            ApplicationService
+            BusinessActor
+            BusinessCollaboration
+            BusinessInterface
+            BusinessRole
+            BusinessService
+          ],
+          relations: DEFAULT_RELATIONS - %w[AccessRelationship]
+        },
+        "Business Function" => {
+          entities: CONNECTORS + %w[
+            BusinessActor
+            BusinessFunction
+            BusinessRole
+          ],
+          relations: DEFAULT_RELATIONS - %w[AccessRelationship RealisationRelationship]
+        },
+        "Business Process" => {
+          entities: CONNECTORS + %w[
+            ApplicationService
+            BusinessActor
+            BusinessCollaboration
+            BusinessEvent
+            BusinessFunction
+            BusinessInteraction
+            BusinessObject
+            BusinessProcess
+            BusinessRole
+            BusinessService
+            Location
+            Representation
+          ],
+          relations: DEFAULT_RELATIONS
+        },
+        "Business Process Co-operation" => {
+          entities: CONNECTORS + %w[
+            ApplicationService
+            BusinessActor
+            BusinessCollaboration
+            BusinessEvent
+            BusinessFunction
+            BusinessInteraction
+            BusinessObject
+            BusinessProcess
+            BusinessRole
+            BusinessService
+            Location
+            Representation
+          ],
+          relations: DEFAULT_RELATIONS
+        },
+        "Product" => {
+          entities: CONNECTORS + %w[
+            ApplicationComponent
+            ApplicationInterface
+            ApplicationService
+            BusinessActor
+            BusinessEvent
+            BusinessFunction
+            BusinessInteraction
+            BusinessInterface
+            BusinessProcess
+            BusinessRole
+            BusinessService
+            Contract
+            Product
+            Value
+          ],
+          relations: DEFAULT_RELATIONS
+        },
+        "Application Behavior" => {
+          entities: CONNECTORS + %w[
+            ApplicationCollaboration
+            ApplicationComponent
+            ApplicationFunction
+            ApplicationInteraction
+            ApplicationInterface
+            ApplicationService
+            DataObject
+          ],
+          relations: DEFAULT_RELATIONS
+        },
+        "Application Co-operation" => {
+          entities: CONNECTORS + %w[
+            ApplicationCollaboration
+            ApplicationComponent
+            ApplicationFunction
+            ApplicationInteraction
+            ApplicationInterface
+            ApplicationService
+            DataObject
+            Location
+          ],
+          relations: DEFAULT_RELATIONS
+        },
+        "Application Structure" => {
+          entities: CONNECTORS + %w[
+            ApplicationCollaboration
+            ApplicationComponent
+            ApplicationInterface
+            DataObject
+          ],
+          relations: DEFAULT_RELATIONS - %w[RealisationRelationship]
+        },
+        "Application Usage" => {
+          entities: CONNECTORS + %w[
+            ApplicationCollaboration
+            ApplicationComponent
+            ApplicationInterface
+            ApplicationService
+            BusinessEvent
+            BusinessFunction
+            BusinessInteraction
+            BusinessObject
+            BusinessProcess
+            BusinessRole
+            DataObject
+          ],
+          relations: DEFAULT_RELATIONS
+        },
+        "Infrastructure" => {
+          entities: CONNECTORS + %w[
+            Artifact
+            CommunicationPath
+            Device
+            InfrastructureFunction
+            InfrastructureInterface
+            InfrastructureService
+            Location
+            Network
+            Node
+            SystemSoftware
+          ],
+          relations: DEFAULT_RELATIONS
+        },
+        "Infrastructure Usage" => {
+          entities: CONNECTORS + %w[
+            ApplicationComponent
+            ApplicationFunction
+            CommunicationPath
+            Device
+            InfrastructureFunction
+            InfrastructureInterface
+            InfrastructureService
+            Network
+            Node
+            SystemSoftware
+          ],
+          relations: DEFAULT_RELATIONS
+        },
+        "Implementation and Deployment" => {
+          entities: CONNECTORS + %w[
+            ApplicationCollaboration
+            ApplicationComponent
+            Artifact
+            CommunicationPath
+            DataObject
+            Device
+            InfrastructureService
+            Network
+            Node
+            SystemSoftware
+          ],
+          relations: DEFAULT_RELATIONS
+        },
+        "Information Structure" => {
+          entities: CONNECTORS + %w[
+            Artifact
+            BusinessObject
+            DataObject
+            Meaning
+            Representation
+          ],
+          relations: DEFAULT_RELATIONS - %w[AssignmentRelationship UsedByRelationship]
+        },
+        "Service Realization" => {
+          entities: CONNECTORS + %w[
+            ApplicationCollaboration
+            ApplicationComponent
+            ApplicationService
+            BusinessActor
+            BusinessCollaboration
+            BusinessEvent
+            BusinessFunction
+            BusinessInteraction
+            BusinessObject
+            BusinessProcess
+            BusinessRole
+            BusinessService
+            DataObject
+          ],
+          relations: DEFAULT_RELATIONS
+        },
+        "Layered" => {
+          entities: ENTITIES + CONNECTORS,
+          relations: RELATIONS
+        },
+        "Landscape Map" => {
+          entities: ENTITIES + CONNECTORS,
+          relations: RELATIONS
+        },
+        "Stakeholder" => {
+          entities: %w[
+            Assessment
+            Driver
+            Goal
+            Stakeholder
+          ],
+          relations: %w[
+            AggregationRelationship
+            AssociationRelationship
+            CompositionRelationship
+            InfluenceRelationship
+            SpecialisationRelationship
+          ]
+        },
+        "Goal Realization" => {
+          entities: %w[
+            Constraint
+            Goal
+            Principle
+            Requirement
+          ],
+          relations: %w[
+            AggregationRelationship
+            AssociationRelationship
+            CompositionRelationship
+            InfluenceRelationship
+            RealisationRelationship
+            SpecialisationRelationship
+          ]
+        },
+        "Goal Contribution" => {
+          entities: %w[
+            Constraint
+            Goal
+            Principle
+            Requirement
+          ],
+          relations: %w[
+            AggregationRelationship
+            AssociationRelationship
+            CompositionRelationship
+            InfluenceRelationship
+            RealisationRelationship
+            SpecialisationRelationship
+          ]
+        },
+        "Principles" => {
+          entities: %w[
+            Goal
+            Principle
+          ],
+          relations: %w[
+            AggregationRelationship
+            AssociationRelationship
+            CompositionRelationship
+            InfluenceRelationship
+            RealisationRelationship
+            SpecialisationRelationship
+          ]
+        },
+        "Requirements Realization" => {
+          entities: CORE_ELEMENTS + CONNECTORS + %w[
+            Constraint
+            Goal
+            Requirement
+          ],
+          relations: DEFAULT_RELATIONS
+        },
+        "Motivation" => {
+          entities: %w[
+            Assessment
+            Constraint
+            Driver
+            Goal
+            Principle
+            Requirement
+            Stakeholder
+          ],
+          relations: %w[
+            AggregationRelationship
+            AssociationRelationship
+            CompositionRelationship
+            FlowRelationship
+            InfluenceRelationship
+            RealisationRelationship
+            SpecialisationRelationship
+          ]
+        },
+        "Project" => {
+          entities: CONNECTORS + %w[
+            BusinessActor
+            BusinessRole
+            Deliverable
+            Goal
+            WorkPackage
+          ],
+          relations: DEFAULT_RELATIONS - %w[AccessRelationship]
+        },
+        "Migration" => {
+          entities: CONNECTORS + %w[Gap Plateau],
+          relations: %w[
+            AndJunction
+            AssociationRelationship
+            CompositionRelationship
+            FlowRelationship
+            Junction
+            OrJunction
+            TriggeringRelationship
+          ]
+        },
+        "Implementation and Migration" => {
+          entities: CORE_ELEMENTS + CONNECTORS + %w[
+            Location
+            Requirement
+            Constraint
+            Goal
+            BusinessRole
+            WorkPackage
+            Deliverable
+            BusinessActor
+            Plateau
+            Gap
+          ],
+          relations: DEFAULT_RELATIONS
+        }
+      }.freeze
+    end
+  end
+end

data/lib/archimate/file_formats/model_exchange_file/xml_lang_string.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Archimate
+  module FileFormats
+    module ModelExchangeFile
+      class XmlLangString
+        def self.parse(node)
+          return nil unless node
+          DataModel::LangString.new(text: node.content, lang: node["xml:lang"])
+        end
+
+        def initialize(lang_str, tag_name)
+          @tag_name = tag_name
+          @lang_strs = Array(lang_str)
+        end
+
+        def serialize(xml)
+          return if @lang_strs.empty?
+
+          @lang_strs.each do |lang_str|
+            attrs = lang_str.lang && !lang_str.lang.empty? ? {"xml:lang" => lang_str.lang} : {}
+            xml.send(@tag_name, attrs) { xml.text text_proc(lang_str) }
+          end
+        end
+
+        # Processes text for text elements
+        private
+
+        def text_proc(str)
+          str.strip.tr("\r", "\n")
+        end
+      end
+    end
+  end
+end

data/lib/archimate/file_formats/model_exchange_file/xml_metadata.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Archimate
+  module FileFormats
+    module ModelExchangeFile
+      class XmlMetadata
+        def self.parse(metadata)
+          return nil unless metadata
+          DataModel::Metadata.new(schema_infos: parse_schema_infos(metadata))
+        end
+
+        def initialize(metadata)
+          @metadata = metadata
+        end
+
+        def serialize(xml)
+          return unless @metadata && @metadata.schema_infos.size > 0
+          xml.metadata do
+            if @metadata.schema_infos.size == 1
+              serialize_schema_info_body(xml, @metadata.schema_infos.first)
+            else
+              @metadata.schema_infos.each do |schema_info|
+                serialize_schema_info(xml, schema_info)
+              end
+            end
+          end
+        end
+
+        private
+
+        def serialize_schema_info(xml, schema_info)
+          xml.schemaInfo do
+            serialize_schema_info_body(xml, schema_info)
+          end
+        end
+
+        def serialize_schema_info_body(xml, schema_info)
+          xml.schema { xml.text (schema_info.schema) } if schema_info.schema
+          xml.schemaversion { xml.text (schema_info.schemaversion) } if schema_info.schemaversion
+          schema_info.elements.each do |el|
+            serialize_any_element(xml, el)
+          end
+        end
+
+        def serialize_any_element(xml, el)
+          if el.prefix && !el.prefix.empty?
+            xml_prefix = xml[el.prefix]
+          else
+            xml_prefix = xml
+          end
+          xml_prefix.send(el.element.to_sym, serialize_any_attributes(el.attributes)) do
+            xml.text(el.content) if el.content&.size > 0
+            el.children.each { |child| serialize_any_element(xml, child) }
+          end
+        end
+
+        def serialize_any_attributes(attrs)
+          attrs.each_with_object({}) do |attr, hash|
+            key = attr.prefix&.size > 0 ? [attr.prefix, attr.attribute].join(":") : attr.attribute
+            hash[key] = attr.value
+          end
+        end
+
+        def self.parse_schema_infos(metadata)
+          schema_infos = metadata.css(">schemaInfo")
+          if schema_infos.size > 0
+            schema_infos.map { |si| parse_schema_info(si) }
+          else
+            [parse_schema_info(metadata)].compact
+          end
+        end
+
+        def self.parse_schema_info(node)
+          els = node.element_children
+          return nil if els.empty?
+          schema_info_attrs = {
+            schema: nil,
+            schemaversion: nil,
+            elements: []
+          }
+          els.each do |el|
+            case(el.name)
+            when "schema"
+              schema_info_attrs[:schema] = el.text
+            when "schemaversion"
+              schema_info_attrs[:schemaversion] = el.text
+            else
+              schema_info_attrs[:elements] << parse_any_element(el)
+            end
+          end
+          DataModel::SchemaInfo.new(schema_info_attrs)
+        end
+
+        def self.parse_any_element(node)
+          return nil unless node && node.is_a?(Nokogiri::XML::Element)
+          DataModel::AnyElement.new(
+            element: node.name,
+            prefix: node.namespace&.prefix,
+            attributes: node.attributes.map { |attr| parse_any_attribute(attr) },
+            content: node.text,
+            children: node.element_children.map { |child| parse_any_element(node) }
+          )
+        end
+
+        def self.parse_any_attribute(attr)
+          DataModel::AnyAttribute.new(
+            attribute: attr.name,
+            prefix: attr.namepace&.prefix,
+            value: attr.text
+          )
+        end
+      end
+    end
+  end
+end

data/lib/archimate/file_formats/model_exchange_file/xml_property_definitions.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Archimate
+  module FileFormats
+    module ModelExchangeFile
+      # Property Definitions as defined in ArchiMate 3.0 Model Exchange XSDs
+      class XmlPropertyDefinitions
+        def initialize(property_defs)
+          @property_definitions = property_defs
+        end
+
+        def serialize(xml)
+          return if @property_definitions.empty?
+          xml.propertyDefinitions do
+            @property_definitions.each do |property_def|
+              xml.propertyDefinition(
+                "identifier" => property_def.id,
+                "type" => property_def.value_type
+              ) do
+                ModelExchangeFile::XmlLangString.new(property_def.name, :name).serialize(xml)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/archimate/file_formats/model_exchange_file/xml_property_defs.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Archimate
+  module FileFormats
+    module ModelExchangeFile
+      # Property Definitions as defined in ArchiMate 2.1 Model Exchange XSDs
+      class XmlPropertyDefs
+        def initialize(property_defs)
+          @property_definitions = property_defs
+        end
+
+        def serialize(xml)
+          return if @property_definitions.empty?
+          xml.propertydefs do
+            @property_definitions.each do |property_def|
+              xml.propertydef(
+                "identifier" => property_def.id,
+                "name" => property_def.name,
+                "type" => property_def.value_type
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end