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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4a49b1b98f4b6a8903466391a01dd42cccc0a80d477614b24bafea89d7af97c
-  data.tar.gz: ff35d3b2783bfa70cd8f72fb2336357a2f1e9a8d15ac48f958d5a1a15f4ac2eb
+  metadata.gz: 3b1d4e97d9aad4f03905d45ae68993220d23c8b52fa5bbf3be588c7ed9b11300
+  data.tar.gz: 496d9fdb62b4b2e7b44c59e2ab3b6b8142ec11ebd956b54b0423f487f78974ad
 SHA512:
-  metadata.gz: 845c40b2a93ab03c99fff74050da48d099329a430625929e1630625be95c55b1321882ba120dbf5670b53b9769be41ad4d9a9c70ce19b24337af756d785fb9b8
-  data.tar.gz: 715deb4ae224a58c8084f9eb8f538bc0217b7be91601c0a77b7f934dbf52fc8d5c58455c073bd281a1fc1c736783f469bbbe10df23b013af8b6ae99610388e54
+  metadata.gz: 4f6ddb7b29aad86b3d71fcff8a424a17b8a62971def177ae1dc99aa1ae2c9b7bc70efa8ca50782f2164d3061724993662442632e860bdd8d80485fc2ec041555
+  data.tar.gz: bed4fcefeafea0edd8517733d30ea90b507f7694a10ca2a8cda234255de2c534fde126841c5a1742d5f31d8d3bc31c3347a4792a5cd0cf1539ff7340f1e70249

data/.github/workflows/rake.yml

@@ -0,0 +1,31 @@
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
+        os: [ ubuntu-latest ]
+        experimental: [ false ]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/.github/workflows/release.yml

@@ -0,0 +1,44 @@
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  push:
+    tags: [ v* ]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+          bundler-cache: true
+
+      - run: gem install gem-release
+
+      - run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+
+      - if: github.event_name == 'workflow_dispatch' && github.event.inputs.next_version != 'skip'
+        run: gem bump --version ${{ github.event.inputs.next_version }} --tag --push
+
+      - name: publish to rubygems.org
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RIBOSE_RUBYGEMS_API_KEY}}
+        run: |
+          gem install gem-release
+          envsubst << 'EOF' > ~/.gem/credentials
+          ---
+          :rubygems_api_key: ${RUBYGEMS_API_KEY}
+          EOF
+          chmod 0600 ~/.gem/credentials
+          gem release

data/.gitignore

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

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/README.md

@@ -1,5 +1,12 @@
 # Open Project theme helpers
 
+[![Build Status](https://github.com/riboseinc/jekyll-theme-open-project-helpers/actions/workflows/rake.yml/badge.svg)](https://github.com/riboseinc/jekyll-theme-open-project-helpers/actions/workflows/rake.yml)
+[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-open-project-helpers.svg)](https://rubygems.org/gems/jekyll-theme-open-project-helpers
+)
+[![Pull Requests](https://img.shields.io/github/issues-pr-raw/riboseinc/jekyll-theme-open-project-helpers.svg)](https://github.com/riboseinc/jekyll-theme-open-project-helpers/pulls)
+[![Commits since latest](https://img.shields.io/github/commits-since/riboseinc/jekyll-theme-open-project-helpers/latest.svg)](https://github.com/riboseinc/jekyll-theme-open-project-helpers/releases)
+
+
 Jekyll plugin for the Open Project gem-based Jekyll theme by Ribose.
 
 It provides the data reading and page generation capabilities
@@ -11,17 +18,7 @@ fetching open project/software/specification data from their repos.
 
 ## Releasing
 
-**Release this helpers gem and theme gem in tandem with matching versions.**
-See [Theme gem docs](https://github.com/riboseinc/jekyll-theme-open-project) for more.
-
-
-1. Inside .gemspec within this repo’s root, update main gem version to the one being released.
-
-2. Make a commit for the new release (“chore: Release vX.X.X”).
-
-3. Execute `./develop/release`. This does the following:
+### New approach
 
-   * Builds new gem version
-   * Pushes gem to rubygems.org
-   * Creates new version tag in this repository
-   * Pushes changes to GitHub
+Do `git tag ${version-tag}` or, start release manually with the
+[`release.yml` workflow](https://github.com/riboseinc/jekyll-theme-open-project-helpers/actions/workflows/release.yml)

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]

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

@@ -1,22 +1,29 @@
 # frozen_string_literal: true
 
 Gem::Specification.new do |s|
-  s.name          = 'jekyll-theme-open-project-helpers'
-  s.version       = '2.1.7'
-  s.authors       = ['Ribose Inc.']
-  s.email         = ['open.source@ribose.com']
+  s.name          = "jekyll-theme-open-project-helpers"
+  s.version       = "2.1.9"
+  s.authors       = ["Ribose Inc."]
+  s.email         = ["open.source@ribose.com"]
 
-  s.summary       = 'Helpers for the Open Project Jekyll theme'
-  s.homepage      = 'https://github.com/riboseinc/jekyll-theme-open-project-helpers/'
-  s.license       = 'MIT'
+  s.summary       = "Helpers for the Open Project Jekyll theme"
+  s.homepage      = "https://github.com/riboseinc/jekyll-theme-open-project-helpers/"
+  s.license       = "MIT"
 
-  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!) }
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r!^(test|spec|features)/!)
+  end
 
-  s.add_runtime_dependency 'jekyll', '~> 4.0'
-  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'
+  s.required_ruby_version = ">= 2.5.0"
+
+  s.add_runtime_dependency "fastimage", "~> 2.1.4"
+  s.add_runtime_dependency "git", "~> 1.4"
+  s.add_runtime_dependency "jekyll", "~> 4.0"
+
+  s.add_development_dependency "rake", "~> 13.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "rspec-command", "~> 1.0"
+  s.add_development_dependency "rubocop", "~> 1.5.2"
 
   s.require_paths = ["lib"]
 end

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

@@ -260,7 +260,7 @@ module Jekyll
         git_dir = File.join(repo_path, '.git')
         git_info_dir = File.join(git_dir, 'info')
         git_sparse_checkout_file = File.join(git_dir, 'info', 'sparse-checkout')
-        unless File.exists? git_dir
+        unless File.exist? git_dir
           newly_initialized = true
 
           repo = Git.init(repo_path)

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

@@ -1,92 +1,131 @@
-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
+def find_nav_items(diagram_nav_items, png_name_noext)
+  diagram_nav_items.select do |item|
+    item["path"].start_with?(png_name_noext)
+  end
+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_stylesheets"] = EXTRA_STYLESHEETS
+      self.data["extra_scripts"] = EXTRA_SCRIPTS
+      self.data["layout"] = "spec"
+    end
+  end
 
-      self.data['extra_scripts'] = [{
-        "src" => "https://unpkg.com/leaflet@1.3.4/dist/leaflet.js",
-        "integrity" => "sha512-nMMmRyTVoLYqjP9hrbed9S+FzjZHW5gY1TWCHA5ckwXZBadntCNs8kEqAWdrb9O7rxbCaA4lKTIWjDXZxflOcA==",
-        "crossorigin" => "",
-      }]
+  def build_spec_pages(site, spec_info, source, dest, _opts)
+    nav_items = get_nav_items_with_path(
+      spec_info.data["navigation"]["items"],
+    )
 
-      self.data['layout'] = 'spec'
+    pages, not_found_items = process_spec_images(site, source, nav_items,
+                                                 dest, spec_info)
+
+    not_found_items.each do |item|
+      warn "SPECIFIED PNG NOT FOUND: #{item['title']}.png not found " \
+           "at source as specified at (#{dest})."
     end
+
+    pages
   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"
+  def process_spec_images(site, source, nav_items, dest, spec_info)
     pages = []
+    not_found_items = nav_items.dup
 
-    diagram_nav_items = get_nav_items_with_path(spec_info.data['navigation']['items'])
-
-    Dir.glob("#{images_path}/*.png") do |pngfile|
+    Dir.glob("#{source}/*.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 = find_nav_items(nav_items, png_name_noext)[0].clone
 
       if nav_item == nil
-        raise "Navigation item matching #{png_name} (#{spec_root}) was not found"
+        warn "UNUSED PNG: #{File.basename(pngfile)} detected at source " \
+             "without a corresponding navigation item at (#{dest})."
+        next
       end
 
-      data = data.merge(nav_item)
+      not_found_items.delete_if { |item| item["title"] == nav_item["title"] }
 
-      data['title'] = "#{spec_info['title']}: #{nav_item['title']}"
-      data['article_header_title'] = "#{nav_item['title']}"
+      data = build_spec_page_data(pngfile, dest, png_name, nav_item,
+                                  spec_info)
 
-      page = PngDiagramPage.new(
-        site,
-        site.source,
-        File.join(spec_root, png_name_noext),
-        data)
-      page.content = File.read(stub_path)
-      pages << page
+      pages << build_spec_page(site, dest, png_name_noext, data)
     end
 
-    return pages
+    [pages, not_found_items]
   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)
+    data = fill_image_data(pngfile, spec_info, spec_root, png_name)
+      .merge(nav_item)
+
+    data["title"] = "#{spec_info['title']}: #{nav_item['title']}"
+    data["article_header_title"] = nav_item["title"].to_s
+
+    data
+  end
+
+  def fill_image_data(pngfile, spec_info, spec_root, png_name)
+    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
+  end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project-helpers
 version: !ruby/object:Gem::Version
-  version: 2.1.7
+  version: 2.1.9
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: fastimage
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 2.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -39,57 +39,90 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: fastimage
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: 1.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
-description:
+        version: 1.5.2
+description: 
 email:
 - open.source@ribose.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rake.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
 - LICENSE.txt
 - README.md
-- develop/release
+- Rakefile
 - jekyll-theme-open-project-helpers.gemspec
 - lib/jekyll-theme-open-project-helpers.rb
 - lib/jekyll-theme-open-project-helpers/blog_index.rb
@@ -104,7 +137,7 @@ homepage: https://github.com/riboseinc/jekyll-theme-open-project-helpers/
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -112,15 +145,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Helpers for the Open Project Jekyll theme
 test_files: []

data/develop/release

@@ -1,41 +0,0 @@
-#!/bin/sh
-# Tag and push a release.
-
-set -e
-
-# Make sure we're in the project root.
-
-cd $(dirname "$0")/..
-
-# Make sure the darn thing works? Meh.
-# bundle update
-
-# Build a new gem archive.
-
-rm -rf jekyll-theme-open-project-helpers-*.gem
-gem build -q jekyll-theme-open-project-helpers.gemspec
-
-# Make sure we're on the master branch.
-
-(git branch | grep -q 'master') || {
-  echo "Only release from the master branch."
-  exit 1
-}
-
-# Figure out what version we're releasing.
-
-tag=v`ls jekyll-theme-open-project-helpers-*.gem | sed 's/^jekyll-theme-open-project-helpers-\(.*\)\.gem$/\1/'`
-
-# Make sure we haven't released this version before.
-
-git fetch -t origin
-
-(git tag -l | grep -q "$tag") && {
-  echo "Whoops, there's already a '${tag}' tag."
-  exit 1
-}
-
-# Tag it and bag it.
-
-gem push jekyll-theme-open-project-helpers-*.gem && git tag "$tag" &&
-git push origin master && git push origin "$tag"