jekyll-archimate 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cca198efae7d2a8b22e7df60440fcd68c8617e9
-  data.tar.gz: 45684df63ae3ce763c510dc98cdf9a15b7419e93
+  metadata.gz: 1390d11ccf52bae0ba50f6f22bd1dec103f2465e
+  data.tar.gz: 792d680dea4b6dbb6a95f91276d14d7df09ee373
 SHA512:
-  metadata.gz: 651b1932c684728d99b26bdf178fea1ea3e8931e8701679e60b014569618e92875a6b406fa243b97af16177ec7d390c79b643a59b7dbecf1959bc688eb0173fe
-  data.tar.gz: d4e1d9e6d95e6c6e34182fb928634cb0decac62abe96eaf577fbf235dcdc0fe1f53aee100479401af644b0ae91ed74ceb5c88584440c6834bf26b39fe5c0b2d9
+  metadata.gz: aa6f9b4030f007efb4ca456029abb00721af40180c67ea6ca96ebc81814ec10115c7c8261e8cd4cef66601ae2ae509d9aa46f608c175ed34f2f5378774171df4
+  data.tar.gz: 0730d88c6bd3b3067b1d797cb913a19dc8cecab7307ba9695a06b79ed66b02ad05f76ef423084e314a1826c7822fa3f62cf6f7f11d14867651dca99ecf453960

data/lib/jekyll-archimate.rb

@@ -3,5 +3,6 @@ require "jekyll"
 require "jekyll/archimate/version"
 require "jekyll/archimate/archimate_cache"
 require "jekyll/archimate/archimate_diagram_tag"
-require "jekyll/archimate/element_catalog_tag"
+require "jekyll/archimate/catalog_tag"
+require "jekyll/archimate/matrix_tag"
 require "jekyll/archimate/archimate_hook"

data/lib/jekyll/archimate/archimate_hook.rb

@@ -6,15 +6,17 @@ module Jekyll
   module Archimate
     # Removes all keys that have null or empty values
     def self.hash_purge(hash)
-      hash.delete_if { |_, value| !value || value.empty? }
+      hash.delete_if { |_, value| !value || (value.is_a?(String) && value.empty?) }
     end
 
     # Base class for ArchiMate Entities: Model, Diagram, Element, Relationship
     class EntityBase
       attr_reader :entity
+      attr_reader :model
 
-      def initialize(entity)
+      def initialize(entity, model: nil)
         @entity = entity
+        @model = model
       end
 
       def to_h
@@ -25,7 +27,7 @@ module Jekyll
         {
           id: entity.id,
           name: entity.name,
-          documentation: entity.documentation.map(&:to_h),
+          documentation: entity.documentation&.to_h,
           properties: entity.properties.map(&:to_h)
         }
       end
@@ -46,8 +48,8 @@ module Jekyll
         super.merge(
           type: "Element",
           element_type: entity.type,
-          relationships: entity.relationships.map(&:id),
-          views: entity.diagrams.map(&:id)
+          relationships: model.relationships.select { |rel| rel.source&.id == entity.id || rel.target&.id == entity.id }.map(&:id),
+          views: model.diagrams.select { |dia| dia.element_ids.include?(entity.id) }.map(&:id)
         )
       end
     end
@@ -58,9 +60,9 @@ module Jekyll
         super.merge(
           type: "Relationship",
           relationship_type: entity.type,
-          source: entity.source,
-          target: entity.target,
-          views: entity.diagrams.map(&:id)
+          source: entity.source&.id,
+          target: entity.target&.id,
+          views: model.diagrams.select { |dia| dia.relationship_ids.include?(entity.id) }.map(&:id)
         )
       end
     end
@@ -96,7 +98,7 @@ module Jekyll
       def to_h
         Archimate.hash_purge(
           id: folder.id,
-          name: folder.name,
+          name: folder.name.to_s,
           folders: folder.organizations.map { |child| Folder.new(child).to_h },
           diagrams: items
         )
