jekyll-theme-open-project-helpers 1.1.24 → 1.1.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ff260a10532e72a2e3d117c383e0970b2f7eb4bf12a1f2b55e9a800a4541a62
-  data.tar.gz: 1a6ce67cdc2ca0d1b02c30f63e72559ec0dd27d42017a4e8758dc31dc572452f
+  metadata.gz: c192c0b3ad2c0a163331115f647f7d40821573c0b519ea879c90f4309bbe1ffb
+  data.tar.gz: e02887c7c4e8c046d2ebf3a06cf659b4fc744f8cc6ca7c40c9bbd8657ace5d23
 SHA512:
-  metadata.gz: 38fcfdd49087c7caa030d85a250986000d2f2802228a9a2a0e1a58c613cabda6727a93e97f26c0607f021d50b1d82c66c6e1ee7dcfeb223d0b6e4c633e697f87
-  data.tar.gz: 7875178aae1b268e398bebf5357980cf2dc8d9ec799100c27dcd252c2fb25ea3ebd8f79f5e884e2f5a4dfab58e2d0712575fac7eac7d0d4dfa870c571528918b
+  metadata.gz: 664b3e7464608435eb4dac2f31b75413279297d2894d391bcf04baf316d400bed0c35f1813b7373093c153c8dc1aa68ba5b54d23eda2b174d8c7bb8248c9dc8a
+  data.tar.gz: 1adce0e0cf30a8284797ce9464caf33d2662864a025d0c2d5915227020971ca61878ba70d16aaf5c27b6ae6250e86bffb726223766fe458fbfdd0a57f075ab19

data/jekyll-theme-open-project-helpers.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'jekyll-theme-open-project-helpers'
-  s.version       = '1.1.24'
+  s.version       = '1.1.25'
   s.authors       = ['Ribose Inc.']
   s.email         = ['open.source@ribose.com']
 
@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'jekyll', '~> 3.8'
   s.add_runtime_dependency 'git', '~> 1.4'
+  s.add_runtime_dependency 'fastimage', '~> 2.1.4'
   s.add_development_dependency 'rake', '~> 12.0'
   s.add_development_dependency 'rubocop', '~> 0.50'
 

data/lib/jekyll-theme-open-project-helpers.rb

@@ -8,6 +8,7 @@ require 'jekyll-theme-open-project-helpers/project_data_reader'
 require 'jekyll-theme-open-project-helpers/filterable_index'
 require 'jekyll-theme-open-project-helpers/blog_index'
 require 'jekyll-theme-open-project-helpers/external_links'
+require 'jekyll-theme-open-project-helpers/spec_builders/spec_builder'
 
 
 module Jekyll

data/lib/jekyll-theme-open-project-helpers/project_data_reader.rb

@@ -69,8 +69,8 @@ module Jekyll
         if @site.config['is_hub']
           fetch_and_read_projects
         else
-          fetch_and_read_docs_for_items('software')
-          fetch_and_read_docs_for_items('specs')
+          fetch_and_read_software('software')
+          fetch_and_read_specs('specs')
           fetch_hub_logo
         end
       end
@@ -99,18 +99,76 @@ module Jekyll
             project['site']['git_repo_url'],
             ['assets', '_posts', '_software', '_specs'])
 
-          fetch_and_read_docs_for_items('projects', 'software')
-          fetch_and_read_docs_for_items('projects', 'specs')
+          fetch_and_read_software('projects')
+          fetch_and_read_specs('projects')
         end
       end
 
-      def fetch_and_read_docs_for_items(collection_name, index_collection_name=nil)
-        # collection_name would be either software, specs, or (for hub site) projects
-        # index_collection_name would be either software, specs or (for project site) nil
+      def build_and_read_spec_pages(collection_name, index_doc)
+        item_name = index_doc.id.split('/')[-1]
+
+        repo_checkout = nil
+        src = index_doc.data['spec_source']
+        repo_url = src['git_repo_url']
+        repo_subtree = src['git_repo_subtree']
+        build = src['build']
+        engine = build['engine']
+        engine_opts = build['options'] || {}
+
+        spec_checkout_path = "#{index_doc.path.split('/')[0..-2].join('/')}/#{item_name}"
+        spec_root = if repo_subtree
+                      "#{spec_checkout_path}/#{repo_subtree}"
+                    else
+                      spec_checkout_path
+                    end
+
+        begin
+          repo_checkout = git_shallow_checkout(spec_checkout_path, repo_url, [repo_subtree])
+        rescue
+          repo_checkout = nil
+        end
+
+        if repo_checkout
+          builder = Jekyll::OpenProjectHelpers::SpecBuilder::new(
+            @site,
+            index_doc,
+            spec_root,
+            "specs/#{item_name}",
+            engine,
+            engine_opts)
+
+          builder.build()
+          builder.built_pages.each do |page|
+            @site.pages << page
+          end
+
+          CollectionDocReader.new(site).read(
+            spec_checkout_path,
+            @site.collections[collection_name])
+
+          index_doc.merge_data!({ 'last_update' => repo_checkout[:modified_at] })
+        end
+      end
+
+      def fetch_and_read_specs(collection_name)
+        # collection_name would be either specs or (for hub site) projects
 
         return unless @site.collections.key?(collection_name)
 
-        index_collection_name = index_collection_name or collection_name
+        # Get spec entry points
+        entry_points = @site.collections[collection_name].docs.select do |doc|
+          doc.data['spec_source']
+        end
+
+        entry_points.each do |index_doc|
+          build_and_read_spec_pages(collection_name, index_doc)
+        end
+      end
+
+      def fetch_and_read_software(collection_name)
+        # collection_name would be either software or (for hub site) projects
+
+        return unless @site.collections.key?(collection_name)
 
         entry_points = @site.collections[collection_name].docs.select do |doc|
           doc.data['repo_url']
@@ -120,22 +178,24 @@ module Jekyll
           item_name = index_doc.id.split('/')[-1]
 
           if index_doc.data.key?('docs') and index_doc.data['docs']['git_repo_url']
-            docs_repo = index_doc.data['docs']['git_repo_url']
-            docs_subtree = index_doc.data['docs']['git_repo_subtree'] || DEFAULT_DOCS_SUBTREE
+            sw_docs_repo = index_doc.data['docs']['git_repo_url']
+            sw_docs_subtree = index_doc.data['docs']['git_repo_subtree'] || DEFAULT_DOCS_SUBTREE
           else
-            docs_repo = index_doc.data['repo_url']
-            docs_subtree = DEFAULT_DOCS_SUBTREE
+            sw_docs_repo = index_doc.data['repo_url']
+            sw_docs_subtree = DEFAULT_DOCS_SUBTREE
           end
 
+          main_repo = index_doc.data['repo_url']
+
           docs_path = "#{index_doc.path.split('/')[0..-2].join('/')}/#{item_name}"
 
           begin
-            docs_checkout = git_shallow_checkout(docs_path, docs_repo, [docs_subtree])
+            sw_docs_checkout = git_shallow_checkout(docs_path, sw_docs_repo, [sw_docs_subtree])
           rescue
-            docs_checkout = nil 
+            sw_docs_checkout = nil 
           end
 
-          if docs_checkout
+          if sw_docs_checkout
             CollectionDocReader.new(site).read(
               docs_path,
               @site.collections[collection_name])
@@ -144,12 +204,12 @@ module Jekyll
           # Get last repository modification timestamp.
           # Fetch the repository for that purpose,
           # unless it’s the same as the repo where docs are.
-          if docs_checkout == nil or docs_repo != index_doc.data['repo_url']
+          if sw_docs_checkout == nil or sw_docs_repo != main_repo
             repo_path = "#{index_doc.path.split('/')[0..-2].join('/')}/_#{item_name}_repo"
-            repo_checkout = git_shallow_checkout(repo_path, index_doc.data['repo_url'])
+            repo_checkout = git_shallow_checkout(repo_path, main_repo)
             index_doc.merge_data!({ 'last_update' => repo_checkout[:modified_at] })
           else
-            index_doc.merge_data!({ 'last_update' => docs_checkout[:modified_at] })
+            index_doc.merge_data!({ 'last_update' => sw_docs_checkout[:modified_at] })
           end
         end
       end

data/lib/jekyll-theme-open-project-helpers/spec_builders/png_diagram.html

@@ -0,0 +1,31 @@
+{% comment %}Page stub.{% endcomment %}
+
+<div id="diagramContainer" style="height: {{ page.image_height }}px"></div>
+
+<style>
+  .leaflet-container {
+    background-color: transparent;
+  }
+  .documentation.with-expandable-toc > article {
+    max-width: none;
+  }
+</style>
+
+<script>
+  (function () {
+    var map = L.map('diagramContainer', {
+      crs: L.CRS.Simple,
+      attributionControl: false,
+      scrollWheelZoom: false,
+      zoomControl: false,
+      minZoom: -10,
+    }).
+    setView([{{ page.image_height }}/2, {{ page.image_width }}/2]);
+
+    map.addControl(L.control.zoom({ position: 'bottomleft' }));
+
+    var bounds = [[0,0], [{{ page.image_height }}, {{ page.image_width }}]];
+    var image = L.imageOverlay('{{ page.image_path }}', bounds).addTo(map);
+    map.fitBounds(bounds);
+  }());
+</script>

data/lib/jekyll-theme-open-project-helpers/spec_builders/png_diagrams.rb

@@ -0,0 +1,66 @@
+require 'fastimage'
+
+module Builder
+
+  class PngDiagramPage < Jekyll::Page
+    def initialize(site, base, dir, data)
+      @site = site
+      @base = base
+      @dir = dir
+      @name = 'index.html'
+
+      self.process(@name)
+      self.data ||= data
+
+      self.data['extra_stylesheets'] = [{
+        "href" => "https://unpkg.com/leaflet@1.3.4/dist/leaflet.css",
+        "integrity" => "sha512-puBpdR0798OZvTTbP4A8Ix/l+A4dHDD0DGqYW6RQ+9jxkRFclaxxQb/SJAWZfWAkuyeQUytO7+7N4QKrDh+drA==",
+        "crossorigin" => "",
+      }]
+
+      self.data['extra_scripts'] = [{
+        "src" => "https://unpkg.com/leaflet@1.3.4/dist/leaflet.js",
+        "integrity" => "sha512-nMMmRyTVoLYqjP9hrbed9S+FzjZHW5gY1TWCHA5ckwXZBadntCNs8kEqAWdrb9O7rxbCaA4lKTIWjDXZxflOcA==",
+        "crossorigin" => "",
+      }]
+
+      self.data['layout'] = 'spec'
+    end
+  end
+
+  def build_spec_pages(site, spec_info, source, destination, opts)
+    images_path = source
+    spec_root = destination
+    stub_path = "#{File.dirname(__FILE__)}/png_diagram.html"
+    pages = []
+
+    Dir.glob("#{images_path}/*.png") do |pngfile|
+      png_name = File.basename(pngfile)
+      png_name_noext = File.basename(png_name, File.extname(png_name))
+
+      nav_item = spec_info.data['navigation']['sections'].map { |section|
+        section['items']
+      } .flatten.select { |item| item['path'] == png_name_noext} [0].clone
+
+      png_dimensions = FastImage.size(pngfile)
+      data = spec_info.data.clone
+      data['image_path'] = "/#{spec_root}/images/#{png_name}"
+      data['image_width'] = png_dimensions[0]
+      data['image_height'] = png_dimensions[1]
+      data = data.merge(nav_item)
+
+      data['title'] = "#{spec_info['title']}: #{nav_item['title']}"
+
+      page = PngDiagramPage.new(
+        site,
+        site.source,
+        File.join(spec_root, png_name_noext),
+        data)
+      page.content = File.read(stub_path)
+      pages << page
+    end
+
+    return pages
+  end
+
+end

data/lib/jekyll-theme-open-project-helpers/spec_builders/spec_builder.rb

@@ -0,0 +1,33 @@
+require 'forwardable'
+
+module Jekyll
+  module OpenProjectHelpers
+    class SpecBuilder
+
+      attr_reader :built_pages
+
+      def initialize(site, spec_index_doc, spec_source_base, spec_out_base, engine, opts)
+        require_relative engine
+        extend Builder  # adds the build_spec_pages method
+
+        @site = site
+        @spec_index_doc = spec_index_doc
+        @spec_source_base = spec_source_base
+        @spec_out_base = spec_out_base
+        @opts = opts
+
+        @built_pages = []
+      end
+
+      def build()
+        @built_pages = build_spec_pages(
+          @site,
+          @spec_index_doc,
+          @spec_source_base,
+          @spec_out_base,
+          @opts)
+      end
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project-helpers
 version: !ruby/object:Gem::Version
-  version: 1.1.24
+  version: 1.1.25
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-16 00:00:00.000000000 Z
+date: 2018-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: fastimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +97,9 @@ files:
 - lib/jekyll-theme-open-project-helpers/filterable_index.rb
 - lib/jekyll-theme-open-project-helpers/project_data_reader.rb
 - lib/jekyll-theme-open-project-helpers/site_type.rb
+- lib/jekyll-theme-open-project-helpers/spec_builders/png_diagram.html
+- lib/jekyll-theme-open-project-helpers/spec_builders/png_diagrams.rb
+- lib/jekyll-theme-open-project-helpers/spec_builders/spec_builder.rb
 homepage: https://github.com/riboseinc/jekyll-theme-open-project-helpers/
 licenses:
 - MIT