Skip to content

feat: byA11yValue matcher #262

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.

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

Merged
merged 1 commit into from
Mar 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 34 additions & 0 deletions src/__tests__/a11yAPI.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class Button extends React.Component<any> {
accessibilityRole={TEXT_ROLE}
accessibilityStates={['selected']}
accessibilityState={{ expanded: false, selected: true }}
accessibilityValue={{ min: 40, max: 60 }}
>
{this.props.children}
</Typography>
Expand All @@ -50,6 +51,7 @@ function Section() {
accessibilityRole={TEXT_ROLE}
accessibilityStates={['selected', 'disabled']}
accessibilityState={{ expanded: false }}
accessibilityValue={{ max: 60 }}
>
Title
</Typography>
Expand Down Expand Up @@ -202,3 +204,35 @@ test('getAllByA11yState, queryAllByA11yState', () => {
expect(getAllByA11yState({ expanded: false }).length).toEqual(2);
expect(queryAllByA11yState({ expanded: false }).length).toEqual(2);
});

test('getByA11yValue, queryByA11yValue', () => {
const { getByA11yValue, queryByA11yValue } = render(<Section />);

expect(getByA11yValue({ min: 40 }).props.accessibilityValue).toEqual({
min: 40,
max: 60,
});
expect(queryByA11yValue({ min: 40 })?.props.accessibilityValue).toEqual({
min: 40,
max: 60,
});

expect(() => getByA11yValue({ min: 50 })).toThrow(NO_INSTANCES_FOUND);
expect(queryByA11yValue({ min: 50 })).toEqual(null);

expect(() => getByA11yValue({ max: 60 })).toThrow(FOUND_TWO_INSTANCES);
expect(() => queryByA11yValue({ max: 60 })).toThrow(FOUND_TWO_INSTANCES);
});

test('getAllByA11yValue, queryAllByA11yValue', () => {
const { getAllByA11yValue, queryAllByA11yValue } = render(<Section />);

expect(getAllByA11yValue({ min: 40 }).length).toEqual(1);
expect(queryAllByA11yValue({ min: 40 }).length).toEqual(1);

expect(() => getAllByA11yValue({ min: 50 })).toThrow(NO_INSTANCES_FOUND);
expect(queryAllByA11yValue({ min: 50 })).toEqual([]);

expect(getAllByA11yValue({ max: 60 }).length).toEqual(2);
expect(queryAllByA11yValue({ max: 60 }).length).toEqual(2);
});
18 changes: 17 additions & 1 deletion src/helpers/a11yAPI.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// @flow
import makeQuery from './makeQuery';
import type { A11yRole, A11yStates, A11yState } from '../types.flow';
import type { A11yRole, A11yStates, A11yState, A11yValue } from '../types.flow';

type GetReturn = ReactTestInstance;
type GetAllReturn = Array<ReactTestInstance>;
Expand Down Expand Up @@ -37,6 +37,12 @@ type A11yAPI = {|
getAllByA11yState: A11yState => GetAllReturn,
queryByA11yState: A11yState => QueryReturn,
queryAllByA11yState: A11yState => QueryAllReturn,

// Value
getByA11yValue: A11yValue => GetReturn,
getAllByA11yValue: A11yValue => GetAllReturn,
queryByA11yValue: A11yValue => QueryReturn,
queryAllByA11yValue: A11yValue => QueryAllReturn,
|};

export function matchStringValue(
Expand Down Expand Up @@ -129,6 +135,16 @@ const a11yAPI = (instance: ReactTestInstance): A11yAPI =>
},
matchObject
)(instance),
...makeQuery(
'accessibilityValue',
{
getBy: ['getByA11yValue', 'getByAccessibilityValue'],
getAllBy: ['getAllByA11yValue', 'getAllByAccessibilityValue'],
queryBy: ['queryByA11yValue', 'queryByAccessibilityValue'],
queryAllBy: ['queryAllByA11yValue', 'queryAllByAccessibilityValue'],
},
matchObject
)(instance),
}: any);

export default a11yAPI;
7 changes: 7 additions & 0 deletions src/types.flow.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,10 @@ export type A11yStates =
| 'expanded'
| 'collapsed'
| 'hasPopup';

export type A11yValue = {
min?: number,
max?: number,
now?: number,
text?: string,
};
5 changes: 5 additions & 0 deletions typings/__tests__/index.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,11 @@ const getAllByA11yState: Array<ReactTestInstance> = tree.getAllByA11yState({ bus
const queryByA11yState: ReactTestInstance = tree.queryByA11yState({ busy: true });
const queryAllByA11yState: Array<ReactTestInstance> = tree.queryAllByA11yState({ busy: true });

const getByA11yValue: ReactTestInstance = tree.getByA11yValue({ min: 10 });
const getAllByA11yValue: Array<ReactTestInstance> = tree.getAllByA11yValue({ min: 10 });
const queryByA11yValue: ReactTestInstance = tree.queryByA11yValue({ min: 10 });
const queryAllByA11yValue: Array<ReactTestInstance> = tree.queryAllByA11yValue({ min: 10 });

const debugFn = tree.debug();
const debugFnWithMessage = tree.debug('my message');

Expand Down
14 changes: 14 additions & 0 deletions typings/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@ type GetAllReturn = Array<ReactTestInstance>;
type QueryReturn = ReactTestInstance | null;
type QueryAllReturn = Array<ReactTestInstance> | [];

// Not yet available in DefinitelyTyped
export type A11yValue = {
min?: number,
max?: number,
now?: number,
text?: string,
};

type A11yAPI = {
// Label
getByA11yLabel: (matcher: string | RegExp) => GetReturn,
Expand Down Expand Up @@ -85,6 +93,12 @@ type A11yAPI = {
getAllByA11yState: (matcher: AccessibilityState) => GetAllReturn,
queryByA11yState: (matcher: AccessibilityState) => QueryReturn,
queryAllByA11yState: (matcher: AccessibilityState) => QueryAllReturn,

// Value
getByA11yValue: (matcher: A11yValue) => GetReturn,
getAllByA11yValue: (matcher: A11yValue) => GetAllReturn,
queryByA11yValue: (matcher: A11yValue) => QueryReturn,
queryAllByA11yValue: (matcher: A11yValue) => QueryAllReturn,
};

export interface Thenable {
Expand Down