translate_self 0.8.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7434934d496f14c0767302238db2351de6ca166dd8a137dbc53dac618198877d
-  data.tar.gz: b9973d4a3cb4b18129b847aec4cd95dca02ebe59d45c5180623d5d06b3146739
+  metadata.gz: 3440e7e27417b8402613c3b0a8b9ffefbbe3af690a6dc9600a847a56266c77b3
+  data.tar.gz: fa0310235e61ef1dc3571ef737d124743ef6d85560e8cc5777624e1e9d67c008
 SHA512:
-  metadata.gz: b9f482c4f31471092e275417f5449ed87d7527ab85ed0067039b72c138dc1ec73698298621a303fa499279a9072fa4971fa67c39cc949b2acd601be70ad29bbc
-  data.tar.gz: 00bcd9a92d53dbd96a4672d038bd9fac0820986b03c2f7cf1052a2ee4d6f37fde69fc2d09f36ca2a9a36fe9cc93bb2f0c6c7fe20cede22398bbc695466e41109
+  metadata.gz: 8473f84cbb40f018afce32d74ed4bf4a57a51de31d7f893debd079eb36f733bbdbfa2aa5eb2230afa977609b0ee11479a1e7f7b518f25eec3f02d0a59f91bc1c
+  data.tar.gz: 9d1d285395839950a413c38b94723392d281701ca1eb3986d5a39f5839bb559d865b85a3c7f78268af55ed5c80cadad63787baebecca42a48ab64f3bca8306b0

data/.rubocop.yml

@@ -1,3 +1,5 @@
+require: rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 2.5
   NewCops: enable
@@ -13,8 +15,22 @@ Style/StringLiteralsInInterpolation:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'
+
 Layout/LineLength:
   Max: 120
 
 Style/AsciiComments:
   Enabled: false
+
+RSpec/ExpectActual:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/CHANGELOG.md

