ebe026d6d394f651e2f1f22f764ce7416bbb306c

Committed 27 Nov 2024 09:28AM UTC coverage: 43.553% (-13.5%) from 57.085%

Build # ebe026d6d394f651e2f1f22f764ce7416bbb306c

Build Type

push

github

Committed by

thijsoo

Commit Message

Merge branch 'trunk' of github.com:Yoast/wordpress-seo into feature/dash-phase-1

Run Details

5027 of 10938 branches covered (45.96%)

Branch coverage included in aggregate %.

45 of 69 new or added lines in 7 files covered. (65.22%)

3 existing lines in 3 files now uncovered.

13689 of 32035 relevant lines covered (42.73%)

71642.72 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/packages/js/src/components/contentAnalysis/ReadabilityAnalysis.js

/* global wpseoAdminL10n */
/* External components */
import { Component, Fragment } from "@wordpress/element";
import { withSelect } from "@wordpress/data";
import PropTypes from "prop-types";
import styled from "styled-components";
import { __, sprintf } from "@wordpress/i18n";
import { isNil } from "lodash";

/* Internal components */
import ScoreIconPortal from "../portals/ScoreIconPortal";
import Results from "../../containers/Results";
import Collapsible from "../SidebarCollapsible";
import getIndicatorForScore from "../../analysis/getIndicatorForScore";
import { getIconForScore } from "./mapResults";
import { LocationConsumer, RootContext } from "@yoast/externals/contexts";
import HelpLink from "../HelpLink";
import ReadabilityResultsPortal from "../portals/ReadabilityResultsPortal";
import { isWordComplexitySupported } from "../../helpers/assessmentUpsellHelpers";
import { addQueryArgs } from "@wordpress/url";
import getL10nObject from "../../analysis/getL10nObject";
import isBlockEditor from "../../helpers/isBlockEditor";
import AIAssessmentFixesButton from "../../ai-assessment-fixes/components/ai-assessment-fixes-button";

const AnalysisHeader = styled.span`
        font-size: 1em;
        font-weight: bold;
        margin: 0 0 8px;
        display: block;
`;

const ReadabilityResultsTabContainer = styled.div`
        padding: 16px;
`;

const StyledHelpLink = styled( HelpLink )`
        margin: -8px 0 -4px 4px;
`;

/**
 * Redux container for the readability analysis.
 */
class ReadabilityAnalysis extends Component {
        /**
         * Renders the Readability Analysis results.
         *
         * @param {Array} upsellResults The array of upsell results.
         *
         * @returns {wp.Element} The Readability Analysis results.
         */
        renderResults( upsellResults ) {
                const highlightingUpsellLink = "shortlinks.upsell.sidebar.highlighting_readability_analysis";

                return (
                        <Fragment>
                                <AnalysisHeader>
                                        { __( "Analysis results", "wordpress-seo" ) }
                                        <StyledHelpLink
                                                href={ wpseoAdminL10n[ "shortlinks.readability_analysis_info" ] }
                                                className="dashicons"
                                        >
                                                <span className="screen-reader-text">
                                                        {
                                                                /* translators: Hidden accessibility text. */
                                                                __( "Learn more about the readability analysis", "wordpress-seo" )
                                                        }
                                                </span>
                                        </StyledHelpLink>
                                </AnalysisHeader>
                                <Results
                                        results={ this.props.results }
                                        upsellResults={ upsellResults }
                                        marksButtonClassName="yoast-tooltip yoast-tooltip-w"
                                        marksButtonStatus={ this.props.marksButtonStatus }
                                        highlightingUpsellLink={ highlightingUpsellLink }
                                        shouldUpsellHighlighting={ this.props.shouldUpsellHighlighting }
                                        renderAIFixesButton={ this.renderAIFixesButton }
                                />
                        </Fragment>
                );
        }

