Merge pull request #59 from localmed/friendly-files

Better file handling for reporters (fixes #48 and #57)

Author: Adam Kliment

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dredd",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "API Blueprint testing tool",
   "main": "lib/dredd.js",
   "bin": {
@@ -27,7 +27,8 @@
     "advisable": "~0.2.0",
     "proxyquire": "~0.5.1",
     "coffee-script": "1.6.3",
-    "glob": "~3.2.8"
+    "glob": "~3.2.8",
+    "file": "~0.2.2"
   },
   "devDependencies": {
     "coffee-errors": "~0.8.4",

src/reporters/html-reporter.coffee

@@ -2,6 +2,7 @@
 fs = require 'fs'
 
 marked = require 'marked'
+file = require 'file'
 
 logger = require './../logger'
 prettifyResponse = require './../prettify-response'
@@ -29,10 +30,9 @@ class HtmlReporter extends EventEmitter
     @configureEmitter emitter
 
   sanitizedPath: (path) =>
-    filePath = if path? then process.cwd() + "/" + path else process.cwd() + "/report.html"
+    filePath = if path? then file.path.abspath(path) else file.path.abspath("./report.html")
     if fs.existsSync(filePath)
-      logger.info "File exists at #{filePath}, deleting..."
-      fs.unlinkSync(filePath)
+      logger.info "File exists at #{filePath}, will be overwritten..."
     filePath
 
   configureEmitter: (emitter) =>

src/reporters/markdown-reporter.coffee

@@ -1,6 +1,8 @@
 {EventEmitter} = require 'events'
 fs = require 'fs'
 
+file = require 'file'
+
 logger = require './../logger'
 prettifyResponse = require './../prettify-response'
 
@@ -17,10 +19,9 @@ class MarkdownReporter extends EventEmitter
     @configureEmitter emitter
 
   sanitizedPath: (path) =>
-    filePath = if path? then process.cwd() + "/" + path else process.cwd() + "/report.md"
+    filePath = if path? then file.path.abspath(path) else file.path.abspath("./report.md")
     if fs.existsSync(filePath)
-      logger.info "File exists at #{filePath}, deleting..."
-      fs.unlinkSync(filePath)
+      logger.info "File exists at #{filePath}, will be overwritten..."
     filePath
 
   configureEmitter: (emitter) =>

src/reporters/x-unit-reporter.coffee

@@ -2,6 +2,7 @@
 fs = require 'fs'
 
 htmlencode = require 'htmlencode'
+file = require 'file'
 
 logger = require './../logger'
 prettifyResponse = require './../prettify-response'
@@ -17,10 +18,9 @@ class XUnitReporter extends EventEmitter
     @configureEmitter emitter
 
   sanitizedPath: (path) =>
-    filePath = if path? then process.cwd() + "/" +  path else process.cwd() + "/report.xml"
+    filePath = if path? then file.path.abspath(path) else file.path.abspath("./report.xml")
     if fs.existsSync(filePath)
-      logger.info "File exists at #{filePath}, deleting..."
-      fs.unlinkSync(filePath)
+      logger.info "File exists at #{filePath}, will be overwritten..."
     filePath
 
   configureEmitter: (emitter) =>

test/unit/reporters/html-reporter-test.coffee

@@ -45,14 +45,14 @@ describe 'HtmlReporter', () ->
       before () ->
         sinon.stub fsStub, 'existsSync', (path) ->
           return true
-        sinon.stub fsStub, 'unlinkSync'
+        sinon.stub loggerStub, 'info'
 
       after () ->
         fsStub.existsSync.restore()
-        fsStub.unlinkSync.restore()
+        loggerStub.info.restore()
 
-      it 'should delete the existing file', () ->
-        assert.ok fsStub.unlinkSync.called
+      it 'should inform about the existing file', () ->
+        assert.ok loggerStub.info.called
 
     describe 'when file does not exist', () ->
 
@@ -142,4 +142,3 @@ describe 'HtmlReporter', () ->
       emitter.emit 'test start', test
       emitter.emit 'test error', new Error('Error'), test
       assert.ok ~htmlReporter.buf.indexOf 'Error'
-

test/unit/reporters/markdown-reporter-test.coffee

@@ -46,15 +46,14 @@ describe 'MarkdownReporter', () ->
       before () ->
         sinon.stub fsStub, 'existsSync', (path) ->
           return true
-        sinon.stub fsStub, 'unlinkSync'
+        sinon.stub loggerStub, 'info'
 
       after () ->
         fsStub.existsSync.restore()
-        fsStub.unlinkSync.restore()
+        loggerStub.info.restore()
 
-      it 'should delete the existing file', (done) ->
-        assert.ok fsStub.unlinkSync.calledOnce
-        done()
+      it 'should inform about the existing file', () ->
+        assert.ok loggerStub.info.called
 
     describe 'when file does not exist', () ->
 
@@ -149,5 +148,3 @@ describe 'MarkdownReporter', () ->
     it 'should write error to the buffer', (done) ->
       assert.ok ~mdReporter.buf.indexOf 'Error'
       done()
-
-

test/unit/reporters/x-unit-reporter-test.coffee

@@ -27,16 +27,16 @@ describe 'XUnitReporter', () ->
       before () ->
         sinon.stub fsStub, 'existsSync', (path) ->
           return true
-        sinon.stub fsStub, 'unlinkSync'
+        sinon.stub loggerStub, 'info'
 
       after () ->
         fsStub.existsSync.restore()
-        fsStub.unlinkSync.restore()
+        loggerStub.info.restore()
 
-      it 'should delete the existing file', () ->
+      it 'should inform about the existing file', () ->
         emitter = new EventEmitter()
         xUnitReporter = new XUnitReporter(emitter, {}, {}, "test.xml")
-        assert.ok fsStub.unlinkSync.calledOnce
+        assert.ok loggerStub.info.called
 
     describe 'when file does not exist', () ->