utils.test.js

var chai    = require('chai')
  , spies   = require('chai-spies')
  , expect  = chai.expect
  , Utils   = require(__dirname + '/../lib/utils')
  , Support = require(__dirname + '/support')

chai.use(spies)
chai.config.includeStack = true

describe(Support.getTestDialectTeaser("Utils"), function() {
  describe('removeCommentsFromFunctionString', function() {
    it("removes line comments at the start of a line", function(done) {
      var functionWithLineComments = function() {
        // noot noot
      }

      var string = functionWithLineComments.toString()
        , result = Utils.removeCommentsFromFunctionString(string)

      expect(result).not.to.match(/.*noot.*/)
      done()
    })

    it("removes lines comments in the middle of a line", function(done) {
      var functionWithLineComments = function() {
        alert(1) // noot noot
      }

      var string = functionWithLineComments.toString()
        , result = Utils.removeCommentsFromFunctionString(string)

      expect(result).not.to.match(/.*noot.*/)
      done()
    })

    it("removes range comments", function(done) {
      var s = function() {
        alert(1) /*
          noot noot
        */
        alert(2) /*
          foo
        */
      }.toString()

      var result = Utils.removeCommentsFromFunctionString(s)

      expect(result).not.to.match(/.*noot.*/)
      expect(result).not.to.match(/.*foo.*/)
      expect(result).to.match(/.*alert\(2\).*/)
      done()
    })
  })

  describe('argsArePrimaryKeys', function() {
    it("doesn't detect primary keys if primareyKeys and values have different lengths", function(done) {
      expect(Utils.argsArePrimaryKeys([1,2,3], [1])).to.be.false
      done()
    })

    it("doesn't detect primary keys if primary keys are hashes or arrays", function(done) {
      expect(Utils.argsArePrimaryKeys([[]], [1])).to.be.false
      done()
    })

    it('detects primary keys if length is correct and data types are matching', function(done) {
      expect(Utils.argsArePrimaryKeys([1,2,3], ["INTEGER", "INTEGER", "INTEGER"])).to.be.true
      done()
    })

    it("detects primary keys if primary keys are dates and lengths are matching", function(done) {
      expect(Utils.argsArePrimaryKeys([new Date()], ['foo'])).to.be.true
      done()
    })
  })

  describe('underscore', function() {
    describe('underscoredIf', function() {
      it('is defined', function(done) {
        expect(Utils._.underscoredIf).to.be.ok
        done()
      })

      it('underscores if second param is true', function(done) {
        expect(Utils._.underscoredIf('fooBar', true)).to.equal('foo_bar')
        done()
      })

      it("doesn't underscore if second param is false", function(done) {
        expect(Utils._.underscoredIf('fooBar', false)).to.equal('fooBar')
        done()
      })
    })

    describe('camelizeIf', function() {
      it('is defined', function(done) {
        expect(Utils._.camelizeIf).to.be.ok
        done()
      })

      it('camelizes if second param is true', function(done) {
        expect(Utils._.camelizeIf('foo_bar', true)).to.equal('fooBar')
        done()
      })

      it("doesn't camelize if second param is false", function(done) {
        expect(Utils._.underscoredIf('fooBar', true)).to.equal('foo_bar')
        done()
      })
    })
  })

  describe('isHash', function() {
    it('doesn\'t match arrays', function(done) {
      expect(Utils.isHash([])).to.be.false
      done()
    })

    it('doesn\'t match null', function(done) {
      expect(Utils.isHash(null)).to.be.false
      done()
    })

    it('matches plain objects', function(done) {
      var values = {
        'name': {
          'first': 'Foo',
          'last': 'Bar'
        }
      }

      expect(Utils.isHash(values)).to.be.true
      done()
    })

    it('matches plain objects with length property/key', function(done) {
      var values = {
        'name': {
          'first': 'Foo',
          'last': 'Bar'
        },
        'length': 1
      }

      expect(Utils.isHash(values)).to.be.true
      done()
    })
  })

  describe('format', function() {
    it('should format where clause correctly when the value is truthy', function(done) {
      var where = ['foo = ?', 1]
      expect(Utils.format(where)).to.equal('foo = 1')
      done()
    })

    it('should format where clause correctly when the value is false', function(done) {
      var where = ['foo = ?', 0]
      expect(Utils.format(where)).to.equal('foo = 0')
      done()
    })
  })

  describe('validateParameter', function() {
    describe('method signature', function() {
      it('throws an error if the value is not defined', function() {
        expect(function() {
          Utils.validateParameter()
        }).to.throw('No value has been passed.')
      })

      it('does not throw an error if the value is not defined and the parameter is optional', function() {
        expect(function() {
          Utils.validateParameter(undefined, Object, { optional: true })
        }).to.not.throw()
      })

      it('throws an error if the expectation is not defined', function() {
        expect(function() {
          Utils.validateParameter(1)
        }).to.throw('No expectation has been passed.')
      })
    })

    describe('expectation', function() {
      it('uses the typeof method if the expectation is a string', function() {
        expect(Utils.validateParameter(1, 'number')).to.be.true
      })

      it('uses the instanceof method if the expectation is a class', function() {
        expect(Utils.validateParameter(new Number(1), Number)).to.be.true
      })
    })

    describe('failing expectations', function() {
      it('throws an error if the expectation does not match', function() {
        expect(function() {
          Utils.validateParameter(1, String)
        }).to.throw(/The parameter.*is no.*/)
      })

      it('does not throw an error if throwError is false', function() {
        expect(Utils.validateParameter(1, String, { throwError: false })).to.be.false
      })
    })

    describe('deprecation warning', function() {
      it('uses the passed function', function() {
        var spy = chai.spy(function(s){})
        Utils.validateParameter([], Object, {
          deprecated: Array,
          onDeprecated: spy
        })
        expect(spy).to.have.been.called()
      })
    })
  })
})