tr8n_client_sdk 4.1.5 → 4.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9826d9afd314a52e2df7f0b362a2365d293812b7
-  data.tar.gz: 771b6ba185227163c3dcf99a151d59162eb7685e
+  metadata.gz: 7cb47a8f25f6b27451a1c9e8b45a9d5311f18e79
+  data.tar.gz: 5f16ff10ab8df805d404234b5f8971a9d8bbdaa4
 SHA512:
-  metadata.gz: 228ea21e988c0c8e98b3e2366858dfebbc3ec22ef2acd2c3284b362c6c0693dd36fe32eee833f6c67111f507e45884157b491689e063773826f67cd4e9d23cb6
-  data.tar.gz: 3c0af5a81b95fe4150b0e36336b0ddd1a8bb977ede7a605072d31bb9529b282e4c6fc2750aed38258df2e6f0eb3dad50648a80c9eb87a42815b2bc3afe537e3d
+  metadata.gz: 7d002ca916300782dccd51275759dd7a6692f099a295f6f3d03518a7a73eda3ff22c00277f5cfb9f598e3dd3950ecd95b03cafad8ec058e255d851379f107bb2
+  data.tar.gz: 0a48178707dcd1ab2608deed5b787645f6133c6502dceff671d43f1bcaa67aef1983a2cb2afa929a512019335633650b2d6d650b7f1893818e826594d92dfaec

data/README.md

