archimate 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24983cbe0a25eb6b4fdd4592faf9d424f3f6dab8a0a28495cfa0c79f81bf6f18
-  data.tar.gz: 91796ec52b8680a1449c8a9e424894e786191a82b2e96679ca767dee69ffa04a
+  metadata.gz: 0f7cec778a203f45d8559a57bebf5ad29fbecfaad296d3c4a0b9fdc47d746baa
+  data.tar.gz: 304983b0c9afd59fdd6f703a0866fc29f716da49681970d3fa3b2736d9f0b8f1
 SHA512:
-  metadata.gz: 6b3d2698127d1aad4f6f729ef1735322658670e8527ab0d7a746ca23c9c7d77669ccb9751d731a4efe431355bf376904237f3a85fd60edf260f252a411a1a6be
-  data.tar.gz: 530ce2ba4cb376a6120fcb2c80c7aab6f2eed57c02a6dff21825de3018079c3714e39fec69728bc6dd38bbc0e8433e87d9c9d9fd458c9a4914738af2ad1cb0c5
+  metadata.gz: 5229b50c9b1af5e15e505f331ff197d3cbaf8519b0f93c3f7b636c852b282fcf8c15a9a05311ef7c2e8979c386deed3601be48d201e598e2523b854ec25c6bd6
+  data.tar.gz: 1cbb2a88d904e7a08e756c7ea51ba745a5c0da6dd4deb382359f3638fcdd593da18f1c007db24108e500a86529b6bc7cac4cb8cab791e02848ec09d1db4e3e8e

data/bin/archimate

@@ -15,7 +15,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/lib/archimate/cli/archi.rb

@@ -62,12 +62,24 @@ module Archimate
              type: :boolean,
              default: false,
              desc: "Use diagram name for filename (default: diagram id)"
+      option :format_xml,
+             aliases: :f,
+             type: :boolean,
+             default: true,
+             desc: "Format (pretty print) the SVG output (default: true)"
+      option :legend,
+             aliases: :l,
+             type: :boolean,
+             default: false,
+             desc: "Include an ArchiMate legend in each diagram"
       def svg(archifile)
         Config.instance.interactive = !options.fetch("noninteractive", false)
         Archimate::Cli::Svger.export_svgs(
           archifile,
           options.fetch("output", Dir.pwd),
-          options["name"] ? :name : :id
+          svg_name: options["name"] ? :name : :id,
+          legend: options["legend"],
+          format_xml: options["format_xml"]
         )
       end
 

data/lib/archimate/cli/svger.rb

@@ -2,18 +2,25 @@
 
 module Archimate
   module Cli
-    SVG_NAME_OPTION = [:id, :name] # TODO: add a way to export in folders with :folder_name]
+    SVG_NAME_OPTION = %i[id name].freeze # TODO: add a way to export in folders with :folder_name]
+    DEFAULT_OPTIONS = {
+      svg_name: :id,
+      format_xml: true,
+      legend: false
+    }.freeze
 
     # This class is used to export SVG diagrams as defined in the given model
     class Svger
-      def self.export_svgs(archi_file, output_dir, name_option = :id)
-        new(Archimate.read(archi_file).diagrams, output_dir, name_option).export_svgs
+      attr_reader :options
+
+      def self.export_svgs(archi_file, output_dir, options = {})
+        new(Archimate.read(archi_file).diagrams, output_dir, options).export_svgs
       end
 
-      def initialize(diagrams, output_dir, name_option = :id)
+      def initialize(diagrams, output_dir, options = {})
+        @options = DEFAULT_OPTIONS.merge(options)
         @diagrams = diagrams
         @output_dir = output_dir
-        @name_option = name_option
         @diagram_base_names = {}
       end
 
@@ -21,7 +28,7 @@ module Archimate
         @diagram_base_names = {}
         progress = ProgressIndicator.new(total: @diagrams.size, title: "Writing SVGs")
         @diagrams.each do |diagram|
-          export(diagram, filename_for(diagram, @name_option))
+          export(diagram, filename_for(diagram, options[:svg_name]))
           progress.increment
         end
       ensure
@@ -31,7 +38,7 @@ module Archimate
       def export(diagram, file_name = nil)
         file_name = Cli.process_svg_filename(file_name || diagram.id)
         File.open(File.join(@output_dir, file_name), "wb") do |svg_file|
-          svg_file.write(Svg::Diagram.new(diagram).to_svg)
+          svg_file.write(Svg::Diagram.new(diagram, options).to_svg)
         end
       end
 
@@ -40,10 +47,8 @@ module Archimate
         base_name = diagram_base_name(diagram, name_option)
         if @diagram_base_names.include?(base_name)
           idx = 2
-          while @diagram_base_names.include?(base_name + " - #{idx}") do
-            idx += 1
-          end
-          base_name = base_name + " - #{idx}"
+          idx += 1 while @diagram_base_names.include?(base_name + " - #{idx}")
+          base_name += " - #{idx}"
         end
         base_name
       end

data/lib/archimate/data_model/element.rb

@@ -9,6 +9,7 @@ module Archimate
     # attribute of +xsi:type="BusinessRole"+ where +BusinessRole+ is a derived
     # type from [ElementType].
     class Element
