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

feat(programming): establish editable test cases to be reorderable #7769

Merged
merged 2 commits into from
Feb 26, 2025
Merged

feat(programming): establish editable test cases to be reorderable #7769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
273c32e
refactor(testCases): prepare for reorderable
bivanalhar Jan 22, 2025
0088fb2
feat(testCases): make editable test cases reorderable
bivanalhar Jan 23, 2025
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
82 changes: 5 additions & 77 deletions .../app/bundles/course/assessment/pages/AssessmentGenerate/GenerateQuestionPrototypeForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import { FC, ReactNode } from 'react';
import { FC } from 'react';
import { Controller, FormProvider, UseFormReturn } from 'react-hook-form';
import { LockOpenOutlined, LockOutlined } from '@mui/icons-material';
import { Container, Divider, IconButton } from '@mui/material';
import { Container } from '@mui/material';
import { LanguageMode } from 'types/course/assessment/question/programming';

import EditorAccordion from 'course/assessment/question/programming/components/common/EditorAccordion';
import TestCases from 'course/assessment/question/programming/components/common/TestCases';
import { generationActions as actions } from 'course/assessment/reducers/generation';
import FormRichTextField from 'lib/components/form/fields/RichTextField';
import FormTextField from 'lib/components/form/fields/TextField';
Expand All @@ -14,31 +12,10 @@ import useTranslation from 'lib/hooks/useTranslation';

import translations from '../../translations';

import LockableSection from './LockableSection';
import TestCasesManager from './TestCasesManager';
import { QuestionPrototypeFormData } from './types';

interface LockableSectionProps {
onToggleLock: (key: string) => void;
children: ReactNode;
lockStateKey: string;
lockState: boolean;
}

const LockableSection: FC<LockableSectionProps> = (props) => (
<>
<div className="flex flex-nowrap">
<IconButton
centerRipple={false}
className="m-1 rounded-lg items-start"
onClick={() => props.onToggleLock(props.lockStateKey)}
>
{props.lockState ? <LockOutlined /> : <LockOpenOutlined />}
</IconButton>
{props.children}
</div>
<Divider className="my-4" variant="middle" />
</>
);

interface Props {
prototypeForm: UseFormReturn<QuestionPrototypeFormData>;
onToggleLock: (key: string) => void;
Expand Down Expand Up @@ -155,57 +132,8 @@ const GenerateQuestionPrototypeForm: FC<Props> = (props) => {
/>
</Container>
</LockableSection>
<LockableSection
lockState={lockStates['testUi.metadata.testCases.public']}
lockStateKey="testUi.metadata.testCases.public"
onToggleLock={onToggleLock}
>
<Container disableGutters maxWidth={false}>
<TestCases
disabled={lockStates['testUi.metadata.testCases.public']}
hintHeader={t(translations.hint)}
lhsHeader={t(translations.expression)}
name="testUi.metadata.testCases.public"
rhsHeader={t(translations.expected)}
title={t(translations.publicTestCases)}
/>
</Container>
</LockableSection>
<LockableSection
lockState={lockStates['testUi.metadata.testCases.private']}
lockStateKey="testUi.metadata.testCases.private"
onToggleLock={onToggleLock}
>
<Container disableGutters maxWidth={false}>
<TestCases
disabled={lockStates['testUi.metadata.testCases.private']}
hintHeader={t(translations.hint)}
lhsHeader={t(translations.expression)}
name="testUi.metadata.testCases.private"
rhsHeader={t(translations.expected)}
subtitle={t(translations.privateTestCasesHint)}
title={t(translations.privateTestCases)}
/>
</Container>
</LockableSection>

<LockableSection
lockState={lockStates['testUi.metadata.testCases.evaluation']}
lockStateKey="testUi.metadata.testCases.evaluation"
onToggleLock={onToggleLock}
>
<Container disableGutters maxWidth={false}>
<TestCases
disabled={lockStates['testUi.metadata.testCases.evaluation']}
hintHeader={t(translations.hint)}
lhsHeader={t(translations.expression)}
name="testUi.metadata.testCases.evaluation"
rhsHeader={t(translations.expected)}
subtitle={t(translations.evaluationTestCasesHint)}
title={t(translations.evaluationTestCases)}
/>
</Container>
</LockableSection>
<TestCasesManager lockStates={lockStates} onToggleLock={onToggleLock} />
</FormProvider>
);
};
Expand Down
28 changes: 28 additions & 0 deletions client/app/bundles/course/assessment/pages/AssessmentGenerate/LockableSection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { FC, ReactNode } from 'react';
import { LockOpenOutlined, LockOutlined } from '@mui/icons-material';
import { Divider, IconButton } from '@mui/material';

