jekyll-chatgpt-translate 0.0.23 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 245b89b06aae1508c1fd00fa9575ba342ac7340212946f92308307da1e01de1e
-  data.tar.gz: 62a7ba956bc489efe84cf119457ffd181208882dd0c1939242df08a123c11b10
+  metadata.gz: 76c9c7e2f01f4350b38e1343d88918c9a89bfb5ace6bc84855bba6cd401cf027
+  data.tar.gz: 35dbf1ac0f89d6a3a68de2a1f36ae451686b665a8ef4a3f9adc4054623d45dc9
 SHA512:
-  metadata.gz: 8516fa43643cd48288761e4fbe4afdb628dab9281482ce6e486b05e33d214c610604958d70810ce6ba61918956952fadeadfa4397ffa0e0079d671bc379c01e9
-  data.tar.gz: f962f34852a2184821635ed8683f0cdcd3373934f185a716f5f1e4e20c8bacd8b671746209ce829fd241da5a61dffe52e2eae74187b957c245e64783b049d86c
+  metadata.gz: db448c1104508d9084c1b28ea687fda646b72c6c03b78e72c4423106c28d9414120b323957f0c967a7932926870fac33a7a7dc713571c0179f58cd5cdfca0f00
+  data.tar.gz: 96f431eb35b166ab4cc82575f8dbee0b80e845f5801d3d7436aede3d75becb196e3dd2aee36595742f0a664237bbe804d449e1f10348579b509111384beabb73

data/.rubocop.yml

@@ -3,7 +3,7 @@ AllCops:
     - 'bin/**/*'
     - 'assets/**/*'
   DisplayCopNames: true
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7
   SuggestExtensions: false
   NewCops: enable
 

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

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

@@ -59,11 +59,15 @@ class GptTranslate::ChatGPT
       elsif par.start_with?('```') || par.end_with?('```')
         Jekyll.logger.debug("Not translating this code block: #{par.inspect}")
         par
-      elsif par =~ /^[^\p{Alnum}\*'"]/
+      elsif par =~ /^[^\p{Alnum}\*'"\[]/
         Jekyll.logger.debug("Not translating this, b/c it's not a plain text: #{par.inspect}")
         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

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

@@ -62,6 +62,7 @@ class GptTranslate::Generator < Jekyll::Generator
     site.posts.docs.shuffle.each do |doc|
       plain = GptTranslate::Plain.new(doc.content).to_s
       config['targets'].each do |target|
+        start = 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?
@@ -106,7 +107,8 @@ class GptTranslate::Generator < Jekyll::Generator
           )
           site.pages << Jekyll::Page.new(site, site.source, File.dirname(path), File.basename(path))
           translated += 1
-          Jekyll.logger.info("Translated via ChatGPT: #{path} (#{File.size(path)} bytes)")
+          Jekyll.logger.info("Translated via ChatGPT \
+in #{(Time.now - start).round(2)}s: #{path} (#{File.size(path)} bytes)")
         end
         doc.data["translated-#{lang}-url"] = link
         doc.data['chatgpt-model'] = model

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.23'
+  VERSION = '0.0.25'
 end

data/test/test_chatgpt.rb

@@ -37,6 +37,27 @@ class GptTranslate::ChatGPTTest < Minitest::Test
     assert_equal('Hello, world!', chat.translate('Hello, world!'))
   end
 
+  def test_start_with_link
+    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!', 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-chatgpt-translate
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.25
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iri