@instructure/canvas-rce 5.6.2 → 5.6.3

package/lib/translated/en_CY/modules/rce/plugins/instructure_wordcount/utils/__tests__/countContent.test.js

@@ -1,164 +0,0 @@
-/*
- * Copyright (C) 2022 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-import { countWords, countCharsNoSpaces, countChars, callbackForCategory, countShouldIgnore, getTinymceCount, countContent, IGNORE_ATTRIBUTE } from '../countContent';
-const editor = {
-  getBody: () => ({
-    querySelectorAll: () => [createNode('hello world'), createNode('hi again')]
-  }),
-  plugins: {
-    wordcount: {
-      body: {
-        getWordCount: () => 50,
-        getCharacterCountWithoutSpaces: () => 51,
-        getCharacterCount: () => 52
-      },
-      selection: {
-        getWordCount: () => 53,
-        getCharacterCountWithoutSpaces: () => 54,
-        getCharacterCount: () => 55
-      }
-    }
-  }
-};
-
-const createNode = function (content) {
-  let charsOnly = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-  const node = document.createElement('p');
-  node.setAttribute(IGNORE_ATTRIBUTE, charsOnly ? 'chars-only' : '');
-  node.innerText = content;
-  return node;
-};
-
-describe('countWords', () => {
-  it('returns 0 if the ignore attribute is "chars-only"', () => {
-    const node = createNode('abc', true);
-    expect(countWords(node)).toEqual(0);
-  });
-  it('returns 0 if the text content is the empty string', () => {
-    const node = createNode('');
-    expect(countWords(node)).toEqual(0);
-  });
-  it('returns 0 if the text content is only whitespace', () => {
-    const node = createNode('  ');
-    expect(countWords(node)).toEqual(0);
-  });
-  it('returns the number of words (whitespace delimited)', () => {
-    const node = createNode('a  b c      d');
-    expect(countWords(node)).toEqual(4);
-  });
-});
-describe('countChars', () => {
-  it('returns 0 if the text content is the empty string', () => {
-    const node = createNode('');
-    expect(countChars(node)).toEqual(0);
-  });
-  it('handles invisible and nonstandard length characters', () => {
-    // first one is invisible char U+2062
-    ;
-    ['⁢', '👉', '𝟈'].forEach(char => {
-      const node = createNode(char);
-      expect(countChars(node)).toEqual(1);
-    });
-  });
-  it('otherwise handles normal strings of characters', () => {
-    ;
-    ['abc', 'a b c', 'somethingsomething'].forEach(str => {
-      const node = createNode(str);
-      expect(countChars(node)).toEqual(str.length);
-    });
-  });
-});
-describe('countCharsNoSpaces', () => {
-  it('returns 0 if the text content is the empty string', () => {
-    const node = createNode('');
-    expect(countCharsNoSpaces(node)).toEqual(0);
-  });
-  it('returns 0 if the text content is only spaces', () => {
-    const node = createNode(' ');
-    expect(countCharsNoSpaces(node)).toEqual(0);
-  });
-  it('returns the character count minus the number of spaces', () => {
-    const node = createNode('123       '); // 7 spaces
-
-    expect(countCharsNoSpaces(node)).toEqual(3);
-  });
-  it('returns the character count if there are no spaces spaces', () => {
-    const node = createNode('123');
-    expect(countCharsNoSpaces(node)).toEqual(3);
-  });
-});
-describe('callbackForCategory', () => {
-  it('returns countWords for "words"', () => {
-    expect(callbackForCategory('words')).toEqual(countWords);
-  });
-  it('returns countCharsNoSpaces for "chars-no-spaces"', () => {
-    expect(callbackForCategory('chars-no-spaces')).toEqual(countCharsNoSpaces);
-  });
-  it('returns countChars for "chars"', () => {
-    expect(callbackForCategory('chars')).toEqual(countChars);
-  });
-});
-describe('countShouldIgnore', () => {
-  it('returns 0 if scope is selection', () => {
-    expect(countShouldIgnore(editor, 'selection', 'words')).toEqual(0);
-  });
-  it('counts correctly using the callback for "words"', () => {
-    expect(countShouldIgnore(editor, 'body', 'words')).toEqual(4);
-  });
-  it('counts correctly using the callback for "chars-no-spaces"', () => {
-    expect(countShouldIgnore(editor, 'body', 'chars-no-spaces')).toEqual(17);
-  });
-  it('counts correctly using the callback for "chars"', () => {
-    expect(countShouldIgnore(editor, 'body', 'chars')).toEqual(19);
-  });
-});
-describe('getTinymceCount', () => {
-  it('returns the appropriate value for each input combination', () => {
-    const scopes = ['body', 'selection'];
-    const categories = ['words', 'chars-no-spaces', 'chars'];
-    let expectedValue = 50;
-    scopes.forEach(scope => {
-      categories.forEach(category => {
-        expect(getTinymceCount(editor, scope, category)).toEqual(expectedValue);
-        expectedValue++;
-      });
-    });
-  });
-});
-describe('countContent', () => {
-  describe('returns getTinymceCount less countShouldIgnore', () => {
-    it('for "body" + "words"', () => {
-      expect(countContent(editor, 'body', 'words')).toEqual(50 - 4);
-    });
-    it('for "body" + "chars-no-spaces"', () => {
-      expect(countContent(editor, 'body', 'chars-no-spaces')).toEqual(51 - 17);
-    });
-    it('for "body" + "chars"', () => {
-      expect(countContent(editor, 'body', 'chars')).toEqual(52 - 19);
-    });
-    it('for "selection" + "words"', () => {
-      expect(countContent(editor, 'selection', 'words')).toEqual(53 - 0);
-    });
-    it('for "selection" + "chars-no-spaces"', () => {
-      expect(countContent(editor, 'selection', 'chars-no-spaces')).toEqual(54 - 0);
-    });
-    it('for "selection" + "chars"', () => {
-      expect(countContent(editor, 'selection', 'chars')).toEqual(55 - 0);
-    });
-  });
-});

package/lib/translated/en_CY/modules/rce/plugins/instructure_wordcount/utils/__tests__/tableContent.test.js

@@ -1,41 +0,0 @@
-/*
- * Copyright (C) 2022 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-import { generateRows } from '../tableContent';
-jest.mock('../countContent', () => {
-  return {
-    countContent: () => 0
-  };
-});
-const editor = {};
-describe('generateRows', () => {
-  it('creates the expected row structure', () => {
-    expect(generateRows(editor)).toEqual([{
-      label: 'Words',
-      documentCount: 0,
-      selectionCount: 0
-    }, {
-      label: 'Characters (no spaces)',
-      documentCount: 0,
-      selectionCount: 0
-    }, {
-      label: 'Characters',
-      documentCount: 0,
-      selectionCount: 0
-    }]);
-  });
-});

package/lib/translated/en_CY/modules/rce/plugins/instructure_wordcount/utils/countContent.js

@@ -1,78 +0,0 @@
-/*
- * Copyright (C) 2022 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-export const IGNORE_ATTRIBUTE = 'data-ignore-wordcount';
-export const countWords = node => {
-  if (node.getAttribute(IGNORE_ATTRIBUTE) === 'chars-only') return 0;
-  const textContent = (node === null || node === void 0 ? void 0 : node.innerText) || '';
-  const trimmedTextContent = textContent.trim();
-  if (trimmedTextContent.length === 0) return 0;
-  return trimmedTextContent.split(/\s+/).length;
-};
-export const countCharsNoSpaces = node => {
-  const textContent = (node === null || node === void 0 ? void 0 : node.innerText) || '';
-  const matches = textContent.match(/ /g); // a single space
-
-  const spaces = matches ? matches.length : 0;
-  return countChars(node) - spaces;
-};
-export const countChars = node => {
-  const textContent = (node === null || node === void 0 ? void 0 : node.innerText) || '';
-  const iterator = textContent[Symbol.iterator]();
-  let count = 0;
-
-  while (!iterator.next().done) {
-    count++;
-  }
-
-  return count;
-};
-export const callbackForCategory = category => {
-  switch (category) {
-    case 'words':
-      return countWords;
-
-    case 'chars-no-spaces':
-      return countCharsNoSpaces;
-
-    case 'chars':
-      return countChars;
-  }
-};
-export const countShouldIgnore = (ed, scope, category) => {
-  if (scope === 'selection') return 0;
-  const nodesToCount = Array.from(ed.getBody().querySelectorAll(`[${IGNORE_ATTRIBUTE}]`));
-  const callback = callbackForCategory(category);
-  return nodesToCount.reduce((total, node) => total + callback(node), 0);
-};
-export const getTinymceCount = (ed, scope, category) => {
-  const wc = ed.plugins.wordcount[scope];
-
-  switch (category) {
-    case 'words':
-      return wc.getWordCount();
-
-    case 'chars-no-spaces':
-      return wc.getCharacterCountWithoutSpaces();
-
-    case 'chars':
-      return wc.getCharacterCount();
-  }
-};
-export const countContent = (ed, scope, category) => {
-  return getTinymceCount(ed, scope, category) - countShouldIgnore(ed, scope, category);
-};

package/lib/translated/en_CY/modules/rce/plugins/instructure_wordcount/utils/tableContent.js

@@ -1,40 +0,0 @@
-/*
- * Copyright (C) 2022 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-import { countContent } from './countContent';
-import formatMessage from '../../../../format-message';
-export const HEADERS = [{
-  id: 'count',
-  label: "Count"
-}, {
-  id: 'document',
-  label: "Document"
-}, {
-  id: 'selection',
-  label: "Selection"
-}];
-const ROW_LABELS = [['words', "Words"], ['chars-no-spaces', "Characters (no spaces)"], ['chars', "Characters"]];
-export const generateRows = ed => {
-  return ROW_LABELS.map(_ref => {
-    let [category, label] = _ref;
-    return {
-      label,
-      documentCount: countContent(ed, 'body', category),
-      selectionCount: countContent(ed, 'selection', category)
-    };
-  });
-};

package/lib/translated/en_GB/modules/rce/plugins/instructure_wordcount/clickCallback.js

@@ -1,46 +0,0 @@
-/*
- * Copyright (C) 2022 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-import React from 'react';
-import ReactDOM from 'react-dom';
-import { generateRows, HEADERS } from './utils/tableContent';
-const MODAL_ID = 'canvas-rce-wordcount-container';
-export default function (ed, document) {
-  return import('./components/WordCountModal').then(_ref => {
-    let {
-      WordCountModal
-    } = _ref;
-    let container = document.querySelector(`#${MODAL_ID}`);
-
-    if (!container) {
-      container = document.createElement('div');
-      container.id = MODAL_ID;
-      document.body.appendChild(container);
-    }
-
-    const handleDismiss = () => {
-      ReactDOM.unmountComponentAtNode(container);
-      ed.focus(false);
-    };
-
-    ReactDOM.render( /*#__PURE__*/React.createElement(WordCountModal, {
-      headers: HEADERS,
-      rows: generateRows(ed),
-      onDismiss: handleDismiss
-    }), container);
-  });
-}

