Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add prettier config, lint #39

Merged
merged 3 commits into from
Apr 2, 2021
Merged

Add prettier config, lint #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d6917a5
Add prettier, lint index
pacocoursey Mar 30, 2021
9096ebd
lint all files
pacocoursey Mar 30, 2021
06f771d
lint test file
pacocoursey Mar 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
343 changes: 183 additions & 160 deletions __tests__/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,200 +1,223 @@
import {act, render, screen} from "@testing-library/react";
import {ThemeProvider, useTheme} from "../index";
import React, {useEffect} from "react";
import { act, render, screen } from '@testing-library/react'
import { ThemeProvider, useTheme } from '../index'
import React, { useEffect } from 'react'

let localStorageMock: { [key: string]: string } = {}

// HelperComponent to render the theme inside a paragraph-tag and setting a theme via the forceSetTheme prop
const HelperComponent = ({forceSetTheme}: { forceSetTheme?: string }) => {
const {setTheme, theme, forcedTheme} = useTheme()

useEffect(() => {
if (forceSetTheme) {
setTheme(forceSetTheme)
}
}, [forceSetTheme])

return <>
<p data-testid="theme">{theme}</p>
<p data-testid="forcedTheme">{forcedTheme}</p>
</>;
const HelperComponent = ({ forceSetTheme }: { forceSetTheme?: string }) => {
const { setTheme, theme, forcedTheme } = useTheme()

useEffect(() => {
if (forceSetTheme) {
setTheme(forceSetTheme)
}
}, [forceSetTheme])

return (
<>
<p data-testid="theme">{theme}</p>
<p data-testid="forcedTheme">{forcedTheme}</p>
</>
)
}

beforeAll(() => {
// Create a mock of the window.matchMedia function
// Based on: https://stackoverflow.com/questions/39830580/jest-test-fails-typeerror-window-matchmedia-is-not-a-function
Object.defineProperty(window, 'matchMedia', {
writable: true,
value: jest.fn().mockImplementation(query => ({
matches: false,
media: query,
onchange: null,
addListener: jest.fn(), // Deprecated
removeListener: jest.fn(), // Deprecated
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
dispatchEvent: jest.fn(),
})),
})

// Create mocks of localStorage getItem and setItem functions
global.Storage.prototype.getItem = jest.fn((key: string) => localStorageMock[key])
global.Storage.prototype.setItem = jest.fn((key: string, value: string) => {
localStorageMock[key] = value;
})
// Create a mock of the window.matchMedia function
// Based on: https://stackoverflow.com/questions/39830580/jest-test-fails-typeerror-window-matchmedia-is-not-a-function
Object.defineProperty(window, 'matchMedia', {
writable: true,
value: jest.fn().mockImplementation(query => ({
matches: false,
media: query,
onchange: null,
addListener: jest.fn(), // Deprecated
removeListener: jest.fn(), // Deprecated
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
dispatchEvent: jest.fn()
}))
})

// Create mocks of localStorage getItem and setItem functions
global.Storage.prototype.getItem = jest.fn(
(key: string) => localStorageMock[key]
)
global.Storage.prototype.setItem = jest.fn((key: string, value: string) => {
localStorageMock[key] = value
})
})

beforeEach(() => {
// Clear the localStorage-mock
localStorageMock = {}
// Clear the localStorage-mock
localStorageMock = {}
})

describe('defaultTheme test-suite', () => {

test('should return system when no default-theme is set', () => {
render(
<ThemeProvider>
<HelperComponent/>
</ThemeProvider>
)

expect(screen.getByTestId('theme').textContent).toBe('system')
})

test('should return light when no default-theme is set and enableSystem=false', () => {
render(
<ThemeProvider enableSystem={false}>
<HelperComponent/>
</ThemeProvider>
)

expect(screen.getByTestId('theme').textContent).toBe('light')
})

test('should return light when light is set as default-theme', () => {
render(
<ThemeProvider defaultTheme="light">
<HelperComponent/>
</ThemeProvider>
)

expect(screen.getByTestId('theme').textContent).toBe('light')
})

test('should return dark when dark is set as default-theme', () => {
render(
<ThemeProvider defaultTheme="dark">
<HelperComponent/>
</ThemeProvider>
)

expect(screen.getByTestId('theme').textContent).toBe('dark')
})
});
test('should return system when no default-theme is set', () => {
render(
<ThemeProvider>
<HelperComponent />
</ThemeProvider>
)

expect(screen.getByTestId('theme').textContent).toBe('system')
})

test('should return light when no default-theme is set and enableSystem=false', () => {
render(
<ThemeProvider enableSystem={false}>
<HelperComponent />
</ThemeProvider>
)

expect(screen.getByTestId('theme').textContent).toBe('light')
})

test('should return light when light is set as default-theme', () => {
render(
<ThemeProvider defaultTheme="light">
<HelperComponent />
</ThemeProvider>
)

expect(screen.getByTestId('theme').textContent).toBe('light')
})

test('should return dark when dark is set as default-theme', () => {
render(
<ThemeProvider defaultTheme="dark">
<HelperComponent />
</ThemeProvider>
)

expect(screen.getByTestId('theme').textContent).toBe('dark')
})
})

describe('custom storageKey test-suite', () => {

test('should save to localStorage with \'theme\' key when using default settings', () => {
act(() => {
render(<ThemeProvider>
<HelperComponent forceSetTheme="light"/>
</ThemeProvider>)
})

expect(global.Storage.prototype.getItem).toHaveBeenCalledWith('theme')
expect(global.Storage.prototype.setItem).toHaveBeenCalledWith('theme', 'light')
test("should save to localStorage with 'theme' key when using default settings", () => {
act(() => {
render(
<ThemeProvider>
<HelperComponent forceSetTheme="light" />
</ThemeProvider>
)
})

test('should save to localStorage with \'custom\' when setting prop \'storageKey\' to \'customKey\'', () => {
act(() => {
render(<ThemeProvider storageKey="customKey">
<HelperComponent forceSetTheme="light"/>
</ThemeProvider>)
})

expect(global.Storage.prototype.getItem).toHaveBeenCalledWith('customKey')
expect(global.Storage.prototype.setItem).toHaveBeenCalledWith('customKey', 'light')
expect(global.Storage.prototype.getItem).toHaveBeenCalledWith('theme')
expect(global.Storage.prototype.setItem).toHaveBeenCalledWith(
'theme',
'light'
)
})

test("should save to localStorage with 'custom' when setting prop 'storageKey' to 'customKey'", () => {
act(() => {
render(
<ThemeProvider storageKey="customKey">
<HelperComponent forceSetTheme="light" />
</ThemeProvider>
)
})

expect(global.Storage.prototype.getItem).toHaveBeenCalledWith('customKey')
expect(global.Storage.prototype.setItem).toHaveBeenCalledWith(
'customKey',
'light'
)
})
})

describe('custom attribute test-suite', () => {

test('should use data-theme attribute when using default', () => {
act(() => {
render(<ThemeProvider>
<HelperComponent forceSetTheme="light"/>
</ThemeProvider>)
})

expect(document.documentElement.getAttribute("data-theme")).toBe("light")
test('should use data-theme attribute when using default', () => {
act(() => {
render(
<ThemeProvider>
<HelperComponent forceSetTheme="light" />
</ThemeProvider>
)
})

test('should use class attribute (CSS-class) when attribute="class"', () => {
act(() => {
render(<ThemeProvider attribute="class">
<HelperComponent forceSetTheme="light"/>
</ThemeProvider>)
})
expect(document.documentElement.getAttribute('data-theme')).toBe('light')
})

expect(document.documentElement.classList.contains("light")).toBeTruthy()
});
test('should use class attribute (CSS-class) when attribute="class"', () => {
act(() => {
render(
<ThemeProvider attribute="class">
<HelperComponent forceSetTheme="light" />
</ThemeProvider>
)
})

test('should use "data-example"-attribute when attribute="data-example"', () => {
act(() => {
render(<ThemeProvider attribute="data-example">
<HelperComponent forceSetTheme="light"/>
</ThemeProvider>)
})
expect(document.documentElement.classList.contains('light')).toBeTruthy()
})

expect(document.documentElement.getAttribute('data-example')).toBe('light')
test('should use "data-example"-attribute when attribute="data-example"', () => {
act(() => {
render(
<ThemeProvider attribute="data-example">
<HelperComponent forceSetTheme="light" />
</ThemeProvider>
)
})

expect(document.documentElement.getAttribute('data-example')).toBe('light')
})
})

describe('custom value-mapping test-suite', () => {

test('should use custom value mapping when using value={{pink:"my-pink-theme"}}', () => {
localStorageMock["theme"] = "pink"

act(() => {
render(<ThemeProvider themes={['pink', 'light', 'dark', 'system']} value={{pink: "my-pink-theme"}}>
<HelperComponent forceSetTheme="pink"/>
</ThemeProvider>)
})

expect(document.documentElement.getAttribute('data-theme')).toBe('my-pink-theme')
expect(global.Storage.prototype.setItem).toHaveBeenCalledWith('theme', 'pink')
test('should use custom value mapping when using value={{pink:"my-pink-theme"}}', () => {
localStorageMock['theme'] = 'pink'

act(() => {
render(
<ThemeProvider
themes={['pink', 'light', 'dark', 'system']}
value={{ pink: 'my-pink-theme' }}
>
<HelperComponent forceSetTheme="pink" />
</ThemeProvider>
)
})

expect(document.documentElement.getAttribute('data-theme')).toBe(
'my-pink-theme'
)
expect(global.Storage.prototype.setItem).toHaveBeenCalledWith(
'theme',
'pink'
)
})
})

describe('forcedTheme test-suite', () => {

test('should render saved theme when no forcedTheme is set', () => {
localStorageMock['theme'] = 'dark';

render(
<ThemeProvider>
<HelperComponent/>
</ThemeProvider>
)

expect(screen.getByTestId('theme').textContent).toBe('dark')
expect(screen.getByTestId('forcedTheme').textContent).toBe('')
})

test('should render light theme when forcedTheme is set a', () => {
localStorageMock['theme'] = 'dark'

act(() => {
render(<ThemeProvider forcedTheme="light">
<HelperComponent/>
</ThemeProvider>)
})

expect(screen.getByTestId('theme').textContent).toBe('dark')
expect(screen.getByTestId('forcedTheme').textContent).toBe('light')
test('should render saved theme when no forcedTheme is set', () => {
localStorageMock['theme'] = 'dark'

render(
<ThemeProvider>
<HelperComponent />
</ThemeProvider>
)

expect(screen.getByTestId('theme').textContent).toBe('dark')
expect(screen.getByTestId('forcedTheme').textContent).toBe('')
})

test('should render light theme when forcedTheme is set a', () => {
localStorageMock['theme'] = 'dark'

act(() => {
render(
<ThemeProvider forcedTheme="light">
<HelperComponent />
</ThemeProvider>
)
})

expect(screen.getByTestId('theme').textContent).toBe('dark')
expect(screen.getByTestId('forcedTheme').textContent).toBe('light')
})
})
Loading