tr8n_client_sdk 1.0.0

data/lib/tr8n_client_sdk/engine.rb

@@ -0,0 +1,31 @@
+#--
+# Copyright (c) 2010-2013 Michael Berkovich, tr8nhub.com
+#
+# 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.
+#++
+
+module Tr8nClientSdk
+  class Engine < ::Rails::Engine
+    isolate_namespace Tr8nClientSdk
+    config.generators do |g|
+      g.test_framework :rspec, :view_specs => false
+    end
+  end
+end

data/lib/tr8n_client_sdk/extensions/action_common_methods.rb

@@ -0,0 +1,122 @@
+#--
+# Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+#
+# 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.
+#++
+
+module Tr8nClientSdk
+  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 = {})
+      return label if label.tr8n_translated?
+
+      params = Tr8n::Utils.normalize_tr_params(label, description, tokens, options)
+      params[:options][:caller] = caller
+
+      if request
+        params[:options][:url]  = request.url
+        params[:options][:host] = request.env['HTTP_HOST']
+      end
+
+      if Tr8n.config.disabled?
+        return Tr8n::TranslationKey.substitute_tokens(params[:label], params[:tokens], params[:options]).tr8n_translated.html_safe
+      end
+
+      # Translate individual sentences
+      if params[:options][:split]
+        text = params[:label]
+        sentences = Tr8n::Utils.split_by_sentence(text)
+        sentences.each do |sentence|
+          text = text.gsub(sentence, Tr8n.config.current_language.translate(sentence, params[:description], params[:tokens], params[:options]))
+        end
+        return text.tr8n_translated.html_safe
+      end
+
+      Tr8n.config.current_language.translate(params).tr8n_translated.html_safe
+    rescue Tr8n::Exception => ex
+      Tr8n::Logger.error("ERROR: #{label}")
+      Tr8n::Logger.error(ex.message + "\n=> " + ex.backtrace.join("\n=> "))
+      label
+    end
+
+    # for translating labels
+    def trl(label, description = "", tokens = {}, options = {})
+      params = Tr8n::Utils.normalize_tr_params(label, description, tokens, options)
+      params[:options][:skip_decorations] = true
+      tr(params)
+    end
+
+    # flash notice
+    def trfn(label, desc = "", tokens = {}, options = {})
+      flash[:trfn] = tr(Tr8n::Utils.normalize_tr_params(label, desc, tokens, options))
+    end
+
+    # flash error
+    def trfe(label, desc = "", tokens = {}, options = {})
+      flash[:trfe] = tr(Tr8n::Utils.normalize_tr_params(label, desc, tokens, options))
+    end
+
+    # flash warning
+    def trfw(label, desc = "", tokens = {}, options = {})
+      flash[:trfw] = tr(Tr8n::Utils.normalize_tr_params(label, desc, tokens, options))
+    end
+
+    ######################################################################
+    ## Common methods - wrappers
+    ######################################################################
+
+    def tr8n_application
+      Tr8n.config.application
+    end
+
+    def tr8n_current_user
+      Tr8n.config.current_user
+    end
+
+    def tr8n_current_language
+      Tr8n.config.current_language
+    end
+
+    def tr8n_default_language
+      Tr8n.config.default_language
+    end
+
+    def tr8n_current_translator
+      Tr8n.config.current_translator
+    end
+
+    def tr8n_current_user_is_guest?
+      Tr8n.config.current_user_is_guest?
+    end
+
+    def tr8n_current_user_is_translator?
+      not Tr8n.config.current_translator.nil?
+    end
+
+  end
+end

data/lib/tr8n_client_sdk/extensions/action_controller_extension.rb

