traversing.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429
  1. var select = require('css-select'),
  2. utils = require('../utils'),
  3. domEach = utils.domEach,
  4. uniqueSort = require('htmlparser2').DomUtils.uniqueSort,
  5. isTag = utils.isTag,
  6. _ = {
  7. bind: require('lodash.bind'),
  8. forEach: require('lodash.foreach'),
  9. reject: require('lodash.reject'),
  10. filter: require('lodash.filter'),
  11. reduce: require('lodash.reduce')
  12. };
  13. exports.find = function(selectorOrHaystack) {
  14. var elems = _.reduce(this, function(memo, elem) {
  15. return memo.concat(_.filter(elem.children, isTag));
  16. }, []);
  17. var contains = this.constructor.contains;
  18. var haystack;
  19. if (selectorOrHaystack && typeof selectorOrHaystack !== 'string') {
  20. if (selectorOrHaystack.cheerio) {
  21. haystack = selectorOrHaystack.get();
  22. } else {
  23. haystack = [selectorOrHaystack];
  24. }
  25. return this._make(haystack.filter(function(elem) {
  26. var idx, len;
  27. for (idx = 0, len = this.length; idx < len; ++idx) {
  28. if (contains(this[idx], elem)) {
  29. return true;
  30. }
  31. }
  32. }, this));
  33. }
  34. var options = {__proto__: this.options, context: this.toArray()};
  35. return this._make(select(selectorOrHaystack, elems, options));
  36. };
  37. // Get the parent of each element in the current set of matched elements,
  38. // optionally filtered by a selector.
  39. exports.parent = function(selector) {
  40. var set = [];
  41. domEach(this, function(idx, elem) {
  42. var parentElem = elem.parent;
  43. if (parentElem && set.indexOf(parentElem) < 0) {
  44. set.push(parentElem);
  45. }
  46. });
  47. if (arguments.length) {
  48. set = exports.filter.call(set, selector, this);
  49. }
  50. return this._make(set);
  51. };
  52. exports.parents = function(selector) {
  53. var parentNodes = [];
  54. // When multiple DOM elements are in the original set, the resulting set will
  55. // be in *reverse* order of the original elements as well, with duplicates
  56. // removed.
  57. this.get().reverse().forEach(function(elem) {
  58. traverseParents(this, elem.parent, selector, Infinity)
  59. .forEach(function(node) {
  60. if (parentNodes.indexOf(node) === -1) {
  61. parentNodes.push(node);
  62. }
  63. }
  64. );
  65. }, this);
  66. return this._make(parentNodes);
  67. };
  68. exports.parentsUntil = function(selector, filter) {
  69. var parentNodes = [], untilNode, untilNodes;
  70. if (typeof selector === 'string') {
  71. untilNode = select(selector, this.parents().toArray(), this.options)[0];
  72. } else if (selector && selector.cheerio) {
  73. untilNodes = selector.toArray();
  74. } else if (selector) {
  75. untilNode = selector;
  76. }
  77. // When multiple DOM elements are in the original set, the resulting set will
  78. // be in *reverse* order of the original elements as well, with duplicates
  79. // removed.
  80. this.toArray().reverse().forEach(function(elem) {
  81. while ((elem = elem.parent)) {
  82. if ((untilNode && elem !== untilNode) ||
  83. (untilNodes && untilNodes.indexOf(elem) === -1) ||
  84. (!untilNode && !untilNodes)) {
  85. if (isTag(elem) && parentNodes.indexOf(elem) === -1) { parentNodes.push(elem); }
  86. } else {
  87. break;
  88. }
  89. }
  90. }, this);
  91. return this._make(filter ? select(filter, parentNodes, this.options) : parentNodes);
  92. };
  93. // For each element in the set, get the first element that matches the selector
  94. // by testing the element itself and traversing up through its ancestors in the
  95. // DOM tree.
  96. exports.closest = function(selector) {
  97. var set = [];
  98. if (!selector) {
  99. return this._make(set);
  100. }
  101. domEach(this, function(idx, elem) {
  102. var closestElem = traverseParents(this, elem, selector, 1)[0];
  103. // Do not add duplicate elements to the set
  104. if (closestElem && set.indexOf(closestElem) < 0) {
  105. set.push(closestElem);
  106. }
  107. }.bind(this));
  108. return this._make(set);
  109. };
  110. exports.next = function(selector) {
  111. if (!this[0]) { return this; }
  112. var elems = [];
  113. _.forEach(this, function(elem) {
  114. while ((elem = elem.next)) {
  115. if (isTag(elem)) {
  116. elems.push(elem);
  117. return;
  118. }
  119. }
  120. });
  121. return selector ?
  122. exports.filter.call(elems, selector, this) :
  123. this._make(elems);
  124. };
  125. exports.nextAll = function(selector) {
  126. if (!this[0]) { return this; }
  127. var elems = [];
  128. _.forEach(this, function(elem) {
  129. while ((elem = elem.next)) {
  130. if (isTag(elem) && elems.indexOf(elem) === -1) {
  131. elems.push(elem);
  132. }
  133. }
  134. });
  135. return selector ?
  136. exports.filter.call(elems, selector, this) :
  137. this._make(elems);
  138. };
  139. exports.nextUntil = function(selector, filterSelector) {
  140. if (!this[0]) { return this; }
  141. var elems = [], untilNode, untilNodes;
  142. if (typeof selector === 'string') {
  143. untilNode = select(selector, this.nextAll().get(), this.options)[0];
  144. } else if (selector && selector.cheerio) {
  145. untilNodes = selector.get();
  146. } else if (selector) {
  147. untilNode = selector;
  148. }
  149. _.forEach(this, function(elem) {
  150. while ((elem = elem.next)) {
  151. if ((untilNode && elem !== untilNode) ||
  152. (untilNodes && untilNodes.indexOf(elem) === -1) ||
  153. (!untilNode && !untilNodes)) {
  154. if (isTag(elem) && elems.indexOf(elem) === -1) {
  155. elems.push(elem);
  156. }
  157. } else {
  158. break;
  159. }
  160. }
  161. });
  162. return filterSelector ?
  163. exports.filter.call(elems, filterSelector, this) :
  164. this._make(elems);
  165. };
  166. exports.prev = function(selector) {
  167. if (!this[0]) { return this; }
  168. var elems = [];
  169. _.forEach(this, function(elem) {
  170. while ((elem = elem.prev)) {
  171. if (isTag(elem)) {
  172. elems.push(elem);
  173. return;
  174. }
  175. }
  176. });
  177. return selector ?
  178. exports.filter.call(elems, selector, this) :
  179. this._make(elems);
  180. };
  181. exports.prevAll = function(selector) {
  182. if (!this[0]) { return this; }
  183. var elems = [];
  184. _.forEach(this, function(elem) {
  185. while ((elem = elem.prev)) {
  186. if (isTag(elem) && elems.indexOf(elem) === -1) {
  187. elems.push(elem);
  188. }
  189. }
  190. });
  191. return selector ?
  192. exports.filter.call(elems, selector, this) :
  193. this._make(elems);
  194. };
  195. exports.prevUntil = function(selector, filterSelector) {
  196. if (!this[0]) { return this; }
  197. var elems = [], untilNode, untilNodes;
  198. if (typeof selector === 'string') {
  199. untilNode = select(selector, this.prevAll().get(), this.options)[0];
  200. } else if (selector && selector.cheerio) {
  201. untilNodes = selector.get();
  202. } else if (selector) {
  203. untilNode = selector;
  204. }
  205. _.forEach(this, function(elem) {
  206. while ((elem = elem.prev)) {
  207. if ((untilNode && elem !== untilNode) ||
  208. (untilNodes && untilNodes.indexOf(elem) === -1) ||
  209. (!untilNode && !untilNodes)) {
  210. if (isTag(elem) && elems.indexOf(elem) === -1) {
  211. elems.push(elem);
  212. }
  213. } else {
  214. break;
  215. }
  216. }
  217. });
  218. return filterSelector ?
  219. exports.filter.call(elems, filterSelector, this) :
  220. this._make(elems);
  221. };
  222. exports.siblings = function(selector) {
  223. var parent = this.parent();
  224. var elems = _.filter(
  225. parent ? parent.children() : this.siblingsAndMe(),
  226. _.bind(function(elem) { return isTag(elem) && !this.is(elem); }, this)
  227. );
  228. if (selector !== undefined) {
  229. return exports.filter.call(elems, selector, this);
  230. } else {
  231. return this._make(elems);
  232. }
  233. };
  234. exports.children = function(selector) {
  235. var elems = _.reduce(this, function(memo, elem) {
  236. return memo.concat(_.filter(elem.children, isTag));
  237. }, []);
  238. if (selector === undefined) return this._make(elems);
  239. return exports.filter.call(elems, selector, this);
  240. };
  241. exports.contents = function() {
  242. return this._make(_.reduce(this, function(all, elem) {
  243. all.push.apply(all, elem.children);
  244. return all;
  245. }, []));
  246. };
  247. exports.each = function(fn) {
  248. var i = 0, len = this.length;
  249. while (i < len && fn.call(this[i], i, this[i]) !== false) ++i;
  250. return this;
  251. };
  252. exports.map = function(fn) {
  253. return this._make(_.reduce(this, function(memo, el, i) {
  254. var val = fn.call(el, i, el);
  255. return val == null ? memo : memo.concat(val);
  256. }, []));
  257. };
  258. var makeFilterMethod = function(filterFn) {
  259. return function(match, container) {
  260. var testFn;
  261. container = container || this;
  262. if (typeof match === 'string') {
  263. testFn = select.compile(match, container.options);
  264. } else if (typeof match === 'function') {
  265. testFn = function(el, i) {
  266. return match.call(el, i, el);
  267. };
  268. } else if (match.cheerio) {
  269. testFn = match.is.bind(match);
  270. } else {
  271. testFn = function(el) {
  272. return match === el;
  273. };
  274. }
  275. return container._make(filterFn(this, testFn));
  276. };
  277. };
  278. exports.filter = makeFilterMethod(_.filter);
  279. exports.not = makeFilterMethod(_.reject);
  280. exports.has = function(selectorOrHaystack) {
  281. var that = this;
  282. return exports.filter.call(this, function() {
  283. return that._make(this).find(selectorOrHaystack).length > 0;
  284. });
  285. };
  286. exports.first = function() {
  287. return this.length > 1 ? this._make(this[0]) : this;
  288. };
  289. exports.last = function() {
  290. return this.length > 1 ? this._make(this[this.length - 1]) : this;
  291. };
  292. // Reduce the set of matched elements to the one at the specified index.
  293. exports.eq = function(i) {
  294. i = +i;
  295. // Use the first identity optimization if possible
  296. if (i === 0 && this.length <= 1) return this;
  297. if (i < 0) i = this.length + i;
  298. return this[i] ? this._make(this[i]) : this._make([]);
  299. };
  300. // Retrieve the DOM elements matched by the jQuery object.
  301. exports.get = function(i) {
  302. if (i == null) {
  303. return Array.prototype.slice.call(this);
  304. } else {
  305. return this[i < 0 ? (this.length + i) : i];
  306. }
  307. };
  308. // Search for a given element from among the matched elements.
  309. exports.index = function(selectorOrNeedle) {
  310. var $haystack, needle;
  311. if (arguments.length === 0) {
  312. $haystack = this.parent().children();
  313. needle = this[0];
  314. } else if (typeof selectorOrNeedle === 'string') {
  315. $haystack = this._make(selectorOrNeedle);
  316. needle = this[0];
  317. } else {
  318. $haystack = this;
  319. needle = selectorOrNeedle.cheerio ? selectorOrNeedle[0] : selectorOrNeedle;
  320. }
  321. return $haystack.get().indexOf(needle);
  322. };
  323. exports.slice = function() {
  324. return this._make([].slice.apply(this, arguments));
  325. };
  326. function traverseParents(self, elem, selector, limit) {
  327. var elems = [];
  328. while (elem && elems.length < limit) {
  329. if (!selector || exports.filter.call([elem], selector, self).length) {
  330. elems.push(elem);
  331. }
  332. elem = elem.parent;
  333. }
  334. return elems;
  335. }
  336. // End the most recent filtering operation in the current chain and return the
  337. // set of matched elements to its previous state.
  338. exports.end = function() {
  339. return this.prevObject || this._make([]);
  340. };
  341. exports.add = function(other, context) {
  342. var selection = this._make(other, context);
  343. var contents = uniqueSort(selection.get().concat(this.get()));
  344. for (var i = 0; i < contents.length; ++i) {
  345. selection[i] = contents[i];
  346. }
  347. selection.length = contents.length;
  348. return selection;
  349. };
  350. // Add the previous set of elements on the stack to the current set, optionally
  351. // filtered by a selector.
  352. exports.addBack = function(selector) {
  353. return this.add(
  354. arguments.length ? this.prevObject.filter(selector) : this.prevObject
  355. );
  356. };