+      LAYER = Layers::None
       include Comparison
       include Referenceable
       include RelationshipReferences

data/lib/archimate/data_model/elements.rb

@@ -8,6 +8,8 @@ module Archimate
       #############################################################
 
       class BusinessActor < Element
+        NAME = "Business Actor"
+        DESCRIPTION = "A business actor is a business entity that is capable of performing behavior."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Business
 
@@ -17,6 +19,8 @@ module Archimate
       end
 
       class BusinessCollaboration < Element
+        NAME = "Business Collaboration"
+        DESCRIPTION = "A business collaboration is an aggregate of two or more business internal active structure elements that work together to perform collective behavior."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Business
 
@@ -26,6 +30,8 @@ module Archimate
       end
 
       class BusinessEvent < Element
+        NAME = "Business Event"
+        DESCRIPTION = "A business event is a business behavior element that denotes an organizational state change. It may originate from and be resolved inside or outside the organization."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Business
 
@@ -35,6 +41,8 @@ module Archimate
       end
 
       class BusinessFunction < Element
+        NAME = "Business Function"
+        DESCRIPTION = "A business function is a collection of business behavior based on a chosen set of criteria (typically required business resources and/or competencies), closely aligned to an organization, but not necessarily explicitly governed by the organization."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Business
 
@@ -44,6 +52,8 @@ module Archimate
       end
 
       class BusinessInteraction < Element
+        NAME = "Business Interaction"
+        DESCRIPTION = "A business interaction is a unit of collective business behavior performed by (a collaboration of) two or more business roles."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Business
 
@@ -53,6 +63,8 @@ module Archimate
       end
 
       class BusinessInterface < Element
+        NAME = "Business Interface"
+        DESCRIPTION = "A business interface is a point of access where a business service is made available to the environment."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Business
 
@@ -62,6 +74,8 @@ module Archimate
       end
 
       class BusinessObject < Element
+        NAME = "Business Object"
+        DESCRIPTION = "A business object represents a concept used within a particular business domain."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Business
 
@@ -71,6 +85,8 @@ module Archimate
       end
 
       class BusinessProcess < Element
+        NAME = "Business Process"
+        DESCRIPTION = "A business process represents a sequence of business behaviors that achieves a specific outcome such as a defined set of products or business services."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Business
 
@@ -80,6 +96,8 @@ module Archimate
       end
 
       class BusinessRole < Element
+        NAME = "Business Role"
+        DESCRIPTION = "A business role is the responsibility for performing specific behavior, to which an actor can be assigned, or the part an actor plays in a particular action or event."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Business
 
@@ -89,6 +107,8 @@ module Archimate
       end
 
       class BusinessService < Element
+        NAME = "Business Service"
+        DESCRIPTION = "A business service represents an explicitly defined exposed business behavior."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Business
 
@@ -98,6 +118,8 @@ module Archimate
       end
 
       class Contract < Element
+        NAME = "Contract"
+        DESCRIPTION = "A contract represents a formal or informal specification of an agreement between a provider and a consumer that specifies the rights and obligations associated with a product and establishes functional and non-functional parameters for interaction."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Business
 
@@ -107,6 +129,8 @@ module Archimate
       end
 
       class Location < Element
+        NAME = "Location"
+        DESCRIPTION = "A location is a place or position where structure elements can be located or behavior can be performed."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Business
 
@@ -116,6 +140,8 @@ module Archimate
       end
 
       class Product < Element
+        NAME = "Product"
+        DESCRIPTION = "A product represents a coherent collection of services and/or passive structure elements, accompanied by a contract/set of agreements, which is offered as a whole to (internal or external) customers."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Business
 
@@ -125,6 +151,8 @@ module Archimate
       end
 
       class Representation < Element
+        NAME = "Representation"
+        DESCRIPTION = "A representation represents a perceptible form of the information carried by a business object."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Business
 
@@ -138,6 +166,8 @@ module Archimate
       #############################################################
 
       class ApplicationCollaboration < Element
+        NAME = "Application Collaboration"
+        DESCRIPTION = "An application collaboration represents an aggregate of two or more application components that work together to perform collective application behavior."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Application
 
@@ -147,6 +177,8 @@ module Archimate
       end
 
       class ApplicationComponent < Element
+        NAME = "Application Component"
+        DESCRIPTION = "An application component represents an encapsulation of application functionality aligned to implementation structure, which is modular and replaceable. It encapsulates its behavior and data, exposes services, and makes them available through interfaces."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Application
 
@@ -156,6 +188,8 @@ module Archimate
       end
 
       class ApplicationEvent < Element
+        NAME = "Application Event"
+        DESCRIPTION = "An application event is an application behavior element that denotes a state change."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Application
 
@@ -165,6 +199,8 @@ module Archimate
       end
 
       class ApplicationFunction < Element
+        NAME = "Application Function"
+        DESCRIPTION = "An application function represents automated behavior that can be performed by an application component."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Application
 
@@ -174,6 +210,8 @@ module Archimate
       end
 
       class ApplicationInteraction < Element
+        NAME = "Application Interaction"
+        DESCRIPTION = "An application interaction represents a unit of collective application behavior performed by (a collaboration of) two or more application components."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Application
 