package/lib/translated/en_GB/modules/rce/plugins/instructure_wordcount/components/WordCountModal.js

@@ -1,91 +0,0 @@
-import _pt from "prop-types";
-
-/*
- * Copyright (C) 2022 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-import React from 'react';
-import { Modal } from '@instructure/ui-modal';
-import { BaseButton, CloseButton } from '@instructure/ui-buttons';
-import { Heading } from '@instructure/ui-heading';
-import { Table } from '@instructure/ui-table';
-import formatMessage from '../../../../format-message';
-// Doing this to avoid TS2339 errors -- TODO: remove once we're on InstUI 8
-const {
-  Head,
-  Row,
-  ColHeader,
-  Body,
-  Cell
-} = Table;
-
-const renderBody = (headers, rows) => {
-  return /*#__PURE__*/React.createElement(Table, {
-    caption: "Word Count"
-  }, /*#__PURE__*/React.createElement(Head, null, /*#__PURE__*/React.createElement(Row, null, headers.map(_ref => {
-    let {
-      id,
-      label
-    } = _ref;
-    return /*#__PURE__*/React.createElement(ColHeader, {
-      key: id,
-      id: id
-    }, label);
-  }))), /*#__PURE__*/React.createElement(Body, null, rows.map(_ref2 => {
-    let {
-      label,
-      documentCount,
-      selectionCount
-    } = _ref2;
-    return /*#__PURE__*/React.createElement(Row, {
-      key: label
-    }, /*#__PURE__*/React.createElement(Cell, {
-      key: "label"
-    }, label), /*#__PURE__*/React.createElement(Cell, {
-      key: "document"
-    }, documentCount), /*#__PURE__*/React.createElement(Cell, {
-      key: "selection"
-    }, selectionCount));
-  })));
-};
-
-export const WordCountModal = _ref3 => {
-  let {
-    headers,
-    rows,
-    onDismiss
-  } = _ref3;
-  return /*#__PURE__*/React.createElement(Modal, {
-    label: "Word Count",
-    open: true
-  }, /*#__PURE__*/React.createElement(Modal.Header, null, /*#__PURE__*/React.createElement(CloseButton, {
-    placement: "end",
-    offset: "medium",
-    color: "primary",
-    onClick: onDismiss,
-    screenReaderLabel: "Close"
-  }), /*#__PURE__*/React.createElement(Heading, null, "Word Count")), /*#__PURE__*/React.createElement(Modal.Body, {
-    padding: "x-large"
-  }, renderBody(headers, rows)), /*#__PURE__*/React.createElement(Modal.Footer, null, /*#__PURE__*/React.createElement(BaseButton, {
-    onClick: onDismiss,
-    "data-testid": "footer-close-button"
-  }, "Close")));
-};
-WordCountModal.propTypes = {
-  headers: _pt.array.isRequired,
-  rows: _pt.array.isRequired,
-  onDismiss: _pt.func.isRequired
-};

package/lib/translated/en_GB/modules/rce/plugins/instructure_wordcount/components/__tests__/WordCountModal.test.js

@@ -1,91 +0,0 @@
-/*
- * Copyright (C) 2022 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-import React from 'react';
-import { fireEvent, render } from '@testing-library/react';
-import { WordCountModal } from '../WordCountModal';
-import { HEADERS } from '../../utils/tableContent';
-const defaultProps = {
-  headers: HEADERS,
-  rows: [{
-    label: 'Words',
-    documentCount: 0,
-    selectionCount: 1
-  }, {
-    label: 'Characters (no spaces)',
-    documentCount: 2,
-    selectionCount: 3
-  }, {
-    label: 'Characters',
-    documentCount: 4,
-    selectionCount: 5
-  }],
-  onDismiss: jest.fn()
-};
-
-const renderModal = function () {
-  let overrideProps = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  return render( /*#__PURE__*/React.createElement(WordCountModal, Object.assign({}, defaultProps, overrideProps)));
-};
-
-describe('WordCountModal', () => {
-  describe('onDismiss', () => {
-    it('is called when the header close button is clicked', () => {
-      const {
-        getAllByText
-      } = renderModal();
-      fireEvent.click(getAllByText(/close/i)[0]);
-      expect(defaultProps.onDismiss).toHaveBeenCalled();
-    });
-    it('is called when the footer close button is clicked', () => {
-      const {
-        getByTestId
-      } = renderModal();
-      fireEvent.click(getByTestId('footer-close-button'));
-      expect(defaultProps.onDismiss).toHaveBeenCalled();
-    });
-  });
-  describe('headers', () => {
-    it('are rendered', () => {
-      const {
-        getByRole
-      } = renderModal();
-      defaultProps.headers.forEach(header => {
-        expect(getByRole('columnheader', {
-          name: header.label
-        })).toBeInTheDocument();
-      });
-    });
-  });
-  describe('rows', () => {
-    it('are rendered', () => {
-      const {
-        getByRole
-      } = renderModal();
-      defaultProps.rows.forEach(_ref => {
-        let {
-          label,
-          documentCount,
-          selectionCount
-        } = _ref;
-        expect(getByRole('row', {
-          name: `${label} ${documentCount} ${selectionCount}`
-        })).toBeInTheDocument();
-      });
-    });
-  });
-});

package/lib/translated/en_GB/modules/rce/plugins/instructure_wordcount/plugin.js

@@ -1,32 +0,0 @@
-/*
- * Copyright (C) 2022 - present Instructure, Inc.
- *
- * This file is part of Canvas.
- *
- * Canvas is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, version 3 of the License.
- *
- * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-import tinymce from 'tinymce';
-import formatMessage from '../../../format-message';
-import clickCallback from './clickCallback';
-tinymce.create('tinymce.plugins.InstructureWordcount', {
-  init(ed) {
-    ed.addCommand('instructureWordcount', clickCallback.bind(this, ed, document));
-    ed.ui.registry.addMenuItem('instructure_wordcount', {
-      text: "Word Count",
-      icon: 'character-count',
-      onAction: () => ed.execCommand('instructureWordcount')
-    });
-  }
-
-});
-tinymce.PluginManager.add('instructure_wordcount', tinymce.plugins.InstructureWordcount);