jekyll-dictionaries 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36df1371462bb937a7af666ad4db6b25f286f5ade437a76f6b1ecfcabf6c5ffe
-  data.tar.gz: 546ec1819e6f760ec135d340820f11de48bf09d1f5d70bfdf63ebe79f647bc9c
+  metadata.gz: 0ae6fbb1a2c9e99134e6a3c2efa23a802b6b23b9a2990f3cb24de390d86e3b2a
+  data.tar.gz: daec5bcd991748fbcc89e55bc74f1c86998ad3d8d68ef3a11c4de77a792dcb7f
 SHA512:
-  metadata.gz: dc4e3620041b4f8e892ce2684f0030906cafdecac9e9e12a5ab8c0838e9749854c2e8390c1211e390650961cb21830610bb48077b99c7e2265ccfa085c6dc870
-  data.tar.gz: 1128d9b0a9c36e1ca95943e0db3600ca76d45b05e64ac049a2b033d61108f0a2b887865ff9bd761343d80e88dee0cd51a7ca5d25edf552cd0d5e4f5ab51bbd49
+  metadata.gz: f7ccbf3eb1883c6286a4059eaa019cb6975480e57eaeedd351cd8e23a2d1f9505b2a8cf500e733249d31085ada93d076997d8934934fc45e7b86942f5efedbc6
+  data.tar.gz: b9ad86763fa24cfc53ee6abfc77f0d052a2927db263b8a4e5f99fa9034a10ce6a26b55da14c6f988887face3cab1cd9c1f9be73e1d2ac3b8204e4610e8f7b931

data/.idea/workspace.xml

@@ -5,8 +5,25 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="a0de0db4-04ba-4a6e-9544-85d905789a03" name="Changes" comment="">
+      <change afterPath="$PROJECT_DIR$/lib/jekyll-dictionaries/generators/dictionaries.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/jekyll-dictionaries/generators/theme.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/jekyll-dictionaries/pages/dictionary.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/jekyll-dictionaries/pages/dictionary_api.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/spec/fixtures/jekyll/_includes/head.html" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/jekyll-dictionaries.gemspec" beforeDir="false" afterPath="$PROJECT_DIR$/jekyll-dictionaries.gemspec" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/jekyll-dictionaries.rb" beforeDir="false" afterPath="$PROJECT_DIR$/lib/jekyll-dictionaries.rb" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/jekyll-dictionaries/dictionary_api_page.rb" beforeDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/jekyll-dictionaries/dictionary_page.rb" beforeDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/jekyll-dictionaries/generator.rb" beforeDir="false" afterPath="$PROJECT_DIR$/lib/jekyll-dictionaries/generator.rb" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/spec/fixtures/jekyll/_config.yml" beforeDir="false" afterPath="$PROJECT_DIR$/spec/fixtures/jekyll/_config.yml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/spec/fixtures/jekyll/_layouts/dictionary.html" beforeDir="false" />
+      <change beforePath="$PROJECT_DIR$/spec/fixtures/jekyll/_layouts/dictionary_api.json" beforeDir="false" />
+      <change beforePath="$PROJECT_DIR$/spec/fixtures/snapshots/api/multiple.json" beforeDir="false" afterPath="$PROJECT_DIR$/spec/fixtures/snapshots/api/multiple.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/spec/fixtures/snapshots/api/single.json" beforeDir="false" afterPath="$PROJECT_DIR$/spec/fixtures/snapshots/api/single.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/spec/fixtures/snapshots/pages/multiple.html" beforeDir="false" afterPath="$PROJECT_DIR$/spec/fixtures/snapshots/pages/multiple.html" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/spec/fixtures/snapshots/pages/single.html" beforeDir="false" afterPath="$PROJECT_DIR$/spec/fixtures/snapshots/pages/single.html" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -44,16 +61,17 @@
   <component name="RecentsManager">
     <key name="CopyFile.RECENT_KEYS">
       <recent name="$PROJECT_DIR$/spec/fixtures/snapshots/pages" />
+      <recent name="$PROJECT_DIR$/spec/fixtures/snapshots/api" />
       <recent name="$PROJECT_DIR$/spec/fixtures/jekyll" />
       <recent name="$PROJECT_DIR$" />
       <recent name="$PROJECT_DIR$/.idea" />
     </key>
     <key name="MoveFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/lib/jekyll-dictionaries/pages" />
