Code coverage report for src/compiler/data.js

Statements: 100% (102 / 102)      Branches: 98.28% (57 / 58)      Functions: 100% (21 / 21)      Lines: 100% (100 / 100)      Ignored: none     

All files » src/compiler/ » data.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    1   1   1                           1 38   38 38 22           38     38 38 8     38       1 41     41 3 3   38 38       41 41 36     41 41     1 41   41 96 8 8 88 54 47 47       41               1     42               1 43 100 7   7           100         1 43 100 11                 100             1 44   101     94       60   94     44       60         1 43 43           1 42 42 41     1 1 1 1       1   61     61   61   61 152 48 48 13 13   35 35     104       61       61 48 48     61 45                     16           1 8 8 8   8                   8 2                   8     1 38 93 4              
'use strict';
 
require('../globals');
 
module.exports = data;
 
var vlEncDef = require('../encdef'),
  util = require('../util'),
  time = require('./time');
 
/**
 * Create Vega's data array from a given encoding.
 *
 * @param  {Encoding} encoding
 * @return {Array} Array of Vega data.
 *                 This always includes a "raw" data table.
 *                 If the encoding contains aggregate value, this will also create
 *                 aggregate table as well.
 */
// FIXME(#514): eliminate stats
function data(encoding, stats) {
  var def = [data.raw(encoding, stats)];
 
  var aggregate = data.aggregate(encoding);
  if (aggregate) {
    def.push(data.aggregate(encoding));
  }
 
  // TODO add "having" filter here
 
  // append non-positive filter at the end for the data table
  data.filterNonPositive(def[def.length - 1], encoding);
 
  // Stack
  var stack = encoding.stack();
  if (stack) {
    def.push(data.stack(encoding, stack));
  }
 
  return def;
}
 
// FIXME(#514): eliminate stats
data.raw = function(encoding, stats) {
  var raw = {name: RAW};
 
  // Data source (url or inline)
  if (encoding.hasValues()) {
    raw.values = encoding.data().values;
    raw.format = {type: 'json'};
  } else {
    raw.url = encoding.data().url;
    raw.format = {type: encoding.data().formatType};
  }
 
  // Set data's format.parse if needed
  var parse = data.raw.formatParse(encoding);
  if (parse) {
    raw.format.parse = parse;
  }
 
  raw.transform = data.raw.transform(encoding, stats);
  return raw;
};
 
data.raw.formatParse = function(encoding) {
  var parse;
 
  encoding.forEach(function(encDef) {
    if (encDef.type == T) {
      parse = parse || {};
      parse[encDef.name] = 'date';
    } else if (encDef.type == Q) {
      if (vlEncDef.isCount(encDef)) return;
      parse = parse || {};
      parse[encDef.name] = 'number';
    }
  });
 
  return parse;
};
 
/**
 * Generate Vega transforms for the raw data table.  This can include
 * transforms for time unit, binning and filtering.
 */
// FIXME(#514): eliminate stats
data.raw.transform = function(encoding, stats) {
  // null filter comes first so transforms are not performed on null values
  // time and bin should come before filter so we can filter by time and bin
  return data.raw.transform.nullFilter(encoding).concat(
    data.raw.transform.formula(encoding),
    data.raw.transform.time(encoding),
    data.raw.transform.bin(encoding, stats),
    data.raw.transform.filter(encoding)
  );
};
 
data.raw.transform.time = function(encoding) {
  return encoding.reduce(function(transform, encDef, encType) {
    if (encDef.type === T && encDef.timeUnit) {
      var fieldRef = encoding.fieldRef(encType, {nofn: true, datum: true});
 
      transform.push({
        type: 'formula',
        field: encoding.fieldRef(encType),
        expr: time.formula(encDef.timeUnit, fieldRef)
      });
    }
    return transform;
  }, []);
};
 
// FIXME(#514): eliminate stats
data.raw.transform.bin = function(encoding, stats) {
  return encoding.reduce(function(transform, encDef, encType) {
    if (encoding.bin(encType)) {
      transform.push({
        type: 'bin',
        field: encDef.name,
        output: {bin: encoding.fieldRef(encType)},
        maxbins: encoding.bin(encType).maxbins,
        min: stats[encDef.name].min,
        max: stats[encDef.name].max
      });
    }
    return transform;
  }, []);
};
 
