jekyll-theme-open-project-helpers 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f63b46564cc429a52480049af1d972a63a0ac845caebbeef39aff999f6fbd43
-  data.tar.gz: 6ea1458978a4423864d31229ea8a6f38b4320005b280ae0791425ef63e23165d
+  metadata.gz: f5fd5decde1edbaf519bb5db108a98384d4c3638c1ecafd392ea0f684da92c71
+  data.tar.gz: 7cc6823120af4dd4147948d4410d0f282445c7ff61df0c84be53ad842f2b425b
 SHA512:
-  metadata.gz: 057e49bf5d6cee6318e5240900f0a59e98f74654cdef1d7b643d5073f834d13759ab0e0b9fd4f718f19ca81fa5762f614bab1cf38e0ba0ef5f56cd5358114c48
-  data.tar.gz: 2a7cbde88d5c9b607fc355397cf8f11a9d188ef5eb9cc9a4f0e6057d2b84f43727063f11aee7a3c4ff3a04dc605899bda6c8f28d94053a8a390066dab083fbec
+  metadata.gz: 3107adcca93d30676b5c72ec5925bb7de05b79cf431e388fd2052736d8dcdfe9b28c4a43cb8574d8707f60700880500c38bf43077083c333b8b685e73272a7c3
+  data.tar.gz: 582502b40a9d21e12af4def1e90a135c88bb0d62cc4a58deb0e0cccbca0d6e48367bf907ea8240a541c0d923f31a78c64f204b601c65e7648df37be75195deec

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

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

@@ -3,6 +3,8 @@ require 'fileutils'
 module Jekyll
   module OpenProjectHelpers
 
+    DEFAULT_DOCS_SUBTREE = 'docs'
+
     class CollectionDocReader < Jekyll::DataReader
 
       def read(dir, collection)
@@ -65,7 +67,7 @@ module Jekyll
 
       def fetch_hub_logo
         if @site.config.key? 'parent_hub' and @site.config['parent_hub'].key? 'git_repo_url'
-          git_sparse_checkout(
+          git_shallow_checkout(
             File.join(@site.source, 'parent-hub'),
             @site.config['parent_hub']['git_repo_url'],
             ['assets/', 'title.html'])
@@ -80,7 +82,7 @@ module Jekyll
         project_indexes.each do |project|
           project_path = project.path.split('/')[0..-2].join('/')
 
-          result = git_sparse_checkout(
+          result = git_shallow_checkout(
             project_path,
             project['site']['git_repo_url'],
             ['assets/', '_posts/', '_software/', '_specs/'])
@@ -96,46 +98,61 @@ module Jekyll
         end
       end
 
-      def fetch_docs_for_item(item_doc)
-        item_name = item_doc.id.split('/')[-1]
-        docs_path = "#{item_doc.path.split('/')[0..-2].join('/')}/#{item_name}"
-
-        return {
-          :checkout_result => git_sparse_checkout(
-            docs_path,
-            item_doc['docs']['git_repo_url'],
-            [item_doc['docs']['git_repo_subtree']]),
-          :docs_path => docs_path,
-        }
-      end
-
       def fetch_and_read_docs_for_items(collection_name, index_collection_name=nil)
         # collection_name would be either software, specs, or (for hub site) projects
-        # index_collection_name would be either software or specs
+        # index_collection_name would be either software, specs or (for project site) nil
 
         return unless @site.collections.key?(collection_name)
 
         index_collection_name = index_collection_name or collection_name
 
         entry_points = @site.collections[collection_name].docs.select do |doc|
-          doc.data.key?('docs') and
-          doc.data['docs']['git_repo_url']
+          doc.data['repo_url']
         end
+
         entry_points.each do |index_doc|
-          result = fetch_docs_for_item(index_doc)
-          index_doc.merge_data!({ 'last_update' => result[:checkout_result][:modified_at] })
+          item_name = index_doc.id.split('/')[-1]
+
+          if index_doc.data.key?('docs') and index_doc.data['docs']['git_repo_url']
+            docs_repo = index_doc.data['docs']['git_repo_url']
+            docs_subtree = index_doc.data['docs']['git_repo_subtree'] || DEFAULT_DOCS_SUBTREE
+          else
+            docs_repo = index_doc.data['repo_url']
+            docs_subtree = DEFAULT_DOCS_SUBTREE
+          end
 
-          # Read all docs for hub site only when the repo is freshly initialized,
-          # for project sites always. A workaround for #4 pending proper solution.
-          if !@site.config['is_hub'] or result[:newly_initialized]
-            CollectionDocReader.new(site).read(
-              result[:docs_path],
-              @site.collections[collection_name])
+          docs_path = "#{index_doc.path.split('/')[0..-2].join('/')}/#{item_name}"
+
+          begin
+            docs_checkout = git_shallow_checkout(docs_path, docs_repo, [docs_subtree])
+
+            # Read all docs for hub site only when the repo is freshly initialized,
+            # for project sites always. A workaround for #4 pending proper solution.
+            if !@site.config['is_hub'] or docs_checkout[:newly_initialized]
+              CollectionDocReader.new(site).read(
+                docs_checkout[:docs_path],
+                @site.collections[collection_name])
+            end
+
+          rescue
+            docs_checkout = nil
+
+          end
+
+          # Get last repository modification timestamp.
+          # Fetch the repository for that purpose,
+          # unless it’s the same as the repo where docs are.
+          if docs_checkout == nil or docs_repo != index_doc.data['repo_url']
+            repo_path = "#{index_doc.path.split('/')[0..-2].join('/')}/_#{item_name}_repo"
+            repo_checkout = git_shallow_checkout(repo_path, index_doc.data['repo_url'])
+            index_doc.merge_data!({ 'last_update' => repo_checkout[:modified_at] })
+          else
+            index_doc.merge_data!({ 'last_update' => docs_checkout[:modified_at] })
           end
         end
       end
 
-      def git_sparse_checkout(repo_path, remote_url, subtrees)
+      def git_shallow_checkout(repo_path, remote_url, sparse_subtrees=[])
         # Returns hash with timestamp of latest repo commit
         # and boolean signifying whether new repo has been initialized
         # in the process of pulling the data.
@@ -155,19 +172,21 @@ module Jekyll
 
           repo.add_remote('origin', remote_url)
 
-          repo.config('core.sparseCheckout', true)
+          if sparse_subtrees.size > 0
+            repo.config('core.sparseCheckout', true)
 
-          FileUtils.mkdir_p File.join(git_dir, 'info')
-          open(File.join(git_dir, 'info', 'sparse-checkout'), 'a') { |f|
-            subtrees.each { |path| f << "#{path}\n" }
-          }
+            FileUtils.mkdir_p File.join(git_dir, 'info')
+            open(File.join(git_dir, 'info', 'sparse-checkout'), 'a') { |f|
+              subtrees.each { |path| f << "#{path}\n" }
+            }
+          end
 
         else
           repo = Git.open(repo_path)
 
         end
 
-        repo.fetch
+        repo.fetch('origin', { :depth => 1 })
         repo.reset_hard
         repo.checkout('origin/master', { :f => true })
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project-helpers
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-09 00:00:00.000000000 Z
+date: 2018-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll