translate_self 0.3.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3327edb424a2cb958b0c393f3dfe5bc057cf925d1f92043ec0a6be71df3add4a
-  data.tar.gz: 3dfd89f27f7c48dccba36900301c76fb7a2adcfe534a4586936185d0fe4a3f89
+  metadata.gz: 7434934d496f14c0767302238db2351de6ca166dd8a137dbc53dac618198877d
+  data.tar.gz: b9973d4a3cb4b18129b847aec4cd95dca02ebe59d45c5180623d5d06b3146739
 SHA512:
-  metadata.gz: 4d66138e6ee261acbb8054501e3d99c15b95f08fc8e0250b96da0448282b7241243bcf83f15429ba316019a1bf0be30987a238083df011391313b89e1e44c984
-  data.tar.gz: fcce9b4ab0af49522be5e68128dd436ddc16e1fd733440bb4a2ca1ca6b5c01985dd5b45882420909d1d6c42584277606677c031951f1128fa4324ea4104b4091
+  metadata.gz: b9f482c4f31471092e275417f5449ed87d7527ab85ed0067039b72c138dc1ec73698298621a303fa499279a9072fa4971fa67c39cc949b2acd601be70ad29bbc
+  data.tar.gz: 00bcd9a92d53dbd96a4672d038bd9fac0820986b03c2f7cf1052a2ee4d6f37fde69fc2d09f36ca2a9a36fe9cc93bb2f0c6c7fe20cede22398bbc695466e41109

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

@@ -15,3 +15,23 @@ You can now translate strings! Be free!
 - 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`.
+
+## [0.8.0] - 2021-06-08
+
+- Add option to use the shorter `t_to_language_code` alias. 

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.3.0)
+    translate_self (0.8.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
@@ -22,6 +31,13 @@ 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!
+# 世界よ、ハローだ
+```
+
 This gem uses the wonderful DeepL for Ruby as its backend.
 
 https://github.com/wikiti/deepl-rb
@@ -72,9 +88,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. \
@@ -32,17 +33,18 @@ module Translation
     replace translate
   end
 
-  # Translates the string itself to a language the user wants to translate it to. \
+  # Translates the string itself to a language the user wants to translate it to.
   # Sample usage:
   # 'hello'.translate_to_fi
   # # Hei
   #
   # @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
+    alias_method "t_to_#{lan}", "translate_to_#{lan}"
   end
 
   private
@@ -51,7 +53,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.3.0'.freeze
+  VERSION = '0.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: translate_self
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.8.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