axyseo 2.0.0-alpha.1

package/build/scoring/assessments/seo/UrlKeywordAssessment.js

@@ -0,0 +1,102 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _polaris = require("@shopify/polaris");
+var _lodash = require("lodash");
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents the Slug keyword assessment. This assessment checks if the keyword is present in the slug.
+ */
+class SlugKeywordAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} config   The configuration to use.
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: 'slugKeyword',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-in-url',
+      fixPosition: 'url handle',
+      ctaType: 'fix',
+      priority: 'medium',
+      title: 'Keyword in URL',
+      content: {
+        good: 'Keyword is included in URL.',
+        improve: '',
+        bad: 'Missing keyword in URL. Include it for relevance and better SEO.'
+      }
+    };
+    this.identifier = 'slugKeyword';
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+  }
+
+  /**
+   * Executes the Assessment and returns a result.
+   *
+   * @param {Paper}       paper       The Paper object to assess.
+   * @param {Researcher}  researcher  The Researcher object containing all available researches.
+   *
+   * @param i18n
+   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.
+   */
+  getResult(paper, researcher, i18n) {
+    this._keywordInSlug = researcher.getResearch('keywordCountInSlug');
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult(i18n);
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setBody(calculatedResult.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks whether the paper has a keyword and a slug.
+   *
+   * @param {Paper}       paper       The paper to use for the assessment.
+   * @param {Researcher}  researcher  The researcher object.
+   *
+   * @returns {boolean} True if the paper contains a keyword and a slug, and if the keywordCountInSlug research is available on the researcher.
+   */
+  isApplicable(paper, researcher) {
+    return !paper.isFrontPage() && paper.hasKeyword() && paper.hasSlug() && researcher.hasResearch('keywordCountInSlug');
+  }
+
+  /**
+   *
+   * @param i18n
+   * @returns {{score: number, body: React.JSX.Element, status: string}}
+   */
+  calculateResult(i18n) {
+    const status = (() => {
+      if (this._keywordInSlug.keyphraseLength < 3) {
+        return this._keywordInSlug.percentWordMatches === 100 ? 'good' : 'bad';
+      }
+      return this._keywordInSlug.percentWordMatches > 50 ? 'good' : 'bad';
+    })();
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status,
+      body: /*#__PURE__*/_react.default.createElement(_polaris.Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/_react.default.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, "Learn more"))
+    };
+  }
+}
+var _default = exports.default = SlugKeywordAssessment;
+//# sourceMappingURL=UrlKeywordAssessment.js.map

package/build/scoring/assessments/seo/UrlKeywordAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UrlKeywordAssessment.js","names":["_react","_interopRequireDefault","require","_polaris","_lodash","_assessment","_AssessmentResult","e","__esModule","default","SlugKeywordAssessment","Assessment","constructor","config","defaultConfig","id","docUrl","fixPosition","ctaType","priority","title","content","good","improve","bad","identifier","_config","merge","getResult","paper","researcher","i18n","_keywordInSlug","getResearch","assessmentResult","AssessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","setBody","body","isApplicable","isFrontPage","hasKeyword","hasSlug","hasResearch","keyphraseLength","percentWordMatches","getScore","createElement","Text","as","href","target","rel","_default","exports"],"sources":["../../../../src/scoring/assessments/seo/UrlKeywordAssessment.js"],"sourcesContent":["import React from 'react';\nimport {Text} from '@shopify/polaris';\nimport {merge} from 'lodash';\n\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\n\n/**\n * Represents the Slug keyword assessment. This assessment checks if the keyword is present in the slug.\n */\nclass SlugKeywordAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {Object} config   The configuration to use.\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: 'slugKeyword',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-in-url',\n      fixPosition: 'url handle',\n      ctaType: 'fix',\n      priority: 'medium',\n      title: 'Keyword in URL',\n      content: {\n        good: 'Keyword is included in URL.',\n        improve: '',\n        bad: 'Missing keyword in URL. Include it for relevance and better SEO.'\n      }\n    };\n\n    this.identifier = 'slugKeyword';\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Executes the Assessment and returns a result.\n   *\n   * @param {Paper}       paper       The Paper object to assess.\n   * @param {Researcher}  researcher  The Researcher object containing all available researches.\n   *\n   * @param i18n\n   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.\n   */\n  getResult(paper, researcher, i18n) {\n    this._keywordInSlug = researcher.getResearch('keywordCountInSlug');\n\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    const calculatedResult = this.calculateResult(i18n);\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setBody(calculatedResult.body);\n    return assessmentResult;\n  }\n\n  /**\n   * Checks whether the paper has a keyword and a slug.\n   *\n   * @param {Paper}       paper       The paper to use for the assessment.\n   * @param {Researcher}  researcher  The researcher object.\n   *\n   * @returns {boolean} True if the paper contains a keyword and a slug, and if the keywordCountInSlug research is available on the researcher.\n   */\n  isApplicable(paper, researcher) {\n    return (\n      !paper.isFrontPage() &&\n      paper.hasKeyword() &&\n      paper.hasSlug() &&\n      researcher.hasResearch('keywordCountInSlug')\n    );\n  }\n\n  /**\n   *\n   * @param i18n\n   * @returns {{score: number, body: React.JSX.Element, status: string}}\n   */\n  calculateResult(i18n) {\n    const status = (() => {\n      if (this._keywordInSlug.keyphraseLength < 3) {\n        return this._keywordInSlug.percentWordMatches === 100 ? 'good' : 'bad';\n      }\n      return this._keywordInSlug.percentWordMatches > 50 ? 'good' : 'bad';\n    })();\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              Learn more\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n}\n\nexport default SlugKeywordAssessment;\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;AACA,IAAAE,OAAA,GAAAF,OAAA;AAEA,IAAAG,WAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,iBAAA,GAAAL,sBAAA,CAAAC,OAAA;AAAgE,SAAAD,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEhE;AACA;AACA;AACA,MAAMG,qBAAqB,SAASC,mBAAU,CAAC;EAC7C;AACF;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,aAAa;MACjBC,MAAM,EACJ,4FAA4F;MAC9FC,WAAW,EAAE,YAAY;MACzBC,OAAO,EAAE,KAAK;MACdC,QAAQ,EAAE,QAAQ;MAClBC,KAAK,EAAE,gBAAgB;MACvBC,OAAO,EAAE;QACPC,IAAI,EAAE,6BAA6B;QACnCC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE;MACP;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,aAAa;IAC/B,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAACb,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEe,SAASA,CAACC,KAAK,EAAEC,UAAU,EAAEC,IAAI,EAAE;IACjC,IAAI,CAACC,cAAc,GAAGF,UAAU,CAACG,WAAW,CAAC,oBAAoB,CAAC;IAElE,MAAMC,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACtB,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErE,MAAMU,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACN,IAAI,CAAC;IAEnDG,gBAAgB,CAACI,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDL,gBAAgB,CAACM,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IACnDP,gBAAgB,CAACQ,OAAO,CAACN,gBAAgB,CAACO,IAAI,CAAC;IAC/C,OAAOT,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEU,YAAYA,CAACf,KAAK,EAAEC,UAAU,EAAE;IAC9B,OACE,CAACD,KAAK,CAACgB,WAAW,CAAC,CAAC,IACpBhB,KAAK,CAACiB,UAAU,CAAC,CAAC,IAClBjB,KAAK,CAACkB,OAAO,CAAC,CAAC,IACfjB,UAAU,CAACkB,WAAW,CAAC,oBAAoB,CAAC;EAEhD;;EAEA;AACF;AACA;AACA;AACA;EACEX,eAAeA,CAACN,IAAI,EAAE;IACpB,MAAMU,MAAM,GAAG,CAAC,MAAM;MACpB,IAAI,IAAI,CAACT,cAAc,CAACiB,eAAe,GAAG,CAAC,EAAE;QAC3C,OAAO,IAAI,CAACjB,cAAc,CAACkB,kBAAkB,KAAK,GAAG,GAAG,MAAM,GAAG,KAAK;MACxE;MACA,OAAO,IAAI,CAAClB,cAAc,CAACkB,kBAAkB,GAAG,EAAE,GAAG,MAAM,GAAG,KAAK;IACrE,CAAC,EAAE,CAAC;IAEJ,MAAMX,KAAK,GAAG,IAAI,CAACY,QAAQ,CAAC,IAAI,CAACzB,OAAO,CAACP,QAAQ,EAAEsB,MAAM,CAAC;IAE1D,OAAO;MACLF,KAAK;MACLE,MAAM;MACNE,IAAI,eACF3C,MAAA,CAAAS,OAAA,CAAA2C,aAAA,CAACjD,QAAA,CAAAkD,IAAI;QAACC,EAAE,EAAE;MAAO,GACd,IAAI,CAAC5B,OAAO,CAACL,OAAO,CAACoB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACf,OAAO,CAACV,MAAM,iBAClBhB,MAAA,CAAAS,OAAA,CAAA2C,aAAA;QAAGG,IAAI,EAAE,IAAI,CAAC7B,OAAO,CAACV,MAAO;QAACwC,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAAC,YAE5D,CAED;IAEV,CAAC;EACH;AACF;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAlD,OAAA,GAEcC,qBAAqB","ignoreList":[]}

