translation_engine 0.0.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac95cf9c6d16b490a19aaeedae0ea1caa3c6243c97cb4d9ed2ba9f7106b8988b
-  data.tar.gz: 5510294287f26bdf0abe67d12b28c65013e1633e0b2b478bbffd1fba5fe10947
+  metadata.gz: 8504f4c93d33bebfd84f224caf9cbeaf75cc2754ad9a4616ff6d2fe6aab4c1ec
+  data.tar.gz: d2c7782ee74fa7f5ce69629406d8bd076ed51b6b28e5a7cb2f1f06e3e15d9a9c
 SHA512:
-  metadata.gz: 9f1ba7e2297b1a93bc783cd2f8009d49cb8666af916801c75593a1fb5ee582d4c3a60e2902f0110ccaebd3271ed69d390dc7f5f6cd261ee381dda4a3f8eb4796
-  data.tar.gz: 647279a4752922e40ed772171597f234caf4a630f45d576c88902bef29eb5db942c2b213a211485d21ac9b545b0129272b38af77f325687013893e616c476819
+  metadata.gz: fe9249300f13201dcc6efdcc97f69ec94ef672490875eb877eff59df116b342adc8962532d3f52110bc06bfdd1e20f644c8b70e343ca2bac1e263d0b479bdce0
+  data.tar.gz: af56402ee4b345ee64b532c237b401a47b545ab7f96465165a538d01028e7eed2443ad9b47668a971a8f14af94406adfda8a894329c05acb9d16e68279578707

data/README.md

@@ -0,0 +1,146 @@
+# TranslationEngine [![Dependency Status](https://dependencyci.com/github/blueberryapps/translation-engine/badge)](https://dependencyci.com/github/blueberryapps/translation-engine)
+
+```
+gem 'translation_engine', git: 'https://github.com/blueberryapps/translation-engine.git'
+```
+
+## Configuration
+
+Default configuration is that all part are turned off, so for enabling you need
+to create file `config/initializers/translation_engine.rb` with this content:
+
+```ruby
+# config/initializers/translation_engine.rb
+
+TranslationEngine.config do |config|
+  # key for user
+  config.api_key  = 'API_KEY'
+
+  # url to Translation Server
+  config.api_host = 'http://127.0.0.1:3000'
+
+  # enable screenshot functionality (default is false)
+  config.use_screenshots  = true
+
+  # enable to send translation after every request and receive translations
+  # when something changed (default is false)
+  config.use_catcher      = true
+
+  # for production envs you don't want to send translations
+  # so if use_catcher is true you can disable sending them by this option:
+  config.disable_sending_translations = true
+
+  # Timeout for connecting to translation server
+  # config.timeout = 5
+
+  # Set time between asking translation server for new data, (default is 0)
+  config.cache_timeout = 60 # ask translation server every 60s for new data
+
+  # If true TranslationEngine will throw exceptions on connection problems
+  # If false TranslationEngine will just log exception to Rails.logger
+  config.raise_exceptions = Rails.env.development?
+end
+```
+
+## Releases
+
+```
+# list all possible releases
+I18n.backend.releases
+
+# list all possible release which has same locale as I18n.locale
+I18n.backend.current_locale_releases
+```
+### Switch release on frontend
+
+```slim
+- I18n.backend.current_locale_releases.each do |release|
+  = link_to release.version.upcase,
+            { translation_release: release.version },
+            class: ('active' if release.current?)
+```
+
+## Screenshots Integration
+
+### Javascript
+Require javascript by inserting `app/assets/javascripts/application.js`
+```
+//= require translation_engine/screenshots
+```
+or in views `= javascript_include_tag 'translation_engine/screenshots'`
+(this javascript is already precompiled, so you don't need to do anything else)
+
+Ensure that you have jquery + coffeescript
+(or similar gems which provides same function)
+
+```ruby
+gem 'coffee-rails'
+gem 'jquery-rails'
+```
+
+### Stylesheets
+Require stylesheets by inserting `app/assets/stylesheets/application.sass`:
+
+```
+@import 'translation_engine/screenshots'
+```
+
+or in views `= stylesheet_link_tag 'translation_engine/screenshots'`
+(this stylesheet is already precompiled, so you don't need to do anything else)
+
+### Start translations screenshoting
+Create element with class `translation_engine_start`.
+When you click on this element, Translation Engine will start screenshoting page
+and then sends all images + highlights to server `/transaltion_engine` which
+will be catched by `ScreenshotsMiddleware` and then send to TranslationServer.
+
+or
+
+Use callback `window.TranslationEngine.start()`
+
+### Show translations and keys + link to translation server
+Create element with class `translation_highlight_start`.
+
+When you click on this element, Translation Engine will show keys instead of text to all
+translated text in page and it will add link to translation server.
+
+or
+
+Use callback `window.TranslationEngine.highlight()`
+
+## Rake tasks
+
+### `rake translation_engine:list:releases`
+
+List all available releases from Translations Server
+
+
+### `rake translation_engine:pull:master`
+
+Download all master translations from Translations server and store them
+into config/locales/z_translation_engine.yml
+
+### `rake translation_engine:pull:release RELEASE=en_v001`
+
+Download released translations from Translations server and store them
+into config/locales/z_releases/(release_locale).yml,
+will overwrite previous locale release, leaving allways only one release.
+
+## Architecture of service
+
+![Catcher](./readme/catcher.png)
+
+Catcher is middleware in rails APP which catches all used translations in page
+and then it sends them into Translation Server.
+
+![Screenshots](./readme/screenshots.png)
+
+Screenshots middleware takes highlights and images which sends into Translation
+Server.
+
+## Publishing
+
+```
+gem build translation_engine.gemspec
+gem push translation_engine-0.0.5.gem
+```

data/app/middlewares/translation_engine/catcher_middleware.rb

@@ -1,3 +1,5 @@
+require_relative 'request'
+
 module TranslationEngine
   class CatcherMiddleware
     include Request

data/app/middlewares/translation_engine/keys_middleware.rb

@@ -1,3 +1,5 @@
+require_relative 'request'
+
 module TranslationEngine
   class KeysMiddleware
 

data/app/middlewares/translation_engine/screenshots_middleware.rb

@@ -1,3 +1,5 @@
+require_relative 'request'
+
 module TranslationEngine
   class ScreenshotsMiddleware
     include Request

data/app/models/translation_engine/backend.rb

@@ -56,10 +56,10 @@ class TranslationEngine::Backend < I18n::Backend::Simple
     result = catch(:exception) do
       case subject
       when Symbol
-        I18n.translate(subject, options.merge(:locale => locale, :throw => true))
+        I18n.translate(subject, **options.merge(:locale => locale, :throw => true))
       when Proc
         date_or_time = options.delete(:object) || object
-        resolve(locale, object, subject.call(date_or_time, options))
+        resolve(locale, object, subject.call(date_or_time, **options))
       when nil
         nil
       else

data/lib/translation_engine/engine.rb

@@ -1,3 +1,8 @@
+require_relative '../../app/middlewares/translation_engine/catcher_middleware'
+require_relative '../../app/middlewares/translation_engine/connection_exception_middleware'
+require_relative '../../app/middlewares/translation_engine/keys_middleware'
+require_relative '../../app/middlewares/translation_engine/screenshots_middleware'
+
 module TranslationEngine
   class Engine < ::Rails::Engine
     isolate_namespace TranslationEngine
@@ -61,4 +66,3 @@ module TranslationEngine
     end
   end
 end
-

data/lib/translation_engine/version.rb

@@ -1,3 +1,3 @@
 module TranslationEngine
-  VERSION = "0.0.8"
+  VERSION = "0.2.0"
 end

data/test/dummy/config/application.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../boot', __FILE__)
+require_relative "boot"
 
 require 'rails/all'
 
@@ -23,4 +23,3 @@ module Dummy
     config.active_record.raise_in_transactional_callbacks = true
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: translation_engine
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-30 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - app/assets/javascripts/translation_engine/html2canvas.js
 - app/assets/javascripts/translation_engine/screenshots.js.coffee
@@ -145,7 +146,6 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config/secrets.yml
-- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -172,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Connects Rails application to Translation Server
@@ -218,6 +218,5 @@ test_files:
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/404.html
-- test/dummy/log/test.log
 - test/dummy/README.rdoc
 - test/test_helper.rb