@@ -0,0 +1,123 @@
+#--
+# Copyright (c) 2013 Michael Berkovich, tr8nhub.com
+#
+# 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.
+#++
+
+module Tr8nClientSdk
+  module ActionControllerExtension
+
+    def self.included(base)
+      base.send(:include, Tr8nClientSdk::ActionCommonMethods) 
+      base.send(:include, InstanceMethods) 
+      base.before_filter :tr8n_init_client_sdk
+      base.after_filter :tr8n_reset_client_sdk
+    end
+
+    module InstanceMethods
+
+      def tr8n_browser_accepted_locales
+        @tr8n_browser_accepted_locales ||= Tr8n::Utils.browser_accepted_locales(request)
+      end
+
+      def tr8n_user_preferred_locale
+        tr8n_browser_accepted_locales.each do |locale|
+          next unless Tr8n.config.application.locales.include?(locale)
+          return locale
+        end
+        Tr8n.config.default_locale
+      end
+      
+      # Overwrite this method in a controller to assign a custom source for all views
+      def tr8n_source
+        "/#{controller_name}/#{action_name}"
+      rescue
+        self.class.name
+      end
+
+      # Overwrite this method in a controller to assign a custom component for all views
+      def tr8n_component
+        nil
+      end  
+
+      def tr8n_init_current_locale
+        self.send(Tr8n.config.current_locale_method)
+      rescue
+        # fallback to the default session based locale implementation
+        # choose the first language from the accepted languages header
+        session[:locale] = tr8n_user_preferred_locale unless session[:locale]
+        session[:locale] = params[:locale] if params[:locale]
+        session[:locale]
+      end
+
+      def tr8n_init_current_user
+        self.send(Tr8n.config.current_user_method)
+      end
+
+      def tr8n_init_client_sdk
+        return unless Tr8n.config.enabled?
+
+        Tr8n.logger.info("Initializing request...")
+        @tr8n_started_at = Time.now
+
+        Tr8n.config.init_application
+        tr8n_application.update_cache_version
+
+        translator = nil
+
+        cookie_name = "tr8n_#{tr8n_application.key}"
+        if request.cookies[cookie_name]
+          Tr8n.logger.info("Cookie exists:")
+          cookie_params = Tr8n::Utils.decode_and_verify_params(request.cookies[cookie_name], Tr8n.config.app_secret)
+          Tr8n.logger.info(cookie_params.inspect)
+          locale = cookie_params["locale"]
+          translator = Tr8n::Translator.new(cookie_params["translator"].merge(:application => tr8n_application)) unless cookie_params["translator"].nil?
+        else
+          Tr8n.logger.info("Cookie does not exist")
+        end
+
+        locale ||= tr8n_init_current_locale
+        user = tr8n_init_current_user
+
+        Tr8n.config.init_request(user, translator, locale, tr8n_source, tr8n_component)
+
+        # register component and verify that the current user is authorized to view it
+        #unless Tr8n.config.current_user_is_authorized_to_view_component?
+        #   trfe("You are not authorized to view this component")
+        #   return redirect_to(Tr8n.config.default_url)
+        #end
+        #unless Tr8n.config.current_user_is_authorized_to_view_language?
+        #   Tr8n.config.set_language(Tr8n.config.default_language)
+        #end
+      end
+
+      def tr8n_reset_client_sdk
+        @tr8n_finished_at = Time.now
+
+        Tr8n.logger.info("Resetting request...")
+        tr8n_application.submit_missing_keys
+        Tr8n.config.reset_request
+
+        Tr8n.logger.info("Request took #{@tr8n_finished_at - @tr8n_started_at} mls")
+      end
+
+    end
+  end
+end

data/lib/tr8n_client_sdk/extensions/action_view_extension.rb

