@instructure/ui-i18n 10.16.1 → 10.16.3

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

@@ -0,0 +1,224 @@
+/*
+ * 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 { expect } from 'vitest'
+import { DateTime } from '../DateTime'
+
+const {
+  now,
+  isValid,
+  browserTimeZone,
+  parse,
+  toLocaleString,
+  getFirstDayOfWeek,
+  getLocalDayNamesOfTheWeek
+} = DateTime
+
+describe('DateTime', () => {
+  const timezone = 'America/Halifax' // -3
+  const locale = 'en'
+
+  it('checks params', () => {
+    let whoops = false
+    try {
+      // @ts-expect-error intentionally wrong
+      now()
+    } catch (ex) {
+      whoops = true
+    } finally {
+      expect(whoops).toBe(true)
+    }
+    whoops = false
+    try {
+      // @ts-expect-error intentionally wrong
+      now(locale)
+    } catch (ex) {
+      whoops = true
+    } finally {
+      expect(whoops).toBe(true)
+    }
+  })
+
+  it('knows when now is', () => {
+    // not much of a test, but I need it for coverage stats
+    const result = now(locale, timezone)
+    expect(result).toBeDefined()
+  })
+
+  it("can figure out the browser's timezone", () => {
+    const result = browserTimeZone()
+    expect(result).toBeDefined()
+  })
+
+  it('validates', () => {
+    expect(isValid('2018-04-15T23:30:00Z')).toBe(true)
+    expect(isValid('2018-04-15T23:30')).toBe(true)
+    expect(isValid('2018-04-15')).toBe(true)
+  })
+
+  it('parses iso8601', () => {
+    const result = parse(
+      '2018-04-15T20:30:00-03:00',
+      locale,
+      timezone
+    ).toISOString()
+    expect(result).toEqual('2018-04-15T23:30:00.000Z')
+  })
+
+  it('parses llll', () => {
+    const result = parse(
+      'Sun, Apr 15, 2018 8:30 PM',
+      locale,
+      timezone
+    ).toISOString()
+    expect(result).toEqual('2018-04-15T23:30:00.000Z')
+  })
+
+  it('parses LLLL', () => {
+    const result = parse(
+      'Sunday, April 15, 2018 8:30 PM',
+      locale,
+      timezone
+    ).toISOString()
+    expect(result).toEqual('2018-04-15T23:30:00.000Z')
+  })
+
+  it('parses lll', () => {
+    const result = parse('Apr 15, 2018 8:30 PM', locale, timezone).toISOString()
+    expect(result).toEqual('2018-04-15T23:30:00.000Z')
+  })
+
+  it('parses LLL', () => {
+    const result = parse(
+      'April 15, 2018 8:30 PM',
+      locale,
+      timezone
+    ).toISOString()
+    expect(result).toEqual('2018-04-15T23:30:00.000Z')
+  })
+
+  it('parses ll', () => {
+    const result = parse('Apr 15, 2018', locale, timezone).toISOString()
+    expect(result).toEqual('2018-04-15T03:00:00.000Z')
+  })
+
+  it('parses LL', () => {
+    const result = parse('April 15, 2018', locale, timezone).toISOString()
+    expect(result).toEqual('2018-04-15T03:00:00.000Z')
+  })
+
+  it('parses l', () => {
+    const result = parse('4/15/2018', locale, timezone).toISOString()
+    expect(result).toEqual('2018-04-15T03:00:00.000Z')
+  })
+
+  it('parses L', () => {
+    const result = parse('04/15/2018', locale, timezone).toISOString()
+    expect(result).toEqual('2018-04-15T03:00:00.000Z')
+  })
+
+  it('parses French L', () => {
+    const result = parse('15/04/2018', 'fr', timezone).toISOString()
+    expect(result).toEqual('2018-04-15T03:00:00.000Z')
+  })
+
+  it('parses French LL', () => {
+    const result = parse('15 Avril, 2018', 'fr', timezone).toISOString()
+    expect(result).toEqual('2018-04-15T03:00:00.000Z')
+  })
+
+  it('returns localized string', () => {
+    let result = toLocaleString('2018-04-15T13:00Z', 'en', 'UTC', 'LLL')
+    expect(result).toEqual('April 15, 2018 1:00 PM')
+    result = toLocaleString('2018-04-15T13:00Z', 'fr', 'UTC', 'LLL')
+    expect(result).toEqual('15 avril 2018 13:00')
+    // iso8601 in given timezone
+    result = toLocaleString('2018-04-15T13:00Z', 'fr', 'America/Halifax') // -3
+    expect(result).toEqual('2018-04-15T10:00:00.000-03:00')
+  })
+
+  it('calculates the first day of the week', () => {
+    // normal case
+    const d11 = DateTime.parse('2021-09-15T20:30:00Z', 'hu-hu', 'UTC')
+    expect(getFirstDayOfWeek(d11).date()).toEqual(13)
+    const d12 = DateTime.parse('2021-09-15T20:30:00Z', 'en-us', 'UTC')
+    expect(getFirstDayOfWeek(d12).date()).toEqual(12)
+    // date wraps month/year
+    const d21 = DateTime.parse('2022-01-01T20:30:00Z', 'hu-hu', 'UTC')
+    expect(getFirstDayOfWeek(d21).date()).toEqual(27)
+    const d22 = DateTime.parse('2022-01-01T20:30:00Z', 'en-us', 'UTC')
+    expect(getFirstDayOfWeek(d22).date()).toEqual(26)
+
+    // Monday
+    const d31 = DateTime.parse('2021-12-05T20:30:00Z', 'hu-hu', 'UTC')
+    expect(getFirstDayOfWeek(d31).date()).toEqual(29)
+    // Sunday
+    const d32 = DateTime.parse('2021-12-05T20:30:00Z', 'en-us', 'UTC')
+    expect(getFirstDayOfWeek(d32).date()).toEqual(5)
+    // Sunday (but in other systems Friday)
+    const d33 = DateTime.parse('2021-12-05T20:30:00Z', 'bn-bd', 'UTC')
+    expect(getFirstDayOfWeek(d33).date()).toEqual(5)
+  })
+
+  it('calculates the local day names of the week', () => {
+    // short names
+    expect(getLocalDayNamesOfTheWeek('hu-hu', 'short')).toEqual([
+      'h',
+      'k',
+      'sze',
+      'cs',
+      'p',
+      'szo',
+      'v'
+    ])
+    expect(getLocalDayNamesOfTheWeek('en-us', 'short')).toEqual([
+      'Su',
+      'Mo',
+      'Tu',
+      'We',
+      'Th',
+      'Fr',
+      'Sa'
+    ])
+    // long
+    expect(getLocalDayNamesOfTheWeek('en-us', 'long')).toEqual([
+      'Sunday',
+      'Monday',
+      'Tuesday',
+      'Wednesday',
+      'Thursday',
+      'Friday',
+      'Saturday'
+    ])
+    expect(getLocalDayNamesOfTheWeek('es-mx', 'long')).toEqual([
+      'domingo',
+      'lunes',
+      'martes',
+      'miércoles',
+      'jueves',
+      'viernes',
+      'sábado'
+    ])
+  })
+})

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

@@ -0,0 +1,119 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 - 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 { expect } from 'vitest'
+import { I18nPropTypes } from '../I18nPropTypes'
+
+describe('I18nPropTypes', () => {
+  describe('iso8601', () => {
+    const { iso8601 } = I18nPropTypes
+
+    // Test cases taken from https://www.myintervals.com/blog/2009/05/20/iso-8601-date-validation-that-doesnt-suck/
+    it('should not return error when provided with a valid ISO8601 string', () => {
+      const props: { date: string | null } = { date: null }
+      const validISO8601Strings = [
+        '2009-12T12:34',
+        '2009',
+        '2009-05-19',
+        '20090519',
+        '2009123',
+        '2009-05',
+        '2009-123',
+        '2009-222',
+        '2009-001',
+        '2009-W01-1',
+        '2009-W51-1',
+        '2009-W511',
+        '2009-W33',
+        '2009W511',
+        '2009-05-19',
+        '2009-05-19 00:00',
+        '2009-05-19 14',
+        '2009-05-19 14:31',
+        '2009-05-19 14:39:22',
+        '2009-05-19T14:39Z',
+        '2009-W21-2',
+        '2009-W21-2T01:22',
+        '2009-139',
+        '2009-05-19 14:39:22-06:00',
+        '2009-05-19 14:39:22+0600',
+        '2009-05-19 14:39:22-01',
+        '20090621T0545Z',
+        '2007-04-06T00:00',
+        '2007-04-05T24:00',
+        '2010-02-18T16:23:48.5',
+        '2010-02-18T16:23:48,444',
+        '2010-02-18T16:23:48,3-06:00',
+        '2010-02-18T16:23.4',
+        '2010-02-18T16:23,25',
+        '2010-02-18T16:23.33+0600',
+        '2010-02-18T16.23334444',
+        '2010-02-18T16,2283',
+        '2009-05-19 143922.500',
+        '2009-05-19 1439,55'
+      ]
+      validISO8601Strings.forEach((iso8601string) => {
+        props.date = iso8601string
+        expect(iso8601(props, 'date', 'TestComponent', '', '')).toBe(null)
+      })
+    })
+
+    it('should return error when provided with an invalid ISO8601 string', () => {
+      const props: { date: string | null } = { date: null }
+      const invalidISO8601Strings = [
+        'some text',
+        'June 27, 1990',
+        '200905',
+        '2009367',
+        '2009-',
+        '2007-04-05T24:50',
+        '2009-000',
+        '2009-M511',
+        '2009M511',
+        '2009-05-19T14a39r',
+        '2009-05-19T14:3924',
+        '2009-0519',
+        '2009-05-1914:39',
+        '2009-05-19 14:',
+        '2009-05-19r14:39',
+        '2009-05-19 14a39a22',
+        '200912-01',
+        '2009-05-19 14:39:22+06a00',
+        '2009-05-19 146922.500',
+        '2010-02-18T16.5:23.35:48',
+        '2010-02-18T16:23.35:48',
+        '2010-02-18T16:23.35:48.45',
+        '2009-05-19 14.5.44',
+        '2010-02-18T16:23.33.600',
+        '2010-02-18T16,25:23:48,444'
+      ]
+      invalidISO8601Strings.forEach((iso8601string) => {
+        props.date = iso8601string
+        expect(iso8601(props, 'date', 'TestComponent', '', '')).toBeInstanceOf(
+          Error
+        )
+      })
+    })
+  })
+})

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

@@ -0,0 +1,55 @@
+/*
+ * 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 { expect } from 'vitest'
+import { Locale } from '../Locale'
+
+describe('browserLocale', () => {
+  it('returns the navigator language if a navigator is explicity passed', () => {
+    const navigator = { language: 'de' }
+    expect(Locale.browserLocale(navigator)).toBe('de')
+  })
+
+  describe('with document lang attribute', () => {
+    it('returns the document locale if no navigator is passed', () => {
+      const original = document.documentElement.lang
+
+      document.documentElement.lang = 'fr'
+      expect(Locale.browserLocale()).toBe('fr')
+
+      // Restore global
+      document.documentElement.lang = original
+    })
+  })
+
+  it('returns the browser locale if no navigator is passed, or "en-US" if no browser locale is set', () => {
+    const expectedLanguage = navigator ? navigator.language : 'en-US'
+    expect(Locale.browserLocale()).toBe(expectedLanguage)
+  })
+
+  it('returns the default "en-US" if navigator is undefined and the DOM is unavailable', () => {
+    expect(Locale.browserLocale(null, false)).toBe('en-US')
+  })
+})

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

@@ -0,0 +1,125 @@
+/*
+ * 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 ReactDOM from 'react-dom'
+import ReactTestUtils from 'react-dom/test-utils'
+import { render } from '@testing-library/react'
+import '@testing-library/jest-dom'
+import { vi, expect } from 'vitest'
+import type { MockInstance } from 'vitest'
+
+import {
+  textDirectionContextConsumer,
+  TextDirectionContextConsumerProps
+} from '../textDirectionContextConsumer'
+import { TextDirectionContext } from '../TextDirectionContext'
+
+@textDirectionContextConsumer()
+class TextDirectionContextConsumerComponent extends Component<TextDirectionContextConsumerProps> {
+  render() {
+    return (
+      <div data-dir={this.props.dir} dir={this.props.dir}>
+        {this.props.children}
+      </div>
+    )
+  }
+}
+
+class WrapperComponent extends Component {
+  render() {
+    return (
+      <div>
+        <TextDirectionContextConsumerComponent />
+      </div>
+    )
+  }
+}
+
+describe('@textDirectionContextConsumer', () => {
+  let consoleErrorMock: ReturnType<typeof vi.spyOn>
+
+  beforeEach(() => {
+    // Mocking console to prevent test output pollution
+    consoleErrorMock = vi
+      .spyOn(console, 'error')
+      .mockImplementation(() => {}) as MockInstance
+  })
+
+  afterEach(() => {
+    consoleErrorMock.mockRestore()
+  })
+
+  it('should take on the direction of the document by default', async () => {
+    const { container } = render(<TextDirectionContextConsumerComponent />)
+
+    expect(container.firstChild).toHaveAttribute('data-dir', 'ltr')
+  })
+
+  it('can be found and tested with ReactTestUtils', async () => {
+    const rootNode = document.createElement('div')
+
+    document.body.appendChild(rootNode)
+
+    // eslint-disable-next-line react/no-render-return-value
+    const rendered = ReactDOM.render(<WrapperComponent />, rootNode)
+    const foundComponent = ReactTestUtils.findRenderedComponentWithType(
+      rendered as any,
+      (TextDirectionContextConsumerComponent as any).originalType
+    )
+
+    expect(foundComponent).toBeDefined()
+  })
+
+  it('should set the text direction via props', async () => {
+    const { container } = render(
+      <TextDirectionContextConsumerComponent dir="rtl" />
+    )
+    expect(container.firstChild).toHaveAttribute('data-dir', 'rtl')
+  })
+
+  /* TODO re-enable this test when we allow 'auto' text direction
+  it('setting "auto" from context figures out text direction from the text', async () => {
+    const subject = await mount(
+      <TextDirectionContextConsumerComponent dir="auto">
+        <span>
+          هذه الفقرة باللغة العربية ، لذا يجب الانتقال من اليمين إلى اليسار.
+        </span>
+      </TextDirectionContextConsumerComponent>
+    )
+    expect(
+      getComputedStyle(subject.getDOMNode().childNodes[0] as Element).direction
+    ).to.equal('rtl')
+  })
+  */
+
+  it('should give props preference when context and context are present', async () => {
+    const { container } = render(
+      <TextDirectionContext.Provider value="ltr">
+        <TextDirectionContextConsumerComponent dir="rtl" />
+      </TextDirectionContext.Provider>
+    )
+    expect(container.firstChild).toHaveAttribute('data-dir', 'rtl')
+  })
+})

package/tsconfig.build.json

@@ -11,9 +11,8 @@
       "path": "../ui-babel-preset/tsconfig.build.json"
     },
     {
-      "path": "../ui-test-utils/tsconfig.build.json"
+      "path": "../shared-types/tsconfig.build.json"
     },
-    { "path": "../shared-types/tsconfig.build.json" },
     {
       "path": "../ui-decorator/tsconfig.build.json"
     },