jekyll-theme-open-project-helpers 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b66bfdb58fa9bd277603af3c29b2736c8af021a144eaa150c59285fa41804ad
-  data.tar.gz: f6c21cb54b396ef4ee17869e5539ca961c9485f669d1370e4071bc5e05034369
+  metadata.gz: 9f94594d15f1b9e8b4c7a02d99a6ebfed8164ad00e65fedffb9fd5f3deed0bde
+  data.tar.gz: e45b408956ce95fd59e813b1f1af8ec284d0c52938abe12fde4d90ee5d8be24b
 SHA512:
-  metadata.gz: 521ab65d046b3605ad8efbdb113f9a387986331c23421db0f14afe8429a9a28d4e4bce191275936b59471396541811f1aa7f0b1bd1d964ae08cee7fc227d635a
-  data.tar.gz: fbcbc3022c5930db262ea81afd94ac54544b4c32c817ad2e40f28b893cecc143bb473e66dedeec81a89c9a1585e2ba7cb1f61609a578a5528a1c8bcf11acc5a1
+  metadata.gz: 5b0b8be8ff9299477f8d3ceb29c02832a4e3b61af1f98db082245862c18da9c3ea7441e41a8e4a0097fab6edc6c48524abe1d823a3a799001d809d6e1a1c4afa
+  data.tar.gz: adc2f75f13ed2548901e9b8c008b7385f43a07a42a57c94e639d6e54a78e2032cd25a2f780463711593dd72a93e854237514b17f31906cc30e237ec2ef7373ac

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

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

@@ -42,12 +42,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}")
@@ -140,13 +142,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])
 
-        if repo_checkout
+        if repo_checkout[:success]
           if build_pages
             builder = Jekyll::OpenProjectHelpers::SpecBuilder::new(
               @site,
@@ -223,13 +221,9 @@ module Jekyll
 
           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])
 
-          if sw_docs_checkout
+          if sw_docs_checkout[:success]
             CollectionDocReader.new(site).read(
               docs_path,
               @site.collections[collection_name])
@@ -238,7 +232,7 @@ 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)
             index_doc.merge_data!({ 'last_update' => repo_checkout[:modified_at] })
@@ -296,20 +290,39 @@ module Jekyll
           repo.checkout("#{DEFAULT_REPO_REMOTE_NAME}/#{DEFAULT_REPO_BRANCH}", { :f => true })
 
         elsif refresh_condition == 'last-resort'
+          # This is the default case.
+
           begin
+            # 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}/#{DEFAULT_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}/#{DEFAULT_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 +340,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.4
+  version: 2.1.5
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2021-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.50'
-description:
+description: 
 email:
 - open.source@ribose.com
 executables: []
@@ -104,7 +104,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
@@ -119,8 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.0.8
+signing_key: 
 specification_version: 4
 summary: Helpers for the Open Project Jekyll theme
 test_files: []