jekyll-chatgpt-translate 0.0.20 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76da34820682d38fd53ca0c5c02bf8d9e23f5665af2a6f0553f11a62d6fce452
-  data.tar.gz: 413def3d7da352c1a6c2d7dbd67722329573732d53bfbae96a1bf86c39c9c16e
+  metadata.gz: daa42e099235943fc1a5473a83796abe90b7949d1365c9d9b7349c7c86be7406
+  data.tar.gz: 6c7559aea364339a8b2ac5eac397e314491166b77cfff92565218f6cdd04499b
 SHA512:
-  metadata.gz: 715bdfed0bf33249c0091a66a0f338d89469aaa43db6fb6f80bf79a2e633d68ed0087997ce7b08b259bc24a47196061d3114d2c3f66ab8f1c7f76cc9758e0a2c
-  data.tar.gz: 6a0eeb27d20053284535b0a053ab3e0832eb6e20477bb3451ac095ce5ab48e967b7e5e607aa777269475ce846b784414382e1367ceb88daf5e24ad458440c745
+  metadata.gz: e651bfae3d35ddf473555eb168cf3301ba6dacda8352fd00a610613c9a2dc8821a1188064089f701ae94c4e4b2277f41b5d635842ae4132f92e9242828ecc0ac
+  data.tar.gz: a18e7007a9f40cfdba340285c8ef665c8c47d8e829ac6f76d304b77cec89b14ce9e9c1d56ddfd72f010429d4620f712ee773ed7011942d771c49993799bcef23

data/.rubocop.yml

@@ -18,7 +18,7 @@ Layout/MultilineMethodCallIndentation:
 Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:
-  Max: 50
+  Max: 100
 Metrics/CyclomaticComplexity:
   Max: 20
 Metrics/PerceivedComplexity:

data/README.md

@@ -1,4 +1,3 @@
-[![Gem Version](https://badge.fury.io/rb/glogin.svg)](http://badge.fury.io/rb/glogin)
 <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)

data/features/cli.feature

@@ -31,6 +31,11 @@ Feature: Simple site building
     Chinese: {{ content }}
     The original: {{ page.translated-original-url }}
     """
+    And I have a "_layouts/translated.html" file with content:
+    """
+    French: {{ content }}
+    The original: {{ page.translated-original-url }}
+    """
     And I have a "_posts/2023-01-01-hello.md" file with content:
     """
     ---
@@ -40,6 +45,7 @@ Feature: Simple site building
     Hello, world!
     """
     Then I build Jekyll site
+    And Exit code is zero
     And File "_chatgpt-translated/zh/2023-01-01-hello-zh.md" exists
     And File "_chatgpt-translated/zh/2023-01-01-hello-zh.md" contains "/2023-01-01-hello-chinese.html"
     And File "_chatgpt-translated/zh/2023-01-01-hello-zh.md" contains "translated-language: \"zh\""
@@ -48,5 +54,34 @@ Feature: Simple site building
     And File "_site/2023-01-01-hello-chinese.html" exists
     And File "_site/2023-01-01-hello-chinese.html" contains "The original: /2023/01/01/hello.html"
     And File "_site/2023/hello-french.html" exists
-    And Exit code is zero
 
+  Scenario: Simple download of existing page
+    Given I have a "_config.yml" file with content:
+    """
+    url: https://www.yegor256.com
+    markdown: kramdown
+    plugins:
+      - jekyll-chatgpt-translate
+    chatgpt-translate:
+      source: en
+      version: ""
+      api_key: "it-is-not-used, because EN to EN translation"
+      layout: should-not-be-used
+      targets:
+        -
+          language: en
+          permalink: about-me.html
+    """
+    And I have a "_posts/2023-01-01-hello.md" file with content:
+    """
+    ---
+    title: foo
+    ---
+    foo
+    """
+    Then I build Jekyll site
+    And Exit code is zero
+    And Stdout contains "No need to translate, the page exists"
+    And File "_site/2023/01/01/hello.html" exists
+    And File "_site/about-me.html" exists
+    And File "_site/about-me.html" contains "Yegor Bugayenko"

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

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

@@ -50,7 +50,10 @@ class GptTranslate::ChatGPT
   def translate(markdown, min: 32)
     markdown.split(/\n{2,}/).compact.map do |par|
       par.strip!
-      if par.length < min
+      if @source == @target
+        Jekyll.logger.debug("No need to translate from #{@source.inspect} to #{@target.inspect}: #{par.inspect}")
+        par
+      elsif par.length < min
         Jekyll.logger.debug("Not translating this, b/c too short: #{par.inspect}")
         par
       elsif par.start_with?('```') || par.end_with?('```')

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

@@ -58,7 +58,7 @@ class GptTranslate::Generator < Jekyll::Generator
     translated = 0
     copied = 0
     model = config['model'] || 'gpt-3.5-turbo'
-    marker = "Translated by ChatGPT #{model}/#{version}"
+    marker = "Translated by ChatGPT #{model}#{version.empty? ? '' : "/#{version}"}"
     site.posts.docs.shuffle.each do |doc|
       plain = GptTranslate::Plain.new(doc.content).to_s
       config['targets'].each do |target|
@@ -67,9 +67,22 @@ class GptTranslate::Generator < Jekyll::Generator
         raise 'Language must be defined for each target' if target.nil?
         path = File.join(home, lang, doc.basename.gsub(/\.md$/, "-#{lang}.md"))
         FileUtils.mkdir_p(File.dirname(path))
-        File.write(path, '') # in order to surpress warnings in Page ctor
-        dest = Jekyll::Page.new(site, site.source, File.dirname(path), File.basename(path)).destination(site.dest)
-        if config['no_download'].nil? && GptTranslate::Ping.new(site, link).found?(dest, version)
+        File.write(
+          path,
+          [
+            '---',
+            "layout: #{target['layout'] || layout}",
+            "title: #{doc['title'].to_json}",
+            "description: #{doc['description'].to_json}",
+            "permalink: #{link.to_json}",
+            "translated-original-url: #{doc.url.to_json}",
+            "translated-language: #{lang.to_json}",
+            "chatgpt-model: #{model.to_json}",
+            '---'
+          ].join("\n")
+        )
+        ping = GptTranslate::Ping.new(site, link)
+        if config['no_download'].nil? && ping.found?(version.empty? ? '' : marker)
           copied += 1
         elsif translated >= threshold
           next
@@ -84,20 +97,12 @@ class GptTranslate::Generator < Jekyll::Generator
           File.write(
             path,
             [
-              '---',
-              "layout: #{target['layout'] || layout}",
-              "title: #{doc['title'].to_json}",
-              "description: #{doc['description'].to_json}",
-              "permalink: #{link.to_json}",
-              "translated-original-url: #{doc.url.to_json}",
-              "translated-language: #{lang.to_json}",
-              "chatgpt-model: #{model.to_json}",
-              '---',
               '',
               foreign,
               '',
               "#{marker} on #{Time.now.strftime('%Y-%m-%d at %H:%M')}\n{: .jekyll-chatgpt-translate}"
-            ].join("\n")
+            ].join("\n"),
+            mode: 'a+'
           )
           site.pages << Jekyll::Page.new(site, site.source, File.dirname(path), File.basename(path))
           translated += 1
@@ -107,7 +112,8 @@ class GptTranslate::Generator < Jekyll::Generator
         doc.data['chatgpt-model'] = model
       end
     end
-    Jekyll.logger.info("#{translated} pages translated and #{copied} pages copied in #{(Time.now - start).round(2)}s")
+    Jekyll.logger.info("jekyll-chatgpt-translate #{GptTranslate::VERSION}: \
+#{translated} pages translated and #{copied} pages copied in #{(Time.now - start).round(2)}s")
   end
 
   private
@@ -128,6 +134,10 @@ class GptTranslate::Generator < Jekyll::Generator
       Jekyll.logger.info("The file with the OpenAI API key is not found: #{file.inspect}")
       nil
     end
+    if key.nil? && config['api_key']
+      Jekyll.logger.info("The OpenAI API key is found in 'api_key' of _config.yml")
+      key = config['api_key']
+    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 \

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

@@ -25,6 +25,7 @@
 require 'iri'
 require 'net/http'
 require 'uri'
+require 'jekyll'
 require 'fileutils'
 require_relative 'version'
 
@@ -47,7 +48,7 @@ class GptTranslate::Ping
     @path = path
   end
 
-  def found?(file, marker)
+  def found?(marker)
     home = @site.config['url']
     return false if home.nil?
     uri = Iri.new(home).path(@path).to_s
@@ -57,20 +58,34 @@ class GptTranslate::Ping
         html = before.body
         if html.include?(marker)
           Jekyll.logger.info("No need to translate, the page exists at \
-#{uri.inspect} (#{html.split.count} words), saved to #{file.inspect}")
-          FileUtils.mkdir_p(File.dirname(file))
-          File.write(file, html)
+#{uri.inspect} (#{html.split.count} words)")
+          @site.static_files << DownloadedFile.new(@site, @path, html)
           return true
         end
         Jekyll.logger.info("Re-translation required for #{uri.inspect}")
       else
-        Jekyll.logger.info("The page is absent, will translate #{uri.inspect}")
+        Jekyll.logger.info("The page is absent, will translate #{uri.inspect} (#{before.code})")
       end
       Jekyll.logger.debug("GET #{uri.inspect}: #{before.code}")
-    rescue StandardError => e
+    rescue Errno::ECONNREFUSED, Errno::EADDRNOTAVAIL => e
       Jekyll.logger.debug("Failed to ping #{uri.inspect}: #{e.message}")
       Jekyll.logger.info("The page is absent (#{e.class.name}): #{uri.inspect}")
     end
     false
   end
+
+  # The file we just downloaded.
+  class DownloadedFile < Jekyll::StaticFile
+    def initialize(site, path, html)
+      super(site, site.dest, '', path)
+      @html = html
+    end
+
+    def write(_dest)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.write(path, @html)
+      Jekyll.logger.info("Saved #{@html.split.count} words to #{path.inspect}")
+      true
+    end
+  end
 end

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

@@ -23,5 +23,5 @@
 # SOFTWARE.
 
 module GptTranslate
-  VERSION = '0.0.20'
+  VERSION = '0.0.22'
 end

data/test/test__helper.rb

@@ -27,3 +27,107 @@ SimpleCov.start
 
 require 'jekyll'
 Jekyll.logger.adjust_verbosity(verbose: true)
+
+# The module we are in.
+module GptTranslate; end
+
+# Fake.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# License:: MIT
+class GptTranslate::FakeSite
+  attr_reader :config, :pages, :static_files
+
+  def initialize(config, docs = [])
+    @config = config
+    @docs = docs
+    @pages = []
+    @static_files = []
+  end
+
+  def posts
+    GptTranslate::FakePosts.new(@docs)
+  end
+
+  def permalink_style
+    ''
+  end
+
+  def frontmatter_defaults
+    Jekyll::FrontmatterDefaults.new(self)
+  end
+
+  def converters
+    [Jekyll::Converters::Markdown.new({ 'markdown_ext' => 'md' })]
+  end
+
+  def source
+    ''
+  end
+
+  def dest
+    return '' if @docs.empty?
+    File.dirname(@docs[0])
+  end
+
+  def in_theme_dir(base, _foo = nil, _bar = nil)
+    base
+  end
+
+  def in_dest_dir(*paths)
+    paths[0].dup
+  end
+end
+
+# Fake.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# License:: MIT
+class GptTranslate::FakeDocument
+  attr_reader :data
+
+  def initialize(path)
+    @path = path
+    @data = { 'date' => Time.now, 'title' => 'Hello!' }
+  end
+
+  def content
+    'Hello, world!'
+  end
+
+  def []=(key, value)
+    @data[key] = value
+  end
+
+  def [](key)
+    @data[key] || ''
+  end
+
+  def relative_path
+    @path
+  end
+
+  def url
+    '2023-01-01-hello.html'
+  end
+
+  def basename
+    '2023-01-01-hello.md'
+  end
+end
+
+# Fake.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# License:: MIT
+class GptTranslate::FakePosts
+  attr_reader :config
+
+  def initialize(docs)
+    @docs = docs
+  end
+
+  def docs
+    @docs.map { |d| GptTranslate::FakeDocument.new(d) }
+  end
+end

data/test/test_generator.rb

@@ -33,98 +33,11 @@ require_relative '../lib/jekyll-chatgpt-translate/generator'
 # Copyright:: Copyright (c) 2023 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::GeneratorTest < Minitest::Test
-  class FakeSite
-    attr_reader :config, :pages
-
-    def initialize(config, docs)
-      @config = config
-      @docs = docs
-      @pages = []
-    end
-
-    def posts
-      FakePosts.new(@docs)
-    end
-
-    def permalink_style
-      ''
-    end
-
-    def frontmatter_defaults
-      Jekyll::FrontmatterDefaults.new(self)
-    end
-
-    def converters
-      [Jekyll::Converters::Markdown.new({ 'markdown_ext' => 'md' })]
-    end
-
-    def source
-      ''
-    end
-
-    def dest
-      File.dirname(@docs[0])
-    end
-
-    def in_theme_dir(base, _foo = nil, _bar = nil)
-      base
-    end
-
-    def in_dest_dir(*paths)
-      paths[0].dup
-    end
-  end
-
-  class FakeDocument
-    attr_reader :data
-
-    def initialize(path)
-      @path = path
-      @data = { 'date' => Time.now, 'title' => 'Hello!' }
-    end
-
-    def content
-      'Hello, world!'
-    end
-
-    def []=(key, value)
-      @data[key] = value
-    end
-
-    def [](key)
-      @data[key] || ''
-    end
-
-    def relative_path
-      @path
-    end
-
-    def url
-      '2023-01-01-hello.html'
-    end
-
-    def basename
-      '2023-01-01-hello.md'
-    end
-  end
-
-  class FakePosts
-    attr_reader :config
-
-    def initialize(docs)
-      @docs = docs
-    end
-
-    def docs
-      @docs.map { |d| FakeDocument.new(d) }
-    end
-  end
-
   def test_simple_scenario
     Dir.mktmpdir do |home|
       post = File.join(home, '2023-01-01-hello.md')
       File.write(post, "---\ntitle: Hello\n---\n\nHello, world!")
-      site = FakeSite.new(
+      site = GptTranslate::FakeSite.new(
         {
           'url' => 'https://www.yegor256.com/',
           'chatgpt-translate' => {
@@ -150,7 +63,7 @@ class GptTranslate::GeneratorTest < Minitest::Test
     Dir.mktmpdir do |home|
       post = File.join(home, '2023-01-01-hello.md')
       File.write(post, "---\ntitle: Hello\n---\n\nHello, world!")
-      site = FakeSite.new(
+      site = GptTranslate::FakeSite.new(
         {
           'chatgpt-translate' => {
             'threshold' => 1,

data/test/test_ping.rb

@@ -34,39 +34,28 @@ require_relative '../lib/jekyll-chatgpt-translate/ping'
 # Copyright:: Copyright (c) 2023 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::PingTest < Minitest::Test
-  class FakeSite
-    attr_reader :config
-
-    def initialize(config)
-      @config = config
-    end
-  end
-
   def test_when_exists
-    stub_request(:any, 'https://www.yegor256.com/about-me.html')
-    site = FakeSite.new({ 'url' => 'https://www.yegor256.com/' })
+    stub_request(:any, 'https://www.yegor256.com/about-me.html').to_return(body: 'Hello!')
+    site = GptTranslate::FakeSite.new({ 'url' => 'https://www.yegor256.com/' })
     ping = GptTranslate::Ping.new(site, '/about-me.html')
-    Tempfile.open do |f|
-      assert(ping.found?(f, ''))
-    end
+    assert(ping.found?(''))
+    assert_equal(1, site.static_files.size)
   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/' })
+    site = GptTranslate::FakeSite.new({ 'url' => 'https://www.yegor256.com/' })
     ping = GptTranslate::Ping.new(site, '/absent.html')
-    Tempfile.open do |f|
-      assert(!ping.found?(f, ''))
-    end
+    assert(!ping.found?(''))
+    assert_equal(0, site.static_files.size)
   end
 
   def test_wrong_address
     WebMock.allow_net_connect!
-    site = FakeSite.new({ 'url' => 'https://localhost:1/' })
+    site = GptTranslate::FakeSite.new({ 'url' => 'https://localhost:1/' })
     ping = GptTranslate::Ping.new(site, '/boom.html')
-    Tempfile.open do |f|
-      assert(!ping.found?(f, ''))
-    end
+    assert(!ping.found?(''))
+    assert_equal(0, site.static_files.size)
   end
 
   def test_relative_path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-chatgpt-translate
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.22
 platform: ruby
 authors:
 - Yegor Bugayenko