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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: da36555e1f842b64fcdaad22a38dd74525c6ffe6
-  data.tar.gz: f1acd009d682c175258c635bd96203526c3719f8
+SHA256:
+  metadata.gz: d096dee75cd2701ec861557d024217d5ae9a1ece20af4449b9711404afab5e40
+  data.tar.gz: b00a83ea68cded47ec6a54619ba8a9989de7a99efc366be0192b9dde65f69b6a
 SHA512:
-  metadata.gz: c379cdda8c9b677ed9fcd7eb03801d3a29e3189c201c24a175466172c10c05f389db716f84c52a7fa03a0543ddf752d73585ce59135052a12e2952381a1f5f53
-  data.tar.gz: 7879abc68451e78432b22ab97f395568bd8e6b3e7ad8b407a705feb59d367b86c8b2b90a4821ff02acc7b084c656b83dd556958fbc77d024e49af50c7152b188
+  metadata.gz: 8edabeaebf34a1dc29863c28387cdaa3f6f530694ce154a6d7dd5f6e3a730a7da4669f5e827b62cbec4ffc768bf584b064ee4be225e14aa272f04828d8ec8cb2
+  data.tar.gz: 2662e8d9aa452712988143669c2d91b1ff709bceaaf838578eb7a05f341431c87bfd32613ae28e8caa373bd6ec038bd2b01170b63b83812bc7dc504cbd9216e1

data/README.md

@@ -8,3 +8,20 @@ required by the theme.
 Currently it enables such features as tag-based filtering
 of open software and specification indexes, unified blog index,
 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.
+
+
+1. Inside .gemspec within this repo’s root, update main gem version to the one being released.
+
+2. Make a commit for the new release (“chore: Release vX.X.X”).
+
+3. Execute `./develop/release`. This does the following:
+
+   * Builds new gem version
+   * Pushes gem to rubygems.org
+   * Creates new version tag in this repository
+   * Pushes changes to GitHub

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.0.18'
+  s.version       = '2.1.1'
   s.authors       = ['Ribose Inc.']
   s.email         = ['open.source@ribose.com']
 
@@ -12,7 +12,7 @@ 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.8'
+  s.add_runtime_dependency 'jekyll', '~> 4.0'
   s.add_runtime_dependency 'git', '~> 1.4'
   s.add_runtime_dependency 'fastimage', '~> 2.1.4'
   s.add_development_dependency 'rake', '~> 12.0'

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

@@ -7,7 +7,6 @@ require 'jekyll-theme-open-project-helpers/site_type'
 require 'jekyll-theme-open-project-helpers/project_data_reader'
 require 'jekyll-theme-open-project-helpers/filterable_index'
 require 'jekyll-theme-open-project-helpers/blog_index'
-require 'jekyll-theme-open-project-helpers/external_links'
 require 'jekyll-theme-open-project-helpers/spec_builders/spec_builder'
 require 'jekyll-theme-open-project-helpers/static_file_fix'
 

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
@@ -131,7 +131,13 @@ end
 def get_all_items(site, collection_name, filter_func)
   # Fetches items of specified type, ordered and prepared for usage in index templates
 
-  items = site.collections[collection_name].docs.select { |item|
+  collection = site.collections[collection_name]
+
+  if collection == nil
+    raise "Collection does not exist: #{collection_name}"
+  end
+
+  items = collection.docs.select { |item|
     filter_func.call(item)
   }
 

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)
 
@@ -41,10 +43,14 @@ module Jekyll
 
               # 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
+              if (doc.url.split('/').size == 4) or (doc.url.split('/').size == 5 and collection.label === 'projects')
+                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}")
               end
             else
+              Jekyll.logger.debug("OPF:", "Adding static file: #{path}")
               collection.files << Jekyll::StaticFile.new(
                 @site,
                 @site.source,
@@ -104,6 +110,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,10 +140,10 @@ module Jekyll
                       spec_checkout_path
                     end
 
+        repo_checkout = nil
         begin
           repo_checkout = git_shallow_checkout(spec_checkout_path, repo_url, [repo_subtree])
         rescue
-          repo_checkout = nil
         end
 
         if repo_checkout
@@ -164,14 +173,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 +197,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,10 +223,10 @@ 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
-            sw_docs_checkout = nil 
           end
 
           if sw_docs_checkout
@@ -280,6 +307,7 @@ module Jekyll
                 :modified_at => nil,
               }
             else
+              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 })
             end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.18
+  version: 2.1.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-04 00:00:00.000000000 Z
+date: 2020-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -93,7 +93,6 @@ files:
 - jekyll-theme-open-project-helpers.gemspec
 - lib/jekyll-theme-open-project-helpers.rb
 - lib/jekyll-theme-open-project-helpers/blog_index.rb
-- lib/jekyll-theme-open-project-helpers/external_links.rb
 - lib/jekyll-theme-open-project-helpers/filterable_index.rb
 - lib/jekyll-theme-open-project-helpers/project_data_reader.rb
 - lib/jekyll-theme-open-project-helpers/site_type.rb
@@ -120,8 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Helpers for the Open Project Jekyll theme

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

@@ -1,49 +0,0 @@
-require 'nokogiri'
-require 'uri'
-
-# Given hostname and content, updates <a> elements as follows:
-#
-# - Adds `rel` attribute
-# - Appends inner markup for FontAwesome external link icon
-#
-# Only processes external links where `href` starts with "http"
-# and target host does not include given site hostname.
-def process_content(site_hostname, content, exclude_selectors=[])
-  content = Nokogiri::HTML(content)
-  content.css('body.site--project main a, body.site--hub.layout--post main a').each do |a|
-    next if matches_one_of(a, exclude_selectors)
-    next unless a.get_attribute('href') =~ /\Ahttp/i
-    next if a.get_attribute('href') =~ /\Ahttp(s)?:\/\/#{site_hostname}\//i
-    next if a.inner_html.include? "ico-ext"
-    a.set_attribute('rel', 'external')
-    a.inner_html = "#{a.inner_html}<span class='ico-ext'><i class='fas fa-external-link-square-alt'></i></span>"
-  end
-  return content.to_s
-end
-
-# Returns true if Nokogiri’s Node matches one of selectors,
-# otherwise return false
-def matches_one_of(node, selectors)
-  for selector in selectors
-    if node.matches? selector
-      return true
-    end
-  end
-  return false
-end
-
-Jekyll::Hooks.register :documents, :post_render do |doc|
-  site_hostname = URI(doc.site.config['url']).host
-  unmarked_link_selectors = doc.site.config['unmarked_external_link_selectors']
-  unless doc.asset_file?
-    doc.output = process_content(site_hostname, doc.output, unmarked_link_selectors)
-  end
-end
-
-Jekyll::Hooks.register :pages, :post_render do |page|
-  site_hostname = URI(page.site.config['url']).host
-  unmarked_link_selectors = page.site.config['unmarked_external_link_selectors']
-  unless page.asset_file?
-    page.output = process_content(site_hostname, page.output, unmarked_link_selectors)
-  end
-end