tr8n 3.2.0 → 3.2.1

data/app/javascript/src/rules/list_rule.js

@@ -0,0 +1,37 @@
+/****************************************************************************
+  Copyright (c) 2010-2012 Michael Berkovich, Ian McDaniel, tr8n.net
+
+  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.
+****************************************************************************/
+
+Tr8n.Proxy.ListRule = function(definition, options) {
+  this.definition = definition;
+  this.options = options;
+}
+
+Tr8n.Proxy.ListRule.prototype = new Tr8n.Proxy.LanguageRule();
+
+Tr8n.Proxy.ListRule.transform = function(object, values) {
+  return "";
+}
+
+Tr8n.Proxy.ListRule.prototype.evaluate = function(token, token_values) {
+  return true;
+}

data/app/javascript/src/rules/numeric_rule.js

@@ -0,0 +1,95 @@
+/****************************************************************************
+  Copyright (c) 2010-2012 Michael Berkovich, Ian McDaniel, tr8n.net
+
+  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.
+****************************************************************************/
+
+Tr8n.Proxy.NumericRule = function(definition, options) {
+  this.definition = definition;
+  this.options = options;
+}
+
+Tr8n.Proxy.NumericRule.prototype = new Tr8n.Proxy.LanguageRule();
+
+// English based transform method
+// FORM: [singular, plural]
+// {count | message, messages}
+// {count | person, people}
+Tr8n.Proxy.NumericRule.transform = function(count, values) {
+  if (count == 1) return values[0];
+  if (values.length == 2) {
+    return values[1];
+  }
+  return values[0].pluralize();  
+}
+
+Tr8n.Proxy.NumericRule.prototype.evaluate = function(token_name, token_values){
+  //  "count":{"value1":"2,3,4","operator":"and","type":"number","multipart":true,"part2":"does_not_end_in","value2":"12,13,14","part1":"ends_in"}
+  
+  var object = this.getTokenValue(token_name, token_values);
+  if (object == null) return false;
+
+  var token_value = null;
+  if (typeof object == 'string' || typeof object == 'number') {
+    token_value = "" + object;
+  } else if (typeof object == 'object' && object['subject']) { 
+    token_value = "" + object['subject'];
+  } else {
+    this.getLogger().error("Invalid token value for numeric token: " + token_name);
+    return false;
+  }
+  
+  this.getLogger().debug("Rule value: '" + token_value + "' for definition: " + this.getDefinitionDescription());
+  
+  var result1 = this.evaluatePartialRule(token_value, this.definition['part1'], this.sanitizeArrayValue(this.definition['value1']));
+  if (this.definition['multipart'] == 'false' || this.definition['multipart'] == false || this.definition['multipart'] == null) return result1;
+  this.getLogger().debug("Part 1: " + result1 + " Processing part 2...");
+
+  var result2 = this.evaluatePartialRule(token_value, this.definition['part2'], this.sanitizeArrayValue(this.definition['value2']));
+  this.getLogger().debug("Part 2: " + result2 + " Completing evaluation...");
+  
+  if (this.definition['operator'] == "or") return (result1 || result2);
+  return (result1 && result2);
+}
+
+
+Tr8n.Proxy.NumericRule.prototype.evaluatePartialRule = function(token_value, name, values) {
+  if (name == 'is') {
+    if (Tr8n.Utils.indexOf(values, token_value)!=-1) return true; 
+    return false;
+  }
+  if (name == 'is_not') {
+    if (Tr8n.Utils.indexOf(values, token_value)==-1) return true; 
+    return false;
+  }
+  if (name == 'ends_in') {
+    for(var i=0; i<values.length; i++) {
+      if (token_value.match(values[i] + "$")) return true;
+    }
+    return false;
+  }
+  if (name == 'does_not_end_in') {
+    for(var i=0; i<values.length; i++) {
+      if (token_value.match(values[i] + "$")) return false;
+    }
+    return true;
+  }
+  return false;
+}

data/app/javascript/src/tml/label.js

@@ -0,0 +1,60 @@
+/****************************************************************************
+  Copyright (c) 2010-2012 Michael Berkovich, Ian McDaniel, tr8n.net
+
+  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.
+****************************************************************************/
+
+Tr8n.Tml = Tr8n.Tml || {};
+
+Tr8n.Tml.Label = function(node, proxy) {
+  this.node = node;
+  this.label = "";
+  this.description = "";
+  this.tokens = {};
+  this.options = {};
+  this.proxy = proxy;
+
+  for (var i=0; i < this.node.childNodes.length; i++) {
+    var childNode = this.node.childNodes[i];
+
+    // text should just be added to the label
+    if (childNode.nodeType == 3) {
+      this.label = this.label + " " + Tr8n.Utils.trim(childNode.nodeValue);
+    } else if (childNode.nodeName == "TML:TOKEN") {
+      var token = new Tr8n.Tml.Token(childNode, this.tokens);
+      this.label = Tr8n.Utils.trim(this.label) + " " + token.toTokenString();
+    }
+    
+  }
+
+  this.description = this.node.attributes['desc'] || this.node.attributes['description']; 
+  this.description = this.description ? this.description.value : null;
+
+  this.label = this.label.replace(/\n/g, '');
+  this.label = Tr8n.Utils.trim(this.label);
+
+  // console.log(this.label + " : " + this.description);
+}
+
+Tr8n.Tml.Label.prototype = {
+  translate: function() {
+    this.node.innerHTML = this.proxy.translate(this.label, this.description, this.tokens, this.options);
+  }
+}

data/app/javascript/src/tml/token.js

@@ -0,0 +1,107 @@
+/****************************************************************************
+  Copyright (c) 2010-2012 Michael Berkovich, Ian McDaniel, tr8n.net
+
+  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.
+****************************************************************************/
+
+Tr8n.Tml = Tr8n.Tml || {};
+
+Tr8n.Tml.Token = function(node, tokens) {
+  this.node = node;
+  
+  this.type = this.node.attributes['type'];
+  this.type = this.type ? this.type.value : 'data';
+
+  this.name = this.node.attributes['name'];
+  this.name = this.name ? this.name.value : 'unknown';
+  this.name = this.name.toLowerCase();
+
+  this.context = this.node.attributes['context'];
+  this.context = this.context ? this.context.value : null;
+
+  this.content = "";
+
+  for (var i=0; i < this.node.childNodes.length; i++) {
+    var childNode = this.node.childNodes[i];
+    // console.log(childNode.nodeType + " " + childNode.nodeValue);
+    var token_type = this.node.attributes['type'] ? this.node.attributes['type'].nodeValue : 'data';
+    // console.log(this.name + " " + token_type);
+
+    if (childNode.nodeType == 3) {
+      // text should just be added to the label
+      // <tml:label>You have <tml:token type="data" name="count" context="number">2</tml:token> messages.</tml:label>    
+      
+      if (node.attributes['context'] && node.attributes['context'].nodeValue == 'gender') {
+        tokens[this.name] = {subject: node.attributes['value'].nodeValue, value: Tr8n.Utils.trim(childNode.nodeValue)};
+      } else {
+        tokens[this.name] = Tr8n.Utils.trim(childNode.nodeValue);
+      }
+
+    } else {
+      // the first element inside the token must be a decoration span, bold, etc...
+      // <tml:label>Hello 
+      //   <tml:token type="decoration" name="span">
+      //     <span style='color:brown;font-weight:bold;'>
+      //       World
+      //     </span>
+      //   </tml:token> 
+      // </tml:label>
+
+      var html_tag = childNode.nodeName.toLowerCase();
+      var attributes = [];
+      if (childNode.attributes['style']) {
+        attributes.push("style='" + childNode.attributes['style'].nodeValue + "'");
+      }
+      if (childNode.attributes['class']) {
+        attributes.push("class='" + childNode.attributes['class'].nodeValue + "'");
+      }
+
+      tokens[this.name] = "<" + html_tag + " " + attributes.join(' ') + ">{$0}</" + html_tag + ">";
+
+      // console.log(this.name + " has value of " + tokens[this.name]);
+
+      this.content = "";
+
+      for (var j=0; j<childNode.childNodes.length; j++) {
+        var grandChildNode = childNode.childNodes[j];
+        if (grandChildNode.nodeType == 3) {
+          this.content = Tr8n.Utils.trim(this.content) + " " + Tr8n.Utils.trim(grandChildNode.nodeValue);
+        } else if (grandChildNode.nodeName == "TML:TOKEN") {
+          var token = new Tr8n.Tml.Token(grandChildNode, tokens);
+          this.content = Tr8n.Utils.trim(this.content) + " " + token.toTokenString();
+        }    
+      }
+    }
+  }
+
+  this.content = this.content.replace(/\n/g, '');
+  this.content = Tr8n.Utils.trim(this.content);
+}
+
+Tr8n.Tml.Token.prototype = {
+  toTokenString: function() {
+    if (this.type == "data") {
+      // TODO: we may need to add dependencies here: gender, number and language cases
+      return "{" + this.name + "}";
+    } else {
+      return "[" + this.name + ": " + this.content + "]";
+    }
+  }
+}

