yoastseo-dep/spec/parse/traverse/findAllInTreeSpec.js

Yoast clientside page analysis

import findAllInTree from "../../../src/parse/traverse/findAllInTree";
import build from "../../../src/parse/build/build";
import LanguageProcessor from "../../../src/parse/language/LanguageProcessor";
import Factory from "../../specHelpers/factory";
import memoizedSentenceTokenizer from "../../../src/languageProcessing/helpers/sentence/memoizedSentenceTokenizer";
import Paper from "../../../src/values/Paper";

let languageProcessor, paper;

beforeEach( () => {
	const researcher = Factory.buildMockResearcher( {}, true, false, false,
		{ memoizedTokenizer: memoizedSentenceTokenizer } );
	languageProcessor = new LanguageProcessor( researcher );
	paper = new Paper( "" );
} );

describe( "A test for findAllInTree", () => {
	it( "should correctly extract all p-tags from a tree", function() {
		paper._text = "<div><p class='yoast'>Hello, world! </p><p class='yoast'>Hello, yoast! </p></div>";
		const tree = build( paper, languageProcessor );

		const searchResult = findAllInTree( tree, treeNode => treeNode.name === "p" );

		const expected = [
			{
				name: "p",
				isImplicit: false,
				attributes: { "class": new Set( [ "yoast" ] ) },
				childNodes: [ {
					name: "#text",
					value: "Hello, world! ",
					sourceCodeRange: { startOffset: 22, endOffset: 36 },
				} ],
				sentences: [ {
					text: "Hello, world!",
					sourceCodeRange: { startOffset: 22, endOffset: 35 },
					tokens: [
						{ text: "Hello", sourceCodeRange: { startOffset: 22, endOffset: 27 } },
						{ text: ",", sourceCodeRange: { startOffset: 27, endOffset: 28 } },
						{ text: " ", sourceCodeRange: { startOffset: 28, endOffset: 29 } },
						{ text: "world", sourceCodeRange: { startOffset: 29, endOffset: 34 } },
						{ text: "!", sourceCodeRange: { startOffset: 34, endOffset: 35 } },
					],
				} ],
				sourceCodeLocation: {
					startOffset: 5,
					endOffset: 40,
					startTag: {
						startOffset: 5,
						endOffset: 22,
					},
					endTag: {
						startOffset: 36,
						endOffset: 40,
					},
				},
			},
			{
				name: "p",
				isImplicit: false,
				attributes: { "class": new Set( [ "yoast" ] ) },
				childNodes: [ {
					name: "#text",
					value: "Hello, yoast! ",
					sourceCodeRange: { startOffset: 57, endOffset: 71 },
				} ],
				sentences: [ {
					text: "Hello, yoast!",
					sourceCodeRange: { startOffset: 57, endOffset: 70 },
					tokens: [
						{ text: "Hello", sourceCodeRange: { startOffset: 57, endOffset: 62 } },
						{ text: ",", sourceCodeRange: { startOffset: 62, endOffset: 63 } },
						{ text: " ", sourceCodeRange: { startOffset: 63, endOffset: 64 } },
						{ text: "yoast", sourceCodeRange: { startOffset: 64, endOffset: 69 } },
						{ text: "!", sourceCodeRange: { startOffset: 69, endOffset: 70 } },
					],
				} ],
				sourceCodeLocation: {
					startOffset: 40,
					endOffset: 75,
					startTag: {
						startOffset: 40,
						endOffset: 57,
					},
					endTag: {
						startOffset: 71,
						endOffset: 75,
					},
				},
			},
		];

		expect( searchResult ).toEqual( expected );
	} );

	it( "should return an empty result if the tag doesnt exist within the tree", function() {
		paper._text = "<div><p class='yoast'>Hello, world! </p><p class='yoast'>Hello, yoast! </p></div>";
		const tree = build( paper, languageProcessor );

		const searchResult = findAllInTree( tree, treeNode => treeNode.name === "h1" );

		expect( searchResult ).toEqual( [] );
	} );

	it( "should return all sub-nodes if recurseFoundNodes is true", function() {
		paper._text = "<div><div><div>foo</div></div></div>";
		const tree = build( paper, languageProcessor );

		const searchResult = findAllInTree( tree, treeNode => treeNode.name === "div", true );

		expect( searchResult.length ).toEqual( 3 );

		const searchResultNoRecurse = findAllInTree( tree, treeNode => treeNode.name === "div", false );

		expect( searchResultNoRecurse.length ).toEqual( 1 );
	} );
} );