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.

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

Implementing bulk updating for headings sequence rule. #140

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
1 change: 0 additions & 1 deletion src/components/__tests__/__snapshots__/checker.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,6 @@ exports[`render matches snapshot with errors 1`] = `
>
<Link
color="link"
forceButtonRole={true}
href="http://some-url"
iconPlacement="start"
isWithinText={true}
Expand Down
104 changes: 80 additions & 24 deletions src/components/__tests__/checker.js
Original file line number Diff line number Diff line change
Expand Up @@ -329,35 +329,91 @@ describe("formStateValid", () => {
describe("fixIssue", () => {
let ev, error

beforeEach(async () => {
await promisify(instance.check.bind(instance))()
component.update()
error = instance.state.errors[0]
ev = { preventDefault: jest.fn() }
jest.spyOn(instance, "check")
})
describe("_fixSingleError", () => {
beforeEach(async () => {
await promisify(instance.check.bind(instance))()
component.update()
error = instance.state.errors[0]
ev = { preventDefault: jest.fn() }
jest.spyOn(instance, "check")
})

test("updates the real node", () => {
instance.fixIssue(ev)
const formState = instance.state.formState
expect(error.rule.update).toHaveBeenCalledWith(error.node, formState)
})
test("updates the real node", () => {
instance.fixIssue(ev)
const formState = instance.state.formState
expect(error.rule.update).toHaveBeenCalledWith(error.node, formState)
})

test("checks everything after applying a fix", () => {
instance.fixIssue(ev)
expect(instance.check).toHaveBeenCalled()
})
test("checks everything after applying a fix", () => {
instance.fixIssue(ev)
expect(instance.check).toHaveBeenCalled()
})

test("does nothing if there are no errors", () => {
instance.state.errors = []
instance.fixIssue(ev)
expect(instance.check).not.toHaveBeenCalled()
})

test("does nothing if there are no errors", () => {
instance.state.errors = []
instance.fixIssue(ev)
expect(instance.check).not.toHaveBeenCalled()
test("focuses the close button", () => {
instance._closeButtonRef = { focus: jest.fn() }
instance.fixIssue(ev)
expect(instance._closeButtonRef.focus).toHaveBeenCalled()
})
})

test("focuses the close button", () => {
instance._closeButtonRef = { focus: jest.fn() }
instance.fixIssue(ev)
expect(instance._closeButtonRef.focus).toHaveBeenCalled()
describe("_fixBulkError", () => {
beforeEach(async () => {
node.appendChild(document.createElement("div"))

await promisify(instance.check.bind(instance))()
component.update()
error = instance.state.errors[0]
ev = { preventDefault: jest.fn() }
jest.spyOn(instance, "check")

const newErrors = instance.state.errors
newErrors.forEach(err => (err.rule.bulkUpdateSupported = true))
component.setState({ errors: newErrors, formStateBulkUpdateEnabled: true })
})

test("updates the real nodes", () => {
const [error1, error2, error3] = instance.state.errors
instance.fixIssue(ev)
const formState = instance.state.formState
expect(error1.rule.update).toHaveBeenCalledWith(error1.node, formState)
expect(error2.rule.update).toHaveBeenCalledWith(error2.node, formState)
expect(error3.rule.update).toHaveBeenCalledWith(error3.node, formState)
})

test("does not update the other error node", async () => {
const newErrors = instance.state.errors
newErrors[2].rule = {...newErrors[0].rule, id: 'another-error', update: jest.fn()}
component.setState({ errors: newErrors, formStateBulkUpdateEnabled: true })
const [error1, error2, error3] = instance.state.errors
instance.fixIssue(ev)
const formState = instance.state.formState
expect(error1.rule.update).toHaveBeenCalledWith(error1.node, formState)
expect(error2.rule.update).toHaveBeenCalledWith(error2.node, formState)
expect(error3.rule.update).not.toHaveBeenCalled()
})

test("checks everything after applying a fix", () => {
instance.fixIssue(ev)
expect(instance.check).toHaveBeenCalled()
})

test("does nothing if there are no errors", () => {
instance.state.errors = []
instance.fixIssue(ev)
expect(instance.check).not.toHaveBeenCalled()
})

test("focuses the close button", () => {
instance._closeButtonRef = { focus: jest.fn() }
instance.fixIssue(ev)
expect(instance._closeButtonRef.focus).toHaveBeenCalled()
})
})
})

Expand Down
57 changes: 54 additions & 3 deletions src/components/checker.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export default class Checker extends React.Component {
errors: [],
formState: {},
formStateValid: false,
formStateBulkUpdateEnabled: false,
errorIndex: 0,
config: {},
showWhyPopover: false,
Expand Down Expand Up @@ -206,6 +207,7 @@ export default class Checker extends React.Component {
this.setState({
formState,
formStateValid: this.formStateValid(formState),
formStateBulkUpdateEnabled: false,
})
}

Expand All @@ -224,7 +226,7 @@ export default class Checker extends React.Component {
return rule.test(node)
}

fixIssue() {
_fixNode(doneCallback) {
const rule = this.errorRule()
let node = this.errorNode()
if (rule && node) {
Expand All @@ -234,8 +236,44 @@ export default class Checker extends React.Component {
if (this._closeButtonRef) {
this._closeButtonRef.focus()
}
const errorIndex = this.state.errorIndex
this.check(() => this.setErrorIndex(errorIndex))
this.check(doneCallback)
}
}

_findMatchErrorIndexes(ruleId) {
return this.state.errors.reduce((result, {rule}, index) => {
if (rule.id === ruleId) {
result.push(index)
}
return result
}, [])
}

_fixSingleError() {
const errorIndex = this.state.errorIndex
this._fixNode(() => this.setErrorIndex(errorIndex))
}

_fixBulkError() {
const fixMatchedErrors = (ruleId) => {
const indexes = this._findMatchErrorIndexes(ruleId)
if (indexes.length === 0) {
return
}
const errorIndex = indexes[0]
this.setErrorIndex(errorIndex)
this._fixNode(fixMatchedErrors)
}
const rule = this.errorRule()
this._fixNode(() => fixMatchedErrors(rule.id))
}

fixIssue() {
const rule = this.errorRule()
if (this.state.formStateBulkUpdateEnabled && rule?.bulkUpdateSupported) {
this._fixBulkError()
} else {
this._fixSingleError()
}
}

Expand Down Expand Up @@ -295,6 +333,8 @@ export default class Checker extends React.Component {
num: this.state.errorIndex + 1,
total: this.state.errors.length,
})
const showBulkUpdate = rule && rule.bulkUpdateSupported && this._findMatchErrorIndexes(rule.id).length > 1 &&
this.state.formStateValid

return (
<LiveAnnouncer>
Expand Down Expand Up @@ -410,6 +450,17 @@ export default class Checker extends React.Component {
{this.renderField(f)}
</View>
))}
{
showBulkUpdate &&
<View as="div" margin="medium 0">
<Checkbox
label={formatMessage("Bulk update")}
name="bulk-update"
checked={this.state.formStateBulkUpdateEnabled}
onChange={(e) => this.setState({formStateBulkUpdateEnabled: e.target.checked})}
/>
</View>
}
<View as="div" margin="medium 0">
<Grid
vAlign="middle"
Expand Down
3 changes: 2 additions & 1 deletion src/rules/__mocks__/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export default [
message: jest.fn().mockReturnValue("Error Message"),
why: jest.fn().mockReturnValue("Why Text"),
link: "http://some-url",
linkText: jest.fn().mockReturnValue("Link for learning more")
linkText: jest.fn().mockReturnValue("Link for learning more"),
id: "mock-error"
}
]
1 change: 1 addition & 0 deletions src/rules/headings-sequence.js
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ const getValidHeadings = elem => {

export default {
id: "headings-sequence",
bulkUpdateSupported: true,
test: elem => {
const testTags = {
H2: true,
Expand Down