data/app/javascript/src/tokens/data_token.js

@@ -0,0 +1,45 @@
+/****************************************************************************
+  Copyright (c) 2010-2012 Michael Berkovich, Ian McDaniel, tr8n.net
+
+  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.
+****************************************************************************/
+
+Tr8n.Proxy.DataToken = function(label, token, options) {
+  this.label = label;
+  this.full_name = token;
+  this.options = options;
+}
+
+Tr8n.Proxy.DataToken.prototype = new Tr8n.Proxy.Token();
+
+Tr8n.Proxy.DataToken.parse = function(label, options) {
+  var tokens = label.match(/(\{[^_][\w]+(:[\w]+)?\})/g);
+  if (!tokens) return [];
+  
+  var objects = [];
+  var uniq = {};
+  for(i=0; i<tokens.length; i++) {
+    if (uniq[tokens[i]]) continue;
+    options['proxy'].debug("Registering data token: " + tokens[i]);
+    objects.push(new Tr8n.Proxy.DataToken(label, tokens[i], options));
+    uniq[tokens[i]] = true;
+  }
+  return objects;
+}

data/app/javascript/src/tokens/decoration_token.js

@@ -0,0 +1,82 @@
+/****************************************************************************
+  Copyright (c) 2010-2012 Michael Berkovich, Ian McDaniel, tr8n.net
+
+  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.
+****************************************************************************/
+
+Tr8n.Proxy.DecorationToken = function(label, token, options) {
+  this.label = label;
+  this.full_name = token;
+  this.options = options;
+}
+
+Tr8n.Proxy.DecorationToken.prototype = new Tr8n.Proxy.Token();
+
+Tr8n.Proxy.DecorationToken.parse = function(label, options) {
+  var tokens = label.match(/(\[\w+:[^\]]+\])/g);
+  if (!tokens) return [];
+  
+  var objects = [];
+  var uniq = {};
+  for(i=0; i<tokens.length; i++) {
+    if (uniq[tokens[i]]) continue;
+    options['proxy'].debug("Registering decoration token: " + tokens[i]);
+    objects.push(new Tr8n.Proxy.DecorationToken(label, tokens[i], options));
+    uniq[tokens[i]] = true;
+  }
+  return objects;
+}
+
+Tr8n.Proxy.DecorationToken.prototype.getDecoratedValue = function() {
+  if (!this.decorated_value) {
+    var value = this.getFullName().replace(/[\]]/g, '');
+    value = value.substring(value.indexOf(':') + 1, value.length);
+    this.decorated_value = Tr8n.Utils.trim(value);
+  }
+  return this.decorated_value;
+}
+
+Tr8n.Proxy.DecorationToken.prototype.substitute = function(label, token_values) {
+  var object = token_values[this.getName()];
+  var decoration = object;
+  
+  if (!object || typeof object == 'object') {
+    // look for the default decoration
+    decoration = this.getProxy().getDecorationFor(this.getName());
+    if (!decoration) {
+      this.getLogger().error("Default decoration is not defined for token " + this.getName());
+      return label;
+    }
+    
+    decoration = Tr8n.Utils.replaceAll(decoration, '{$0}', this.getDecoratedValue());
+    if (object) {
+      for (var key in object) {
+        decoration = Tr8n.Utils.replaceAll(decoration, '{$' + key + '}', object[key]);
+      }
+    }
+  } else if (typeof object == 'string') {
+    decoration = Tr8n.Utils.replaceAll(decoration, '{$0}', this.getDecoratedValue());
+  } else {
+    this.getLogger().error("Unknown type of decoration token " + this.getFullName());
+    return label;
+  }
+  
+  return Tr8n.Utils.replaceAll(label, this.getFullName(), decoration);
+}

