yoastseo-dep/src/scoring/assessments/readability/SentenceBeginningsAssessment.js

Yoast clientside page analysis

import { filter, flatten, map, merge, partition, sortBy } from "lodash-es";
import { _n, __, sprintf } from "@wordpress/i18n";

import marker from "../../../markers/addMark";
import { createAnchorOpeningTag } from "../../../helpers/shortlinker";
import { stripIncompleteTags as stripTags } from "../../../languageProcessing/helpers/sanitize/stripHTMLTags";
import AssessmentResult from "../../../values/AssessmentResult";
import Mark from "../../../values/Mark";
import Assessment from "../assessment";

const maximumConsecutiveDuplicates = 2;

/**
 * Represents the assessment that checks whether there are three or more consecutive sentences beginning with the same word.
 */
export default class SentenceBeginningsAssessment extends Assessment {
	/**
	 * Sets the identifier and the config.
	 *
	 * @param {object} config The configuration to use.
	 *
	 * @returns {void}
	 */
	constructor( config = {} ) {
		super();

		const defaultConfig = {
			urlTitle: createAnchorOpeningTag( "https://yoa.st/35f" ),
			urlCallToAction: createAnchorOpeningTag( "https://yoa.st/35g" ),
		};

		this.identifier = "sentenceBeginnings";
		this._config = merge( defaultConfig, config );
	}

	/**
	 * Counts and groups the number too often used sentence beginnings and determines the lowest count within that group.
	 *
	 * @param {array} sentenceBeginnings The array containing the objects containing the beginning words and counts.
	 *
	 * @returns {object} The object containing the total number of too often used beginnings and the lowest count within those.
	 */
	groupSentenceBeginnings( sentenceBeginnings ) {
		const tooOften = partition( sentenceBeginnings, function( word ) {
			return word.count > maximumConsecutiveDuplicates;
		} );

		if ( tooOften[ 0 ].length === 0 ) {
			return { total: 0 };
		}

		const sortedCounts = sortBy( tooOften[ 0 ], function( word ) {
			return word.count;
		} );

		return { total: tooOften[ 0 ].length, lowestCount: sortedCounts[ 0 ].count };
	}

	/**
	 * Calculates the score based on sentence beginnings.
	 *
	 * @param {object} groupedSentenceBeginnings    The object with grouped sentence beginnings.
	 *
	 * @returns {{score: number, text: string, hasMarks: boolean}} result object with score and text.
	 */
	calculateSentenceBeginningsResult( groupedSentenceBeginnings ) {
		if ( groupedSentenceBeginnings.total > 0 ) {
			return {
				score: 3,
				hasMarks: true,
				text: sprintf(
					/* translators: %1$s and %5$s expand to a link on yoast.com, %2$s expands to the anchor end tag,
					%3$d expands to the number of consecutive sentences starting with the same word,
					%4$d expands to the number of instances where 3 or more consecutive sentences start with the same word. */
					_n(
						// eslint-disable-next-line max-len
						"%1$sConsecutive sentences%2$s: The text contains %3$d consecutive sentences starting with the same word. %5$sTry to mix things up%2$s!",
						// eslint-disable-next-line max-len
						"%1$sConsecutive sentences%2$s: The text contains %4$d instances where %3$d or more consecutive sentences start with the same word. %5$sTry to mix things up%2$s!",
						groupedSentenceBeginnings.total,
						"wordpress-seo"
					),
					this._config.urlTitle,
					"</a>",
					groupedSentenceBeginnings.lowestCount,
					groupedSentenceBeginnings.total,
					this._config.urlCallToAction
				),
			};
		}
		return {
			score: 9,
			hasMarks: false,
			text: sprintf(
				/* translators:  %1$s expands to a link on yoast.com, %2$s expands to the anchor end tag */
				__(
					"%1$sConsecutive sentences%2$s: There is enough variety in your sentences. That's great!",
					"wordpress-seo"
				),
				this._config.urlTitle,
				"</a>"
			),
		};
	}

	/**
	 * Marks all consecutive sentences with the same beginnings.
	 *
	 * @param {object} paper        The paper to use for the assessment.
	 * @param {object} researcher   The researcher used for calling research.
	 *
	 * @returns {object} All marked sentences.
	 */
	getMarks( paper, researcher ) {
		let sentenceBeginnings = researcher.getResearch( "getSentenceBeginnings" );
		sentenceBeginnings = filter( sentenceBeginnings, function( sentenceBeginning ) {
			return sentenceBeginning.count > maximumConsecutiveDuplicates;
		} );

		const sentences = map( sentenceBeginnings, function( begin ) {
			return begin.sentences;
		} );

		return map( flatten( sentences ), function( sentence ) {
			sentence = stripTags( sentence );
			const marked = marker( sentence );
			return new Mark( {
				original: sentence,
				marked: marked,
			} );
		} );
	}

	/**
	 * Scores the repetition of sentence beginnings in consecutive sentences.
	 *
	 * @param {object} paper        The paper to use for the assessment.
	 * @param {object} researcher   The researcher used for calling research.
	 *
	 * @returns {object} The Assessment result
	 */
	getResult( paper, researcher ) {
		const sentenceBeginnings = researcher.getResearch( "getSentenceBeginnings" );
		const groupedSentenceBeginnings = this.groupSentenceBeginnings( sentenceBeginnings );
		const sentenceBeginningsResult = this.calculateSentenceBeginningsResult( groupedSentenceBeginnings );
		const assessmentResult = new AssessmentResult();

		assessmentResult.setScore( sentenceBeginningsResult.score );
		assessmentResult.setText( sentenceBeginningsResult.text );
		assessmentResult.setHasMarks( sentenceBeginningsResult.hasMarks );
		return assessmentResult;
	}

	/**
	 * Checks if the sentence beginnings assessment is applicable to the paper.
	 *
	 * @param {Object}      paper       The paper to check.
	 * @param {Researcher}  researcher  The researcher object.
	 *
	 * @returns {boolean} Returns true if the language is available and the paper is not empty.
	 */
	isApplicable( paper, researcher ) {
		return this.hasEnoughContentForAssessment( paper ) && researcher.hasResearch( "getSentenceBeginnings" );
	}
}