@khanacademy/perseus-editor 0.0.1 → 0.1.0

package/src/widgets/explanation-editor.jsx

@@ -0,0 +1,89 @@
+/* eslint-disable react/forbid-prop-types */
+// @flow
+import {components, Changeable, EditorJsonify} from "@khanacademy/perseus";
+import PropTypes from "prop-types";
+import * as React from "react";
+import _ from "underscore";
+
+import Editor from "../editor.jsx";
+
+const {TextInput} = components;
+
+const defaultExplanationProps = {
+    showPrompt: "Explain",
+    hidePrompt: "Hide explanation",
+    explanation: "explanation goes here\n\nmore explanation",
+    widgets: {},
+};
+
+type Props = $FlowFixMe;
+type State = $FlowFixMe;
+
+class ExplanationEditor extends React.Component<Props, State> {
+    static propTypes = {
+        ...Changeable.propTypes,
+        showPrompt: PropTypes.string,
+        hidePrompt: PropTypes.string,
+        explanation: PropTypes.string,
+        widgets: PropTypes.object,
+        apiOptions: PropTypes.any,
+    };
+
+    static widgetName: "explanation" = "explanation";
+    static defaultProps: Props = defaultExplanationProps;
+    state: State = {};
+
+    change: ($FlowFixMe, $FlowFixMe, $FlowFixMe) => $FlowFixMe = (...args) => {
+        return Changeable.change.apply(this, args);
+    };
+
+    serialize: () => $FlowFixMe = () => {
+        return EditorJsonify.serialize.call(this);
+    };
+
+    render(): React.Node {
+        return (
+            <div className="perseus-widget-explanation-editor">
+                <div className="perseus-widget-row">
+                    <label>
+                        Prompt to show explanation:{" "}
+                        <TextInput
+                            value={this.props.showPrompt}
+                            onChange={this.change("showPrompt")}
+                        />
+                    </label>
+                </div>
+                <div className="perseus-widget-row">
+                    <label>
+                        Prompt to hide explanation:{" "}
+                        <TextInput
+                            value={this.props.hidePrompt}
+                            onChange={this.change("hidePrompt")}
+                        />
+                    </label>
+                </div>
+                <div className="perseus-widget-row">
+                    <Editor
+                        apiOptions={this.props.apiOptions}
+                        content={this.props.explanation}
+                        widgets={this.props.widgets}
+                        widgetEnabled={true}
+                        immutableWidgets={false}
+                        onChange={(props) => {
+                            const newProps = {};
+                            if (_.has(props, "content")) {
+                                newProps.explanation = props.content;
+                            }
+                            if (_.has(props, "widgets")) {
+                                newProps.widgets = props.widgets;
+                            }
+                            this.change(newProps);
+                        }}
+                    />
+                </div>
+            </div>
+        );
+    }
+}
+
+export default ExplanationEditor;

package/src/widgets/expression-editor.jsx

@@ -0,0 +1,559 @@
+/* eslint-disable one-var, react/forbid-prop-types, react/sort-comp */
+// @flow
+import {
+    components,
+    Changeable,
+    Dependencies,
+    Expression,
+} from "@khanacademy/perseus";
+import lens from "hubble";
+import KAS from "kas";
+import PropTypes from "prop-types";
+import * as React from "react";
+import _ from "underscore";
+
+import SortableArea from "../components/sortable.jsx";
+
+const {InfoTip, PropCheckBox, TexButtons} = components;
+const {getDependencies} = Dependencies;
+
+// An answer can be considered correct, wrong, or ungraded.
+const CONSIDERED = ["correct", "wrong", "ungraded"];
+
+const answerFormType = PropTypes.shape({
+    considered: PropTypes.oneOf(CONSIDERED).isRequired,
+    value: PropTypes.string.isRequired,
+    form: PropTypes.bool.isRequired,
+    simplify: PropTypes.bool.isRequired,
+});
+
+// Pick a key that isn't currently used by an answer in answerForms
+const _makeNewKey = (answerForms) => {
+    // first note all the currently used keys in an array, used like a map :3
+    // note that this automatically updates the array's length property to
+    // be one past the largest key.
+    const usedKeys = [];
+    answerForms.forEach((ans) => {
+        usedKeys[ans.key] = true;
+    });
+
+    // then scan through the array to find the first unused (undefined) key
+    for (let i = 0; i < usedKeys.length; i++) {
+        if (!usedKeys[i]) {
+            return i;
+        }
+    }
+
+    // if we didn't find a key, make one bigger than all the other keys,
+    // since that's how the length property is defined to work on arrays
+    return usedKeys.length;
+};
+
+class ExpressionEditor extends React.Component<$FlowFixMe, $FlowFixMe> {
+    static propTypes = {
+        ...Changeable.propTypes,
+        answerForms: PropTypes.arrayOf(answerFormType),
+        times: PropTypes.bool,
+        buttonSets: TexButtons.buttonSetsType,
+        functions: PropTypes.arrayOf(PropTypes.string),
+    };
+
+    static widgetName: "expression" = "expression";
+
+    static defaultProps: $FlowFixMe = {
+        answerForms: [],
+        times: false,
+        buttonSets: ["basic"],
+        functions: ["f", "g", "h"],
+    };
+
+    constructor(props: $FlowFixMe) {
+        super(props);
+        // Is the format of `value` TeX or plain text?
+        // TODO(alex): Remove after backfilling everything to TeX
+        // TODO(joel) - sucks if you edit some expression without
+        // backslashes or curly braces, then come back to the question and
+        // it's surprisingly not TeX anymore.
+
+        let isTex;
+        // default to TeX if new;
+        if (props.answerForms.length === 0) {
+            isTex = true;
+        } else {
+            isTex = _(props.answerForms).any((form) => {
+                const {value} = form;
+                // only TeX has backslashes and curly braces
+                return (
+                    _.indexOf(value, "\\") !== -1 ||
+                    _.indexOf(value, "{") !== -1
+                );
+            });
+        }
+
+        this.state = {isTex};
+    }
+
+    change: ($FlowFixMe, $FlowFixMe, $FlowFixMe) => $FlowFixMe = (...args) => {
+        return Changeable.change.apply(this, args);
+    };
+
+    render(): React.Node {
+        const answerOptions = this.props.answerForms
+            .map((obj, index) => {
+                const expressionProps = {
+                    // note we're using
+                    // *this.props*.{times,functions,buttonSets} since each
+                    // answer area has the same settings for those
+                    times: this.props.times,
+                    functions: this.props.functions,
+                    buttonSets: this.props.buttonSets,
+
+                    buttonsVisible: "focused",
+                    form: obj.form,
+                    simplify: obj.simplify,
+                    value: obj.value,
+
+                    onChange: (props) => this.updateForm(index, props),
+                    trackInteraction: () => {},
+
+                    widgetId: this.props.widgetId + "-" + index,
+                };
+
+                return lens(obj)
+                    .merge([], {
+                        draggable: true,
+                        onChange: (props) => this.updateForm(index, props),
+                        onDelete: () => this.handleRemoveForm(index),
+                        expressionProps: expressionProps,
+                    })
+                    .freeze();
+            })
+            .map((obj, index) => <AnswerOption key={index} {...obj} />);
+
+        const sortable = (
+            <SortableArea
+                components={answerOptions}
+                onReorder={this.handleReorder}
+                className="answer-options-list"
+            />
+        );
+
+        // checkboxes to choose which sets of input buttons are shown
+        const buttonSetChoices = _(TexButtons.buttonSets).map((set, name) => {
+            // The first one gets special cased to always be checked, disabled,
+            // and float left.
+            const isFirst = name === "basic";
+            const checked = _.contains(this.props.buttonSets, name) || isFirst;
+            const className = isFirst
+                ? "button-set-label-float"
+                : "button-set-label";
+            return (
+                <label className={className} key={name}>
+                    <input
+                        type="checkbox"
+                        checked={checked}
+                        disabled={isFirst}
+                        onChange={() => this.handleButtonSet(name)}
+                    />
+                    {name}
+                </label>
+            );
+        });
+
+        const {TeX} = getDependencies(); // OldExpression only
+
+        buttonSetChoices.splice(
+            1,
+            1,
+            <label key="show-div">
+                <input type="checkbox" onChange={this.handleToggleDiv} />
+                <span className="show-div-button">
+                    show <TeX>\div</TeX> button
+                </span>
+            </label>,
+        );
+
+        return (
+            <div className="perseus-widget-expression-editor">
+                <h3 className="expression-editor-h3">Global Options</h3>
+
+                <div>
+                    <PropCheckBox
+                        times={this.props.times}
+                        onChange={this.props.onChange}
+                        labelAlignment="right"
+                        label="Use × for rendering multiplication instead of a
+                        center dot."
+                    />
+                    <InfoTip>
+                        <p>
+                            For pre-algebra problems this option displays
+                            multiplication as \times instead of \cdot in both
+                            the rendered output and the acceptable formats
+                            examples.
+                        </p>
+                    </InfoTip>
+                </div>
+
+                <div>
+                    <label>
+                        {"Function variables: "}
+                        <input
+                            type="text"
+                            defaultValue={this.props.functions.join(" ")}
+                            onChange={this.handleFunctions}
+                        />
+                    </label>
+                    <InfoTip>
+                        <p>
+                            Single-letter variables listed here will be
+                            interpreted as functions. This let us know that f(x)
+                            means "f of x" and not "f times x".
+                        </p>
+                    </InfoTip>
+                </div>
+
+                <div>
+                    <div>Button sets:</div>
+                    {buttonSetChoices}
+                </div>
+
+                {this.state.isTex && (
+                    <TexButtons
+                        className="math-input-buttons"
+                        sets={this.props.buttonSets}
+                        convertDotToTimes={this.props.times}
+                        // onInsert is typed as `(string | ((input: $FlowFixMe) => void)) => void`
+                        // $FlowFixMe[incompatible-type]
+                        onInsert={this.handleTexInsert}
+                    />
+                )}
+
+                <h3 className="expression-editor-h3">Answers</h3>
+
+                <p style={{margin: "4px 0"}}>
+                    student responses area matched against these from top to
+                    bottom
+                </p>
+
+                {sortable}
+
+                <div>
+                    <button
+                        className="simple-button orange"
+                        style={{fontSize: 13}}
+                        onClick={this.newAnswer}
+                        type="button"
+                    >
+                        Add new answer
+                    </button>
+                </div>
+            </div>
+        );
+    }
+
+    serialize: () => $FlowFixMe = () => {
+        const formSerializables = [
+            "value",
+            "form",
+            "simplify",
+            "considered",
+            // it's a little weird to serialize the react key, but saves some
+            // effort reconstructing them when this item is loaded later.
+            "key",
+        ];
+        const serializables = [
+            "answerForms",
+            "buttonSets",
+            "functions",
+            "times",
+        ];
+
+        const answerForms = this.props.answerForms.map((form) => {
+            return _(form).pick(formSerializables);
+        });
+
+        return lens(this.props)
+            .set(["answerForms"], answerForms)
+            .mod([], (props) => _(props).pick(serializables))
+            .freeze();
+    };
+
+    getSaveWarnings: () => $FlowFixMe = () => {
+        const issues = [];
+
+        if (this.props.answerForms.length === 0) {
+            issues.push("No answers specified");
+        } else {
+            const hasCorrect = !!_(this.props.answerForms).find((form) => {
+                return form.considered === "correct";
+            });
+            if (!hasCorrect) {
+                issues.push("No correct answer specified");
+            }
+
+            _(this.props.answerForms).each((form, ix) => {
+                if (this.props.value === "") {
+                    issues.push(`Answer ${ix + 1} is empty`);
+                } else {
+                    // note we're not using icu for content creators
+                    const expression = KAS.parse(form.value, {
+                        functions: this.props.functions,
+                    });
+                    if (!expression.parsed) {
+                        issues.push(`Couldn't parse ${form.value}`);
+                    } else if (
+                        form.simplify &&
+                        !expression.expr.isSimplified()
+                    ) {
+                        issues.push(
+                            `${form.value} isn't simplified, but is required" +
+                            " to be`,
+                        );
+                    }
+                }
+            });
+
+            // TODO(joel) - warn about:
+            //   - unreachable answers (how??)
+            //   - specific answers following unspecific answers
+            //   - incorrect answers as the final form
+        }
+
+        return issues;
+    };
+
+    _newEmptyAnswerForm: () => $FlowFixMe = () => {
+        return {
+            considered: "correct",
+            form: false,
+
+            // note: the key means "n-th form created" - not "form in
+            // position n" and will stay the same for the life of this form
+            key: _makeNewKey(this.props.answerForms),
+
+            simplify: false,
+            value: "",
+        };
+    };
+
+    newAnswer: () => void = () => {
+        const answerForms = this.props.answerForms.slice();
+        answerForms.push(this._newEmptyAnswerForm());
+        this.change({answerForms});
+    };
+
+    handleRemoveForm: (number) => void = (i) => {
+        const answerForms = this.props.answerForms.slice();
+        answerForms.splice(i, 1);
+        this.change({answerForms});
+    };
+
+    // called when the options (including the expression itself) to an answer
+    // form change
+    updateForm: (number, $FlowFixMe) => void = (i, props) => {
+        const answerForms = lens(this.props.answerForms)
+            .merge([i], props)
+            .freeze();
+
+        this.change({answerForms});
+    };
+
+    handleReorder: ($FlowFixMe) => void = (components) => {
+        const answerForms = _(components).map((component) => {
+            const form = _(component.props).pick(
+                "considered",
+                "form",
+                "simplify",
+                "value",
+            );
+            form.key = component.key;
+            return form;
+        });
+
+        this.change({answerForms});
+    };
+
+    // called when the selected buttonset changes
+    handleButtonSet: (string) => void = (changingName) => {
+        const buttonSetNames = _(TexButtons.buttonSets).keys();
+
+        // Filter to preserve order - using .union and .difference would always
+        // move the last added button set to the end.
+        const buttonSets = _(buttonSetNames).filter((set) => {
+            return (
+                _(this.props.buttonSets).contains(set) !==
+                (set === changingName)
+            );
+        });
+
+        this.props.onChange({buttonSets});
+    };
+
+    handleToggleDiv: () => void = () => {
+        // We always want buttonSets to contain exactly one of "basic" and
+        // "basic+div". Toggle between the two of them.
+        // If someone can think of a more elegant formulation of this (there
+        // must be one!) feel free to change it.
+        let keep, remove;
+        if (_(this.props.buttonSets).contains("basic+div")) {
+            keep = "basic";
+            remove = "basic+div";
+        } else {
+            keep = "basic+div";
+            remove = "basic";
+        }
+
+        const buttonSets = _(this.props.buttonSets)
+            .reject((set) => set === remove)
+            .concat(keep);
+
+        this.change("buttonSets", buttonSets);
+    };
+
+    // called when the correct answer changes
+    handleTexInsert: (string) => void = (str) => {
+        // eslint-disable-next-line react/no-string-refs
+        this.refs.expression.insert(str);
+    };
+
+    // called when the function variables change
+    handleFunctions: (SyntheticInputEvent<>) => void = (e) => {
+        const newProps = {};
+        newProps.functions = _.compact(e.target.value.split(/[ ,]+/));
+        this.props.onChange(newProps);
+    };
+}
+
+// Find the next element in arr after val, wrapping around to the first.
+const findNextIn = function (arr, val) {
+    let ix = _(arr).indexOf(val);
+    ix = (ix + 1) % arr.length;
+    return arr[ix];
+};
+
+class AnswerOption extends React.Component<$FlowFixMe, $FlowFixMe> {
+    static propTypes = {
+        ...Changeable.propTypes,
+        considered: PropTypes.oneOf(CONSIDERED).isRequired,
+        expressionProps: PropTypes.object.isRequired,
+
+        // Must the answer have the same form as this answer.
+        form: PropTypes.bool.isRequired,
+
+        // Must the answer be simplified.
+        simplify: PropTypes.bool.isRequired,
+
+        onChange: PropTypes.func.isRequired,
+        onDelete: PropTypes.func.isRequired,
+    };
+
+    state: $FlowFixMe = {deleteFocused: false};
+
+    handleDeleteBlur = () => {
+        this.setState({deleteFocused: false});
+    };
+
+    change = (...args) => {
+        return Changeable.change.apply(this, args);
+    };
+
+    render(): React.Node {
+        let removeButton = null;
+        if (this.state.deleteFocused) {
+            removeButton = (
+                <button
+                    type="button"
+                    className="simple-button orange"
+                    onClick={this.handleImSure}
+                    onBlur={this.handleDeleteBlur}
+                >
+                    I'm sure!
+                </button>
+            );
+        } else {
+            removeButton = (
+                <button
+                    type="button"
+                    className="simple-button orange"
+                    onClick={this.handleDelete}
+                >
+                    Delete
+                </button>
+            );
+        }
+
+        return (
+            <div className="expression-answer-option">
+                <div className="answer-handle" />
+
+                <div className="answer-body">
+                    <div className="answer-considered">
+                        <div
+                            onClick={this.toggleConsidered}
+                            className={"answer-status " + this.props.considered}
+                        >
+                            {this.props.considered}
+                        </div>
+
+                        <div className="answer-expression">
+                            <Expression {...this.props.expressionProps} />
+                        </div>
+                    </div>
+
+                    <div className="answer-option">
+                        <PropCheckBox
+                            form={this.props.form}
+                            onChange={this.props.onChange}
+                            labelAlignment="right"
+                            label="Answer expression must have the same form."
+                        />
+                        <InfoTip>
+                            <p>
+                                The student's answer must be in the same form.
+                                Commutativity and excess negative signs are
+                                ignored.
+                            </p>
+                        </InfoTip>
+                    </div>
+
+                    <div className="answer-option">
+                        <PropCheckBox
+                            simplify={this.props.simplify}
+                            onChange={this.props.onChange}
+                            labelAlignment="right"
+                            label="Answer expression must be fully expanded and
+                            simplified."
+                        />
+                        <InfoTip>
+                            <p>
+                                The student's answer must be fully expanded and
+                                simplified. Answering this equation (x^2+2x+1)
+                                with this factored equation (x+1)^2 will render
+                                this response "Your answer is not fully expanded
+                                and simplified."
+                            </p>
+                        </InfoTip>
+                    </div>
+
+                    <div className="remove-container">{removeButton}</div>
+                </div>
+            </div>
+        );
+    }
+
+    handleImSure = () => {
+        this.props.onDelete();
+    };
+
+    handleDelete = () => {
+        this.setState({deleteFocused: true});
+    };
+
+    toggleConsidered = () => {
+        const newVal = findNextIn(CONSIDERED, this.props.considered);
+        this.change({considered: newVal});
+    };
+}
+
+export default ExpressionEditor;