+      <recent name="$PROJECT_DIR$/lib/jekyll-dictionaries/generators" />
+      <recent name="$PROJECT_DIR$/_includes/dictionary" />
       <recent name="$PROJECT_DIR$/" />
       <recent name="$PROJECT_DIR$/spec/fixtures/snapshots/pages" />
-      <recent name="$PROJECT_DIR$/spec/fixtures/jekyll" />
-      <recent name="$PROJECT_DIR$" />
-      <recent name="$PROJECT_DIR$/spec/fixtures/snapshots/api" />
     </key>
   </component>
   <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
@@ -67,7 +85,7 @@
       <updated>1696301317963</updated>
       <workItem from="1696301319406" duration="9538000" />
       <workItem from="1696310885150" duration="15107000" />
-      <workItem from="1696338033417" duration="9652000" />
+      <workItem from="1696338033417" duration="29066000" />
     </task>
     <servers />
   </component>

data/README.md

@@ -7,8 +7,8 @@ Welcome to the Jekyll Dictionaries Plugin project! This open-source project allo
 
 ## Table of Contents
 
+- [Intro](#intro)
 - [Installation](#installation)
-- [Usage](#usage)
 - [Dictionaries Structure](#dictionaries-structure)
 - [Dictionary Types](#dictionary-types)
     - [1. Single Translation Dictionary](#1-single-translation-dictionary)
@@ -23,103 +23,46 @@ Welcome to the Jekyll Dictionaries Plugin project! This open-source project allo
 - [Push New Version Commands](#push-new-version-commands)
 - [License](#license)
 
+## Intro
+
+The plugin will automatically generate dictionary and dictionary api pages for all dictionaries located into folder `_data/dictionaries` of jekyll project.
+
 ## Installation
 
-Add this line to your site's Gemfile:
+1. Add this line to your site's Gemfile:
 
 ```ruby
 gem 'jekyll-dictionaries'
 ```
 
-Generate 2 layouts for dictionary documentation and api:
+2. Include `dictionary/head.html` into default layout to add custom styles of the plugin (the plugin styles are added as inline css styles and it might be updated if it's needed):
 
-**_layouts/dictionary_api.json:**
-
-```liquid
----
----
-{% assign content = page.content | jsonify %}{% assign docPage = page.related_page %}{% if docPage %}{"docPath":"{{ docPage.url | absolute_url }}",{{ content | remove_first: '{' }}{% else %}{{ content }}{% endif %}
+```html
+<head>
+  ...
+   {% include dictionaries/head.html %}
+</head>
 ```
 
-**_layouts/dictionary.html:**
-
-```liquid
----
-layout: page
----
-
-<h1>Info</h1>
-<table>
-    <tbody>
-    <tr>
-        <th>Name</th>
-        <td>{{ page.content.name }}</td>
-    </tr>
-    <tr>
-        <th>Version</th>
-        <td>{{ page.content.version }}</td>
-    </tr>
-    <tr>
-        <th>Learning</th>
-        <td>{{ page.content.learning }}</td>
-    </tr>
-
-    <tr>
-        <th>Translation Type</th>
-        <td>{{ page.content.translationType }}</td>
-    </tr>
-
-    {% if page.content.translationType == 'multiple' %}
-
-    <tr>
-        <th>Translations</th>
-        <td>{{ page.content.translations | join: ', ' }}</td>
-    </tr>
-    {% endif %}
-
-    {% assign apiPage = page.related_page %}
-
-    {% if apiPage %}
-
-    <tr>
-        <th> <a href="{{ apiPage.url | relative_url }}" target="_blank">API LINK</a> </th>
-        <td>
-            <button onclick="copyToClipboard('{{ apiPage.url | absolute_url }}')">Copy to Clipboard</button>
-        </td>
-    </tr>
-    {% endif %}
-
-
-    </tbody>
-</table>
-
-<script>
-    function copyToClipboard(text) {
-        // Copy the text inside the text field
-        navigator.clipboard.writeText(text);
-    }
-</script>
+3. Include `dictionaries/list.html` into index page to show a list of available dictionaries:
+
+```html
+  {% include dictionaries/list.html %}
 ```
 
-And then add this lines to your site's `_config.yml`:
+4. (OPTIONAL) Also it's possible to change layout and permalink of dictionary pages on site's `_config.yml`:
 
 ```yml
-plugins:
-  - jekyll-dictionaries
-
 dictionaries:
-  dictionary:
-    layout: dictionary
-    permalink: dictionaries/:name
-  dictionary_api:
-    layout: dictionary_api
-    permalink: api/dictionaries/:name.json
+  pages:
+    dictionary:
+      layout: dictionary
+      permalink: dictionaries/:name
+    dictionary_api:
+      layout: dictionary_api
+      permalink: api/dictionaries/:name.json
 ```
 
-## Usage
-
-The plugin will automatically generate dictionary and dictionary api pages for all dictionaries located into folder `_data/dictionaries` of jekyll project.
-
 ## Dictionaries Structure
 
 The dictionaries in this project have a specific structure that consists of the following components:
@@ -336,7 +279,7 @@ _data/dictionaries/single/unit1/numbers.json
 The plugin will generate JSON API **/api/dictionaries/single.json**
 
 ```json
-{"docPath":"http://example.org/dictionaries/single","version":"1.0.0","name":"Basic (One Language)","translationType":"single","learning":"es","data":[{"name":"Greetings","type":"collection","data":[{"learning":"¡Hola!","primary":"Hello!"}]},{"type":"folder","name":"unit1","data":[{"name":"numbers","type":"collection","data":[{"primary":"one","learning":"uno"},{"primary":"two","learning":"dos"},{"primary":"three","learning":"tres"},{"primary":"four","learning":"cuatro"},{"primary":"five","learning":"cinco"},{"primary":"six","elearnings":"seis"},{"primary":"seven","learning":"siete"},{"primary":"eight","learning":"ocho"},{"primary":"nine","learning":"nueve"},{"primary":"ten","learning":"diez"}]}]}]}
+{"docUrl":"http://example.org/dictionaries/single","version":"1.0.0","name":"Basic (One Language)","translationType":"single","learning":"es","data":[{"name":"Greetings","type":"collection","data":[{"learning":"¡Hola!","primary":"Hello!"}]},{"type":"folder","name":"unit1","data":[{"name":"numbers","type":"collection","data":[{"primary":"one","learning":"uno"},{"primary":"two","learning":"dos"},{"primary":"three","learning":"tres"},{"primary":"four","learning":"cuatro"},{"primary":"five","learning":"cinco"},{"primary":"six","elearnings":"seis"},{"primary":"seven","learning":"siete"},{"primary":"eight","learning":"ocho"},{"primary":"nine","learning":"nueve"},{"primary":"ten","learning":"diez"}]}]}]}
 ```
 
 ### 2. Multiple Translations Dictionary Example
@@ -477,7 +420,7 @@ _data/dictionaries/multiple/unit1/numbers.json
 The plugin will generate JSON API **/api/dictionaries/multiple.json**
 
 ```json
-{"docPath":"http://example.org/dictionaries/multiple","version":"1.0.0","name":"Basic (Multiple Languages)","translationType":"multiple","learning":"es","translations":["en","ru","de","fr","pt"],"data":[{"name":"Greetings","type":"collection","data":[{"learning":"¡Hola!","en":"Hello!","ru":"Привет!","de":"Hallo!","fr":"Bonjour!","pt":"Olá!"}]},{"type":"folder","name":"Unit 1","data":[{"name":"numbers","type":"collection","data":[{"learning":"uno","en":"one","ru":"один","de":"eins","fr":"un","pt":"um"},{"learning":"dos","en":"two","ru":"два","de":"zwei","fr":"deux","pt":"dois"},{"learning":"tres","en":"three","ru":"три","de":"drei","fr":"trois","pt":"três"},{"learning":"cuatro","en":"four","ru":"четыре","de":"vier","fr":"quatre","pt":"quatro"},{"learning":"cinco","en":"five","ru":"пять","de":"fünf","fr":"cinq","pt":"cinco"},{"learning":"seis","en":"six","ru":"шесть","de":"sechs","fr":"six","pt":"seis"},{"learning":"siete","en":"seven","ru":"семь","de":"sieben","fr":"sept","pt":"sete"},{"learning":"ocho","en":"eight","ru":"восемь","de":"acht","fr":"huit","pt":"oito"},{"learning":"nueve","en":"nine","ru":"девять","de":"neun","fr":"neuf","pt":"nove"},{"learning":"diez","en":"ten","ru":"десять","de":"zehn","fr":"dix","pt":"dez"}]}]}]}
+{"docUrl":"http://example.org/dictionaries/multiple","version":"1.0.0","name":"Basic (Multiple Languages)","translationType":"multiple","learning":"es","translations":["en","ru","de","fr","pt"],"data":[{"name":"Greetings","type":"collection","data":[{"learning":"¡Hola!","en":"Hello!","ru":"Привет!","de":"Hallo!","fr":"Bonjour!","pt":"Olá!"}]},{"type":"folder","name":"Unit 1","data":[{"name":"numbers","type":"collection","data":[{"learning":"uno","en":"one","ru":"один","de":"eins","fr":"un","pt":"um"},{"learning":"dos","en":"two","ru":"два","de":"zwei","fr":"deux","pt":"dois"},{"learning":"tres","en":"three","ru":"три","de":"drei","fr":"trois","pt":"três"},{"learning":"cuatro","en":"four","ru":"четыре","de":"vier","fr":"quatre","pt":"quatro"},{"learning":"cinco","en":"five","ru":"пять","de":"fünf","fr":"cinq","pt":"cinco"},{"learning":"seis","en":"six","ru":"шесть","de":"sechs","fr":"six","pt":"seis"},{"learning":"siete","en":"seven","ru":"семь","de":"sieben","fr":"sept","pt":"sete"},{"learning":"ocho","en":"eight","ru":"восемь","de":"acht","fr":"huit","pt":"oito"},{"learning":"nueve","en":"nine","ru":"девять","de":"neun","fr":"neuf","pt":"nove"},{"learning":"diez","en":"ten","ru":"десять","de":"zehn","fr":"dix","pt":"dez"}]}]}]}
 ```
 
 As you can see collection `greetings` and folder `un1` have names that are defined by property `name`.
@@ -486,11 +429,10 @@ As you can see collection `greetings` and folder `un1` have names that are defin
 
 ```bash
  gem bump
- 
+ gem build jekyll-dictionaries.gemspec
+ gem push jekyll-dictionaries-1.0.2.gem
 ```
 
-
-
 ## License
 
 This project is licensed under the MIT License.

data/_includes/dictionaries/accordion.html

@@ -0,0 +1,16 @@
+<script>
+    var acc = document.getElementsByClassName("accordion");
+    var i;
+
+    for (i = 0; i < acc.length; i++) {
+        acc[i].addEventListener("click", function () {
+            this.classList.toggle("active");
+            var panel = this.nextElementSibling;
+            if (panel.style.display === "block") {
+                panel.style.display = "none";
+            } else {
+                panel.style.display = "block";
+            }
+        });
+    }
+</script>

data/_includes/dictionaries/collectionItem.html

@@ -0,0 +1,4 @@
+<p>{{ include.value }}</p>
+{% if include.note %}
+<p>({{ include.note }})</p>
+{% endif %}

data/_includes/dictionaries/collectionName.html

@@ -0,0 +1,2 @@
+{% capture icon %}{% if include.item.type == 'folder' %}<i class="accordion-icon fa fa-folder" aria-hidden="true"></i>{% endif %}{% endcapture %}
+<button class="accordion">{{ icon}} {{ include.item.name }}</button>

data/_includes/dictionaries/head.html

@@ -0,0 +1,37 @@
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/all.min.css" integrity="sha512-z3gLpd7yknf1YoNbCzqRKc4qyor8gaKU1qmn+CShxbuBusANI9QpRohGBreCFkKxLhei6S9CQXFEbbKuqLg0DA==" crossorigin="anonymous" referrerpolicy="no-referrer" />
+
+<style>
+    .accordion {
+        background-color: #eee;
+        color: #444;
+        cursor: pointer;
+        padding: 18px;
+        width: 100%;
+        border: none;
+        text-align: left;
+        outline: none;
+        font-size: 15px;
+        transition: 0.4s;
+        margin: 5px 0;
+    }
+    .accordion.active, .accordion:hover {
+        background-color: #ccc;
+    }
+    .accordion-panel {
+        padding: 5px;
+        padding-right: 0;
+        padding-left: 0;
+        display: none;
+        background-color: white;
+        overflow: hidden;
+    }
+    .accordion-panel.folder-container {
+        padding-left: 10px;
+    }
+    .accordion-icon {
+        margin-right: 10px;
+    }
+    .dictionary-list .list-header {
+        margin-bottom: 20px;
+    }
+</style>

data/_includes/dictionaries/list.html

@@ -0,0 +1,13 @@
+<div class="dictionary-list">
+    <h2 class="list-header">Dictionary APIs</h2>
+    {% assign dictPages = site.pages | where_exp: "item", "item.scope == 'dictionary'" %}
+    {% if dictPages.size > 0 %}
+    <ul>
+        {% for page in dictPages %}
+        <li>
+            <a href="{{ page.url | relative_url }}" target="blank">{{ page.name | escape }}</a>
+        </li>
+        {% endfor %}
+    </ul>
+    {% endif %}
+</div>

data/_includes/dictionaries/multiple/collection.html

@@ -0,0 +1,24 @@
+<table>
+    <thead>
+        <tr>
+            <th>Learning</th>
+            {% for translation in include.translations %}
+                <th>{{ translation }}</th>
+            {% endfor %}
+        </tr>
+    </thead>
+    <tbody>
+        {% for item in include.items %}
+        <tr>
+            <td>
+                {% include dictionaries/collectionItem.html value=item.learning note=item.notes.learning %}
+            </td>
+            {% for translation in include.translations %}
+                {% assign value = item[translation] %}
+                {% assign note = item.notes[translation] %}
+                <td>{% include dictionaries/collectionItem.html value=value note=note %}</td>
+            {% endfor %}
+        </tr>
+        {% endfor %}
+    </tbody>
+</table>

data/_includes/dictionaries/multiple/container.html

@@ -0,0 +1,13 @@
+{% for item in include.items %}
+
+{% include dictionaries/collectionName.html item=item %}
+
+<div class="accordion-panel {{ item.type }}-container">
+  {% case item.type %}
+  {% when "folder" %}
+    {% include dictionaries/multiple/container.html items=item.data translations=include.translations %}
+  {% when "collection" %}
+    {% include dictionaries/multiple/collection.html items=item.data translations=include.translations %}
+  {% endcase %}
+</div>
+{% endfor %}

data/_includes/dictionaries/single/collection.html

@@ -0,0 +1,20 @@
+<table>
+    <thead>
+        <tr>
+            <th>Learning</th>
+            <th>Primary</th>
+        </tr>
+    </thead>
+    <tbody>
+        {% for item in include.items %}
+        <tr>
+            <td>
+                {% include dictionaries/collectionItem.html value=item.learning note=item.notes.learning %}
+            </td>
+            <td>
+                {% include dictionaries/collectionItem.html value=item.primary note=item.notes.primary %}
+            </td>
+        </tr>
+        {% endfor %}
+    </tbody>
+</table>

data/_includes/dictionaries/single/container.html

@@ -0,0 +1,13 @@
+{% for item in include.items %}
+
+{% include dictionaries/collectionName.html item=item %}
+
+<div class="accordion-panel {{ item.type }}-container">
+  {% case item.type %}
+  {% when "folder" %} 
+    {% include dictionaries/single/container.html items=item.data %}
+  {% when "collection" %}
+    {% include dictionaries/single/collection.html items=item.data %}
+  {% endcase %}
+</div>
+{% endfor %}

data/_layouts/dictionary.html

@@ -0,0 +1,63 @@
+---
+layout: page
+---
+
+<h1>Info</h1>
+<table>
+    <tbody>
+    <tr>
+        <th>Name</th>
+        <td>{{ page.content.name }}</td>
+    </tr>
+    <tr>
+        <th>Version</th>
+        <td>{{ page.content.version }}</td>
+    </tr>
+    <tr>
+        <th>Learning</th>
+        <td>{{ page.content.learning }}</td>
+    </tr>
+
+    <tr>
+        <th>Translation Type</th>
+        <td>{{ page.content.translationType }}</td>
+    </tr>
+
+    {% if page.content.translationType == 'multiple' %}
+
+    <tr>
+        <th>Translations</th>
+        <td>{{ page.content.translations | join: ', ' }}</td>
+    </tr>
+    {% endif %}
+
+    {% assign apiPage = page.related_page %}
+
+    {% if apiPage %}
+
+    <tr>
+        <th> <a href="{{ apiPage.url | relative_url }}" target="_blank">API LINK</a> </th>
+        <td>
+            <button onclick="copyToClipboard('{{ apiPage.url | absolute_url }}')">Copy to Clipboard</button>
+        </td>
+    </tr>
+    {% endif %}
+
+
+    </tbody>
+</table>
+
+{% if page.content.translationType == 'single' %}
+    {% include dictionaries/single/container.html items=page.content.data prefix='dict-level' %}
+{% else %}
+    {% include dictionaries/multiple/container.html items=page.content.data translations=page.content.translations prefix='dict-level' %}
+{% endif %}
+
+{% include dictionaries/accordion.html %}
+
+<script>
+    function copyToClipboard(text) {
+        // Copy the text inside the text field
+        navigator.clipboard.writeText(text);
+    }
+</script>

data/_layouts/dictionary_api.json

@@ -0,0 +1,3 @@
+---
+---
+{% assign content = page.content | jsonify %}{% assign docPage = page.related_page %}{% if docPage %}{"docUrl":"{{ docPage.url | absolute_url }}",{{ content | remove_first: '{' }}{% else %}{{ content }}{% endif %}

data/jekyll-dictionaries.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["hinkoulabs"]
   spec.email = ["siarhei.hinkou@hinkoulabs.com"]
 
-  spec.summary = "A Jekyll plugin to generate JSON dictionaries for language learning applications"
+  spec.summary = "A Jekyll theme plugin to generate JSON dictionaries for language learning applications"
   spec.homepage = "https://github.com/hinkoulabs/jekyll-dictionaries"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'minima', '~> 2.5'
 end

data/lib/jekyll-dictionaries/generator.rb

@@ -1,73 +1,53 @@
-require_relative './dictionary_page'
-require_relative './dictionary_api_page'
+require_relative 'pages/dictionary'
+require_relative 'pages/dictionary_api'
+
+require_relative 'generators/dictionaries'
+require_relative 'generators/theme'
 
 module JekyllDictionaries
   class Generator < Jekyll::Generator
-    DICT_REGEX = /^_(.*)/
+    CONFIG = {
+      'pages' => {
+        'dictionary' => {
+          'layout' => 'dictionary',
+          'permalink' => 'dictionaries/:name'
+        },
+        'dictionary_api' => {
+          'layout' => 'dictionary_api',
+          'permalink' => 'api/dictionaries/:name.json'
+        }
+      }
+    }
 
     safe true
 
     def generate(site)
       @site = site
-      dicts = site.data['dictionaries'].inject([]) do |memo, (k, v)|
-        # dictionary start with _
-        m = k.match(DICT_REGEX)
-        if m
-          dict = v.merge('data' => [])
-
-          name = m[1]
-
-          folder = site.data['dictionaries'][name]
-
-          if (folder)
-            dict['data'] = build_collections(folder)
-          end
 
-          memo << OpenStruct.new(filename: name, content: dict)
-        end
-        memo
-      end
-
-      dicts.each do |dict|
-        api_page = DictionaryApiPage.new(site, dict, config)
-        doc_page = DictionaryPage.new(site, dict, config)
+      Generators::Theme.new(site).generate
 
-        api_page.related_page = doc_page
-        doc_page.related_page = api_page
+      dictionaries = Generators::Dictionaries.new(site).generate
 
-        site.pages << api_page
-        site.pages << doc_page
+      dictionaries.each do |dictionary|
+        build_dictionary_pages(dictionary)
       end
     end
 
     protected
 
     def config
-      @config ||= @site.config["dictionaries"] || {}
+      @config ||= Jekyll::Utils.deep_merge_hashes(CONFIG, @site.config["dictionaries"] || {})
     end
 
-    def build_collections(folder_content)
-      folder_content.inject([]) do |memo, (k, v)|
-        if v.is_a?(Hash)
-          # collection is detected
-          if (v['type'] == 'collection')
-            # set k as title if title is missing
-            memo << { 'name' => v['name'] || k }.merge(v)
-          else
-            metadata = v['_metadata']
-            # folder is detected
-            memo
-            folder = {
-              'type' => 'folder',
-              'name' => metadata ? metadata['name'] : k,
-              'data' => build_collections(v.select { |kk, _| kk != '_metadata' })
-            }
-            memo << folder
-          end
-        end
+    def build_dictionary_pages(dictionary)
+      api_page = Pages::DictionaryApi.new(@site, dictionary, config['pages']['dictionary_api'])
+      doc_page = Pages::Dictionary.new(@site, dictionary, config['pages']['dictionary'])
 
-        memo
-      end
+      api_page.related_page = doc_page
+      doc_page.related_page = api_page
+
+      @site.pages << api_page
+      @site.pages << doc_page
     end
   end
 end

data/lib/jekyll-dictionaries/generators/dictionaries.rb

@@ -0,0 +1,62 @@
+module JekyllDictionaries
+  module Generators
+    class Dictionaries
+      DICT_REGEX = /^_(.*)/
+
+      def initialize(site)
+        @site = site
+      end
+
+      def generate
+        build_dictionaries_from_data
+      end
+
+      protected
+
+      def build_dictionaries_from_data
+        @site.data['dictionaries'].inject([]) do |memo, (k, v)|
+          # dictionary start with _
+          m = k.match(DICT_REGEX)
+          if m
+            dict = v.merge('data' => [])
+
+            name = m[1]
+
+            folder = @site.data['dictionaries'][name]
+
+            if (folder)
+              dict['data'] = build_collections(folder)
+            end
+
+            memo << OpenStruct.new(filename: name, content: dict)
+          end
+          memo
+        end
+      end
+
+      def build_collections(folder_content)
+        folder_content.inject([]) do |memo, (k, v)|
+          if v.is_a?(Hash)
+            # collection is detected
+            if (v['type'] == 'collection')
+              # set k as title if title is missing
+              memo << { 'name' => v['name'] || k }.merge(v)
+            else
+              metadata = v['_metadata']
+              # folder is detected
+              memo
+              folder = {
+                'type' => 'folder',
+                'name' => metadata ? metadata['name'] : k,
+                'data' => build_collections(v.select { |kk, _| kk != '_metadata' })
+              }
+              memo << folder
+            end
+          end
+
+          memo
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-dictionaries/generators/theme.rb

@@ -0,0 +1,61 @@
+require 'delegate'
+
+module JekyllDictionaries
+  module Generators
+    class Theme
+      attr_reader :site, :theme
+      def initialize(site)
+        @site = site
+      end
+
+      def generate
+        add_includes
+        add_layouts
+      end
+
+      protected
+
+      def theme
+        @theme ||= Jekyll::Theme.new("jekyll-dictionaries")
+      end
+
+      def add_includes
+        @site.includes_load_paths << theme.includes_path
+      end
+
+      def add_layouts
+        layouts_path = theme.layouts_path
+        wrap_custom_theme do
+          entries_in(layouts_path).each do |layout_file|
+            @site.layouts[theme_file_name(layout_file)] ||= Jekyll::Layout.new(@site, layouts_path, layout_file)
+          end
+        end
+      end
+
+      def wrap_custom_theme
+        site_theme = @site.theme
+        @site.theme = theme
+        yield
+        @site.theme = site_theme
+      end
+
+      def entries_in(dir)
+        entries = []
+        within(dir) do
+          entries = Jekyll::EntryFilter.new(@site).filter(Dir["**/*.*"])
+        end
+        entries
+      end
+
+      def within(directory)
+        return unless File.exist?(directory)
+
+        Dir.chdir(directory) { yield }
+      end
+
+      def theme_file_name(file)
+        file.split(".")[0..-2].join(".")
+      end
+    end
+  end
+end

data/lib/jekyll-dictionaries/pages/dictionary.rb

@@ -0,0 +1,53 @@
+module JekyllDictionaries
+  module Pages
+    class Dictionary < Jekyll::Page
+      attr_accessor :type
+      attr_reader :related_page
+
+      def initialize(site, dic, default_opts)
+        @site = site # the current site instance.
+        @base = site.source # path to the source directory.
+        @dir = dic.filename # the directory the page will reside in.
+
+        add_scope_data
+
+        # All pages have the same filename, so define attributes straight away.
+        @basename = dic.filename # filename without the extension.
+        @name = dic.content['name'] || dic.filename # basically @basename + @ext.
+
+        # Initialize data hash with a key pointing to all posts under current category.
+        # This allows accessing the list in a template via `page.linked_docs`.
+        @data = {
+          'content' => dic.content,
+          'scope' => @type
+        }
+
+        # Look up front matter defaults scoped to type `dictionary`, if given key
+        # doesn't exist in the `data` hash.
+        data.default_proc = proc do |_, key|
+          (default_opts || {})[key]
+        end
+      end
+
+      def related_page=(page)
+        @related_page = page
+        @data['related_page'] = @related_page
+      end
+
+      def add_scope_data
+        @type = :dictionary
+        @ext = '.html'
+      end
+
+      # Placeholders that are used in constructing page URL.
+      def url_placeholders
+        {
+          :path => @dir,
+          :name => @dir,
+          :basename => basename,
+          :output_ext => output_ext,
+        }
+      end
+    end
+  end
+end

data/lib/jekyll-dictionaries/pages/dictionary_api.rb

@@ -0,0 +1,12 @@
+require_relative 'dictionary'
+
+module JekyllDictionaries
+  module Pages
+    class DictionaryApi < Dictionary
+      def add_scope_data
+        @type = :dictionary_api
+        @ext = '.json'
+      end
+    end
+  end
+end

data/lib/jekyll-dictionaries/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllDictionaries
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/lib/jekyll-dictionaries.rb

@@ -4,9 +4,6 @@ require "jekyll"
 require "jekyll-dictionaries/generator"
 
 module JekyllDictionaries
-  autoload :DictionaryPage, "jekyll-dictionaries/dictionary_page.rb"
-  autoload :DictionaryApiPage, "jekyll-dictionaries/dictionary_api_page.rb"
-
   def self.root
     File.dirname __dir__
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-dictionaries
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - hinkoulabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2023-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minima
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description:
 email:
 - siarhei.hinkou@hinkoulabs.com
@@ -44,11 +58,25 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- _includes/.DS_Store
+- _includes/dictionaries/accordion.html
+- _includes/dictionaries/collectionItem.html
+- _includes/dictionaries/collectionName.html
+- _includes/dictionaries/head.html
+- _includes/dictionaries/list.html
+- _includes/dictionaries/multiple/collection.html
+- _includes/dictionaries/multiple/container.html
+- _includes/dictionaries/single/collection.html
+- _includes/dictionaries/single/container.html
+- _layouts/dictionary.html
+- _layouts/dictionary_api.json
 - jekyll-dictionaries.gemspec
 - lib/jekyll-dictionaries.rb
-- lib/jekyll-dictionaries/dictionary_api_page.rb
-- lib/jekyll-dictionaries/dictionary_page.rb
 - lib/jekyll-dictionaries/generator.rb
+- lib/jekyll-dictionaries/generators/dictionaries.rb
+- lib/jekyll-dictionaries/generators/theme.rb
+- lib/jekyll-dictionaries/pages/dictionary.rb
+- lib/jekyll-dictionaries/pages/dictionary_api.rb
 - lib/jekyll-dictionaries/version.rb
 homepage: https://github.com/hinkoulabs/jekyll-dictionaries
 licenses:
@@ -73,5 +101,6 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: A Jekyll plugin to generate JSON dictionaries for language learning applications
+summary: A Jekyll theme plugin to generate JSON dictionaries for language learning
+  applications
 test_files: []

data/lib/jekyll-dictionaries/dictionary_api_page.rb

@@ -1,10 +0,0 @@
-require_relative './dictionary_page'
-
-module JekyllDictionaries
-  class DictionaryApiPage < DictionaryPage
-    def add_scope_data
-      @type = :dictionary_api
-      @ext = '.json'
-    end
-  end
-end

data/lib/jekyll-dictionaries/dictionary_page.rb

@@ -1,51 +0,0 @@
-module JekyllDictionaries
-  class DictionaryPage < Jekyll::Page
-    attr_accessor :type
-    attr_reader :related_page
-
-    def initialize(site, dic, default_opts)
-      @site = site # the current site instance.
-      @base = site.source # path to the source directory.
-      @dir = dic.filename # the directory the page will reside in.
-
-      add_scope_data
-
-      # All pages have the same filename, so define attributes straight away.
-      @basename = dic.filename # filename without the extension.
-      @name = dic.content['name'] || dic.filename # basically @basename + @ext.
-
-      # Initialize data hash with a key pointing to all posts under current category.
-      # This allows accessing the list in a template via `page.linked_docs`.
-      @data = {
-        'content' => dic.content,
-        'scope' => @type
-      }
-
-      # Look up front matter defaults scoped to type `dictionary`, if given key
-      # doesn't exist in the `data` hash.
-      data.default_proc = proc do |_, key|
-        (default_opts[@type.to_s] || {})[key]
-      end
-    end
-
-    def related_page=(page)
-      @related_page = page
-      @data['related_page'] = @related_page
-    end
-
-    def add_scope_data
-      @type = :dictionary
-      @ext = '.html'
-    end
-
-    # Placeholders that are used in constructing page URL.
-    def url_placeholders
-      {
-        :path => @dir,
-        :name => @dir,
-        :basename => basename,
-        :output_ext => output_ext,
-      }
-    end
-  end
-end