translate_self 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d621cceb4a433a739bd6656dc910084900ffabd8a93969f4fd167e7ae8204bc1
-  data.tar.gz: 9b8ba476746f15856f4788b3c32cc5ab71bb24c3933168fc79a2fbdaa82d5a52
+  metadata.gz: 680f027a575420fab6eb29bbdb7a49a0410e8b6e51adb0775c6dc884539d84bc
+  data.tar.gz: 51afe0c1d56642d3a9b0d6b2578de001da729a10f8c05b2f61a8ed04f383d639
 SHA512:
-  metadata.gz: 77ef05a2eda347e2bc4836d24aff629751217f2765edda9bfb72b2265040dc6a7ee2812e1f28ca205465cc449a82c543236276db13810f319223d73be73d87cd
-  data.tar.gz: 426ce380fa7762b630816d2ce4b94036b62299e1618ce64d100f1db821d37786272c89c7b5e8a52fcbe6614b5808a241221892636d00d9741812aed1a2915ea3
+  metadata.gz: ead7740d0183cb4959789c62ebebd6ed2bc5a3f528d1b1a4b1e97e71e3607b30dbf52686878dc5bb60e566be3516bcbdd23cfc7e9237cc2ddf0647ac0405a9f2
+  data.tar.gz: 42b7fa5b9d7c68b98fd6884c24808834287c2b0ec63b252970c43bb3fe4083bd5c3a6c3aff5d474fac478ae7b33d8de59dc735c9ad42c9014d1f11167682e65b

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 /.idea/
+.byebug_history
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.5
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -4,4 +4,30 @@
 ## [0.1.0] - 2021-06-02
 
 - Initial release!
-You can now translate strings! Be free!
+You can now translate strings! Be free!
+
+## [0.2.0] - 2021-06-03
+
+- Commentation and cleanup of unneeded files.
+
+## [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.4.0] - 2021-06-05
+
+- The translated new string now knows what language it is. 
+
+## [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
+
+- Add option to use ENV variable DEEPL_HOST
+
+## [0.7.0] - 2021-06-08
+
+- Get rid of duplicated code. Update `benchmark.rb`.

data/Gemfile

@@ -3,4 +3,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in translate_self.gemspec
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    translate_self (0.1.0)
+    translate_self (0.7.0)
       deepl-rb
 
 GEM

data/README.md

@@ -1,5 +1,8 @@
 # TranslateSelf
 
