index.js

'use strict';

var fs = require('fs');
var url = require('url');
var path = require('path');
var get = require('get-value');
var isObject = require('isobject');
var assign = require('assign-deep');
var toHtml = require('html-tag');
var moment = require('moment');

/**
 * Expose sitemap helpers and templates
 */

var sitemap = module.exports;
var helpers = sitemap.helpers = {};
var templates = path.join.bind(path, __dirname, 'templates');

/**
 * Helpers
 */

helpers._collection = require('helper-collection');

helpers._urlset = function(items, options) {
  if (Array.isArray(items)) {
    return items;
  }
  var items = get(options, 'data.root.items')
    || get(options, 'data.root.sitemap.items')
    || get(options, 'data.root.sitemap.urlset');
  if (!Array.isArray(items)) {
    throw new TypeError('expected sitemap.urlset to be an array');
  }
  return items;
};

helpers._loc = function(item, data, options) {
  if (typeof data.url !== 'string') {
    throw new TypeError('expected url to be a string');
  }
  if (typeof item.relative !== 'string') {
    throw new TypeError('expected item.relative to be a string');
  }

  var rel = destRelative.call(this, item, options);
  var res = url.resolve(data.url, rel);
  return safeString(toHtml('loc', res));
};

helpers._lastmod = function(item, data) {
  var date = data.lastModified || data.lastmod || item.stat && item.stat.mtime;
  var res = moment(date || new Date()).format('YYYY-MM-DD');
  return safeString(toHtml('lastmod', res));
};

helpers._changefreq = function(item, data) {
  return safeString(toHtml('changefreq', String(data.changefreq || 'weekly')));
};

helpers._priority = function(item, data) {
  return safeString(toHtml('priority', String(data.priority || '0.5')));
};

helpers._url = function(item, options) {
  var data = assign({}, globalData(options), itemData(item));
  var text = '\n';
  text += '    ' + helpers._loc.call(this, item, data, options) + '\n';
  text += '    ' + helpers._lastmod.call(this, item, data, options) + '\n';
  text += '    ' + helpers._changefreq.call(this, item, data, options) + '\n';
  text += '    ' + helpers._priority.call(this, item, data, options) + '\n';
  text += '  ';
  return safeString(toHtml('url', text));
};

helpers._filterItems = function(items) {
  return items.filter(function(item) {
    return item.stem !== 'sitemap' && item.data.sitemap !== false;
  });
};

helpers._greaterThan = function(a, b) {
  return a > b;
};

helpers.throw = function(msg) {
  var err = new Error(msg);
  err.path = __filename;
  throw err;
};

/**
 * Templates
 */

Object.defineProperty(sitemap, 'template', {
  set: function() {
    throw new Error('sitemap.template is a getter and cannot be defined');
  },
  get: function() {
    return fs.readFileSync(templates('template.hbs'));
  }
});

Object.defineProperty(sitemap, 'layout', {
  set: function() {
    throw new Error('sitemap.layout is a getter and cannot be defined');
  },
  get: function() {
    return fs.readFileSync(templates('layout.hbs'));
  }
});

Object.defineProperty(sitemap, 'partial', {
  set: function() {
    throw new Error('sitemap.partial is a getter and cannot be defined');
  },
  get: function() {
    return fs.readFileSync(templates('partial.hbs'));
  }
});

Object.defineProperty(sitemap, 'page', {
  set: function() {
    throw new Error('sitemap.page is a getter and cannot be defined');
  },
  get: function() {
    return fs.readFileSync(templates('page.hbs'));
  }
});

/**
 * Utils
 */

function destRelative(item, options) {
  if (typeof item.relative !== 'string') {
    throw new TypeError('expected item.relative to be a string');
  }

  var context = this || options.data.root;
  var dest = get(context, 'app.options.dest');
  var dataDest = get(item, 'data.dest');
  var folder = '';

  if (dest && dataDest) {
    folder = path.relative(dest, dataDest);
  }
  return path.join(folder, item.relative);
}

function globalData(options) {
  var sitemap = get(options, 'data.root.sitemap');
  var data = get(options, 'data.root');
  return assign({}, data, sitemap);
}

function itemData(item) {
  var sitemap = get(item, 'data.sitemap');
  return assign({}, item.data, sitemap);
}

function safeString(str) {
  function SafeString(string) {
    this.string = string;
  }
  SafeString.prototype.toString = SafeString.prototype.toHTML = function() {
    return '' + this.string;
  };
  return new SafeString(str);
}