@@ -10,57 +10,54 @@ Tr8n Client SDK for Ruby on Rails
 [![Dependency Status](https://www.versioneye.com/user/projects/53cda6a5225426f1e8000165/badge.svg?style=flat)](https://www.versioneye.com/user/projects/53cda6a5225426f1e8000165)
 [![Project status](http://stillmaintained.com/tr8n/tr8n_ruby_core.png)](http://stillmaintained.com/tr8n/tr8n_ruby_core.png)
 
-This Client SDK provides extensions necessary for translating Rails based application using the Tr8nHub service.
+This Client SDK provides extensions necessary for translating Rails 3.2.X based application using the TranslationExchange.com service.
 
 
 Tr8n Client SDK Sample
 ===================================
 
-The best way to start using Tr8nHub is to run the sample application that comes bundled with this SDK.
+The best way to start using the SDK is to run a sample application that comes bundled with this SDK.
 
 ```sh
   $ git clone https://github.com/tr8n/tr8n_rails_clientsdk.git
   $ cd tr8n_rails_clientsdk/spec/dummy
   $ bundle
-  $ script/rails s
 ```
 
-This will start the dummy application in development mode. The development mode uses Tr8nHub sandbox server for translations.
+Before you running the application, visit TranslationExchange.com, register as a new user and create a new application.
 
+Update your key and secret in the following file:  config/initializers/tr8n.rb
 
-Alternatively, you can use the same sample application as a stand alone app:
-
-https://github.com/tr8n/tr8n_rails_clientsdk_sample
-
-This application is running at:
-
-http://rails.tr8nhub.com
-
+```ruby
+  config.application = {
+      :key => YOUR_KEY,
+      :secret => YOUR_SECRET
+  }
+```
 
-Another sample application that uses this SDK is available here:
+Now you can start the application by running:
 
-https://github.com/tr8n/tr8n_samples_bookface_rails
+```sh
+  $ bundle exec rails s
+```
 
-Install it and see how it works.
 
+This will start the dummy application on port 3000. Open your browser and point to:
 
-Registering Your App
-===================================
+http://localhost:3000
 
-Before you can proceed with the integration, please register with https://translationexchange.com and create a new application.
 
-At the end of the registration process you will be given a key and a secret. You will need to enter them in the initialization function of the Tr8n SDK.
 
 
 Integration
 ===================================
 
-To integrate Tr8n SDK into your app, all you need to do is:
+To integrate Tr8n SDK into your own app, all you need to do is:
 
-Add the following gems to your Gemfile:
+Add the following gem to your Gemfile:
 
 ```ruby
-  gem 'tr8n_client_sdk'
+  gem 'tr8n_client_sdk', '~> 3.2'
 ```
 
 Install the gems:
@@ -69,7 +66,7 @@ Install the gems:
   $ bundle
 ```
 
-Add the following configuration to your Application.rb (or to the various environment files):
+Create an initializer file under config/initializers/tr8n.rb and add the following configuration:
 
 ```ruby
     Tr8n.configure do |config|
@@ -80,6 +77,39 @@ Add the following configuration to your Application.rb (or to the various enviro
     end
 ```
 
+Tr8n is best run with caching enabled. You can specify your caching adapter using the following settings:
+
+Memcache example:
+
+```ruby
+    Tr8n.configure do |config|
+      config.cache = {
+          :enabled  => true,
+          :adapter  => 'memcache',
+          :host     => 'localhost:11211',
+          :version  => 1,
+          :timeout  => 3600
+      }
+    end
+```
+
+Redis example:
+
+```ruby
+    Tr8n.configure do |config|
+      config.cache = {
+          :enabled  => true,
+          :adapter  => 'redis',
+          :host     => 'localhost:6379',
+          :version  => 1,
+          :timeout  => 3600
+      }
+    end
+```
+
+To see a full list of supported cache adapters or to create your own cache adapter, visit TranslationExchange.com/docs
+
+
 In the HEAD section of your layout, add:
 
 ```ruby
@@ -94,7 +124,24 @@ Now you can simply add the default language selector anywhere on your page using
   <%= tr8n_language_selector_tag %>
 ```
 
-And use TML (Translation Markup Language) to translate your strings, using:
+The default language selector is used to enable/disable translation modes. It may be useful on staging or translation
+server, but it may not be ideal on production. There are a number of alternative language selectors you can use, including your own.
+
+To use a dropdown language selector that uses locale in the url parameter, use:
+
+```rails
+<%= tr8n_language_selector_tag(
+        :type => :dropdown,
+        :style => "margin-top:15px",
+        :language => :english
+    ) %>
+```
+
+As you see, you can provide custom values to how you want to make it look and whether you want to use the english version
+of the language name or have the language be printed in a native language.
+
+
+Now you can use TML (Translation Markup Language) in your application to translate your strings:
 
 ```rails
   <%= tr("Hello World") %>
@@ -103,37 +150,21 @@ And use TML (Translation Markup Language) to translate your strings, using:
   ...
 ```
 
-Learn more about TML at: http://wiki.tr8nhub.com
+There are some additional methods that can be very useful. For instance, if you want to translate something inside a model,
+you can simply use:
 
+```ruby
 
-Caching
-===================================
-
-You should enable caching for your application. Without caching you will be querying the service for new translations on every page load.
-If you do it too much, you will be throttled. The translation service is designed to service the up-to-date translations only if you your translators are in translation mode.
-For all other users you should serve translations from your cache.
-
-To enable cache, simply add the following configuration to Tr8n config:
+  "Hello World".translate
 
-```ruby
-    Tr8n.configure do |config|
-      config.cache = {
-          :enabled  => true,
-          :adapter  => 'memcache',
-          :host     => 'localhost:11211',
-          :version  => 2,
-          :timeout  => 3600
-      }
-    end
 ```
 
-The following Cache adapters are supported:
 
-Memcache, Redis, CDB, File
+Learn more about TML at: https://TranslationExchange.com/docs
 
-It is easy to add any other custom cache adapter as well.
 
-Memcache and Redis adapters can do a realtime cache warmup - by loading the translations from the service and storing them in the cache.
+Caching
+===================================
 
 To reset/upgrade your cache, you can simply call
 
@@ -144,13 +175,7 @@ To reset/upgrade your cache, you can simply call
 All the keys stored in memory based cache are versioned. By upgrading the version you will effectively invalidate the old keys and the new keys will be loaded from the translation service.
 
 
-CDB and File adapters require pre-generation. You can pre-generate your cache by running:
-
-```sh
-  $ rake tr8n:generate_cache:file
-```
-
-or
+File adapters require pre-generation. You can pre-generate your cache by running:
 
 ```sh
   $ rake tr8n:generate_cache:cdb
@@ -177,7 +202,7 @@ Tr8n comes with its own logger. If you would like to see what the SDK is doing b
 ```
 
 
-Rules Engine Customizations
+Customization
 ===================================
 
 Tr8n comes with default settings for the rules engine. For example, it assumes that you have the following methods in your ApplicationController:

data/lib/tr8n_client_sdk/extensions/action_common_methods.rb

@@ -41,9 +41,9 @@ module Tr8nClientSdk
     # tr(:label => label, :description => "", :tokens => {}, :options => {})
     ############################################################
     def tr(label, description = '', tokens = {}, options = {})
-      return label.html_safe if label.tr8n_translated?
-
       params = Tr8n::Utils.normalize_tr_params(label, description, tokens, options)
+      return params[:label].html_safe if params[:label].tr8n_translated?
+
       params[:options][:caller] = caller
 
       if request

data/lib/tr8n_client_sdk/extensions/action_controller_extension.rb

@@ -41,6 +41,7 @@ module Tr8nClientSdk
         base.rescue_from 'Tr8n::Exception' do |e|
           Tr8n.logger.error(e)
           Tr8n.logger.error(e.backtrace)
+          Tr8n.session.reset
           raise e
         end
       end

data/lib/tr8n_client_sdk/extensions/action_view_extension.rb

@@ -166,19 +166,23 @@ module Tr8nClientSdk
     ######################################################################
 
     def tr8n_style_attribute_tag(attr_name = 'float', default = 'right', lang = tr8n_current_language)
+      return "#{attr_name}:#{default}".html_safe if Tr8n.config.disabled?
       "#{attr_name}:#{lang.align(default)}".html_safe
     end
 
     def tr8n_style_directional_attribute_tag(attr_name = 'padding', default = 'right', value = '5px', lang = tr8n_current_language)
+      return "#{attr_name}-#{default}:#{value}".html_safe if Tr8n.config.disabled?
       "#{attr_name}-#{lang.align(default)}:#{value}".html_safe
     end
 
     def tr8n_dir_attribute_tag(lang = tr8n_current_language)
+      return "dir='ltr'" if Tr8n.config.disabled?
       "dir='#{lang.dir}'".html_safe
     end
 
     def tr8n_lang_attribute_tag(lang = tr8n_current_language)
-      "lang=#{lang.locale}".html_safe
+      return "lang='en-US'" if Tr8n.config.disabled?
+      "lang='#{lang.locale}'".html_safe
     end
 
   end

data/lib/tr8n_client_sdk/railtie.rb

@@ -37,8 +37,6 @@ require File.join(File.dirname(__FILE__), 'extensions/action_common_methods')
 require File.join(File.dirname(__FILE__), 'extensions/action_view_extension')
 require File.join(File.dirname(__FILE__), 'extensions/action_controller_extension')
 
-require File.join(File.dirname(__FILE__), 'extensions/string')
-
 module Tr8nClientSdk
   class Railtie < ::Rails::Railtie #:nodoc:
     initializer 'tr8n_client_sdk' do |app|

data/lib/tr8n_client_sdk/version.rb

@@ -30,5 +30,5 @@
 #++
 
 module Tr8nClientSdk
-  VERSION = '4.1.5'
+  VERSION = '4.1.6'
 end

data/lib/tr8n_client_sdk.rb

@@ -29,9 +29,10 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+require "tr8n_core"
+require "tr8n_client_sdk/core/string"
 require "tr8n_client_sdk/railtie"
 require "tr8n_client_sdk/engine"
-require "tr8n_core"
 require "tr8n/cache_adapters/rails"
 
 module Tr8nClientSdk

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tr8n_client_sdk
 version: !ruby/object:Gem::Version
-  version: 4.1.5
+  version: 4.1.6
 platform: ruby
 authors:
 - Michael Berkovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-26 00:00:00.000000000 Z
+date: 2014-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -56,11 +56,11 @@ files:
 - lib/tasks/tr8n_client_sdk.rake
 - lib/tr8n/cache_adapters/rails.rb
 - lib/tr8n_client_sdk.rb
+- lib/tr8n_client_sdk/core/string.rb
 - lib/tr8n_client_sdk/engine.rb
 - lib/tr8n_client_sdk/extensions/action_common_methods.rb
 - lib/tr8n_client_sdk/extensions/action_controller_extension.rb
 - lib/tr8n_client_sdk/extensions/action_view_extension.rb
-- lib/tr8n_client_sdk/extensions/string.rb
 - lib/tr8n_client_sdk/railtie.rb
 - lib/tr8n_client_sdk/version.rb
 homepage: https://github.com/tr8n/tr8n_rails_clientsdk