@@ -1,37 +1,57 @@
-## [Unreleased]
-- Nothing new yet. 
+## [2.0.1] - 2021-11-07
+- Finally a way to get around those pesky frozen strings! 
+- By default, [defrost](https://github.com/tenderlove/defrost) is not loaded. You can turn this off by setting `TranslateSelf.defrosting = true`.
+- See `spec/frozen_strings_spec.rb` for more details and exciting ways of using it.
+- Using with frozen_string_literal: true is a great way to troll your coworkers. 
 
-## [0.1.0] - 2021-06-02
+## [1.0.1] - 2021-07-13
 
-- Initial release!
-You can now translate strings! Be free!
+- I'm reading Polished Ruby, and I just learned that it's faster to pass symbols than strings sometimes, 
+so as this library is very performance-oriented, symbols it is! 
 
-## [0.2.0] - 2021-06-03
+## [1.0.0] - 2021-06-11
 
-- Commentation and cleanup of unneeded files.
+- Refactored the translation part a bit. 
+- Now you can translate strings that are over 30 kilobyte! 
+  I couldn't test this too much because of the limits on the free plan, 
+  but if you can test this feature, I'd be really happy to hear how it is working for you. 
 
-## [0.3.0] - 2021-06-03
 
-- Gemfile.lock was not automatically updated, testing it a bit.
-Seems like you need to update it by hand! 
+## [0.9.0] - 2021-06-08
 
-## [0.4.0] - 2021-06-05
+## [0.8.0] - 2021-06-08
 
-- The translated new string now knows what language it is. 
+- Add option to use the shorter `t_to_language_code` alias. 
+## [0.7.0] - 2021-06-08
+
+- Get rid of duplicated code. Update `benchmark.rb`.
+
+## [0.6.0] - 2021-06-08
+
+- Add option to use ENV variable DEEPL_HOST
+
+# Breaking change from 0.8!
+- `t_to_language_code` was too much typing, so changed it to `to_language_code`. 
 
 ## [0.5.0] - 2021-06-06
 
 - Add TranslatableString class to work around frozen string literal magic comment. 
   Also will not crash with frozen strings now. 
 
-## [0.6.0] - 2021-06-08
+## [0.4.0] - 2021-06-05
 
-- Add option to use ENV variable DEEPL_HOST
+- The translated new string now knows what language it is. 
+## [0.3.0] - 2021-06-03
 
-## [0.7.0] - 2021-06-08
+- Gemfile.lock was not automatically updated, testing it a bit.
+Seems like you need to update it by hand! 
 
-- Get rid of duplicated code. Update `benchmark.rb`.
 
-## [0.8.0] - 2021-06-08
+## [0.2.0] - 2021-06-03
+
+- Commentation and cleanup of unneeded files.
+
+## [0.1.0] - 2021-06-02
 
-- Add option to use the shorter `t_to_language_code` alias. 
+- Initial release!
+You can now translate strings! Be free!

data/Gemfile.lock

@@ -1,20 +1,27 @@
 PATH
   remote: .
   specs:
-    translate_self (0.8.0)
+    translate_self (2.0.1)
       deepl-rb
+      defrost (~> 1.0)
+      dry-configurable (~> 0.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    deepl-rb (2.3.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    deepl-rb (2.3.1)
+    defrost (1.0.0)
     diff-lcs (1.4.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    dry-configurable (0.1.7)
+      concurrent-ruby (~> 1.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -29,29 +36,33 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.16.0)
+    rspec-support (3.10.3)
+    rubocop (1.22.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
+    rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  byebug
   rake (~> 13.0)
   rspec (~> 3.2)
   rubocop (~> 1.7)
+  rubocop-rspec
   translate_self!
 
 BUNDLED WITH
-   2.2.17
+   2.2.22

data/README.md

@@ -34,7 +34,7 @@ Now you can translate it to your language of chose with this gem!
 What's even better is that you can also save some typing by using the shortened alias such as below:
 
 ```ruby
-"hello world".t_to_ja # or t_to_fi, t_to_ru... endless possibilities!
+"hello world".to_ja # or to_fi, to_ru... endless possibilities!
 # 世界よ、ハローだ
 ```
 
@@ -59,11 +59,12 @@ Or install it yourself as:
 
     $ gem install translate_self
 
-## Usage
 
-Currently available languages:
+## Supported languages:
+
+Supported languages are: Bulgarian, Chinese, Czech, Danish, Dutch, English, Estonian, Finnish, French, German, Greek, Hungarian, Italian, Japanese, Latvian, Lithuanian, Polish, Portuguese, Romanian, Russian, Slovak, Slovenian, Spanish, and Swedish.
 
-[:bg, :cs, :da, :de, :el, :en, :es, :et, :fi, :fr, :hu, :it, :ja, :lt, :lv, :nl, :pl, :pt, :ro, :ru, :sk, :sl, :sv, :zh]
+## Usage
 
 You can assign a string a language:
 
@@ -103,6 +104,13 @@ hello.translate
 # "Moi"
 ```
 
+OR!
+Use it with [defrost](https://github.com/tenderlove/defrost)!
+By default, defrost is not loaded. You can turn this on by setting `TranslateSelf.defrosting = true`, and after that, no need to worry about frozen strings!
+This will defrost strings if they're frozen. 
+Might be a bit slower, but it's worth it!
+Interesting debug sessions guaranteed. 
+
 ## Benchmark
 
 Create a string 5000000 times. 
@@ -133,7 +141,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/translate_self. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/translate_self/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/sampokuokkanen/translate_self. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/translate_self/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/benchmark.rb

@@ -1,8 +1,8 @@
 require 'benchmark'
 
-n = 5000000
+n = 5_000_000
 Benchmark.bmbm do |x|
-  x.report("normal string") do
+  x.report('normal string') do
     n.times do
       'hello'
     end
@@ -19,4 +19,4 @@ Benchmark.bmbm do |x|
       TranslatableString.new('hello')
     end
   end
-end
+end

data/lib/ext/string.rb

@@ -1,5 +1,5 @@
 require_relative '../translate_self/translation'
-
+# String extension used by TranslateSelf
 class String
   include Translation
 end

data/lib/translate_self/translation.rb

@@ -2,11 +2,20 @@ require 'deepl'
 
 # The part where the actual translation happens.
 module Translation
-  @@languages = %w[bg cs da de el en es et fi fr hu it ja lt lv nl pl pt ro ru sk sl sv zh].freeze
-  attr_accessor :language, :to_language
+  LANGUAGES = %w[bg cs da de el en es et fi fr hu it ja lt lv nl pl pt ro ru sk sl sv zh].freeze
+  attr_accessor :language
+
+  def to_language
+    @to_language || 'fi'
+  end
+
+  def to_language=(language)
+    defroster if needs_defrosting?
+    @to_language = LANGUAGES.include?(language) ? language : 'fi'
+  end
 
   def available_languages
-    @@languages
+    LANGUAGES
   end
 
   # Translates self to the desired language. \
@@ -18,7 +27,7 @@ module Translation
   # # 'Hei'
   # @return [String] a new and shiny translated string!
   def translate
-    call_deepl(self, language, to_language)
+    call_deepl(language, to_language)
   end
 
   # Replaces self with the translation. \
@@ -30,6 +39,7 @@ module Translation
   # # 'Hei'
   # @return [String] self replaced with the new translation
   def translate!
+    defroster if needs_defrosting?
     replace translate
   end
 
@@ -40,20 +50,58 @@ module Translation
   #
   # @param [String] the language to translate to, e.g. "fi"
   # @return [String] the contents translated to another language
-  @@languages.each do |lan|
-    define_method("translate_to_#{lan}") do |language = lan|
-      call_deepl(self, self.language, language)
+  LANGUAGES.each do |lan|
+    define_method("translate_to_#{lan}".to_sym) do |language = lan|
+      call_deepl(self.language, language)
     end
-    alias_method "t_to_#{lan}", "translate_to_#{lan}"
+    alias_method "to_#{lan}".to_sym, "translate_to_#{lan}".to_sym
   end
 
   private
 
-  def call_deepl(text, language = self.language, to_lan = to_language)
+  def needs_defrosting?
+    frozen? && TranslateSelf.config.defrosting
+  end
+
+  def defroster
+    require 'defrost'
+    defrost
+  end
+
+  def break_up(to_lan)
+    sentences = break_text_into_sentences
+    sentences.length.times.map.with_index do |_i, i|
+      sentences[i].send "translate_to_#{to_lan}"
+    end.join(' ')
+  end
+
+  def break_text_into_sentences
+    last_letter = last_letter_of_self
+    tr_count = (bytesize / 25_000.to_f).ceil
+    sentences = split('.')
+    number_of_sentences = sentences.length / tr_count
+    current_count = 0
+    tr_count.times.map do |num|
+      txt = sentences[current_count..(current_count + number_of_sentences)].join('.')
+      current_count += number_of_sentences.next
+      if num == tr_count.pred
+        txt + last_letter
+      else
+        txt
+      end
+    end
+  end
+
+  def last_letter_of_self
+    end_with?('.') ? '.' : ''
+  end
+
+  def call_deepl(language = self.language, to_lan = to_language)
     warn 'No language given!' and return if to_lan.nil?
+    return break_up(to_lan) if bytesize > 30_000
 
-    response = DeepL.translate text, language, to_lan
-    self.language = response.detected_source_language.downcase if self.language.nil? && !frozen?
+    response = DeepL.translate self, language, to_lan
+    self.language = response.detected_source_language.downcase if !frozen? || (needs_defrosting? && defroster)
     actual_translation = response.text
     actual_translation.language = to_lan
     actual_translation

data/lib/translate_self/version.rb

@@ -1,3 +1,3 @@
 module TranslateSelf
-  VERSION = '0.8.0'.freeze
+  VERSION = '2.0.1'.freeze
 end

data/lib/translate_self.rb

@@ -3,9 +3,12 @@ require_relative 'translate_self/translation'
 require_relative 'translate_self/translatable_string'
 require 'ext/string'
 require 'deepl'
+require 'dry-configurable'
 
 # Dangerously include translation methods to strings!
 module TranslateSelf
+  extend Dry::Configurable
+  setting :defrosting, default: false
   DeepL.configure do |config|
     config.auth_key = ENV['DEEPL_AUTH_KEY']
     config.host = ENV['DEEPL_HOST'] || 'https://api-free.deepl.com' # Default value is 'https://api.deepl.com'