jekyll-theme-open-project-helpers 2.1.7 → 2.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4a49b1b98f4b6a8903466391a01dd42cccc0a80d477614b24bafea89d7af97c
-  data.tar.gz: ff35d3b2783bfa70cd8f72fb2336357a2f1e9a8d15ac48f958d5a1a15f4ac2eb
+  metadata.gz: 5340ebd6b73a77f544854b7425860b5a2fa78ae1508182b0fa53f2aaa6002906
+  data.tar.gz: 2f9025c1a872c6176924c2f936c9bc1fdb7f14c5ce272da54a96ded564528122
 SHA512:
-  metadata.gz: 845c40b2a93ab03c99fff74050da48d099329a430625929e1630625be95c55b1321882ba120dbf5670b53b9769be41ad4d9a9c70ce19b24337af756d785fb9b8
-  data.tar.gz: 715deb4ae224a58c8084f9eb8f538bc0217b7be91601c0a77b7f934dbf52fc8d5c58455c073bd281a1fc1c736783f469bbbe10df23b013af8b6ae99610388e54
+  metadata.gz: 992ce56cd7eafea9d7167384a227eaff95d3dc20bd368e277f386238b13725db49662185aef4f0f415f28784fe392036bf01196af7d715fb3b1790f4ec66848e
+  data.tar.gz: 9e6d476f0a89b3aee43f1c3e5d0becc5ca2b3ee3d297eb371143587ae19d7182248fd3c6c1c14fe69bfda241e1522a062fcd363dedab3273ee05a5fc323fbb1e

data/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+/.rubocop-https*

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.5

data/Gemfile

@@ -0,0 +1,6 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+source "https://rubygems.org"
+
+gemspec

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

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       = '2.1.7'
+  s.version       = '2.1.8'
   s.authors       = ['Ribose Inc.']
   s.email         = ['open.source@ribose.com']
 

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

@@ -1,92 +1,119 @@
-require 'fastimage'
+require "fastimage"
 
 # Recursively go through given list of nav_items, including any nested items,
 # and return a flat array containing navigation items with path specified.
 def get_nav_items_with_path(nav_items)
   items_with_path = []
 
-  for item in nav_items do
-    if item['path']
+  nav_items.each do |item|
+    if item["path"]
       items_with_path.push(item)
     end
 
-    if item['items']
-      items_with_path.concat(get_nav_items_with_path(item['items']))
+    if item["items"]
+      items_with_path.concat(get_nav_items_with_path(item["items"]))
     end
   end
 
-  return items_with_path
+  items_with_path
 end
 
 module Builder
-
   class PngDiagramPage < Jekyll::Page
-    def initialize(site, base, dir, data)
+    EXTRA_STYLESHEETS = [{
+      "href" => "https://unpkg.com/leaflet@1.3.4/dist/leaflet.css",
+      "integrity" => "sha512-puBpdR0798OZvTTbP4A8Ix/l+A4dHDD0DGqYW6RQ+9jxkRFclaxxQb/SJAWZfWAkuyeQUytO7+7N4QKrDh+drA==", # rubocop:disable Layout/LineLength
+      "crossorigin" => "",
+    }].freeze
+
+    EXTRA_SCRIPTS = [{
+      "src" => "https://unpkg.com/leaflet@1.3.4/dist/leaflet.js",
+      "integrity" => "sha512-nMMmRyTVoLYqjP9hrbed9S+FzjZHW5gY1TWCHA5ckwXZBadntCNs8kEqAWdrb9O7rxbCaA4lKTIWjDXZxflOcA==", # rubocop:disable Layout/LineLength
+      "crossorigin" => "",
+    }].freeze
+
+    def initialize(site, base, dir, data) # rubocop:disable Lint/MissingSuper
       @site = site
       @base = base
       @dir = dir
-      @name = 'index.html'
+      @name = "index.html"
 
-      self.process(@name)
+      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'
+      self.data["extra_stylesheets"] = EXTRA_STYLESHEETS
+      self.data["extra_scripts"] = EXTRA_SCRIPTS
+      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 = []
 
-    diagram_nav_items = get_nav_items_with_path(spec_info.data['navigation']['items'])
+    diagram_nav_items = get_nav_items_with_path(
+      spec_info.data["navigation"]["items"],
+    )
+    not_found_items = diagram_nav_items.dup
 
     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 = diagram_nav_items.select { |item|
-        item['path'].start_with?(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]
+      nav_item = diagram_nav_items.select do |item|
+        item["path"].start_with?(png_name_noext)
+      end [0].clone
 
       if nav_item == nil
-        raise "Navigation item matching #{png_name} (#{spec_root}) was not found"
+        warn "UNUSED PNG: #{png_name} detected at source without " \
+             "a corresponding navigation item at (#{spec_root})."
+        next
       end
 
-      data = data.merge(nav_item)
+      not_found_items.delete_if { |item| item["title"] == nav_item["title"] }
+
+      data = build_spec_page_data(pngfile, spec_root, png_name, nav_item,
+                                  spec_info)
 
-      data['title'] = "#{spec_info['title']}: #{nav_item['title']}"
-      data['article_header_title'] = "#{nav_item['title']}"
+      pages << build_spec_page(site, spec_root, png_name_noext, data)
+    end
 
-      page = PngDiagramPage.new(
-        site,
-        site.source,
-        File.join(spec_root, png_name_noext),
-        data)
-      page.content = File.read(stub_path)
-      pages << page
+    not_found_items.each do |item|
+      title = item["title"]
+      warn "SPECIFIED PNG NOT FOUND: #{title}.png not found at source " \
+           "as specified at (#{spec_root})."
     end
 
-    return pages
+    pages
+  end
+
+  def build_spec_page(site, spec_root, png_name_noext, data)
+    page = PngDiagramPage.new(
+      site,
+      site.source,
+      File.join(spec_root, png_name_noext),
+      data,
+    )
+
+    stub_path = "#{File.dirname(__FILE__)}/png_diagram.html"
+    page.content = File.read(stub_path)
+
+    page
   end
 
+  def build_spec_page_data(pngfile, spec_root, png_name, nav_item, spec_info)
+    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']}"
+    data["article_header_title"] = nav_item["title"].to_s
+
+    data
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project-helpers
 version: !ruby/object:Gem::Version
-  version: 2.1.7
+  version: 2.1.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -87,8 +87,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
 - develop/release
 - jekyll-theme-open-project-helpers.gemspec
 - lib/jekyll-theme-open-project-helpers.rb
@@ -119,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Helpers for the Open Project Jekyll theme