jekyll-chatgpt-translate 0.0.42 → 0.0.44

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22b2e725c02a5de3447605daaad8d41fce5885908f59c8bc86cc676ac8d3a661
-  data.tar.gz: 5cb8610b0994bab60d9bf23d3aff7888f01f7ff0520e9dddc4e487e99ca94601
+  metadata.gz: ac33cf289fbc970376efe2e1b6af0693db8a2c8875d059dec1d228c89baee96b
+  data.tar.gz: 3baa2cb4e88e93f3fe26cfb253b7ca939269d351930ba56f10c10aa6f5766c67
 SHA512:
-  metadata.gz: f1bf2b84b63f9b82ce5bc28771ab52b3571a5b4d5629fe6e10038c968bad2127407a33e9d7f1d08a7b11c247f4748021695fc569794e3f9966cca3ec30f567cf
-  data.tar.gz: b6385f234df97f3e6f5ea37e555667a59b68db7c4f7ec82ee26bd6e27a4e7cc3df759b7243f50fdcee424a7ecff785a989898ce0c050596a2c616a36f9d3ef55
+  metadata.gz: 629df2b5bbdaf7f51a562d5e941c93e9a18d07dbd868694010076c8657896e7827123b71478d60d903b645dc722e81bd274478de80b68b87bbfe78316cea69ea
+  data.tar.gz: a8099c472aeb3e73f71b94a8221f2bbd549571f1d9414e8b9d787b66823f3d1db9b5411a1a7047376684925c457110e62b1578af463857c3b95d7ab02271ec2d

data/.0pdd.yml

@@ -1,3 +1,25 @@
+# (The MIT License)
+#
+# Copyright (c) 2023-2024 Yegor Bugayenko
+#
+# 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.
+---
 errors:
   - yegor256@gmail.com
 # alerts:

data/.github/workflows/markdown-lint.yml

@@ -0,0 +1,40 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2023-2024 Yegor Bugayenko
+#
+# 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 NON-INFRINGEMENT. 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.
+---
+name: markdown-lint
+'on':
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+    paths-ignore: ['paper/**', 'sandbox/**']
+concurrency:
+  group: markdown-lint-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  markdown-lint:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@cd7d8d697e10461458bc61a30d094dc601a8b017
+      - uses: articulate/actions-markdownlint@v1

data/.github/workflows/rake.yml

@@ -1,3 +1,24 @@
+# (The MIT License)
+#
+# Copyright (c) 2023-2024 Yegor Bugayenko
+#
+# 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.
 ---
 name: rake
 on:

data/.github/workflows/yamllint.yml

@@ -0,0 +1,36 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2023-2024 Yegor Bugayenko
+#
+# 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 NON-INFRINGEMENT. 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.
+---
+name: yamllint
+'on':
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  yamllint:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ibiqlik/action-yamllint@v3

data/.rubocop.yml

@@ -1,3 +1,25 @@
+# (The MIT License)
+#
+# Copyright (c) 2023-2024 Yegor Bugayenko
+#
+# 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.
+---
 AllCops:
   Exclude:
     - 'bin/**/*'
@@ -20,7 +42,7 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Max: 100
 Metrics/CyclomaticComplexity:
-  Max: 30
+  Max: 35
 Metrics/PerceivedComplexity:
   Max: 40
 Layout/EmptyLineAfterGuardClause:

data/.rultor.yml

@@ -1,11 +1,34 @@
+# (The MIT License)
+#
+# Copyright (c) 2023-2024 Yegor Bugayenko
+#
+# 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.
+---
 docker:
-  image: yegor256/rultor-image:1.22.0
+  image: yegor256/rultor-image:1.23.1
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |
   pdd -f /dev/null
   bundle install --no-color
 release:
+  pre: false
   script: |-
     bundle exec rake
     rm -rf *.gem

data/Gemfile

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -25,11 +25,11 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'cucumber', '9.1.0', require: false
+gem 'cucumber', '9.2.0', require: false
 gem 'kramdown-parser-gfm', '1.1.0', require: false
-gem 'minitest', '5.20.0', require: false
-gem 'rake', '13.1.0', require: false
-gem 'rubocop', '1.57.2', require: false
-gem 'rubocop-rspec', '2.25.0', require: false
+gem 'minitest', '5.22.3', require: false
+gem 'rake', '13.2.1', require: false
+gem 'rubocop', '1.63.2', require: false
+gem 'rubocop-rspec', '2.29.1', require: false
 gem 'simplecov', '0.22.0', require: false
-gem 'webmock', '3.19.1', require: false
+gem 'webmock', '3.23.0', require: false

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2023 Yegor Bugayenko
+Copyright (c) 2023-2024 Yegor Bugayenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/README.md

@@ -1,18 +1,24 @@
-<img src="logo.png" style="width:256px;"/>
+# Translator of Jekyll Pages via ChatGPT
+
+![logo](logo.png)
 
 [![rake](https://github.com/yegor256/jekyll-chatgpt-translate/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/jekyll-chatgpt-translate/actions/workflows/rake.yml)
 [![Gem Version](https://badge.fury.io/rb/jekyll-chatgpt-translate.svg)](http://badge.fury.io/rb/jekyll-chatgpt-translate)
 
-If you have a [Jekyll](https://jekyllrb.com/) static site, this plugin may help you automatically
-translate its pages to another language, through [ChatGPT](https://chat.openai.com/). See how it 
-works for [my blog](https://github.com/yegor256/ru.yegor256.com), 
-for example [this page](https://ru.yegor256.com/2023-08-13-dictators.html) is translated to 
+If you have a [Jekyll](https://jekyllrb.com/) static site,
+this plugin may help you automatically
+translate its pages to another language, through
+[ChatGPT](https://chat.openai.com/). See how it
+works for [my blog](https://github.com/yegor256/ru.yegor256.com),
+for example [this page](https://ru.yegor256.com/2023-08-13-dictators.html)
+is translated to
 [English](https://ru.yegor256.com/english/2023-08-13-dictators.html).
 
-Install it first (you need [Ruby 3+](https://www.ruby-lang.org/en/news/2020/12/25/ruby-3-0-0-released/) 
+Install it first (you need
+[Ruby 3+](https://www.ruby-lang.org/en/news/2020/12/25/ruby-3-0-0-released/)
 and [Jekyll 3+](https://jekyllrb.com/)):
 
-```
+```bash
 gem install jekyll-chatgpt-translate
 ```
 
@@ -32,89 +38,124 @@ chatgpt-translate:
       permalink: :year-:month-:day-:slug-chinese.html
       layout: chinese-translated
     - 
+      only: ru-post
       language: fr
       permalink: :year-:month-:day-:title-french.html
 ```
 
-Here, the source language is English (`en`), the target one is Chinese (`zh`),
-the layout is `_layout/translated.html` (you must have this file).
+Here, the source language is English (`en`), the targets are
+Chinese (`zh`) and French (`fr`),
+where the layout for Chinese is `_layout/chinese-translated.html` and for
+French is `_layout/translated.html` (you must have these files).
 
-OpenAI API KEY must be set in `OPENAI_API_KEY` environment variable, otherwise
-the plugin will not do any translation and won't generate translated pages. 
-You can get your key [here](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key).
+OpenAI API KEY must be set in the `OPENAI_API_KEY` environment variable,
+otherwise
+the plugin will not do any translation and won't generate translated pages.
+You can get your key
+[here][open-ai].
 
-Inside the original page you can use `{{ page.chatgpt-translate.urls[XX] }}` in order to render the URL
-of the translated page, where `XX` is the [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) 
+OpenAI API base URL can be customized by the `OPENAI_API_BASE`
+environment variable.
+If this variable is not set, the default value is `https://api.openai.com/`.
+
+Inside the original page you can use `{{ page.chatgpt-translate.urls[XX] }}`
+in order to render the URL
+of the translated page, where `XX` is the [ISO-639-1][iso-639]
 code of the target language.
-Inside the translated page you can use `{{ page.chatgpt-translate.original-url }}` in order
-to get the URL of the page that was translated. 
+Inside the translated page you can use
+`{{ page.chatgpt-translate.original-url }}` in order
+to get the URL of the page that was translated.
 
 You can also use `{{ page.chatgpt-translate.model }}`
-inside both the original page and the translated one, to refer to the model of ChatGPT.
+inside both the original page and the translated one,
+to refer to the model of ChatGPT.
 The presence of `{{ page.chatgpt-translate }}` means that the
-page was translated or the translated HTML was downloaded and placed into the `_site` directory.
+page was translated or the translated HTML was downloaded
+and placed into the `_site` directory.
 
 ## Options
 
 Full list of options available to specify in `_config.yml`:
 
-  * `api_key_file` (optional) — the file with OpenAI API key. If this option is not specified,
-    it is expected to have the key in the `OPENAI_API_KEY` environment variable.
+* `api_key_file` (optional) — the file with OpenAI API key.
+If this option is not specified,
+  it is expected to have the key in the `OPENAI_API_KEY` environment variable.
+
+* `api_key` (optional) — the OpenAI API key itself. This is a very bad idea to
+  specify it right in the `_config.yml` file, but it's still possible.
 
-  * `api_key` (optional) — the OpenAI API key itself. This is a very bad idea to
-    specify it right in the `_config.yml` file, but it's still possible.
+* `model` (optional) — specifies the model to use by ChatGPT,
+  [examples are here](https://github.com/alexrudall/ruby-openai#models).
 
-  * `model` (optional) — specifies the model to use by ChatGPT, 
-    [examples are here](https://github.com/alexrudall/ruby-openai#models).
+* `source` (optional) — is the [ISO-639-1][iso-639] code of the source language.
 
-  * `source` (optional) — is the [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) 
-    code of the source language.
+* `no_download` (optional) — if this attribute is present, the plugin won't try
+  to find HTML versions of translated pages in the Internet and won't try to
+  download them and place into the `_site` directory. Thus, your entire site
+  will have to be re-translated on every build (might be very ineffective
+  if the site is big!)
 
-  * `no_download` (optional) — if this attribute is present, the plugin won't try
-    to find HTML versions of translated pages in the Internet and won't try to 
-    download them and place into the `_site` directory. Thus, your entire site
-    will have to be re-translated on every build (might be very ineffective if the site is big!)
+* `min_chars` (optional) — minimum number of chars that must be present in
+  a paragraph in order for it to be feasible to go to ChatGPT. The robot
+  doesn't translate short paragraphs pretty enough. It's better to keep this
+  number big enough, to avoid silly translations. The default is 128.
 
-  * `min_chars` (optional) — minimum number of chars that must be present in
-    a paragraph in order for it to be feasible to go to ChatGPT. The robot
-    doesn't translate short paragraphs pretty enough. It's better to keep this
-    number big enough, to avoid silly translations. The default is 128.
+* `window_length` (optional) — maximum number of words to be sent to
+  OpenAI API in one
+  request. The default is 2048.
 
-  * `window_length` (optional) — maximum number of words to be sent to OpenAI API in one
-    request. The default is 2048.
+* `layout` (optional) — is name of the file in `_layouts` directory,
+  without the extension.
+  This layout will be specified for the pages generated by this plugin.
+  The default value is `translated` (expecting you to have
+  `_layouts/translated.html` file available).
 
-  * `layout` (optional) — is name of the file in `_layouts` directory, without the extension. 
-    This layout will be specified for the pages generated by this plugin.
-    The default value is `translated` (expecting you to have `_layouts/translated.html` file available).
+* `targets` (mandatory) — an array of target languages, each of
+  which has the following attributes
 
-  * `targets` (mandatory) — an array of target languages, each of which has the following attributes
+  * `only` (optional) —
+    it this is present, only the posts with the provided "layout"
+    will be translated to this target
 
-    * `language` (mandatory) — [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code of the target language
+  * `language` (mandatory) —
+    [ISO-639-1][iso-639] code of the target language
 
-    * `permalink` (mandatory) — template to use for newly generated pages
+  * `permalink` (mandatory) — template to use for newly generated pages
 
-    * `layout` (optional) — the name of the file in the `_layouts` directory
+  * `layout` (optional) — the name of the file in the `_layouts` directory
 
-  * `threshold` (optional) — maximum number of pages to generate in one build cycle.
-    The default value is 1024. It is recommended to use smaller number, in order
-    to avoid too long builds. You can re-run the build again and missing pages
-    will be generated. Thus, in a few builds the entire site will be translated.
+* `threshold` (optional) — maximum number of pages to generate
+  in one build cycle.
+  The default value is 1024. It is recommended to use smaller number, in order
+  to avoid too long builds. You can re-run the build again and missing pages
+  will be generated. Thus, in a few builds the entire site will be translated.
 
-  * `version` (optional) — the version that will be attached to each generated page, 
-    in order to avoid repetitive translations on one hand and enable re-translations
-    when the `version` is changed on another hand. By default, the version of
-    this plugin will be used, unless you set your own value.
+* `version` (optional) — the version that will be attached to each
+  generated page,
+  in order to avoid repetitive translations on one hand
+  and enable re-translations
+  when the `version` is changed on another hand. By default, the version of
+  this plugin will be used, unless you set your own value.
 
-  * `tmpdir` (optional) — the name of the directory where to keep temporary files,
-    `_chatgpt-translate` is the default value.
+* `tmpdir` (optional) — the name of the directory where to keep temporary files,
+  `_chatgpt-translate` is the default value.
 
 ## How to Contribute
 
 Make a fork and then test it locally like this:
 
 ```bash
-$ bundle update
-$ bundle exec rake
+bundle update
+bundle exec rake
 ```
 
 If it works, make changes, test again, and then submit a pull request.
+
+In order to run a single test, do this:
+
+```bash
+bundle exec ruby test/test_generator.rb
+```
+
+[open-ai]: https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key
+[iso-639]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

data/Rakefile

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/features/cli.feature

@@ -207,3 +207,38 @@ Feature: Simple site building
     And Stdout contains "The page is absent, need to translate"
     And File "_site/2023/01/01/hello.html" exists
     And File "_site/2023/01/01/hello.html" contains "NO TRANSLATION!"
+
+  Scenario: Translation skipped due to the ONLY tag
+    Given I have a "_config.yml" file with content:
+    """
+    url: https://www.yegor256.com
+    markdown: kramdown
+    plugins:
+      - jekyll-chatgpt-translate
+    chatgpt-translate:
+      source: en
+      threshold: 0
+      api_key: "it-is-not-used, because EN to EN translation"
+      layout: default
+      targets:
+        -
+          only: ABC
+          language: en
+          permalink: :slug-en.html
+    """
+    And I have a "_layouts/default.html" file with content:
+    """
+    {{ content }}
+    """
+    And I have a "_posts/2023-01-01-hello.md" file with content:
+    """
+    ---
+    layout: default
+    title: foo
+    ---
+    Hello, world!
+    """
+    Then I build Jekyll site
+    And Exit code is zero
+    And File "_site/2023/01/01/hello.html" exists
+    And File "_site/2023/01/01/hello-en.html" doesn't exist

data/features/step_definitions/steps.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -53,6 +53,10 @@ Then('File {string} exists') do |string|
   raise "The file \"#{string}\" is absent:\n#{`tree -s`}" unless File.exist?(string)
 end
 
+Then('File {string} doesn\'t exist') do |string|
+  raise "The file \"#{string}\" is present:\n#{`tree -s`}" if File.exist?(string)
+end
+
 Then('File {string} contains {string}') do |string, string2|
   raise "The file \"#{string}\" is absent" unless File.exist?(string)
   content = File.read(string)

data/features/support/env.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/jekyll-chatgpt-translate.gemspec

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>= 3.0'
   s.name = 'jekyll-chatgpt-translate'
-  s.version = '0.0.42'
+  s.version = '0.0.44'
   s.license = 'MIT'
   s.summary = 'Translate Jekyll Pages Through ChatGPT'
   s.description = [

data/lib/jekyll-chatgpt-translate/chatgpt.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -35,7 +35,7 @@ module GptTranslate; end
 
 # Abstraction of ChatGPT.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::ChatGPT
   # Is TRUE if we already shown to the user the available models.
@@ -45,7 +45,7 @@ class GptTranslate::ChatGPT
   # +key+ OpenAI API Key, which can't be nil, but can be empty string, which means dry mode (no calls to OpenAI)
   # +source+ The language to translate from
   # +target+ The language to translate into
-  def initialize(key, model, source, target, client: OpenAI::Client.new(access_token: key))
+  def initialize(key, model, source, target, client: OpenAI::Client.new(access_token: key, uri_base: api_base_url))
     raise 'OpenAI key cannot be nil' if key.nil?
     @key = key
     @model = model
@@ -54,6 +54,19 @@ class GptTranslate::ChatGPT
     @client = client
   end
 
+  def api_base_url
+    url = ENV.fetch('OPENAI_API_BASE', 'https://api.openai.com/')
+    Jekyll.logger.info("Current OpenAI API Base URL: #{url.inspect}")
+    unless url == 'https://api.openai.com/'
+      Jekyll.logger.warn(
+        'Warning: You\'re using a custom endpoint for the OpenAI API. ' \
+        'The provider of this endpoint may have access to all details ' \
+        'of your requests. Only use a custom endpoint if you trust the provider.'
+      )
+    end
+    url
+  end
+
   def translate(markdown, min: 32, window_length: 2000)
     pars = GptTranslate::Pars.new(markdown).to_a
     ready = []
@@ -62,7 +75,7 @@ class GptTranslate::ChatGPT
       par = pa.dup
       par.strip!
       if @source == @target
-        Jekyll.logger.debug("No need to translate from #{@source.inspect} to #{@target.inspect}: #{par.inspect}")
+        Jekyll.logger.debug("No need to translate from #{@source.inspect} to itself: #{par.inspect}")
         ready[i] = par
       elsif par.length < min
         Jekyll.logger.debug("Not translating this, b/c too short: #{par.inspect}")
@@ -142,15 +155,19 @@ class GptTranslate::ChatGPT
     rescue StandardError => e
       attempt += 1
       if attempt < 4
-        Jekyll.logger.error("ChatGPT failed to answer to #{prompt.inspect} \
-(attempt no.#{attempt}): #{e.message.inspect}")
+        Jekyll.logger.error(
+          "ChatGPT failed to answer to #{prompt.inspect}" \
+          "(attempt no.#{attempt}): #{e.message.inspect}"
+        )
         retry
       end
       raise e
     end
-    Jekyll.logger.info("Translated #{par.split.count} #{@source.upcase} words \
-to #{answer.split.count} #{@target.upcase} words \
-through #{@model} in #{(Time.now - start).round(2)}s: #{"#{par[0..24]}...".inspect}")
+    Jekyll.logger.info(
+      "Translated #{par.split.count} #{@source.upcase} words " \
+      "to #{answer.split.count} #{@target.upcase} words " \
+      "through #{@model} in #{(Time.now - start).round(2)}s: #{"#{par[0..24]}...".inspect}"
+    )
     answer
   end
 end

data/lib/jekyll-chatgpt-translate/generator.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -36,7 +36,7 @@ module GptTranslate; end
 
 # Pages generator.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::Generator < Jekyll::Generator
   safe true
@@ -63,11 +63,17 @@ class GptTranslate::Generator < Jekyll::Generator
     marker = "Translated by ChatGPT #{model}#{version.empty? ? '' : "/#{version}"}"
     site.posts.docs.shuffle.each_with_index do |doc, pos|
       plain = GptTranslate::Plain.new(doc.content).to_s
+      layout = doc['layout']
       config['targets'].each do |target|
         pstart = Time.now
         link = GptTranslate::Permalink.new(doc, target['permalink']).to_path
         lang = target['language']
         raise 'Language must be defined for each target' if target.nil?
+        only = target['only']
+        if !only.nil? && layout != only
+          Jekyll.logger.debug("Not translating #{link.inspect}, b/c 'only' set to '#{only}'")
+          next
+        end
         path = File.join(home, lang, doc.basename.gsub(/\.md$/, "-#{lang}.md"))
         FileUtils.mkdir_p(File.dirname(path))
         File.write(

data/lib/jekyll-chatgpt-translate/pars.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -27,7 +27,7 @@ module GptTranslate; end
 
 # Markdown broken down ito pars.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::Pars
   # Ctor.

data/lib/jekyll-chatgpt-translate/permalink.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -29,7 +29,7 @@ module GptTranslate; end
 
 # Permalink.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::Permalink
   def initialize(doc, template)

data/lib/jekyll-chatgpt-translate/ping.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -36,7 +36,7 @@ module GptTranslate; end
 
 # Ping one page of a site.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::Ping
   # Ctor.

data/lib/jekyll-chatgpt-translate/plain.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -29,7 +29,7 @@ module GptTranslate; end
 
 # Markdown to plain text.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::Plain
   # Ctor.

data/lib/jekyll-chatgpt-translate/prompt.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -30,7 +30,7 @@ module GptTranslate; end
 
 # Prompt for ChatGPT.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::Prompt
   # Ctor.

data/lib/jekyll-chatgpt-translate/version.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -23,5 +23,5 @@
 # SOFTWARE.
 
 module GptTranslate
-  VERSION = '0.0.42'
+  VERSION = '0.0.44'
 end

data/lib/jekyll-chatgpt-translate.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/test/test__helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -33,7 +33,7 @@ module GptTranslate; end
 
 # Fake.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::FakeSite
   attr_reader :config, :pages, :static_files
@@ -81,7 +81,7 @@ end
 
 # Fake.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::FakeDocument
   attr_reader :data
@@ -118,7 +118,7 @@ end
 
 # Fake.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::FakePosts
   attr_reader :config

data/test/test_chatgpt.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -29,11 +29,11 @@ require_relative '../lib/jekyll-chatgpt-translate/chatgpt'
 
 # ChatGPT test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::ChatGPTTest < Minitest::Test
   def test_short_text
-    chat = GptTranslate::ChatGPT.new('fake-key', 'foo', 'xx', 'xx')
+    chat = GptTranslate::ChatGPT.new('fake-key', 'foo', 'xx', 'zz')
     assert_equal('Hello, world!', chat.translate('Hello, world!'))
   end
 
@@ -56,12 +56,12 @@ class GptTranslate::ChatGPTTest < Minitest::Test
   end
 
   def test_dry_mode
-    chat = GptTranslate::ChatGPT.new('', 'foo', 'xx', 'xx')
+    chat = GptTranslate::ChatGPT.new('', 'foo', 'xx', 'zz')
     assert_equal(38, chat.translate('This text should not be sent to OpenAI', min: 100).length)
   end
 
   def test_no_translation
-    chat = GptTranslate::ChatGPT.new('', 'foo', 'xx', 'xx')
+    chat = GptTranslate::ChatGPT.new('', 'foo', 'xx', 'zz')
     chat.translate(
       "
       How are you, my friend? This text must be translated through ChatGPT.
@@ -82,12 +82,17 @@ class GptTranslate::ChatGPTTest < Minitest::Test
   end
 
   def test_markup
-    chat = GptTranslate::ChatGPT.new('fake-key', 'gpt-3.5-turbo', 'xx', 'xx')
-    assert_equal('<img src="a"/>', chat.translate('<img src="a"/>'))
+    chat = GptTranslate::ChatGPT.new('fake-key', 'gpt-3.5-turbo', 'xx', 'zz')
+    assert_equal('<img src="a"/>', chat.translate('<img src="a"/>', min: 1))
+  end
+
+  def test_image
+    chat = GptTranslate::ChatGPT.new('fake-key', 'gpt-3.5-turbo', 'xx', 'zz')
+    assert_equal('![some image](/foo.png)', chat.translate('![some image](/foo.png)', min: 1))
   end
 
   def test_code_block
-    chat = GptTranslate::ChatGPT.new('fake-key', '', 'xx', 'xx')
+    chat = GptTranslate::ChatGPT.new('fake-key', '', 'xx', 'zz')
     chat.translate("```\ntest\n```", min: 0)
   end
 
@@ -127,8 +132,21 @@ class GptTranslate::ChatGPTTest < Minitest::Test
   private
 
   def stub_it!
-    stub_request(:any, 'https://api.openai.com/v1/chat/completions').to_return(
+    url = "#{api_base_url}v1/chat/completions"
+    stub_request(:any, url).to_return(
       body: '{"choices":[{"message":{"content": "done!"}}]}'
     )
   end
+
+  def api_base_url
+    url = ENV.fetch('OPENAI_API_BASE', 'https://api.openai.com/')
+    Jekyll.logger.info("Current OpenAI API Base URL: #{url.inspect}")
+
+    warning_msg = 'Warning: You\'re using a custom endpoint for the OpenAI API. ' \
+                  'The provider of this endpoint may have access to all details ' \
+                  'of your requests. Only use a custom endpoint if you trust the provider.'
+    Jekyll.logger.warn(warning_msg) if url != 'https://api.openai.com/'
+
+    url
+  end
 end

data/test/test_generator.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -30,7 +30,7 @@ require_relative '../lib/jekyll-chatgpt-translate/generator'
 
 # Generator test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::GeneratorTest < Minitest::Test
   def test_simple_scenario

data/test/test_pars.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -28,7 +28,7 @@ require_relative '../lib/jekyll-chatgpt-translate/pars'
 
 # Test for Pars.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::ParsTest < Minitest::Test
   def test_simple_cases

data/test/test_permalink.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -28,7 +28,7 @@ require_relative '../lib/jekyll-chatgpt-translate/permalink'
 
 # Permalink test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::PermalinkTest < Minitest::Test
   def test_simple_link

data/test/test_ping.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -31,7 +31,7 @@ require_relative '../lib/jekyll-chatgpt-translate/ping'
 
 # Ping test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::PingTest < Minitest::Test
   def test_when_exists

data/test/test_plain.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -28,7 +28,7 @@ require_relative '../lib/jekyll-chatgpt-translate/plain'
 
 # Plain test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::PlainTest < Minitest::Test
   def test_simple_map

data/test/test_prompt.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2023 Yegor Bugayenko
+# Copyright (c) 2023-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -28,7 +28,7 @@ require_relative '../lib/jekyll-chatgpt-translate/prompt'
 
 # Prompt test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::PromptTest < Minitest::Test
   def head(source, target)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-chatgpt-translate
 version: !ruby/object:Gem::Version
-  version: 0.0.42
+  version: 0.0.44
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-17 00:00:00.000000000 Z
+date: 2024-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: humanize
@@ -132,7 +132,9 @@ extra_rdoc_files:
 - LICENSE.txt
 files:
 - ".0pdd.yml"
+- ".github/workflows/markdown-lint.yml"
 - ".github/workflows/rake.yml"
+- ".github/workflows/yamllint.yml"
 - ".gitignore"
 - ".pdd"
 - ".rubocop.yml"