@@ -119,11 +121,11 @@ module Jekyll
       end
 
       def elements
-        model.elements.map { |element| ElementEntity.new(element).to_h }
+        model.elements.map { |element| ElementEntity.new(element, model: model).to_h }
       end
 
       def relationships
-        model.relationships.map { |relationship| RelationshipEntity.new(relationship).to_h }
+        model.relationships.map { |relationship| RelationshipEntity.new(relationship, model: model).to_h }
       end
 
       def diagrams
@@ -182,6 +184,7 @@ module Jekyll
         @archimate_file = archimate_file
         @clean_generated_dirs = @site.config.fetch('clean', false)
         @model = ArchimateCache.load_model(archimate_file.sub(site.source, ""))
+        @site.data["archimate_model"] = @model
       end
 
       def generate
@@ -240,7 +243,7 @@ module Jekyll
         {
           "id" => el.id,
           "name" => el.name.to_s,
-          "documentation" => el.documentation.first.to_s,
+          "documentation" => el.documentation&.to_s,
           "type" => el.type,
           "properties" => el.properties.each_with_object({}) do |property, hash|
             hash[property.key.to_s] = property.value.to_s
@@ -251,7 +254,7 @@ module Jekyll
   end
 end
 
-Jekyll::Hooks.register :site, :after_init do |site|
+Jekyll::Hooks.register :site, :pre_render do |site|
   Jekyll.logger.info "ArchiMate Generator..."
   Dir.glob("#{site.source}/**/*.archimate").each do |archimate_file|
     unless archimate_file.start_with?(site.dest) || archimate_file.sub(site.source, "").start_with?("/_")

data/lib/jekyll/archimate/{element_catalog_tag.rb → catalog_tag.rb}

@@ -4,7 +4,7 @@ module Jekyll
     #
     #   {% element_catalog type:"Principle" | caption:"Principles Catalog"  %}
     #
-    class ElementCatalogTag < Liquid::Tag
+    class CatalogTag < Liquid::Tag
       attr_reader :context
       attr_reader :caption
       attr_reader :element_types
@@ -95,5 +95,5 @@ module Jekyll
   end
 end
 
-Liquid::Template.register_tag("element_catalog", Jekyll::Archimate::ElementCatalogTag)
+Liquid::Template.register_tag("catalog", Jekyll::Archimate::CatalogTag)
 

data/lib/jekyll/archimate/matrix_tag.rb

@@ -0,0 +1,148 @@
+module Jekyll
+  module Archimate
+    # Insert a diagram from the ArchiMate model.
+    #
+    #   {% matrix type:"Principle" | caption:"Principles Catalog"  %}
+    #   {% matrix source:"ApplicationComponent" | target:"ApplicationComponent" | }
+    #
+    class MatrixTag < Liquid::Tag
+      attr_reader :context
+      attr_reader :caption
+      attr_reader :element_types
+      attr_reader :markup
+
+
+      def initialize(tag_name, markup, tokens)
+        @markup = markup
+        @context = nil
+        @caption = nil
+        @element_types = []
+        super
+      end
+
+      def render(context)
+        @context = context
+        scan_attributes(context)
+        application_interaction
+        render_table
+      end
+
+      # Here I want all of the Serving relationships between 2 app components
+      # included or derived.
+      #
+      # attrs:
+      # source_selector: Element selector for source elements
+      # target_selector: Element selector for target elements
+      # relationship_selector
+      def application_interaction
+        model = site.data["archimate_model"]
+        derived_relations_engine = ::Archimate::DerivedRelations.new(model)
+
+        concrete_rels = model.relationships.select { |rel|
+          rel.type == "ServingRelationship" &&
+            rel.source.type == "ApplicationComponent" &&
+            rel.target.type == "ApplicationComponent"
+        }
+
+        derived_rels = derived_relations_engine.derived_relations(
+          model.elements.select { |el| el.type == "ApplicationComponent" },
+          lambda { |rel| rel.weight >= ::Archimate::DataModel::Serving::WEIGHT },
+          lambda { |el| el.type == "ApplicationComponent" },
+          lambda { |el| el.type == "ApplicationComponent" }
+        )
+
+        @all_rels = [concrete_rels, derived_rels].flatten
+
+        @callers = @all_rels.map(&:source).uniq.sort { |a, b| a.name.to_s <=> b.name.to_s }
+        @callees = @all_rels.map(&:target).uniq.sort { |a, b| a.name.to_s <=> b.name.to_s }
+      end
+
+      def matrix_data
+        model = site.data["archimate_model"]
+        derived_relations_engine = ::Archimate::DerivedRelations.new(model)
+
+      end
+
+      def render_table
+        <<~END
+        <table class="table table-condensed table-hover table-striped">
+        <caption>#{caption}</caption>
+        <thead>
+        <tr>
+        <th>&nbsp;</th>
+        <th class="success" scope="col" colspan="#{@callers.size}">Callers</th>
+        </tr>
+        <tr>
+        <th class="info" scope="col">Callees</th>
+        #{@callers.map { |ac| "<th class=\"success\" scope=\"col\" style=\"text-transform: capitalize\">#{ac.name}</th>" }.join("\n")}
+        </tr>
+        </thead>
+        <tbody>
+        #{render_rows.strip}
+        </tbody>
+        </table>
+        END
+      end
+
+      def render_rows
+        return "<tr><td>No Items</td></tr>" if @callees.empty?
+        @callees.map do |callee|
+          <<~END
+          <tr>
+          <th class="info" scope="row">#{callee.name}</th>
+          #{@callers.map { |caller| cell_content(caller, callee) }.join("")}
+          </tr>
+          END
+        end.join("")
+      end
+
+      def cell_content(caller, callee)
+        rels = @all_rels.select { |rel| rel.source == caller && rel.target == callee }
+        if rels.empty?
+          "<td></td>"
+        else
+          derived = rels.all? { |rel| rel.derived }
+          span_class = derived ? "text-danger" : "text-primary"
+          tooltip = "#{caller.name} &rarr; #{}#{callee.name} #{"(derived)" if derived}"
+          cell = <<~END
+          <td>
+          <a href="#" data-toggle="tooltip" data-placement="top" title="#{tooltip}">
+          <span class="#{span_class}">&crarr; calls</span>
+          </a>
+          </td>
+          END
+        end
+      end
+
+      def scan_attributes(context)
+        @converter = converter(context)
+
+        # Render any liquid variables
+        markup = Liquid::Template.parse(@markup).render(context)
+
+        # Extract tag attributes
+        attributes = {}
+        markup.scan(Liquid::TagAttributes) do |key, value|
+          attributes[key] = value
+        end
+        @caption = attributes['caption']&.gsub!(/\A"|"\Z/, '')
+        element_type = attributes['type']
+        element_type = element_type.gsub!(/\A"|"\Z/, '') if element_type
+        @element_types = element_type.split(",").map(&:strip)
+      end
+
+      def converter(context)
+        # Gather settings
+        site = context.registers[:site]
+        site.find_converter_instance(::Jekyll::Converters::Markdown)
+      end
+
+      def site
+        @site ||= context.registers[:site]
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("matrix", Jekyll::Archimate::MatrixTag)
+

data/lib/jekyll/archimate/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Archimate
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-archimate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mark Morga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-19 00:00:00.000000000 Z
+date: 2017-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -101,7 +101,8 @@ files:
 - lib/jekyll/archimate/archimate_cache.rb
 - lib/jekyll/archimate/archimate_diagram_tag.rb
 - lib/jekyll/archimate/archimate_hook.rb
-- lib/jekyll/archimate/element_catalog_tag.rb
+- lib/jekyll/archimate/catalog_tag.rb
+- lib/jekyll/archimate/matrix_tag.rb
 - lib/jekyll/archimate/version.rb
 homepage: https://github.com/mmorga/jekyll-archimate
 licenses: []