Skip to content

Commit

Permalink
Merge pull request #119 from sethkinast/log-language
Browse files Browse the repository at this point in the history 
Normalize all log messages.
  • Loading branch information
@prashn64
prashn64 committed Mar 25, 2015
2 parents 762806a + 931569e commit da6e6ed
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 44 deletions.
37 changes: 19 additions & 18 deletions lib/dust-helpers.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,17 @@
}(this, function(dust) {

// Use dust's built-in logging when available
var _log = dust.log ? function(msg, level) {
var _log = dust.log ? function(helper, msg, level) {
level = level || "INFO";
dust.log(msg, level);
helper = helper ? '{@' + helper + '}: ' : '';
dust.log(helper + msg, level);
} : function() {};

var _deprecatedCache = {};
function _deprecated(target) {
if(_deprecatedCache[target]) { return; }
_log("Deprecation warning: " + target + " is deprecated and will be removed in a future version of dustjs-helpers", "WARN");
_log("For help and a deprecation timeline, see https://github.com/linkedin/dustjs-helpers/wiki/Deprecated-Features#" + target.replace(/\W+/g, ""), "WARN");
_log(target, "Deprecation warning: " + target + " is deprecated and will be removed in a future version of dustjs-helpers", "WARN");
_log(null, "For help and a deprecation timeline, see https://github.com/linkedin/dustjs-helpers/wiki/Deprecated-Features#" + target.replace(/\W+/g, ""), "WARN");
_deprecatedCache[target] = true;
}

Expand Down Expand Up @@ -91,7 +92,7 @@ function filter(chunk, context, bodies, params, filterOp) {
filterOp = function() { return false; };
}
} else {
_log("No key specified for filter in {@" + filterOpType + "}");
_log(filterOpType, "No key specified", "WARN");
return chunk;
}
expectedValue = dust.helpers.tap(params.value, chunk, context);
Expand Down Expand Up @@ -227,7 +228,7 @@ var helpers = {
dump = JSON.stringify(context.stack.head, jsonFilter, 2);
}
if (to === 'console') {
_log(dump);
_log('contextDump', dump);
return chunk;
}
else {
Expand Down Expand Up @@ -276,7 +277,7 @@ var helpers = {
switch(method) {
case "mod":
if(operand === 0 || operand === -0) {
_log("Division by 0 in {@math} helper", "WARN");
_log("math", "Division by 0", "ERROR");
}
mathOut = key % operand;
break;
Expand All @@ -291,7 +292,7 @@ var helpers = {
break;
case "divide":
if(operand === 0 || operand === -0) {
_log("Division by 0 in {@math} helper", "WARN");
_log("math", "Division by 0", "ERROR");
}
mathOut = key / operand;
break;
Expand All @@ -311,7 +312,7 @@ var helpers = {
mathOut = parseInt(key, 10);
break;
default:
_log("{@math}: method " + method + " not supported");
_log("math", "Method `" + method + "` is not supported", "ERROR");
}

if (mathOut !== null){
Expand All @@ -333,7 +334,7 @@ var helpers = {
}
// no key parameter and no method
else {
_log("Key is a required parameter for math helper along with method/operand!");
_log("math", "`key` or `method` was not provided", "ERROR");
}
return chunk;
},
Expand Down Expand Up @@ -364,10 +365,10 @@ var helpers = {
}
}
} else {
_log("Missing body block in {@select}");
_log("select", "Missing body block", "WARN");
}
} else {
_log("No key provided for {@select}", "WARN");
_log("select", "`key` is required", "ERROR");
}
return chunk;
},
Expand Down Expand Up @@ -478,10 +479,10 @@ var helpers = {
var selectState = getSelectState(context);

if(!selectState) {
_log("{@any} used outside of a {@select} block", "WARN");
_log("any", "Must be used inside a {@select} block", "ERROR");
} else {
if(selectState.isDeferredComplete) {
_log("{@any} nested inside {@any} or {@none} block. It needs its own {@select} block", "WARN");
_log("any", "Must not be nested inside {@any} or {@none} block", "ERROR");
} else {
chunk = chunk.map(function(chunk) {
selectState.deferreds.push(function() {
Expand All @@ -506,10 +507,10 @@ var helpers = {
var selectState = getSelectState(context);

if(!selectState) {
_log("{@none} used outside of a {@select} block", "WARN");
_log("none", "Must be used inside a {@select} block", "ERROR");
} else {
if(selectState.isDeferredComplete) {
_log("{@none} nested inside {@any} or {@none} block. It needs its own {@select} block", "WARN");
_log("none", "Must not be nested inside {@any} or {@none} block", "ERROR");
} else {
chunk = chunk.map(function(chunk) {
selectState.deferreds.push(function() {
Expand All @@ -532,9 +533,9 @@ var helpers = {
"default": function(chunk, context, bodies, params) {
params.filterOpType = "default";
// Deprecated for removal in 1.7
_deprecated("{@default}");
_deprecated("default");
if(!isSelect(context)) {
_log("{@default} used outside of a {@select} block", "WARN");
_log("default", "Must be used inside a {@select} block", "ERROR");
return chunk;
}
return filter(chunk, context, bodies, params, function() { return true; });
Expand Down
56 changes: 34 additions & 22 deletions test/jasmine-test/spec/helpersTests.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
context: {},
expected: "<div>NaN</div>",
message: "testing math/mod helper with zero as operand value",
log: "Division by 0 in {@math} helper"
log: "{@math}: Division by 0"
},
{
name: "math/mod helper with negative zero as operand value",
Expand Down Expand Up @@ -191,7 +191,7 @@
context: {},
expected: "",
message: "math helper blah operation",
log: "{@math}: method blah not supported"
log: "{@math}: Method `blah` is not supported"
},
{
name: "math helper key as zero",
Expand Down Expand Up @@ -254,28 +254,29 @@
source: '<div>{@math key="{y}" method="divide" operand="{y}"/}</div>',
context: { y : null},
expected: "<div>NaN</div>",
message: "testing math/divide helper with null as key and operand value"
message: "testing math/divide helper with null as key and operand value",
},
{
name: "math helper divide with null as operand value",
source: '<div>{@math key="16" method="divide" operand="{y}"/}</div>',
context: { y : null},
expected: "<div>NaN</div>",
message: "testing math/divide helper with null as operand value"
message: "testing math/divide helper with null as operand value",
},
{
name: "math helper divide with null as undefined value",
source: '<div>{@math key="16" method="divide" operand="{y}"/}</div>',
context: { y : undefined},
expected: "<div>NaN</div>",
message: "testing math/divide helper with null as undefined value"
message: "testing math/divide helper with null as undefined value",
},
{
name: "math helper mod with negative 0 as operand",
source: '<div>{@math key="16" method="mod" operand="{y}"/}</div>',
context: { y : -0 },
expected: "<div>NaN</div>",
message: "testing math/mod helper with negative 0 as operand"
message: "testing math/mod helper with negative 0 as operand",
log: "{@math}: Division by 0"
},
{
name: "math helper mod with null as key and operand",
Expand All @@ -296,21 +297,24 @@
source: '<div>{@math key="doh" method="divide" operand="{y}"/}</div>',
context: { y : 0 },
expected: "<div>NaN</div>",
message: "testing math/divide helper using key as non numeric"
message: "testing math/divide helper using key as non numeric",
log: "{@math}: Division by 0"
},
{
name: "math helper divide using 0 for variable",
source: '<div>{@math key="16" method="divide" operand="{y}"/}</div>',
context: { y : 0 },
expected: "<div>Infinity</div>",
message: "testing math/divide helper using 0 for variable as operand"
message: "testing math/divide helper using 0 for variable as operand",
log: "{@math}: Division by 0"
},
{
name: "math helper divide using negative 0 for variable",
source: '<div>{@math key="16" method="divide" operand="{y}"/}</div>',
context: { y : -0 },
expected: "<div>Infinity</div>",
message: "testing math/divide helper using negative 0 for variable as operand"
message: "testing math/divide helper using negative 0 for variable as operand",
log: "{@math}: Division by 0"
},
{
name: "math helper floor numbers",
Expand Down Expand Up @@ -449,7 +453,7 @@
context: {},
expected: "",
message: "eq helper with no params does not execute",
log: "No key specified for filter in {@eq}"
log: "{@eq}: No key specified"
},
{
name: "eq helper with key that resolves to undefined",
Expand Down Expand Up @@ -550,7 +554,8 @@
source: "{@ne}Hello{/ne}",
context: {},
expected: "",
message: "ne helper with no params does not execute"
message: "ne helper with no params does not execute",
log: "{@ne}: No key specified"
},
{
name: "ne helper matching string case",
Expand Down Expand Up @@ -618,7 +623,8 @@
source: "{@lt}Hello{/lt}",
context: {},
expected: "",
message: "lt helper with no params does not execute"
message: "lt helper with no params does not execute",
log: "{@lt}: No key specified"
},
{
name: "lt helper defaults to type number",
Expand Down Expand Up @@ -693,21 +699,24 @@
source: "{@gt}Hello{/gt}",
context: {},
expected: "",
message: "gt helper with no params does not execute"
message: "gt helper with no params does not execute",
log: "{@gt}: No key specified"
},
{
name: "lte helper with no params",
source: "{@lte}Hello{/lte}",
context: {},
expected: "",
message: "lte helper with no params does not execute"
message: "lte helper with no params does not execute",
log: "{@lte}: No key specified"
},
{
name: "gte helper with no params",
source: "{@gte}Hello{/gte}",
context: {},
expected: "",
message: "gte helper with no params does not execute"
message: "gte helper with no params does not execute",
log: "{@gte}: No key specified"
},
{
name: "lte helper with no body",
Expand Down Expand Up @@ -741,7 +750,7 @@
context: {},
expected: "",
message: "select helper with no body is silent",
log: "Missing body block in {@select}"
log: "{@select}: Missing body block"
},
{
name: "select helper with a constant string and condition eq",
Expand Down Expand Up @@ -931,7 +940,7 @@
"{/select}{/b}"].join("\n"),
context: { b : { z: "foo", x: "bar" } },
expected: "",
log: "No key provided for {@select}",
log: "{@select}: `key` is required",
message: "should test select helper with missing key in the context and hence no output"
},
{
Expand Down Expand Up @@ -1039,7 +1048,8 @@
source: '{@any}Hello{/any}',
context: { any: 'abc'},
expected: "",
message: "any helper outside of select does not render"
message: "any helper outside of select does not render",
log: "{@any}: Must be used inside a {@select} block"
},
{
name: "any in select with no cases",
Expand Down Expand Up @@ -1109,7 +1119,8 @@
source: '{@select key=foo}{@eq value="bar"/}{@any}Hello{@any} World{/any}{/any}{/select}',
context: { foo: "bar"},
expected: "Hello",
message: "an any helper cannot be nested inside an any helper without a select"
message: "an any helper cannot be nested inside an any helper without a select",
log: "{@any}: Must not be nested"
},
{
name: "any nested in an any properly with its own select",
Expand All @@ -1135,7 +1146,8 @@
source: '{@none}Hello{/none}',
context: { none: 'abc'},
expected: "",
message: "none helper outside of select does not render"
message: "none helper outside of select does not render",
log: "{@none}: Must be used inside a {@select} block"
},
{
name: "none in select with no cases",
Expand Down Expand Up @@ -1172,7 +1184,6 @@
expected: "Hello World",
message: "a none helper must have its own select to render"
}

]
},
{
Expand Down Expand Up @@ -1464,7 +1475,8 @@
source: "{@contextDump to=\"console\"/}",
context: { "A": 2, "B": 3},
expected: "",
message: "contextDump simple test"
message: "contextDump simple test",
log: '{@contextDump}: {\n "A": 2,\n "B": 3\n}'
},
{
name: "contextDump full test",
Expand Down
9 changes: 5 additions & 4 deletions test/jasmine-test/spec/renderTestSpec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@

function messageInLog(log, message, level) {
var i;
log = log || [];
for(i = 0; i < log.length; i++) {
if(log[i].message === message) {
if(log[i].message.indexOf(message) > -1) {
return (!level || log[i].level === level);
}
}
Expand All @@ -30,7 +31,7 @@
expect(err).toBeNull();
expect(output).toEqual(test.expected);
if(test.log) {
expect(messageInLog(dust.logQueue, test.log)).toEqual(true);
expect(messageInLog(dust.logQueue, test.log, test.logLevel)).toEqual(true);
}
});
}
Expand Down Expand Up @@ -76,7 +77,7 @@
expect(output).toEqual(test.expected);
}
if(test.log) {
expect(messageInLog(dust.logQueue, test.log)).toEqual(true);
expect(messageInLog(dust.logQueue, test.log, test.logLevel)).toEqual(true);
}
});
};
Expand Down Expand Up @@ -119,7 +120,7 @@
expect(output).toEqual(test.expected);
}
if(test.log) {
expect(messageInLog(dust.logQueue, test.log)).toEqual(true);
expect(messageInLog(dust.logQueue, test.log, test.logLevel)).toEqual(true);
}
});
};
Expand Down

0 comments on commit da6e6ed

Please sign in to comment.