@@ -183,6 +221,8 @@ module Archimate
       end
 
       class ApplicationInterface < Element
+        NAME = "Application Interface"
+        DESCRIPTION = "An application interface represents a point of access where application services are made available to a user, another application component, or a node."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Application
 
@@ -192,6 +232,8 @@ module Archimate
       end
 
       class ApplicationProcess < Element
+        NAME = "Application Process"
+        DESCRIPTION = "An application process represents a sequence of application behaviors that achieves a specific outcome."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Application
 
@@ -201,6 +243,8 @@ module Archimate
       end
 
       class ApplicationService < Element
+        NAME = "Application Service"
+        DESCRIPTION = "An application service represents an explicitly defined exposed application behavior."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Application
 
@@ -210,6 +254,8 @@ module Archimate
       end
 
       class DataObject < Element
+        NAME = "Data Object"
+        DESCRIPTION = "A data object represents data structured for automated processing."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Application
 
@@ -223,6 +269,8 @@ module Archimate
       #############################################################
 
       class Artifact < Element
+        NAME = "Artifact"
+        DESCRIPTION = "An artifact represents a piece of data that is used or produced in a software development process, or by deployment and operation of an IT system."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Technology
 
@@ -232,6 +280,8 @@ module Archimate
       end
 
       class CommunicationNetwork < Element
+        NAME = "Communication Network"
+        DESCRIPTION = "A communication network represents a set of structures that connects computer systems or other electronic devices for transmission, routing, and reception of data or data-based communications such as voice and video."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -241,6 +291,8 @@ module Archimate
       end
 
       class CommunicationPath < Element
+        NAME = "Communication Path"
+        DESCRIPTION = "A path represents a link between two or more nodes, through which these nodes can exchange data or material."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -250,6 +302,8 @@ module Archimate
       end
 
       class Device < Element
+        NAME = "Device"
+        DESCRIPTION = "A device is a physical IT resource upon which system software and artifacts may be stored or deployed for execution."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -259,6 +313,8 @@ module Archimate
       end
 
       class InfrastructureFunction < Element
+        NAME = "Infrastructure Function"
+        DESCRIPTION = "A technology function represents a collection of technology behavior that can be performed by a node."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -268,6 +324,8 @@ module Archimate
       end
 
       class InfrastructureInterface < Element
+        NAME = "Infrastructure Interface"
+        DESCRIPTION = "A technology interface represents a point of access where technology services offered by a node can be accessed."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -277,6 +335,8 @@ module Archimate
       end
 
       class InfrastructureService < Element
+        NAME = "Infrastructure Service"
+        DESCRIPTION = "A technology service represents an explicitly defined exposed technology behavior."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -286,6 +346,8 @@ module Archimate
       end
 
       class Network < Element
+        NAME = "Network"
+        DESCRIPTION = "A communication network represents a set of structures that connects computer systems or other electronic devices for transmission, routing, and reception of data or data-based communications such as voice and video."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -295,6 +357,8 @@ module Archimate
       end
 
       class Node < Element
+        NAME = "Node"
+        DESCRIPTION = "A node represents a computational or physical resource that hosts, manipulates, or interacts with other computational or physical resources."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -304,6 +368,8 @@ module Archimate
       end
 
       class Path < Element
+        NAME = "Path"
+        DESCRIPTION = "A path represents a link between two or more nodes, through which these nodes can exchange data or material."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -313,6 +379,8 @@ module Archimate
       end
 
       class SystemSoftware < Element
+        NAME = "System Software"
+        DESCRIPTION = "System software represents software that provides or contributes to an environment for storing, executing, and using software or data deployed within it."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -322,6 +390,8 @@ module Archimate
       end
 
       class TechnologyCollaboration < Element
+        NAME = "Technology Collaboration"
+        DESCRIPTION = "A technology collaboration represents an aggregate of two or more nodes that work together to perform collective technology behavior."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -331,6 +401,8 @@ module Archimate
       end
 
       class TechnologyEvent < Element
+        NAME = "Technology Event"
+        DESCRIPTION = "A technology event is a technology behavior element that denotes a state change."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Technology
 
@@ -340,6 +412,8 @@ module Archimate
       end
 
       class TechnologyFunction < Element
+        NAME = "Technology Function"
+        DESCRIPTION = "A technology function represents a collection of technology behavior that can be performed by a node."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Technology
 
@@ -349,6 +423,8 @@ module Archimate
       end
 
       class TechnologyInteraction < Element
+        NAME = "Technology Interaction"
+        DESCRIPTION = "A technology interaction represents a unit of collective technology behavior performed by (a collaboration of) two or more nodes."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Technology
 
@@ -358,6 +434,8 @@ module Archimate
       end
 
       class TechnologyInterface < Element
+        NAME = "Technology Interface"
+        DESCRIPTION = "A technology interface represents a point of access where technology services offered by a node can be accessed."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Technology
 
@@ -367,6 +445,8 @@ module Archimate
       end
 
       class TechnologyObject < Element
+        NAME = "Technology Object"
+        DESCRIPTION = "A technology object represents a passive element that is used or produced by technology behavior."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Technology
 
@@ -376,6 +456,8 @@ module Archimate
       end
 
       class TechnologyProcess < Element
+        NAME = "Technology Process"
+        DESCRIPTION = "A technology process represents a sequence of technology behaviors that achieves a specific outcome."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Technology
 
@@ -385,6 +467,8 @@ module Archimate
       end
 
       class TechnologyService < Element
+        NAME = "Technology Service"
+        DESCRIPTION = "A technology service represents an explicitly defined exposed technology behavior."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Technology
 
@@ -398,6 +482,8 @@ module Archimate
       #############################################################
 
       class DistributionNetwork < Element
+        NAME = "Distribution Network"
+        DESCRIPTION = "A distribution network represents a physical network used to transport materials or energy."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Physical
 
@@ -407,6 +493,8 @@ module Archimate
       end
 
       class Equipment < Element
+        NAME = "Equipment"
+        DESCRIPTION = "Equipment represents one or more physical machines, tools, or instruments that can create, use, store, move, or transform materials."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Physical
 
@@ -416,6 +504,8 @@ module Archimate
       end
 
       class Facility < Element
+        NAME = "Facility"
+        DESCRIPTION = "A facility represents a physical structure or environment."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Physical
 
@@ -425,6 +515,8 @@ module Archimate
       end
 
       class Material < Element
+        NAME = "Material"
+        DESCRIPTION = "Material represents tangible physical matter or physical elements."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Physical
 
@@ -438,6 +530,8 @@ module Archimate
       #############################################################
 
       class Assessment < Element
+        NAME = "Assessment"
+        DESCRIPTION = "An assessment represents the result of an analysis of the state of affairs of the enterprise with respect to some driver."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Motivation
 
@@ -447,6 +541,8 @@ module Archimate
       end
 
       class Constraint < Element
+        NAME = "Constraint"
+        DESCRIPTION = "A constraint represents a factor that prevents or obstructs the realization of goals."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Motivation
 
@@ -456,6 +552,8 @@ module Archimate
       end
 
       class Driver < Element
+        NAME = "Driver"
+        DESCRIPTION = "A driver represents an external or internal condition that motivates an organization to define its goals and implement the changes necessary to achieve them."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Motivation
 
@@ -465,6 +563,8 @@ module Archimate
       end
 
       class Goal < Element
+        NAME = "Goal"
+        DESCRIPTION = "A goal represents a high-level statement of intent, direction, or desired end state for an organization and its stakeholders."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Motivation
 
@@ -474,6 +574,8 @@ module Archimate
       end
 
       class Meaning < Element
+        NAME = "Meaning"
+        DESCRIPTION = "Meaning represents the knowledge or expertise present in, or the interpretation given to, a core element in a particular context."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Motivation
 
@@ -483,6 +585,8 @@ module Archimate
       end
 
       class Outcome < Element
+        NAME = "Outcome"
+        DESCRIPTION = "An outcome represents an end result that has been achieved."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Motivation
 
@@ -492,6 +596,8 @@ module Archimate
       end
 
       class Principle < Element
+        NAME = "Principle"
+        DESCRIPTION = "A principle represents a qualitative statement of intent that should be met by the architecture."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Motivation
 
@@ -501,6 +607,8 @@ module Archimate
       end
 
       class Requirement < Element
+        NAME = "Requirement"
+        DESCRIPTION = "A requirement represents a statement of need that must be met by the architecture."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Motivation
 
@@ -510,6 +618,8 @@ module Archimate
       end
 
       class Stakeholder < Element
+        NAME = "Stakeholder"
+        DESCRIPTION = "A stakeholder is the role of an individual, team, or organization (or classes thereof) that represents their interests in the outcome of the architecture."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Motivation
 
@@ -519,6 +629,8 @@ module Archimate
       end
 
       class Value < Element
+        NAME = "Value"
+        DESCRIPTION = "Value represents the relative worth, utility, or importance of a core element or an outcome."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Motivation
 
@@ -532,6 +644,8 @@ module Archimate
       #############################################################
 
       class Deliverable < Element
+        NAME = "Deliverable"
+        DESCRIPTION = "A deliverable represents a precisely-defined outcome of a work package."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Implementation_and_migration
 
@@ -541,6 +655,8 @@ module Archimate
       end
 
       class Gap < Element
+        NAME = "Gap"
+        DESCRIPTION = "A gap represents a statement of difference between two plateaus."
         CLASSIFICATION = :passive_structure
         LAYER = Layers::Implementation_and_migration
 
@@ -550,6 +666,8 @@ module Archimate
       end
 
       class ImplementationEvent < Element
+        NAME = "Implementation Event"
+        DESCRIPTION = "An implementation event is a behavior element that denotes a state change related to implementation or migration."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Implementation_and_migration
 
@@ -559,6 +677,8 @@ module Archimate
       end
 
       class Plateau < Element
+        NAME = "Plateau"
+        DESCRIPTION = "A plateau represents a relatively stable state of the architecture that exists during a limited period of time."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Implementation_and_migration
 
@@ -568,6 +688,8 @@ module Archimate
       end
 
       class WorkPackage < Element
+        NAME = "Work Package"
+        DESCRIPTION = "A work package represents a series of actions identified and designed to achieve specific results within specified time and resource constraints."
         CLASSIFICATION = :behavioral
         LAYER = Layers::Implementation_and_migration
 
