jekyll-geolexica 1.4.0 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df419dc2ad54d36d0ab4de9d534550b154dcb2b2a9a40b660d357ff692c6ec55
-  data.tar.gz: 1a9de9ac8025af15d280176c45775ddb0aafdb3f1cc87d3007e424088eb66eae
+  metadata.gz: 8816b82fd2d8510f65ed56bdfc213a5162ce7be04b2c2794d4c50da409d20b80
+  data.tar.gz: ce988a8c19b0d2066d451643472686d4764be2bd17b78c0c0132badb36efea21
 SHA512:
-  metadata.gz: df6a8124c544aafcd635e8725a5d3807294bae06a503988c48042294f2f685b4b9a6fa5f3d459088a9f4705ba4ac571032eee2e4b2d46bc130b4f280b6feba2e
-  data.tar.gz: d8c7ab3b25e6676741ccd06e7971bcc1075779de3ec5ceffffc8946fc7fb1d37608ec0415448ef7c1dc1d13371919239dcc93327bda8379597321f6a87d43fdc
+  metadata.gz: c443684dc72fa73881a457bea4f8cd3d3856b797ecd8b7ad030ab3ee03ed3b12414335fcc18158107bf7804b1f842aa0189ba164914cd8956533b9a481c8a3b7
+  data.tar.gz: 0cdc4e8d4f655acb28ce21ab53a7f72330e332d4898e8beb3913cf3706db9124f39519bc8e014212d116a6824918441688a0aa377ec4e3b9c0f35bb75f31bdaf

data/_includes/committee-widget.html

@@ -0,0 +1,44 @@
+<span class="committee-widget">
+  <span class="widget-group">
+    {%- if site.committee.parent_org_name %}
+    <span class="widget-item parent-org-reference">
+      {{ site.committee.parent_org_name }}
+    </span>
+    {%- endif %}
+    {%- if site.committee.identifier %}
+    <span class="widget-item committee-id">
+      {{ site.committee.identifier }}
+    </span>
+    {%- endif %}
+    {%- if site.committee.name %}
+    <span class="widget-item committee-name">
+      {{ site.committee.name }}
+    </span>
+    {%- endif %}
+
+    {% if page.layout == "home" and site.always_show_committee_link_on_landing and site.committee.home %}
+      <a href="{{ site.committee.home }}" class="widget-item home">
+        <i class="fas fa-home"></i>
+        Committee site
+      </a>
+    {% endif %}
+  </span>
+
+  {% if site.committee.home or site.committee.links %}
+    <span class="widget-group committee-menu">
+      {% unless page.layout == "home" and site.always_show_committee_link_on_landing and site.committee.home %}
+        <a href="{{ site.committee.home }}" class="widget-item home">
+          <i class="fas fa-home"></i>
+          Committee site
+        </a>
+      {% endunless %}
+      {% if site.committee.links %}
+        {% for link in site.committee.links %}
+          <a href="{{ link.url }}" class="widget-item">
+            {{ link.title }}
+          </a>
+        {% endfor %}
+      {% endif %}
+    </span>
+  {% endif %}
+</span>

data/_includes/concept-source.html

@@ -1,11 +1,6 @@
-{%- assign english = page["eng"] -%}
 <section class="field source">
   <p class="field-name">source</p>
   <p class="field-value">
-    {% if english.authoritative_source.link %}
-      <a href="{{ english.authoritative_source.link }}">{{ english.authoritative_source.ref | default: english.authoritative_source.link | escape_once }}</a>{% if english.authoritative_source.clause %}, {{ english.authoritative_source.clause }}{% endif %}
-    {% else %}
-      {{ english.authoritative_source.ref }}{% if english.authoritative_source.clause %}, {{ english.authoritative_source.clause }}{% endif %}
-    {% endif %}
+    {{ page["eng"].authoritative_source | display_authoritative_source }}
   </p>
 </section>

data/_includes/localized-concept.html

@@ -26,16 +26,9 @@
     {% endif %}
 
     {% if localized_term.authoritative_source.ref != english.authoritative_source.ref %}
-    {% if localized_term.authoritative_source.link %}
       <p class="source localized">
-        [SOURCE: <a href="{{ localized_term.authoritative_source.link }}">
-          {{ localized_term.authoritative_source.ref }}</a>{% if localized_term.authoritative_source.clause %}, {{ localized_term.authoritative_source.clause }}{% endif %}]
+        [SOURCE: {{ localized_term.authoritative_source | display_authoritative_source }}]
       </p>
-    {% else %}
-      <p class="source localized">
-        [SOURCE: {{ localized_term.authoritative_source.ref }}{% if localized_term.authoritative_source.clause %}, {{ localized_term.authoritative_source.clause }}{% endif %}]
-      </p>
-    {% endif %}
       <span class="warning">
         This translated term may not be from the same source as the normative term.
       </span>

data/_layouts/default.html

@@ -15,50 +15,7 @@
         </div>
 
         <div class="site-title">
-          <span class="committee-widget">
-            <span class="widget-group">
-              {%- if site.committee.parent_org_name %}
-              <span class="widget-item parent-org-reference">
-                {{ site.committee.parent_org_name }}
-              </span>
-              {%- endif %}
-              {%- if site.committee.identifier %}
-              <span class="widget-item committee-id">
-                {{ site.committee.identifier }}
-              </span>
-              {%- endif %}
-              {%- if site.committee.name %}
-              <span class="widget-item committee-name">
-                {{ site.committee.name }}
-              </span>
-              {%- endif %}
-
-              {% if page.layout == "home" and site.always_show_committee_link_on_landing and site.committee.home %}
-                <a href="{{ site.committee.home }}" class="widget-item home">
-                  <i class="fas fa-home"></i>
-                  Committee site
-                </a>
-              {% endif %}
-            </span>
-
-            {% if site.committee.home or site.committee.links %}
-              <span class="widget-group committee-menu">
-                {% unless page.layout == "home" and site.always_show_committee_link_on_landing and site.committee.home %}
-                  <a href="{{ site.committee.home }}" class="widget-item home">
-                    <i class="fas fa-home"></i>
-                    Committee site
-                  </a>
-                {% endunless %}
-                {% if site.committee.links %}
-                  {% for link in site.committee.links %}
-                    <a href="{{ link.url }}" class="widget-item">
-                      {{ link.title }}
-                    </a>
-                  {% endfor %}
-                {% endif %}
-              </span>
-            {% endif %}
-          </span>
+          {% include committee-widget.html %}
 
           <h1 class="title">
             <a href="/">{{ site.title_html | default: site.title }}</a>

data/_pages/{concepts-index-list.json → concept-search-index.json}

@@ -1,11 +1,15 @@
 ---