        /**
         * Returns the list of results used to upsell the user to Premium.
         *
         * @param {string} location                 Where this component is rendered (metabox or sidebar).
         * @param {string} locationContext         In which editor this component is rendered.
         *
         * @returns {Array} The upsell results.
         */
        getUpsellResults( location, locationContext ) {
                let link = wpseoAdminL10n[ "shortlinks.upsell.metabox.word_complexity" ];
                if ( location === "sidebar" ) {
                        link = wpseoAdminL10n[ "shortlinks.upsell.sidebar.word_complexity" ];
                }

                link = addQueryArgs( link, { context: locationContext } );

                /*
                 * We don't show the upsell for Word complexity assessment if it's not supported for the current locale.
                 */
                if ( ! isWordComplexitySupported() ) {
                        return [];
                }

                const wordComplexityUpsellText = sprintf(
                        /* Translators: %1$s is a span tag that adds styling to 'Word complexity', %2$s is a closing span tag.
                           %3$s is an anchor tag with a link to yoast.com, %4$s is a closing anchor tag.*/
                        __(
                                "%1$sWord complexity%2$s: Is your vocabulary suited for a larger audience? %3$sYoast SEO Premium will tell you!%4$s",
                                "wordpress-seo"
                        ),
                        "<span style='text-decoration: underline'>",
                        "</span>",
                        `<a href="${ link }" data-action="load-nfd-ctb" data-ctb-id="f6a84663-465f-4cb5-8ba5-f7a6d72224b2" target="_blank">`,
                        "</a>"
                );

                return [
                        {
                                score: 0,
                                rating: "upsell",
                                hasMarks: false,
                                id: "wordComplexity",
                                text: wordComplexityUpsellText,
                                markerId: "wordComplexity",
                        },
                ];
        }

        /* eslint-disable complexity */
        /**
         * Renders the Yoast AI Optimize button.
         * The button is shown when:
         * - The assessment can be fixed through Yoast AI Optimize.
         * - The AI feature is enabled (for Yoast SEO Premium users; for Free users, the button is shown with an upsell).
         * - We are in the block editor.
         * - We are not in the Elementor editor, nor in the Elementor in-between screen.
         *
         * @param {boolean} hasAIFixes Whether the assessment can be fixed through Yoast AI Optimize.
         * @param {string} id The assessment ID.
         *
         * @returns {void|JSX.Element} The AI Optimize button, or nothing if the button should not be shown.
         */
        renderAIFixesButton = ( hasAIFixes, id ) => {
                const { isElementor, isAiFeatureEnabled } = this.props;
                const isPremium = getL10nObject().isPremium;

                // Don't show the button if the AI feature is not enabled for Yoast SEO Premium users.
                if ( isPremium && ! isAiFeatureEnabled ) {
                        return;
                }

                const isElementorEditorPageActive =  document.body.classList.contains( "elementor-editor-active" );
                const isNotElementorPage =  ! isElementor && ! isElementorEditorPageActive;

                // The reason of adding the check if Elementor is active or not is because `isBlockEditor` method also returns `true` for Elementor.
                // The reason of adding the check if the Elementor editor is active, is to stop showing the buttons in the in-between screen.
                return hasAIFixes && isBlockEditor() && isNotElementorPage && (
                        <AIAssessmentFixesButton id={ id } isPremium={ isPremium } />
                );
        };
        /* eslint-enable complexity */

        /**
         * Renders the Readability Analysis component.
         *
         * @returns {wp.Element} The Readability Analysis component.
         */
        render() {
                const score = getIndicatorForScore( this.props.overallScore );

                if ( isNil( this.props.overallScore ) ) {
                        score.className = "loading";
                }

                return (
                        <LocationConsumer>
                                { location => {
                                        return (
                                                <RootContext.Consumer>
                                                        { ( { locationContext } ) => {
                                                                let upsellResults = [];
                                                                if ( this.props.shouldUpsell ) {
                                                                        upsellResults = this.getUpsellResults( location, locationContext );
                                                                }
                                                                if ( location === "sidebar" ) {
                                                                        return (
                                                                                <Collapsible
                                                                                        title={ __( "Readability analysis", "wordpress-seo" ) }
                                                                                        titleScreenReaderText={ score.screenReaderReadabilityText }
                                                                                        prefixIcon={ getIconForScore( score.className ) }
                                                                                        prefixIconCollapsed={ getIconForScore( score.className ) }
                                                                                        id={ `yoast-readability-analysis-collapsible-${ location }` }
                                                                                >
                                                                                        { this.renderResults( upsellResults ) }
                                                                                </Collapsible>
                                                                        );
                                                                }

                                                                if ( location === "metabox" ) {
                                                                        return (
                                                                                <ReadabilityResultsPortal target="wpseo-metabox-readability-root">
                                                                                        <ReadabilityResultsTabContainer>
                                                                                                <ScoreIconPortal
                                                                                                        target="wpseo-readability-score-icon"
                                                                                                        scoreIndicator={ score.className }
                                                                                                />
                                                                                                { this.renderResults( upsellResults ) }
                                                                                        </ReadabilityResultsTabContainer>
                                                                                </ReadabilityResultsPortal>
                                                                        );
                                                                }
                                                        } }
                                                </RootContext.Consumer>
                                        );
                                } }
                        </LocationConsumer>
                );
        }
}

ReadabilityAnalysis.propTypes = {
        results: PropTypes.array.isRequired,
        marksButtonStatus: PropTypes.string.isRequired,
        overallScore: PropTypes.number,
        shouldUpsell: PropTypes.bool,
        shouldUpsellHighlighting: PropTypes.bool,
        isAiFeatureEnabled: PropTypes.bool,
        isElementor: PropTypes.bool,
};

ReadabilityAnalysis.defaultProps = {
        overallScore: null,
        shouldUpsell: false,
        shouldUpsellHighlighting: false,
        isAiFeatureEnabled: false,
};

export default withSelect( select => {
        const {
                getReadabilityResults,
                getMarkButtonStatus,
                getIsElementorEditor,
                getPreference,
        } = select( "yoast-seo/editor" );

        return {
                ...getReadabilityResults(),
                marksButtonStatus: getMarkButtonStatus(),
                isElementor: getIsElementorEditor(),
                isAiFeatureEnabled: getPreference( "isAiFeatureActive", false ),
        };
} )( ReadabilityAnalysis );

