chowdown/dist/query/regex.js

A JavaScript library that allows for the quick transformation of DOM documents into useful formats.

"use strict";

function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }

function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }

function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }

function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }

function _get(target, property, receiver) { if (typeof Reflect !== "undefined" && Reflect.get) { _get = Reflect.get; } else { _get = function _get(target, property, receiver) { var base = _superPropBase(target, property); if (!base) return; var desc = Object.getOwnPropertyDescriptor(base, property); if (desc.get) { return desc.get.call(receiver); } return desc.value; }; } return _get(target, property, receiver || target); }

function _superPropBase(object, property) { while (!Object.prototype.hasOwnProperty.call(object, property)) { object = _getPrototypeOf(object); if (object === null) break; } return object; }

function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }

function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }

function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }

var Query = require('./');
/**
 * When executed, this query will return a promise resolving to
 * a regex match on a string retrieved from a given document.
 *
 * @class RegexQuery
 * @extends Query
 */


var RegexQuery =
/*#__PURE__*/
function (_Query) {
  _inherits(RegexQuery, _Query);

  /**
   * Constructs a RegexQuery given a selector for the string in a document,
   * the regular expression pattern to match on and a regular expression
   * group to choose from the match.
   * 
   * Also takes an object of additional configuration options.
   * 
   * @param  {string} selector                      The selector for the string in a document.
   * @param  {RegExp} pattern                       The regular expression pattern to match on.
   * @param  {number} [group]                       The matched regex group to return.
   * @param  {object} [options]                     An object of additional configuration options.
   * @param  {string|string[]} [options.default=[]] The default value this query will resolve to if no string is found.
   */
  function RegexQuery(selector, pattern, group) {
    var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};

    _classCallCheck(this, RegexQuery);

    options.pattern = pattern;
    options.group = group;
    return _possibleConstructorReturn(this, _getPrototypeOf(RegexQuery).call(this, selector, options));
  }
  /**
   * Configures the RegexQuery given an object of configuration options.
   * By default, the the default value for this query will be an empty
   * array (no matches).
   * 
   * @param  {object} options                       An object of configuration options.
   * @param  {number} [options.group]               The matched regex group to return.
   * @param  {string|string[]} [options.default=[]] The default value this query will resolve to if no string is found.
   */


  _createClass(RegexQuery, [{
    key: "configure",
    value: function configure(options) {
      _get(_getPrototypeOf(RegexQuery.prototype), "configure", this).call(this, options);

      if (!this.options.hasOwnProperty('default')) this.options["default"] = [];
    }
    /**
     * Finds the string in the given document and does a regex match on it using the
     * query's pattern. It will take the group specified in the options.
     * 
     * @param  {Document} document The document to search for the string in.
     * @return {string|string[]}   The matched group(s).
     */

  }, {
    key: "find",
    value: function find(document) {
      var string = _get(_getPrototypeOf(RegexQuery.prototype), "find", this).call(this, document);

      if (string === undefined) return undefined;
      var matches = string.match(this.options.pattern);
      if (!matches) return undefined;
      if (this.options.group !== undefined) return matches[this.options.group];
      return matches;
    }
  }]);

  return RegexQuery;
}(Query);

module.exports = RegexQuery;