@instructure/ui-utils 8.52.1-snapshot-5 → 8.52.1-snapshot-7

package/lib/__new-tests__/parseUnit.test.js

@@ -0,0 +1,71 @@
+"use strict";
+
+require("@testing-library/jest-dom");
+var _parseUnit = require("../parseUnit");
+/*
+ * 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.
+ */
+
+describe('parseUnit', () => {
+  it('unitless', () => {
+    expect((0, _parseUnit.parseUnit)('50')[0]).toEqual(50);
+  });
+  it('integer', () => {
+    expect((0, _parseUnit.parseUnit)(50)[0]).toEqual(50);
+  });
+  it('decimal', () => {
+    expect((0, _parseUnit.parseUnit)(47.89101)[0]).toEqual(47.89101);
+  });
+  it('negative', () => {
+    expect((0, _parseUnit.parseUnit)('-20px')[0]).toEqual(-20);
+    expect((0, _parseUnit.parseUnit)('-20px')[1]).toEqual('px');
+  });
+  it('px', () => {
+    expect((0, _parseUnit.parseUnit)('100.0792px')[0]).toEqual(100.0792);
+    expect((0, _parseUnit.parseUnit)('100.0792px')[1]).toEqual('px');
+  });
+  it('rem', () => {
+    expect((0, _parseUnit.parseUnit)('4000rem')[0]).toEqual(4000);
+    expect((0, _parseUnit.parseUnit)('4000rem')[1]).toEqual('rem');
+  });
+  it('em', () => {
+    expect((0, _parseUnit.parseUnit)('300em')[0]).toEqual(300);
+    expect((0, _parseUnit.parseUnit)('300em')[1]).toEqual('em');
+  });
+  it('s', () => {
+    expect((0, _parseUnit.parseUnit)('5s')[0]).toEqual(5);
+    expect((0, _parseUnit.parseUnit)('5s')[1]).toEqual('s');
+  });
+  it('ms', () => {
+    expect((0, _parseUnit.parseUnit)('20ms')[0]).toEqual(20);
+    expect((0, _parseUnit.parseUnit)('20ms')[1]).toEqual('ms');
+  });
+  it('vh', () => {
+    expect((0, _parseUnit.parseUnit)('327vh')[0]).toEqual(327);
+    expect((0, _parseUnit.parseUnit)('327vh')[1]).toEqual('vh');
+  });
+  it('vmin', () => {
+    expect((0, _parseUnit.parseUnit)('70vmin')[0]).toEqual(70);
+    expect((0, _parseUnit.parseUnit)('70vmin')[1]).toEqual('vmin');
+  });
+});

package/lib/__new-tests__/pascalize.test.js

@@ -0,0 +1,50 @@
+"use strict";
+
+require("@testing-library/jest-dom");
+var _pascalize = require("../pascalize");
+/*
+ * 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.
+ */
+
+describe('convertCase', () => {
+  describe('pascalize', () => {
+    it('handles hyphenated strings', () => {
+      expect((0, _pascalize.pascalize)('foo-bar')).toEqual('FooBar');
+      expect((0, _pascalize.pascalize)('baz-qux-foo')).toEqual('BazQuxFoo');
+      expect((0, _pascalize.pascalize)('x-large')).toEqual('XLarge');
+      expect((0, _pascalize.pascalize)('x-x-small')).toEqual('XXSmall');
+    });
+    it('handles camel cased strings', () => {
+      expect((0, _pascalize.pascalize)('fooBar')).toEqual('FooBar');
+      expect((0, _pascalize.pascalize)('bazQuxFoo')).toEqual('BazQuxFoo');
+      expect((0, _pascalize.pascalize)('xLarge')).toEqual('XLarge');
+      expect((0, _pascalize.pascalize)('borderRadiusLarge')).toEqual('BorderRadiusLarge');
+    });
+    it('does not modify already pascal cased strings', () => {
+      expect((0, _pascalize.pascalize)('FooBar')).toEqual('FooBar');
+      expect((0, _pascalize.pascalize)('BazQuxFoo')).toEqual('BazQuxFoo');
+      expect((0, _pascalize.pascalize)('XLarge')).toEqual('XLarge');
+      expect((0, _pascalize.pascalize)('BorderRadiusLarge')).toEqual('BorderRadiusLarge');
+    });
+  });
+});

