@instructure/ui-react-utils 10.19.2-snapshot-2 → 10.19.2-snapshot-4

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

@@ -1,358 +0,0 @@
-/*
- * 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 { Component } from 'react'
-import { vi } from 'vitest'
-import PropTypes from 'prop-types'
-
-import { render } from '@testing-library/react'
-import '@testing-library/jest-dom'
-
-import { deprecated } from '../deprecated'
-
-type TestComponentProps = {
-  bar: string
-  qux: string
-}
-class TestComponent extends Component<TestComponentProps> {
-  static propTypes = {
-    bar: PropTypes.string,
-    qux: PropTypes.string
-  }
-
-  static defaultProps = {
-    bar: null,
-    qux: 'Hello'
-  }
-
-  render() {
-    return (
-      <div>
-        {this.props.qux} {this.props.bar}
-      </div>
-    )
-  }
-}
-
-describe('@deprecated', () => {
-  describe('deprecated props', () => {
-    const DeprecatedComponent = deprecated('2.1.0', {
-      foo: 'bar',
-      baz: true
-    })(TestComponent)
-
-    it('should warn when suggesting new prop when using old prop', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-
-      render(<DeprecatedComponent foo="Jane" />)
-
-      const expectedWarningMessage =
-        'Warning: [TestComponent] `foo` is deprecated and will be removed in version 2.1.0. Use `bar` instead. '
-
-      expect(consoleWarningSpy).toHaveBeenCalledWith(
-        expect.stringContaining(expectedWarningMessage),
-        expect.any(String)
-      )
-
-      consoleWarningSpy.mockRestore()
-    })
-
-    it('should warn when using old prop with no new prop', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-
-      render(<DeprecatedComponent baz="Goodbye" />)
-
-      const expectedWarningMessage =
-        'Warning: [TestComponent] `baz` is deprecated and will be removed in version 2.1.0.'
-
-      expect(consoleWarningSpy).toHaveBeenCalledWith(
-        expect.stringContaining(expectedWarningMessage),
-        expect.any(String)
-      )
-
-      consoleWarningSpy.mockRestore()
-    })
-
-    it('should not output a warning using new prop', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-
-      render(<DeprecatedComponent bar="Jane" />)
-
-      expect(consoleWarningSpy).not.toHaveBeenCalled()
-
-      consoleWarningSpy.mockRestore()
-    })
-  })
-
-  describe('deprecated component', () => {
-    const DeprecatedComponent = deprecated('3.4.0')(TestComponent)
-
-    it('should warn that the entire component is deprecated if no old props are supplied', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-
-      render(<DeprecatedComponent />)
-
-      const expectedWarningMessage =
-        'Warning: [TestComponent] is deprecated and will be removed in version 3.4.0.'
-
-      expect(consoleWarningSpy).toHaveBeenCalledWith(
-        expect.stringContaining(expectedWarningMessage),
-        expect.any(String)
-      )
-
-      consoleWarningSpy.mockRestore()
-    })
-  })
-
-  describe('deprecated component with a changed package message', () => {
-    const DeprecatedComponent = deprecated(
-      '5.0.0',
-      null,
-      deprecated.changedPackageWarning('ui-forms', 'ui-number-input')
-    )(TestComponent)
-
-    it('should warn that the component is deprecated and output a warning that the package changed', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-
-      const expectedWarningMessage =
-        'Warning: [TestComponent] is deprecated and will be removed in version 5.0.0. It has been moved from @instructure/ui-forms to @instructure/ui-number-input.'
-
-      render(<DeprecatedComponent />)
-
-      expect(consoleWarningSpy).toHaveBeenCalledWith(
-        expect.stringContaining(expectedWarningMessage),
-        expect.any(String)
-      )
-
-      consoleWarningSpy.mockRestore()
-    })
-  })
-
-  describe('component with deprecated prop values', () => {
-    it('should not warn when an allowed prop value is supplied', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-      type DeprecatedPropValueComponentProps = {
-        color: string
-      }
-      class DeprecatedPropValueComponent extends Component<DeprecatedPropValueComponentProps> {
-        static propTypes = {
-          color: deprecated.deprecatePropValues(
-            PropTypes.oneOf(['red', 'yellow', 'blue', 'orange', 'gold']),
-            ['blue', 'orange', 'gold']
-          )
-        }
-
-        static defaultProps = {
-          color: 'red'
-        }
-
-        render() {
-          return <div>{this.props.color}</div>
-        }
-      }
-
-      render(<DeprecatedPropValueComponent color="yellow" />)
-
-      expect(consoleWarningSpy).not.toHaveBeenCalled()
-
-      consoleWarningSpy.mockRestore()
-    })
-
-    it('should warn when a forbidden prop value is supplied', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-
-      const color = 'orange'
-      type DeprecatedPropValueComponentProps = {
-        color: string
-      }
-      class DeprecatedPropValueComponent extends Component<DeprecatedPropValueComponentProps> {
-        static propTypes = {
-          color: deprecated.deprecatePropValues(
-            PropTypes.oneOf(['red', 'yellow', 'blue', 'orange', 'gold']),
-            ['blue', 'orange', 'gold']
-          )
-        }
-
-        static defaultProps = {
-          color: 'red'
-        }
-
-        render() {
-          return <div>{this.props.color}</div>
-        }
-      }
-
-      render(<DeprecatedPropValueComponent color={color} />)
-
-      const expectedWarningMessage = `The '${color}' value for the \`color\` prop is deprecated.`
-
-      expect(consoleWarningSpy).toHaveBeenCalledWith(
-        expect.stringContaining(expectedWarningMessage),
-        expect.any(String)
-      )
-
-      consoleWarningSpy.mockRestore()
-    })
-
-    it('should warn with additional message text when a forbidden prop value is supplied and has message text', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-
-      const color = 'gold'
-      const message = 'It will be removed in v8.0.0.'
-      type DeprecatedPropValueComponentProps = {
-        color: string
-      }
-      class DeprecatedPropValueComponent extends Component<DeprecatedPropValueComponentProps> {
-        static propTypes = {
-          color: deprecated.deprecatePropValues(
-            PropTypes.oneOf(['red', 'yellow', 'blue', 'orange', 'gold']),
-            ['blue', 'orange', 'gold'],
-            'It will be removed in v8.0.0.'
-          )
-        }
-
-        static defaultProps = {
-          color: 'red'
-        }
-
-        render() {
-          return <div>{this.props.color}</div>
-        }
-      }
-
-      render(<DeprecatedPropValueComponent color={color} />)
-
-      const expectedWarningMessage = `The '${color}' value for the \`color\` prop is deprecated. ${message}`
-
-      expect(consoleWarningSpy).toHaveBeenCalledWith(
-        expect.stringContaining(expectedWarningMessage),
-        expect.any(String)
-      )
-
-      consoleWarningSpy.mockRestore()
-    })
-
-    it('should call functional message with the correct props', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-      const messageMock = vi.fn()
-
-      const color = 'gold'
-      type DeprecatedPropValueComponentProps = {
-        color: string
-      }
-      class DeprecatedPropValueComponent extends Component<DeprecatedPropValueComponentProps> {
-        static propTypes = {
-          color: deprecated.deprecatePropValues(
-            PropTypes.oneOf(['red', 'yellow', 'blue', 'orange', 'gold']),
-            ['blue', 'orange', 'gold'],
-            messageMock
-          )
-        }
-
-        static defaultProps = {
-          color: 'red'
-        }
-
-        render() {
-          return <div>{this.props.color}</div>
-        }
-      }
-
-      render(<DeprecatedPropValueComponent color={color} />)
-
-      const { props, propName, propValue } = messageMock.mock.calls[0][0]
-
-      expect(props).toEqual({ color })
-      expect(propName).toBe('color')
-      expect(propValue).toBe(color)
-      expect(consoleWarningSpy).toHaveBeenCalled()
-
-      consoleWarningSpy.mockRestore()
-    })
-
-    it('should warn with a completely custom message when provided message is functional and prop value is forbidden', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-
-      const color = 'gold'
-      type DeprecatedPropValueComponentProps = {
-        color: string
-      }
-      class DeprecatedPropValueComponent extends Component<DeprecatedPropValueComponentProps> {
-        static propTypes = {
-          color: deprecated.deprecatePropValues(
-            PropTypes.oneOf(['red', 'yellow', 'blue', 'orange', 'gold']),
-            ['blue', 'orange', 'gold'],
-            ({
-              propValue,
-              propName
-            }: {
-              propValue: string
-              propName: string
-            }) =>
-              `The ${propValue} value for ${propName} has been deprecated. Use the FooBar component with the 'baz' prop set instead.`
-          )
-        }
-
-        static defaultProps = {
-          color: 'red'
-        }
-
-        render() {
-          return <div>{this.props.color}</div>
-        }
-      }
-
-      render(<DeprecatedPropValueComponent color={color} />)
-
-      const expectedWarningMessage = `The ${color} value for color has been deprecated. Use the FooBar component with the 'baz' prop set instead.`
-
-      expect(consoleWarningSpy).toHaveBeenCalledWith(
-        expect.stringContaining(expectedWarningMessage),
-        expect.any(String)
-      )
-
-      consoleWarningSpy.mockRestore()
-    })
-  })
-})

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

@@ -1,139 +0,0 @@
-/*
- * 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 { Component } from 'react'
-import { vi } from 'vitest'
-import PropTypes from 'prop-types'
-
-import { render } from '@testing-library/react'
-import '@testing-library/jest-dom'
-
-import { experimental } from '../experimental'
-
-type TestComponentProps = {
-  bar: string
-  qux: string
-}
-class TestComponent extends Component<TestComponentProps> {
-  static propTypes = {
-    bar: PropTypes.string,
-    qux: PropTypes.string
-  }
-
-  static defaultProps = {
-    bar: undefined,
-    qux: 'Hello'
-  }
-
-  render() {
-    return (
-      <div>
-        {this.props.qux} {this.props.bar}
-      </div>
-    )
-  }
-}
-
-describe('@experimental', () => {
-  describe('experimental props', () => {
-    const ExperimentalComponent = experimental(['bar'])(TestComponent)
-
-    it('should warn when using an experimental prop', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-      render(<ExperimentalComponent bar="Jane" />)
-
-      const expectedWarningMessage =
-        'Warning: [TestComponent] The `bar` prop is experimental and its API could change significantly in a future release.'
-
-      expect(consoleWarningSpy).toHaveBeenCalledWith(
-        expect.stringContaining(expectedWarningMessage),
-        expect.any(String)
-      )
-
-      consoleWarningSpy.mockRestore()
-    })
-
-    it('should not output a warning using a non-experimental prop', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-      render(<ExperimentalComponent qux="Jane" />)
-
-      expect(consoleWarningSpy).not.toHaveBeenCalled()
-
-      consoleWarningSpy.mockRestore()
-    })
-
-    it('should not output a warning for an experimental prop when dangerously ignored', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-
-      render(
-        <ExperimentalComponent
-          qux="Jane"
-          __dangerouslyIgnoreExperimentalWarnings
-        />
-      )
-
-      expect(consoleWarningSpy).not.toHaveBeenCalled()
-
-      consoleWarningSpy.mockRestore()
-    })
-  })
-
-  describe('experimental component', () => {
-    const ExperimentalComponent = experimental()(TestComponent)
-
-    it('should warn that the entire component is experimental if no props are supplied', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-      render(<ExperimentalComponent />)
-
-      const expectedWarningMessage =
-        'Warning: [TestComponent] is experimental and its API could change significantly in a future release.'
-
-      expect(consoleWarningSpy).toHaveBeenCalledWith(
-        expect.stringContaining(expectedWarningMessage),
-        expect.any(String)
-      )
-
-      consoleWarningSpy.mockRestore()
-    })
-
-    it('should not output a warning for a component when dangerously ignored', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-      render(<ExperimentalComponent __dangerouslyIgnoreExperimentalWarnings />)
-
-      expect(consoleWarningSpy).not.toHaveBeenCalled()
-
-      consoleWarningSpy.mockRestore()
-    })
-  })
-})

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

@@ -1,119 +0,0 @@
-/*
- * 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 { getInteraction, InteractionType } from '../getInteraction'
-
-describe('getInteraction', () => {
-  it("should return 'enabled' when `interaction`, `disabled`, and `readOnly` are not provided", () => {
-    const props = {
-      foo: 'foo',
-      bar: 'bar'
-    }
-
-    expect(getInteraction({ props })).toEqual('enabled')
-  })
-
-  it('should return `interaction` value when `interaction` is specified', () => {
-    const props: { interaction: InteractionType } = {
-      interaction: 'enabled'
-    }
-
-    expect(getInteraction({ props })).toEqual('enabled')
-
-    props.interaction = 'disabled'
-
-    expect(getInteraction({ props })).toEqual('disabled')
-
-    props.interaction = 'readonly'
-
-    expect(getInteraction({ props })).toEqual('readonly')
-  })
-
-  it('should give preference to interaction even when disabled and readonly are also specified', () => {
-    const props: { interaction: InteractionType; [key: string]: any } = {
-      interaction: 'enabled',
-      disabled: true,
-      readOnly: true
-    }
-
-    expect(getInteraction({ props })).toEqual('enabled')
-
-    props.disabled = false
-    props.interaction = 'disabled'
-
-    expect(getInteraction({ props })).toEqual('disabled')
-
-    props.readOnly = false
-    props.interaction = 'readonly'
-
-    expect(getInteraction({ props })).toEqual('readonly')
-  })
-
-  it("should return 'disabled' when `disabled` prop is set and `interaction` is not specified", () => {
-    const props = {
-      disabled: true
-    }
-
-    expect(getInteraction({ props })).toEqual('disabled')
-  })
-
-  it("should return 'disabled' when both `disabled` and `readonly` props are set and `interaction` is not specified", () => {
-    const props = {
-      disabled: true,
-      readOnly: true
-    }
-
-    expect(getInteraction({ props })).toEqual('disabled')
-  })
-
-  it("should return 'readonly' when `readonly` prop is set and `interaction` and `disabled` are not specified", () => {
-    const props = {
-      disabled: true
-    }
-
-    expect(getInteraction({ props })).toEqual('disabled')
-  })
-
-  it('should not include `disabled` if it is not listed in the interactionTypes', () => {
-    const props = {
-      disabled: true,
-      readOnly: true
-    }
-
-    expect(getInteraction({ props, interactionTypes: ['readonly'] })).toEqual(
-      'readonly'
-    )
-  })
-
-  it('should not include `readonly` if it is not listed in the interactionTypes', () => {
-    const props = {
-      readOnly: true
-    }
-
-    expect(getInteraction({ props, interactionTypes: ['disabled'] })).toEqual(
-      'enabled'
-    )
-  })
-})

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

@@ -1,91 +0,0 @@
-/*
- * 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 { Component } from 'react'
-import { vi } from 'vitest'
-import PropTypes from 'prop-types'
-
-import { render } from '@testing-library/react'
-import '@testing-library/jest-dom'
-
-import { hack } from '../hack'
-
-type TestComponentProps = {
-  bar: string
-  qux: string
-}
-class TestComponent extends Component<TestComponentProps> {
-  static propTypes = {
-    bar: PropTypes.string,
-    qux: PropTypes.string
-  }
-
-  static defaultProps = {
-    bar: undefined,
-    qux: 'Hello'
-  }
-
-  render() {
-    return (
-      <div>
-        {this.props.qux} {this.props.bar}
-      </div>
-    )
-  }
-}
-
-describe('@hack', () => {
-  describe('hack props', () => {
-    const HackComponent = hack(['bar'])(TestComponent)
-
-    it('should warn when using an hack prop', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-      render(<HackComponent bar="Jane" />)
-
-      const expectedWarningMessage =
-        'Warning: [TestComponent] The `bar` prop is a temporary hack and will be removed in a future release.'
-
-      expect(consoleWarningSpy).toHaveBeenCalledWith(
-        expect.stringContaining(expectedWarningMessage),
-        expect.any(String)
-      )
-
-      consoleWarningSpy.mockRestore()
-    })
-
-    it('should not output a warning using a non-hack prop', () => {
-      const consoleWarningSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-
-      render(<HackComponent qux="Jane" />)
-
-      expect(consoleWarningSpy).not.toHaveBeenCalled()
-
-      consoleWarningSpy.mockRestore()
-    })
-  })
-})