jekyll-theme-open-project-helpers 2.1.1 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d096dee75cd2701ec861557d024217d5ae9a1ece20af4449b9711404afab5e40
-  data.tar.gz: b00a83ea68cded47ec6a54619ba8a9989de7a99efc366be0192b9dde65f69b6a
+  metadata.gz: d2af15e9882d15732f6c20715f4823b9979f59c60febeae4edc26004db20fb2f
+  data.tar.gz: 41480819941abc2f376fddd95571b6473258f547338424b1b0a0f39894a4ebeb
 SHA512:
-  metadata.gz: 8edabeaebf34a1dc29863c28387cdaa3f6f530694ce154a6d7dd5f6e3a730a7da4669f5e827b62cbec4ffc768bf584b064ee4be225e14aa272f04828d8ec8cb2
-  data.tar.gz: 2662e8d9aa452712988143669c2d91b1ff709bceaaf838578eb7a05f341431c87bfd32613ae28e8caa373bd6ec038bd2b01170b63b83812bc7dc504cbd9216e1
+  metadata.gz: a46054eeb605e0aa6edf7d15a6d267bd3fe760d6134c2766466da109c939023229df0d77ada8e4078771fa920449400ac5b062a1102d11d131b11ffe2d7b3f96
+  data.tar.gz: 8e85bcc789cabdbb79f62d9eb5d5d8b08bf3ae45e92f43ca003ddeb7ecaa6c55cba407d816d47948ee5227bf9e130f064bc96526f853cc0884b4cc84c39871f9

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Ribose
+Copyright (c) 2020 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

data/README.md

@@ -12,7 +12,7 @@ fetching open project/software/specification data from their repos.
 ## Releasing
 
 **Release this helpers gem and theme gem in tandem with matching versions.**
-See [https://github.com/riboseinc/jekyll-theme-open-project-helpers](theme gem docs) for more.
+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.

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

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

@@ -6,7 +6,9 @@ module Jekyll
     DEFAULT_DOCS_SUBTREE = 'docs'
 
     DEFAULT_REPO_REMOTE_NAME = 'origin'
-    DEFAULT_REPO_BRANCH = 'master'
+    DEFAULT_REPO_BRANCH = 'main'
+    # Can be overridden by default_repo_branch in site config.
+    # Used by shallow_git_checkout.
 
     class NonLiquidDocument < Jekyll::Document
       def render_with_liquid?
@@ -42,12 +44,14 @@ module Jekyll
               doc.read
 
               # Add document to Jekyll document database if it refers to software or spec
-              # (as opposed to be some nested document like README)
-              if (doc.url.split('/').size == 4) or (doc.url.split('/').size == 5 and collection.label === 'projects')
+              # (as opposed to be some random nested document within repository source, like a README)
+              doc_url_parts = doc.url.split('/')
+              Jekyll.logger.debug("OPF:", "Reading document in collection #{collection.label} with URL #{doc.url} (#{doc_url_parts.size} parts)")
+              if collection.label != 'projects' or doc_url_parts.size == 5
                 Jekyll.logger.debug("OPF:", "Adding document with URL: #{doc.url}")
                 collection.docs << doc
               else
-                Jekyll.logger.debug("OPF:", "Did NOT add document with URL (nesting level doesn’t match): #{doc.url}")
+                Jekyll.logger.debug("OPF:", "Did NOT add document with URL (possibly nesting level doesn’t match): #{doc.url}")
               end
             else
               Jekyll.logger.debug("OPF:", "Adding static file: #{path}")
@@ -93,7 +97,8 @@ module Jekyll
           git_shallow_checkout(
             File.join(@site.source, 'parent-hub'),
             @site.config['parent_hub']['git_repo_url'],
-            ['assets', 'title.html'])
+            ['assets', 'title.html'],
+            @site.config['parent_hub']['git_repo_branch'])
         end
       end
 
@@ -108,7 +113,8 @@ module Jekyll
           git_shallow_checkout(
             project_path,
             project['site']['git_repo_url'],
-            ['assets', '_posts', '_software', '_specs'])
+            ['assets', '_posts', '_software', '_specs'],
+            project['site']['git_repo_branch'])
 
           
           Jekyll.logger.debug("OPF:", "Reading files in project #{project_path}")
@@ -129,6 +135,7 @@ module Jekyll
         src = index_doc.data['spec_source']
         repo_url = src['git_repo_url']
         repo_subtree = src['git_repo_subtree']
+        repo_branch = src['git_repo_branch']
         build = src['build']
         engine = build['engine']
         engine_opts = build['options'] || {}
@@ -140,13 +147,9 @@ module Jekyll
                       spec_checkout_path
                     end
 
-        repo_checkout = nil
-        begin
-          repo_checkout = git_shallow_checkout(spec_checkout_path, repo_url, [repo_subtree])
-        rescue
-        end
+        repo_checkout = git_shallow_checkout(spec_checkout_path, repo_url, [repo_subtree], repo_branch)
 