1	/* global wpseoAdminL10n */
2	/* External components */
3	import { Component, Fragment } from "@wordpress/element";
4	import { withSelect } from "@wordpress/data";
5	import PropTypes from "prop-types";
6	import styled from "styled-components";
7	import { __, sprintf } from "@wordpress/i18n";
8	import { isNil } from "lodash";
9
10	/* Internal components */
11	import ScoreIconPortal from "../portals/ScoreIconPortal";
12	import Results from "../../containers/Results";
13	import Collapsible from "../SidebarCollapsible";
14	import getIndicatorForScore from "../../analysis/getIndicatorForScore";
15	import { getIconForScore } from "./mapResults";
16	import { LocationConsumer, RootContext } from "@yoast/externals/contexts";
17	import HelpLink from "../HelpLink";
18	import ReadabilityResultsPortal from "../portals/ReadabilityResultsPortal";
19	import { isWordComplexitySupported } from "../../helpers/assessmentUpsellHelpers";
20	import { addQueryArgs } from "@wordpress/url";
21	import getL10nObject from "../../analysis/getL10nObject";
22	import isBlockEditor from "../../helpers/isBlockEditor";
23	import AIAssessmentFixesButton from "../../ai-assessment-fixes/components/ai-assessment-fixes-button";
24
25	const AnalysisHeader = styled.span`	×
26	font-size: 1em;
27	font-weight: bold;
28	margin: 0 0 8px;
29	display: block;
30	`;
31
32	const ReadabilityResultsTabContainer = styled.div`	×
33	padding: 16px;
34	`;
35
36	const StyledHelpLink = styled( HelpLink )`	×
37	margin: -8px 0 -4px 4px;
38	`;
39
40	/**
41	* Redux container for the readability analysis.
42	*/
43	class ReadabilityAnalysis extends Component {
44	/**
45	* Renders the Readability Analysis results.
46	*
47	* @param {Array} upsellResults The array of upsell results.
48	*
49	* @returns {wp.Element} The Readability Analysis results.
50	*/
51	renderResults( upsellResults ) {
52	const highlightingUpsellLink = "shortlinks.upsell.sidebar.highlighting_readability_analysis";	×
53
54	return (	×
55	<Fragment>
56	<AnalysisHeader>
57	{ __( "Analysis results", "wordpress-seo" ) }
58	<StyledHelpLink
59	href={ wpseoAdminL10n[ "shortlinks.readability_analysis_info" ] }
60	className="dashicons"
61	>
62	<span className="screen-reader-text">
63	{
64	/* translators: Hidden accessibility text. */
65	__( "Learn more about the readability analysis", "wordpress-seo" )
66	}
67	</span>
68	</StyledHelpLink>
69	</AnalysisHeader>
70	<Results
71	results={ this.props.results }
72	upsellResults={ upsellResults }
73	marksButtonClassName="yoast-tooltip yoast-tooltip-w"
74	marksButtonStatus={ this.props.marksButtonStatus }
75	highlightingUpsellLink={ highlightingUpsellLink }
76	shouldUpsellHighlighting={ this.props.shouldUpsellHighlighting }
77	renderAIFixesButton={ this.renderAIFixesButton }
78	/>
79	</Fragment>
80	);
81	}
82
83	/**
84	* Returns the list of results used to upsell the user to Premium.
85	*
86	* @param {string} location Where this component is rendered (metabox or sidebar).
87	* @param {string} locationContext In which editor this component is rendered.
88	*
89	* @returns {Array} The upsell results.
90	*/
91	getUpsellResults( location, locationContext ) {
92	let link = wpseoAdminL10n[ "shortlinks.upsell.metabox.word_complexity" ];	×
93	if ( location === "sidebar" ) {	×
94	link = wpseoAdminL10n[ "shortlinks.upsell.sidebar.word_complexity" ];	×
95	}
96
97	link = addQueryArgs( link, { context: locationContext } );	×
98
99	/*
100	* We don't show the upsell for Word complexity assessment if it's not supported for the current locale.
101	*/
102	if ( ! isWordComplexitySupported() ) {	×
103	return [];	×
104	}
105
106	const wordComplexityUpsellText = sprintf(	×
107	/* Translators: %1$s is a span tag that adds styling to 'Word complexity', %2$s is a closing span tag.
108	%3$s is an anchor tag with a link to yoast.com, %4$s is a closing anchor tag.*/
109	__(
110	"%1$sWord complexity%2$s: Is your vocabulary suited for a larger audience? %3$sYoast SEO Premium will tell you!%4$s",
111	"wordpress-seo"
112	),
113	"<span style='text-decoration: underline'>",
114	"</span>",
115	`<a href="${ link }" data-action="load-nfd-ctb" data-ctb-id="f6a84663-465f-4cb5-8ba5-f7a6d72224b2" target="_blank">`,
116	"</a>"
117	);
118
119	return [	×
120	{
121	score: 0,
122	rating: "upsell",
123	hasMarks: false,
124	id: "wordComplexity",
125	text: wordComplexityUpsellText,
126	markerId: "wordComplexity",
127	},
128	];
129	}
130
131	/* eslint-disable complexity */
132	/**
133	* Renders the Yoast AI Optimize button.
134	* The button is shown when:
135	* - The assessment can be fixed through Yoast AI Optimize.
136	* - The AI feature is enabled (for Yoast SEO Premium users; for Free users, the button is shown with an upsell).
137	* - We are in the block editor.
138	* - We are not in the Elementor editor, nor in the Elementor in-between screen.
139	*
140	* @param {boolean} hasAIFixes Whether the assessment can be fixed through Yoast AI Optimize.
141	* @param {string} id The assessment ID.
142	*
143	* @returns {void\|JSX.Element} The AI Optimize button, or nothing if the button should not be shown.
144	*/
NEW 145	renderAIFixesButton = ( hasAIFixes, id ) => {	×
NEW 146	const { isElementor, isAiFeatureEnabled } = this.props;	×
NEW 147	const isPremium = getL10nObject().isPremium;	×
148
149	// Don't show the button if the AI feature is not enabled for Yoast SEO Premium users.
NEW 150	if ( isPremium && ! isAiFeatureEnabled ) {	×
NEW 151	return;	×
152	}
153
NEW 154	const isElementorEditorPageActive = document.body.classList.contains( "elementor-editor-active" );	×
NEW 155	const isNotElementorPage = ! isElementor && ! isElementorEditorPageActive;	×
156
157	// The reason of adding the check if Elementor is active or not is because `isBlockEditor` method also returns `true` for Elementor.
158	// The reason of adding the check if the Elementor editor is active, is to stop showing the buttons in the in-between screen.
NEW 159	return hasAIFixes && isBlockEditor() && isNotElementorPage && (	×
160	<AIAssessmentFixesButton id={ id } isPremium={ isPremium } />
161	);
162	};
163	/* eslint-enable complexity */
164
165	/**
166	* Renders the Readability Analysis component.
167	*
168	* @returns {wp.Element} The Readability Analysis component.
169	*/
170	render() {
171	const score = getIndicatorForScore( this.props.overallScore );	×
172
173	if ( isNil( this.props.overallScore ) ) {	×
174	score.className = "loading";	×
175	}
176
177	return (	×
178	<LocationConsumer>
179	{ location => {
180	return (	×
181	<RootContext.Consumer>
182	{ ( { locationContext } ) => {
183	let upsellResults = [];	×
184	if ( this.props.shouldUpsell ) {	×
185	upsellResults = this.getUpsellResults( location, locationContext );	×
186	}
187	if ( location === "sidebar" ) {	×
188	return (	×
189	<Collapsible
190	title={ __( "Readability analysis", "wordpress-seo" ) }
191	titleScreenReaderText={ score.screenReaderReadabilityText }
192	prefixIcon={ getIconForScore( score.className ) }
193	prefixIconCollapsed={ getIconForScore( score.className ) }
194	id={ `yoast-readability-analysis-collapsible-${ location }` }
195	>
196	{ this.renderResults( upsellResults ) }
197	</Collapsible>
198	);
199	}
200
201	if ( location === "metabox" ) {	×
202	return (	×
203	<ReadabilityResultsPortal target="wpseo-metabox-readability-root">
204	<ReadabilityResultsTabContainer>
205	<ScoreIconPortal
206	target="wpseo-readability-score-icon"
207	scoreIndicator={ score.className }
208	/>
209	{ this.renderResults( upsellResults ) }
210	</ReadabilityResultsTabContainer>
211	</ReadabilityResultsPortal>
212	);
213	}
214	} }
215	</RootContext.Consumer>
216	);
217	} }
218	</LocationConsumer>
219	);
220	}
221	}
222
223	ReadabilityAnalysis.propTypes = {	×
224	results: PropTypes.array.isRequired,
225	marksButtonStatus: PropTypes.string.isRequired,
226	overallScore: PropTypes.number,
227	shouldUpsell: PropTypes.bool,
228	shouldUpsellHighlighting: PropTypes.bool,
229	isAiFeatureEnabled: PropTypes.bool,
230	isElementor: PropTypes.bool,
231	};
232
233	ReadabilityAnalysis.defaultProps = {	×
234	overallScore: null,
235	shouldUpsell: false,
236	shouldUpsellHighlighting: false,
237	isAiFeatureEnabled: false,
238	};
239
240	export default withSelect( select => {
241	const {
242	getReadabilityResults,
243	getMarkButtonStatus,
244	getIsElementorEditor,
245	getPreference,
UNCOV 246	} = select( "yoast-seo/editor" );	×
247
248	return {	×
249	...getReadabilityResults(),
250	marksButtonStatus: getMarkButtonStatus(),
251	isElementor: getIsElementorEditor(),
252	isAiFeatureEnabled: getPreference( "isAiFeatureActive", false ),
253	};
254	} )( ReadabilityAnalysis );

Yoast / wordpress-seo / ebe026d6d394f651e2f1f22f764ce7416bbb306c

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous