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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b045cd70c2375d6cc096ac8d3323e15727c907bcc78ecb627641e0f87832ec9
-  data.tar.gz: 283ad8eb59754e1d664d442aba2ead3b4fcb6a882a2fba05bc0658ddd5d09d30
+  metadata.gz: 9f94594d15f1b9e8b4c7a02d99a6ebfed8164ad00e65fedffb9fd5f3deed0bde
+  data.tar.gz: e45b408956ce95fd59e813b1f1af8ec284d0c52938abe12fde4d90ee5d8be24b
 SHA512:
-  metadata.gz: cd120bba4d87dbe8b3a20c88b9c468d8c1a561d857597ff1d3111dd177ead51920a15d27b2ac8fc52f83894eba82623b3aeb8f3dd8fbe0bef49e70df215b478e
-  data.tar.gz: 34c9f84aee668df5e6194b2a5256fe02a870286d5b3883dc9227447f110ba195e354debbe6e7788e5eb14b4d161508915930a0632da7b2c29b8e9a9946dbef73
+  metadata.gz: 5b0b8be8ff9299477f8d3ceb29c02832a4e3b61af1f98db082245862c18da9c3ea7441e41a8e4a0097fab6edc6c48524abe1d823a3a799001d809d6e1a1c4afa
+  data.tar.gz: adc2f75f13ed2548901e9b8c008b7385f43a07a42a57c94e639d6e54a78e2032cd25a2f780463711593dd72a93e854237514b17f31906cc30e237ec2ef7373ac

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

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

@@ -55,7 +55,7 @@ module Jekyll
           # Creates a data structure like { tag1: [item1, item2], tag2: [item2, item3] }
           tags = {}
           items.each do |item|
-            item.data['tags'].each do |tag|
+            (item.data['tags'] or []).each do |tag|
               unless tags.key? tag
                 tags[tag] = []
               end

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

@@ -30,6 +30,8 @@ module Jekyll
         entries.each do |entry|
           path = File.join(dir, entry)
 
+          Jekyll.logger.debug("OPF:", "Reading entry #{path}")
+
           if File.directory?(path)
             read_project_subdir(path, collection, nested=true)
 
@@ -40,11 +42,17 @@ 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
+              # (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 (possibly nesting level doesn’t match): #{doc.url}")
               end
             else
+              Jekyll.logger.debug("OPF:", "Adding static file: #{path}")
               collection.files << Jekyll::StaticFile.new(
                 @site,
                 @site.source,
@@ -104,6 +112,9 @@ module Jekyll
             project['site']['git_repo_url'],
             ['assets', '_posts', '_software', '_specs'])
 
+          
+          Jekyll.logger.debug("OPF:", "Reading files in project #{project_path}")
+
           CollectionDocReader.new(site).read(
             project_path,
             @site.collections['projects'])
@@ -131,13 +142,9 @@ module Jekyll
                       spec_checkout_path
                     end
 
-        begin
-          repo_checkout = git_shallow_checkout(spec_checkout_path, repo_url, [repo_subtree])
-        rescue
-          repo_checkout = nil
-        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,
@@ -164,14 +171,23 @@ module Jekyll
       def fetch_and_read_specs(collection_name, build_pages=false)
         # collection_name would be either specs or (for hub site) projects
 
+        Jekyll.logger.debug("OPF:", "Fetching specs for items in collection #{collection_name} (if it exists)")
+
         return unless @site.collections.key?(collection_name)
 
+        Jekyll.logger.debug("OPF:", "Fetching specs for items in collection #{collection_name}")
+
         # Get spec entry points
         entry_points = @site.collections[collection_name].docs.select do |doc|
           doc.data['spec_source']
         end
 
+        if entry_points.size < 1
+          Jekyll.logger.info("OPF:", "Fetching specs for items in collection #{collection_name}: No entry points")
+        end
+
         entry_points.each do |index_doc|
+          Jekyll.logger.debug("OPF:", "Fetching specs: entry point #{index_doc.id} in collection #{collection_name}")
           build_and_read_spec_pages(collection_name, index_doc, build_pages)
         end
       end
@@ -179,14 +195,23 @@ module Jekyll
       def fetch_and_read_software(collection_name)
         # collection_name would be either software or (for hub site) projects
 
+        Jekyll.logger.debug("OPF:", "Fetching software for items in collection #{collection_name} (if it exists)")
+
         return unless @site.collections.key?(collection_name)
 
+        Jekyll.logger.debug("OPF:", "Fetching software for items in collection #{collection_name}")
+
         entry_points = @site.collections[collection_name].docs.select do |doc|
           doc.data['repo_url']
         end
 
+        if entry_points.size < 1
+          Jekyll.logger.info("OPF:", "Fetching software for items in collection #{collection_name}: No entry points")
+        end
+
         entry_points.each do |index_doc|
           item_name = index_doc.id.split('/')[-1]
+          Jekyll.logger.debug("OPF:", "Fetching software: entry point #{index_doc.id} in collection #{collection_name}")
 
           docs = index_doc.data['docs']
           main_repo = index_doc.data['repo_url']
@@ -196,13 +221,9 @@ module Jekyll
 
           docs_path = "#{index_doc.path.split('/')[0..-2].join('/')}/#{item_name}"
 
-          begin
-            sw_docs_checkout = git_shallow_checkout(docs_path, sw_docs_repo, [sw_docs_subtree])
-          rescue
-            sw_docs_checkout = nil 
-          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])
@@ -211,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] })
@@ -269,19 +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
@@ -299,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.0
+  version: 2.1.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2021-03-27 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.8
 signing_key: 
 specification_version: 4
 summary: Helpers for the Open Project Jekyll theme