interface LockableSectionProps {
onToggleLock: (key: string) => void;
children: ReactNode;
lockStateKey: string;
lockState: boolean;
}

const LockableSection: FC<LockableSectionProps> = (props) => (
<>
<div className="flex flex-nowrap">
<IconButton
centerRipple={false}
className="m-1 rounded-lg items-start"
onClick={() => props.onToggleLock(props.lockStateKey)}
>
{props.lockState ? <LockOutlined /> : <LockOpenOutlined />}
</IconButton>
{props.children}
</div>
<Divider className="my-4" variant="middle" />
</>
);

export default LockableSection;
95 changes: 95 additions & 0 deletions client/app/bundles/course/assessment/pages/AssessmentGenerate/TestCasesManager.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
import { FC } from 'react';
import { useFormContext, useWatch } from 'react-hook-form';
import { DragDropContext, DropResult } from '@hello-pangea/dnd';
import { Container } from '@mui/material';
import { ProgrammingFormData } from 'types/course/assessment/question/programming';

import ReorderableTestCases from 'course/assessment/question/programming/components/common/ReorderableTestCases';
import { rearrangeTestCases } from 'course/assessment/question/programming/operations';
import useTranslation from 'lib/hooks/useTranslation';

import translations from '../../translations';

import LockableSection from './LockableSection';

interface TestCasesManagerProps {
lockStates: { [key: string]: boolean };
onToggleLock: (key: string) => void;
}

const TestCasesManager: FC<TestCasesManagerProps> = (props) => {
const { t } = useTranslation();
const { lockStates, onToggleLock } = props;

const { control, setValue } = useFormContext<ProgrammingFormData>();
const testCases = useWatch({ control, name: 'testUi.metadata.testCases' });

const onRearrangingTestCases = (result: DropResult): void => {
rearrangeTestCases(result, testCases, setValue);
};

return (
<DragDropContext onDragEnd={onRearrangingTestCases}>
<LockableSection
lockState={lockStates['testUi.metadata.testCases.public']}
lockStateKey="testUi.metadata.testCases.public"
onToggleLock={onToggleLock}
>
<Container disableGutters maxWidth={false}>
<ReorderableTestCases
control={control}
disabled={lockStates['testUi.metadata.testCases.public']}
hintHeader={t(translations.hint)}
lhsHeader={t(translations.expression)}
name="testUi.metadata.testCases.public"
rhsHeader={t(translations.expected)}
testCases={testCases.public}
title={t(translations.publicTestCases)}
/>
</Container>
</LockableSection>

<LockableSection
lockState={lockStates['testUi.metadata.testCases.private']}
lockStateKey="testUi.metadata.testCases.private"
onToggleLock={onToggleLock}
>
<Container disableGutters maxWidth={false}>
<ReorderableTestCases
control={control}
disabled={lockStates['testUi.metadata.testCases.private']}
hintHeader={t(translations.hint)}
lhsHeader={t(translations.expression)}
name="testUi.metadata.testCases.private"
rhsHeader={t(translations.expected)}
subtitle={t(translations.privateTestCasesHint)}
testCases={testCases.private}
title={t(translations.privateTestCases)}
/>
</Container>
</LockableSection>

<LockableSection
lockState={lockStates['testUi.metadata.testCases.evaluation']}
lockStateKey="testUi.metadata.testCases.evaluation"
onToggleLock={onToggleLock}
>
<Container disableGutters maxWidth={false}>
<ReorderableTestCases
control={control}
disabled={lockStates['testUi.metadata.testCases.evaluation']}
hintHeader={t(translations.hint)}
lhsHeader={t(translations.expression)}
name="testUi.metadata.testCases.evaluation"
rhsHeader={t(translations.expected)}
subtitle={t(translations.evaluationTestCasesHint)}
testCases={testCases.evaluation}
title={t(translations.evaluationTestCases)}
/>
</Container>
</LockableSection>
</DragDropContext>
);
};

export default TestCasesManager;
77 changes: 77 additions & 0 deletions ...bundles/course/assessment/question/programming/components/ReorderableTestCasesManager.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import { FC } from 'react';
import { useFormContext, useWatch } from 'react-hook-form';
import { DragDropContext, DropResult } from '@hello-pangea/dnd';
import { ProgrammingFormData } from 'types/course/assessment/question/programming';

import useTranslation from 'lib/hooks/useTranslation';

import translations from '../../../translations';
import { rearrangeTestCases } from '../operations';

import ReorderableTestCases, {
ReorderableTestCasesProps,
} from './common/ReorderableTestCases';

export interface ReorderableTestCasesManagerProps
extends Omit<
ReorderableTestCasesProps,
'testCases' | 'hintHeader' | 'title' | 'control'
> {}

const ReorderableTestCasesManager: FC<ReorderableTestCasesManagerProps> = (
props,
) => {
const { t } = useTranslation();
const { component, disabled, lhsHeader, rhsHeader } = props;
const { control, setValue } = useFormContext<ProgrammingFormData>();

const testCases = useWatch({ control, name: 'testUi.metadata.testCases' });

const onRearrangingTestCases = (result: DropResult): void => {
rearrangeTestCases(result, testCases, setValue);
};

return (
<DragDropContext onDragEnd={onRearrangingTestCases}>
<ReorderableTestCases
component={component}
control={control}
disabled={disabled}
hintHeader={t(translations.hint)}
lhsHeader={lhsHeader}
name="testUi.metadata.testCases.public"
rhsHeader={rhsHeader}
testCases={testCases?.public ?? []}
title={t(translations.publicTestCases)}
/>

<ReorderableTestCases
component={component}
control={control}
disabled={props.disabled}
hintHeader={t(translations.hint)}
lhsHeader={lhsHeader}
name="testUi.metadata.testCases.private"
rhsHeader={rhsHeader}
subtitle={t(translations.privateTestCasesHint)}
testCases={testCases?.private ?? []}
title={t(translations.privateTestCases)}
/>

<ReorderableTestCases
component={component}
control={control}
disabled={props.disabled}
hintHeader={t(translations.hint)}
lhsHeader={lhsHeader}
name="testUi.metadata.testCases.evaluation"
rhsHeader={rhsHeader}
subtitle={t(translations.evaluationTestCasesHint)}
testCases={testCases?.evaluation ?? []}
title={t(translations.evaluationTestCases)}
/>
</DragDropContext>
);
};

export default ReorderableTestCasesManager;
11 changes: 5 additions & 6 deletions .../app/bundles/course/assessment/question/programming/components/common/ExpressionField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ interface ExpressionFieldProps {
onChange?: (value: string) => void;
plain?: boolean;
disabled?: boolean;
label?: string;
}

const ExpressionField = forwardRef<HTMLDivElement, ExpressionFieldProps>(
(props, ref): JSX.Element => (
<div className="flex h-full flex-col">
<div className="flex h-full w-[27%] flex-col">
<TextField
ref={ref}
className={`-mx-2 h-full rounded-lg ${
Expand All @@ -23,19 +24,17 @@ const ExpressionField = forwardRef<HTMLDivElement, ExpressionFieldProps>(
}`}
disabled={props.disabled}
fullWidth
hiddenLabel
InputProps={{
className: `p-2 text-[1.3rem] h-full ${
props.plain ? '' : 'font-mono'
}`,
className: `text-[1.3rem] h-full ${props.plain ? '' : 'font-mono'}`,
disableUnderline: true,
}}
label={props.label ?? ''}
multiline
onChange={(e): void => props.onChange?.(e.target.value)}
size="small"
spellCheck={false}
value={props.value}
variant="standard"
variant="filled"
/>

{props.error && (
Expand Down
Loading