tml-rails 4.4.3 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8315876d08b00acf7d136a653d4b4532f2354742
-  data.tar.gz: 2a5b78a61e089c7acb94744f9ec4901e8658d67a
+  metadata.gz: 2088405b5d3e687320118711c6d8af1da0a6e512
+  data.tar.gz: 056a6c51fb7ccfb609eb8c303dd937aaffa517ef
 SHA512:
-  metadata.gz: 4e00d95c6f7594f2bd2c46f383894b6232ec9fab1ee472f4c72215a51f0211976b518a5b779b7a8a0c86ed11b126b1886a60129f4c144709d573a4bd154448d2
-  data.tar.gz: 5edcd87ae7c437239e971a06051ca83cdfbe34522da699978d85b3b68ec77e568c72fade41702fc543726750cecb2b15a29db576441d1a17316a8ae1e96d9724
+  metadata.gz: daf41e9d10c5e54cf2a78be03c65de63ea3cd844b4fa1554a6c02556ce0d4e1f383c13789c65518413a2d45441b8f029ee2afd25f618b1312e01ecef1e99b725
+  data.tar.gz: 1d26cb1bd823edcbcd39072ebf0f5561313e1b561786f00d16c4f9499ca73ac1866e1508032c569504a0f94ba9cf43c5346ae23ca8bd2d6b21d30f8eb4219242

data/lib/tml/cache_adapters/rails.rb

@@ -65,7 +65,7 @@ class Tml::CacheAdapters::Rails < Tml::Cache
 
   def store(key, data, opts = {})
     info("Cache store: #{key}")
-    @cache.write(versioned_key(key, opts), data)
+    @cache.write(versioned_key(key, opts), strip_extensions(data))
     data
   rescue Exception => ex
     warn("Failed to store data: #{ex.message}")

data/lib/tml_rails/extensions/action_common_methods.rb

@@ -58,7 +58,7 @@ module TmlRails
       # Translate individual sentences
       if params[:options][:split]
         text = params[:label]
-        sentences = Tml::Utils.split_by_sentence(text)
+        sentences = Tml::Utils.split_sentences(text)
         sentences.each do |sentence|
           text = text.gsub(sentence, tml_current_language.translate(sentence, params[:description], params[:tokens], params[:options]))
         end

data/lib/tml_rails/extensions/action_controller_extension.rb

@@ -37,8 +37,8 @@ module TmlRails
       base.send(:include, InstanceMethods)
 
       if Tml.config.auto_init
-        base.before_filter :tml_init
-        base.after_filter :tml_reset
+        base.before_filter  :tml_init
+        base.after_filter   :tml_reset
       end
 
       if defined? base.rescue_from
@@ -53,18 +53,11 @@ module TmlRails
 
     module InstanceMethods
 
+      # Returns all browser accepted locales
       def tml_browser_accepted_locales
-        @tml_browser_accepted_locales ||= Tml::Utils.browser_accepted_locales(request)
+        @tml_browser_accepted_locales ||= Tml::Utils.browser_accepted_locales(request.env['HTTP_ACCEPT_LANGUAGE']).join(',')
       end
 
-      def tml_user_preferred_locale
-        tml_browser_accepted_locales.each do |locale|
-          next unless Tml.session.application and Tml.session.application.locales.include?(locale)
-          return locale
-        end
-        Tml.config.default_locale
-      end
-      
       # Overwrite this method in a controller to assign a custom source for all views
       def tml_source
         "/#{controller_name}/#{action_name}"
@@ -72,44 +65,90 @@ module TmlRails
         self.class.name
       end
 
-      def tml_init
-        return if Tml.config.disabled?
-
-        @tml_started_at = Time.now
+      # Returns data from cookie set by the agent
+      def tml_cookie
+        @tml_cookie ||= begin
+          cookie = cookies[Tml::Utils.cookie_name(Tml.config.application[:key])]
+          if cookie.blank?
+            {}
+          else
+            HashWithIndifferentAccess.new(Tml::Utils.decode(cookie, Tml.config.application[:token]))
+          end
+        end
+      rescue Exception => ex
+        Tml.logger.error("Failed to parse tml cookie: #{ex.message}")
+        {}
+      end
 
-        tml_session_params = {
-          :source => tml_source
-        }
+      # Locale is retrieved from method => params => cookie => subdomain => browser accepted locales
+      # Alternatively, this method can be overwritten
+      def tml_locale
+        @tml_locale ||= begin
+          locale = nil
+
+          unless Tml.config.current_locale_method.blank?
+            begin
+              locale = self.send(Tml.config.current_locale_method)
+            rescue
+              locale = nil
+            end
+          end
 
-        if Tml.config.current_user_method
-          begin
-            tml_session_params.merge!(:user => self.send(Tml.config.current_user_method))
-          rescue
-            # Tml.logger.error('Current user method is specified but not provided')
+          if locale.nil?
+            if params[:locale].blank?
+              locale = tml_cookie[:locale]
+              if locale.nil?
+                if Tml.config.locale[:subdomain]
+                  locale = request.subdomain
+                else
+                  locale = tml_browser_accepted_locales
+                end
+              end
+            else
+              locale = tml_cookie[:locale] = params[:locale]
+              cookies[Tml::Utils.cookie_name(Tml.config.application[:key])] = Tml::Utils.encode(tml_cookie, Tml.config.application[:token])
+            end
           end
+
+          locale
         end
+      end
 