+[![Gem Version](http://img.shields.io/gem/v/translate_self.svg)](https://rubygems.org/gems/translate_self)
+[![Gem Downloads](https://img.shields.io/gem/dt/translate_self.svg)](https://rubygems.org/gems/translate_self)
+
 Strings in Ruby are a bit hard to understand if you're not an English speaker. 
 What does 
 ```ruby
@@ -8,13 +11,19 @@ What does
 even mean? I for one didn't study enough English to understand that!
 But worry no more! 
 
+[![asciicast](https://asciinema.org/a/TJU6H5iPopKrUwqwYnLUX3Y2o.svg)](https://asciinema.org/a/TJU6H5iPopKrUwqwYnLUX3Y2o)
+
 Just get a DeepL auth key and export it as follows:
 
 ```sh
 export DEEPL_AUTH_KEY="your-api-token"
 ```
 
-This gem currently hardcodes the free DeepL servers. # TODO 
+By default this gem uses the free DeepL servers, but you can also configure your own:
+
+```sh
+export DEEPL_HOST="non-free-host"
+```
 
 Now you can translate it to your language of chose with this gem!
 ```ruby
@@ -72,9 +81,42 @@ finn.translate
 # I am a Finn
 ```
 
-## Beware!
+## Using with `# frozen_string_literal: true`
+
+~~Does not work if you freeze the strings.~~ 
 
-Does not work if you freeze the strings. 
+Now it does! 
+Just use the classes `TranslatableString` (aliased to `TString`). 
+So even if you have a magic comment making all your strings frozen, 
+you can still use the `translate` method like below:
+
+```ruby
+hello = TranslatableString.new('hello', language: 'en', to_language: 'fi')
+hello.translate
+# "Moi"
+```
+
+## Benchmark
+
+Create a string 5000000 times. 
+
+```shell
+C:\home\sampo\translate_self> ruby benchmark.rb 
+Rehearsal --------------------------------------------------------
+normal string          0.221517   0.000101   0.221618 (  0.221677)
+monkeypatched string   0.267748   0.000000   0.267748 (  0.267865)
+translatable string    1.878466   0.000000   1.878466 (  1.878497)
+----------------------------------------------- total: 2.367832sec
+
+                           user     system      total        real
+normal string          0.225292   0.000000   0.225292 (  0.225289)
+monkeypatched string   0.225690   0.000000   0.225690 (  0.225740)
+translatable string    1.886653   0.000000   1.886653 (  1.886735)
+
+```
+So... the overhead might be surprisingly low!
+If you use the TranslatableString class, there is some overhead. 
+But if you just hack string it's pretty fast! See `benchmark.rb`.
 
 ## Development
 

data/benchmark.rb

@@ -0,0 +1,22 @@
+require 'benchmark'
+
+n = 5000000
+Benchmark.bmbm do |x|
+  x.report("normal string") do
+    n.times do
+      'hello'
+    end
+  end
+  x.report('monkeypatched string') do
+    require 'translate_self'
+    n.times do
+      'hello'
+    end
+  end
+  x.report('translatable string') do
+    require 'translate_self'
+    n.times do
+      TranslatableString.new('hello')
+    end
+  end
+end

data/lib/translate_self.rb

@@ -1,14 +1,13 @@
 require_relative 'translate_self/version'
 require_relative 'translate_self/translation'
+require_relative 'translate_self/translatable_string'
 require 'ext/string'
 require 'deepl'
 
 # Dangerously include translation methods to strings!
 module TranslateSelf
-  include Translation
-  class Error < StandardError; end
   DeepL.configure do |config|
-    config.host = 'https://api-free.deepl.com' # Default value is 'https://api.deepl.com'
+    config.auth_key = ENV['DEEPL_AUTH_KEY']
+    config.host = ENV['DEEPL_HOST'] || 'https://api-free.deepl.com' # Default value is 'https://api.deepl.com'
   end
-  AVAILABLE_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
 end

data/lib/translate_self/translatable_string.rb

@@ -0,0 +1,11 @@
+# A class that let's you translate strings with
+# the language and to_language params even if you happen to
+# freeze them. Aliased to TString.
+class TranslatableString < String
+  def initialize(str, language: nil, to_language: nil)
+    super str
+    self.language = language
+    self.to_language = to_language
+  end
+end
+TString = TranslatableString

data/lib/translate_self/translation.rb

@@ -2,10 +2,11 @@ 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
 
   def available_languages
-    TranslateSelf::AVAILABLE_LANGUAGES
+    @@languages
   end
 
   # Translates self to the desired language. \
@@ -39,7 +40,7 @@ module Translation
   #
   # @param [String] the language to translate to, e.g. "fi"
   # @return [String] the contents translated to another language
-  %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].each do |lan|
+  @@languages.each do |lan|
     define_method("translate_to_#{lan}") do |language = lan|
       call_deepl(self, self.language, language)
     end
@@ -51,7 +52,9 @@ module Translation
     warn 'No language given!' and return if to_lan.nil?
 
     response = DeepL.translate text, language, to_lan
-    self.language = response.detected_source_language.downcase if self.language.nil?
-    response.text
+    self.language = response.detected_source_language.downcase if self.language.nil? && !frozen?
+    actual_translation = response.text
+    actual_translation.language = to_lan
+    actual_translation
   end
 end

data/lib/translate_self/version.rb

@@ -1,3 +1,3 @@
 module TranslateSelf
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: translate_self
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deepl-rb
@@ -75,7 +75,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -87,10 +86,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark.rb
 - bin/console
 - bin/setup
 - lib/ext/string.rb
 - lib/translate_self.rb
+- lib/translate_self/translatable_string.rb
 - lib/translate_self/translation.rb
 - lib/translate_self/version.rb
 - translate_self.gemspec

data/.byebug_history

@@ -1,48 +0,0 @@
-c
-@language
-c
-@language
-self
-c
-self
-c
-self
-c
-self
-c
-suomalainen.language
-suomalainen.language = 'fi'
-suomalainen.language
-c
-suomalainen.language
-c
-self.language
-c
-self.language
-self.language = 'fi'
-response.detected_source_language
-self.language.nil?
-self.language
-self
-c
-available_languages.include?(name.to_s[-2..-1])
-available_languages.include?(name.to_s[-2..-1].to_sym)
-exit
-c
-available_languages.include?(name.to_s[-2..-1].to_sym)
-available_languages.include?(name.to_s[-2..-1])
-name.to_s[-2..-1]
-name
-c
-languages.map(&:code).map(&:downcase)
-languages.map(&:code)
-languages.map(&:code.downcase.to_sym)
-languages = DeepL.languages
-c
-self
-self.replace 'kon'
-self.instance_methods(false)
-self.attributes
-self = 'kon'
-language
-self