jekyll-chatgpt-translate 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 951ecc1df96633e4552be477e42c43977b0187282978d9cb1c07bedc3913e8fa
-  data.tar.gz: 9fb20f291797eaee903f0ca20aaf0adcc7ed65fd77626dda6afbe3c6390418cd
+  metadata.gz: ad6aab5a14ab43febd8be49411b3cd30c89213140b5bc11d5ef0f2dd86c8de3f
+  data.tar.gz: 396b48cfade277af37a5698049e1e8ed09c37b2777b4a009ac5561543a340708
 SHA512:
-  metadata.gz: d94a2be708d58bb23427a707660276ce7d42dc90372924644b76558933c631834d3eeece4b1bb46c5b89221c3d758b62e71958137e355edb02451ef671fc9f03
-  data.tar.gz: 623f0e383d89805288678b37d9304d365b3adf6995d60c9bec4e7a9e6c85e2be44cb51e4a1001892cb5919a55799f99dfe9e174c5edf931f9f2e641d24ffed37
+  metadata.gz: 4b6917658e850826539295bc02266bab962c411812ada39f78e219837587b5a481de3b55a9471926b674d4d14b377680d8957c7d7564e8cdbff2d983bdd3f85f
+  data.tar.gz: aa290814eb9f36d3feafed043bb24b38d308b33f70cd732fa9136ddb50972142c06b6132542535e006c36735f02d698bb1f501381305a3a6c68d1d65a2a8218b

data/.rubocop.yml

@@ -27,3 +27,9 @@ Layout/EmptyLineAfterGuardClause:
   Enabled: false
 Naming/FileName:
   Enabled: false
+Layout/IndentationWidth:
+  Enabled: false
+Layout/ElseAlignment:
+  Enabled: false
+Layout/EndAlignment:
+  Enabled: false

data/Gemfile

@@ -29,7 +29,7 @@ gem 'cucumber', '8.0.0', require: false
 gem 'kramdown-parser-gfm', '1.1.0', require: false
 gem 'minitest', '5.19.0', require: false
 gem 'rake', '13.0.6', require: false
-gem 'rubocop', '1.55.1', require: false
+gem 'rubocop', '1.56.0', require: false
 gem 'rubocop-rspec', '2.23.2', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'webmock', '3.18.1', require: false

data/README.md

@@ -1,3 +1,5 @@
+<img src="logo.png" style="width:256px;"/>
+
 [![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)
 
@@ -20,7 +22,7 @@ chatgpt-translate:
   targets: 
     - 
       language: cn
-      permalink: :year-:month-:day-:title-chinese.html
+      permalink: :year-:month-:day-:slug-chinese.html
       layout: chinese-translated
     - 
       language: fr
@@ -34,14 +36,18 @@ 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).
 
