jekyll-chatgpt-translate 0.0.24 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 496c59378248bd1973071e0ed6d01d0e55253cf0c47dce9f72b2704ba315e9e3
-  data.tar.gz: 13905a9d5f52ed1558f1e0679af7ec236936b4d77eb97d0c8e63ce3e0cb72ac7
+  metadata.gz: 9f480f74d9f096d1b24d516f05c1c24a27cefe7e87cc9db917d2fffe727646fe
+  data.tar.gz: 0dd088c831b8a3d9685bf4363ea7821d83d8602767fb933740b938552475d98e
 SHA512:
-  metadata.gz: 63e2c67379437c2f6aa20cff512452fcb2d2237b1e5d8a1d8bb0155c67a4ee044bfb4957765bff3daab4d24fdb875779ec9bffd8419e1331f0efd3667ee19d38
-  data.tar.gz: 84ab3c8daa5173849cbcaeeb067ddf7470fa04b099c1793582c99f44f4a64e0fbf65b842817e0c489996cd742d8335de3f4fc62576aaede50212aeb4ff7d7c22
+  metadata.gz: c286215fa7b40fab206be74d7f03d02963f307009ba6d91c0f1ff7ce06795eb29be1588c022a994696755677e6640fb595aca7246474d8a1bc9072f38f5458a1
+  data.tar.gz: af831575ce9749aada2c42ad5c4d8798890490e5e0795cd87f70cce9a2d8b7bbaa3d7dfba9b95e9b5f81eaef2e9f9513ca1542341e1393bc4878c6ee257911af

data/.rubocop.yml

@@ -3,7 +3,7 @@ AllCops:
     - 'bin/**/*'
     - 'assets/**/*'
   DisplayCopNames: true
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7
   SuggestExtensions: false
   NewCops: enable
 
@@ -35,3 +35,5 @@ Layout/EndAlignment:
   Enabled: false
 Metrics/ClassLength:
   Max: 200
+Style/ClassVars:
+  Enabled: false

data/README.md

@@ -60,9 +60,14 @@ 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.
+  * `api_key` (optional) — the OpenAI API key itself. This is a very bad idea to
+    specify it right in the `_config.yml` file, but it's still possible.
 
