@instructure/ui-utils 8.52.1-snapshot-6 → 8.52.1-snapshot-11

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [8.52.1-snapshot-6](https://github.com/instructure/instructure-ui/compare/v8.52.0...v8.52.1-snapshot-6) (2024-02-07)
+## [8.52.1-snapshot-11](https://github.com/instructure/instructure-ui/compare/v8.52.0...v8.52.1-snapshot-11) (2024-02-08)
 
 **Note:** Version bump only for package @instructure/ui-utils
 

package/es/__new-tests__/camelize.test.js

@@ -0,0 +1,40 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import '@testing-library/jest-dom';
+import { camelize } from '../camelize';
+describe('convertCase', () => {
+  describe('camelize', () => {
+    it('handles hyphenated strings', () => {
+      expect(camelize('foo-bar')).toEqual('fooBar');
+      expect(camelize('baz-qux-foo')).toEqual('bazQuxFoo');
+      expect(camelize('xx-small')).toEqual('xxSmall');
+      expect(camelize('border-radius-x-large')).toEqual('borderRadiusXLarge');
+      expect(camelize('margin-xxLarge')).toEqual('marginXxLarge');
+    });
+    it('does not modify already camel cased strings', () => {
+      expect(camelize('fooBar')).toEqual('fooBar');
+      expect(camelize('bazQuxFoo')).toEqual('bazQuxFoo');
+    });
+  });
+});

package/es/__new-tests__/cloneArray.test.js

@@ -0,0 +1,52 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import '@testing-library/jest-dom';
+import { cloneArray } from '../cloneArray';
+import { deepEqual } from '../deepEqual';
+describe('cloneArray', () => {
+  it('should return an array', () => {
+    const arr = [['one', 'two'], ['three']];
+    const newArr = cloneArray(arr);
+    expect(Array.isArray(newArr)).toBeTruthy();
+  });
+  it('should preserve sub arrays', () => {
+    const arr = [['one', 'two'], ['three'], [4, 5, 6], [7, [8, 9, 10], 11, 12]];
+    const newArr = cloneArray(arr);
+    expect(newArr.length).toEqual(4);
+    expect(newArr[0].length).toEqual(2);
+    expect(newArr[2][1]).toEqual(5);
+    expect(Array.isArray(newArr[3][1])).toEqual(true);
+    expect(newArr[3][1][2]).toEqual(10);
+  });
+  it('should return a new array', () => {
+    const arr = [['one', 'two'], ['three']];
+    const newArr = cloneArray(arr);
+    expect(deepEqual(arr, newArr)).toEqual(true);
+    newArr[0][1] = '2';
+    expect(deepEqual(arr, newArr)).toEqual(false);
+    const newArr2 = cloneArray(arr);
+    arr[0][0] = '1';
+    expect(deepEqual(arr, newArr2)).toEqual(false);
+  });
+});

package/es/__new-tests__/createChainedFunction.test.js

@@ -0,0 +1,50 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import '@testing-library/jest-dom';
+import { createChainedFunction } from '../createChainedFunction';
+describe('createChainedFunction', () => {
+  it('should return null if no function provided', () => {
+    expect(createChainedFunction(null, void 0)).toEqual(null);
+  });
+  it('should return a function', () => {
+    expect(typeof createChainedFunction(() => {})).toEqual('function');
+  });
+  it('should throw an error if something other than function, null, undefined provided', () => {
+    expect(() => {
+      // @ts-expect-error intentionally bad code
+      createChainedFunction(12345);
+    }).toThrow(Error);
+  });
+  it('should execute all the functions', () => {
+    const spies = Array.from({
+      length: 5
+    }, () => jest.fn());
+    const chain = createChainedFunction(...spies);
+    chain();
+    spies.forEach(spy => {
+      expect(spy).toHaveBeenCalledTimes(1);
+    });
+  });
+});

package/es/__new-tests__/generateId.test.js

@@ -0,0 +1,60 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import '@testing-library/jest-dom';
+import { generateId } from '../generateId';
+describe('generateId', () => {
+  it('should generate unique ids for the same instance', () => {
+    const seed = new Map();
+    const component = 'TestComponent';
+    const inst1 = generateId(component, seed);
+    const inst2 = generateId(component, seed);
+    expect(inst1).not.toEqual(inst2);
+  });
+  it('should create ids deterministicly', () => {
+    const seed1 = new Map();
+    const component = 'TestComponent';
+
+    // Simulate rendering component: TestComponent
+    const render1 = generateId(component, seed1);
+
+    // Suppose we have a refresh, meaning the instanceCounter will be reseted:
+    const seed2 = new Map();
+    const render2 = generateId(component, seed2);
+    expect(render1).toEqual(render2);
+  });
+  it('should not create the same id for the same instance.', () => {
+    const counter = new Map();
+    const seed = new Map();
+    const component = 'TestComponent';
+    for (let i = 0; i <= 20000; i++) {
+      const id = generateId(component, seed);
+      if (!counter.has(id)) {
+        counter.set(id, false);
+      } else {
+        counter.set(id, true);
+      }
+      expect(counter.get(id)).toBe(false);
+    }
+  });
+});

package/es/__new-tests__/hash.test.js

@@ -0,0 +1,415 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import '@testing-library/jest-dom';
+import { hash } from '../hash';
+describe('hash', () => {
+  it('should error if supplied value is undefined', () => {
+    let error = false;
+    try {
+      expect(hash(void 0)).toEqual('');
+    } catch (err) {
+      error = true;
+    }
+    expect(error).toBe(true);
+  });
+  it('should allow specifying a max length', () => {
+    const result = hash('some value', 4);
+    expect(result).toBeDefined();
+    expect(result).toHaveLength(4);
+  });
+  describe('strings', () => {
+    it('hashes two identical strings to the same value', () => {
+      const result1 = hash('Some string with3_ distinct$() !_)(* va1ues');
+      const result2 = hash('Some string with3_ distinct$() !_)(* va1ues');
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+    it('hashes different strings to different values', () => {
+      const result1 = hash('Some string with3_ distinct$() !_)(* va1ues');
+      const result2 = hash('Some string with3_ distinct$() !_)(* va1ues ');
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).not.toEqual(result2);
+    });
+  });
+  describe('numbers', () => {
+    it('hashes two identical numbers to the same value', () => {
+      const result1 = hash(532);
+      const result2 = hash(532);
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+    it('hashes two different numbers to different values', () => {
+      const result1 = hash(532);
+      const result2 = hash(5321);
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).not.toEqual(result2);
+    });
+  });
+  describe('booleans', () => {
+    it('hashes true to the same value', () => {
+      const result1 = hash(true);
+      const result2 = hash(true);
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+    it('hashes false to the same value', () => {
+      const result1 = hash(false);
+      const result2 = hash(false);
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+    it('hashes true and false to different values', () => {
+      const result1 = hash(true);
+      const result2 = hash(false);
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).not.toEqual(result2);
+    });
+  });
+  describe('functions', () => {
+    it('hashes two identical arrow function expressions to the same value', () => {
+      const result1 = hash(() => 'foo');
+      const result2 = hash(() => 'foo');
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+    it('hashes two different arrow function expressions to different values', () => {
+      const result1 = hash(() => 'foo');
+      const result2 = hash(() => 'bar');
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).not.toEqual(result2);
+    });
+    it('hashes two identical functions to the same value', () => {
+      const result1 = hash(function myFunc() {
+        const foo = 1;
+        const bar = 2;
+        return foo + bar;
+      });
+      const result2 = hash(function myFunc() {
+        const foo = 1;
+        const bar = 2;
+        return foo + bar;
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+    it('hashes two identical functions with different names to different values', () => {
+      const result1 = hash(function myFunc() {
+        const foo = 1;
+        const bar = 2;
+        return foo + bar;
+      });
+      const result2 = hash(function myFunc1() {
+        const foo = 1;
+        const bar = 2;
+        return foo + bar;
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).not.toEqual(result2);
+    });
+    it('hashes two identical functions with different bodies to different values', () => {
+      const result1 = hash(function myFunc() {
+        const foo = 1;
+        const bar = 2;
+        return foo + bar;
+      });
+      const result2 = hash(function myFunc() {
+        const foo = 1;
+        const baz = 2;
+        return foo + baz;
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).not.toEqual(result2);
+    });
+  });
+  describe('objects', () => {
+    it('hashes two identical simple objects to the same value', () => {
+      const result1 = hash({
+        foo: 'foo',
+        bar: 'bar',
+        baz: 'baz'
+      });
+      const result2 = hash({
+        foo: 'foo',
+        bar: 'bar',
+        baz: 'baz'
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+    it('hashes two identical simple objects with rearranged keys to the same value', () => {
+      const result1 = hash({
+        foo: 'foo',
+        bar: 'bar',
+        baz: 'baz'
+      });
+      const result2 = hash({
+        baz: 'baz',
+        foo: 'foo',
+        bar: 'bar'
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+    it('hashes two different simple objects to different values', () => {
+      const result1 = hash({
+        foo: 'foo',
+        bar: 'bar',
+        baz: 'baz'
+      });
+      const result2 = hash({
+        foo: 'foo',
+        bar: 'ba',
+        baz: 'baz'
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).not.toEqual(result2);
+    });
+    it('hashes two identical complex objects to the same value', () => {
+      const result1 = hash({
+        foo: 'foo',
+        bar: [{
+          qux: 'qux',
+          qang: 'qaz'
+        }, {
+          ['foo-bar']: true
+        }],
+        baz: () => {
+          const hello = 'hello';
+          const world = 'world';
+          return hello + world;
+        }
+      });
+      const result2 = hash({
+        foo: 'foo',
+        bar: [{
+          qux: 'qux',
+          qang: 'qaz'
+        }, {
+          ['foo-bar']: true
+        }],
+        baz: () => {
+          const hello = 'hello';
+          const world = 'world';
+          return hello + world;
+        }
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+    it('hashes two identical complex objects with rearranged keys to the same value', () => {
+      const result1 = hash({
+        foo: 'foo',
+        bar: [{
+          qux: 'qux',
+          qang: 'qaz'
+        }, {
+          ['foo-bar']: true
+        }],
+        baz: () => {
+          const hello = 'hello';
+          const world = 'world';
+          return hello + world;
+        }
+      });
+      const result2 = hash({
+        bar: [{
+          qux: 'qux',
+          qang: 'qaz'
+        }, {
+          ['foo-bar']: true
+        }],
+        foo: 'foo',
+        baz: () => {
+          const hello = 'hello';
+          const world = 'world';
+          return hello + world;
+        }
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+    it('hashes two different simple objects to different values', () => {
+      const result1 = hash({
+        foo: 'foo',
+        bar: 'bar',
+        baz: 'baz'
+      });
+      const result2 = hash({
+        foo: 'foo',
+        bar: 'ba',
+        baz: 'baz'
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).not.toEqual(result2);
+    });
+    it('hashes two different complex objects to the same value', () => {
+      const result1 = hash({
+        foo: 'foo',
+        bar: [{
+          qux: 'qux',
+          qang: 'qaz'
+        }, {
+          ['foobar']: true
+        }],
+        baz: () => {
+          const hello = 'hello';
+          const world = 'world';
+          return hello + world;
+        }
+      });
+      const result2 = hash({
+        foo: 'foo',
+        bar: [{
+          qux: 'qux',
+          qang: 'qaz'
+        }, {
+          ['foo-bar']: true
+        }],
+        baz: () => {
+          const hello = 'hello';
+          const world = 'world';
+          return hello + world;
+        }
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).not.toEqual(result2);
+    });
+  });
+  describe('classes', () => {
+    it('hashes two identical classes to the same value', () => {
+      const result1 = hash(class Something {
+        constructor(settings) {
+          this._settings = void 0;
+          this.doSomething = () => {
+            return 'doing something';
+          };
+          this._settings = settings;
+        }
+        get settings() {
+          return this._settings;
+        }
+      });
+      const result2 = hash(class Something {
+        constructor(settings) {
+          this._settings = void 0;
+          this.doSomething = () => {
+            return 'doing something';
+          };
+          this._settings = settings;
+        }
+        get settings() {
+          return this._settings;
+        }
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+    it('hashes two classes with different content to different values', () => {
+      const result1 = hash(class Something {
+        constructor(settings) {
+          this._settings = void 0;
+          this.doSomething = () => {
+            return 'doing something';
+          };
+          this._settings = settings;
+        }
+        get settings() {
+          return this._settings;
+        }
+      });
+      const result2 = hash(class Something {
+        constructor(settings) {
+          this._settings = void 0;
+          this.doSomething = () => {
+            return 'doing something else';
+          };
+          this._settings = settings;
+        }
+        get settings() {
+          return this._settings;
+        }
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).not.toEqual(result2);
+    });
+    it('hashes two classes with different names to different values', () => {
+      const result1 = hash(class Something {
+        constructor(settings) {
+          this._settings = void 0;
+          this.doSomething = () => {
+            return 'doing something';
+          };
+          this._settings = settings;
+        }
+        get settings() {
+          return this._settings;
+        }
+      });
+      const result2 = hash(class Somethin {
+        constructor(settings) {
+          this._settings = void 0;
+          this.doSomething = () => {
+            return 'doing something';
+          };
+          this._settings = settings;
+        }
+        get settings() {
+          return this._settings;
+        }
+      });
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).not.toEqual(result2);
+    });
+    it('hashes null to the same value', () => {
+      const result1 = hash(null);
+      const result2 = hash(null);
+      expect(result1).toBeDefined();
+      expect(result2).toBeDefined();
+      expect(result1).toEqual(result2);
+    });
+  });
+});