Code coverage report for lib/extract.js

Statements: 100% (80 / 80)      Branches: 100% (52 / 52)      Functions: 100% (8 / 8)      Lines: 100% (80 / 80)      Ignored: none     

All files » lib/ » extract.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    1       1 13   13   13   13   13   13   13 13 13   13   13     13             13             13 13 22           13 13   13     1     13 13 26       13 13 26     13   89 89     89 37 15       89     37 74 3   1 2   1           37 74 3   1 2   1           89 15   74     13 13 13 15     13     1   13   13 89 37 37 1       37 1 1 2 2 1         37 20 7         89     13 13       1 52 2   50     1 22    
'use strict';
 
var htmlparser = require('htmlparser2'),
  crypto = require('crypto'),
  s18n = require('../');
 
module.exports = function(html, options) {
  options = options || {};
  // localize the contents of all of the following elements
  options.elements = arrayify(options.elements) || ['title', 'p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
  // localize the contents of all of the following attributes
  options.attributes = arrayify(options.attributes) || ['alt', 'title'];
  // localize the contents of all elements with the following attributes
  options.directives = arrayify(options.directives) || ['s18n', 'translate=yes'];
  // do not localize the contents of all elements with the following attributes
  options.cancelers = arrayify(options.cancelers) || ['cancel-s18n', 'translate=no'];
  // localize the contents of attributes provided to this attribute
  options.attributeSetter = options.attributeSetter || 's18n-attrs';
  // do not localize the contents of attributes provided to this attribute
  options.attributeCanceler = options.attributeCanceler || 'cancel-s18n-attrs';
  options.algorithm = options.hashAlgorithm || 'md5';
  options.hashLength = options.hashLength || 8;
 
  var locale = {};
 
  var parser = new htmlparser.Parser(new htmlparser.DomHandler(function(err, dom) {
    // TODO: does this callback need any sort of error handling?
 
    var elementStrings = getElementsContentsToLocalize(
      dom,
      options.elements,
      options.directives,
      options.cancelers
    );
 
    var attributeStrings = getAttributeContentsToLocalize(
      dom,
      options.attributes,
      options.attributeSetter,
      options.attributeCanceler
    );
 
    var strings = elementStrings.concat(attributeStrings);
    for (var j = 0; j < strings.length; j++) {
      locale[hash(strings[j], options.algorithm, options.hashLength)] = strings[j];
    }
  }, {
    normalizeWhitespace: true
  }));
 
  parser.write(html);
  parser.done();
 
  return s18n.formatLocale(locale);
};
 
function getElementsContentsToLocalize(dom, elementsArray, directivesArray, cancelersArray) {
 
  // split directives requiring a certain value, e.g. 'translate=yes'
  var directiveDefs = [];
  for (var i = 0; i < directivesArray.length; i++) {
    directiveDefs[i] = directivesArray[i].split('=');
  }
 
  // split cancelers requiring a certain value, e.g. 'translate=no'
  var cancelerDefs = [];
  for (var j = 0; j < cancelersArray.length; j++) {
    cancelerDefs[j] = cancelersArray[j].split('=');
  }
 
  var filterDom = function(elem) {
    // each dom node must pass without being cancelled
    var passes = false;
    var cancel = false;
 
    // check if dom node is a matching element
    if (htmlparser.DomUtils.isTag(elem)) {
      if (elementsArray.indexOf(elem.name) !== -1) {
        passes = true;
      }
    }
 
    if (elem.attribs) {
 
      // check directives
      for (var k = 0; k < directiveDefs.length; k++) {
        if (elem.attribs.hasOwnProperty(directiveDefs[k][0])) {
          if (directiveDefs[k].length === 1) {
            // has a matching directive
            passes = true;
          } else if (elem.attribs[directiveDefs[k][0]] === directiveDefs[k][1]) {
            // has a matching directive=value combination
            passes = true;
          }
        }
      }
 
      // check cancelers
      for (var m = 0; m < cancelerDefs.length; m++) {
        if (elem.attribs.hasOwnProperty(cancelerDefs[m][0])) {
          if (cancelerDefs[m].length === 1) {
            // has a matching canceler
            cancel = true;
          } else if (elem.attribs[cancelerDefs[m][0]] === cancelerDefs[m][1]) {
            // has a matching canceler=value combination
            cancel = true;
          }
        }
      }
    }
 
    if (passes && !cancel) {
      return true;
    }
    return false;
  };
 
  var elements = htmlparser.DomUtils.filter(filterDom, dom);
  var strings = [];
  for (var n = 0; n < elements.length; n++) {
    strings.push(htmlparser.DomUtils.getInnerHTML(elements[n]));
  }
 
  return strings;
}
 
function getAttributeContentsToLocalize(dom, attributesArray, attributeSetter, attributeCanceler) {
 
  var strings = [];
 
  var filterAttributes = function(elem) {
    if (elem.attribs) {
      var tempAttrsArray = attributesArray;
      if (elem.attribs.hasOwnProperty(attributeSetter)) {
        tempAttrsArray = tempAttrsArray.concat(elem.attribs[attributeSetter].split(' '));
      }
 
      // remove cancelled attributes
      if (elem.attribs.hasOwnProperty(attributeCanceler)) {
        var tempCancArray = elem.attribs[attributeCanceler].split(' ');
        for(var i = 0; i < tempCancArray.length; i++){
          var index = tempAttrsArray.indexOf(tempCancArray[i]);
          if (index > -1){
            tempAttrsArray.splice(index, 1);
          }
        }
      }
 
      for(var attr in elem.attribs){
        if(tempAttrsArray.indexOf(attr) > -1){
          strings.push(elem.attribs[attr]);
        }
      }
 
    }
    return false;
  };
 
  htmlparser.DomUtils.filter(filterAttributes, dom);
  return strings;
}
 
 
function arrayify(unknown) {
  if (typeof unknown === 'string') {
    return [unknown];
  }
  return unknown;
}
 
function hash(str, algorithm, length) {
  return crypto.createHash(algorithm).update(str).digest('hex').slice(0, length);
}