@@ -0,0 +1,218 @@
+#--
+# Copyright (c) 2010-2013 Michael Berkovich, tr8nhub.com
+#
+# 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.
+#++
+
+module Tr8nClientSdk
+  module ActionViewExtension
+    extend ActiveSupport::Concern
+
+    def tr8n_options_for_select(options, selected = nil, description = nil, lang = Tr8n.config.current_language)
+      options_for_select(options.tro(description), selected)
+    end
+
+    def tr8n_phrases_link_tag(search = "", phrase_type = :without, phrase_status = :any)
+      return unless Tr8n.config.enabled?
+      return if Tr8n.config.current_language.default?
+      return unless Tr8n.config.current_translator.inline?
+
+      link_to(image_tag(Tr8n.config.url_for("/assets/tr8n/translate_icn.gif"), :style => "vertical-align:middle; border: 0px;", :title => search),
+                        Tr8n.config.url_for("/tr8n/app/phrases/index?search=#{search}")).html_safe
+    end
+
+    def tr8n_language_flag_tag(lang = Tr8n.config.current_language, opts = {})
+      return "" unless Tr8n.config.application.feature_enabled?(:language_flags)
+      html = image_tag(lang.flag_url, :style => "vertical-align:middle;", :title => lang.native_name)
+      html << "&nbsp;".html_safe 
+      html.html_safe
+    end
+
+    def tr8n_language_name_tag(lang = Tr8n.config.current_language, opts = {})
+      show_flag = opts[:flag].nil? ? true : opts[:flag]
+      name_type = opts[:name].nil? ? :full : opts[:name] # :full, :native, :english, :locale
+      linked = opts[:linked].nil? ? true : opts[:linked] 
+
+      html = "<span style='white-space: nowrap'>"
+      html << tr8n_language_flag_tag(lang, opts) if show_flag
+      html << "<span dir='ltr'>"
+
+      name = case name_type
+        when :native  then lang.native_name
+        when :english then lang.english_name
+        when :locale  then lang.locale
+        else lang.full_name
+      end
+
+#      if linked
+#        # Todo: use language selector
+##        html << link_to(name.html_safe, "/tr8n/language/switch?locale=#{lang.locale}&language_action=switch_language&source_url=#{CGI.escape(opts[:source_url]||'')}")
+#      else
+        html << name
+      #end
+
+      html << "</span></span>"
+      html.html_safe
+    end
+
+    def tr8n_language_strip_tag(opts = {})
+      opts[:flag] = opts[:flag].nil? ? false : opts[:flag]
+      opts[:name] = opts[:name].nil? ? :native : opts[:name] 
+      opts[:linked] = opts[:linked].nil? ? true : opts[:linked] 
+      opts[:javascript] = opts[:javascript].nil? ? false : opts[:javascript] 
+
+      render(:partial => '/tr8n_client_sdk/tags/language_strip', :locals => {:opts => opts})    
+    end
+
+    def tr8n_flashes_tag(opts = {})
+      render(:partial => '/tr8n_client_sdk/tags/flashes', :locals => {:opts => opts})    
+    end
+
+    def tr8n_scripts_tag(opts = {})
+      render(:partial => '/tr8n_client_sdk/tags/scripts', :locals => {:opts => opts})    
+    end
+
+    def tr8n_select_month(date, options = {}, html_options = {})
+      month_names = options[:use_short_month] ? Tr8n.config.default_abbr_month_names : Tr8n.config.default_month_names
+      select_month(date, options.merge(
+        :use_month_names => month_names.collect{|month_name| Tr8n::Language.translate(month_name, options[:description] || "Month name")} 
+      ), html_options)
+    end
+
+    def tr8n_with_options_tag(opts, &block)
+      if Tr8n.config.disabled?
+        return capture(&block) if block_given?
+        return ""
+      end
+
+      Thread.current[:block_options] ||= []
+      Thread.current[:block_options].push(opts)
+
+      #component = Tr8n.config.current_component_from_block_options
+      #if component
+      #  source = Tr8n.config.current_source_from_block_options
+      #  unless source.nil?
+      #    Tr8n::ComponentSource.find_or_create(component, source)
+      #  end
+      #end
+      #
+      #if Tr8n.config.current_user_is_authorized_to_view_component?(component)
+      #  selected_language = Tr8n.config.current_language
+      #
+      #  unless Tr8n.config.current_user_is_authorized_to_view_language?(component, selected_language)
+      #    Tr8n.config.set_language(Tr8n.config.default_language)
+      #  end
+      #
+      #  if block_given?
+      #    ret = capture(&block)
+      #  end
+      #
+      #  Tr8n.config.current_language = selected_language
+      #else
+      #  ret = ""
+      #end
+
+      if block_given?
+        ret = capture(&block)
+      end
+
+      Thread.current[:block_options].pop
+      ret
+    end
+
+    def tr8n_content_for_locales_tag(opts = {}, &block)
+      locale = Tr8n.config.current_language.locale
+
+      if opts[:only] 
+         return unless opts[:only].include?(locale)
+      end
+
+      if opts[:except]
+        return if opts[:except].include?(locale)
+      end
+
+      if block_given?
+        ret = capture(&block) 
+      end
+      ret
+    end
+
+    def tr8n_content_for_countries_tag(opts = {}, &block)
+      country = Tr8n.config.country_from_ip(tr8n_request_remote_ip)
+      
+      if opts[:only] 
+         return unless opts[:only].include?(country)
+      end
+
+      if opts[:except]
+        return if opts[:except].include?(country)
+      end
+
+      if block_given?
+        ret = capture(&block) 
+      end
+      ret
+    end
+
+    def tr8n_when_string_tag(time, opts = {})
+      elapsed_seconds = Time.now - time
+      if elapsed_seconds < 0
+        tr('In the future, Marty!', 'Time reference')
+      elsif elapsed_seconds < 2.minutes
+        tr('a moment ago', 'Time reference')
+      elsif elapsed_seconds < 55.minutes
+        elapsed_minutes = (elapsed_seconds / 1.minute).to_i
+        tr("{minutes||minute} ago", 'Time reference', :minutes => elapsed_minutes)
+      elsif elapsed_seconds < 1.75.hours
+        tr("about an hour ago", 'Time reference')
+      elsif elapsed_seconds < 12.hours
+        elapsed_hours = (elapsed_seconds / 1.hour).to_i
+        tr("{hours||hour} ago", 'Time reference', :hours => elapsed_hours)
+      elsif time.today_in_time_zone?
+        display_time(time, :time_am_pm)
+      elsif time.yesterday_in_time_zone?
+        tr("Yesterday at {time}", 'Time reference', :time => time.tr(:time_am_pm).gsub('/ ', '/').sub(/^[0:]*/,""))
+      elsif elapsed_seconds < 5.days
+        time.tr(:day_time).gsub('/ ', '/').sub(/^[0:]*/,"")
+      elsif time.same_year_in_time_zone?
+        time.tr(:monthname_abbr_time).gsub('/ ', '/').sub(/^[0:]*/,"")
+      else
+        time.tr(:monthname_abbr_year_time).gsub('/ ', '/').sub(/^[0:]*/,"")
+      end
+    end
+    
+    ######################################################################
+    ## Language Direction Support
+    ######################################################################
+
+    def tr8n_style_attribute_tag(attr_name = 'float', default = 'right', lang = Tr8n.config.current_language)
+      "#{attr_name}:#{lang.align(default)}".html_safe
+    end
+
+    def tr8n_style_directional_attribute_tag(attr_name = 'padding', default = 'right', value = '5px', lang = Tr8n.config.current_language)
+      "#{attr_name}-#{lang.align(default)}:#{value}".html_safe
+    end
+
+    def tr8n_dir_attribute_tag(lang = Tr8n.config.current_language)
+      "dir='#{lang.dir}'".html_safe
+    end
+
+  end
+end