package/lib/__new-tests__/px.test.js

@@ -0,0 +1,53 @@
+"use strict";
+
+require("@testing-library/jest-dom");
+var _getFontSize = require("@instructure/ui-dom-utils/lib/getFontSize.js");
+var _px = require("../px");
+/*
+ * 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.
+ */
+
+describe('px', () => {
+  let node;
+  beforeEach(() => {
+    node = document.createElement('div');
+    document.body.appendChild(node);
+  });
+  afterEach(() => {
+    node && node.parentNode && node.parentNode.removeChild(node);
+    node = null;
+  });
+  it('handles px units', () => {
+    expect((0, _px.px)('30px')).toEqual(30);
+  });
+  it('converts rem to px', () => {
+    expect((0, _px.px)('50rem')).toEqual(50 * (0, _getFontSize.getFontSize)());
+  });
+  it('converts em to px', () => {
+    node.style.fontSize = '24px';
+    expect((0, _px.px)('10em', node)).toEqual(10 * (0, _getFontSize.getFontSize)(node));
+  });
+  it('handles unitless input', () => {
+    expect((0, _px.px)('4')).toEqual(4);
+  });
+});

package/lib/__new-tests__/within.test.js

@@ -0,0 +1,43 @@
+"use strict";
+
+require("@testing-library/jest-dom");
+var _within = require("../within");
+/*
+ * 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.
+ */
+
+describe('within', () => {
+  it('returns true when values are within range', () => {
+    expect((0, _within.within)(10, 8, 2)).toBe(true);
+    expect((0, _within.within)(10, 11, 1)).toBe(true);
+    expect((0, _within.within)(10, 10, 0)).toBe(true);
+    expect((0, _within.within)(10, 9.999, 0.001)).toBe(true);
+    expect((0, _within.within)(-10, -15, 5)).toBe(true);
+  });
+  it('returns false when values are out of range', () => {
+    expect((0, _within.within)(10, 8, 1)).toBe(false);
+    expect((0, _within.within)(12, 10, 1.9999)).toBe(false);
+    expect((0, _within.within)(8.705, 8.7, 0.004)).toBe(false);
+    expect((0, _within.within)(-2, -1.5, 0.4)).toBe(false);
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-utils",
-  "version": "8.52.1-snapshot-5",
+  "version": "8.52.1-snapshot-7",
   "description": "A collection of utilities for UI components",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -22,14 +22,15 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.52.1-snapshot-5",
-    "@instructure/ui-test-utils": "8.52.1-snapshot-5",
+    "@instructure/ui-babel-preset": "8.52.1-snapshot-7",
+    "@testing-library/jest-dom": "^6.1.4",
+    "@testing-library/react": "^14.0.0",
     "@types/json-stable-stringify": "^1.0.34"
   },
   "dependencies": {
     "@babel/runtime": "^7.23.2",
-    "@instructure/console": "8.52.1-snapshot-5",
-    "@instructure/ui-dom-utils": "8.52.1-snapshot-5",
+    "@instructure/console": "8.52.1-snapshot-7",
+    "@instructure/ui-dom-utils": "8.52.1-snapshot-7",
     "@types/ua-parser-js": "^0.7.37",
     "bowser": "^2.11.0",
     "fast-deep-equal": "^3.1.3",

package/src/__new-tests__/camelize.test.tsx

@@ -0,0 +1,42 @@
+/*
+ * 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/src/__new-tests__/cloneArray.test.tsx

@@ -0,0 +1,62 @@
+/*
+ * 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] as number[])[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/src/__new-tests__/createChainedFunction.test.tsx

@@ -0,0 +1,54 @@
+/*
+ * 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, undefined)).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/src/__new-tests__/generateId.test.tsx

@@ -0,0 +1,69 @@
+/*
+ * 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<string, number>()
+    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<string, number>()
+    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<string, number>()
+    const render2 = generateId(component, seed2)
+
+    expect(render1).toEqual(render2)
+  })
+
+  it('should not create the same id for the same instance.', () => {
+    const counter = new Map<string, boolean>()
+    const seed = new Map<string, number>()
+    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)
+    }
+  })
+})