-        if repo_checkout
+        if repo_checkout[:success]
           if build_pages
             builder = Jekyll::OpenProjectHelpers::SpecBuilder::new(
               @site,
@@ -217,19 +220,17 @@ module Jekyll
 
           docs = index_doc.data['docs']
           main_repo = index_doc.data['repo_url']
+          main_repo_branch = index_doc.data['repo_branch']
 
           sw_docs_repo = (if docs then docs['git_repo_url'] end) || main_repo
           sw_docs_subtree = (if docs then docs['git_repo_subtree'] end) || DEFAULT_DOCS_SUBTREE
+          sw_docs_branch = (if docs then docs['git_repo_branch'] end) || nil
 
           docs_path = "#{index_doc.path.split('/')[0..-2].join('/')}/#{item_name}"
 
-          sw_docs_checkout = nil 
-          begin
-            sw_docs_checkout = git_shallow_checkout(docs_path, sw_docs_repo, [sw_docs_subtree])
-          rescue
-          end
+          sw_docs_checkout = git_shallow_checkout(docs_path, sw_docs_repo, [sw_docs_subtree], sw_docs_branch)
 
-          if sw_docs_checkout
+          if sw_docs_checkout[:success]
             CollectionDocReader.new(site).read(
               docs_path,
               @site.collections[collection_name])
@@ -238,9 +239,9 @@ 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 sw_docs_checkout == nil or sw_docs_repo != main_repo
+          if !sw_docs_checkout[:success] 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, main_repo)
+            repo_checkout = git_shallow_checkout(repo_path, main_repo, [], main_repo_branch)
             index_doc.merge_data!({ 'last_update' => repo_checkout[:modified_at] })
           else
             index_doc.merge_data!({ 'last_update' => sw_docs_checkout[:modified_at] })
@@ -248,7 +249,7 @@ module Jekyll
         end
       end
 
-      def git_shallow_checkout(repo_path, remote_url, sparse_subtrees=[])
+      def git_shallow_checkout(repo_path, remote_url, sparse_subtrees, branch_name)
         # Returns hash with timestamp of latest repo commit
         # and boolean signifying whether new repo has been initialized
         # in the process of pulling the data.
@@ -285,6 +286,7 @@ module Jekyll
         end
 
         refresh_condition = @@siteconfig['refresh_remote_data'] || 'last-resort'
+        repo_branch = branch_name || @@siteconfig['default_repo_branch'] || DEFAULT_REPO_BRANCH
 
         unless ['always', 'last-resort', 'skip'].include?(refresh_condition)
           raise RuntimeError.new('Invalid refresh_remote_data value in site’s _config.yml!')
@@ -293,23 +295,42 @@ module Jekyll
         if refresh_condition == 'always'
           repo.fetch(DEFAULT_REPO_REMOTE_NAME, { :depth => 1 })
           repo.reset_hard
-          repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{DEFAULT_REPO_BRANCH}", { :f => true })
+          repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{repo_branch}", { :f => true })
 
         elsif refresh_condition == 'last-resort'
+          # This is the default case.
+
           begin
-            repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{DEFAULT_REPO_BRANCH}", { :f => true })
+            # Let’s try in case this repo has been fetched before (this would never be the case on CI though)
+            repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{repo_branch}", { :f => true })
           rescue Exception => e
-            if e.message.include? "Sparse checkout leaves no entry on working directory"
-              # Supposedly, software docs are missing! No big deal.
+            if is_sparse_checkout_error(e, sparse_subtrees)
+              # Silence errors caused by nonexistent sparse checkout directories
               return {
                 :success => false,
                 :newly_initialized => nil,
                 :modified_at => nil,
               }
             else
+              # In case of any other error, presume repo has not been fetched and do that now.
               Jekyll.logger.debug("OPF:", "Fetching & checking out #{remote_url} for #{repo_path}")
               repo.fetch(DEFAULT_REPO_REMOTE_NAME, { :depth => 1 })
-              repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{DEFAULT_REPO_BRANCH}", { :f => true })
+              begin
+                # Try checkout again
+                repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{repo_branch}", { :f => true })
+              rescue Exception => e
+                if is_sparse_checkout_error(e, sparse_subtrees)
+                  # Again, silence an error caused by nonexistent sparse checkout directories…
+                  return {
+                    :success => false,
+                    :newly_initialized => nil,
+                    :modified_at => nil,
+                  }
+                else
+                  # but this time throw any other error.
+                  raise e
+                end
+              end
             end
           end
         end
@@ -327,6 +348,15 @@ module Jekyll
   end
 end
 
+def is_sparse_checkout_error(err, subtrees)
+  if err.message.include? "Sparse checkout leaves no entry on working directory"
+    Jekyll.logger.debug("OPF: It looks like sparse checkout of these directories failed:", subtrees.to_s)
+    true
+  else
+    false
+  end
+end
+
 Jekyll::Hooks.register :site, :after_init do |site|
   if site.theme  # TODO: Check theme name
     site.reader = Jekyll::OpenProjectHelpers::OpenProjectReader::new(site)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project-helpers
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-31 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -119,7 +119,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