tml-rails 5.4.6 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf3a772c2d881f6862aa2fe6dae70c021d65ed66
-  data.tar.gz: 8dc31a645a9f092905cfb4b0ca8d39db18eccc78
+  metadata.gz: a0301a87bd78a66f93bad4a3e824fbb00d5a513b
+  data.tar.gz: 04845d65cebb7ec8edb394e9ba904408d8f896b1
 SHA512:
-  metadata.gz: d6c56a78acfd2c5144cf3085252ca68182981ad7ea3794ffc4661e8346a6ddd114d633aea3aa0b25f6805d16423572fa67a841212c5b5fe88e30e917ba191608
-  data.tar.gz: 0be0458b0969a2381e1941f00d4a951a9f3653b1c0326f991760b4bdfb97c1db9586c7019a42a4ce03986d5d11942b7ae37161af19d97136eeadbf9ce2f2a0ad
+  metadata.gz: 6cef4b611ae3f1d13d971e51d54388ca55f1abaf715134d51336ef4ff433f56fdc3e1c53924fd8c28d68bc1fbb1c8a26fbad434487ee380a63fa4889ead73e67
+  data.tar.gz: 9dc77cee4e5cb87c3fa637e4bbb3849c52d102041544d07538042dd3df97fd2bec2a7a817c20a81ddb4d94662dfae89c4f012126c388fe5da396575834ba8797

data/lib/tml_rails/extensions/action_common_methods.rb

@@ -31,15 +31,7 @@
 
 module TmlRails
   module ActionCommonMethods
-    ############################################################
-    # There are three ways to call the tr method
-    #
-    # tr(label, desc = '', tokens = {}, options = {})
-    # or
-    # tr(label, tokens = {}, options = {})
-    # or
-    # tr(:label => label, :description => '', :tokens => {}, :options => {})
-    ############################################################
+
     def tr(label, description = '', tokens = {}, options = {})
       params = Tml::Utils.normalize_tr_params(label, description, tokens, options)
       return params[:label].html_safe if params[:label].tml_translated?
@@ -51,26 +43,7 @@ module TmlRails
         params[:options][:host] = request.env['HTTP_HOST']
       end
 
-      if Tml.config.disabled?
-        return Tml.config.default_language.translate(params[:label], params[:tokens], params[:options]).tml_translated.html_safe
-      end
-
-      # Translate individual sentences
-      if params[:options][:split]
-        text = params[:label]
-        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
-        return text.tml_translated.html_safe
-      end
-
-      Tml.session.target_language.translate(params).tml_translated.html_safe
-    rescue Tml::Exception => ex
-      #pp ex, ex.backtrace
-      Tml.logger.error(ex.message)
-      #Tml.logger.error(ex.message + "\n=> " + ex.backtrace.join("\n=> "))
-      label
+      Tml.translate(params)
     end
 
     # for translating labels
@@ -119,6 +92,10 @@ module TmlRails
       tml_session.current_translator
     end
 
+    def tml_default_locale
+      tml_session.application.default_locale
+    end
+
     def tml_current_locale
       tml_session.current_language.locale
     end

data/lib/tml_rails/extensions/action_controller_extension.rb

@@ -52,18 +52,6 @@ module TmlRails
 
     module InstanceMethods
 
-      # Returns all browser accepted locales
-      def tml_browser_accepted_locales
-        @tml_browser_accepted_locales ||= Tml::Utils.browser_accepted_locales(request.env['HTTP_ACCEPT_LANGUAGE']).join(',')
-      end
-
-      # Overwrite this method in a controller to assign a custom source for all views
-      def tml_source
-        "/#{controller_name}/#{action_name}"
-      rescue
-        self.class.name
-      end
-
       # Returns data from cookie set by the agent
       def tml_cookie
         @tml_cookie ||= begin
@@ -79,61 +67,57 @@ module TmlRails
         {}
       end
 
+      # Overwrite this method in a controller to assign a custom source for all views
+      def tml_source
+        "/#{controller_name}/#{action_name}"
+      rescue
+        "/classes/#{self.class.name}"
+      end
+
       # 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 locale has been passed by a param, it will be in the params hash
+        if Tml.config.locale_strategy == 'param'
+          return params[Tml.config.locale_param]  # will be nil without ?locale=:locale
+        end
 
-          if locale.nil?
-            if params[:locale].blank?
-              locale = tml_cookie[:locale]
-              if locale.nil?
-                if Tml.config.locale[:subdomain]
-                  locale = request.subdomains.first
-                elsif Tml.config.locale[:tld]
-                  locale = request.host.split('.').last
-                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
+        if Tml.config.locale_strategy == 'pre-path'
+          return params[Tml.config.locale_param]  # will be nil without /:locale
+        end
+
+        if Tml.config.locale_strategy == 'pre-domain'
+          locale = request.subdomains.first
+          if locale.nil? or not locale.match(Tml.config.locale_expression)
+            locale = Tml.config.locale[:default]
           end
+          return locale
+        end
 
-          locale
+        if Tml.config.locale_strategy == 'custom-domain'
+          host = "#{request.host}#{[80, 443].include?(request.port) ? '' : ":#{request.port}"}"
+          locale = Tml.config.locale[:mapping].invert[host]  # will be nil if host is wrong
+          return locale
         end
+
+        nil
       end
 
       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
+        unless Tml.config.current_user_method.blank?
+          begin
+            self.send(Tml.config.current_user_method)
+          rescue
+            {}
           end
         end
       end
 
       def tml_translator
-        @tml_translator ||= begin
-          if tml_cookie[:translator]
-            Tml::Translator.new(tml_cookie[:translator])
-          else
-            nil
-          end
+        if tml_cookie[:translator]
+          Tml::Translator.new(tml_cookie[:translator])
+        else
+          nil
         end
       end
 
@@ -148,9 +132,30 @@ module TmlRails
 
         @tml_started_at = Time.now
 
+        requested_locale = desired_locale = tml_locale
+
+        # if user has a custom method for providing the locale, use it
+        if Tml.config.current_locale_method
+          begin
+            desired_locale = self.send(Tml.config.current_locale_method)
+          rescue
+            desired_locale = requested_locale
+          end
+        end
+        # check if locale was previously stored in a cookie
+        desired_locale ||= Tml.config.locale_cookie_enabled? ? tml_cookie[:locale] : nil
+        # fallback onto the browser locale
+        desired_locale ||= Tml.config.locale_browser_enabled? ? Tml::Utils.browser_accepted_locales(
+            request.env['HTTP_ACCEPT_LANGUAGE']
+        ).join(',') : nil
+
+        # pp requested_locale: requested_locale, desired_locale: desired_locale
+        # pp cookie: tml_cookie
+
+        # init SDK with desired locale and get the actual locale supported in the app
         Tml.session.init(
             :source => tml_source,
-            :locale => tml_locale,
+            :locale => desired_locale,
             :user => tml_viewing_user,
             :translator => tml_translator,
             :access_token => tml_access_token
@@ -159,7 +164,69 @@ module TmlRails
         if defined? I18n.enforce_available_locales
           I18n.enforce_available_locales = false
         end
-        I18n.locale = Tml.session.current_language.locale
+        I18n.locale = tml_current_locale
+
+        # pp current_locale: tml_current_locale
+
+        # check if we want to store the last selected locale in the cookie
+        if requested_locale == tml_current_locale and Tml.config.locale_cookie_enabled?
+          tml_cookie[:locale] = tml_current_locale
+          cookies[Tml::Utils.cookie_name(Tml.config.application[:key])] = {
+              :value => Tml::Utils.encode(tml_cookie),
+              :expires => 1.year.from_now,
+              :domain => Tml.config.locale[:domain]
+          }
+        end
+
+        # pp cookie: tml_cookie
+        # pp redirect: Tml.config.locale_redirect_enabled?
+
+        if Tml.config.locale_redirect_enabled?
+          if Tml.config.locale[:skip_default] and tml_current_locale == tml_default_locale
+            # first lets see if we are in default locale and user doesn't want to show locale in url
+            if Tml.config.locale_strategy == 'pre-path' and not requested_locale.nil?
+              return redirect_to(Tml.config.locale_param => nil)
+            end
+
+            if Tml.config.locale_strategy == 'pre-domain' and request.subdomains.any?
+              fragments = request.host.split('.')
+              if fragments.first.match(Tml.config.locale_expression)
+                if Tml.config.locale[:default_subdomain]
+                  fragments[0] = Tml.config.locale[:default_subdomain]
+                else
+                  fragments.shift
+                end
+              end
+              return redirect_to(host: fragments.join('.'))
+            end
+
+            if Tml.config.locale_strategy == 'custom-domain'
+              host = Tml.config.locale[:mapping][tml_default_locale]
+              return redirect_to(host: host)
+            end
+          elsif requested_locale != tml_current_locale
+            # otherwise, the locale is not the same as what was requested, deal with it
+            if Tml.config.locale_strategy == 'pre-path'
+              return redirect_to(Tml.config.locale_param => tml_current_locale)
+            end
+
+            if Tml.config.locale_strategy == 'pre-domain'
+              fragments = request.host.split('.')
+              if request.subdomains.any?
+                fragments[0] = tml_current_locale
+              else
+                fragments.unshift(tml_current_locale)
+              end
+              return redirect_to(host: fragments.join('.'))
+            end
+
+            if Tml.config.locale_strategy == 'custom-domain'
+              host = Tml.config.locale[:mapping][tml_current_locale]
+              host ||= Tml.config.locale[:mapping][tml_default_locale]
+              return redirect_to(host: host)
+            end
+          end
+        end
 
         if tml_current_translator and tml_current_translator.inline?
           I18n.reload!

data/lib/tml_rails/extensions/action_view_extension.rb

@@ -128,10 +128,12 @@ module TmlRails
         agent_host += "?ts=#{t.to_i}"
       end
 
+      agent_config[:domain] = Tml.config.domain if Tml.config.domain
       agent_config[:locale] = tml_current_locale
       agent_config[:source] = tml_current_source
       agent_config[:css] = tml_application.css
       agent_config[:sdk] = Tml.respond_to?(:full_version) ? Tml.full_version : Tml::VERSION
+      agent_config[:locale_strategy] = Tml.config.agent_locale_strategy
       agent_config[:languages] = []
 
       tml_application.languages.each do |lang|

data/lib/tml_rails/version.rb

@@ -30,5 +30,5 @@
 #++
 
 module TmlRails
-  VERSION = '5.4.6'
+  VERSION = '5.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tml-rails
 version: !ruby/object:Gem::Version
-  version: 5.4.6
+  version: 5.5.0
 platform: ruby
 authors:
 - Michael Berkovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.6'
 description: Translation Markup Language from Translation Exchange.
 email:
 - support@translationexchange.com
@@ -85,4 +85,3 @@ signing_key:
 specification_version: 4
 summary: Tml Client SDK for Ruby on Rails
 test_files: []
-has_rdoc: