@qualweb/cui-checks 0.1.1 → 0.2.0

package/src/index.ts

@@ -1,121 +0,0 @@
-import {
-  CUIOptions,
-  CUIChecksReport
-} from '@qualweb/cui-checks';
-import { Translate } from '@qualweb/locale';
-import * as rules from './lib/rules';
-import Check from './lib/Check.object';
-
-class CUIChecks {
-  private readonly rules: { [rule: string]: Check };
-  private readonly rulesToExecute: { [rule: string]: boolean };
-
-  private readonly report: CUIChecksReport;
-
-  constructor(locale: Translate, options?: CUIOptions) {
-    this.rules = {};
-    this.rulesToExecute = {};
-    this.report = {
-      type: 'cui-checks',
-      metadata: {
-        passed: 0,
-        warning: 0,
-        failed: 0,
-        inapplicable: 0
-      },
-      assertions: {}
-    };
-
-    for (const rule of Object.keys(rules) || []) {
-      const _rule = rule.replace(/_/g, '-');
-      //@ts-ignore
-      this.rules[_rule] = new rules[rule](locale);
-      this.rulesToExecute[_rule] = true;
-    }
-
-    if (options) {
-      this.configure(options);
-    }
-  }
-
-  public configure(options: CUIOptions): void {
-    this.resetConfiguration();
-    if (options.rules) {
-      options.rules = options.rules.map((r: string) => {
-        return r.toLowerCase().startsWith('qw') ? r.toUpperCase().trim() : r.trim();
-      });
-    }
-    if (options.exclude) {
-      options.exclude = options.exclude.map((r: string) => {
-        return r.toLowerCase().startsWith('qw') ? r.toUpperCase().trim() : r.trim();
-      });
-    }
-
-    for (const rule of Object.keys(this.rules) || []) {
-      if (options.principles && options.principles.length !== 0) {
-        if (options.levels && options.levels.length !== 0) {
-          if (!this.rules[rule].hasPrincipleAndLevels(options.principles, options.levels)) {
-            this.rulesToExecute[rule] = false;
-          }
-        } else if (!this.rules[rule].hasPrincipleAndLevels(options.principles, ['A', 'AA', 'AAA'])) {
-          this.rulesToExecute[rule] = false;
-        }
-      } else if (options.levels && options.levels.length !== 0) {
-        if (
-          !this.rules[rule].hasPrincipleAndLevels(
-            ['Perceivable', 'Operable', 'Understandable', 'Robust'],
-            options.levels
-          )
-        ) {
-          this.rulesToExecute[rule] = false;
-        }
-      }
-      if (!options.principles && !options.levels) {
-        if (options.rules && options.rules.length !== 0) {
-          if (!options.rules.includes(rule) && !options.rules.includes(this.rules[rule]?.getRuleMapping())) {
-            this.rulesToExecute[rule] = false;
-          } else {
-            this.rulesToExecute[rule] = true;
-          }
-        }
-      } else {
-        if (options.rules && options.rules.length !== 0) {
-          if (options.rules.includes(rule) || options.rules.includes(this.rules[rule]?.getRuleMapping())) {
-            this.rulesToExecute[rule] = true;
-          }
-        }
-      }
-      if (options.exclude && options.exclude.length !== 0) {
-        if (options.exclude.includes(rule) || options.exclude.includes(this.rules[rule]?.getRuleMapping())) {
-          this.rulesToExecute[rule] = false;
-        }
-      }
-    }
-  }
-
-  public resetConfiguration(): void {
-    for (const rule in this.rulesToExecute ?? {}) {
-      this.rulesToExecute[rule] = true;
-    }
-  }
-
-  public executeRule(rule: string, selector: string): void {
-    const elements = window.qwPage.getElements(selector);
-    if (elements.length > 0) {
-      for (const elem of elements ?? []) {
-        this.rules[rule].execute(elem);
-      }
-    } else {
-      this.rules[rule].execute(undefined);
-    }
-
-    this.report.assertions[rule] = this.rules[rule].getFinalResults();
-    this.report.metadata[this.report.assertions[rule].metadata.outcome]++;
-  }
-
-  public getReport(): CUIChecksReport {
-    return this.report;
-  }
-}
-
-export { CUIChecks };

package/src/lib/Check.object.ts

@@ -1,105 +0,0 @@
-import { CUICheck, TranslationValues } from '@qualweb/cui-checks';
-import { Translate } from '@qualweb/locale';
-import { Level, Principle } from '@qualweb/evaluation';
-
-import Test from '@qualweb/act-rules/src/lib/Test.object';
-
-abstract class Check {
-  protected readonly rule: CUICheck;
-  protected readonly locale: Translate;
-
-  constructor(rule: CUICheck, locale: Translate) {
-    this.rule = rule;
-    this.locale = locale;
-  }
-
-  abstract execute(element: typeof window.qwElement | undefined): void;
-  
-  public getRuleMapping(): string {
-    return this.rule.mapping;
-  }
-
-  public hasPrincipleAndLevels(principles: Array<Principle>, levels: Array<Level>): boolean {
-    let has = false;
-    for (const sc of this.rule.metadata['success-criteria'] ?? []) {
-      if (principles.includes(sc.principle) && levels.includes(sc.level)) {
-        has = true;
-      }
-    }
-    return has;
-  }
-
-  public getFinalResults(): CUICheck {
-    this.outcomeRule();
-    return this.rule;
-  }
-
-  protected getNumberOfPassedResults(): number {
-    return this.rule.metadata.passed;
-  }
-
-  protected getNumberOfWarningResults(): number {
-    return this.rule.metadata.warning;
-  }
-
-  protected getNumberOfFailedResults(): number {
-    return this.rule.metadata.failed;
-  }
-
-  protected addTestResult(test: Test): void {
-    if (!test.description || test.description.trim() === '') {
-      test.description = this.getTranslation(test.resultCode);
-    }
-
-    this.rule.results.push(test);
-
-    if (test.verdict && test.verdict !== 'inapplicable') {
-      this.rule.metadata[test.verdict]++;
-    }
-  }
-
-  protected getTranslation(resultCode: string, values?: TranslationValues): string {
-    let translation = '';
-    if (this.locale.translate['act-rules']?.[this.rule.code]?.results?.[resultCode]) {
-      translation = <string>this.locale.translate['act-rules'][this.rule.code].results?.[resultCode];
-    } else {
-      translation = <string>this.locale.fallback['act-rules']?.[this.rule.code].results?.[resultCode];
-    }
-
-    if (values) {
-      for (const key of Object.keys(values) || []) {
-        translation = translation.replace(new RegExp(`{${key}}`, 'g'), values[key].toString());
-      }
-    }
-
-    return translation;
-  }
-
-  private outcomeRule(): void {
-    if (this.rule.metadata.failed > 0) {
-      this.rule.metadata.outcome = 'failed';
-    } else if (this.rule.metadata.warning > 0) {
-      this.rule.metadata.outcome = 'warning';
-    } else if (this.rule.metadata.passed > 0) {
-      this.rule.metadata.outcome = 'passed';
-    } else {
-      this.rule.metadata.outcome = 'inapplicable';
-      this.rule.metadata.inapplicable = 1;
-    }
-
-    if (this.rule.results.length > 0) {
-      this.addDescription();
-    }
-  }
-
-  private addDescription(): void {
-    for (const result of this.rule.results ?? []) {
-      if (result.verdict === this.rule.metadata.outcome) {
-        this.rule.metadata.description = result.description;
-        break;
-      }
-    }
-  }
-}
-
-export = Check;

package/src/lib/Test.object.ts

@@ -1,40 +0,0 @@
-import { CUICheckResult, CUIElement } from '@qualweb/cui-checks';
-
-class Test implements CUICheckResult {
-  verdict: 'passed' | 'failed' | 'warning' | 'inapplicable';
-  description: string;
-  resultCode: string;
-  elements: Array<CUIElement>;
-  attributes: Array<string>;
-
-  constructor(verdict?: 'passed' | 'failed' | 'warning', description?: string, resultCode?: string) {
-    this.verdict = verdict ?? 'inapplicable';
-    this.description = description ?? '';
-    this.resultCode = resultCode ?? 'I1';
-    this.elements = new Array<CUICheckResult>();
-    this.attributes = new Array<string>();
-  }
-
-  public addElement(element: typeof window.qwElement, withText = true, fullElement = false, aName?: boolean): void {
-    const htmlCode = element.getElementHtmlCode(withText, fullElement);
-    const pointer = element.getElementSelector();
-    let accessibleName: string | undefined;
-    if (aName) {
-      accessibleName = window.AccessibilityUtils.getAccessibleName(element);
-    }
-    this.elements.push({ htmlCode, pointer, accessibleName });
-  }
-
-  public addElements(
-    elements: Array<typeof window.qwElement>,
-    withText = true,
-    fullElement = false,
-    aName?: boolean
-  ): void {
-    for (const element of elements ?? []) {
-      this.addElement(element, withText, fullElement, aName);
-    }
-  }
-}
-
-export = Test;