jekyll-archimate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7de1d6c85efc793fd744046d96c7e9e6a8177303
+  data.tar.gz: df8a2d1db4fa72b1c4527d59fd6182b31c3fea11
+SHA512:
+  metadata.gz: a553f35f25a97cf3e8c8b136da045a773a18286af7e50f2a5598a88c14fd1428988606febbd49c3721e40f592a639b7ee8eac2f210d48d7901bf6d1c8a01f51d
+  data.tar.gz: a4098311ecda926ac1f1badd5fd885bc8d52fd35b3b01ed72205ed79f76c3edc68718f356d60ad41fe510a0b00710cfb9dd5845a0ab37cff23951c4bf3942cb2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jekyll-archimate.gemspec
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# Jekyll::Archimate
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/archimate`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-archimate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-archimate
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-archimate.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/archimate"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-archimate.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll/archimate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-archimate"
+  spec.version       = Jekyll::Archimate::VERSION
+  spec.authors       = ["Mark Morga"]
+  spec.email         = ["markmorga@gmail.com"]
+
+  spec.summary       = %q{Jekyll plugins to support documenting ArchiMate models.}
+  spec.description   = %q{Produces SVG diagrams and a JSON index useful for
+                          search from an ArchiMate model file.}
+  spec.homepage      = "https://github.com/mmorga/jekyll-archimate"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "jekyll", "~> 3.0"
+  spec.add_runtime_dependency "archimate", ">= 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/jekyll/archimate.rb

@@ -0,0 +1,4 @@
+require "jekyll/archimate/version"
+require "jekyll/archimate/archimate_cache"
+require "jekyll/archimate/archimate_diagram_tag"
+require "jekyll/archimate/archimate_hook"

data/lib/jekyll/archimate/archimate_cache.rb

@@ -0,0 +1,70 @@
+# 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
+
+        cache_file = marshal_cache_file(file_path)
+        if File.exist?(cache_file) && File.mtime(cache_file) >= mod_time
+          @@cache[file_path] = {
+            cache_time: File.mtime(cache_file),
+            model: File.open(cache_file, "rb") { |f| Marshal.load(f) }
+          }
+          return @@cache[file_path][:model]
+        end
+
+        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
+      end
+      module_function :load_model
+
+      def rel_path(file_path)
+        file_path.sub!(%r{^/}, "")
+      end
+
+      module_function :rel_path
+
+      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
+      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
+        end
+        File.join(cache_path, File.basename(file_name, ".archimate" + ".marshal"))
+      end
+      module_function :marshal_cache_file
+    end
+  end
+end

data/lib/jekyll/archimate/archimate_diagram_tag.rb

@@ -0,0 +1,44 @@
+module Jekyll
+  module Archimate
+    # Insert a diagram from the ArchiMate model.
+    #
+    # @param id [String] id of the diagram in the ArchiMate model
+    # @param caption [String] caption for the diagram
+    #
+    #   {% archimate_diagram id-4623784 Gumball Manufacturing Business Process %}
+    #
+    class ArchimateDiagramTag < ::Liquid::Tag
+      def initialize(tag_name, args_text, tokens)
+        super
+
+        args = args_text.strip.split(" ")
+        @diagram_id = args.shift.strip
+        @caption = args.join(" ")
+      end
+
+      def render(context)
+        baseurl = context.registers[:site].baseurl
+        # 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 id="#{@diagram_id}">
+          <a href="#{baseurl}/archimate/svg/#{@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}">
+          <figcaption>
+          #{@caption}
+          <br/>
+          <a href="#{baseurl}/archimate/index.html##{@diagram_id}">
+          <small>View in ArchiMate Model Repository</small>
+          </a>
+          </figcaption>
+          </figure>
+        END
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("archimate_diagram", Jekyll::Archimate::ArchimateDiagramTag)

data/lib/jekyll/archimate/archimate_hook.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+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.empty? }
+    end
+
+    # Base class for ArchiMate Entities: Model, Diagram, Element, Relationship
+    class EntityBase
+      attr_reader :entity
+
+      def initialize(entity)
+        @entity = entity
+      end
+
+      def to_h
+        Archimate.hash_purge(attr_hash)
+      end
+
+      def attr_hash
+        {
+          id: entity.id,
+          name: entity.name,
+          documentation: entity.documentation.map(&:to_h),
+          properties: entity.properties.map(&:to_h)
+        }
+      end
+    end
+
+    # Represents the overall model
+    class ModelEntity < EntityBase
+      def attr_hash
+        super.merge(
+          type: "Model"
+        )
+      end
+    end
+
+    # Represents an ArchiMate Element
+    class ElementEntity < EntityBase
+      def attr_hash
+        super.merge(
+          type: "Element",
+          element_type: entity.type,
+          relationships: entity.relationships.map(&:id),
+          views: entity.diagrams.map(&:id)
+        )
+      end
+    end
+
+    # Represents an ArchiMate Relationship
+    class RelationshipEntity < EntityBase
+      def attr_hash
+        super.merge(
+          type: "Relationship",
+          relationship_type: entity.type,
+          source: entity.source,
+          target: entity.target,
+          views: entity.diagrams.map(&:id)
+        )
+      end
+    end
+
+    # Represents an ArchiMate Diagram
+    class DiagramEntity < EntityBase
+      def attr_hash
+        super.merge(
+          type: "Diagram",
+          path: "svg/#{entity.id}.svg",
+          viewpoint: entity.viewpoint,
+          elements: entity.elements.map(&:id),
+          relationships: entity.relationships.map(&:id),
+          views: []
+        )
+      end
+    end
+
+    # Represents an ArchiMate Organizing Folder
+    class Folder
+      attr_reader :folder
+
+      def initialize(folder)
+        @folder = folder
+      end
+
+      # This item check is necessary because some models seem to contain
+      # an item that is a string rather than an element of some sort.
+      def items
+        folder.items.map { |item| item.is_a?(String) ? item : item.id }
+      end
+
+      def to_h
+        Archimate.hash_purge(
+          id: folder.id,
+          name: folder.name,
+          folders: folder.organizations.map { |child| Folder.new(child).to_h },
+          diagrams: items
+        )
+      end
+    end
+
+    # This is the top level object used by the web Archimate Navigator
+    class UnifiedModel
+      attr_reader :model
+
+      def initialize(model)
+        @model = model
+      end
+
+      def to_h
+        {
+          entities: entities,
+          folders: folders
+        }
+      end
+
+      def elements
+        model.elements.map { |element| ElementEntity.new(element).to_h }
+      end
+
+      def relationships
+        model.relationships.map { |relationship| RelationshipEntity.new(relationship).to_h }
+      end
+
+      def diagrams
+        model.diagrams.map { |diagram| DiagramEntity.new(diagram).to_h }
+      end
+
+      def entities
+        [ModelEntity.new(model).to_h].concat(
+          elements).concat(
+            relationships).concat(
+              diagrams)
+      end
+
+      def folders
+        [Folder.new(model.organizations.last).to_h]
+      end
+    end
+
+    # Writes any object that can be hashified (with to_h) to a JSON file
+    class JsonFile
+      def initialize(filename)
+        @filename = filename
+      end
+
+      def write(obj)
+        File.open(@filename, "wb") do |file|
+          file.write(JSON.generate(obj.to_h))
+        end
+      end
+    end
+
+    # Persists an ArchiMate diagram to a file
+    class SvgFile
+      def initialize(filename)
+        @filename = filename
+      end
+
+      def write(diagram)
+        File.open(@filename, "wb") do |svg_file|
+          svg_file.write(Archimate::Svg::Diagram.new(diagram).to_svg)
+        end
+      end
+    end
+
+    # Configuration variables:
+    # clean: clean destination directories before rendering
+    # layout: layout to use for the archimate navigator
+    class ArchimateHook
+      attr_reader :clean_generated_dirs
+      attr_reader :site
+      attr_reader :model
+      attr_reader :archimate_file
+
+      def initialize(site, archimate_file)
+        @site = site
+        @archimate_file = archimate_file
+        @clean_generated_dirs = @site.config.fetch('clean', false)
+        @model = ArchimateCache.load_model(archimate_file.sub(site.source, ""))
+      end
+
+      def generate
+        export_svgs
+        export_unified_json
+      end
+
+      def export_unified_json
+        dest_file = File.join(File.dirname(archimate_file), 'index.json')
+        dest_mtime = File.exist?(dest_file) && File.mtime(dest_file)
+        return unless !dest_mtime || File.mtime(archimate_file) > dest_mtime
+        JsonFile.new(dest_file).write(UnifiedModel.new(model))
+      end
+
+      def svg_dest_dir
+        @svg_dest_dir ||= File.join(File.dirname(archimate_file), 'svg')
+      end
+
+      def svgs_need_export?
+        Dir.mkdir(svg_dest_dir) unless Dir.exist?(svg_dest_dir)
+        last_svg_mtime = Dir.glob(File.join(svg_dest_dir, "*.svg")).map { |svg_file| File.mtime(svg_file) }.max
+        !last_svg_mtime || File.mtime(archimate_file) > last_svg_mtime
+      end
+
+      def export_svgs
+        return unless svgs_need_export?
+        model.diagrams.each do |diagram|
+          SvgFile.new(File.join(svg_dest_dir, "#{diagram.id}.svg")).write(diagram)
+        end
+      end
+    end
+  end
+end
+
+Jekyll::Hooks.register :site, :after_init 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?("/_")
+      Jekyll.logger.info "  processing: #{archimate_file}"
+      Jekyll::Archimate::ArchimateHook.new(site, archimate_file).generate
+    end
+  end
+end

data/lib/jekyll/archimate/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Archimate
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-archimate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Morga
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: archimate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  Produces SVG diagrams and a JSON index useful for
+                            search from an ArchiMate model file.
+email:
+- markmorga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-archimate.gemspec
+- lib/jekyll/archimate.rb
+- lib/jekyll/archimate/archimate_cache.rb
+- lib/jekyll/archimate/archimate_diagram_tag.rb
+- lib/jekyll/archimate/archimate_hook.rb
+- lib/jekyll/archimate/version.rb
+homepage: https://github.com/mmorga/jekyll-archimate
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Jekyll plugins to support documenting ArchiMate models.
+test_files: []