jekyll-archimate 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28f21df623d8b7517b7cb96f6afa8d2447a70d20
-  data.tar.gz: 723393f13b2337fbc0ff24e4e743fd132735c7b3
+  metadata.gz: 450c76bef35c5a96c2dd7b52a7e8598ef0b3910a
+  data.tar.gz: 9506cf3a7a0a23f70ac2f4083be19f9ae25023b2
 SHA512:
-  metadata.gz: 3d4dfa4d1e4ab5ac8dad5bb6290369053af032950183cf53cbf5a1727180ebe413b1572777da64ac65b21f7d87afa8edaf9c09016ee9e0e36e1efc4f17f8d088
-  data.tar.gz: 256ae8198b5cd36510c13351f3fb30be571f0cd06be3513e24f59f784dc388e5b809ca71ba382f5d0de11bab22c5ff2f2064d17bf7b4dd3276976a1a2cbc4639
+  metadata.gz: ad3da00341c4db0c5329e8e23a50cdf1eac79c9f0fcbf36db9f85a6cfd8acc4171716a98539c77f69183cc27053f2d28b2965a0ab3c43c0cd4674dc8bdc2bd21
+  data.tar.gz: 79ac5eae532d4709e7fe08de80acea38649c8f3c95ae8d5029a565648ef1b5a442681b888c91ae00069e15bed420d7258e0a29c5ded297e54b82a9730b691bc5

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 *.sublime*
+docs/

data/lib/jekyll-archimate.rb

@@ -1,8 +1,30 @@
+# frozen_string_literal: true
+
 require "jekyll"
+require "archimate"
+
+module Jekyll
+  module Archimate
+    # Removes all keys that have null or empty values
+    def self.hash_purge(hash)
+      hash.delete_if { |_, value| !value || (value.is_a?(String) && value.empty?) }
+    end
+  end
+end
 
 require "jekyll/archimate/version"
 require "jekyll/archimate/archimate_cache"
 require "jekyll/archimate/archimate_diagram_tag"
 require "jekyll/archimate/catalog_tag"
 require "jekyll/archimate/application_interaction_matrix_tag"
-require "jekyll/archimate/archimate_hook"
+require "jekyll/archimate/conditional_file"
+require "jekyll/archimate/archimate_index_generator"
+require "jekyll/archimate/archimate_svg_generator"
+require "jekyll/archimate/entity_base"
+require "jekyll/archimate/model_entity"
+require "jekyll/archimate/element_entity"
+require "jekyll/archimate/relationship_entity"
+require "jekyll/archimate/diagram_entity"
+require "jekyll/archimate/folder"
+require "jekyll/archimate/unified_model"
+require "jekyll/archimate/archimate_generator"

data/lib/jekyll/archimate/application_interaction_matrix_tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Archimate
     # Insert a diagram from the ArchiMate model.
@@ -5,12 +7,13 @@ module Jekyll
     #   {% application_interaction_matrix plateau:"Today" | caption: "Today's Application Interaction" }
     #
     class ApplicationInteractionMatrixTag < Liquid::Tag
+      EMPTY_CELL = "<td></td>"
+
       attr_reader :context
       attr_reader :markup
       attr_reader :caption
       attr_reader :plateau
 
-
       def initialize(tag_name, markup, tokens)
         @markup = markup
         @context = nil
@@ -34,27 +37,26 @@ module Jekyll
       # target_selector: Element selector for target elements
       # relationship_selector
       def application_interaction
-        model = site.data["archimate_model"]
+        model = ArchimateCache.instance.model
         dr_engine = ::Archimate::DerivedRelations.new(model)
 
-        relationship_filter = lambda { |rel| rel.weight >= ::Archimate::DataModel::Serving::WEIGHT }
+        relationship_filter = ->(rel) { rel.weight >= ::Archimate::DataModel::Serving::WEIGHT }
 
         plateau_today = dr_engine.element_by_name(plateau)
         today_rels = model.relationships.select do |rel|
           rel.source.id == plateau_today.id &&
-            %w{CompositionRelationship AggregationRelationship}.include?(rel.type) &&
+            %w[CompositionRelationship AggregationRelationship].include?(rel.type) &&
             rel.target.type == "ApplicationComponent"
         end
-        today_apps = today_rels.map { |rel| rel.target }
-        source_filter = lambda { |el|  }
-        target_filter = lambda { |el| today_apps.map(&:id).include?(el.id) }
-        stop_filter = lambda { |el| el.type == "ApplicationComponent" }
+        today_apps = today_rels.map(&:target)
+        target_filter = ->(el) { today_apps.map(&:id).include?(el.id) }
+        stop_filter = ->(el) { el.type == "ApplicationComponent" }
 
-        concrete_rels = model.relationships.select { |rel|
+        concrete_rels = model.relationships.select do |rel|
           rel.type == "ServingRelationship" &&
             today_apps.include?(rel.source.id) &&
             today_apps.include?(rel.target.id)
-        }
+        end
 
         derived_rels = dr_engine.derived_relations(
           today_apps,
@@ -69,61 +71,52 @@ module Jekyll
         @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"]
-        dr_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
+        <<~TABLE
+          <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>
+        TABLE
       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
+          <<~TABLE_ROW
+            <tr>
+            <th class="info" scope="row">#{callee.name}</th>
+            #{@callers.map { |caller| cell_content(caller, callee) }.join('')}
+            </tr>
+          TABLE_ROW
         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
+        return EMPTY_CELL if rels.empty?
+        derived = rels.all?(&:derived)
+        span_class = derived ? "text-danger" : "text-primary"
+        tooltip = "#{caller.name} &rarr; #{callee.name} #{'(derived)' if derived}"
+        <<~TABLE_CELL
           <td>
           <a href="#" data-toggle="tooltip" data-placement="top" title="#{tooltip}">
           <span class="#{span_class}">&crarr; calls</span>
           </a>
           </td>
-          END
-        end
+        TABLE_CELL
       end
 
       def scan_attributes(context)
@@ -147,4 +140,3 @@ module Jekyll
 end
 
 Liquid::Template.register_tag("application_interaction_matrix", Jekyll::Archimate::ApplicationInteractionMatrixTag)
-

data/lib/jekyll/archimate/archimate_cache.rb

@@ -1,75 +1,52 @@
 # frozen_string_literal: true
 
-require "archimate"
-
 module Jekyll
   module Archimate
-    module ArchimateCache
-      # load an archimate model from either...
-      # 1. Memory
-      # 2. Cached & Marshaled File
-      # 3. Archimate File
-      # Defaulting to the Archimate file if it is newer than either cached version
-      def load_model(file_path)
-        @@cache ||= {}
-        file_path.sub!(%r{^/}, "")
-        mod_time = File.mtime(file_path)
-
-        if @@cache.key?(file_path)
-          model_info = @@cache[file_path]
-          return model_info[:model] if model_info[:cache_time] >= mod_time
-        end
+    ArchimateFileCacheInfo = Struct.new(:archimate_file, :model)
 
-        cache_file = marshal_cache_file(file_path)
-        if File.exist?(cache_file) && File.mtime(cache_file) >= mod_time
-          begin
-            @@cache[file_path] = {
-              cache_time: File.mtime(cache_file),
-              model: File.open(cache_file, "rb") { |f| Marshal.load(f) }
-            }
-            return @@cache[file_path][:model]
-        rescue ArgumentError
-          puts "Cache file is invalid - removing cache #{cache_file} and loading #{file_path}"
-          FileUtils.rm cache_file
-        end
-        end
+    class ArchimateCache
+      include Singleton
 
-        model = ::Archimate.read(file_path)
-        File.open(cache_file, "wb") { |f| Marshal.dump(model, f) }
-        @@cache[file_path] = {
-          cache_time: File.mtime(cache_file),
-          model: model
-        }
-
-        model
+      def initialize
+        @cache = {}
+        @default_archimate_file = nil
       end
-      module_function :load_model
 
-      def rel_path(file_path)
-        file_path.sub!(%r{^/}, "")
+      def cache_valid?(archimate_file)
+        path = archimate_file.path
+        @cache.key?(path) &&
+          @cache[path].archimate_file.modified_time.to_i == archimate_file.modified_time.to_i
       end
 
-      module_function :rel_path
+      def model(archimate_file = nil)
+        archimate_file ||= default_archimate_file
+        raise "No ArchiMate file has been detected." unless archimate_file
+        update_cache(archimate_file) unless cache_valid?(archimate_file)
+        @cache[archimate_file.path].model
+      end
 
-      def cache_stale?(file_path)
-        @@cache ||= {}
-        rel = rel_path(file_path)
-        mod_time = File.mtime(rel)
-        !@@cache.key?(rel) ||
-          @@cache[rel][:cache_time] < mod_time
+      def default_archimate_file
+        @default_archimate_file || @cache.keys.first
       end
-      module_function :cache_stale?
 
-      def marshal_cache_file(path)
-        file_path, file_name = File.split(path)
-        cache_path = File.join("_cache", file_path).split("/").inject("") do |cpath, rel_dir|
-          npath = cpath.empty? ? rel_dir : File.join(cpath, rel_dir)
-          Dir.mkdir(File.absolute_path(npath)) unless Dir.exist?(File.absolute_path(npath))
-          npath
+      def default_archimate_file=(archimate_file)
+        unless @cache.key?(archimate_file.path)
+          raise(
+            "Default ArchiMate file does not exist in cache: #{archimate_file.relative_path}"
+          )
         end
-        File.join(cache_path, File.basename(file_name, ".archimate" + ".marshal"))
+        @default_archimate_file = archimate_file
+      end
+
+      def update_cache(archimate_file)
+        # update the cache
+        Jekyll.logger.info "  loading ArchiMate #{archimate_file.relative_path}"
+        load_start_time = Time.new
+        model = ::Archimate.read(archimate_file.path)
+        load_finish_time = Time.new
+        Jekyll.logger.info format("       %.1f seconds", (load_finish_time - load_start_time))
+        @cache[archimate_file.path] = ArchimateFileCacheInfo.new(archimate_file, model)
       end
-      module_function :marshal_cache_file
     end
   end
 end

data/lib/jekyll/archimate/archimate_diagram_tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Archimate
     # Insert a diagram from the ArchiMate model.
@@ -21,12 +23,12 @@ module Jekyll
         # TODO: make the archimate_dir configurable in _config.yml and as an
         #       optional argument in the tag.
         archimate_dir = [baseurl, "archimate", "svg"].join("/")
-        <<~END
+        <<~FIGURE
           <figure id="#{@diagram_id}">
-          <a href="#{baseurl}/archimate/svg/#{@diagram_id}.svg" alt="View Full Screen">
+          <a href="#{archimate_dir}/#{@diagram_id}.svg" alt="View Full Screen">
           <span class="glyphicon glyphicon-fullscreen" style="float:right"></span>
           </a>
-          <img src="#{baseurl}/archimate/svg/#{@diagram_id}.svg" class="img-responsive" alt="#{@caption}">
+          <img src="#{archimate_dir}/#{@diagram_id}.svg" class="img-responsive" alt="#{@caption}">
           <figcaption>
           #{@caption}
           <br/>
@@ -35,7 +37,7 @@ module Jekyll
           </a>
           </figcaption>
           </figure>
-        END
+        FIGURE
       end
     end
   end

data/lib/jekyll/archimate/archimate_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Archimate
+    class ArchimateGenerator < Jekyll::Generator
+      def generate(site)
+        Jekyll.logger.info "ArchimateGenerator.generate"
+        archimate_files = site.static_files.select { |static_file| static_file.extname =~ /\.(archimate|xml)$/ }
+        archimate_file = preload_cache(archimate_files)
+        return unless needs_generation?
+        ArchimateSvgGenerator.new(site, archimate_file).generate
+        ArchimateIndexGenerator.new(site, archimate_file).generate
+      end
+
+      private
+
+      def needs_generation?
+        cache.cache_valid?(cache.default_archimate_file)
+      end
+
+      def preload_cache(archimate_files)
+        archimate_files.each { |file| cache.model(file) }
+        cache.default_archimate_file = archimate_files.first # TODO: select file in the `archimate` directory
+      end
+
+      def cache
+        @cache ||= ArchimateCache.instance
+      end
+    end
+  end
+end

data/lib/jekyll/archimate/archimate_index_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Archimate
+    class ArchimateIndexGenerator
+      attr_reader :site
+      attr_reader :archimate_file
+
+      def initialize(site, archimate_file)
+        @site = site
+        @archimate_file = archimate_file
+        @name = "index.json"
+      end
+
+      def generate
+        ConditionalFile.new(
+          site,
+          File.dirname(archimate_file.relative_path),
+          @name,
+          archimate_file
+        ).write(JSON.generate(UnifiedModel.new(model).to_h))
+      end
+
+      def model
+        @model ||= ArchimateCache.instance.model(archimate_file)
+      end
+    end
+  end
+end

data/lib/jekyll/archimate/archimate_svg_generator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Archimate
+    class ArchimateSvgGenerator
+      attr_reader :site
+      attr_reader :archimate_file
+
+      def initialize(site, archimate_file)
+        @site = site
+        @archimate_file = archimate_file
+      end
+
+      def generate
+        create_svg_source_path_if_needed
+        model.diagrams.each do |diagram|
+          generate_diagram(diagram)
+        end
+      end
+
+      private
+
+      def model
+        @model ||= ArchimateCache.instance.model(archimate_file)
+      end
+
+      def svg_source_path
+        @svg_source_path ||= File.join(
+          site.source,
+          File.dirname(archimate_file.relative_path),
+          'svg'
+        )
+      end
+
+      def svg_relative_path
+        @svg_relative_path ||= File.join(File.dirname(archimate_file.relative_path), "svg")
+      end
+
+      def create_svg_source_path_if_needed
+        Dir.mkdir(svg_source_path) unless Dir.exist?(svg_source_path)
+      end
+
+      def generate_diagram(diagram)
+        ConditionalFile.new(
+          site,
+          svg_relative_path,
+          "#{diagram.id}.svg",
+          archimate_file
+        ).write(::Archimate::Svg::Diagram.new(diagram).to_svg)
+      end
+    end
+  end
+end