translation_engine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 205d428df157042d2c719d3fc16675987bf5af75
+  data.tar.gz: 4ed393be15ecd6795e97f49e8157b7e22f105306
+SHA512:
+  metadata.gz: 5f71b85e162c5826caebe3a66a005ded7b60d072c545f5dcbe4363a1257be7ecea1d01ce7282e1599bd15ce488c8a9a75deb9172262447707b66438bccf39221
+  data.tar.gz: 8f44020c85bcf9bce0d212beeb3682ea4d3f5c9d5f5651086ef4e4191eac3c7872eca778a287d233d4b3b97e8199cab55c86d6c0a4f1a5ba769c3e3a3ec63091

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Ondrej Bartas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, 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.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TranslationEngine'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/translation_engine/screenshots.js.coffee

@@ -0,0 +1,225 @@
+#= require html2canvas
+
+class TranslationEngine
+
+  baseUrl: '/translation_engine/keys'
+  submitButton: ''
+  highlightButton: ''
+  translationsQueue: []
+  screenshots: []
+  screenshotsCaptured: {}
+  translationIndex: 0
+  keysVisible: false
+  keysInfoGenerated: false
+  highlights: []
+  variant: 'desktop'
+
+  constructor: (startButton, highlightButton) ->
+    @startButton = $(startButton)
+    @highlightButton = $(highlightButton)
+    @lookupDom()
+    @bindStartButton()
+    @bindHighlightButton()
+    @variant = 'mobile' if $('body').hasClass('mobile')
+
+  start: ->
+    setTimeout @nextTranslationScreeshot, 100
+
+  highlight: ->
+    baseUrl = @baseUrl
+    keysVisible = @keysVisible
+    @translationsQueue.map((translation) ->
+      # generate url
+      if !keysVisible
+        [ country, rest... ] = translation.key.split('.')
+        url = "#{baseUrl}/#{country}/translates/browse/all/#{rest.join('/')}"
+        translation['url'] = url
+        translation.backup = translation.element.html()
+        translation.element.html("<a href='#{url}' style='color: #444; background: #ddd'>#{translation.key}</a>")
+      else
+        translation.element.html(translation.backup)
+    )
+
+
+    @keysVisible = !@keysVisible
+
+  appendScreenshotsOverlay: ->
+    if $('body').find('.screenshots-overlay').length == 0
+      $('body').append('<div class="screenshots-overlay" data-html2canvas-ignore="true"></div>')
+      $('body').append('<div class="screenshots-status" data-html2canvas-ignore="true"></div>')
+
+  dismissScreenshotsOverlay: ->
+    setTimeout ->
+      $('body').find('.screenshots-overlay').detach()
+      $('body').find('.screenshots-status').detach()
+    , 1000
+
+  bindStartButton: ->
+    @startButton.click =>
+      if @translationsQueue.length > @translationIndex
+        setTimeout @nextTranslationScreeshot, 100
+      else
+        @appendScreenshotsOverlay()
+        @setStatusText('Screenshots already send')
+        @dismissScreenshotsOverlay()
+
+  bindHighlightButton: ->
+    @highlightButton.click =>
+      @highlight()
+
+  nextTranslationScreeshot: =>
+    if @translationsQueue.length > @translationIndex
+      @renderHighlight()
+    else
+      @sendTranslations()
+
+  lookupDom: ->
+    @lookupTextDom()
+    @lookupAttributesDom()
+    @lookupMissingTranslationDom()
+
+  lookupTextDom: ->
+    while $(':contains("--TRANSLATION--")').length > 0
+      $(':contains("--TRANSLATION--")').each (i, element) =>
+        element = $(element)
+        if element.find(':contains("--TRANSLATION--")').length == 0
+          text    = element.html()
+          matched = @findTranslationFromText(text)
+          element.html(text.replace(matched[0], ''))
+
+          @translationsQueue.push
+            key:     matched[1],
+            element: element
+
+  lookupAttributesDom: ->
+    $('*').each (i, element) =>
+      $.each element.attributes, (i, attribute) =>
+        if attribute.value.match('--TRANSLATION--')
+          element = $(element)
+          text    = attribute.value
+          matched = @findTranslationFromText(text)
+          element.attr(attribute.name, text.replace(matched[0], ''))
+
+          @translationsQueue.push
+            key:     matched[1],
+            element: element
+
+  lookupMissingTranslationDom: ->
+    $('[class^="translation"]').each (i, element) =>
+      element = $(element)
+      if element.attr('title') != undefined && element.attr('title').match('translation')
+        @translationsQueue.push
+          element: element,
+          key:     element.attr('title').replace('translation missing: ', '')
+
+  findTranslationFromText: (text) ->
+    translations_regexp = /--TRANSLATION--(.*?)--/g
+    translations_regexp.exec(text)
+
+  setStatusText: (text) ->
+    $('body').find('.screenshots-status').text(text)
+
+  windowLocation: ->
+    window.location.pathname.replace(/\?.*/, '').replace(/\d+/, ':id')
+
+  sendTranslations: ->
+    data = {
+      location:   @windowLocation(),
+      images:     @screenshots,
+      highlights: @highlights
+    }
+    @setStatusText('Sending translations')
+
+    $.ajax(
+      url:  '/translation_engine/screenshots',
+      type: 'POST',
+      data: JSON.stringify(data),
+      contentType: 'json'
+    ).done (response) =>
+      @setStatusText(response.message)
+      @dismissScreenshotsOverlay()
+
+  renderHighlight: ->
+    @appendScreenshotsOverlay()
+
+    translation = @translationsQueue[@translationIndex]
+
+    @setStatusText("Capturing #{translation.key} (#{@translationIndex}/#{@translationsQueue.length})")
+
+    image_name = @windowLocation()
+
+    type = 'span'
+
+    if translation.element.parent('select').length > 0
+      main_element = translation.element.parent('select')
+      type = 'select'
+      original_selected_value = main_element.val()
+      new_value = translation.element.val()
+      image_name += "#select_#{main_element.attr('id')}_#{new_value}"
+      main_element.val(new_value)
+
+    else if translation.element.closest('.dropdown').length > 0
+      main_element = translation.element
+      dropdown     = main_element.closest('.dropdown')
+      dropdown.addClass('open')
+      image_name += "#dropdown_#{dropdown.attr('id')}"
+      type = 'dropdown'
+
+    else if translation.element.closest('.modal').length > 0
+      main_element = translation.element
+      modal = main_element.closest('.modal')
+      modal.css(height: $(document).height()).removeClass('fade in').modal('show')
+      $('.modal-backdrop').css(height: $(document).height())
+      image_name += "#modal_#{modal.attr('id')}"
+      type = 'modal'
+
+    else
+      main_element = translation.element
+
+    offset = main_element.offset()
+    width  = main_element.outerWidth()
+    height = main_element.outerHeight()
+
+    @highlights.push
+      key:        translation.key,
+      image_name: image_name,
+      x:          offset.left,
+      y:          offset.top,
+      width:      width,
+      height:     height
+
+    setTimeout =>
+      if @screenshotsCaptured[image_name] == true
+        if type == 'select'
+          main_element.val(original_selected_value)
+        else if type == 'dropdown'
+          main_element.closest('.dropdown').removeClass('open')
+        else if type == 'modal'
+          main_element.closest('.modal').modal('hide')
+        @translationIndex += 1
+        @nextTranslationScreeshot()
+      else
+        html2canvas([ document.body ], {
+          onrendered: (canvas) =>
+            @screenshots.push {
+              location: document.URL,
+              name:     image_name,
+              variant:  @variant,
+              image:    canvas.toDataURL()
+            }
+            @screenshotsCaptured[image_name] = true
+            @translationIndex += 1
+            @nextTranslationScreeshot()
+        })
+    , 1
+
+$(document).ready ->
+  window.TranslationEngine = new TranslationEngine(
+    '.translation_engine_start',
+    '.translation_highlight_start'
+  )
+
+  $(window).bind 'ajaxComplete', ->
+    window.TranslationEngine.lookupDom()
+
+  $(document).trigger 'translation_engine:ready'

