Code coverage report for upstream/lib/dialects/abstract/query.js

Statements: 78.52% (106 / 135)      Branches: 76.62% (59 / 77)      Functions: 69.7% (23 / 33)      Lines: 78.79% (104 / 132)     

All files » upstream/lib/dialects/abstract/ » query.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 3731         1 1         1                       1                 1 2569         2569                                           1 2562   2562 344     2562 673 1889 205 1684                                               1684       2562                 1                   1 605                           1                                         1 2562     2562     2562     2562   2562     1 344   261     261 261   261       1 1889     1 205 390       1 2562     1       1 673     673 393 22   22 74 30       22     393     280 19 19 22                   261 37 20   20       20   20 20   20         224 196         673 92     673     1 1684   1684 1684   1684     1 1684   1684   1684                                                                                 1 51           51 26     51 56 56   56 5 5         56 55     56 265   265   265 33 33   33           51 55 32   55     51     1    
var Utils              = require('../../utils')
  , CustomEventEmitter = require("../../emitters/custom-event-emitter")
  , Dot                = require('dottie')
  , _                  = require('lodash')
 
module.exports = (function() {
  var AbstractQuery = function(database, sequelize, callee, options) {}
 
  /**
    Inherit from CustomEventEmitter
  */
  Utils.inherit(AbstractQuery, CustomEventEmitter)
 
  /**
   * Execute the passed sql query.
   *
   * Examples:
   *
   *     query.run('SELECT 1')
   *
   * @param {String} sql - The SQL query which should be executed.
   * @api public
   */
  AbstractQuery.prototype.run = function(sql) {
    throw new Error("The run method wasn't overwritten!")
  }
 
  /**
   * Check the logging option of the instance and print deprecation warnings.
   *
   * @return {void}
   */
  AbstractQuery.prototype.checkLoggingOption = function() {
    Iif (this.options.logging === true) {
      console.log('DEPRECATION WARNING: The logging-option should be either a function or false. Default: console.log')
      this.options.logging = console.log
    }
 
    Iif (this.options.logging === console.log) {
      // using just console.log will break in node < 0.6
      this.options.logging = function(s) { console.log(s) }
    }
  }
 
  /**
   * High level function that handles the results of a query execution.
   *
   *
   * Example:
   *  query.formatResults([
   *    {
   *      id: 1,              // this is from the main table
   *      attr2: 'snafu',     // this is from the main table
   *      Tasks.id: 1,        // this is from the associated table
   *      Tasks.title: 'task' // this is from the associated table
   *    }
   *  ])
   *
   * @param {Array} data - The result of the query execution.
   */
  AbstractQuery.prototype.formatResults = function(data) {
    var result  = this.callee
 
    if (isInsertQuery.call(this, data)) {
      handleInsertQuery.call(this, data)
    }
 
    if (isSelectQuery.call(this)) {
      result = handleSelectQuery.call(this, data)
    } else if (isShowTableQuery.call(this)) {
      result = handleShowTableQuery.call(this, data)
    } else Iif (isShowOrDescribeQuery.call(this)) {
      result = data
 
      if (this.sql.toLowerCase().indexOf('describe') === 0) {
        result = {}
 
        data.forEach(function(_result) {
          result[_result.Field] = {
            type:         _result.Type.toUpperCase(),
            allowNull:    (_result.Null === 'YES'),
            defaultValue: _result.Default
          }
        })
      } else if (this.sql.toLowerCase().indexOf('show index from') === 0) {
        result = Utils._.uniq(result.map(function(result) {
          return {
            name:       result.Key_name,
            tableName:  result.Table,
            unique:     (result.Non_unique !== 1)
          }
        }), false, function(row) {
          return row.name
        })
      }
    } else Iif (isCallQuery.call(this)) {
      result = data[0]
    }
 
    return result
  }
 
  /**
   * This function is a wrapper for private methods.
   *
   * @param {String} fctName The name of the private method.
   *
   */
  AbstractQuery.prototype.send = function(fctName/*, arg1, arg2, arg3, ...*/) {
    var args = Array.prototype.slice.call(arguments).slice(1)
    return eval(fctName).apply(this, args)
  }
 
  /**
   * Get the attributes of an insert query, which contains the just inserted id.
   *
   * @return {String} The field name.
   */
  AbstractQuery.prototype.getInsertIdField = function() {
    return 'insertId'
  }
 
  /////////////
  // private //
  /////////////
 
  /**
   * Iterate over all known tables and search their names inside the sql query.
   * This method will also check association aliases ('as' option).
   *
   * @param  {String} attribute An attribute of a SQL query. (?)
   * @return {String}           The found tableName / alias.
   */
  var findTableNameInAttribute = function(attribute) {
    if (!this.options.include) {
      return null
    }
    if (!this.options.includeNames) {
      this.options.includeNames = this.options.include.map(function(include) {
        return include.as
      })
    }
 
    var tableNames = this.options.includeNames.filter(function(include) {
      return attribute.indexOf(include + '.') === 0
    })
 
    if (tableNames.length === 1) {
      return tableNames[0]
    } else {
      return null
    }
  }
 
  var isInsertQuery = function(results, metaData) {
    var result = true
 
    // is insert query if sql contains insert into
    result = result && (this.sql.toLowerCase().indexOf('insert into') === 0)
 
    // is insert query if no results are passed or if the result has the inserted id
    result = result && (!results || results.hasOwnProperty(this.getInsertIdField()))
 
    // is insert query if no metadata are passed or if the metadata has the inserted id
    result = result && (!metaData || metaData.hasOwnProperty(this.getInsertIdField()))
 
    return result
  }
 
  var handleInsertQuery = function(results, metaData) {
    if (this.callee) {
      // add the inserted row id to the instance
      var autoIncrementField = this.callee.__factory.autoIncrementField
        , id                 = null
 
      id = id || (results && results[this.getInsertIdField()])
      id = id || (metaData && metaData[this.getInsertIdField()])
 
      this.callee[autoIncrementField] = id
    }
  }
 
  var isShowTableQuery = function() {
    return (this.sql.toLowerCase().indexOf('show tables') === 0)
  }
 
  var handleShowTableQuery = function(results) {
    return Utils._.flatten(results.map(function(resultSet) {
      return Utils._.values(resultSet)
    }))
  }
 
  var isSelectQuery = function() {
    return this.options.type === 'SELECT'
  }
 
  var isUpdateQuery = function() {
    return (this.sql.toLowerCase().indexOf('update') === 0)
  }
 
  var handleSelectQuery = function(results) {
    var result = null
 
    // Raw queries
    if (this.options.raw) {
      result = results.map(function(result) {
        var o = {}
 
        for (var key in result) {
          if (result.hasOwnProperty(key)) {
            o[key] = result[key]
          }
        }
 
        return o
      })
 
      result = result.map(Dot.transform)
 
    // Queries with include
    } else if (this.options.hasJoin === true) {
      results = groupJoinData(results, this.options)
      result = results.map(function(result) {
        return this.callee.build(result, {
          isNewRecord: false,
          isDirty: false,
          include:this.options.include,
          includeNames: this.options.includeNames,
          includeMap: this.options.includeMap,
          includeValidated: true,
          raw: true
        })
      }.bind(this))
    } else if (this.options.hasJoinTableModel === true) {
      result = results.map(function(result) {
        result = Dot.transform(result)
 
        var joinTableData = result[this.options.joinTableModel.name]
          , joinTableDAO = this.options.joinTableModel.build(joinTableData, { isNewRecord: false, isDirty: false })
          , mainDao
 
        delete result[this.options.joinTableModel.name]
 
        mainDao = this.callee.build(result, { isNewRecord: false, isDirty: false })
        mainDao[this.options.joinTableModel.name] = joinTableDAO
 
        return mainDao
      }.bind(this))
 
    // Regular queries
    } else {
      result = results.map(function(result) {
        return this.callee.build(result, { isNewRecord: false, isDirty: false, raw: true })
      }.bind(this))
    }
 
    // return the first real model instance if options.plain is set (e.g. Model.find)
    if (this.options.plain) {
      result = (result.length === 0) ? null : result[0]
    }
 
    return result
  }
 
  var isShowOrDescribeQuery = function() {
    var result = false
 
    result = result || (this.sql.toLowerCase().indexOf('show') === 0)
    result = result || (this.sql.toLowerCase().indexOf('describe') === 0)
 
    return  result
  }
 
  var isCallQuery = function() {
    var result = false
 
    result = result || (this.sql.toLowerCase().indexOf('call') === 0)
 
    return result
  }
 
 
  /**
    The function takes the result of the query execution and groups
    the associated data by the callee.
 
    Example:
      groupJoinData([
        {
          some: 'data',
          id: 1,
          association: { foo: 'bar', id: 1 }
        }, {
          some: 'data',
          id: 1,
          association: { foo: 'bar', id: 2 }
        }, {
          some: 'data',
          id: 1,
          association: { foo: 'bar', id: 3 }
        }
      ])
 
    Result:
      Something like this:
 
      [
        {
          some: 'data',
          id: 1,
          association: [
            { foo: 'bar', id: 1 },
            { foo: 'bar', id: 2 },
            { foo: 'bar', id: 3 }
          ]
        }
      ]
  */
 
  var groupJoinData = function(data, options) {
    var results = []
      , existingResult
      , calleeData
      , child
      , calleeDataIgnore = ['__children']
 
    if (options.includeNames) {
      calleeDataIgnore = calleeDataIgnore.concat(options.includeNames)
    }
 
    data.forEach(function (row) {
      row = Dot.transform(row)
      calleeData = _.omit(row, calleeDataIgnore)
 
      existingResult = _.find(results, function (result) {
        Eif (calleeDataIgnore) {
          return Utils._.isEqual(_.omit(result, calleeDataIgnore), calleeData)
        }
        return Utils._.isEqual(result, calleeData)
      })
 
      if (!existingResult) {
        results.push(existingResult = calleeData)
      }
 
      for (var attrName in row) {
        Eif (row.hasOwnProperty(attrName)) {
          // Child if object, and is an child include
          child = Object(row[attrName]) === row[attrName] && options.includeMap && options.includeMap[attrName]
 
          if (child) {
            if (!existingResult.__children) existingResult.__children = {}
            if (!existingResult.__children[attrName]) existingResult.__children[attrName] = []
 
            existingResult.__children[attrName].push(row[attrName])
          }
        }
      }
    })
    
    results.forEach(function (result) {
      _.each(result.__children, function (children, key) {
        result[key] = groupJoinData(children, (options.includeMap && options.includeMap[key]))
      })
      delete result.__children
    })
 
    return results
  }
 
  return AbstractQuery
})()