package/build/scoring/assessments/seo/UrlLengthAssessment.js

@@ -0,0 +1,102 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _react = _interopRequireDefault(require("react"));
+var _polaris = require("@shopify/polaris");
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+var _assessment = _interopRequireDefault(require("../assessment"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents the assessment that checks whether there are three or more consecutive sentences beginning with the same word.
+ */
+class UrlLengthAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {object} config The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: 'urlLength',
+      priority: 'high',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#url-length',
+      fixPosition: 'url handle',
+      ctaType: 'fix',
+      title: 'URL length',
+      content: {
+        good: 'URL length is optimized, less than 75 characters.',
+        improve: '',
+        bad: 'Keep it less than 75 characters for better readability and SEO.'
+      }
+    };
+    this.identifier = 'urlLength';
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+  }
+
+  /**
+   *
+   * @param paper
+   * @param i18n
+   * @returns {{score: number, body: React.JSX.Element, status: string}}
+   */
+  calculateResult(paper, i18n) {
+    let status = '';
+    const length = paper.getDomain().length + paper.getSlug().length + 11;
+    if (length < 75) {
+      status = 'good';
+    } else {
+      status = 'bad';
+    }
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status,
+      body: /*#__PURE__*/_react.default.createElement(_polaris.Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/_react.default.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, "Learn more"))
+    };
+  }
+
+  /**
+   *
+   * @param paper
+   * @param researcher
+   * @param i18n
+   * @returns {AssessmentResult}
+   */
+  getResult(paper, researcher, i18n) {
+    const calculatedResult = this.calculateResult(paper, i18n);
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setBody(calculatedResult.body);
+    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 true;
+  }
+}
+exports.default = UrlLengthAssessment;
+//# sourceMappingURL=UrlLengthAssessment.js.map

package/build/scoring/assessments/seo/UrlLengthAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UrlLengthAssessment.js","names":["_lodash","require","_react","_interopRequireDefault","_polaris","_AssessmentResult","_assessment","e","__esModule","default","UrlLengthAssessment","Assessment","constructor","config","defaultConfig","id","priority","docUrl","fixPosition","ctaType","title","content","good","improve","bad","identifier","_config","merge","calculateResult","paper","i18n","status","length","getDomain","getSlug","score","getScore","body","createElement","Text","as","href","target","rel","getResult","researcher","calculatedResult","assessmentResult","AssessmentResult","setStatus","setBody","isApplicable","exports"],"sources":["../../../../src/scoring/assessments/seo/UrlLengthAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport React from 'react';\nimport {Text} from '@shopify/polaris';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\n\n/**\n * Represents the assessment that checks whether there are three or more consecutive sentences beginning with the same word.\n */\nexport default class UrlLengthAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {object} config The configuration to use.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: 'urlLength',\n      priority: 'high',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#url-length',\n      fixPosition: 'url handle',\n      ctaType: 'fix',\n      title: 'URL length',\n      content: {\n        good: 'URL length is optimized, less than 75 characters.',\n        improve: '',\n        bad: 'Keep it less than 75 characters for better readability and SEO.'\n      }\n    };\n\n    this.identifier = 'urlLength';\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   *\n   * @param paper\n   * @param i18n\n   * @returns {{score: number, body: React.JSX.Element, status: string}}\n   */\n  calculateResult(paper, i18n) {\n    let status = '';\n    const length = paper.getDomain().length + paper.getSlug().length + 11;\n\n    if (length < 75) {\n      status = 'good';\n    } else {\n      status = 'bad';\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              Learn more\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @param i18n\n   * @returns {AssessmentResult}\n   */\n  getResult(paper, researcher, i18n) {\n    const calculatedResult = this.calculateResult(paper, i18n);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setBody(calculatedResult.body);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if the sentence beginnings assessment is applicable to the paper.\n   *\n   * @param {Object}      paper       The paper to check.\n   * @param {Researcher}  researcher  The researcher object.\n   *\n   * @returns {boolean} Returns true if the language is available and the paper is not empty.\n   */\n  isApplicable(paper, researcher) {\n    return true;\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,QAAA,GAAAH,OAAA;AACA,IAAAI,iBAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,WAAA,GAAAH,sBAAA,CAAAF,OAAA;AAAuC,SAAAE,uBAAAI,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEvC;AACA;AACA;AACe,MAAMG,mBAAmB,SAASC,mBAAU,CAAC;EAC1D;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,WAAW;MACfC,QAAQ,EAAE,MAAM;MAChBC,MAAM,EACJ,wFAAwF;MAC1FC,WAAW,EAAE,YAAY;MACzBC,OAAO,EAAE,KAAK;MACdC,KAAK,EAAE,YAAY;MACnBC,OAAO,EAAE;QACPC,IAAI,EAAE,mDAAmD;QACzDC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE;MACP;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,WAAW;IAC7B,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAACb,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEe,eAAeA,CAACC,KAAK,EAAEC,IAAI,EAAE;IAC3B,IAAIC,MAAM,GAAG,EAAE;IACf,MAAMC,MAAM,GAAGH,KAAK,CAACI,SAAS,CAAC,CAAC,CAACD,MAAM,GAAGH,KAAK,CAACK,OAAO,CAAC,CAAC,CAACF,MAAM,GAAG,EAAE;IAErE,IAAIA,MAAM,GAAG,EAAE,EAAE;MACfD,MAAM,GAAG,MAAM;IACjB,CAAC,MAAM;MACLA,MAAM,GAAG,KAAK;IAChB;IAEA,MAAMI,KAAK,GAAG,IAAI,CAACC,QAAQ,CAAC,IAAI,CAACV,OAAO,CAACV,QAAQ,EAAEe,MAAM,CAAC;IAE1D,OAAO;MACLI,KAAK;MACLJ,MAAM;MACNM,IAAI,eACFnC,MAAA,CAAAO,OAAA,CAAA6B,aAAA,CAAClC,QAAA,CAAAmC,IAAI;QAACC,EAAE,EAAE;MAAO,GACd,IAAI,CAACd,OAAO,CAACL,OAAO,CAACU,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACL,OAAO,CAACT,MAAM,iBAClBf,MAAA,CAAAO,OAAA,CAAA6B,aAAA;QAAGG,IAAI,EAAE,IAAI,CAACf,OAAO,CAACT,MAAO;QAACyB,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAAC,YAE5D,CAED;IAEV,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,SAASA,CAACf,KAAK,EAAEgB,UAAU,EAAEf,IAAI,EAAE;IACjC,MAAMgB,gBAAgB,GAAG,IAAI,CAAClB,eAAe,CAACC,KAAK,EAAEC,IAAI,CAAC;IAC1D,MAAMiB,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACnC,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErEqB,gBAAgB,CAACE,SAAS,CAACH,gBAAgB,CAACf,MAAM,CAAC;IACnDgB,gBAAgB,CAACE,SAAS,CAACH,gBAAgB,CAACf,MAAM,CAAC;IACnDgB,gBAAgB,CAACG,OAAO,CAACJ,gBAAgB,CAACT,IAAI,CAAC;IAE/C,OAAOU,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEI,YAAYA,CAACtB,KAAK,EAAEgB,UAAU,EAAE;IAC9B,OAAO,IAAI;EACb;AACF;AAACO,OAAA,CAAA3C,OAAA,GAAAC,mBAAA","ignoreList":[]}

package/build/scoring/assessors/assessor.js

@@ -0,0 +1,248 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _AssessmentResult = _interopRequireDefault(require("../../values/AssessmentResult.js"));
+var _build = require("../../parse/build");
+var _LanguageProcessor = _interopRequireDefault(require("../../parse/language/LanguageProcessor.js"));
+var _missingArgument = _interopRequireDefault(require("../../errors/missingArgument.js"));
+var _errors = require("../../helpers/errors.js");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// External dependencies.
+
+// Internal dependencies.
+
+// The maximum score of individual assessment is 9. This is why we set the "score rating" here to 9.
+const ScoreRating = 9;
+
+/**
+ * The Assessor is a base class for all assessors.
+ */
+class Assessor {
+  /**
+   * Creates a new Assessor instance.
+   * @param {Researcher}	researcher	The researcher to use.
+   * @param {Object}		[options]	The assessor options.
+   */
+  constructor(researcher, options) {
+    this.type = 'assessor';
+    this.setResearcher(researcher);
+    this._assessments = [];
+    this._options = options || {};
+  }
+
+  /**
+   * Checks if the researcher is defined and sets it.
+   *
+   * @param   {Researcher} researcher The researcher to use in the assessor.
+   *
+   * @throws  {MissingArgument} Parameter needs to be a valid researcher object.
+   * @returns {void}
+   */
+  setResearcher(researcher) {
+    if ((0, _lodash.isUndefined)(researcher)) {
+      throw new _missingArgument.default('The assessor requires a researcher.');
+    }
+    this._researcher = researcher;
+  }
+
+  /**
+   * Gets all available assessments.
+   * @returns {Assessment[]} assessment
+   */
+  getAvailableAssessments() {
+    return this._assessments;
+  }
+
+  /**
+   * Checks whether the Assessment is applicable.
+   *
+   * @param {Assessment} assessment The Assessment object that needs to be checked.
+   * @param {Paper} paper The Paper object to check against.
+   * @param {Researcher} [researcher] The Researcher object containing additional information.
+   * @returns {boolean} Whether or not the Assessment is applicable.
+   */
+  isApplicable(assessment, paper, researcher) {
+    if (assessment.hasOwnProperty('isApplicable') || typeof assessment.isApplicable === 'function') {
+      return assessment.isApplicable(paper, researcher);
+    }
+    return true;
+  }
+
+  /**
+   * Determines whether an assessment has a marker.
+   *
+   * @param {Assessment} assessment The assessment to check for.
+   * @returns {boolean} Whether or not the assessment has a marker.
+   */
+  hasMarker(assessment) {
+    return (0, _lodash.isFunction)(this._options.marker) && (assessment.hasOwnProperty('getMarks') || typeof assessment.getMarks === 'function');
+  }
+
+  /**
+   * Returns the specific marker for this assessor.
+   *
+   * @returns {Function} The specific marker for this assessor.
+   */
+  getSpecificMarker() {
+    return this._options.marker;
+  }
+
+  /**
+   * Returns the paper that was most recently assessed.
+   *
+   * @returns {Paper} The paper that was most recently assessed.
+   */
+  getPaper() {
+    return this._lastPaper;
+  }
+
+  /**
+   * Runs the researches defined in the task list or the default researches.
+   *
+   * @param {Paper} paper The paper to run assessments on.
+   * @param i18n
+   * @returns {void}
+   */
+  assess(paper, i18n) {
+    this._researcher.setPaper(paper);
+    const languageProcessor = new _LanguageProcessor.default(this._researcher);
+    const shortcodes = paper._attributes && paper._attributes.shortcodes;
+    paper.setTree((0, _build.build)(paper, languageProcessor, shortcodes));
+    let assessments = this.getAvailableAssessments();
+    this.results = [];
+    assessments = (0, _lodash.filter)(assessments, function (assessment) {
+      return this.isApplicable(assessment, paper, this._researcher);
+    }.bind(this));
+    this.results = (0, _lodash.map)(assessments, assessment => this.executeAssessment({
+      paper,
+      researcher: this._researcher,
+      assessment,
+      i18n
+    }));
+    this._lastPaper = paper;
+  }
+
+  /**
+   * Executes an assessment and returns the AssessmentResult.
+   *
+   * @param {Paper} paper The paper to pass to the assessment.
+   * @param {Researcher} researcher The researcher to pass to the assessment.
+   * @param {Assessment} assessment The assessment to execute.
+   * @param i18n
+   * @returns {AssessmentResult} The result of the assessment.
+   */
+  executeAssessment({
+    paper,
+    researcher,
+    assessment,
+    i18n
+  }) {
+    let result;
+    try {
+      result = assessment.getResult(paper, researcher, i18n);
+      result.setIdentifier(assessment.identifier);
+    } catch (assessmentError) {
+      (0, _errors.showTrace)(assessmentError);
+      result = new _AssessmentResult.default();
+      result.setScore(-1);
+    }
+    return result;
+  }
+
+  /**
+   * Filters out all assessment results that have no score and no text.
+   *
+   * @returns {AssessmentResult[]} The array with all the valid assessments.
+   */
+  getValidResults() {
+    return (0, _lodash.filter)(this.results, function (result) {
+      return this.isValidResult(result);
+    }.bind(this));
+  }
+
+  /**
+   * Returns if an assessmentResult is valid.
+   *
+   * @param {AssessmentResult} assessmentResult The assessmentResult to validate.
+   * @returns {boolean} whether or not the result is valid.
+   */
+  isValidResult(assessmentResult) {
+    return assessmentResult.hasScore() && assessmentResult.hasText();
+  }
+
+  /**
+   * Returns the overall score. Calculates the total score by adding all scores and dividing these
+   * by the number of results times the ScoreRating.
+   *
+   * @returns {number} The overall score.
+   */
+  calculateOverallScore() {
+    const results = this.getValidResults();
+    const totalScore = results.reduce((total, assessmentResult) => total + assessmentResult.getScore(), 0);
+    return Math.round(totalScore / (results.length * ScoreRating) * 100) || 0;
+  }
+
+  /**
+   * Registers an assessment and adds it to the internal assessments object.
+   *
+   * @param {string} name The name of the assessment.
+   * @param {Assessment} assessment The object containing function to run as an assessment and it's requirements.
+   * @returns {boolean} Whether registering the assessment was successful.
+   */
+  addAssessment(name, assessment) {
+    if (!assessment.hasOwnProperty('identifier')) {
+      assessment.identifier = name;
+    }
+    // If the assessor already has the same assessment, remove it and replace it with the new assessment with the same identifier.
+    if (this.getAssessment(assessment.identifier)) {
+      this.removeAssessment(assessment.identifier);
+    }
+    this._assessments.push(assessment);
+    return true;
+  }
+
+  /**
+   * Removes a specific Assessment from the list of Assessments.
+   *
+   * @param {string} name The Assessment to remove from the list of assessments.
+   * @returns {void}
+   */
+  removeAssessment(name) {
+    const toDelete = (0, _lodash.findIndex)(this._assessments, function (assessment) {
+      return assessment.hasOwnProperty('identifier') && name === assessment.identifier;
+    });
+    if (-1 !== toDelete) {
+      this._assessments.splice(toDelete, 1);
+    }
+  }
+
+  /**
+   * Returns an assessment by identifier
+   *
+   * @param {string} identifier The identifier of the assessment.
+   * @returns {undefined|Assessment} The object if found, otherwise undefined.
+   */
+  getAssessment(identifier) {
+    return (0, _lodash.find)(this._assessments, function (assessment) {
+      return assessment.hasOwnProperty('identifier') && identifier === assessment.identifier;
+    });
+  }
+
+  /**
+   * Checks which of the available assessments are applicable and returns an array with applicable assessments.
+   *
+   * @returns {Assessment[]} The array with applicable assessments.
+   */
+  getApplicableAssessments() {
+    const availableAssessments = this.getAvailableAssessments();
+    return (0, _lodash.filter)(availableAssessments, function (availableAssessment) {
+      return this.isApplicable(availableAssessment, this.getPaper(), this._researcher);
+    }.bind(this));
+  }
+}
+var _default = exports.default = Assessor;
+//# sourceMappingURL=assessor.js.map

package/build/scoring/assessors/assessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assessor.js","names":["_lodash","require","_AssessmentResult","_interopRequireDefault","_build","_LanguageProcessor","_missingArgument","_errors","e","__esModule","default","ScoreRating","Assessor","constructor","researcher","options","type","setResearcher","_assessments","_options","isUndefined","MissingArgument","_researcher","getAvailableAssessments","isApplicable","assessment","paper","hasOwnProperty","hasMarker","isFunction","marker","getMarks","getSpecificMarker","getPaper","_lastPaper","assess","i18n","setPaper","languageProcessor","LanguageProcessor","shortcodes","_attributes","setTree","build","assessments","results","filter","bind","map","executeAssessment","result","getResult","setIdentifier","identifier","assessmentError","showTrace","AssessmentResult","setScore","getValidResults","isValidResult","assessmentResult","hasScore","hasText","calculateOverallScore","totalScore","reduce","total","getScore","Math","round","length","addAssessment","name","getAssessment","removeAssessment","push","toDelete","findIndex","splice","find","getApplicableAssessments","availableAssessments","availableAssessment","_default","exports"],"sources":["../../../src/scoring/assessors/assessor.js"],"sourcesContent":["// External dependencies.\nimport {filter, find, findIndex, isFunction, isUndefined, map} from 'lodash';\n\n// Internal dependencies.\nimport AssessmentResult from '../../values/AssessmentResult.js';\nimport {build} from '../../parse/build';\nimport LanguageProcessor from '../../parse/language/LanguageProcessor.js';\nimport MissingArgument from '../../errors/missingArgument.js';\nimport {showTrace} from '../../helpers/errors.js';\n\n// The maximum score of individual assessment is 9. This is why we set the \"score rating\" here to 9.\nconst ScoreRating = 9;\n\n/**\n * The Assessor is a base class for all assessors.\n */\nclass Assessor {\n  /**\n   * Creates a new Assessor instance.\n   * @param {Researcher}\tresearcher\tThe researcher to use.\n   * @param {Object}\t\t[options]\tThe assessor options.\n   */\n  constructor(researcher, options) {\n    this.type = 'assessor';\n    this.setResearcher(researcher);\n    this._assessments = [];\n\n    this._options = options || {};\n  }\n\n  /**\n   * Checks if the researcher is defined and sets it.\n   *\n   * @param   {Researcher} researcher The researcher to use in the assessor.\n   *\n   * @throws  {MissingArgument} Parameter needs to be a valid researcher object.\n   * @returns {void}\n   */\n  setResearcher(researcher) {\n    if (isUndefined(researcher)) {\n      throw new MissingArgument('The assessor requires a researcher.');\n    }\n    this._researcher = researcher;\n  }\n\n  /**\n   * Gets all available assessments.\n   * @returns {Assessment[]} assessment\n   */\n  getAvailableAssessments() {\n    return this._assessments;\n  }\n\n  /**\n   * Checks whether the Assessment is applicable.\n   *\n   * @param {Assessment} assessment The Assessment object that needs to be checked.\n   * @param {Paper} paper The Paper object to check against.\n   * @param {Researcher} [researcher] The Researcher object containing additional information.\n   * @returns {boolean} Whether or not the Assessment is applicable.\n   */\n  isApplicable(assessment, paper, researcher) {\n    if (\n      assessment.hasOwnProperty('isApplicable') ||\n      typeof assessment.isApplicable === 'function'\n    ) {\n      return assessment.isApplicable(paper, researcher);\n    }\n\n    return true;\n  }\n\n  /**\n   * Determines whether an assessment has a marker.\n   *\n   * @param {Assessment} assessment The assessment to check for.\n   * @returns {boolean} Whether or not the assessment has a marker.\n   */\n  hasMarker(assessment) {\n    return (\n      isFunction(this._options.marker) &&\n      (assessment.hasOwnProperty('getMarks') || typeof assessment.getMarks === 'function')\n    );\n  }\n\n  /**\n   * Returns the specific marker for this assessor.\n   *\n   * @returns {Function} The specific marker for this assessor.\n   */\n  getSpecificMarker() {\n    return this._options.marker;\n  }\n\n  /**\n   * Returns the paper that was most recently assessed.\n   *\n   * @returns {Paper} The paper that was most recently assessed.\n   */\n  getPaper() {\n    return this._lastPaper;\n  }\n\n  /**\n   * Runs the researches defined in the task list or the default researches.\n   *\n   * @param {Paper} paper The paper to run assessments on.\n   * @param i18n\n   * @returns {void}\n   */\n  assess(paper, i18n) {\n    this._researcher.setPaper(paper);\n\n    const languageProcessor = new LanguageProcessor(this._researcher);\n    const shortcodes = paper._attributes && paper._attributes.shortcodes;\n    paper.setTree(build(paper, languageProcessor, shortcodes));\n\n    let assessments = this.getAvailableAssessments();\n    this.results = [];\n\n    assessments = filter(\n      assessments,\n      function(assessment) {\n        return this.isApplicable(assessment, paper, this._researcher);\n      }.bind(this)\n    );\n\n    this.results = map(assessments, assessment =>\n      this.executeAssessment({\n        paper,\n        researcher: this._researcher,\n        assessment,\n        i18n\n      })\n    );\n    this._lastPaper = paper;\n  }\n\n  /**\n   * Executes an assessment and returns the AssessmentResult.\n   *\n   * @param {Paper} paper The paper to pass to the assessment.\n   * @param {Researcher} researcher The researcher to pass to the assessment.\n   * @param {Assessment} assessment The assessment to execute.\n   * @param i18n\n   * @returns {AssessmentResult} The result of the assessment.\n   */\n  executeAssessment({paper, researcher, assessment, i18n}) {\n    let result;\n\n    try {\n      result = assessment.getResult(paper, researcher, i18n);\n      result.setIdentifier(assessment.identifier);\n    } catch (assessmentError) {\n      showTrace(assessmentError);\n\n      result = new AssessmentResult();\n\n      result.setScore(-1);\n    }\n    return result;\n  }\n\n  /**\n   * Filters out all assessment results that have no score and no text.\n   *\n   * @returns {AssessmentResult[]} The array with all the valid assessments.\n   */\n  getValidResults() {\n    return filter(\n      this.results,\n      function(result) {\n        return this.isValidResult(result);\n      }.bind(this)\n    );\n  }\n\n  /**\n   * Returns if an assessmentResult is valid.\n   *\n   * @param {AssessmentResult} assessmentResult The assessmentResult to validate.\n   * @returns {boolean} whether or not the result is valid.\n   */\n  isValidResult(assessmentResult) {\n    return assessmentResult.hasScore() && assessmentResult.hasText();\n  }\n\n  /**\n   * Returns the overall score. Calculates the total score by adding all scores and dividing these\n   * by the number of results times the ScoreRating.\n   *\n   * @returns {number} The overall score.\n   */\n  calculateOverallScore() {\n    const results = this.getValidResults();\n\n    const totalScore = results.reduce(\n      (total, assessmentResult) => total + assessmentResult.getScore(),\n      0\n    );\n\n    return Math.round((totalScore / (results.length * ScoreRating)) * 100) || 0;\n  }\n\n  /**\n   * Registers an assessment and adds it to the internal assessments object.\n   *\n   * @param {string} name The name of the assessment.\n   * @param {Assessment} assessment The object containing function to run as an assessment and it's requirements.\n   * @returns {boolean} Whether registering the assessment was successful.\n   */\n  addAssessment(name, assessment) {\n    if (!assessment.hasOwnProperty('identifier')) {\n      assessment.identifier = name;\n    }\n    // If the assessor already has the same assessment, remove it and replace it with the new assessment with the same identifier.\n    if (this.getAssessment(assessment.identifier)) {\n      this.removeAssessment(assessment.identifier);\n    }\n\n    this._assessments.push(assessment);\n    return true;\n  }\n\n  /**\n   * Removes a specific Assessment from the list of Assessments.\n   *\n   * @param {string} name The Assessment to remove from the list of assessments.\n   * @returns {void}\n   */\n  removeAssessment(name) {\n    const toDelete = findIndex(this._assessments, function(assessment) {\n      return assessment.hasOwnProperty('identifier') && name === assessment.identifier;\n    });\n\n    if (-1 !== toDelete) {\n      this._assessments.splice(toDelete, 1);\n    }\n  }\n\n  /**\n   * Returns an assessment by identifier\n   *\n   * @param {string} identifier The identifier of the assessment.\n   * @returns {undefined|Assessment} The object if found, otherwise undefined.\n   */\n  getAssessment(identifier) {\n    return find(this._assessments, function(assessment) {\n      return assessment.hasOwnProperty('identifier') && identifier === assessment.identifier;\n    });\n  }\n\n  /**\n   * Checks which of the available assessments are applicable and returns an array with applicable assessments.\n   *\n   * @returns {Assessment[]} The array with applicable assessments.\n   */\n  getApplicableAssessments() {\n    const availableAssessments = this.getAvailableAssessments();\n    return filter(\n      availableAssessments,\n      function(availableAssessment) {\n        return this.isApplicable(availableAssessment, this.getPaper(), this._researcher);\n      }.bind(this)\n    );\n  }\n}\n\nexport default Assessor;\n"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AAGA,IAAAC,iBAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,MAAA,GAAAH,OAAA;AACA,IAAAI,kBAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,gBAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,OAAA,GAAAN,OAAA;AAAkD,SAAAE,uBAAAK,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AARlD;;AAGA;;AAOA;AACA,MAAMG,WAAW,GAAG,CAAC;;AAErB;AACA;AACA;AACA,MAAMC,QAAQ,CAAC;EACb;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,OAAO,EAAE;IAC/B,IAAI,CAACC,IAAI,GAAG,UAAU;IACtB,IAAI,CAACC,aAAa,CAACH,UAAU,CAAC;IAC9B,IAAI,CAACI,YAAY,GAAG,EAAE;IAEtB,IAAI,CAACC,QAAQ,GAAGJ,OAAO,IAAI,CAAC,CAAC;EAC/B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEE,aAAaA,CAACH,UAAU,EAAE;IACxB,IAAI,IAAAM,mBAAW,EAACN,UAAU,CAAC,EAAE;MAC3B,MAAM,IAAIO,wBAAe,CAAC,qCAAqC,CAAC;IAClE;IACA,IAAI,CAACC,WAAW,GAAGR,UAAU;EAC/B;;EAEA;AACF;AACA;AACA;EACES,uBAAuBA,CAAA,EAAG;IACxB,OAAO,IAAI,CAACL,YAAY;EAC1B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEM,YAAYA,CAACC,UAAU,EAAEC,KAAK,EAAEZ,UAAU,EAAE;IAC1C,IACEW,UAAU,CAACE,cAAc,CAAC,cAAc,CAAC,IACzC,OAAOF,UAAU,CAACD,YAAY,KAAK,UAAU,EAC7C;MACA,OAAOC,UAAU,CAACD,YAAY,CAACE,KAAK,EAAEZ,UAAU,CAAC;IACnD;IAEA,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEc,SAASA,CAACH,UAAU,EAAE;IACpB,OACE,IAAAI,kBAAU,EAAC,IAAI,CAACV,QAAQ,CAACW,MAAM,CAAC,KAC/BL,UAAU,CAACE,cAAc,CAAC,UAAU,CAAC,IAAI,OAAOF,UAAU,CAACM,QAAQ,KAAK,UAAU,CAAC;EAExF;;EAEA;AACF;AACA;AACA;AACA;EACEC,iBAAiBA,CAAA,EAAG;IAClB,OAAO,IAAI,CAACb,QAAQ,CAACW,MAAM;EAC7B;;EAEA;AACF;AACA;AACA;AACA;EACEG,QAAQA,CAAA,EAAG;IACT,OAAO,IAAI,CAACC,UAAU;EACxB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,MAAMA,CAACT,KAAK,EAAEU,IAAI,EAAE;IAClB,IAAI,CAACd,WAAW,CAACe,QAAQ,CAACX,KAAK,CAAC;IAEhC,MAAMY,iBAAiB,GAAG,IAAIC,0BAAiB,CAAC,IAAI,CAACjB,WAAW,CAAC;IACjE,MAAMkB,UAAU,GAAGd,KAAK,CAACe,WAAW,IAAIf,KAAK,CAACe,WAAW,CAACD,UAAU;IACpEd,KAAK,CAACgB,OAAO,CAAC,IAAAC,YAAK,EAACjB,KAAK,EAAEY,iBAAiB,EAAEE,UAAU,CAAC,CAAC;IAE1D,IAAII,WAAW,GAAG,IAAI,CAACrB,uBAAuB,CAAC,CAAC;IAChD,IAAI,CAACsB,OAAO,GAAG,EAAE;IAEjBD,WAAW,GAAG,IAAAE,cAAM,EAClBF,WAAW,EACX,UAASnB,UAAU,EAAE;MACnB,OAAO,IAAI,CAACD,YAAY,CAACC,UAAU,EAAEC,KAAK,EAAE,IAAI,CAACJ,WAAW,CAAC;IAC/D,CAAC,CAACyB,IAAI,CAAC,IAAI,CACb,CAAC;IAED,IAAI,CAACF,OAAO,GAAG,IAAAG,WAAG,EAACJ,WAAW,EAAEnB,UAAU,IACxC,IAAI,CAACwB,iBAAiB,CAAC;MACrBvB,KAAK;MACLZ,UAAU,EAAE,IAAI,CAACQ,WAAW;MAC5BG,UAAU;MACVW;IACF,CAAC,CACH,CAAC;IACD,IAAI,CAACF,UAAU,GAAGR,KAAK;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEuB,iBAAiBA,CAAC;IAACvB,KAAK;IAAEZ,UAAU;IAAEW,UAAU;IAAEW;EAAI,CAAC,EAAE;IACvD,IAAIc,MAAM;IAEV,IAAI;MACFA,MAAM,GAAGzB,UAAU,CAAC0B,SAAS,CAACzB,KAAK,EAAEZ,UAAU,EAAEsB,IAAI,CAAC;MACtDc,MAAM,CAACE,aAAa,CAAC3B,UAAU,CAAC4B,UAAU,CAAC;IAC7C,CAAC,CAAC,OAAOC,eAAe,EAAE;MACxB,IAAAC,iBAAS,EAACD,eAAe,CAAC;MAE1BJ,MAAM,GAAG,IAAIM,yBAAgB,CAAC,CAAC;MAE/BN,MAAM,CAACO,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrB;IACA,OAAOP,MAAM;EACf;;EAEA;AACF;AACA;AACA;AACA;EACEQ,eAAeA,CAAA,EAAG;IAChB,OAAO,IAAAZ,cAAM,EACX,IAAI,CAACD,OAAO,EACZ,UAASK,MAAM,EAAE;MACf,OAAO,IAAI,CAACS,aAAa,CAACT,MAAM,CAAC;IACnC,CAAC,CAACH,IAAI,CAAC,IAAI,CACb,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEY,aAAaA,CAACC,gBAAgB,EAAE;IAC9B,OAAOA,gBAAgB,CAACC,QAAQ,CAAC,CAAC,IAAID,gBAAgB,CAACE,OAAO,CAAC,CAAC;EAClE;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,qBAAqBA,CAAA,EAAG;IACtB,MAAMlB,OAAO,GAAG,IAAI,CAACa,eAAe,CAAC,CAAC;IAEtC,MAAMM,UAAU,GAAGnB,OAAO,CAACoB,MAAM,CAC/B,CAACC,KAAK,EAAEN,gBAAgB,KAAKM,KAAK,GAAGN,gBAAgB,CAACO,QAAQ,CAAC,CAAC,EAChE,CACF,CAAC;IAED,OAAOC,IAAI,CAACC,KAAK,CAAEL,UAAU,IAAInB,OAAO,CAACyB,MAAM,GAAG3D,WAAW,CAAC,GAAI,GAAG,CAAC,IAAI,CAAC;EAC7E;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE4D,aAAaA,CAACC,IAAI,EAAE/C,UAAU,EAAE;IAC9B,IAAI,CAACA,UAAU,CAACE,cAAc,CAAC,YAAY,CAAC,EAAE;MAC5CF,UAAU,CAAC4B,UAAU,GAAGmB,IAAI;IAC9B;IACA;IACA,IAAI,IAAI,CAACC,aAAa,CAAChD,UAAU,CAAC4B,UAAU,CAAC,EAAE;MAC7C,IAAI,CAACqB,gBAAgB,CAACjD,UAAU,CAAC4B,UAAU,CAAC;IAC9C;IAEA,IAAI,CAACnC,YAAY,CAACyD,IAAI,CAAClD,UAAU,CAAC;IAClC,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEiD,gBAAgBA,CAACF,IAAI,EAAE;IACrB,MAAMI,QAAQ,GAAG,IAAAC,iBAAS,EAAC,IAAI,CAAC3D,YAAY,EAAE,UAASO,UAAU,EAAE;MACjE,OAAOA,UAAU,CAACE,cAAc,CAAC,YAAY,CAAC,IAAI6C,IAAI,KAAK/C,UAAU,CAAC4B,UAAU;IAClF,CAAC,CAAC;IAEF,IAAI,CAAC,CAAC,KAAKuB,QAAQ,EAAE;MACnB,IAAI,CAAC1D,YAAY,CAAC4D,MAAM,CAACF,QAAQ,EAAE,CAAC,CAAC;IACvC;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEH,aAAaA,CAACpB,UAAU,EAAE;IACxB,OAAO,IAAA0B,YAAI,EAAC,IAAI,CAAC7D,YAAY,EAAE,UAASO,UAAU,EAAE;MAClD,OAAOA,UAAU,CAACE,cAAc,CAAC,YAAY,CAAC,IAAI0B,UAAU,KAAK5B,UAAU,CAAC4B,UAAU;IACxF,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;EACE2B,wBAAwBA,CAAA,EAAG;IACzB,MAAMC,oBAAoB,GAAG,IAAI,CAAC1D,uBAAuB,CAAC,CAAC;IAC3D,OAAO,IAAAuB,cAAM,EACXmC,oBAAoB,EACpB,UAASC,mBAAmB,EAAE;MAC5B,OAAO,IAAI,CAAC1D,YAAY,CAAC0D,mBAAmB,EAAE,IAAI,CAACjD,QAAQ,CAAC,CAAC,EAAE,IAAI,CAACX,WAAW,CAAC;IAClF,CAAC,CAACyB,IAAI,CAAC,IAAI,CACb,CAAC;EACH;AACF;AAAC,IAAAoC,QAAA,GAAAC,OAAA,CAAA1E,OAAA,GAEcE,QAAQ","ignoreList":[]}

package/build/scoring/assessors/avadaAssessor.js

@@ -0,0 +1,65 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _index = require("../../../scoring/assessors/index");
+var _helpers = require("../../../scoring/helpers");
+/**
+ * The AvadaAssessor class is used for the general SEO analysis.
+ */
+class AvadaAssessor {
+  /**
+   * Creates a new AvadaAssessor instance.
+   * @param {Researcher}  researcher  The researcher to use.
+   * @param {Object}    [options]  The assessor options.
+   */
+  constructor(researcher, options) {
+    const seoAssessor = new _index.SEOAssessor(researcher, options);
+    const contentAssessor = new _index.ContentAssessor(researcher, options);
+    this.seoAssessor = seoAssessor;
+    this.contentAssessor = contentAssessor;
+    this.researcher = researcher;
+  }
+  assess(paper, i18n) {
+    this.seoAssessor.assess(paper, i18n);
+    this.contentAssessor.assess(paper, i18n);
+    let assessments = [...this.seoAssessor.results, ...this.contentAssessor.results];
+    assessments = assessments.map(assessment => ({
+      ...assessment.config,
+      body: assessment.body,
+      status: assessment.status,
+      score: assessment.score,
+      title: assessment.title || assessment.config.title
+    }));
+    this.assessments = assessments;
+  }
+  getResult(groupBy = 'category', getScore = true) {
+    let assessments = [];
+    switch (groupBy) {
+      case 'category':
+        assessments = (0, _helpers.groupAssessmentsByCategory)(this.assessments);
+        break;
+      case 'status':
+        assessments = (0, _helpers.groupAssessmentsByStatus)(this.assessments);
+        break;
+    }
+    return {
+      assessments,
+      ...(getScore ? {
+        score: this.getScore()
+      } : {})
+    };
+  }
+  getScore() {
+    let point = 0;
+    this.assessments.forEach(assessment => {
+      point += assessment.score;
+    });
+    const maxPoint = (0, _helpers.getMaxPoint)(this.assessments);
+    return Math.round(point * 100 / maxPoint);
+  }
+}
+exports.default = AvadaAssessor;
+//# sourceMappingURL=avadaAssessor.js.map