data/app/assets/stylesheets/translation_engine/screenshots.css

@@ -0,0 +1,23 @@
+.screenshots-overlay {
+  background: rgba(0, 0, 0, 0.3);
+  bottom: 0;
+  left: 0;
+  position: absolute;
+  right: 0;
+  top: 0;
+  z-index: 10000;
+}
+
+.screenshots-status {
+  background: rgba(0, 0, 0, 0.5);
+  color: white;
+  font-family: sans-serif;
+  font-size: 20px;
+  left: 0;
+  padding: 10px;
+  position: fixed;
+  right: 0;
+  text-align: center;
+  top: 20%;
+  z-index: 10001;
+}

data/app/middlewares/translation_engine/catcher_middleware.rb

@@ -0,0 +1,64 @@
+class TranslationEngine::CatcherMiddleware
+  REMOVE_QUERY = /\?.*/
+  REPLACE_IDS = /\d+/
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    if TranslationEngine.use_catcher
+      call_catcher(env)
+    else
+      @app.call(env)
+    end
+  end
+
+  private
+
+  def call_catcher(env)
+    TranslationEngine::Translation.clear_catched
+
+    if env['QUERY_STRING'].include?('translation_release')
+      I18n.backend.release = params(env)['translation_release']
+    end
+
+    update_translations unless assets_request?(env)
+
+    response = @app.call(env)
+
+    send_translations(env)
+
+    response
+  end
+
+  def assets_request?(env)
+    env['PATH_INFO'] =~ /\/assets/
+  end
+
+  def params(env)
+    Rack::Utils.parse_query(env['QUERY_STRING'], '&')
+  end
+
+  def update_translations
+    translation_downloader.update
+  end
+
+  def send_translations(env)
+    return if TranslationEngine::Translation.catched.empty?
+
+    location = env['PATH_INFO'].gsub(REMOVE_QUERY, '').gsub(REPLACE_IDS, ':id')
+
+    data = {
+      location:     location,
+      locale:       I18n.locale,
+      translations: TranslationEngine::Translation.catched.uniq
+    }
+
+    Thread.new { TranslationEngine::Connection.new.send_translations(data) }
+  end
+
+  def translation_downloader
+    @translation_downloader ||= TranslationEngine::Downloader.new
+  end
+end

data/app/middlewares/translation_engine/connection_exception_middleware.rb

@@ -0,0 +1,18 @@
+require 'faraday'
+
+class TranslationEngine::ConnectionExceptionMiddleware < Faraday::Middleware
+  def call(env)
+    begin
+      @app.call(env)
+    rescue Faraday::Error => e
+      message = "Connecting to TranslationServer got #{e.class}: #{e.message}"
+
+      if TranslationEngine.raise_exceptions
+        raise ConnectionError, message
+      else
+        Rails.logger.error { message }
+        {}
+      end
+    end
+  end
+end

data/app/middlewares/translation_engine/keys_middleware.rb

@@ -0,0 +1,31 @@
+class TranslationEngine::KeysMiddleware
+
+  URL_PATH = /\A\/translation_engine\/keys/
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    if env['PATH_INFO'] =~ URL_PATH
+      handle_redirect_request(env)
+    else
+      @app.call(env)
+    end
+  end
+
+  private
+
+  def handle_redirect_request(env)
+    key_path = env['PATH_INFO'].gsub(URL_PATH, '')
+
+    [
+      302,
+      {
+        'Location' => "#{TranslationEngine.api_host}/#{key_path}",
+        'Content-Type' => 'text/html'
+      },
+      ['Moved Temporarily']
+    ]
+  end
+end

data/app/middlewares/translation_engine/screenshots_middleware.rb

@@ -0,0 +1,31 @@
+class TranslationEngine::ScreenshotsMiddleware
+
+  URL_PATH = /\A\/translation_engine\/screenshots/
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    if TranslationEngine.use_screenshots && env['PATH_INFO'] =~ URL_PATH
+      handle_translation_request(env)
+    else
+      @app.call(env)
+    end
+  end
+
+  private
+
+  def handle_translation_request(env)
+    data = JSON.parse(env["rack.input"].read)
+
+    TranslationEngine::Connection.new
+      .send_images(data.merge(locale: I18n.locale))
+
+    [
+      200,
+      { 'Content-Type' => 'application/json' },
+      [{ message: 'translations saved' }.to_json]
+    ]
+  end
+end