jekyll-dictionaries 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0764c62ab68f291ad64d37b37ea0af0e7e562e3d3a3ad3d275ba49957f20ca3
+  data.tar.gz: c551767a61e5bca0134f6e1e4f474dee01d834a24cb46af50d73f8922262215c
+SHA512:
+  metadata.gz: 7f6d651e768b5701498d4e5cedd539d211eedce85140b1044a021f646933e19b993e8426c94f5fd95f5768da5050fbfaec984663ca41c4f682f7a1a3a0d92bdc
+  data.tar.gz: 11c1c8461223bb29e3d8ecd293ef277c8ff752d188bacc357117a69679bae9732e388a0ce7920dfa6e51deb5d4a776f94c5b04b356d5c7aafd3a9ab87c306d72

data/.idea/jekyll-dictionaries.iml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake" />
+    </option>
+  </component>
+</module>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="RVM: ruby-2.6.2 [market_analytics]" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.idea/workspace.xml

@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AutoImportSettings">
+    <option name="autoReloadType" value="SELECTIVE" />
+  </component>
+  <component name="ChangeListManager">
+    <list default="true" id="a0de0db4-04ba-4a6e-9544-85d905789a03" name="Changes" comment="">
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="MarkdownSettingsMigration">
+    <option name="stateVersion" value="1" />
+  </component>
+  <component name="ProjectId" id="2WEcjgC80wlCjXuxXvYFq2ebd1H" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;WebServerToolWindowFactoryState&quot;: &quot;false&quot;,
+    &quot;last_opened_file_path&quot;: &quot;/Users/s.ginkov/Work/Hinkou Labs/jekyll-dictionaries/spec/fixtures/jekyll&quot;,
+    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
+    &quot;node.js.detected.package.tslint&quot;: &quot;true&quot;,
+    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
+    &quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;,
+    &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
+    &quot;ruby.rails.projectView.checked&quot;: &quot;true&quot;,
+    &quot;ruby.structure.view.model.defaults.configured&quot;: &quot;true&quot;,
+    &quot;settings.editor.selected.configurable&quot;: &quot;org.jetbrains.plugins.ruby.settings.RubyActiveModuleSdkConfigurable&quot;,
+    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
+  }
+}</component>
+  <component name="RecentsManager">
+    <key name="CopyFile.RECENT_KEYS">
+      <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$/" />
+      <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" />
+  <component name="SpringUtil" SPRING_PRE_LOADER_OPTION="true" RAKE_SPRING_PRE_LOADER_OPTION="true" RAILS_SPRING_PRE_LOADER_OPTION="true" />
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="a0de0db4-04ba-4a6e-9544-85d905789a03" name="Changes" comment="" />
+      <created>1696301317963</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1696301317963</updated>
+      <workItem from="1696301319406" duration="9538000" />
+      <workItem from="1696310885150" duration="15107000" />
+      <workItem from="1696338033417" duration="6149000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+</project>

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/History.markdown

@@ -0,0 +1,3 @@
+## 0.1.0 / 2023-10-03
+
+* Created a gem with basic dictionary support

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 hinkoulabs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,483 @@
+# Jekyll Dictionaries Plugin
+
+Welcome to the Jekyll Dictionaries Plugin project! This open-source project allows you to create and share JSON dictionaries that can be accessed via a public API for language learning in mobile applications.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Dictionaries Structure](#dictionaries-structure)
+- [Dictionary Types](#dictionary-types)
+    - [1. Single Translation Dictionary](#1-single-translation-dictionary)
+    - [2. Multiple Translations Dictionary](#2-multiple-translations-dictionary)
+- [Object Properties](#object-properties)
+    - [1. Dictionary Object](#1-dictionary-object)
+    - [2. Collection Object](#2-collection-object)
+    - [3. Folder Object](#3-folder-object)
+- [Dictionary Types Examples](#dictionary-types-examples)
+    - [1. Single Translation Dictionary Example](#1-single-translation-dictionary-example)
+    - [2. Multiple Translations Dictionary Example](#2-multiple-translations-dictionary-example)
+- [License](#license)
+
+## Installation
+
+Add this line to your site's Gemfile:
+
+```ruby
+gem 'jekyll-dictionaries'
+```
+
+Generate 2 layouts for dictionary documentation and api:
+
+**_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 %}
+```
+
+**_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>
+```
+
+And then add this lines to your 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
+```
+
+## 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:
+
+### Root Directory
+
+The root directory for dictionaries is `_data/dictionaries`. It contains JSON files that start with an underscore `_` as well as folders that have names similar to the files but without the underscore. These folders act as containers for dictionary collections and can be nested.
+
+### Collection Files
+
+1. **Any JSON File**: Any JSON file within a folder is detected as a collection file. A collection file is a JSON object that can be used to set translations.
+
+2. **"_metadata.json" (Optional)**: This file can be added inside nested folders to set folder details for the API. If this file is missing, the folder name will be used as the container name for the dictionaries in the API response. For example, if there is a folder named "greetings," and a developer wants to use a specific name for the folder in the API, they can add the file "_metadata.json" into the folder with data `{"name": "Greetings"}`. As a result, the plugin will generate an API where the folder name will be "Greetings."
+
+## Dictionary Types
+
+This project supports two types of dictionaries:
+
+### 1. Single Translation Dictionary
+
+A "single translation" dictionary is used to generate a dictionary for a selected learning language, with translations available in any other languages. The JSON structure for a "single translation" dictionary and its collections is as follows:
+
+**_data/dictionaries/_single_dictionary.json:**
+
+```json
+{
+    "version": "1.0.0",
+    "name": "Simple",
+    "translationType": "single",
+    "learning": "es"
+}
+```
+
+In this example, the learning language is set on the dictionary data with the "learning" field (using ISO 639-1 language codes).
+
+**_data/dictionaries/single_dictionary/greetings.json:**
+
+```json
+{
+    "name": "Greetings",
+    "type": "collection",
+    "data": [
+        {"learning":"¡Hola!", "primary":"Hello!"},
+        {"learning":"¡Buenos días!", "primary":"Good morning!", "notes": {"learning": "por la mañana", "primary": "at morning"}}
+    ]
+}
+```
+
+The collection contains an array property "data" with word translations. In this case, the learning language is specified for each translation entry, while the "primary" field represents the translation in the target language. Additionally, you can include "notes" related to learning and translations.
+
+### 2. Multiple Translations Dictionary
+
+A "multiple translation" dictionary is used to generate a dictionary with multiple translations available simultaneously. The JSON structure for a "multiple translation" dictionary and its collections is as follows:
+
+**_data/dictionaries/_multiple_dictionary.json:**
+
+```json
+{
+    "version": "1.0.0",
+    "name": "Simple",
+    "translationType": "multiple",
+    "learning": "es",
+    "translations":  ["en", "ru"]
+}
+
+```
+
+In this example, the learning language is set on the dictionary data with the "learning" field (using ISO 639-1 language codes). Multiple translation types are specified in the "translations" property (using ISO 639-1 language codes).
+
+**_data/dictionaries/multiple_dictionary/greetings.json:**
+
+```json
+{
+    "name": "Greetings",
+    "type": "collection",
+    "data": [
+        {"learning":"¡Hola!", "en":"Hello!", "ru": "Привет!"},
+        {"learning":"¡Buenos días!", "en":"Good morning!", "ru":"Доброе утро!",  "notes": {"learning": "por la mañana", "en": "at morning", "ru": "говорят по утрам"}}
+    ]
+}
+```
+
+The collection contains an array property "data" with word translations. Each translation entry includes the learning language and multiple translations specified in the "translations" property. Additionally, you can include "notes" related to learning and translations for each entry.
+
+## Object Properties
+
+### 1. Dictionary Object
+
+The dictionary object is a JSON object with the following properties:
+
+| Property         | Type     | Description                              |
+|------------------|----------|------------------------------------------|
+| `name`           | string   | The name of the dictionary. (Required)   |
+| `translationType`| string   | The type of translation ("single" or "multiple"). (Required) |
+| `learning`       | string   | The learning language code, related to ISO 639-1 language codes. (Required) [ISO 639-1 Language Codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
+| `version`        | string   | The version of the dictionary. (Optional) |
+| `translations`   | array    | An array of ISO 639-1 language codes (required if `translationType` is "multiple"). |
+
+### 2. Collection Object
+
+The collection object is a JSON object with the following properties based on the `translationType` of the dictionary:
+
+#### If `translationType` is "single":
+
+| Property    | Type     | Description                              |
+|-------------|----------|------------------------------------------|
+| `type`      | string   | The type of the collection ("folder"). (Required) |
+| `learning`  | string   | The learning word or phrase. (Required)  |
+| `primary`   | string   | The primary translation. (Required)      |
+| `notes`     | object   | Additional notes related to learning and translation (Optional). - `learning`: Additional notes related to the learning word/phrase (string). - `primary`: Additional notes related to the primary translation (string). |
+
+#### If `translationType` is "multiple":
+
+| Property    | Type     | Description                              |
+|-------------|----------|------------------------------------------|
+| `type`      | string   | The type of the collection ("folder"). (Required) |
+| `learning`  | string   | The learning word or phrase. (Required)  |
+| Properties for each translations of related dictionary | string | Properties for each translations of related dictionary, all of which are required. |
+| `notes`     | object   | Additional notes related to learning and translations (Optional). - `learning`: Additional notes related to the learning word/phrase (string). - Properties for each translation type: Additional notes related to each translation type (string). |
+
+### 3. Folder Object
+
+The `_metadata.json` file is used to set the folder name on the API response and contains the following property:
+
+| Property    | Type     | Description                              |
+|-------------|----------|------------------------------------------|
+| `name`      | string   | The name to be used as the folder name in the API response. (Optional, if missing, the folder name will be used.) |
+
+## Dictionary Types Examples
+
+### 1. Single Translation Dictionary Example
+
+#### Folder Structure
+
+```bash
+_data/dictionaries/_single.json
+_data/dictionaries/single/greetings.json
+_data/dictionaries/single/unit1/numbers.json
+```
+
+**_data/dictionaries/_single.json:**
+
+```json
+{
+    "version": "1.0.0",
+    "name": "Basic (One Language)",
+    "translationType": "single",
+    "learning": "es"
+}
+```
+
+**_data/dictionaries/single/greetings.json:**
+
+```json
+{
+    "name": "Greetings",
+    "type": "collection",
+    "data": [
+        {"learning":"¡Hola!", "primary":"Hello!"}
+    ]
+}
+```
+
+**_data/dictionaries/single/unit1/numbers.json:**
+
+```json
+{
+    "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"
+        }
+    ]
+}
+```
+
+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"}]}]}]}
+```
+
+### 2. Multiple Translations Dictionary Example
+
+#### Folder Structure
+
+```bash
+_data/dictionaries/_multiple.json
+_data/dictionaries/multiple/greetings.json
+_data/dictionaries/multiple/unit1/_metadata.json
+_data/dictionaries/multiple/unit1/numbers.json
+```
+
+**_data/dictionaries/_multiple.json:**
+
+```json
+{
+    "version": "1.0.0",
+    "name": "Basic (Multiple Languages)",
+    "translationType": "multiple",
+    "learning": "es",
+    "translations": [
+        "en", "ru", "de", "fr", "pt"
+    ]
+}
+```
+
+**_data/dictionaries/multiple/greetings.json:**
+
+```json
+{
+    "name": "Greetings",
+    "type": "collection",
+    "data": [
+        {"learning":"¡Hola!", "en":"Hello!", "ru":"Привет!", "de":"Hallo!", "fr":"Bonjour!", "pt":"Olá!"}
+    ]
+}
+```
+
+**_data/dictionaries/multiple/un1/_metadata.json:**
+
+```json
+{
+    "name": "Unit 1"
+}
+```
+
+**_data/dictionaries/multiple/un1/numbers.json:**
+
+```json
+{
+    "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"
+        }
+    ]
+}
+```
+
+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"}]}]}]}
+```
+
+As you can see collection `greetings` and folder `un1` have names that are defined by property `name`.
+
+## License
+
+This project is licensed under the MIT License.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/jekyll-dictionaries.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll-dictionaries/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-dictionaries"
+  spec.version = JekyllDictionaries::VERSION
+  spec.authors = ["hinkoulabs"]
+  spec.email = ["siarhei.hinkou@hinkoulabs.com"]
+
+  spec.summary = "A Jekyll 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"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.extra_rdoc_files = Dir["README.md", "History.markdown", "LICENSE.txt"]
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rspec'
+end

data/lib/jekyll-dictionaries/dictionary_api_page.rb

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,51 @@
+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

data/lib/jekyll-dictionaries/generator.rb

@@ -0,0 +1,73 @@
+require_relative './dictionary_page'
+require_relative './dictionary_api_page'
+
+module JekyllDictionaries
+  class Generator < Jekyll::Generator
+    DICT_REGEX = /^_(.*)/
+
+    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)
+
+        api_page.related_page = doc_page
+        doc_page.related_page = api_page
+
+        site.pages << api_page
+        site.pages << doc_page
+      end
+    end
+
+    protected
+
+    def config
+      @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
+
+        memo
+      end
+    end
+  end
+end

data/lib/jekyll-dictionaries/version.rb

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

data/lib/jekyll-dictionaries.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+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
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-dictionaries
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- hinkoulabs
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- siarhei.hinkou@hinkoulabs.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- History.markdown
+- LICENSE.txt
+files:
+- ".DS_Store"
+- ".idea/jekyll-dictionaries.iml"
+- ".idea/misc.xml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- ".rspec"
+- History.markdown
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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/version.rb
+homepage: https://github.com/hinkoulabs/jekyll-dictionaries
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hinkoulabs/jekyll-dictionaries
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: A Jekyll plugin to generate JSON dictionaries for language learning applications
+test_files: []