jekyll-chatgpt-translate 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38924a750a0276a65b25263ec22b74f92a2ccd652636a65ec0cf90a46bb45983
-  data.tar.gz: '058007955befb70a3323a3c68863b09621e63d52da65424383644c7751b47861'
+  metadata.gz: ed6617e3b8bf46db264f484e1286ea1f91295f4fb47512cb983a6fc59c7922df
+  data.tar.gz: a0f6c744cd4bf2b2558d7b5568f1ca961a3f854e5264b9d64bb8b24249f03e3a
 SHA512:
-  metadata.gz: 33e22f1a3f0055308860c966a3ea824bd336f2ef122902bc10e533692649bb55c13d422e8b0bcde148064646745865e403830458c61767ce072ba7cd4329f07f
-  data.tar.gz: 546dfbd3042bbf630ec7647096a879fc82d32368714057189b543abb6154ac6dca0fcf504220259ad9ca27182f52e4c432fcb7eeffbb535a93513004109f6c2e
+  metadata.gz: 2d58f41b76840e524e9f1d72c2a4816b33d9e57ad6b207f54baa226abf68ae6cca848cb8cce80cf1f4502a3ad9b52871db7f7708463bf4101fdbf8c21e5f99bb
+  data.tar.gz: f85b41ad75176c9989a8a3715fd84485b3a2fcbe03e6cca879b7a201ac4b5745dda0aa16695f26cbaad1ec901b84c6837f983f7a04cee94aa26752d13ef41593

data/.rubocop.yml

@@ -20,9 +20,9 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Max: 50
 Metrics/CyclomaticComplexity:
-  Max: 15
+  Max: 20
 Metrics/PerceivedComplexity:
-  Max: 15
+  Max: 20
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 Naming/FileName:

data/README.md

@@ -4,7 +4,10 @@
 [![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/).
+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]().
 
 Install it first:
 
@@ -39,7 +42,8 @@ You can get your key [here](https://help.openai.com/en/articles/4936850-where-do
 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.
+to get the URL of the page that was translated. You can also use `{{ page.chatgpt-model }}`
+inside both the original page and the translated one, to refer to the model of ChatGPT.
 
 ## Options
 
@@ -64,6 +68,14 @@ This layout will be specified for the pages generated by this plugin.
     * `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.
+
+  * `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
+    the plugin will be used here, unless you set your own value.
 
 ## How to Contribute
 

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.10'
+  s.version = '0.0.12'
   s.license = 'MIT'
   s.summary = 'Translate Jekyll Pages Through ChatGPT'
   s.description = [
@@ -45,7 +45,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'iri', '>= 0'
   s.add_runtime_dependency 'iso-639', '>= 0'
   s.add_runtime_dependency 'jekyll', '>= 3'
-  s.add_runtime_dependency 'liquid', '>= 4'
   s.add_runtime_dependency 'redcarpet', '>= 3'
   s.add_runtime_dependency 'ruby-openai', '>= 5'
   s.metadata['rubygems_mfa_required'] = 'true'

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

@@ -50,17 +50,19 @@ class GptTranslate::Generator < Jekyll::Generator
       return
     end
     layout = config['layout'] || 'translated'
-    threshold = config['threshold'] || 1_000_000_000
+    version = config['version'] || GptTranslate::VERSION
+    threshold = config['threshold'] || 1024
     start = Time.now
     total = 0
-    site.posts.docs.each do |doc|
+    model = config['model'] || 'gpt-3.5-turbo'
+    marker = "Translated by ChatGPT #{model}/#{version}"
+    site.posts.docs.shuffle.each do |doc|
       plain = GptTranslate::Plain.new(doc.content).to_s
       config['targets'].each do |target|
         link = GptTranslate::Permalink.new(doc, target['permalink']).to_path
-        next if GptTranslate::Ping.new(site, link).found?(doc.path)
+        next if GptTranslate::Ping.new(site, link).found?(doc.path, version)
         lang = target['language']
         raise 'Language must be defined for each target' if target.nil?
-        model = config['model'] || 'gpt-3.5-turbo'
         if total >= threshold
           Jekyll.logger.info("Already generated #{total} pages, that's enough for today")
           break
@@ -82,14 +84,16 @@ class GptTranslate::Generator < Jekyll::Generator
             "title: #{doc.data['title']}",
             "permalink: #{link}",
             "translated-original-url: #{doc.url}",
+            "chatgpt-model: #{model}",
             '---',
             '',
             translated,
             '',
-            "Translated by ChatGPT #{model}/#{GptTranslate::VERSION}\n{: .jekyll-chatgpt-translate}"
+            "#{marker}\n{: .jekyll-chatgpt-translate}"
           ].join("\n")
         )
         doc.data["translated-#{lang}-url"] = link
+        doc.data['chatgpt-model'] = model
         site.pages << Jekyll::Page.new(site, site.source, File.dirname(path), File.basename(path))
         total += 1
         Jekyll.logger.info("Translated via ChatGPT: #{path}")
@@ -110,10 +114,12 @@ class GptTranslate::Generator < Jekyll::Generator
       Jekyll.logger.info('The key is found in the OPENAI_API_KEY env variable') unless k.nil?
       k
     elsif File.exist?(file)
-      Jekyll.logger.info("Reading OpenAI key from the file: #{file}")
-      File.read(file).strip
+      k = File.read(file).strip
+      Jekyll.logger.info("The OpenAI API key taken from the file: \"#{file}\" (#{k.length} chars)")
+      k
     else
-      Jekyll.logger.info("The file is not found: #{file}")
+      Jekyll.logger.info("The file with the OpenAI API key is not found: \"#{file}\"")
+      nil
     end
     if key.nil? && Jekyll.env == 'development'
       Jekyll.logger.info("OPENAI_API_KEY environment variable is not set, \

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

@@ -25,6 +25,7 @@
 require 'iri'
 require 'net/http'
 require 'uri'
+require 'fileutils'
 require_relative 'version'
 
 # see https://stackoverflow.com/a/6048451/187141
@@ -46,17 +47,17 @@ class GptTranslate::Ping
     @path = path
   end
 
-  def found?(file)
+  def found?(file, marker)
     home = @site.config['url']
     return false if home.nil?
     uri = Iri.new(home).path(@path)
     before = Net::HTTP.get_response(URI(uri.to_s))
     if before.is_a?(Net::HTTPSuccess)
       html = before.body
-      if html.include?("/#{GptTranslate::VERSION}")
+      if html.include?(marker)
         Jekyll.logger.info("No need to translate, the page exists at \
 #{uri} (#{html.split.count} words), saved to #{file}")
-        File.mkdir_p(File.dirname(file))
+        FileUtils.mkdir_p(File.dirname(file))
         File.write(file, html)
         return true
       end

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

@@ -23,7 +23,6 @@
 # SOFTWARE.
 
 require 'redcarpet'
-require 'liquid'
 
 # The module we are in.
 module GptTranslate; end
@@ -42,9 +41,11 @@ class GptTranslate::Plain
     @markdown.split(/\n{2,}/).compact.map do |par|
       par.gsub!("\n", ' ')
       par.gsub!(/\s{2,}/, ' ')
+      # Liquid tags are removed, but this implementation is primitive
+      # Seehttps://stackoverflow.com/questions/
+      par.gsub!(/{{[^}]+}}/, '')
+      par.gsub!(/{%[^%]+%}/, '')
       par.strip!
-      liquid = Liquid::Template.parse(par)
-      par = liquid.render({}, drop: NullDrop.new, registers: { removed: true })
       Redcarpet::Markdown.new(Strip).render(par)
     end.join("\n\n").gsub(/\n{2,}/, "\n\n").strip
   end

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

@@ -23,5 +23,5 @@
 # SOFTWARE.
 
 module GptTranslate
-  VERSION = '0.0.1'
+  VERSION = '0.0.12'
 end

data/test/test_ping.rb

@@ -46,7 +46,7 @@ class GptTranslate::PingTest < Minitest::Test
     site = FakeSite.new({ 'url' => 'https://www.yegor256.com/' })
     ping = GptTranslate::Ping.new(site, '/about-me.html')
     Tempfile.open do |f|
-      assert(!ping.found?(f))
+      assert(ping.found?(f, ''))
     end
   end
 
@@ -55,7 +55,7 @@ class GptTranslate::PingTest < Minitest::Test
     site = FakeSite.new({ 'url' => 'https://www.yegor256.com/' })
     ping = GptTranslate::Ping.new(site, '/absent.html')
     Tempfile.open do |f|
-      assert(!ping.found?(f))
+      assert(!ping.found?(f, ''))
     end
   end
 

data/test/test_plain.rb

@@ -81,5 +81,13 @@ class GptTranslate::PlainTest < Minitest::Test
       'Hello, !',
       GptTranslate::Plain.new('Hello, {{ Java }}!').to_s
     )
+    assert_equal(
+      'Hello,  dude !',
+      GptTranslate::Plain.new('Hello, {% if a %} dude {% endif %}!').to_s
+    )
+    assert_equal(
+      'Hello, !',
+      GptTranslate::Plain.new('Hello, {% Java %}!').to_s
+    )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-chatgpt-translate
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.12
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-21 00:00:00.000000000 Z
+date: 2023-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iri
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: liquid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement