axyseo 2.0.0-alpha.0.0.4 → 2.0.0-alpha.0.0.6

package/src/scoring/scoreAggregators/SEOScoreAggregator.js

@@ -1,54 +0,0 @@
-import ScoreAggregator from "./ScoreAggregator";
-
-/**
- * The number to scale the score to.
- *
- * Individual scores are from 1 to 9.
- * The total score should be multiplied by this number to scale up.
- *
- * @type {number}
- * @const
- *
- * @memberOf module:parsedPaper/assess
- */
-const ScoreScale = 100;
-
-/**
- * The factor to multiply the amount of results with.
- *
- * Individual scores are from 1 to 9.
- * The make the total score work in the 100 scale, the amount of results needs to get multiplied by this factor.
- *
- * @type {number}
- * @const
- *
- * @memberOf module:parsedPaper/assess
- */
-const ScoreFactor = 9;
-
-/**
- * Aggregates SEO assessment results into a single score.
- *
- * @memberOf module:parsedPaper/assess
- */
-class SEOScoreAggregator extends ScoreAggregator {
-	/**
-	 * Aggregates the given assessment results into a single score.
-	 *
-	 * @param {AssessmentResult[]} results The assessment results.
-	 *
-	 * @returns {number} The aggregated score.
-	 */
-	aggregate( results ) {
-		const score = results.reduce( ( sum, result ) => sum + result.getScore(), 0 );
-
-		/*
-		 * Whenever the divide by part is 0 this can result in a `NaN` value. Then 0 should be returned as fallback.
-		 * This seemed better than the if check `results.length === 0`,
-		 * because it also protects against ScoreFactor being 0.
-		 */
-		return Math.round( ( score * ScoreScale ) / ( results.length * ScoreFactor ) ) || 0;
-	}
-}
-
-export default SEOScoreAggregator;

package/src/scoring/scoreAggregators/ScoreAggregator.js

@@ -1,23 +0,0 @@
-/**
- * Aggregates assessment results into a single score.
- *
- * @memberOf module:parsedPaper/assess
- *
- * @abstract
- */
-class ScoreAggregator {
-	/**
-	 * Aggregates the given assessment results into a single score.
-	 *
-	 * @param {AssessmentResult[]} results The assessment results.
-	 *
-	 * @returns {number} The aggregated score.
-	 *
-	 * @abstract
-	 */
-	aggregate( results ) { // eslint-disable-line no-unused-vars
-		console.warn( "'aggregate' must be implemented by a child class of 'ScoreAggregator'" );
-	}
-}
-
-export default ScoreAggregator;

package/src/scoring/scoreAggregators/index.js

@@ -1,3 +0,0 @@
-export { default as ReadabilityScoreAggregator } from "./ReadabilityScoreAggregator";
-export { default as ScoreAggregator } from "./ScoreAggregator";
-export { default as SEOScoreAggregator } from "./SEOScoreAggregator";

package/src/values/AssessmentResult.js

@@ -1,496 +0,0 @@
-import {isArray, isEmpty, isNull, isNumber, isUndefined} from 'lodash';
-
-import Mark from './Mark';
-
-/**
- * A function that only returns an empty that can be used as an empty marker
- *
- * @returns {Array} A list of empty marks.
- */
-const emptyMarker = () => [];
-
-/**
- * Represents the assessment result.
- */
-class AssessmentResult {
-  /**
-   * Constructs the AssessmentResult value object.
-   *
-   * @param {Object} [values] The values for this assessment result.
-   * @param {number} [values.score] The score for this assessment result.
-   * @param {React.JSX.Element} [values.body] The score for this assessment result.
-   * @param {string} [values.status] The score for this assessment result.
-   * @param {string} [values.title] The title for this assessment result.
-   * @param {string} [values.text] The text for this assessment result. This is the text that can be used as a feedback message associated with the score.
-   * @param {array} [values.marks] The marks for this assessment result.
-   * @param {object} [values.config] The config for this assessment result.
-   * @param {boolean} [values._hasBetaBadge] Whether this result has a beta badge.
-   * @param {boolean} [values._hasJumps] Whether this result causes a jump to a different field.
-   * @param {string} [values.editFieldName] The edit field name for this assessment result.
-   * @param {boolean} [values._hasAIFixes] Whether this result has AI fixes.
-   * @constructor
-   * @returns {void}
-   */
-  constructor(values) {
-    this._hasScore = false;
-    this._identifier = '';
-    this._hasAIFixes = false;
-    this._hasMarks = false;
-    this._hasJumps = false;
-    this._hasBody = false;
-    this._hasTitle = false;
-    this._hasEditFieldName = false;
-    this._marker = emptyMarker;
-    this._hasBetaBadge = false;
-    this.score = 0;
-    this.config = {};
-    this.body = null;
-    this.status = '';
-    this.title = '';
-    this.text = '';
-    this.marks = [];
-    this.editFieldName = '';
-
-    if (isUndefined(values)) {
-      values = {};
-    }
-
-    if (!isUndefined(values.score)) {
-      this.setScore(values.score);
-    }
-
-    if (values.status) {
-      this.setStatus(values.status);
-    }
-
-    if (values.config) {
-      this.setConfig(values.config);
-    }
-
-    if (values.body) {
-      this.setBody(values.body);
-    }
-
-    if (values.title) {
-      this.setTitle(values.title);
-    }
-
-    if (!isUndefined(values.text)) {
-      this.setText(values.text);
-    }
-
-    if (!isUndefined(values.status)) {
-      this.setStatus(values.status);
-    }
-
-    if (!isUndefined(values.body)) {
-      this.setBody(values.body);
-    }
-
-    if (!isUndefined(values.marks)) {
-      this.setMarks(values.marks);
-    }
-
-    if (!isUndefined(values._hasBetaBadge)) {
-      this.setHasBetaBadge(values._hasBetaBadge);
-    }
-
-    if (!isUndefined(values._hasJumps)) {
-      this.setHasJumps(values._hasJumps);
-    }
-
-    if (!isUndefined(values.editFieldName)) {
-      this.setEditFieldName(values.editFieldName);
-    }
-
-    if (!isUndefined(values._hasAIFixes)) {
-      this.setHasAIFixes(values._hasAIFixes);
-    }
-  }
-
-  /**
-   * Checks if a status is available.
-   * @returns {boolean} Whether or not a status is available.
-   */
-  hasStatus() {
-    return !isEmpty(this._hasStatus);
-  }
-
-  /**
-   * Gets the available score.
-   * @returns {React.JSX.Element} The status associated with the AssessmentResult.
-   */
-  getStatus() {
-    return this.status;
-  }
-
-  /**
-   * Sets the status for the assessment.
-   * @returns {void}
-   * @param status
-   */
-  setStatus(status) {
-    if (status) {
-      this.status = status;
-      this._hasStatus = true;
-    }
-  }
-
-  /**
-   * Checks if a title is available.
-   * @returns {boolean} Whether or not a title is available.
-   */
-  hasTitle() {
-    return !isEmpty(this._hasTitle);
-  }
-
-  /**
-   * Gets the available score.
-   * @returns {React.JSX.Element} The title associated with the AssessmentResult.
-   */
-  getTitle() {
-    return this.title;
-  }
-
-  /**
-   * Sets the title for the assessment.
-   * @returns {void}
-   * @param title
-   */
-  setTitle(title) {
-    if (title) {
-      this.title = title;
-      this._hasTitle = true;
-    }
-  }
-
-  /**
-   * Checks if a config is available.
-   * @returns {boolean} Whether or not a config is available.
-   */
-  hasConfig() {
-    return !isEmpty(this._hasConfig);
-  }
-
-  /**
-   * Gets the available score.
-   * @returns {React.JSX.Element} The config associated with the AssessmentResult.
-   */
-  getConfig() {
-    return this.config;
-  }
-
-  /**
-   * Sets the config for the assessment.
-   * @returns {void}
-   * @param config
-   */
-  setConfig(config) {
-    if (config) {
-      this.config = config;
-      this._hasConfig = true;
-    }
-  }
-
-  /**
-   * Checks if a body is available.
-   * @returns {boolean} Whether or not a body is available.
-   */
-  hasBody() {
-    return !isNull(this._hasBody);
-  }
-
-  /**
-   * Gets the available score.
-   * @returns {React.JSX.Element} The body associated with the AssessmentResult.
-   */
-  getBody() {
-    return this.body;
-  }
-
-  /**
-   * Sets the body for the assessment.
-   * @returns {void}
-   * @param element
-   */
-  setBody(element) {
-    if (element) {
-      this.body = element;
-      this._hasBody = true;
-    }
-  }
-
-  /**
-   * Checks if a score is available.
-   * @returns {boolean} Whether or not a score is available.
-   */
-  hasScore() {
-    return this._hasScore;
-  }
-
-  /**
-   * Gets the available score.
-   * @returns {number} The score associated with the AssessmentResult.
-   */
-  getScore() {
-    return this.score;
-  }
-
-  /**
-   * Sets the score for the assessment.
-   * @param {number} score The score to be used for the score property.
-   * @returns {void}
-   */
-  setScore(score) {
-    if (isNumber(score)) {
-      this.score = score;
-      this._hasScore = true;
-    }
-  }
-
-  /**
-   * Checks if a text for the assessment result is available.
-   * @returns {boolean} Whether or not a text is available.
-   */
-  hasText() {
-    return this.text !== '';
-  }
-
-  /**
-   * Gets the available text for the assessment result.
-   * @returns {string} The text associated with the AssessmentResult.
-   */
-  getText() {
-    return this.text;
-  }
-
-  /**
-   * Sets the text for the assessment.
-   * @param {string} text The text to be used for the text property.
-   * @returns {void}
-   */
-  setText(text) {
-    if (isUndefined(text)) {
-      text = '';
-    }
-
-    this.text = text;
-  }
-
-  /**
-   * Gets the available marks.
-   *
-   * @returns {array} The marks associated with the AssessmentResult.
-   */
-  getMarks() {
-    return this.marks;
-  }
-
-  /**
-   * Sets the marks for the assessment.
-   *
-   * @param {array} marks The marks to be used for the marks property.
-   *
-   * @returns {void}
-   */
-  setMarks(marks) {
-    if (isArray(marks)) {
-      this.marks = marks;
-      this._hasMarks = marks.length > 0;
-    }
-  }
-
-  /**
-   * Sets the identifier.
-   *
-   * @param {string} identifier An alphanumeric identifier for this result.
-   * @returns {void}
-   */
-  setIdentifier(identifier) {
-    this._identifier = identifier;
-  }
-
-  /**
-   * Gets the identifier.
-   *
-   * @returns {string} An alphanumeric identifier for this result.
-   */
-  getIdentifier() {
-    return this._identifier;
-  }
-
-  /**
-   * Sets the marker, a pure function that can return the marks for a given Paper.
-   *
-   * @param {Function} marker The marker to set.
-   * @returns {void}
-   */
-  setMarker(marker) {
-    this._marker = marker;
-  }
-
-  /**
-   * Returns whether this result has a marker that can be used to mark for a given Paper.
-   *
-   * @returns {boolean} Whether this result has a marker.
-   */
-  hasMarker() {
-    return this._hasMarks && this._marker !== emptyMarker;
-  }
-
-  /**
-   * Gets the marker, a pure function that can return the marks for a given Paper.
-   *
-   * @returns {Function} The marker.
-   */
-  getMarker() {
-    return this._marker;
-  }
-
-  /**
-   * Sets the value of _hasMarks to determine if there is something to mark.
-   *
-   * @param {boolean} hasMarks Is there something to mark.
-   * @returns {void}
-   */
-  setHasMarks(hasMarks) {
-    this._hasMarks = hasMarks;
-  }
-
-  /**
-   * Returns the value of _hasMarks to determine if there is something to mark.
-   *
-   * @returns {boolean} Is there something to mark.
-   */
-  hasMarks() {
-    return this._hasMarks;
-  }
-
-  /**
-   * Sets the value of _hasBetaBadge to determine if the result has a beta badge.
-   *
-   * @param {boolean} hasBetaBadge Whether this result has a beta badge.
-   * @returns {void}
-   */
-  setHasBetaBadge(hasBetaBadge) {
-    this._hasBetaBadge = hasBetaBadge;
-  }
-
-  /**
-   * Returns the value of _hasBetaBadge to determine if the result has a beta badge.
-   *
-   * @returns {bool} Whether this result has a beta badge.
-   */
-  hasBetaBadge() {
-    return this._hasBetaBadge;
-  }
-
-  /**
-   * Sets the value of _hasJumps to determine whether it's needed to jump to a different field.
-   *
-   * @param {boolean} hasJumps Whether this result causes a jump to a different field.
-   * @returns {void}
-   */
-  setHasJumps(hasJumps) {
-    this._hasJumps = hasJumps;
-  }
-
-  /**
-   * Returns the value of _hasJumps to determine whether it's needed to jump to a different field.
-   *
-   * @returns {bool} Whether this result causes a jump to a different field.
-   */
-  hasJumps() {
-    return this._hasJumps;
-  }
-
-  /**
-   * Check if an edit field name is available.
-   * @returns {boolean} Whether or not an edit field name is available.
-   */
-  hasEditFieldName() {
-    return this._hasEditFieldName;
-  }
-
-  /**
-   * Gets the edit field name.
-   * @returns {string} The edit field name associated with the AssessmentResult.
-   */
-  getEditFieldName() {
-    return this.editFieldName;
-  }
-
-  /**
-   * Sets the edit field name to be used to create the aria label for an edit button.
-   * @param {string} editFieldName The string to be used for the string property
-   * @returns {void}
-   */
-  setEditFieldName(editFieldName) {
-    if (editFieldName !== '') {
-      this.editFieldName = editFieldName;
-      this._hasEditFieldName = true;
-    }
-  }
-
-  /**
-   * Sets the value of _hasAIFixes to determine if the result has AI fixes.
-   *
-   * @param {boolean} hasAIFixes Whether this result has AI fixes.
-   * @returns {void}
-   */
-  setHasAIFixes(hasAIFixes) {
-    this._hasAIFixes = hasAIFixes;
-  }
-
-  /**
-   * Returns the value of _hasAIFixes to determine if the result has AI fixes.
-   *
-   * @returns {bool} Whether this result has AI fixes.
-   */
-  hasAIFixes() {
-    return this._hasAIFixes;
-  }
-
-  /**
-   * Serializes the AssessmentResult instance to an object.
-   *
-   * @returns {Object} The serialized AssessmentResult.
-   */
-  serialize() {
-    return {
-      _parseClass: 'AssessmentResult',
-      identifier: this._identifier,
-      score: this.score,
-      text: this.text,
-      marks: this.marks.map(mark => mark.serialize()),
-      _hasBetaBadge: this._hasBetaBadge,
-      _hasJumps: this._hasJumps,
-      _hasAIFixes: this._hasAIFixes,
-      editFieldName: this.editFieldName
-    };
-  }
-
-  /**
-   * Parses the object to an AssessmentResult.
-   *
-   * @param {Object} serialized The serialized object.
-   *
-   * @returns {AssessmentResult} The parsed AssessmentResult.
-   */
-  static parse(serialized) {
-    const result = new AssessmentResult({
-      text: serialized.text,
-      score: serialized.score,
-      marks: serialized.marks.map(mark => Mark.parse(mark)),
-      _hasBetaBadge: serialized._hasBetaBadge,
-      _hasJumps: serialized._hasJumps,
-      _hasAIFixes: serialized._hasAIFixes,
-      editFieldName: serialized.editFieldName
-    });
-    result.setIdentifier(serialized.identifier);
-
-    return result;
-  }
-}
-
-export default AssessmentResult;