fs2json/spec/lib/traverse.coffee

Translates a filesystem directory structure into a JSON object

traverse = require '../../lib/traverse'
sinon = require 'sinon'
chai = require 'chai'
helpers = require '../helpers'
fixtures = require '../fixtures/fs.json'
q = require 'q'

chai.use require('sinon-chai')
chai.should()

describe 'Traversing a non-existing path', ->
  it 'should emit an `error` event', (done)->
    em = traverse 'make_sure_to_never_add_such_a_folder_name_to_any_of_my_code_in_my_entire_life' #That most certainly does not exist!
    em.on 'error', ->
      done()

  it 'should not emit an `path` event', (done)->
    dfd = q.defer()
    em = traverse 'qwertyuiopasdfghjklzxcvbnm' #That one either...
    em.on 'error', ->
      done()
    em.on 'path', ->
      done('should not have been called')

  # @TODO How to check that the event has NOT been raised, when the only other event is raised prior to it?
  #       Use timeouts ? Seems ugly...
  xit 'should not emit an `end` event', (done)->
    dfd = q.defer()
    em = traverse 'qwertyuiopasdfghjklzxcvbnm' #That one either...
    em.on 'error', ->
      done()
    em.on 'end', ->
      throw 'should not have been called'

describe 'Traversing with a file as root', ->
  it 'should emit a `path` event', (done)->
    path = helpers.fake_fs 'file_as_root'
    em = traverse path
    em.on 'path', ->
      done()
  it 'should send the path and Stat instance with the `path` event', (done)->
    path = helpers.fake_fs 'file_as_root'
    em = traverse path
    em.on 'path', (_path, stat)->
      _path.should.equal path
      # @TODO How to check the Stat file ?
      done()
  it 'should emit a `end` event', (done)->
    path = helpers.fake_fs 'file_as_root'
    em = traverse path
    em.on 'end', ->
      done()
  it 'should emit the `end` event after the `path` event', (done)->
    spy = sinon.spy()
    path = helpers.fake_fs 'file_as_root'
    em = traverse path
    em.on 'path', spy
    em.on 'end', ->
      spy.should.have.been.called
      done()

describe 'Traversing an empty dir', ->
  it 'should emit a `path` event', (done)->
    path = helpers.fake_fs 'empty_dir'
    em = traverse path
    em.on 'path', ->
      done()
  it 'should emit a `end` event', (done)->
    path = helpers.fake_fs 'empty_dir'
    em = traverse path
    em.on 'end', ->
      done()
  it 'should emit the `end` event after the `path` event', (done)->
    spy = sinon.spy()
    path = helpers.fake_fs 'empty_dir'
    em = traverse path
    em.on 'path', spy
    em.on 'end', ->
      spy.should.have.been.called
      done()
describe 'Traversing a dir containing files', ->
  it 'should emit as many `path` events as the number of children', (done)->
    spy = sinon.spy()
    path = helpers.fake_fs 'dir_two_files'
    em = traverse path
    em.on 'path', spy
    em.on 'end', ->
      spy.should.have.been.called.twice
      done()

describe 'Traversing a directory with subdirectories and files', ->
  it 'should emit as many `path` events as the number of children', (done)->
    spy = sinon.spy()
    path = helpers.fake_fs 'depth_2'
    em = traverse path
    em.on 'path', spy
    em.on 'end', ->
      spy.should.have.been.called
      spy.callCount.should.equal 7
      done()