jekyll-chatgpt-translate 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bef852600359023f88efcea920702d0bbb44ae263e0493c77e10989df3b3e311
-  data.tar.gz: 5b8fc42cc02249b143396487d0ea0123e276362369b35a7a869c3291a3b9dea0
+  metadata.gz: a33656cc2e5c82d51feb6cb2900c339cce6f210bbe9615dd19756f457ace47c7
+  data.tar.gz: 2867d144dfa9e867a6bbecce340a1d77eb908a54c9790fbef9f7985223861250
 SHA512:
-  metadata.gz: 961104d1f55fdceaf47dae3bf5c739d871987cd0f31ae1203e311eec12fe018c1726ff47e0eb31844406197bf51b755295ca9d2befec4ea4d7e596fa7bf5cf41
-  data.tar.gz: 543b382769527466b275c0d03d01590e745cdc7a8df51849a6edf9cf711441d38a708198a2ea4a0342b3675ecbfd3de39cdb84211156dcaebcc0cfa52171920f
+  metadata.gz: 370cf4f063e237ab00af98e0212b738211d33f868e24c89547a4b378f867389ff46c6dfce39ac90553e25e448751490b8c465382d5a6ffdefb6aa8bca59b6826
+  data.tar.gz: beafec1d47ac6b1f731d9557de276c7ce4d9b9223a6a19e3791e7b9555cf2d3950501e99d77bc92c54501a0c8b8d4ba21710cb35102ad4a932430330c32b6795

data/Gemfile

@@ -11,6 +11,7 @@ gem 'kramdown-parser-gfm', '~>1.1', require: false
 gem 'minitest', '~>6.0', require: false
 gem 'minitest-reporters', '~>1.7', require: false
 gem 'rake', '~>13.2', require: false
+gem 'rdoc', '~>7.0', require: false
 gem 'rubocop', '~>1.64', require: false
 gem 'rubocop-minitest', '~>0.38', require: false
 gem 'rubocop-performance', '>1.26', require: false

data/README.md

@@ -6,17 +6,18 @@
 [![Gem Version](https://badge.fury.io/rb/jekyll-chatgpt-translate.svg)](https://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
-[English](https://www.yegor256.com/en/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/)
-and [Jekyll 3+](https://jekyllrb.com/)):
+  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://www.yegor256.com/en/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/)
+  and [Jekyll 3+](https://jekyllrb.com/)):
 
 ```bash
 gem install jekyll-chatgpt-translate
@@ -49,29 +50,28 @@ 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 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].
+  otherwise the plugin will not do any translation
+  and won't generate translated pages.
+You can get your key go to [OpenAI][open-ai].
 
 OpenAI API base URL can be customized by the `OPENAI_API_BASE`
-environment variable.
+  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.
+  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.
+  `{{ 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
 

data/jekyll-chatgpt-translate.gemspec

@@ -9,7 +9,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.2.0'
+  s.version = '0.3.0'
   s.license = 'MIT'
   s.summary = 'Translate Jekyll Pages Through ChatGPT'
   s.description = [
@@ -24,10 +24,11 @@ Gem::Specification.new do |s|
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = %w[README.md LICENSE.txt]
   s.add_dependency 'base64', '~>0.3'
+  s.add_dependency 'elapsed', '~>0.2'
   s.add_dependency 'humanize', '~>3.1'
   s.add_dependency 'iri', '~>0.11'
   s.add_dependency 'iso-639', '~>0.3'
-  s.add_dependency 'jekyll', '~>3.10'
+  s.add_dependency 'jekyll', '>= 3.0', '< 5.0'
   s.add_dependency 'json', '~>2.18'
   s.add_dependency 'redcarpet', '~>3.6'
   s.add_dependency 'ruby-openai', '~>8.3'

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

@@ -3,10 +3,11 @@
 # SPDX-FileCopyrightText: Copyright (c) 2023-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
+require 'elapsed'
+require 'iso-639'
 require 'jekyll'
 require 'json'
 require 'openai'
-require 'iso-639'
 require 'tiktoken_ruby'
 require_relative 'pars'
 require_relative 'prompt'
@@ -115,40 +116,39 @@ class GptTranslate::ChatGPT
       @@models_printed = true
     end
     prompt = GptTranslate::Prompt.new(par, @source, @target).to_s
-    start = Time.now
     answer = nil
     attempt = 0
-    begin
-      response = @client.chat(
-        parameters: {
-          model: @model,
-          messages: [{ role: 'user', content: prompt }],
-          temperature: 0.7
-        }
-      )
-      json = response.is_a?(Hash) ? response : JSON.parse(response)
-      answer = json.dig('choices', 0, 'message', 'content')
-      if answer.nil?
-        Jekyll.logger.error("No content returned by ChatGPT: #{response}")
-        raise 'No content returned by ChatGPT'
-      end
-      Jekyll.logger.debug("ChatGPT prompt: #{prompt.inspect}, ChatGPT answer: #{answer.inspect}")
-    rescue StandardError => e
-      attempt += 1
-      if attempt < 4
-        Jekyll.logger.error(
-          "ChatGPT failed to answer to #{prompt.inspect}" \
-          "(attempt no.#{attempt}): #{e.message.inspect}"
+    elapsed(Jekyll.logger) do
+      begin
+        response = @client.chat(
+          parameters: {
+            model: @model,
+            messages: [{ role: 'user', content: prompt }],
+            temperature: 0.7
+          }
         )
-        retry
+        json = response.is_a?(Hash) ? response : JSON.parse(response)
+        answer = json.dig('choices', 0, 'message', 'content')
+        if answer.nil?
+          Jekyll.logger.error("No content returned by ChatGPT: #{response}")
+          raise 'No content returned by ChatGPT'
+        end
+        Jekyll.logger.debug("ChatGPT prompt: #{prompt.inspect}, ChatGPT answer: #{answer.inspect}")
+      rescue StandardError => e
+        attempt += 1
+        if attempt < 4
+          Jekyll.logger.error(
+            "ChatGPT failed to answer to #{prompt.inspect}" \
+            "(attempt no.#{attempt}): #{e.message.inspect}"
+          )
+          retry
+        end
+        raise e
       end
-      raise e
+      throw :"Translated #{par.split.count} #{@source.upcase} words \
+        to #{answer.split.count} #{@target.upcase} words \
+        through #{@model}: #{"#{par[0..24]}...".inspect}"
     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}"
-    )
     answer
   end
 end

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

@@ -3,8 +3,9 @@
 # SPDX-FileCopyrightText: Copyright (c) 2023-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
-require 'jekyll'
+require 'elapsed'
 require 'fileutils'
+require 'jekyll'
 require 'json'
 require_relative 'chatgpt'
 require_relative 'permalink'
@@ -29,7 +30,7 @@ class GptTranslate::Generator < Jekyll::Generator
       Jekyll.logger.info("jekyll-chatgpt-translate #{GptTranslate::VERSION} skipped, due to the --offline option")
       return
     end
-    Jekyll.logger.info("jekyll-chatgpt-translate #{GptTranslate::VERSION} starting...")
+    Jekyll.logger.info("jekyll-chatgpt-translate #{GptTranslate::VERSION} starts (no --offline option)...")
     config ||= site.config['chatgpt-translate'] || {}
     home = config['tmpdir'] || '_chatgpt-translate'
     key = api_key(config)
@@ -41,101 +42,100 @@ class GptTranslate::Generator < Jekyll::Generator
     version = config['version'] || GptTranslate::VERSION
     threshold = config['threshold'] || 1024
     min_chars = config['min_chars'] || 128
-    start = Time.now
     translated = 0
     copied = 0
     model = config['model'] || 'gpt-3.5-turbo'
     marker = "Translated by ChatGPT #{model}#{"/#{version}" unless version.empty?}"
-    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(
-          path,
-          [
-            '---',
-            "layout: #{target['layout'] || layout}",
-            "title: #{doc['title'].to_json}",
-            "description: #{doc['description'].to_json}",
-            "permalink: #{link.to_json}",
-            'chatgpt-translate:',
-            "  original-url: #{doc.url.to_json}",
-            "  language: #{lang.to_json}",
-            "  model: #{model.to_json}",
-            '---'
-          ].join("\n")
-        )
-        html = config['no_download'].nil? ? GptTranslate::Ping.new(site, link).download : nil
-        needed = false
-        added = false
-        if html.nil?
-          Jekyll.logger.info("The page is absent, need to translate #{link.inspect}")
-          needed = true
-        else
-          copied += 1
-          site.static_files << DownloadedFile.new(site, link, html)
-          added = true
-          if version.empty?
-            Jekyll.logger.info("Re-translation not required, since version is empty: #{link.inspect}")
-          elsif html.include?(marker)
-            Jekyll.logger.info("No need to translate, the page exists at \
-#{link.inspect} (#{html.split.count} words)")
-          else
-            Jekyll.logger.info("Re-translation required for #{link.inspect}")
-            needed = true
+    elapsed(Jekyll.logger) do
+      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|
+          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
-        end
-        if translated >= threshold
-          Jekyll.logger.info("Page ##{pos} is ignored, we are over the threshold of #{threshold}: #{link}")
-        elsif needed
-          gpt = GptTranslate::ChatGPT.new(
-            key,
-            model,
-            target['source'] || config['source'] || 'en',
-            lang
-          )
-          foreign = gpt.translate(
-            plain,
-            min: min_chars,
-            window_length: (config['window_length'] || '2048').to_i
-          )
+          path = File.join(home, lang, doc.basename.gsub(/\.md$/, "-#{lang}.md"))
+          FileUtils.mkdir_p(File.dirname(path))
           File.write(
             path,
             [
-              '',
-              foreign,
-              '',
-              "#{marker} on #{Time.now.strftime('%Y-%m-%d at %H:%M')}\n{: .jekyll-chatgpt-translate}"
-            ].join("\n"),
-            mode: 'a+'
+              '---',
+              "layout: #{target['layout'] || layout}",
+              "title: #{doc['title'].to_json}",
+              "description: #{doc['description'].to_json}",
+              "permalink: #{link.to_json}",
+              'chatgpt-translate:',
+              "  original-url: #{doc.url.to_json}",
+              "  language: #{lang.to_json}",
+              "  model: #{model.to_json}",
+              '---'
+            ].join("\n")
           )
-          site.pages << Jekyll::Page.new(site, site.source, File.dirname(path), File.basename(path))
-          site.static_files.delete_if { |f| f.is_a?(DownloadedFile) && f.link == link }
-          added = true
-          translated += 1
-          Jekyll.logger.info("Translated via ChatGPT \
-in #{(Time.now - pstart).round(2)}s: #{path} (#{File.size(path)} bytes)")
+          html = config['no_download'].nil? ? GptTranslate::Ping.new(site, link).download : nil
+          needed = false
+          added = false
+          if html.nil?
+            Jekyll.logger.info("The page is absent, need to translate #{link.inspect}")
+            needed = true
+          else
+            copied += 1
+            site.static_files << DownloadedFile.new(site, link, html)
+            added = true
+            if version.empty?
+              Jekyll.logger.info("Re-translation not required, since version is empty: #{link.inspect}")
+            elsif html.include?(marker)
+              Jekyll.logger.info("The page exists at #{link.inspect} (#{html.split.count} words)")
+            else
+              Jekyll.logger.info("Re-translation required for #{link.inspect}")
+              needed = true
+            end
+          end
+          if translated >= threshold
+            Jekyll.logger.info("Page ##{pos} is ignored, we are over the threshold of #{threshold}: #{link}")
+          elsif needed
+            elapsed(Jekyll.logger) do
+              gpt = GptTranslate::ChatGPT.new(
+                key,
+                model,
+                target['source'] || config['source'] || 'en',
+                lang
+              )
+              foreign = gpt.translate(
+                plain,
+                min: min_chars,
+                window_length: (config['window_length'] || '2048').to_i
+              )
+              File.write(
+                path,
+                [
+                  '',
+                  foreign,
+                  '',
+                  "#{marker} on #{Time.now.strftime('%Y-%m-%d at %H:%M')}\n{: .jekyll-chatgpt-translate}"
+                ].join("\n"),
+                mode: 'a+'
+              )
+              site.pages << Jekyll::Page.new(site, site.source, File.dirname(path), File.basename(path))
+              site.static_files.delete_if { |f| f.is_a?(DownloadedFile) && f.link == link }
+              added = true
+              translated += 1
+              throw :"Translated via ChatGPT #{path} (#{File.size(path)} bytes)"
+            end
+          end
+          next unless added
+          doc.data['chatgpt-translate'] ||= {}
+          doc.data['chatgpt-translate']['model'] ||= model
+          doc.data['chatgpt-translate']['urls'] ||= {}
+          doc.data['chatgpt-translate']['urls'][lang] = link
         end
-        next unless added
-        doc.data['chatgpt-translate'] ||= {}
-        doc.data['chatgpt-translate']['model'] ||= model
-        doc.data['chatgpt-translate']['urls'] ||= {}
-        doc.data['chatgpt-translate']['urls'][lang] = link
       end
+      throw :"#{translated} page(s) translated and #{copied} page(s) copied"
     end
-    Jekyll.logger.info("jekyll-chatgpt-translate #{GptTranslate::VERSION}: \
-#{translated} pages translated and #{copied} pages copied in #{(Time.now - start).round(2)}s")
   end
 
   # The file we just downloaded.

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

@@ -10,7 +10,7 @@ require_relative 'version'
 
 # see https://stackoverflow.com/a/6048451/187141
 require 'openssl'
-OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE unless defined?(OpenSSL::SSL::VERIFY_PEER)
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
 
 # The module we are in.
 module GptTranslate; end

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

@@ -4,5 +4,5 @@
 # SPDX-License-Identifier: MIT
 
 module GptTranslate
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-chatgpt-translate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: elapsed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: humanize
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +84,22 @@ dependencies:
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement