jekyll-chatgpt-translate 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b2375ac0c0ab9bc728d9e1d6684b4cb1f1424ae5718095a8644a447b91487e8
-  data.tar.gz: bf13ed8a50dad4ca6f4cdd1d719728a57e0c7081a16eda4d56bb6dbbcae5bb3d
+  metadata.gz: ae5a29abd8e4cb757fa40d7b50c999a4453901b1be9a597f23e560fa3900416d
+  data.tar.gz: e1769e8544c657ad086c462a1d32652edd434ac26509b064d1441f8beb35ea28
 SHA512:
-  metadata.gz: 26dbc8403f36f4bfb8c127efac666dd8884823be38b9fda7a7c92800c50f6805cfe7aa8b04251830412025ae3582a799331fdff0e8336507a6c2004fbbbbf49c
-  data.tar.gz: 5f5cd81fd192d7945f57b23148df57ebd95f09ff8b917190ffd89cb2a8dc4d44f49afffc78d7032c0194a6a0e0aa25ce95b80d97a210cfd1cbfe9965e0a44f6c
+  metadata.gz: 97ac19fd067d197faf5fb5c2b541a0641b56c0ca0fbbef3f9fbfe02c4efacb89657fc9d9011bd10081ce6221807eba792be5ed8f12e9617a197c36574f668df4
+  data.tar.gz: 2f5251871b78f3052f33b7c1778318d89945b9874295fc36da9ae8f8d7fb34a720bb475210f0e1546ccf18c7a136ee2ed5e24d70aaa4630d5fe7e1f707d95bac

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,6 +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

@@ -13,30 +13,37 @@ Feature: Simple site building
       targets:
         -
           language: cn
-          permalink: :year-:month-:day-:title-chinese.html
+          permalink: :year-:month-:day-:slug-chinese.html
           layout: chinese-translated
         -
           language: fr
-          permalink: :year/:title-french.html
+          permalink: :year/:slug-french.html
     """
     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:
     """
     ---