-The plugin is compatible with 
-[Jekyll 3.9.3](https://jekyllrb.com/news/2023/01/29/jekyll-3-9-3-released/) and 
-[Jekyll 4.3.2](https://jekyllrb.com/news/2023/01/20/jekyll-4-3-2-released/). 
+Inside the original page you can use `{{ page.translated-XX-url }}` in order to render the URL
+of the translated page, where `XX` is the ISO-839-1 code of the target language..
+Inside the translated page you can use `{{ page.translated-original-url }}` in order
+to get the URL of the page that was translated.
 
 ## 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.
+
   * `model` (optional) — specifies the model to use by ChatGPT.
 
   * `source` (optional) — is the ISO-839-1 code of the source language.
@@ -61,7 +67,7 @@ This layout will be specified for the pages generated by this plugin.
 
 ## How to Contribute
 
-Test is like this:
+Make a fork and then test it locally like this:
 
 ```bash
 $ bundle update

data/features/cli.feature

@@ -8,6 +8,7 @@ Feature: Simple site building
     plugins:
       - jekyll-chatgpt-translate
     chatgpt-translate:
+      api_key_file: the-file-is-absent.txt
       source: en
       layout: translated
       targets:
@@ -21,11 +22,14 @@ Feature: Simple site building
     """
     And I have a "_layouts/default.html" file with content:
     """
+    The Chinese: {{ page.translated-cn-url }}
+    The French: {{ page.translated-fr-url }}
     {{ content }}
     """
     And I have a "_layouts/chinese-translated.html" file with content:
     """
     Chinese: {{ content }}
+    The original: {{ page.translated-original-url }}
     """
     And I have a "_posts/2023-01-01-hello.md" file with content:
     """
@@ -38,7 +42,9 @@ Feature: Simple site building
     Then I build Jekyll site
     Then File "_chatgpt-translated/cn/2023-01-01-hello-cn.md" exists
     Then File "_site/2023/01/01/hello.html" exists
+    Then File "_site/2023/01/01/hello.html" contains "The Chinese: /2023-01-01-hello-chinese.html"
     Then File "_site/2023-01-01-hello-chinese.html" exists
+    Then File "_site/2023-01-01-hello-chinese.html" contains "The original: /2023/01/01/hello.html"
     Then File "_site/2023/hello-french.html" exists
     And Exit code is zero
 

data/features/step_definitions/steps.rb

@@ -53,6 +53,11 @@ Then(/^File "([^"]*)" exists$/) do |name|
   raise "The file \"#{name}\" is absent:\n#{`tree`}" unless File.exist?(name)
 end
 
+Then(/^File "([^"]*)" contains "([^"]*)"$/) do |name, text|
+  content = File.read(name)
+  raise "The file \"#{name}\" doesn't contain \"#{text}\":\n#{content}" unless content.include?(text)
+end
+
 Then(/^Stdout is empty$/) do
   raise "STDOUT is not empty:\n#{@stdout}" unless @stdout == ''
 end

data/jekyll-chatgpt-translate.gemspec

@@ -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 = '>= 2.6'
   s.name = 'jekyll-chatgpt-translate'
-  s.version = '0.0.7'
+  s.version = '0.0.9'
   s.license = 'MIT'
   s.summary = 'Translate Jekyll Pages Through ChatGPT'
   s.description = [

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

@@ -42,15 +42,9 @@ class GptTranslate::Generator < Jekyll::Generator
 
   # Main plugin action, called by Jekyll-core
   def generate(site)
-    @site = site
+    config ||= site.config['chatgpt-translate'] || {}
     home = '_chatgpt-translated'
-    key = ENV.fetch('OPENAI_API_KEY', nil)
-    if key.nil? && Jekyll.env == 'development'
-      Jekyll.logger.info("OPENAI_API_KEY environment variable is not set and \
-we are in development mode, no actual translation will happen, \
-but pages will be generated")
-      key = ''
-    end
+    key = api_key(config)
     if key.nil?
       Jekyll.logger.info('jekyll-chatgpt-translate requires OPENAI_API_KEY environment variable')
       return
@@ -87,6 +81,7 @@ but pages will be generated")
             "layout: #{target['layout'] || layout}",
             "title: #{doc.data['title']}",
             "permalink: #{link}",
+            "translated-original-url: #{doc.url}",
             '---',
             '',
             translated,
@@ -94,8 +89,10 @@ but pages will be generated")
             "Translated by ChatGPT #{model}/#{GptTranslate::VERSION}\n{: .jekyll-chatgpt-translate}"
           ].join("\n")
         )
+        doc.data["translated-#{lang}-url"] = link
         site.pages << Jekyll::Page.new(site, site.source, File.dirname(path), File.basename(path))
         total += 1
+        Jekyll.logger.info("Translated via ChatGPT: #{path}")
       end
       break if total >= threshold
     end
@@ -104,8 +101,22 @@ but pages will be generated")
 
   private
 
-  # Returns the plugin's config or an empty hash if not set
-  def config
-    @config ||= @site.config['chatgpt-translate'] || {}
+  # Try to find the KEY, either in the environment, a file, etc.
+  # If not found, return NIL.
+  def api_key(config)
+    file = config['api_key_file']
+    key = if file.nil?
+      ENV.fetch('OPENAI_API_KEY', nil)
+    elsif File.exist?(file)
+      File.read(file).strip
+    end
+    if key.nil? && Jekyll.env == 'development'
+      Jekyll.logger.info("OPENAI_API_KEY environment variable is not set, \
+the `api_key_file` option is not specified in the _config.yml, and \
+we are in development mode, that's why no actual translation will happen, \
+but .md pages will be generated")
+      key = ''
+    end
+    key
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-chatgpt-translate
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -125,6 +125,7 @@ files:
 - lib/jekyll-chatgpt-translate/ping.rb
 - lib/jekyll-chatgpt-translate/plain.rb
 - lib/jekyll-chatgpt-translate/version.rb
+- logo.png
 - renovate.json
 - test/test__helper.rb
 - test/test_chatgpt.rb