package/build/scoring/assessors/avadaAssessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"avadaAssessor.js","names":["_index","require","_helpers","AvadaAssessor","constructor","researcher","options","seoAssessor","SEOAssessor","contentAssessor","ContentAssessor","assess","paper","i18n","assessments","results","map","assessment","config","body","status","score","title","getResult","groupBy","getScore","groupAssessmentsByCategory","groupAssessmentsByStatus","point","forEach","maxPoint","getMaxPoint","Math","round","exports","default"],"sources":["../../../src/scoring/assessors/avadaAssessor.js"],"sourcesContent":["import {ContentAssessor, SEOAssessor} from '../../../scoring/assessors/index';\nimport {\n  getMaxPoint,\n  groupAssessmentsByCategory,\n  groupAssessmentsByStatus\n} from '../../../scoring/helpers';\n\n/**\n * The AvadaAssessor class is used for the general SEO analysis.\n */\nexport default class AvadaAssessor {\n  /**\n   * Creates a new AvadaAssessor instance.\n   * @param {Researcher}  researcher  The researcher to use.\n   * @param {Object}    [options]  The assessor options.\n   */\n  constructor(researcher, options) {\n    const seoAssessor = new SEOAssessor(researcher, options);\n    const contentAssessor = new ContentAssessor(researcher, options);\n    this.seoAssessor = seoAssessor;\n    this.contentAssessor = contentAssessor;\n    this.researcher = researcher;\n  }\n\n  assess(paper, i18n) {\n    this.seoAssessor.assess(paper, i18n);\n    this.contentAssessor.assess(paper, i18n);\n\n    let assessments = [...this.seoAssessor.results, ...this.contentAssessor.results];\n    assessments = assessments.map(assessment => ({\n      ...assessment.config,\n      body: assessment.body,\n      status: assessment.status,\n      score: assessment.score,\n      title: assessment.title || assessment.config.title\n    }));\n    this.assessments = assessments;\n  }\n\n  getResult(groupBy = 'category', getScore = true) {\n    let assessments = [];\n    switch (groupBy) {\n      case 'category':\n        assessments = groupAssessmentsByCategory(this.assessments);\n        break;\n      case 'status':\n        assessments = groupAssessmentsByStatus(this.assessments);\n        break;\n    }\n\n    return {\n      assessments,\n      ...(getScore ? {score: this.getScore()} : {})\n    };\n  }\n\n  getScore() {\n    let point = 0;\n\n    this.assessments.forEach(assessment => {\n      point += assessment.score;\n    });\n\n    const maxPoint = getMaxPoint(this.assessments);\n    return Math.round((point * 100) / maxPoint);\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;AAMA;AACA;AACA;AACe,MAAME,aAAa,CAAC;EACjC;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,OAAO,EAAE;IAC/B,MAAMC,WAAW,GAAG,IAAIC,kBAAW,CAACH,UAAU,EAAEC,OAAO,CAAC;IACxD,MAAMG,eAAe,GAAG,IAAIC,sBAAe,CAACL,UAAU,EAAEC,OAAO,CAAC;IAChE,IAAI,CAACC,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACE,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACJ,UAAU,GAAGA,UAAU;EAC9B;EAEAM,MAAMA,CAACC,KAAK,EAAEC,IAAI,EAAE;IAClB,IAAI,CAACN,WAAW,CAACI,MAAM,CAACC,KAAK,EAAEC,IAAI,CAAC;IACpC,IAAI,CAACJ,eAAe,CAACE,MAAM,CAACC,KAAK,EAAEC,IAAI,CAAC;IAExC,IAAIC,WAAW,GAAG,CAAC,GAAG,IAAI,CAACP,WAAW,CAACQ,OAAO,EAAE,GAAG,IAAI,CAACN,eAAe,CAACM,OAAO,CAAC;IAChFD,WAAW,GAAGA,WAAW,CAACE,GAAG,CAACC,UAAU,KAAK;MAC3C,GAAGA,UAAU,CAACC,MAAM;MACpBC,IAAI,EAAEF,UAAU,CAACE,IAAI;MACrBC,MAAM,EAAEH,UAAU,CAACG,MAAM;MACzBC,KAAK,EAAEJ,UAAU,CAACI,KAAK;MACvBC,KAAK,EAAEL,UAAU,CAACK,KAAK,IAAIL,UAAU,CAACC,MAAM,CAACI;IAC/C,CAAC,CAAC,CAAC;IACH,IAAI,CAACR,WAAW,GAAGA,WAAW;EAChC;EAEAS,SAASA,CAACC,OAAO,GAAG,UAAU,EAAEC,QAAQ,GAAG,IAAI,EAAE;IAC/C,IAAIX,WAAW,GAAG,EAAE;IACpB,QAAQU,OAAO;MACb,KAAK,UAAU;QACbV,WAAW,GAAG,IAAAY,mCAA0B,EAAC,IAAI,CAACZ,WAAW,CAAC;QAC1D;MACF,KAAK,QAAQ;QACXA,WAAW,GAAG,IAAAa,iCAAwB,EAAC,IAAI,CAACb,WAAW,CAAC;QACxD;IACJ;IAEA,OAAO;MACLA,WAAW;MACX,IAAIW,QAAQ,GAAG;QAACJ,KAAK,EAAE,IAAI,CAACI,QAAQ,CAAC;MAAC,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;EACH;EAEAA,QAAQA,CAAA,EAAG;IACT,IAAIG,KAAK,GAAG,CAAC;IAEb,IAAI,CAACd,WAAW,CAACe,OAAO,CAACZ,UAAU,IAAI;MACrCW,KAAK,IAAIX,UAAU,CAACI,KAAK;IAC3B,CAAC,CAAC;IAEF,MAAMS,QAAQ,GAAG,IAAAC,oBAAW,EAAC,IAAI,CAACjB,WAAW,CAAC;IAC9C,OAAOkB,IAAI,CAACC,KAAK,CAAEL,KAAK,GAAG,GAAG,GAAIE,QAAQ,CAAC;EAC7C;AACF;AAACI,OAAA,CAAAC,OAAA,GAAAhC,aAAA","ignoreList":[]}