Changeset 7502

Timestamp:

03/01/07 11:53:01 (21 months ago)

Author:

peller

Message:

Fixes #2350. Mike - this is a compromise. I added compound paths and whacked the polymorphic/varargs thing. ${} in favor of %{}, but formatting would have to be a separate pass prior to calling this method. Sound reasonable?

Location:

trunk

Files:

• src/string/extras.js (modified) (2 diffs)
• tests/i18n/nls/es/salutations.js (modified) (1 diff)
• tests/i18n/nls/salutations.js (modified) (1 diff)

trunk/src/string/extras.js

@@ -5 +5 @@
 dojo.require("dojo.lang.array");
 
-//TODO: should we use ${} substitution syntax instead, like widgets do?
-dojo.string.substituteParams = function(/*string*/template, /* object - optional or ... */hash){
+dojo.string.substitute = function(/*String*/template, /*Object or Array*/map, /*Object?*/thisObject){
 // summary:
 //      Performs parameterized substitutions on a string. Throws an exception if any parameter is unmatched.
@@ -12 +11 @@
 // description:
 //      For example,
-//              dojo.string.substituteParams("File '%{0}' is not found in directory '%{1}'.","foo.html","/temp");
-//      returns
+//              dojo.string.substituteParams("File '${0}' is not found in directory '${1}'.",["foo.html","/temp"]);
+//              dojo.string.substituteParams("File '${name}' is not found in directory '${info.dir}'.",{name: "foo.html", info: {dir: "/temp"}});
+//      both return
 //              "File 'foo.html' is not found in directory '/temp'."
 //
-// template: the original string template with %{values} to be replaced
-// hash: name/value pairs (type object) to provide substitutions.  Alternatively, substitutions may be
-//      included as arguments 1..n to this function, corresponding to template parameters 0..n-1
-
-        var map = (typeof hash == 'object') ? hash : dojo.lang.toArray(arguments, 1);
-
-        return template.replace(/\%\{(\w+)\}/g, function(match, key){
-                if(typeof(map[key]) != "undefined" && map[key] != null){
-                        return map[key];
-                }
-                dojo.raise("Substitution not found: " + key);
+// template: a string with expressions in the form ${key} to be replaced or ${key:format} which specifies a format function.  NOTE syntax has changed from %{key}
+// map: where to look for substitutions
+// thisObject: where to look for optional format function
+
+        return template.replace(/\$\{([^\s\:]+)(?:\:(\S+))?\}/g, function(match, key, format){
+                var value = dojo.getObject(key,false,map);
+                if(typeof(value) == "undefined"){
+                        dojo.raise("Missing key: " + key);
+                }
+                return format ? dojo.getObject(format,false,thisObject)(value) : value;
         }); // string
 };

trunk/tests/i18n/nls/es/salutations.js

@@ -2 +2 @@
  es: "Español",
  hello: "Hola",
- hello_dojo: "¡%{hello}, %{dojo}!"
+ hello_dojo: "¡${hello}, ${dojo}!"
 }

trunk/tests/i18n/nls/salutations.js

@@ -28 +28 @@
  hello: "Hello",
  dojo: "Dojo",
- hello_dojo: "%{hello}, %{dojo}!",
- file_not_found:"The file you requested, %{0}, is not found."
+ hello_dojo: "${hello}, ${dojo}!",
+ file_not_found:"The file you requested, ${0}, is not found."
 }