+    title: Hello, world!
     layout: default
     ---
     Hello, world!
     """
     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-chinese.html" exists
-    Then File "_site/2023/Hello-french.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

@@ -50,7 +50,12 @@ Then(/^Stdout contains "([^"]*)"$/) do |txt|
 end
 
 Then(/^File "([^"]*)" exists$/) do |name|
-  raise unless File.exist?(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

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.6'
+  s.version = '0.0.8'
   s.license = 'MIT'
   s.summary = 'Translate Jekyll Pages Through ChatGPT'
   s.description = [

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

@@ -65,7 +65,7 @@ class GptTranslate::ChatGPT
   private
 
   def translate_par(par)
-    Time.now
+    start = Time.now
     t = nil
     attempt = 0
     begin
@@ -80,26 +80,21 @@ class GptTranslate::ChatGPT
         }
       )
       t = response.dig('choices', 0, 'message', 'content')
-    rescue StandardError
+    rescue StandardError => e
       attempt += 1
       retry if attempt < 4
+      raise e
     end
-    if t.nil?
-      Jekyll.logger.error("Failed to translate #{par.split.count}
-#{@source.upcase} words after #{attempt} attempts :(")
-      'FAILED TO TRANSLATE THIS PARAGRAPH'
-    else
-      Jekyll.logger.debug("Translated #{par.split.count} #{@source.upcase} words
-to #{t.split.count} #{@target.upcase} words
-through #{@model} in #{(Time.now - pstart).round(2)}s")
-      t
-    end
+    Jekyll.logger.info("Translated #{par.split.count} #{@source.upcase} words \
+to #{t.split.count} #{@target.upcase} words \
+through #{@model} in #{(Time.now - start).round(2)}s")
+    t
   end
 
   def prompt
-    if (source == 'ru') && (target == 'en')
+    if (@source == 'ru') && (@target == 'en')
       'Пожалуйста, переведи этот параграф на английский язык'
-    elsif (source == 'en') && (target == 'ru')
+    elsif (@source == 'en') && (@target == 'ru')
       'Please, translate this paragraph to Russian'
     else
       [

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

@@ -42,14 +42,9 @@ class GptTranslate::Generator < Jekyll::Generator
 
   # Main plugin action, called by Jekyll-core
   def generate(site)
-    @site = site
-    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
+    config ||= site.config['chatgpt-translate'] || {}
+    home = '_chatgpt-translated'
+    key = api_key(config)
     if key.nil?
       Jekyll.logger.info('jekyll-chatgpt-translate requires OPENAI_API_KEY environment variable')
       return
@@ -61,7 +56,7 @@ but pages will be generated')
     site.posts.docs.each do |doc|
       plain = GptTranslate::Plain.new(doc.content).to_s
       config['targets'].each do |target|
-        link = GptTranslate::Permalink.new(doc, target['permalink']).to_s
+        link = GptTranslate::Permalink.new(doc, target['permalink']).to_path
         next if GptTranslate::Ping.new(site, link).exists?
         lang = target['language']
         raise 'Language must be defined for each target' if target.nil?
@@ -77,7 +72,7 @@ but pages will be generated')
           lang
         )
         translated = gpt.translate(plain)
-        path = "_chatgpt-translated/#{doc.basename}"
+        path = File.join(home, lang, doc.basename.gsub(/\.md$/, "-#{lang}.md"))
         FileUtils.mkdir_p(File.dirname(path))
         File.write(
           path,
@@ -86,6 +81,7 @@ but pages will be generated')
             "layout: #{target['layout'] || layout}",
             "title: #{doc.data['title']}",
             "permalink: #{link}",
+            "translated-original-url: #{doc.url}",
             '---',
             '',
             translated,
@@ -93,18 +89,34 @@ 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
-    Jekyll.logger.info("#{total} pages generated in #{(Time.now - start).round(2)}s")
+    Jekyll.logger.info("#{total} pages translated in #{(Time.now - start).round(2)}s")
   end
 
   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)
+    else
+      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

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

@@ -38,11 +38,14 @@ class GptTranslate::Permalink
     @template = template
   end
 
-  def to_s
-    @template
+  def to_path
+    path = @template
       .gsub(':year', format('%04d', @doc['date'].year))
       .gsub(':month', format('%02d', @doc['date'].month))
       .gsub(':day', format('%02d', @doc['date'].day))
       .gsub(':title', CGI.escape(@doc['title']))
+      .gsub(':slug', CGI.escape(@doc['slug']))
+    path = "/#{path}" unless path.start_with?('/')
+    path
   end
 end

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

@@ -40,15 +40,16 @@ module GptTranslate; end
 # License:: MIT
 class GptTranslate::Ping
   # Ctor.
-  def initialize(site, link)
+  def initialize(site, path)
     @site = site
-    @link = link
+    raise 'Permalink must start with a slash' unless path.start_with?('/')
+    @path = path
   end
 
   def exists?
     home = @site.config['url']
     return false if home.nil?
-    uri = Iri.new(home).path(@link)
+    uri = Iri.new(home).path(@path)
     before = Net::HTTP.get_response(URI(uri.to_s))
     if before.is_a?(Net::HTTPSuccess) && before.body.include?("/#{GptTranslate::VERSION}")
       Jekyll.logger.info("No need to translate, page exists at #{uri} (#{before.body.split.count} words)")

data/test/test_chatgpt.rb

@@ -23,6 +23,7 @@
 # SOFTWARE.
 
 require 'minitest/autorun'
+require 'webmock/minitest'
 require_relative '../lib/jekyll-chatgpt-translate/chatgpt'
 
 # ChatGPT test.
@@ -44,4 +45,11 @@ class GptTranslate::ChatGPTTest < Minitest::Test
     chat = GptTranslate::ChatGPT.new('fake-key', 'gpt-3.5-turbo', 'en', 'ru')
     assert_equal('<img src="a"/>', chat.translate('<img src="a"/>'))
   end
+
+  def test_through_webmock
+    stub_request(:any, 'https://api.openai.com/v1/chat/completions')
+      .to_return(body: '{"choices":[{"message":{"content": "boom!"}}]}')
+    chat = GptTranslate::ChatGPT.new('fake-key', 'gpt-3.5-turbo', 'en', 'ru')
+    assert_equal('boom!', chat.translate('This is the text to send to OpenAI'))
+  end
 end

data/test/test_permalink.rb

@@ -34,9 +34,9 @@ class GptTranslate::PermalinkTest < Minitest::Test
     assert_equal(
       '/2023.html',
       GptTranslate::Permalink.new(
-        { 'date' => Time.parse('2023-01-01'), 'title' => 'Hello' },
-        '/:year.html'
-      ).to_s
+        { 'date' => Time.parse('2023-01-01'), 'title' => 'Hello', 'slug' => 'hello' },
+        ':year.html'
+      ).to_path
     )
   end
 
@@ -44,9 +44,9 @@ class GptTranslate::PermalinkTest < Minitest::Test
     assert_equal(
       '/2023-%23%D0%BF%D1%80%D0%B8%D0%B2%D0%B5%D1%82.html',
       GptTranslate::Permalink.new(
-        { 'date' => Time.parse('2023-01-01'), 'title' => '#привет' },
-        '/:year-:title.html'
-      ).to_s
+        { 'date' => Time.parse('2023-01-01'), 'title' => '#привет', 'slug' => 'hello' },
+        ':year-:title.html'
+      ).to_path
     )
   end
 end

data/test/test_ping.rb

@@ -23,6 +23,7 @@
 # SOFTWARE.
 
 require 'minitest/autorun'
+require 'webmock/minitest'
 require 'jekyll'
 require_relative '../lib/jekyll-chatgpt-translate/ping'
 
@@ -40,8 +41,22 @@ class GptTranslate::PingTest < Minitest::Test
   end
 
   def test_when_exists
+    stub_request(:any, 'https://www.yegor256.com/about-me.html')
     site = FakeSite.new({ 'url' => 'https://www.yegor256.com/' })
     ping = GptTranslate::Ping.new(site, '/about-me.html')
     assert(!ping.exists?)
   end
+
+  def test_when_not_exists
+    stub_request(:any, 'https://www.yegor256.com/absent.html').to_return(status: 404)
+    site = FakeSite.new({ 'url' => 'https://www.yegor256.com/' })
+    ping = GptTranslate::Ping.new(site, '/absent.html')
+    assert(!ping.exists?)
+  end
+
+  def test_relative_path
+    assert_raises do
+      GptTranslate::Ping.new({}, '404.html')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-chatgpt-translate
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-20 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iri
@@ -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