-permalink: "/api/concepts-index-list.json"
+permalink: "/api/concept-search-index.json"
 ---
 [
   {% for concept in site.concepts %}
   {
-    "termid": {{ concept.termid }},
+    "termid": {{ concept.termid | jsonify }},
     "term": {{ concept.eng.terms.first.designation | jsonify }},
+    "term_url": {{ concept.url | jsonify }},
+    "sort_order": {
+      "natural": {{ forloop.index }}
+    },
 
     {% assign english_concept = concept["eng"] %}
     {% for lang in site.geolexica.term_languages %}
@@ -13,6 +17,7 @@ permalink: "/api/concepts-index-list.json"
     "{{ lang }}": {% if concept[lang] %}{
       "term": {{ concept[lang].terms.first.designation | jsonify }},
       "id": {{ concept[lang].id | jsonify }},
+      "term_url": {{ concept.url | append: "#entry-lang-" | append: lang | jsonify }},
       "entry_status": {{ english_concept.entry_status | jsonify }},
       "language_code": {{ concept[lang].language_code | jsonify }},
       "review_decision": {{ english_concept.review_decision | jsonify }}

data/assets/js/concept-search-worker.js

@@ -1,21 +1,16 @@
+---
+---
 importScripts('/assets/js/babel-polyfill.js');
 
-const CONCEPTS_URL = '/api/concepts-index-list.json';
+const CONCEPTS_URL = '/api/concept-search-index.json';
 
-const LANGUAGES = [
-  'eng',
-  'ara',
-  'spa',
-  'swe',
-  'kor',
-  'rus',
-  'ger',
-  'fre',
-  'fin',
-  'jpn',
-  'dan',
-  'chi',
-];
+/** For example:
+ *    const LANGUAGES = [ 'eng', 'deu' ];
+ *  Having a wrapper function helps not to break syntax highlight.
+ */
+const LANGUAGES = (function() {
+  return {{ site.geolexica.term_languages | jsonify }} || [];
+})();
 
 var concepts = null;
 var latestQuery = null;
@@ -39,7 +34,7 @@ async function filterAndSort(params) {
       const matchingLanguages = LANGUAGES.
         filter((lang) => {
           const term = (item[lang] || {}).term;
-          return term && term.toLowerCase().indexOf(params.string) >= 0;
+          return term && term.toLowerCase().indexOf(queryString) >= 0;
         });
 
       if (matchingLanguages.length > 0) {
@@ -77,7 +72,7 @@ async function filterAndSort(params) {
       });
   }
 
-  return concepts.sort((item1, item2) => item1.termid - item2.termid);
+  return concepts.sort((item1, item2) => item1.sort_order.natural - item2.sort_order.natural);
 }
 
 onmessage = async function(msg) {

data/assets/js/concept-search.js

@@ -1,22 +1,24 @@
+---
+---
 (function () {
 
   const searchWorker = new Worker('/assets/js/concept-search-worker.js');
 
-  // TODO: Move to a shared module
-  const LANGUAGES = [
-    'eng',
-    'ara',
-    'spa',
-    'swe',
-    'kor',
-    'rus',
-    'ger',
-    'fre',
-    'fin',
-    'jpn',
-    'dan',
-    'chi',
-  ];
+  /** For example:
+   *    const LANGUAGES = [ 'eng', 'deu' ];
+   *  Having a wrapper function helps not to break syntax highlight.
+   */
+  const LANGUAGES = (function() {
+    return {{ site.geolexica.term_languages | jsonify }} || [];
+  })();
+
+  /** For example:
+   *    const SEARCH_REFINEMENTS = [ 'validity' ];
+   *  Having a wrapper function helps not to break syntax highlight.
+   */
+  const SEARCH_REFINEMENTS = (function() {
+    return {{ site.geolexica.search.refinements | jsonify }} || [];
+  })();
 
 
   // React-based concept browser
@@ -57,7 +59,7 @@
       this.stringInputRef = React.createRef();
 
       this.state = {
-        valid: 'valid',  // Required value of the entry_status field, or undefined
+        valid: SEARCH_REFINEMENTS.indexOf('validity') >= 0 ? 'valid' : undefined,  // Required value of the entry_status field, or undefined
         string: '',
       };
     }
@@ -75,10 +77,10 @@
           onChange: this.handleSearchStringChange}),
       ];
 
-      if (this.state.string.length > 1 && (this.props.refineControls || []).length > 0) {
+      if (this.state.string.length > 1 && (SEARCH_REFINEMENTS).length > 0) {
         var refineControls = [];
 
-        if (this.props.refineControls.indexOf('validity') >= 0) {
+        if (SEARCH_REFINEMENTS.indexOf('validity') >= 0) {
           refineControls.push(
             el('div', { key: 'validity', className: 'validity' }, [
               el('input', {
@@ -218,7 +220,7 @@
         el('div', { key: 'search-controls', className: 'search-controls' },
           el(SearchControls, {
             onSearchChange: this.handleSearchQuery,
-            refineControls: ['validity'],
+            refineControls: SEARCH_REFINEMENTS,
           })
         ),
       ];
@@ -265,13 +267,7 @@
   ReactDOM.render(el(ConceptBrowser, null), document.querySelector('.browse-concepts'))
 
   function getConceptPermalink(concept) {
-    if (concept.termid) {
-      return `/concepts/${concept.termid}/`;
-    } else if (concept.id && concept.language_code) {
-      return `/concepts/${concept.id}/#entry-lang-${concept.language_code}`;
-    } else {
-      return null;
-    }
+    return concept.term_url;
   }
 
   function updateBodyClass({ searchQuery, expanded }) {

data/jekyll-geolexica.gemspec

@@ -43,6 +43,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "jekyll-asciidoc"
 
+  # Zeitwerk::Loader#push_dir supports :namespace argument from v. 2.4.
+  spec.add_runtime_dependency "zeitwerk", "~> 2.4"
+
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", ">= 10"

data/lib/jekyll-geolexica.rb

@@ -1,3 +1,6 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
 # The Jekyll convention is to use kebab-case in gem names only, even though
 # it conflicts with Ruby conventions.  This file is meant to bridge those
 # two conventions together, otherwise this plugin won't work if loaded

data/lib/jekyll/geolexica.rb

@@ -3,17 +3,33 @@
 
 require "jekyll"
 
+# Unfortunately, Zeitwerk::Loader.for_gem doesn't work well when gem's main
+# namespace is compound.
+require "zeitwerk"
+loader = Zeitwerk::Loader.new
+loader.tag = "jekyll-geolexica"
+loader.push_dir(File.join(__dir__, "geolexica"), namespace: Jekyll::Geolexica)
+loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
+loader.setup
+
 module Jekyll
   module Geolexica
+    # Loads Rake tasks which are provided in this gem.
+    #
+    # In order to load these tasks, following lines should be added to given
+    # site's Rakefile:
+    #
+    #   require "jekyll-geolexica"
+    #   ::Jekyll::Geolexica.load_tasks
+    def self.load_tasks
+      tasks_path = File.expand_path("../tasks", __dir__)
+      Rake.add_rakelib(tasks_path)
+    end
   end
 end
 
-require_relative "geolexica/configuration"
-require_relative "geolexica/concept_page"
-require_relative "geolexica/concept_serializer"
-require_relative "geolexica/concepts_generator"
-require_relative "geolexica/glossary"
-require_relative "geolexica/hooks"
-require_relative "geolexica/meta_pages_generator"
+# Jekyll-Geolexica must be loaded eagerly because Jekyll has no other way
+# to learn about gem's features.
+loader.eager_load
 
 Jekyll::Geolexica::Hooks.register_all_hooks

data/lib/jekyll/geolexica/concept_page.rb

@@ -26,7 +26,7 @@ module Jekyll
       def default_data
         {
           "layout" => layout,
-          "liquid" => uses_liquid,
+          "render_with_liquid" => uses_liquid,
           "permalink" => permalink,
           "representations" => concept.pages,
         }

data/lib/jekyll/geolexica/concept_serializer.rb

@@ -1,3 +1,6 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
 module Jekyll
   module Geolexica
     # A decorator responsible for serializing concepts in the most simplistic

data/lib/jekyll/geolexica/concepts_generator.rb

@@ -44,7 +44,7 @@ module Jekyll
       end
 
       def sort_pages
-        generated_pages.sort_by! { |p| p.termid.to_s }
+        generated_pages.sort_by! { |p| p.termid }
       end
 
       def initialize_collections

data/lib/jekyll/geolexica/filters.rb

@@ -0,0 +1,29 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
+module Jekyll
+  module Geolexica
+    module Filters
+      # Renders authoritative source hash as HTML.
+      #
+      # @param input [Hash] authoritative source hash.
+      # @return [String]
+      #
+      # TODO Maybe support string inputs.
+      def display_authoritative_source(input)
+        ref, clause, link = input.values_at("ref", "clause", "link") rescue nil
+
+        return "" if ref.nil? && link.nil?
+
+        ref_caption = escape_once(ref || link)
+        ref_part = link ? %[<a href="#{link}">#{ref_caption}</a>] : ref_caption
+
+        clause_part = clause && escape_once(clause)
+
+        [ref_part, clause_part].compact.join(", ")
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Geolexica::Filters)

data/lib/jekyll/geolexica/hooks.rb

@@ -1,3 +1,6 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
 module Jekyll
   module Geolexica
     module Hooks

data/lib/jekyll/geolexica/version.rb

@@ -3,6 +3,6 @@
 
 module Jekyll
   module Geolexica
-    VERSION = "1.4.0".freeze
+    VERSION = "1.5.3".freeze
   end
 end

data/lib/tasks/deploy.rake

@@ -0,0 +1,44 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
+namespace :geolexica do
+
+  desc "Deploy site to S3"
+  task :s3_deploy do
+    s3sync_patterns_and_options = {
+      "*.html" => ["--content-type", "text/html; charset=utf-8"],
+      "*.json" => ["--content-type", "application/json; charset=utf-8"],
+      "*.jsonld" => ["--content-type", "application/ld+json; charset=utf-8"],
+      "*.tbx.xml" => ["--content-type", "application/xml; charset=utf-8"],
+      "*.ttl" => ["--content-type", "text/turtle; charset=utf-8"],
+      "*.yaml" => ["--content-type", "text/yaml; charset=utf-8"],
+    }
+
+    s3sync_patterns_and_options.each_pair do |pattern, options|
+      s3_sync "--exclude", "*", "--include", pattern, *options
+    end
+
+    # Remaining files
+    remaining_patterns = s3sync_patterns_and_options.keys
+    s3_sync "--include", "*", *remaining_patterns.flat_map { |k| ["--exclude", k] }
+
+    aws "configure", "set", "preview.cloudfront", "true"
+
+    aws "cloudfront", "create-invalidation",
+      "--distribution-id", ENV["CLOUDFRONT_DISTRIBUTION_ID"],
+      "--paths", "/*"
+  end
+
+  def s3_sync(*args)
+    source = "_site"
+    target = "s3://#{ENV["S3_BUCKET_NAME"]}"
+    common_options = ["--region", ENV["AWS_REGION"], "--delete", "--no-progress"]
+
+    aws "s3", "sync", source, target, *common_options, *args
+  end
+
+  def aws(*args)
+    system "aws", *args, exception: true
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-geolexica
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.3
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -17,12 +17,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.8.5
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,12 +30,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.8.5
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: jekyll-asciidoc
   requirement: !ruby/object:Gem::Requirement
@@ -50,6 +50,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,7 +120,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-description:
+description: 
 email:
 - open.source@ribose.com
 executables: []
@@ -118,6 +132,7 @@ files:
 - _config.yml
 - _data/lang.yaml
 - _includes/analytics.html
+- _includes/committee-widget.html
 - _includes/concept-api-links.html
 - _includes/concept-header.html
 - _includes/concept-info.html
@@ -148,7 +163,7 @@ files:
 - _layouts/resource-page.html
 - _pages/404.adoc
 - _pages/api/rdf-profile.ttl
-- _pages/concepts-index-list.json
+- _pages/concept-search-index.json
 - _pages/concepts-index.json
 - _pages/concepts.adoc
 - _pages/index.adoc
@@ -186,10 +201,12 @@ files:
 - lib/jekyll/geolexica/concept_serializer.rb
 - lib/jekyll/geolexica/concepts_generator.rb
 - lib/jekyll/geolexica/configuration.rb
+- lib/jekyll/geolexica/filters.rb
 - lib/jekyll/geolexica/glossary.rb
 - lib/jekyll/geolexica/hooks.rb
 - lib/jekyll/geolexica/meta_pages_generator.rb
 - lib/jekyll/geolexica/version.rb
+- lib/tasks/deploy.rake
 - package-lock.json
 - package.json
 homepage: https://open.ribose.com/
@@ -199,7 +216,7 @@ metadata:
   bug_tracker_uri: https://github.com/geolexica/geolexica-server/issues
   homepage_uri: https://open.ribose.com/
   source_code_uri: https://github.com/geolexica/geolexica-server
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -214,8 +231,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Geolexica plugin for Jekyll
 test_files: []