jekyll-theme-open-project-helpers 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e26790a1c7302ae34771b65d077202f032b21912
+  data.tar.gz: 7f5e0cd9bfc7dc2d03a0d4202af8d125952ec301
+SHA512:
+  metadata.gz: 598f4d1cebd24a0fe19727b3453993d58ef7634841aad33db6dc87452d1db8205118f0253617f7f9a1ece012e2c67bd6b758e9d1191e4ebe70c5767f9d479eb5
+  data.tar.gz: b2bbb6e08b2c8be67fb716fe020ff614d81aeb36e904a06a213efb5f5f6b349aaa2b9437df2c16f0fe83659574ee67d4b26857ef022ebb6a17b3b2ca2b31f829

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ribose
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,6 @@
+# Open Project theme helpers
+
+Jekyll plugin for the Open Project gem-based Jekyll theme by Ribose.
+
+Currently, its functionality includes filtered tag page generation
+for open software and specification indexes on an open hub site.

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name          = 'jekyll-theme-open-project-helpers'
+  s.version       = '0.1.6'
+  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.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!) }
+
+  s.add_runtime_dependency 'jekyll', '~> 3.7'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rubocop', '~> 0.50'
+
+  s.require_paths = ["lib"]
+end

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

@@ -0,0 +1,193 @@
+require 'digest/md5'
+
+module Jekyll
+  # Monkey-patching Site to add a custom property holding combined blog post array
+  # and speed up generation.
+
+  class Site
+    attr_accessor :posts_combined
+
+    def posts_combined
+      @posts_combined
+    end
+  end
+end
+
+module OpenProjectHelpers
+
+  # On an open hub site, Jekyll Open Project theme assumes the existence of two types
+  # of item indexes: software and specs, where items are gathered
+  # from across open projects in the hub.
+  #
+  # The need for :item_test arises from our data structure (see Jekyll Open Project theme docs)
+  # and the fact that Jekyll doesn’t intuitively handle nested collections.
+  INDEXES = {
+    "software" => {
+      :item_test => lambda { |item| item.url.include? '_software' and not item.url.include? '_docs' },
+    },
+    "specs" => {
+      :item_test => lambda { |item| item.url.include? '_specs' and not item.url.include? '_docs' },
+    },
+  }
+
+
+  # Each software or spec item can have its tags,
+  # and the theme allows to filter each index by a tag.
+  # The below generates an additional index page
+  # for each tag in an index, like software/Ruby.
+  #
+  # Note: this expects "_pages/<index page>.html" to be present in site source,
+  # so it would fail if theme setup instructions were not followed fully.
+
+  class FilteredIndexPage < Jekyll::Page
+    def initialize(site, base, dir, tag, items, index_page)
+      @site = site
+      @base = base
+      @dir = dir
+      @name = 'index.html'
+
+      self.process(@name)
+      self.read_yaml(File.join(base, '_pages'), "#{index_page}.html")
+      self.data['tag'] = tag
+      self.data['items'] = items
+    end
+  end
+
+  class FilteredIndexPageGenerator < Jekyll::Generator
+    safe true
+
+    def generate(site)
+
+      # If there’s a “projects” collection, we assume it is indeed
+      # a Jekyll Open Project hub site.
+      if site.collections.key? 'projects'
+
+        INDEXES.each do |index_name, params|
+          items = site.collections['projects'].docs.select { |item| params[:item_test].call(item) }
+
+          # Creates a data structure like { tag1: [item1, item2], tag2: [item2, item3] }
+          tags = {}
+          items.each do |item|
+            item.data['tags'].each do |tag|
+              unless tags.key? tag
+                tags[tag] = []
+              end
+              tags[tag].push(item)
+            end
+          end
+
+          # Creates a filtered index page for each tag
+          tags.each do |tag, tagged_items|
+            site.pages << FilteredIndexPage.new(
+              site,
+              site.source,
+
+              # The filtered page will be nested under /<index page>/<tag>.html
+              File.join(index_name, tag),
+
+              tag,
+              tagged_items,
+              index_name)
+          end
+        end
+      end
+    end
+  end
+
+
+  # Below passes the `items` variable to normal (unfiltered)
+  # index page layout.
+
+  class IndexPage < Jekyll::Page
+    def initialize(site, base, dir, items, index_page)
+      @site = site
+      @base = base
+      @dir = dir
+      @name = 'index.html'
+
+      self.process(@name)
+      self.read_yaml(File.join(base, '_pages'), "#{index_page}.html")
+      self.data['items'] = items
+    end
+  end
+
+  class IndexPageGenerator < Jekyll::Generator
+    safe true
+
+    def generate(site)
+
+      # If there’s a “projects” collection, we assume it is indeed
+      # a Jekyll Open Project hub site.
+      if site.collections.key? 'projects'
+
+        INDEXES.each do |index_name, params|
+          items = site.collections['projects'].docs.select { |item| params[:item_test].call(item) }
+          page = site.site_payload["site"]["pages"].detect { |p| p.url == "/#{index_name}/" }
+          page.data['items'] = items
+        end
+      end
+    end
+  end
+
+
+  # Below passes an array of posts of open hub blog
+  # and from each individual project blog, combined and sorted by date,
+  # to open hub blog index page.
+  #
+  # (It also does some processing on the posts.)
+
+  class BlogIndexGenerator < Jekyll::Generator
+    safe true
+
+    def generate(site)
+
+      site_posts = site.posts.docs
+
+      # If there’s a “projects” collection, we assume it is indeed
+      # a Jekyll Open Project hub site.
+      if site.collections.key? 'projects'
+
+        # Get documents representing projects
+        projects = site.collections['projects'].docs.select do |item|
+          pieces = item.url.split('/')
+          pieces[3] == 'index.html' && pieces[1] == 'projects'
+        end
+        # Add project name (matches directory name, may differ from title)
+        projects = projects.map do |project|
+          project.data['name'] = project.url.split('/')[2]
+          project
+        end
+
+        # Get documents representnig posts from each project’s blog
+        project_posts = site.collections['projects'].docs.select { |item| item.url.include? '_posts' }
+
+        # Add parent project’s data hash onto each
+        project_posts = project_posts.map do |post|
+          project_name = post.url.split('/')[2]
+          post.data['parent_project'] = projects.detect { |p| p.data['name'] == project_name }
+          post
+        end
+
+        posts_combined = (project_posts + site_posts).sort_by(&:date).reverse
+      else
+        posts_combined = site_posts
+      end
+
+      # On each post, replace authors’ emails with corresponding md5 hashes
+      # suitable for hotlinking authors’ Gravatar profile pictures.
+      posts_combined = posts_combined.map do |post|
+        if post.data.key? 'author'
+          email = post.data['author']['email']
+          hash = Digest::MD5.hexdigest(email)
+          post.data['author']['email'] = hash
+        end
+        post
+      end
+
+      blog_index = site.site_payload["site"]["pages"].detect { |page| page.url == '/blog/' }
+      blog_index.data['posts_combined'] = posts_combined
+
+      site.posts_combined = posts_combined
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-theme-open-project-helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+description: 
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- jekyll-theme-open-project-helpers.gemspec
+- lib/jekyll-theme-open-project-helpers.rb
+homepage: https://github.com/riboseinc/jekyll-theme-open-project-helpers/
+licenses:
+- MIT
+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.14.1
+signing_key: 
+specification_version: 4
+summary: Helpers for the Open Project Jekyll theme
+test_files: []