@@ -581,6 +703,8 @@ module Archimate
       #############################################################
 
       class AndJunction < Element
+        NAME = "And Junction"
+        DESCRIPTION = "A junction is used to connect relationships of the same type."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Connectors
 
@@ -590,6 +714,8 @@ module Archimate
       end
 
       class Junction < Element
+        NAME = "Junction"
+        DESCRIPTION = "A junction is used to connect relationships of the same type."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Connectors
 
@@ -599,6 +725,8 @@ module Archimate
       end
 
       class OrJunction < Element
+        NAME = "Or Junction"
+        DESCRIPTION = "A junction is used to connect relationships of the same type."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Connectors
 
@@ -612,6 +740,8 @@ module Archimate
       #############################################################
 
       class Capability < Element
+        NAME = "Capability"
+        DESCRIPTION = "A capability represents an ability that an active structure element, such as an organization, person, or system, possesses."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Strategy
 
@@ -621,6 +751,8 @@ module Archimate
       end
 
       class CourseOfAction < Element
+        NAME = "Course Of Action"
+        DESCRIPTION = "A course of action is an approach or plan for configuring some capabilities and resources of the enterprise, undertaken to achieve a goal."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Strategy
 
@@ -630,6 +762,8 @@ module Archimate
       end
 
       class Resource < Element
+        NAME = "Resource"
+        DESCRIPTION = "A resource represents an asset owned or controlled by an individual or organization."
         CLASSIFICATION = :active_structure
         LAYER = Layers::Strategy
 
@@ -643,6 +777,8 @@ module Archimate
       #############################################################
 
       class Grouping < Element
+        NAME = "Grouping"
+        DESCRIPTION = "The grouping element aggregates or composes concepts that belong together based on some common characteristic."
         CLASSIFICATION = :other
         LAYER = Layers::Other
 

data/lib/archimate/data_model/model.rb

@@ -177,6 +177,10 @@ module Archimate
         end
       end
 
+      def find_by_class(klass)
+        @index_hash.values.select { |item| item.is_a?(klass) }
+      end
+
       private
 
       # Only used by [#find_default_organization]
@@ -239,10 +243,6 @@ module Archimate
         end
       end
 
-      def find_by_class(klass)
-        @index_hash.values.select { |item| item.is_a?(klass) }
-      end
-
       def find_default_organization(type, name)
         result = organizations.find { |f| f.type == type }
         return result unless result.nil?

data/lib/archimate/data_model/relationships.rb

@@ -21,6 +21,8 @@ module Archimate
     # relationship.
     module Relationships
       class Composition < Relationship
+        NAME = "Composition"
+        DESCRIPTION = "The composition relationship indicates that an element consists of one or more other concepts."
         WEIGHT = 10
         CLASSIFICATION = :structural
         VERB = "composes"
@@ -32,6 +34,8 @@ module Archimate
       end
 
       class Aggregation < Relationship
+        NAME = "Aggregation"
+        DESCRIPTION = "The aggregation relationship indicates that an element groups a number of other concepts. "
         WEIGHT = 9
         CLASSIFICATION = :structural
         VERB = "aggregates"
@@ -43,6 +47,8 @@ module Archimate
       end
 
       class Assignment < Relationship
+        NAME = "Assignment"
+        DESCRIPTION = "The assignment relationship expresses the allocation of responsibility, performance of behavior, or execution."
         WEIGHT = 8
         CLASSIFICATION = :structural
         VERB = "assigned to"
@@ -54,6 +60,8 @@ module Archimate
       end
 
       class Realization < Relationship
+        NAME = "Realization"
+        DESCRIPTION = "The realization relationship indicates that an entity plays a critical role in the creation, achievement, sustenance, or operation of a more abstract entity."
         WEIGHT = 7
         CLASSIFICATION = :structural
         VERB = "realizes"
@@ -65,6 +73,8 @@ module Archimate
       end
 
       class Serving < Relationship
+        NAME = "Serving"
+        DESCRIPTION = "The serving relationship models that an element provides its functionality to another element. I.e. the element pointed to calls the other element."
         WEIGHT = 6
         CLASSIFICATION = :dependency
         VERB = "serves"
@@ -76,6 +86,8 @@ module Archimate
       end
 
       class Access < Relationship
+        NAME = "Access"
+        DESCRIPTION = "The access relationship models the ability of behavior and active structure elements to observe or act upon passive structure elements."
         WEIGHT = 5
         CLASSIFICATION = :dependency
         VERB = "accesses"
@@ -87,6 +99,8 @@ module Archimate
       end
 
       class Influence < Relationship
+        NAME = "Influence"
+        DESCRIPTION = "The influence relationship models that an element affects the implementation or achievement of some motivation element."
         WEIGHT = 4
         CLASSIFICATION = :dependency
         VERB = "influences"
@@ -98,6 +112,8 @@ module Archimate
       end
 
       class Triggering < Relationship
+        NAME = "Triggering"
+        DESCRIPTION = "The triggering relationship describes a temporal or causal relationship between elements."
         WEIGHT = 3
         CLASSIFICATION = :dynamic
         VERB = "triggers"
@@ -109,6 +125,8 @@ module Archimate
       end
 
       class Flow < Relationship
