tr8n 3.0.2

data/lib/tr8n/tokenized_label.rb

@@ -0,0 +1,141 @@
+#--
+# Copyright (c) 2010-2011 Michael Berkovich
+#
+# 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.
+#++
+
+class Tr8n::TokenizedLabel
+   
+  # constracts the label  
+  def initialize(label)
+    @label = label
+  end
+
+  def label
+    @label
+  end
+
+  # scans for all token types    
+  def data_tokens
+    @data_tokens ||= Tr8n::Token.register_data_tokens(label)
+  end
+
+  def data_tokens?
+    data_tokens.any?
+  end
+
+  def decoration_tokens
+    @decoration_tokens ||= Tr8n::Token.register_decoration_tokens(label)
+  end
+
+  def decoration_tokens?
+    decoration_tokens.any?
+  end
+
+  def tokens
+    @tokens = data_tokens + decoration_tokens
+  end
+
+  def sanitized_tokens_hash
+    @sanitized_tokens_hash ||= begin
+      hash = {}
+      tokens.each do |token|
+        hash[token.sanitized_name] = token
+      end
+      hash
+    end
+  end
+  
+  def tokens?
+    tokens.any?
+  end
+
+  # tokens that can be used by the user in translation
+  def translation_tokens
+    @translation_tokens ||= tokens.select{|token| token.allowed_in_translation?} 
+  end
+
+  def translation_tokens?
+    translation_tokens.any?
+  end
+
+  def sanitized_label
+    @sanitized_label ||= begin 
+      lbl = label.clone
+      data_tokens.each do |token|
+        lbl = token.prepare_label_for_translator(lbl)
+      end
+      lbl
+    end 
+  end
+  
+  def tokenless_label
+    @tokenless_label ||= begin
+      lbl = label.clone
+      tokens.each_with_index do |token, index|
+        lbl = token.prepare_label_for_suggestion(lbl, index)
+      end
+      lbl
+    end
+  end 
+
+  def suggestion_tokens
+    @suggestion_tokens ||= begin
+      toks = []
+      tokens.each do |token|
+        if token.decoration?
+          toks << token.name
+        else  
+          toks << token.sanitized_name          
+        end
+      end
+      toks
+    end
+  end 
+  
+  def words
+    return [] if label.blank?
+    
+    @words ||= begin 
+      clean_label = sanitized_label
+      parts = []
+      clean_label = clean_label.gsub(/[\,\.\;\!\-\:\'\"\[\]{}]/, "")
+      
+      clean_label.split(" ").each do |w|
+        parts << w.strip.capitalize if w.length > 3
+      end
+      parts
+    end
+  end
+
+  def sanitized_tokens_hash
+    @sanitized_tokens_hash ||= begin
+      hash = {}
+      tokens.each do |token|
+        hash[token.sanitized_name] = token
+      end
+      hash
+    end
+  end
+  
+  def allowed_token?(token)
+    not sanitized_tokens_hash[token.sanitized_name].nil?
+  end
+end

data/lib/tr8n/tokens/data_token.rb

@@ -0,0 +1,52 @@
+#--
+# Copyright (c) 2010-2011 Michael Berkovich
+#
+# 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.
+#++
+
+####################################################################### 
+# 
+# Data Token Forms:
+#
+# {count} 
+# {count:number} 
+# {user:gender}
+# {today:date} 
+# {user_list:list}
+# {long_token_name} 
+# {user1}
+# {user1:user}
+# {user1:user::pos}
+#
+# Data tokens can be associated with any rules through the :dependency
+# notation or using the nameing convetnion of the token suffix, defined
+# in the tr8n configuration file
+#
+####################################################################### 
+
+module Tr8n
+  module Tokens
+    class DataToken < Tr8n::Token
+      def self.expression
+        /(\{[^_][\w]+(:[\w]+)?(::[\w]+)?\})/
+      end
+    end
+  end
+end

data/lib/tr8n/tokens/decoration_token.rb

@@ -0,0 +1,124 @@
+#--
+# Copyright (c) 2010-2011 Michael Berkovich
+#
+# 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.
+#++
+
+####################################################################### 
+# 
+# Decoration Token Forms:
+#
+# [link: click here]
+#
+# Decoration Tokens Allow Nesting:
+# 
+# [link: {count} {_messages}] 
+# [link: {count||message}] 
+# [link: {count||person, people}] 
+# [link: {user.name}] 
+#
+####################################################################### 
+module Tr8n
+  module Tokens
+    class DecorationToken < Tr8n::Token
+      def self.expression
+        /(\[\w+:[^\]]+\])/
+      end
+      
+      def decoration?
+        true
+      end
+      
+      def language_rule
+        nil
+      end
+      
+      def value
+        @value ||= begin
+          parts = full_name.gsub(/[\]]/, '').split(':')
+          vl = parts[1..-1].join(':')
+          vl.strip
+        end
+      end
+      
+      # return as is
+      def prepare_label_for_translator(label)
+        label
+      end
+    
+      # return only the internal part
+      def prepare_label_for_suggestion(label, index)
+        label.gsub(name, "(#{index})")
+      end
+        
+      def handle_default_decorations(lambda_token_name, lambda_token_value, token_values)
+        unless Tr8n::Config.default_decoration_tokens[lambda_token_name]
+          raise Tr8n::TokenException.new("Invalid decoration token value")
+        end
+    
+        lambda_value = Tr8n::Config.default_decoration_tokens[lambda_token_name].clone
+    
+        params = [lambda_token_value]
+        params += token_values[lambda_token_name.to_sym] if token_values[lambda_token_name.to_sym]
+        
+        params.each_with_index do |param, index|
+          lambda_value.gsub!("{$#{index}}", param.to_s)
+        end
+        
+        # clean all the rest of the {$num} params, if any
+        param_index = params.size
+        while lambda_value.index("{$#{param_index}}")
+          lambda_value.gsub!("{$#{param_index}}", "")
+          param_index += 1
+        end
+        
+        lambda_value
+      end  
+      
+      def substitute(label, values = {}, options = {}, language = Tr8n::Config.current_language)
+        method = values[name_key]
+        substitution_value = ""
+        
+        if method
+          if method.is_a?(Proc)
+            substitution_value = method.call(value)
+          elsif method.is_a?(Array)
+            substitution_value = handle_default_decorations(name, value, values)
+          elsif method.is_a?(String)
+            substitution_value = method.to_s.gsub("{$0}", value)
+          else
+            raise Tr8n::TokenException.new("Invalid decoration token value")
+          end
+        elsif Tr8n::Config.default_decoration_tokens[name]
+          substitution_value = handle_default_decorations(name, value, values)
+        else
+          raise Tr8n::TokenException.new("Missing decoration token value")
+        end
+          
+        label.gsub(full_name, substitution_value) 
+      end
+      
+      def sanitized_name
+        "[#{name}: ]"
+      end
+      
+    end
+  end
+end

data/lib/tr8n/tokens/hidden_token.rb

@@ -0,0 +1,87 @@
+#--
+# Copyright (c) 2010-2011 Michael Berkovich
+#
+# 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.
+#++
+
+####################################################################### 
+# 
+# Hidden Token Forms:
+#
+# {_he_she} 
+# {_posted__items}
+#
+#  '_' escaped as '/'
+#  '__' escaped as '__'
+# 
+# Hidden tokens cannot have rules and are there for default language
+# substitutions only
+#
+####################################################################### 
+
+module Tr8n
+  module Tokens
+    class HiddenToken < Tr8n::Token
+      def self.expression
+        /(\{_[\w]+\})/
+      end
+    
+      def allowed_in_translation?
+        false
+      end
+    
+      def supports_cases?
+        false
+      end
+    
+      def dependant?
+        false
+      end
+    
+      def dependency_rules
+        []
+      end
+    
+      def language_rule
+        nil
+      end
+    
+      # return humanized form
+      def prepare_label_for_translator(label)
+        label.gsub(full_name, humanized_name)
+      end
+    
+      # return humanized form
+      def prepare_label_for_suggestion(label, index)
+        label.gsub(full_name, humanized_name)
+      end
+      
+      def humanized_name
+        @humanized_name ||= begin
+          hnm = name[1..-1].clone
+          hnm.gsub!('__', ' ')
+          hnm.gsub!('_', '/')
+          hnm
+        end
+      end
+      
+    end
+  end
+end

data/lib/tr8n/tokens/method_token.rb

@@ -0,0 +1,60 @@
+#--
+# Copyright (c) 2010-2011 Michael Berkovich
+#
+# 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.
+#++
+
+####################################################################### 
+# 
+# Method Token Forms
+#
+# {user.name}  
+# {user.name:gender}
+# 
+####################################################################### 
+
+module Tr8n
+  module Tokens
+    class MethodToken < Tr8n::Token
+      def self.expression
+        /(\{[^_][\w]+(\.[\w]+)(:[\w]+)?(::[\w]+)?\})/
+      end
+    
+      def object_name
+        @object_name ||= name.split(".").first
+      end
+    
+      def object_method_name
+        @object_method_name ||= name.split(".").last
+      end
+    
+      def suffix
+        @suffix ||= object_name.split('_').last
+      end
+    
+      def substitute(label, values = {}, options = {}, language = Tr8n::Config.current_language)
+        object = values[object_name.to_sym]
+        raise Tr8n::TokenException.new("Missing value for a token: #{full_name}") unless object
+        object_value = sanitize_token_value(object, object.send(object_method_name), options.merge(:sanitize_values => true), language)
+        label.gsub(full_name, object_value)
+      end
+    end
+  end
+end