jekyll-chatgpt-translate 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e80c34ee1b28dc84b884ad53ef3f68d1b5bb9d0ba9620e1c50e7fe97abe6785
-  data.tar.gz: d47885e2ac998c1d57004c784baba4ecb3988ec39d697771a0082a76a46097a2
+  metadata.gz: 951ecc1df96633e4552be477e42c43977b0187282978d9cb1c07bedc3913e8fa
+  data.tar.gz: 9fb20f291797eaee903f0ca20aaf0adcc7ed65fd77626dda6afbe3c6390418cd
 SHA512:
-  metadata.gz: 5cc86659f819d55cab262ce1658a70e25b1ba361ec46a03d43063e644bb2ba01d9e0e986a29fd1c85ca0867e87e00bd7dfb5852c448ec29ba9bd72f1c6d998a9
-  data.tar.gz: b1735adc1ac05a53bb65a9e49467bd4aa79299ab9a0c9de1e68d199ce8852820ff8d9f260f8f9d5f7137432fbd27d69b69d18f3cbbaa3d5730e7439253764523
+  metadata.gz: d94a2be708d58bb23427a707660276ce7d42dc90372924644b76558933c631834d3eeece4b1bb46c5b89221c3d758b62e71958137e355edb02451ef671fc9f03
+  data.tar.gz: 623f0e383d89805288678b37d9304d365b3adf6995d60c9bec4e7a9e6c85e2be44cb51e4a1001892cb5919a55799f99dfe9e174c5edf931f9f2e641d24ffed37

data/Gemfile

@@ -32,3 +32,4 @@ gem 'rake', '13.0.6', require: false
 gem 'rubocop', '1.55.1', 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/features/cli.feature

@@ -13,11 +13,11 @@ 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:
     """
@@ -30,13 +30,15 @@ Feature: Simple site building
     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-chinese.html" exists
+    Then File "_site/2023/hello-french.html" exists
     And Exit code is zero
 

data/features/step_definitions/steps.rb

@@ -50,7 +50,7 @@ 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(/^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.5'
+  s.version = '0.0.7'
   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

@@ -24,6 +24,7 @@
 
 require 'jekyll'
 require_relative 'chatgpt'
+require_relative 'permalink'
 require_relative 'ping'
 require_relative 'plain'
 require_relative 'version'
@@ -42,11 +43,12 @@ class GptTranslate::Generator < Jekyll::Generator
   # Main plugin action, called by Jekyll-core
   def generate(site)
     @site = site
+    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')
+      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
     if key.nil?
@@ -60,7 +62,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 = permalink(doc, target['permalink'])
+        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?
@@ -76,7 +78,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,
@@ -97,7 +99,7 @@ but pages will be generated')
       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
@@ -106,13 +108,4 @@ but pages will be generated')
   def config
     @config ||= @site.config['chatgpt-translate'] || {}
   end
-
-  def permalink(doc, template)
-    raise 'permalink must be defined for each target' if template.nil?
-    template
-      .gsub(':year', format('%04d', doc['date'].year))
-      .gsub(':month', format('%02d', doc['date'].month))
-      .gsub(':day', format('%02d', doc['date'].day))
-      .gsub(':title', doc['title'])
-  end
 end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2023 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'cgi'
+
+# The module we are in.
+module GptTranslate; end
+
+# Permalink.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# License:: MIT
+class GptTranslate::Permalink
+  def initialize(doc, template)
+    @doc = doc
+    raise 'permalink must be defined for each target' if template.nil?
+    @template = template
+  end
+
+  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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2023 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require_relative '../lib/jekyll-chatgpt-translate/permalink'
+
+# Permalink test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2023 Yegor Bugayenko
+# License:: MIT
+class GptTranslate::PermalinkTest < Minitest::Test
+  def test_simple_link
+    assert_equal(
+      '/2023.html',
+      GptTranslate::Permalink.new(
+        { 'date' => Time.parse('2023-01-01'), 'title' => 'Hello', 'slug' => 'hello' },
+        ':year.html'
+      ).to_path
+    )
+  end
+
+  def test_unicode_link
+    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' => '#привет', '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.5
+  version: 0.0.7
 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
@@ -121,6 +121,7 @@ files:
 - lib/jekyll-chatgpt-translate.rb
 - lib/jekyll-chatgpt-translate/chatgpt.rb
 - lib/jekyll-chatgpt-translate/generator.rb
+- lib/jekyll-chatgpt-translate/permalink.rb
 - lib/jekyll-chatgpt-translate/ping.rb
 - lib/jekyll-chatgpt-translate/plain.rb
 - lib/jekyll-chatgpt-translate/version.rb
@@ -128,6 +129,7 @@ files:
 - test/test__helper.rb
 - test/test_chatgpt.rb
 - test/test_generator.rb
+- test/test_permalink.rb
 - test/test_ping.rb
 - test/test_plain.rb
 homepage: https://github.com/yegor256/jekyll-chatgpt-translate