+        NAME = "Flow"
+        DESCRIPTION = "The flow relationship represents transfer from one element to another."
         WEIGHT = 2
         CLASSIFICATION = :dynamic
         VERB = "flows to"
@@ -120,6 +138,8 @@ module Archimate
       end
 
       class Specialization < Relationship
+        NAME = "Specialization"
+        DESCRIPTION = "The specialization relationship indicates that an element is a particular kind of another element."
         WEIGHT = 1
         CLASSIFICATION = :other
         VERB = "specializes"
@@ -131,6 +151,8 @@ module Archimate
       end
 
       class Association < Relationship
+        NAME = "Association"
+        DESCRIPTION = "An association relationship models an unspecified relationship, or one that is not represented by another ArchiMate relationship."
         WEIGHT = 0
         CLASSIFICATION = :other
         VERB = "associated with"
@@ -144,6 +166,8 @@ module Archimate
       # Junction is a relationship connector
       # *  All relationships connected with relationship connectors must be of the same type
       class Junction < Relationship
+        NAME = "Junction"
+        DESCRIPTION = "A junction is used to connect relationships of the same type."
         WEIGHT = 0
         CLASSIFICATION = :other
         VERB = "junction to"
@@ -157,6 +181,8 @@ module Archimate
       # Junction is a relationship connector
       # *  All relationships connected with relationship connectors must be of the same type
       class AndJunction < Relationship
+        NAME = "AndJunction"
+        DESCRIPTION = "A junction is used to connect relationships of the same type."
         WEIGHT = 0
         CLASSIFICATION = :other
         VERB = "and junction to"
@@ -170,6 +196,8 @@ module Archimate
       # Junction is a relationship connector
       # *  All relationships connected with relationship connectors must be of the same type
       class OrJunction < Relationship
+        NAME = "OrJunction"
+        DESCRIPTION = "A junction is used to connect relationships of the same type."
         WEIGHT = 0
         CLASSIFICATION = :other
         VERB = "or junction to"

data/lib/archimate/export/n_quads.rb

@@ -46,7 +46,7 @@ module Archimate
   module Export
     Quad = Struct.new(:subject, :predicate, :object) do
       def fmt_obj
-        if object =~ /\s/
+        if /\s/ === object
           "\"#{object.gsub('"', '\\"').gsub(/[\n\r]/, '\\n')}\""
         else
           "<#{object}>"

data/lib/archimate/svg/archimate.css

@@ -29,6 +29,16 @@ path {
     z-index: 1000;
 }
 
+.archimate-legend-title {
+    font-weight: bold;
+}
+
+.archimate-legend {
+    fill: #eee;
+    stroke: #bbb;
+    stroke-width: 2px;
+}
+
 table.properties {
     background-color: whitesmoke;
     border: 2px solid gray;
@@ -138,6 +148,11 @@ table.properties>caption {
     stroke: #9cb29c;
 }
 
+.archimate-connectors-background, .archimate-other-background {
+    fill: #eee;
+    stroke: #bbb;
+}
+
 .archimate-note-background {
     fill: #fff;
     stroke: #b2b2b2;

data/lib/archimate/svg/diagram.rb

@@ -7,57 +7,95 @@ module Archimate
   module Svg
     class Diagram
       attr_reader :diagram
+      attr_reader :svg_doc
+      attr_reader :options
 
-      def initialize(diagram)
+      DEFAULT_SVG_OPTIONS = {
+        legend: false,
+        format_xml: true
+      }.freeze
+
+      def initialize(diagram, options = {})
         @diagram = diagram
+        @options = DEFAULT_SVG_OPTIONS.merge(options)
         @svg_template = Nokogiri::XML(SvgTemplate.new.to_s).freeze
       end
 
       def to_svg
-        svg_doc = @svg_template.clone
-        set_title(svg_doc)
-        top_group = svg_doc.at_css("#archimate-diagram")
+        @svg_doc = @svg_template.clone
+        set_title
         render_connections(
-          render_elements(top_group)
+          render_elements(archimate_diagram_group)
         )
-        update_viewbox(svg_doc.at_css("svg"))
-        format_node(top_group)
-        svg_doc.to_xml(encoding: 'UTF-8', indent: 2)
+        legend = Legend.new(self)
+        if include_legend?
+          legend.insert
+        else
+          legend.remove
+        end
+        update_viewbox
+        format_node(archimate_diagram_group) if format_xml?
+        format_node(legend_group) if include_legend? && format_xml?
+        svg_doc.to_xml(encoding: 'UTF-8', indent: indentation)
+      end
+
+      def svg_element
+        @svg_element ||= svg_doc.at_css("svg")
+      end
+
+      def archimate_diagram_group
+        @archimate_diagram_group ||= svg_doc.at_css("#archimate-diagram")
+      end
+
+      def legend_group
+        @legend_group ||= svg_doc.at_css("#archimate-legend")
       end
 
-      def set_title(svg)
-        svg.at_css("title").content = diagram.name || "untitled"
-        svg.at_css("desc").content = diagram.documentation.to_s || ""
+      def include_legend?
+        options[:legend]
+      end
+
+      def format_xml?
+        options[:format_xml]
+      end
+
+      def indentation
+        format_xml? ? 2 : 0
+      end
+
+      def set_title
+        svg_doc.at_css("title").content = diagram.name || "untitled"
+        svg_doc.at_css("desc").content = diagram.documentation.to_s || ""
       end
 
       # Scan the SVG and figure out min & max
-      def update_viewbox(svg)
-        extents = calculate_max_extents(svg).expand(10)
-        svg.set_attribute(:width, extents.width)
-        svg.set_attribute(:height, extents.height)
-        svg.set_attribute("viewBox", "#{extents.min_x} #{extents.min_y} #{extents.width} #{extents.height}")
-        svg
+      def update_viewbox
+        extents = calculate_max_extents.expand(10)
+        svg_element.set_attribute(:width, extents.width)
+        svg_element.set_attribute(:height, extents.height)
+        svg_element.set_attribute("viewBox", "#{extents.min_x} #{extents.min_y} #{extents.width} #{extents.height}")
+        svg_element
       end
 
       def format_node(node, depth = 4)
         node.children.each do |child|
-          child.add_previous_sibling("\n#{ ' ' * depth }")
+          child.add_previous_sibling("\n#{' ' * depth}")
           format_node(child, depth + 2)
-          child.add_next_sibling("\n#{ ' ' * (depth - 2) }") if node.children.last == child
+          child.add_next_sibling("\n#{' ' * (depth - 2)}") if node.children.last == child
         end
       end
 
-      def calculate_max_extents(doc)
+      def calculate_max_extents
         node_vals =
-          doc
+          svg_element
           .xpath("//*[@x or @y]")
           .map { |node| %w[x y width height].map { |attr| node.attr(attr).to_i } }
-        doc.css(".archimate-relationship")
-          .each { |path|
-            path.attr("d").split(" ").each_slice(3) do |point|
-              node_vals << [point[1].to_i, point[2].to_i, 0, 0]
-            end
-          }
+        svg_element.css(".archimate-relationship")
+                   .each do |path|
+          path.attr("d").split(" ").each_slice(3) do |point|
+            node_vals << [point[1].to_i, point[2].to_i, 0, 0]
+          end
+        end
         Extents.new(
           node_vals.map(&:first).min,
           node_vals.map { |v| v[0] + v[2] }.max,

data/lib/archimate/svg/legend.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module Archimate
+  module Svg
+    class Legend
+      attr_reader :svg_diagram
+      attr_reader :legend_group
+      attr_reader :columns
+      attr_reader :element_width
+      attr_reader :element_height
+      attr_reader :line_height
+      attr_reader :text_indent
+      attr_reader :description_width
+      attr_reader :col_width
+      attr_reader :row_height
+      attr_reader :top_margin
+      attr_reader :section_width
+      attr_reader :legend_width
+      attr_reader :layers
+      attr_reader :element_classes
+      attr_reader :relationship_classes
+
+      def initialize(svg_diagram)
+        @svg_diagram = svg_diagram
+        @legend_group = svg_diagram.legend_group
+        @top_margin = 25
+        @columns = 2
+        @element_width = 110
+        @element_height = 50
+        @line_height = 15
+        @text_indent = 10
+        @description_width = 500
+        @col_width = element_width + text_indent + description_width + text_indent
+        @row_height = element_height + text_indent
+        @section_width = columns * col_width
+        @legend_width = text_indent * 2 + columns * col_width
+        diagram = svg_diagram.diagram
+        @element_classes = diagram.elements.map(&:class).uniq
+        @layers = diagram.elements.map(&:layer).uniq.sort
+        @relationship_classes = diagram.relationships.map(&:class).uniq
+      end
+
+      def remove
+        legend_group.remove
+      end
+
+      def insert
+        Nokogiri::XML::Builder.with(legend_group) do |xml|
+          legend_for_relationship_classes(xml,
+                                          legend_for_element_types_by_layer(xml,
+                                                                            top_level_legend(xml)))
+        end
+      end
+
+      def top_level_legend(xml)
+        text(legend_left, legend_top, legend_width, legend_height, "Legend", "archimate-legend", xml) + line_height
+      end
+
+      def legend_for_element_types_by_layer(xml, top)
+        layers.inject(top) do |section_top, layer|
+          section_legend(section_top, layer.name, layer.background_class, layer_elements(layer), xml)
+        end
+      end
+
+      def legend_for_relationship_classes(xml, top)
+        return top if relationship_classes.empty?
+
+        section_legend(top, "Relationships", "archimate-other-background", relationship_classes, xml)
+      end
+
+      def section_legend(top, heading, css_class, items, xml)
+        sec_height = section_height(items)
+        top = text(legend_left + text_indent, top, section_width, sec_height, heading, css_class, xml)
+        items.each_with_index do |item, idx|
+          item_example(item_x(idx), item_y(top, idx), item, xml)
+        end
+        top + sec_height
+      end
+
+      # Legend entry for a particular element type
+      def item_example(x, y, klass, xml)
+        klass_name = klass.name.split("::").last
+        if klass.superclass == DataModel::Element
+          element_example(x, y, klass, klass_name, xml)
+        elsif klass.superclass == DataModel::Relationship
+          relationship_example(x, y, klass_name, xml)
+        end
+        element_type_description(klass::DESCRIPTION, text_bounds(x, y), xml)
+      end
+
+      def element_example(x, y, klass, klass_name, xml)
+        case klass_name
+        when "Junction"
+          r = (element_height - 10) / 4
+
+          xml.circle(cx: x + r, cy: y + r, r: r, style: "fill:#000;stroke:#000")
+          xml.text_(x: x + r * 2 + text_indent, y: y + r + line_height / 2, class: "archimate-legend-title") do
+            xml.text("And Junction")
+          end
+          xml.circle(cx: x + r, cy: y + row_height / 2 + r, r: r, style: "fill:#fff;stroke:#000")
+          xml.text_(x: x + r * 2 + text_indent, y: y + row_height / 2 + r + line_height / 2, class: "archimate-legend-title") do
+            xml.text("Or Junction")
+          end
+        else
+          element = DataModel::Elements.const_get(klass_name).new(id: "legend-element-#{klass_name}", name: klass::NAME)
+          view_node = DataModel::ViewNode.new(
+            id: "legend-element-type-#{klass_name}",
+            name: klass::NAME,
+            type: klass_name,
+            element: element,
+            diagram: svg_diagram.diagram,
+            bounds: DataModel::Bounds.new(x: x, y: y, width: element_width, height: element_height)
+          )
+          EntityFactory.make_entity(view_node, nil).to_svg(xml)
+        end
+      end
+
+      def relationship_example(x, y, klass_name, xml)
+        css_class = "archimate-#{klass_name.downcase} archimate-relationship"
+        xml.path(d: "M#{x} #{y + row_height / 2} h #{element_width}", class: css_class)
+      end
+
+      # Paragraph that describes a element or relationship
+      def element_type_description(text, text_bounds, xml)
+        css_style = "height:#{text_bounds.height}px;width:#{text_bounds.width}px;"
+        xml.foreignObject(text_bounds.to_h) do
+          xml.table(xmlns: "http://www.w3.org/1999/xhtml", style: css_style) do
+            xml.tr(style: "height:#{text_bounds.height}px;") do
+              xml.td(class: "entity-description") do
+                xml.p(class: "entity-description") do
+                  text.tr("\r\n", "\n").split(/[\r\n]/).each do |line|
+                    xml.text(line)
+                    xml.br
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def text(x, y, width, height, str, css_class, xml)
+        css_style = "fill-opacity: 0.4"
+        xml.rect(x: x, y: y - line_height, width: width, height: height,
+                 rx: 5, ry: 5, class: css_class, style: css_style)
+        xml.text_(x: x + text_indent, y: y, class: "archimate-legend-title") do
+          xml.text(str)
+        end
+        y + line_height
+      end
+
+      def extents
+        @extents ||= svg_diagram.calculate_max_extents
+      end
+
+      def diagram_width
+        @diagram_width ||= extents.width
+      end
+
+      def legend_top
+        extents.max_y + top_margin
+      end
+
+      def legend_left
+        extents.min_x
+      end
+
+      def layer_elements(layer)
+        element_classes.select { |k| k::LAYER == layer }
+      end
+
+      def legend_height
+        height = layers.inject(line_height) do |h, layer|
+          h + rows(layer_elements(layer)) * row_height + line_height * 3
+        end + line_height
+        height += rows(relationship_classes) * row_height + line_height * 3 unless relationship_classes.empty?
+        height
+      end
+
+      def rows(items)
+        (items.size / columns.to_f).round
+      end
+
+      def section_height(items)
+        rows(items) * row_height + line_height * 2
+      end
+
+      def item_x(idx)
+        legend_left + (text_indent * 2) + (col_width * (idx % columns))
+      end
+
+      def item_y(top, idx)
+        top + (row_height * (idx / columns))
+      end
+
+      def text_bounds(x, y)
+        DataModel::Bounds.new(
+          x: x + element_width + text_indent,
+          y: y,
+          width: description_width,
+          height: element_height
+        )
+      end
+    end
+  end
+end

data/lib/archimate/svg/svg_template.svg.erb

@@ -174,4 +174,5 @@
     </marker>
   </defs>
   <g id="archimate-diagram"></g>
+  <g id="archimate-legend"></g>
 </svg>

data/lib/archimate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Archimate
-  VERSION = "2.0.3"
+  VERSION = "2.1.0"
 end

data/lib/archimate.rb

@@ -56,6 +56,7 @@ module Archimate
     autoload :Entity, 'archimate/svg/entity'
     autoload :EntityFactory, 'archimate/svg/entity_factory'
     autoload :Extents, 'archimate/svg/extents'
+    autoload :Legend, 'archimate/svg/legend'
     autoload :Path, 'archimate/svg/path'
     autoload :Point, 'archimate/svg/point'
     autoload :Segment, 'archimate/svg/segment'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: archimate
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Mark Morga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -655,6 +655,7 @@ files:
 - lib/archimate/svg/entity/work_package.rb
 - lib/archimate/svg/entity_factory.rb
 - lib/archimate/svg/extents.rb
+- lib/archimate/svg/legend.rb
 - lib/archimate/svg/path.rb
 - lib/archimate/svg/point.rb
 - lib/archimate/svg/segment.rb
@@ -681,8 +682,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Archi Tools