data/app/javascript/src/tokens/token.js

@@ -0,0 +1,121 @@
+/****************************************************************************
+  Copyright (c) 2010-2012 Michael Berkovich, Ian McDaniel, tr8n.net
+
+  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.
+****************************************************************************/
+
+Tr8n.Proxy.Token = function() {}
+
+Tr8n.Proxy.Token.prototype = {
+  getProxy: function() {
+    return this.options['proxy'];
+  },
+  getLogger: function() {
+    return this.getProxy().logger;
+  },
+  getExpression: function() {
+    // must be implemented by the extending class
+    return null;
+  },
+  register: function(label, options) {
+    if (this.getExpression() == null)
+      alert("Token expression must be provided");
+      
+    var tokens = label.match(this.getExpression());
+    if (!tokens) return [];
+    
+    var objects = [];
+    var uniq = {};
+    for(i=0; i<tokens.length; i++) {
+      if (uniq[tokens[i]]) continue;
+      options['proxy'].debug("Registering data token: " + tokens[i]);
+      objects.push(new Tr8n.Proxy.TransformToken(label, tokens[i], options)); 
+      uniq[tokens[i]] = true;
+    }
+    return objects;
+  },
+  getFullName: function() {
+    return this.full_name;
+  },
+  getDeclaredName: function() {
+    if (!this.declared_name) {
+      this.declared_name = this.getFullName().replace(/[{}\[\]]/g, '');
+    }
+    return this.declared_name;
+  },
+  getName: function() {
+    if (!this.name) {
+      this.name = Tr8n.Utils.trim(this.getDeclaredName().split(':')[0]); 
+    }
+    return this.name;
+  },
+  getLanguageRule: function() {
+    
+    return null;
+  },
+  substitute: function(label, token_values) {
+    var value = token_values[this.getName()];
+    
+    if (value == null) {
+      this.getLogger().error("Value for token: " + this.getFullName() + " was not provided");
+      return label;
+    }
+
+    return Tr8n.Utils.replaceAll(label, this.getFullName(), this.getTokenValue(value)); 
+  },
+  getTokenValue: function(token_value) {
+    if (typeof token_value == 'string') return token_value;
+    if (typeof token_value == 'number') return token_value;
+    return token_value['value'];
+  },
+  getTokenObject: function(token_value) {
+    if (typeof token_value == 'string') return token_value;
+    if (typeof token_value == 'number') return token_value;
+    return token_value['subject'];
+  },
+  getType: function() {
+    if (this.getDeclaredName().indexOf(':') == -1)
+      return null;
+    
+    if (!this.type) {
+      this.type = this.getDeclaredName().split('|')[0].split(':');
+      this.type = this.type[this.type.length - 1];
+    }
+    
+    return this.type;     
+  },
+  getSuffix: function() {
+    if (!this.suffix) {
+      this.suffix = this.getName().split('_');
+      this.suffix = this.suffix[this.suffix.length - 1];
+    }
+    return this.suffix;
+  },
+  getLanguageRule: function() {
+    if (!this.language_rule) {
+      if (this.getType()) {
+        this.language_rule = this.getProxy().getLanguageRuleForType(this.getType()); 
+      } else {
+        this.language_rule = this.getProxy().getLanguageRuleForTokenSuffix(this.getSuffix());
+      }
+    }
+    return this.language_rule;
+  }
+}