Merge pull request #39 from doug-martin/master

v0.3.1

Author: doug-martin

Gruntfile.js

@@ -4,8 +4,13 @@ module.exports = function (grunt) {
     grunt.initConfig({
         pkg: grunt.file.readJSON('package.json'),
 
+        exec: {
+            removeDocs: "rm -rf docs/*",
+            createDocs: 'coddoc -f multi-html -d ./lib --dir ./docs'
+        },
+
         jshint: {
-            file: "./lib/index.js",
+            file: "./lib/*.js",
             options: {
                 jshintrc: '.jshintrc'
             }
@@ -19,12 +24,13 @@ module.exports = function (grunt) {
                     reporter: 'spec'
                 }
             }
-        },
+        }
     });
 
     // Default task.
-    grunt.registerTask('default', ['jshint', 'it']);
+    grunt.registerTask('default', ['jshint', 'it', "exec"]);
     grunt.loadNpmTasks('grunt-it');
     grunt.loadNpmTasks('grunt-contrib-jshint');
+    grunt.loadNpmTasks('grunt-exec');
 
 };

History.md

@@ -1,3 +1,9 @@
+# v0.3.1
+
+* Added transform support to formatters
+   * When using `createWriteStream` you can now you the `transform` method to specify a row transformer.
+   * When using other transform methods you can specify a `transform` option.
+
 # v0.3.0
 
 * You can now specify `objectMode` when parsing a csv which will cause `data` events to have an object emitted.

Makefile

@@ -212,7 +212,9 @@ csv
 
 `fast-csv` also allows to you to create create a `CSV` from data.
 
-Formatting accepts the same options as parsing.
+Formatting accepts the same options as parsing with an additional `transform` option.
+
+* `transform(row)`: A function that accepts a row and returns a transformed one to be written.
 
 **`createWriteStream(options)`**
 
@@ -235,6 +237,32 @@ csvStream.write({a: "a3", b: "b4"});
 csvStream.write(null);
 ```
 
+If you wish to transform rows as writing then you can use the `.transform` method.
+
+```javascript
+var csvStream = csv
+    .createWriteStream({headers: true})
+    .transform(function(row){
+        return {
+           A: row.a,
+           B: row.b
+        };
+    }),
+    writableStream = fs.createWriteStream("my.csv");
+
+writableStream.on("finish", function(){
+  console.log("DONE!");
+});
+
+csvSream.pipe(writableStream);
+csvStream.write({a: "a0", b: "b0"});
+csvStream.write({a: "a1", b: "b1"});
+csvStream.write({a: "a2", b: "b2"});
+csvStream.write({a: "a3", b: "b4"});
+csvStream.write({a: "a3", b: "b4"});
+csvStream.write(null);
+```
+
 **Writing Data**
 
 Each of the following methods accept an array of values to be written, however each value must be an `array` of `array`s or `object`s.
@@ -264,6 +292,26 @@ csv
    .pipe(ws);
 ```
 
+```javascript
+var ws = fs.createWriteStream("my.csv");
+csv
+   .write([
+       {a: "a1", b: "b1"},
+       {a: "a2", b: "b2"}
+   ], {
+        headers: true
+        transform: function(row){
+            return {
+                A: row.a,
+                B: row.b
+            };
+        }
+   })
+   .pipe(ws);
+```
+
+
+
 **`writeToStream(stream,arr[, options])`**
 
 Write an array of values to a `WritableStream`
@@ -286,6 +334,23 @@ csv
    .pipe(ws);
 ```
 
+```javascript
+csv
+   .writeToStream(fs.createWriteStream("my.csv"), [
+       {a: "a1", b: "b1"},
+       {a: "a2", b: "b2"}
+   ], {
+        headers: true,
+        transform: function(row){
+            return {
+                A: row.a,
+                B: row.b
+            };
+        }
+   })
+   .pipe(ws);
+```
+
 **`writeToPath(arr[, options])`**
 
 Write an array of values to the specified path
@@ -313,6 +378,25 @@ csv
    });
 ```
 
+```javascript
+csv
+   .writeToStream("my.csv", [
+       {a: "a1", b: "b1"},
+       {a: "a2", b: "b2"}
+   ], {
+        headers: true,
+        transform: function(row){
+            return {
+                A: row.a,
+                B: row.b
+            };
+        }
+   })
+   .on("finish", function(){
+      console.log("done!");
+   });
+```
+
 **`writeToString(arr[, options])`**
 
 ```javascript
@@ -330,6 +414,21 @@ csv.writeToString([
 ], {headers: true}); //"a,b\na1,b1\na2,b2\n"
 ```
 
+```javascript
+csv.writeToString([
+   {a: "a1", b: "b1"},
+   {a: "a2", b: "b2"}
+], {
+        headers: true,
+        transform: function(row){
+            return {
+                A: row.a,
+                B: row.b
+            };
+        }
+   }); //"a,b\na1,b1\na2,b2\n"
+```
+
 ## Piping from Parser to Writer
 
 You can use `fast-csv` to pipe the output from a parsed CSV to a transformed CSV by setting the parser to `objectMode` and using `createWriteStream`.
@@ -361,6 +460,27 @@ csv
 
 The output will contain formatted result from the transform function.
 
+If you want to tranform on the formatting side
+
+
+```javascript
+var formatStream = csv
+        .createWriteStream({headers: true})
+        .transform(function(){
+            return {
+                name: obj.Name,
+                address: obj.Address,
+                emailAddress: obj.Email_Address,
+                verified: obj.Verified
+            };
+        });  
+csv
+   .fromPath("in.csv", {headers: true})
+   .pipe(formatStream)
+   .pipe(fs.createWriteStream("out.csv", {encoding: "utf8"}));
+```
+
+
 ## Benchmarks
 
 `Parsing 20000 records AVG over 3 runs`

README.md

@@ -176,6 +176,14 @@
 
 
 
+<h1>v0.3.1</h1>
+<ul>
+<li>Added transform support to formatters<ul>
+<li>When using <code>createWriteStream</code> you can now you the <code>transform</code> method to specify a row transformer.</li>
+<li>When using other transform methods you can specify a <code>transform</code> option.</li>
+</ul>
+</li>
+</ul>
 <h1>v0.3.0</h1>
 <ul>
 <li>You can now specify <code>objectMode</code> when parsing a csv which will cause <code>data</code> events to have an object emitted.</li>