yoastseo-dep/spec/scoring/assessments/seo/SingleH1AssessmentSpec.js

Yoast clientside page analysis

import SingleH1Assessment from "../../../../src/scoring/assessments/seo/SingleH1Assessment.js";
import Paper from "../../../../src/values/Paper.js";
import Mark from "../../../../src/values/Mark.js";
import EnglishResearcher from "../../../../src/languageProcessing/languages/en/Researcher";
import buildTree from "../../../specHelpers/parse/buildTree";

const h1Assessment = new SingleH1Assessment();

describe( "An assessment to check whether there is more than one H1 in the text", function() {
	it( "returns the default result when the paper doesn't contain an H1", function() {
		const mockPaper = new Paper( "<p>a paragraph</p>" );
		const mockResearcher = new EnglishResearcher( mockPaper );
		buildTree( mockPaper, mockResearcher );
		const assessment = h1Assessment.getResult( mockPaper, mockResearcher );

		expect( assessment.getScore() ).toEqual( 0 );
		expect( assessment.getText() ).toEqual( "" );
		expect( assessment.hasScore() ).toEqual( false );
	} );

	it( "returns the default result when there's an H1 at the beginning of the body", function() {
		const mockPaper = new Paper( "<h1>heading</h1><p>a paragraph</p>" );
		const mockResearcher = new EnglishResearcher( mockPaper );
		buildTree( mockPaper, mockResearcher );
		const assessment = h1Assessment.getResult( mockPaper, mockResearcher );


		expect( assessment.getScore() ).toEqual( 0 );
		expect( assessment.getText() ).toEqual( "" );
		expect( assessment.hasScore() ).toEqual( false );
	} );

	it( "also returns the default result when there's an H1 and it's not at the beginning of the body", function() {
		const mockPaper = new Paper( "<p>Cool intro</p><h1>heading</h1><p>a paragraph</p>" );
		const mockResearcher = new EnglishResearcher( mockPaper );
		buildTree( mockPaper, mockResearcher );
		const assessment = h1Assessment.getResult( mockPaper, mockResearcher );

		expect( assessment.getScore() ).toEqual( 0 );
		expect( assessment.getText() ).toEqual( "" );
		expect( assessment.hasScore() ).toEqual( false );
	} );

	it( "returns a bad score and appropriate feedback when there are multiple one superfluous (i.e., non-title) " +
		"H1s in the body of the text", function() {
		const mockPaper = new Paper( "<p>a paragraph</p><h1>heading 1</h1><p>a paragraph</p><h1>heading 2</h1>" );
		const mockResearcher = new EnglishResearcher( mockPaper );
		buildTree( mockPaper, mockResearcher );
		const assessment = h1Assessment.getResult( mockPaper, mockResearcher );

		expect( assessment.getScore() ).toEqual( 1 );
		expect( assessment.getText() ).toEqual(  "<a href='https://yoa.st/3a6' target='_blank'>Single title</a>: " +
			"H1s should only be used as your main title. Find all H1s in your text that aren't your main title and " +
			"<a href='https://yoa.st/3a7' target='_blank'>change them to a lower heading level</a>!" );
	} );
} );

describe( "A test for marking incorrect H1s in the body", function() {
	it( "returns markers for incorrect H1s in the body", function() {
		const mockPaper = new Paper( "<p>a paragraph</p><h1>heading</h1>" );
		const mockResearcher = new EnglishResearcher( mockPaper );
		buildTree( mockPaper, mockResearcher );
		h1Assessment.getResult( mockPaper, mockResearcher );

		const expected = [
			new Mark( {
				original: "<h1>heading</h1>",
				marked: "<h1><yoastmark class='yoast-text-mark'>heading</yoastmark></h1>",
				position: {
					startOffset: 22,
					endOffset: 29,
					clientId: "",
					endOffsetBlock: 7,
					startOffsetBlock: 0,
				} } ),
		];

		expect( h1Assessment.getMarks() ).toEqual( expected );
	} );

	it( "also returns markers for H1s in the first position of the body", function() {
		const mockPaper = new Paper( "<h1>heading</h1><p>a paragraph</p>" );
		const mockResearcher = new EnglishResearcher( mockPaper );
		buildTree( mockPaper, mockResearcher );
		h1Assessment.getResult( mockPaper, mockResearcher );
		const expected = [
			new Mark( {
				original: "<h1>heading</h1>",
				marked: "<h1><yoastmark class='yoast-text-mark'>heading</yoastmark></h1>",
				position: {
					startOffset: 4,
					endOffset: 11,
					clientId: "",
					endOffsetBlock: 7,
					startOffsetBlock: 0,
				},
			} ),
		];

		expect( h1Assessment.getMarks() ).toEqual( expected );
	} );

	it( "doesn't return markers when there are no H1s in the body", function() {
		const mockPaper = new Paper( "<p>a paragraph</p>" );
		const mockResearcher = new EnglishResearcher( mockPaper );
		buildTree( mockPaper, mockResearcher );
		const results = h1Assessment.getResult( mockPaper, mockResearcher );

		expect( results._hasMarks ).toEqual( false );
	} );
} );

describe( "Checks if the assessment is applicable", function() {
	it( "is applicable when there is a paper with a text", function() {
		const mockPaper = new Paper( "text" );
		const assessment = h1Assessment.isApplicable( mockPaper );

		expect( assessment ).toBe( true );
	} );

	it( "is not applicable when there there is no text", function() {
		const mockPaper = new Paper( "" );
		const assessment = h1Assessment.isApplicable( mockPaper );

		expect( assessment ).toBe( false );
	} );
} );