-  * `source` (optional) — is the ISO-839-1 code of the source language.
+  * `model` (optional) — specifies the model to use by ChatGPT, 
+    [examples are here](https://github.com/alexrudall/ruby-openai#models).
+
+  * `source` (optional) — is the [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) 
+    code of the source language.
 
   * `no_download` (optional) — if this attribute is present, the plugin won't try
     to find HTML versions of translated pages in the Internet and won't try to 
@@ -79,7 +84,7 @@ This layout will be specified for the pages generated by this plugin.
 
   * `targets` (mandatory) — an array of target languages, each of which has the following attributes
 
-    * `language` (mandatory) — ISO-839-1 code of the target language
+    * `language` (mandatory) — [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code of the target language
 
     * `permalink` (mandatory) — template to use for newly generated pages
 
@@ -93,7 +98,7 @@ This layout will be specified for the pages generated by this plugin.
   * `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.
+    this plugin will be used, 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.24'
+  s.version = '0.0.26'
   s.license = 'MIT'
   s.summary = 'Translate Jekyll Pages Through ChatGPT'
   s.description = [

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

@@ -35,6 +35,9 @@ module GptTranslate; end
 # Copyright:: Copyright (c) 2023 Yegor Bugayenko
 # License:: MIT
 class GptTranslate::ChatGPT
+  # Is TRUE if we already shown to the user the available models.
+  @@models_printed = false
+
   # Ctor.
   # +key+ OpenAI API Key, which can't be nil, but can be empty string, which means dry mode (no calls to OpenAI)
   # +source+ The language to translate from
@@ -64,6 +67,10 @@ class GptTranslate::ChatGPT
         par
       elsif @key.empty?
         par
+      elsif par.start_with?('* ')
+        "* #{translate_par(par[2..])}"
+      elsif par =~ /^[0-9]+\. /
+        "1. #{translate_par(par.split('.', 2)[1])}"
       else
         translate_par(par)
       end
@@ -73,12 +80,17 @@ class GptTranslate::ChatGPT
   private
 
   def translate_par(par)
+    client = OpenAI::Client.new(access_token: @key)
+    if @@models_printed
+      Jekyll.logger.info("Available ChatGPT models: #{client.models.list['data'].map { |m| m['id'] }.join(', ')}")
+      @@models_printed = true
+    end
+    prompt = GptTranslate::Prompt.new(par, @source, @target).to_s
     start = Time.now
     answer = nil
     attempt = 0
     begin
-      prompt = GptTranslate::Prompt.new(par, @source, @target).to_s
-      response = OpenAI::Client.new(access_token: @key).chat(
+      response = client.chat(
         parameters: {
           model: @model,
           messages: [{ role: 'user', content: prompt }],
@@ -86,7 +98,10 @@ class GptTranslate::ChatGPT
         }
       )
       answer = response.dig('choices', 0, 'message', 'content')
-      raise 'No content returned by ChatGPT' if answer.nil?
+      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

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

@@ -106,8 +106,8 @@ class GptTranslate::Plain
       content
     end
 
-    def list_item(content, _type)
-      "#{content.strip}\n\n"
+    def list_item(content, type)
+      "#{type == :ordered ? '1.' : '*'} #{content.strip}\n\n"
     end
 
     def paragraph(text)

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

@@ -23,5 +23,5 @@
 # SOFTWARE.
 
 module GptTranslate
-  VERSION = '0.0.24'
+  VERSION = '0.0.26'
 end

data/test/test_chatgpt.rb

@@ -44,6 +44,20 @@ class GptTranslate::ChatGPTTest < Minitest::Test
     assert_equal('done!', chat.translate('[OpenAI](https://openai.com) is the creator of ChatGPT', min: 10))
   end
 
+  def test_unordered_list_item
+    stub_request(:any, 'https://api.openai.com/v1/chat/completions')
+      .to_return(body: '{"choices":[{"message":{"content": "done!"}}]}')
+    chat = GptTranslate::ChatGPT.new('fake-key', 'gpt-3.5-turbo', 'en', 'ru')
+    assert_equal("* done!\n\n* done!", chat.translate("* First\n\n* Second", min: 1))
+  end
+
+  def test_ordered_list_item
+    stub_request(:any, 'https://api.openai.com/v1/chat/completions')
+      .to_return(body: '{"choices":[{"message":{"content": "done!"}}]}')
+    chat = GptTranslate::ChatGPT.new('fake-key', 'gpt-3.5-turbo', 'en', 'ru')
+    assert_equal("1. done!\n\n1. done!", chat.translate("1. First\n\n2. Second", min: 1))
+  end
+
   def test_dry_mode
     chat = GptTranslate::ChatGPT.new('', 'foo', 'xx', 'xx')
     assert_equal(38, chat.translate('This text should not be sent to OpenAI', min: 100).length)

data/test/test_plain.rb

@@ -42,25 +42,25 @@ class GptTranslate::PlainTest < Minitest::Test
 
   def test_lists
     assert_equal(
-      "first\n\nsecond\n\nthird",
+      "* first\n\n* second\n\n* third",
       GptTranslate::Plain.new("* first\n\n* second\n\n* third").to_s
     )
     assert_equal(
-      'first',
+      '* first',
       GptTranslate::Plain.new("* first\n\n\n\n").to_s
     )
   end
 
   def test_ordered_list
     assert_equal(
-      "first\n\nsecond\n\nthird",
+      "1. first\n\n1. second\n\n1. third",
       GptTranslate::Plain.new("1. first\n\n2. second\n\n3. third").to_s
     )
   end
 
   def test_compact_list
     assert_equal(
-      "first\n\nsecond\n\nthird",
+      "* first\n\n* second\n\n* third",
       GptTranslate::Plain.new("* first\n* second\n* third").to_s
     )
   end
@@ -151,11 +151,11 @@ class GptTranslate::PlainTest < Minitest::Test
 
 In this *lovely* letter I will explain how objects work in C++:
 
-Declare a class
+* Declare a class
 
-Make an instance of it
+* Make an instance of it
 
-Delete the instance
+* Delete the instance
 
 ## More details
 

metadata

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