-        if Tml.config.current_locale_method
-          begin
-            tml_session_params.merge!(:locale => self.send(Tml.config.current_locale_method))
-          rescue
-            # Tml.logger.error('Current locale method is specified but not provided')
+      def tml_viewing_user
+        @tml_viewing_user ||= begin
+          unless Tml.config.current_user_method.blank?
+            begin
+              self.send(Tml.config.current_user_method)
+            rescue
+              {}
+            end
           end
         end
+      end
 
-        unless tml_session_params[:locale]
-          tml_session_params.merge!(:cookies => cookies)
-          params[:locale] = request.subdomain if Tml.config.locale[:subdomain]
-          tml_session_params.merge!(:change_locale => true) if params[:locale]
-          tml_session_params.merge!(:locale => params[:locale] || tml_user_preferred_locale)
+      def tml_translator
+        @tml_translator ||= begin
+          if tml_cookie[:translator]
+            Tml::Translator.new(tml_cookie[:translator])
+          else
+            nil
+          end
         end
+      end
+
+      def tml_init
+        return if Tml.config.disabled?
 
-        Tml.session.init(tml_session_params)
+        # Tml.logger.info(tml_cookie.inspect)
 
-        # if user sets locale manually, update the cookie for future use
-        if tml_session_params[:change_locale]
-          cookies[Tml.session.cookie_name] = Tml::Utils.encode(Tml.session.cookie_params)
-        end
+        @tml_started_at = Time.now
+
+        Tml.session.init({
+         :source      => tml_source,
+         :locale      => tml_locale,
+         :user        => tml_viewing_user,
+         :translator  => tml_translator
+        })
 
         if I18n.backend.class.name == 'I18n::Backend::Tml'
           if defined? I18n.enforce_available_locales

data/lib/tml_rails/extensions/action_view_extension.rb

@@ -33,6 +33,7 @@ module TmlRails
   module ActionViewExtension
     extend ActiveSupport::Concern
 
+    # Translates HTML block
     def trh(tokens = {}, options = {}, &block)
       return '' unless block_given?
 
@@ -42,10 +43,12 @@ module TmlRails
       tokenizer.translate(label).html_safe
     end
 
+    # Translates <select><option></option></select>
     def tml_options_for_select(options, selected = nil, description = nil, lang = Tml.session.current_language)
       options_for_select(options.tro(description), selected)
     end
 
+    # Returns language flag
     def tml_language_flag_tag(lang = tml_current_language, opts = {})
       return '' unless tml_application.feature_enabled?(:language_flags)
       html = image_tag(lang.flag_url, :style => (opts[:style] || 'vertical-align:middle;'), :title => lang.native_name)
@@ -53,6 +56,7 @@ module TmlRails
       html.html_safe
     end
 
+    # Returns language name
     def tml_language_name_tag(lang = tml_current_language, opts = {})
       show_flag = opts[:flag].nil? ? true : opts[:flag]
       name_type = opts[:language].nil? ? :english : opts[:language].to_sym # :full, :native, :english, :locale, :both
@@ -81,6 +85,7 @@ module TmlRails
       html.join.html_safe
     end
 
+    # Returns language selector UI
     def tml_language_selector_tag(type = nil, opts = {})
       return unless Tml.config.enabled?
 
@@ -94,6 +99,7 @@ module TmlRails
       render(:partial => "/tml_rails/tags/language_selector_#{type}", :locals => {:opts => opts})
     end
 
+    # Returns language strip UI
     def tml_language_strip_tag(opts = {})
       opts[:flag] = opts[:flag].nil? ? false : opts[:flag]
       opts[:name] = opts[:name].nil? ? :native : opts[:name] 
@@ -103,6 +109,7 @@ module TmlRails
       render(:partial => '/tml_rails/tags/language_strip', :locals => {:opts => opts})
     end
 
+    # Translates flashes
     def tml_flashes_tag(opts = {})
       render(:partial => '/tml_rails/tags/flashes', :locals => {:opts => opts})
     end
@@ -191,8 +198,9 @@ module TmlRails
 
     # provides the locale and direction of the language
     def tml_html_attributes_tag(lang = tml_current_language)
-      "#{tml_lang_attribute_tag(lang)} #{tml_dir_attribute_tag(lang)}"
+      "xml:lang='#{lang.locale}' #{tml_lang_attribute_tag(lang)} #{tml_dir_attribute_tag(lang)}".html_safe
     end
+    alias_method :tml_lang_attributes_tag, :tml_html_attributes_tag
 
     # providers the direction of the language
     def tml_dir_attribute_tag(lang = tml_current_language)
@@ -206,10 +214,6 @@ module TmlRails
       "lang='#{lang.locale}'".html_safe
     end
 
-    def tml_lang_attributes_tag(lang = tml_current_language)
-      "#{tml_lang_attribute_tag(lang)} #{tml_dir_attribute_tag(lang)}".html_safe
-    end
-
     def tml_stylesheet_link_tag(ltr, rtl, attrs = {})
       if tml_current_language.right_to_left?
         stylesheet_link_tag(rtl, attrs)

data/lib/tml_rails/version.rb

@@ -30,5 +30,5 @@
 #++
 
 module TmlRails
-  VERSION = '4.4.3'
+  VERSION = '5.0.1'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: tml-rails
 version: !ruby/object:Gem::Version
-  version: 4.4.3
+  version: 5.0.1
 platform: ruby
 authors:
 - Michael Berkovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: tml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '5.0'
 description: Translation Markup Language from Translation Exchange.
 email:
 - michael@translationexchange.com
@@ -82,17 +82,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Tml Client SDK for Ruby on Rails