jekyll-theme-open-project-helpers 0.1.6 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e26790a1c7302ae34771b65d077202f032b21912
-  data.tar.gz: 7f5e0cd9bfc7dc2d03a0d4202af8d125952ec301
+  metadata.gz: 9651edae0b25bd5fa6a36a40e57bb39983f69559
+  data.tar.gz: 5d3c6ac31536983b40e6c65f148fc2c898b2449b
 SHA512:
-  metadata.gz: 598f4d1cebd24a0fe19727b3453993d58ef7634841aad33db6dc87452d1db8205118f0253617f7f9a1ece012e2c67bd6b758e9d1191e4ebe70c5767f9d479eb5
-  data.tar.gz: b2bbb6e08b2c8be67fb716fe020ff614d81aeb36e904a06a213efb5f5f6b349aaa2b9437df2c16f0fe83659574ee67d4b26857ef022ebb6a17b3b2ca2b31f829
+  metadata.gz: 51cd731eef63bb7ae0741e42787a7af2bdbb3938374abf6aaec1d19e4b9d893b39c448900b24138351caf16466819a5607e0e966c44d9d2b407382c43620f537
+  data.tar.gz: 49e31e2a27dfeb3ef12b9e1853d303dd82be03d1325796d489c224c3ff09bab545a922709fe0627c86d952423755d184a85208661e1fc9b025eb4f68290f83d5

data/develop/release

@@ -0,0 +1,41 @@
+#!/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"

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       = '0.1.6'
+  s.version       = '1.0.0.pre'
   s.authors       = ['Ribose Inc.']
   s.email         = ['open.source@ribose.com']
 
@@ -12,7 +12,8 @@ Gem::Specification.new do |s|
 
   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_runtime_dependency 'jekyll', '~> 3.8.3'
+  s.add_runtime_dependency 'git'
   s.add_development_dependency 'rake', '~> 12.0'
   s.add_development_dependency 'rubocop', '~> 0.50'
 

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

@@ -1,18 +1,188 @@
 require 'digest/md5'
+require 'jekyll-data/reader'
+require 'git'
 
-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 is_hub(site)
+  # If there’re projects defined, we assume it is indeed
+  # a Jekyll Open Project hub site.
+  if site.collections.key? 'projects'
+    if site.collections['projects'] != nil
+      if site.collections['projects'].docs.length > 0
+        return true
+      end
+    end
+  end
+
+  return false
+end
+
+class CollectionDocReader < Jekyll::DataReader
+
+  def read(dir, collection)
+    read_project_subdir(dir, collection)
+  end
+
+  def read_project_subdir(dir, collection, nested=false)
+    return unless File.directory?(dir) && !@entry_filter.symlink?(dir)
+
+    entries = Dir.chdir(dir) do
+      Dir["*.{md,markdown,html}"] + Dir["*"].select { |fn| File.directory?(fn) }
+    end
+
+    entries.each do |entry|
+      path = File.join(dir, entry)
 
-    def posts_combined
-      @posts_combined
+      if File.directory?(path)
+        read_project_subdir(path, collection, nested=true)
+      elsif nested or (File.basename(entry, '.*') != 'index')
+        doc = Jekyll::Document.new(path, :site => @site, :collection => collection)
+        doc.read
+        collection.docs << doc
+      end
     end
   end
 end
 
