slimkeyfy 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19d0a4d7e4a6b8c2e5a7082ef08f7c28493d4e38
-  data.tar.gz: 9cd1467d4e37f17a3157e2e729f3cd2781d4825c
+  metadata.gz: 3060e269599400cb5c6f08f20765aa8a69544551
+  data.tar.gz: fa2fbd45f6a32e10dbcd730d52ddefc9c7354e12
 SHA512:
-  metadata.gz: 19e37288365b2471c828b347197c19f6928a22fbd7232aa1f2506b08ecad70864f0fce06735c84fc52d6276b057091ec9e519a88ad497a5a6ab1f277079f3f25
-  data.tar.gz: edc05e14a643ba3d92f7c5b8bac7cb23579591f6c43818d510dea3d61e0fe1a85c5476f447736990802a30c13e465aa096514364668f565ec524b663b7b0ee3b
+  metadata.gz: 41e0f4bab018c96e341fb79581f011760f4334f81c168e081317e267305886f31415b3319c4c9f5a5a581c31fbeeaf16a5c183e55732bb1f12228c3d909669e8
+  data.tar.gz: fe503865ca14b56af2fe288b91e6c2ccc3c032f5da5a4e875755b15919ec6bf08308cafbae7888ed434e4022cfc9fb6dd7f2b22537e8d4e92d6417a2ed97ee5c

data/Gemfile

@@ -1,6 +1,14 @@
 source 'https://rubygems.org'
 
-ruby '2.1.1'
+ruby '>= 2.1.1'
+
+gem 'russian'
+gem 'yandex-translator'
+
+group :development do
+  # gem 'pry-byebug'
+end
+
 
 gem 'rspec', :require => 'spec'
 

data/Gemfile.lock

@@ -1,22 +1,33 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.2.5)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.2)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.2)
+    diff-lcs (1.3)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    i18n (0.8.1)
+    multi_xml (0.6.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.2)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.2)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    russian (0.6.0)
+      i18n (>= 0.5.0)
+    yandex-translator (0.3.2)
+      httparty (>= 0.13.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   rspec
+  russian
+  yandex-translator

data/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2014 PhraseApp.com
+Copyright (c) 2014 Dynport GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

data/README.md

@@ -1,8 +1,11 @@
 Slimkeyfy
 =
-Extract plain Strings from .slim views and Rails controllers to replace them with I18n's t() method. Keys with it's translations will be streamed to a YAML file.
+Extract plain Strings from .slim views and Rails controllers to replace them with I18n's t() method. 
+Keys with it's translations will be streamed to a YAML file.
+Non english keys get translated with yandex translator gem ( you need to get your api first ). 
+Russian keys get transliterated in case API KEY is missed.
 
-Read more in this blog post: [PhraseApp Blog: Make your Rails App localizable with Slimkeyfy](http://blog.phraseapp.com/post/96450272307/make-your-rails-app-localizable-with-slimkeyfy)
+Read more in this blog post: [PhraseApp Blog: Make your Rails App localizable with Slimkeyfy](https://phraseapp.com/blog/posts/slim-localize-your-slim-templates-in-a-second-with-slimkeyfy/)
 
 ```ruby
 slimkeyfy app/views/users/show.html.slim en
@@ -31,7 +34,7 @@ group :development do
   # Github
   gem 'slimkeyfy', github: 'https://github.com/phrase/slimkeyfy.git'
   # or with concrete version
-  gem 'slimkeyfy', '~> 0.0.3'
+  gem 'slimkeyfy', '~> 0.X'
 end
 ```
 
@@ -48,6 +51,28 @@ slimkeyfy INPUT_FILENAME_OR_DIRECTORY LOCALE (e.g. en, fr) [YAML_FILE] [Options]
 - If you provide one make sure that the top level locale matches your provided locale
 - The YAML file will be loaded as a hash and deep_merged with the new found translations
 
+I18n for keys addition
+----------------------
+( from alekseyl translator branch: https://github.com/alekseyl/slimkeyfy/tree/translator )
+I18n keys better be in english so if you start I18n from other than en locale you cannot use original slikeyfy approach, you need to translate keys first
+Two options added to CLI: 
+```unix
+  '-t', '--translator-api-key [API_KEY]', 'API key for Yandex Translator'
+  '-l', '--keys-from-locale LOCALE', 'translate keys from locale'  
+```
+
+API key can be given directly in CLI or added with export:
+
+```unix
+   export YANDEX_TRANSLATOR_API="YANDEX_TRANSLATOR_API_KEY"
+```
+
+How to get one:
+Go to https://tech.yandex.com/keys/get/?service=trnsl
+Click on "register an account"
+Fill in the form, with your mobile phone number. Click on send code and Yandex will send you a 4 digit code to your mobile phone. Enter the code from your phone to complete registration. Yandex will then give you an API key
+
+
 **Stream** - walks through the given file/files and if a regex hits you will be prompted to apply (y)es, discard (n)o, tag (x) (comments suggestions above the processed line) or (a)bort (only aborts the current file).
 
 without YAML file
@@ -149,19 +174,22 @@ bundle exec rspec spec/
 ```
 PhraseApp Integration
 -
-Now that you processed your views and moved the generated keys to your localization files it is quite easy to push it to PhraseApp. If you have not set up your account yet [take a look here](https://phraseapp.com/docs/about/setup-your-translations-with-phraseapp?language=en). Make sure that the latest gem of PhraseApp is installed by simply typing:
+Now that you processed your views and moved the generated keys to your localization files it is quite easy to push it to PhraseApp. If you have not set up your account yet [take a look here](https://phraseapp.com/). Make sure that the latest gem of PhraseApp is installed by simply typing:
 ```unix
 > gem install phrase
 ```
-If you are already familiar with the PhraseApp gem you can upload your translation/localization files now. For more details on your setup have a look at our [detailed guide](https://phraseapp.com/docs/about/access-your-locale-files-with-the-api-client?language=en).
+If you are already familiar with the PhraseApp gem you can upload your translation/localization files now. For more details on your setup have a look at our [detailed guide](https://phraseapp.com/docs/guides/setup/).
 
 Todo
 -
-- YAML placeholders are currently not supported (We are working on it!).
 - a dry run option where you can see what will happen if you convert.
 - currently you are prompted for all hits - We would like to do 70-80% automatically and prompt for the 20-30% that cannot be decided upon.
 - adding / generalizing Regular Expressions for better hit rate
 
+Closed Todos
+-
+- YAML placeholders are supported - thx@joshblour
+
 Issues
 -
 - If you choose to take a lot of files at one time make sure to go through with it. It is not an issue to completely rerun everything (already translated strings are ignored) but should be avoided.
@@ -172,4 +200,4 @@ References
 * Other tools, not slim specific for this task is the [i15r gem](https://github.com/balinterdi/i15r). It can process .haml and .erb.
 * I strongly recommend checking your translated app with the [i18n-tasks gem](https://github.com/glebm/i18n-tasks). It is a great tool in     finding missing and unused translations.
 * Always consult the [Official Rails Internationalization guide](http://guides.rubyonrails.org/i18n.html) if in doubt.
-* Visit [PhraseApp on Github](https://github.com/phrase/phrase)
+* Visit [PhraseApp on Github](https://github.com/phrase)

data/lib/slimkeyfy.rb

@@ -1,3 +1,5 @@
+require 'russian'
+require 'yandex-translator'
 
 module SlimKeyfy
   

data/lib/slimkeyfy/console/command_line.rb

@@ -2,7 +2,7 @@ require 'optparse'
 
 class SlimKeyfy::Console::Commandline
   def initialize(args)
-    @options = {}
+    @options = { translator: {} }
     @args = args
     OptionParser.new(&method(:opt_scan)).parse!(@args)
   end
@@ -24,6 +24,15 @@ class SlimKeyfy::Console::Commandline
   the following options are available:
 
 "
+    opts.on_tail('-t', '--translator-api-key [API_KEY]', 'API key for Yandex Translator') do |value|
+      @options[:translator][:api] = value || ENV['YANDEX_TRANSLATOR_API']
+    end
+
+    #
+    opts.on_tail('-l', '--keys-from-locale LOCALE', 'translate keys from locale') do |from_locale|
+      @options[:translator][:from_locale] = from_locale
+    end
+
     opts.on_tail('-h', '--help', 'Show this message') do
       puts opts
       exit
@@ -50,6 +59,8 @@ class SlimKeyfy::Console::Commandline
     @options[:locale] = locale = @args.shift
     @options[:yaml_output] = @args.shift
 
+    SlimKeyfy::Slimutils::TranslationKeyGenerator.translator_options = @options[:translator]
+
     wrong_usage if (input.nil? or locale.nil?)
 
     if File.directory?(input)

data/lib/slimkeyfy/console/translate.rb

@@ -8,7 +8,7 @@ class SlimKeyfy::Console::Translate
     @original_file_path = options[:input]
     @no_backup = options.fetch(:no_backup, false)
     @bak_path = SlimKeyfy::Slimutils::MFileUtils.backup(@original_file_path)
-    @content = SlimKeyfy::Slimutils::FileReader.read(@bak_path).split("\n")
+    @content = self.class.join_multiline( SlimKeyfy::Slimutils::FileReader.read(@bak_path).split("\n") )
     @file_path = SlimKeyfy::Slimutils::MFileUtils.create_new_file(@original_file_path)
     @key_base = generate_key_base
     @yaml_processor = create_yaml_processor(options)
@@ -98,4 +98,38 @@ class SlimKeyfy::Console::Translate
   def comment_tag
     @transformer.slim? ? "//" : "#"
   end
+
+  def self.join_multiline( strings_array )
+    result = []
+    joining_str = ''
+    indent_length = 0
+    long_str_start = /^[ ]+\|/
+    long_str_indent = /^[ ]+/
+    long_str_indent_with_vertical_bar = /^[ ]+\|/
+    strings_array.each do |str|
+      if joining_str.empty?
+        if str[long_str_start]
+          joining_str = str
+          indent_length = str[long_str_start].length
+        else
+          result << str
+        end
+      #multiline string continues with spaces
+      elsif ( str[long_str_indent] && str[long_str_indent].length.to_i >= indent_length )
+        joining_str << str.gsub( long_str_indent, ' ' )
+      #muliline string continues with spaces and vertical bar with same indentation
+      elsif str[long_str_indent_with_vertical_bar] && str[long_str_indent_with_vertical_bar].length.to_i == indent_length
+        joining_str << str.gsub( long_str_indent_with_vertical_bar, ' ' )
+      #multiline string ends
+      else
+        result << joining_str
+        joining_str = ''
+        indent_length = 0
+        result << str
+      end
+    end
+    result << joining_str unless joining_str.empty?
+
+    result
+  end
 end

data/lib/slimkeyfy/slimutils/key_generator.rb

@@ -39,8 +39,39 @@ class SlimKeyfy::Slimutils::TranslationKeyGenerator
   VALID = /[^0-9a-z]/i
   DEFAULT_KEY_NAME = "default_key"
 
+  #class public methods
+  def self.translator_options
+    @translator_options ||= {}
+  end
+
+  def self.translator_options=( new_options  )
+    @translator_options = new_options
+  end
+
+  def self.yt
+    @yt ||= Yandex::Translator.new( translator_options[:api] )
+  end
+
+  def self.translate_key(translation)
+    if translator_options[:api] && translation && !translation.empty?
+      begin
+        # language can be detected automatically but this is noticeably slower than providing one.
+        yt.translate( translation, from: translator_options[:from_locale], to: :en )
+      rescue Exception => e
+        p e.inspect
+        return translation
+      end
+    elsif translator_options[:from_locale].to_s == 'ru'
+      ::Russian.transliterate(translation)
+    else
+      translation
+    end
+  end
+
+  #instance methods
   def initialize(translation)
-    @translation = translation
+    # keys must be in english!
+    @translation = self.class.translate_key( translation )
   end
 
   def generate_key_name
@@ -66,5 +97,5 @@ class SlimKeyfy::Slimutils::TranslationKeyGenerator
     end
     s
   end
-end
 
+end

data/lib/slimkeyfy/transformer/whitespacer.rb

@@ -24,22 +24,17 @@ class SlimKeyfy::Transformer::Whitespacer
     lead = leading_nbsp(body)
     trail = trailing_nsbp(body, tag)
 
-    body = lead ? body.sub(" ", "") : body
-    body = trail ? body.reverse.sub(";psbn&", "").reverse : body
-
-    tag = tag.gsub(tag, "#{tag}#{lead}#{trail}")
-    [body.gsub("&nbsp;", " "), tag.gsub("=><", "=<>")]
+    tag = tag.gsub(tag, "#{tag}#{lead.to_s}#{trail.to_s}")
+    [body.sub(/^&nbsp;/, '').sub(/&nbsp;$/, '').gsub("&nbsp;", " "), tag.gsub("=><", "=<>")]
   end
 
   def self.leading_nbsp(body)
     return "<"  if body.start_with?("&nbsp;")
-    ""
   end
 
   def self.trailing_nsbp(body, tag)
-    return "" if tag.start_with?("=>")
+    return '' if tag.start_with?("=>")
     return ">"  if body.end_with?("&nbsp;")
-    ""
   end
 
   def self.has_equals_tag?(s, html_tag)

data/lib/slimkeyfy/version.rb

@@ -1,3 +1,3 @@
 module SlimKeyfy
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/slimkeyfy.gemspec

@@ -17,5 +17,10 @@ Gem::Specification.new do |s|
   s.test_files  = s.files.grep(%r{^(spec)/})
   s.executables = ["slimkeyfy"]
   s.require_paths = ["lib"]
+
+  s.add_dependency "yandex-translator"
+  s.add_dependency "russian"
+
   s.add_development_dependency('rspec')
+  s.add_development_dependency('pry-byebug')
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: slimkeyfy
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Dynport GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: yandex-translator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: russian
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Replace plain text strings in your slim templates and Rails controllers
   with calls to I18n t() method. Keys and YAML output files will be automatically
   generated and filled in.