feat: CodeBuilder push and unshift can format strings

thibaultcha · thibaultcha · commit 331e83eb62cf · 2015-03-20T21:30:26.000-07:00
- add an example to CodeBuilder
- convert objc/nsurlsession to not use util.format anymore
diff --git a/src/helpers/code-builder.js b/src/helpers/code-builder.js
@@ -1,5 +1,7 @@
 'use strict'
 
+var util = require('util')
+
 /**
  * Helper object to format and aggragate lines of code.
  * Lines are aggregated in a `code` array, and need to be joined to obtain a proper code snippet.
@@ -16,14 +18,29 @@ var CodeBuilder = function (indentation, join) {
 }
 
 /**
- * Add given indentation level to given string
- * @param {number} [indentationLevel=0] Desired level of indentation for this line
- * @param {string} line Line of code
+ * Add given indentation level to given string and format the string (variadic)
+ * @param {number} [indentationLevel=0] - Desired level of indentation for this line
+ * @param {string} line - Line of code. Can contain formatting placeholders
+ * @param {...anyobject} - Parameter to bind to `line`'s formatting placeholders
  * @return {string}
+ *
+ * @example
+ *   var builder = CodeBuilder('\t')
+ *
+ *   builder.buildLine('console.log("hello world")')
+ *   // returns: 'console.log("hello world")'
+ *
+ *   builder.buildLine(2, 'console.log("hello world")')
+ *   // returns: 'console.log("\t\thello world")'
+ *
+ *   builder.buildLine(2, 'console.log("%s %s")', 'hello', 'world')
+ *   // returns: 'console.log("\t\thello world")'
  */
 CodeBuilder.prototype.buildLine = function (indentationLevel, line) {
   var lineIndentation = ''
+  var slice = 2
   if (Object.prototype.toString.call(indentationLevel) === '[object String]') {
+    slice = 1
     line = indentationLevel
     indentationLevel = 0
   } else if (indentationLevel === null) {
@@ -35,29 +52,32 @@ CodeBuilder.prototype.buildLine = function (indentationLevel, line) {
     indentationLevel--
   }
 
-  return lineIndentation + line
+  var format = Array.prototype.slice.call(arguments, slice, arguments.length)
+  format.unshift(lineIndentation + line)
+
+  return util.format.apply(this, format)
 }
 
 /**
- * Add a line at the top of current lines with given indentation level
+ * Invoke buildLine() and add the line at the top of current lines
  * @param {number} [indentationLevel=0] Desired level of indentation for this line
  * @param {string} line Line of code
  * @return {this}
  */
-CodeBuilder.prototype.unshift = function (indentationLevel, str) {
-  this.code.unshift(this.buildLine(indentationLevel, str))
+CodeBuilder.prototype.unshift = function () {
+  this.code.unshift(this.buildLine.apply(this, arguments))
 
   return this
 }
 
 /**
- * Add a line at the end of current lines with given indentation level
+ * Invoke buildLine() and add the line at the bottom of current lines
  * @param {number} [indentationLevel=0] Desired level of indentation for this line
  * @param {string} line Line of code
  * @return {this}
  */
-CodeBuilder.prototype.push = function (indentationLevel, str) {
-  this.code.push(this.buildLine(indentationLevel, str))
+CodeBuilder.prototype.push = function () {
+  this.code.push(this.buildLine.apply(this, arguments))
 
   return this
 }
diff --git a/src/targets/objc/nsurlsession.js b/src/targets/objc/nsurlsession.js
@@ -46,11 +46,11 @@ module.exports = function (source, options) {
         // we make it easier for the user to edit it according to his or her needs after pasting.
         // The user can just add/remove lines adding/removing body parameters.
         code.blank()
-            .push(util.format('NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"%s=%s" dataUsingEncoding:NSUTF8StringEncoding]];',
-          source.postData.params[0].name, source.postData.params[0].value))
+            .push('NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"%s=%s" dataUsingEncoding:NSUTF8StringEncoding]];',
+          source.postData.params[0].name, source.postData.params[0].value)
         for (var i = 1, len = source.postData.params.length; i < len; i++) {
-          code.push(util.format('[postData appendData:[@"&%s=%s" dataUsingEncoding:NSUTF8StringEncoding]];',
-            source.postData.params[i].name, source.postData.params[i].value))
+          code.push('[postData appendData:[@"&%s=%s" dataUsingEncoding:NSUTF8StringEncoding]];',
+            source.postData.params[i].name, source.postData.params[i].value)
         }
         break
 
@@ -67,7 +67,7 @@ module.exports = function (source, options) {
         // we make it easier for the user to edit it according to his or her needs after pasting.
         // The user can just edit the parameters NSDictionary or put this part of a snippet in a multipart builder method.
         code.push(helpers.nsDeclaration('NSArray', 'parameters', source.postData.params, opts.pretty))
-            .push(util.format('NSString *boundary = @"%s";', source.postData.boundary))
+            .push('NSString *boundary = @"%s";', source.postData.boundary)
             .blank()
             .push('NSError *error;')
             .push('NSMutableString *body = [NSMutableString string];')