+
+#
+# Below deals with fetching each open project’s data from its site’s repo
+# (such as posts, template includes, software and specs)
+# and reading it into 'projects' collection docs.
+#
+
+class OpenProjectReader < JekyllData::Reader
+
+  def read
+    super
+    if is_hub(@site)
+      fetch_and_read_projects
+    else
+      fetch_and_read_docs
+    end
+  end
+
+  private
+
+  def fetch_and_read_projects
+    project_indexes = @site.collections['projects'].docs.select do |doc|
+      pieces = doc.id.split('/')
+      pieces.length == 4 and pieces[1] == 'projects' and pieces[3] == 'index'
+    end
+    project_indexes.each do |project|
+      project_path = project.path.split('/')[0..-2].join('/')
+
+      did_check_out = git_sparse_checkout(
+        project_path,
+        project['site']['git_repo_url'],
+        ['_includes/', '_posts/', '_software/', '_specs/'])
+
+      if did_check_out
+        CollectionDocReader.new(site).read(
+          project_path,
+          @site.collections['projects'])
+      end
+    end
+  end
+
+  def fetch_and_read_docs
+
+    # Software
+    software_entry_points = @site.collections['software'].docs.select do |doc|
+      pieces = doc.id.split('/')
+      product_name = pieces[2]
+      last_piece = pieces[-1]
+
+      doc.data.key?('docs') and
+      doc.data['docs']['git_repo_url'] and
+      pieces[1] == 'software' and
+      last_piece == product_name
+    end
+    software_entry_points.each do |index_doc|
+      item_name = index_doc.id.split('/')[-1]
+      docs_path = "#{index_doc.path.split('/')[0..-2].join('/')}/#{item_name}"
+
+      did_check_out = git_sparse_checkout(
+        docs_path,
+        index_doc['docs']['git_repo_url'],
+        [index_doc['docs']['git_repo_subtree']])
+
+      if did_check_out
+        CollectionDocReader.new(site).read(
+          docs_path,
+          @site.collections['software'])
+      end
+    end
+
+    # Specs
+    spec_entry_points = @site.collections['specs'].docs.select do |doc|
+      pieces = doc.id.split('/')
+      product_name = pieces[2]
+      last_piece = pieces[-1]
+
+      doc.data.key?('docs') and
+      doc.data['docs']['git_repo_url'] and
+      pieces[1] == 'specs' and
+      last_piece == product_name
+    end
+    spec_entry_points.each do |index_doc|
+      item_name = index_doc.id.split('/')[-1]
+      docs_path = "#{index_doc.path.split('/')[0..-2].join('/')}/#{item_name}"
+
+      did_check_out = git_sparse_checkout(
+        docs_path,
+        index_doc['docs']['git_repo_url'],
+        [index_doc['docs']['git_repo_subtree']])
+
+      if did_check_out
+        CollectionDocReader.new(site).read(
+          docs_path,
+          @site.collections['software'])
+      end
+    end
+  end
+
+  def git_sparse_checkout(repo_path, remote_url, subtrees)
+    # Returns boolean indicating whether the checkout happened
+
+    git_dir = File.join(repo_path, '.git')
+    unless File.exists? git_dir
+      repo = Git.init(repo_path)
+
+      repo.add_remote('origin', remote_url)
+
+      repo.config('core.sparseCheckout', true)
+      open(File.join(git_dir, 'info', 'sparse-checkout'), 'a') { |f|
+        subtrees.each { |path|
+          f << "#{path}\n"
+        }
+      }
+
+      repo.fetch
+      repo.reset_hard
+      repo.checkout('origin/master', { :f => true })
+
+      return true
+
+    else
+      return false
+
+    end
+  end
+end
+
+
+Jekyll::Hooks.register :site, :after_init do |site|
+  if site.theme  # TODO: Check theme name
+    site.reader = OpenProjectReader::new(site)
+  end
+end
+
+
+#
+# Below deals with blog and other indexes
+#
+
 module OpenProjectHelpers
 
   # On an open hub site, Jekyll Open Project theme assumes the existence of two types
@@ -23,10 +193,10 @@ module OpenProjectHelpers
   # 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' },
+      :item_test => lambda { |item| item.path.include? '/_software' and not item.path.include? '/docs' },
     },
     "specs" => {
-      :item_test => lambda { |item| item.url.include? '_specs' and not item.url.include? '_docs' },
+      :item_test => lambda { |item| item.path.include? '/_specs' and not item.path.include? '/docs' },
     },
   }
 
@@ -57,11 +227,7 @@ module OpenProjectHelpers
     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'
-
+      if is_hub(site)
         INDEXES.each do |index_name, params|
           items = site.collections['projects'].docs.select { |item| params[:item_test].call(item) }
 
@@ -90,6 +256,7 @@ module OpenProjectHelpers
               index_name)
           end
         end
+
       end
     end
   end
@@ -98,34 +265,22 @@ module OpenProjectHelpers
   # 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|
+      INDEXES.each do |index_name, params|
+        if is_hub(site)
           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
+        else
+          items = site.collections[index_name].docs.select { |item| params[:item_test].call(item) }
         end
+
+        page = site.site_payload["site"]["pages"].detect { |p| p.url == "/#{index_name}/" }
+        page.data['items'] = items
       end
+
     end
   end
 
@@ -140,17 +295,13 @@ module OpenProjectHelpers
     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'
-
+      if is_hub(site)
         # Get documents representing projects
         projects = site.collections['projects'].docs.select do |item|
           pieces = item.url.split('/')
-          pieces[3] == 'index.html' && pieces[1] == 'projects'
+          pieces.length == 4 && pieces[-1] == 'index' && pieces[1] == 'projects'
         end
         # Add project name (matches directory name, may differ from title)
         projects = projects.map do |project|
@@ -169,8 +320,10 @@ module OpenProjectHelpers
         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
@@ -186,8 +339,6 @@ module OpenProjectHelpers
 
       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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project-helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 1.0.0.pre
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-27 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.8.3
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +75,7 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- develop/release
 - jekyll-theme-open-project-helpers.gemspec
 - lib/jekyll-theme-open-project-helpers.rb
 homepage: https://github.com/riboseinc/jekyll-theme-open-project-helpers/
@@ -78,9 +93,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14.1