/**
 * @return {Array} An array that might contain a filter transform for filtering null value based on filterNul config
 */
data.raw.transform.nullFilter = function(encoding) {
  var filteredFields = util.reduce(encoding.fields(),
    function(filteredFields, fieldList, fieldName) {
      if (fieldName === '*') return filteredFields; //count
 
      // TODO(#597) revise how filterNull is structured.
      if ((encoding.config('filterNull').Q && fieldList.containsType[Q]) ||
          (encoding.config('filterNull').T && fieldList.containsType[T]) ||
          (encoding.config('filterNull').O && fieldList.containsType[O]) ||
          (encoding.config('filterNull').N && fieldList.containsType[N])) {
        filteredFields.push(fieldName);
      }
      return filteredFields;
    }, []);
 
  return filteredFields.length > 0 ?
    [{
      type: 'filter',
      test: filteredFields.map(function(fieldName) {
        return 'datum.' + fieldName + '!==null';
      }).join(' && ')
    }] : [];
};
 
data.raw.transform.filter = function(encoding) {
  var filter = encoding.data().filter;
  return filter ? [{
      type: 'filter',
      test: filter
  }] : [];
};
 
data.raw.transform.formula = function(encoding) {
  var formulas = encoding.data().formulas;
  if (formulas === undefined) {
    return [];
  }
 
  return formulas.reduce(function(transform, formula) {
    formula.type = 'formula';
    transform.push(formula);
    return transform;
  }, []);
};
 
data.aggregate = function(encoding) {
  /* dict set for dimensions */
  var dims = {};
 
  /* dictionary mapping field name => dict set of aggregation functions */
  var meas = {};
 
  var hasAggregate = false;
 
  encoding.forEach(function(encDef, encType) {
    if (encDef.aggregate) {
      hasAggregate = true;
      if (encDef.aggregate === 'count') {
        meas['*'] = meas['*'] || {};
        meas['*'].count = true;
      } else {
        meas[encDef.name] = meas[encDef.name] || {};
        meas[encDef.name][encDef.aggregate] = true;
      }
    } else {
      dims[encDef.name] = encoding.fieldRef(encType);
    }
  });
 
  var groupby = util.vals(dims);
 
  // short-format summarize object for Vega's aggregate transform
  // https://github.com/vega/vega/wiki/Data-Transforms#-aggregate
  var summarize = util.reduce(meas, function(summarize, fnDictSet, field) {
    summarize[field] = util.keys(fnDictSet);
    return summarize;
  }, {});
 
  if (hasAggregate) {
    return {
      name: AGGREGATE,
      source: RAW,
      transform: [{
        type: 'aggregate',
        groupby: groupby,
        summarize: summarize
      }]
    };
  }
 
  return null;
};
 
/**
 * Add stacked data source, for feeding the shared scale.
 */
data.stack = function(encoding, stack) {
  var dim = stack.groupby;
  var val = stack.value;
  var facets = encoding.facets();
 
  var stacked = {
    name: STACKED,
    source: encoding.dataTable(),
    transform: [{
      type: 'aggregate',
      groupby: [encoding.fieldRef(dim)].concat(facets), // dim and other facets
      summarize: [{ops: ['sum'], field: encoding.fieldRef(val)}]
    }]
  };
 
  if (facets && facets.length > 0) {
    stacked.transform.push({ //calculate max for each facet
      type: 'aggregate',
      groupby: facets,
      summarize: [{
        ops: ['max'],
        // we want max of sum from above transform
        field: encoding.fieldRef(val, {prefn: 'sum_'})
      }]
    });
  }
  return stacked;
};
 
data.filterNonPositive = function(dataTable, encoding) {
  encoding.forEach(function(encDef, encType) {
    if (encoding.scale(encType).type === 'log') {
      dataTable.transform.push({
        type: 'filter',
        test: encoding.fieldRef(encType, {datum: 1}) + ' > 0'
      });
    }
  });
};