@@ -314,7 +325,7 @@ export class SummaryPanel extends React.Component { /> diff --git a/app/javascript/Components/Result/text_viewer.jsx b/app/javascript/Components/Result/text_viewer.jsx index 64cf0ef2d5..16f161bf99 100644 --- a/app/javascript/Components/Result/text_viewer.jsx +++ b/app/javascript/Components/Result/text_viewer.jsx @@ -1,5 +1,6 @@ import React from "react"; import Prism from "prismjs"; +import {TextAnnotationManager} from "../../common/annotations/text_annotation_manager"; export class TextViewer extends React.PureComponent { constructor(props) { @@ -144,7 +145,7 @@ export class TextViewer extends React.PureComponent { this.highlight_root.style.font_size = this.state.fontSize + "em"; if (this.props.resultView) { - window.annotation_type = ANNOTATION_TYPES.CODE; + window.annotation_type = window.ANNOTATION_TYPES.CODE; window.annotation_manager = new TextAnnotationManager(this.raw_content.current.children); this.annotation_manager = window.annotation_manager; diff --git a/app/javascript/Components/__tests__/course_cards.test.jsx b/app/javascript/Components/__tests__/course_cards.test.jsx new file mode 100644 index 0000000000..8defd18a4e --- /dev/null +++ b/app/javascript/Components/__tests__/course_cards.test.jsx @@ -0,0 +1,28 @@ +import React from "react"; +import {render, screen} from "@testing-library/react"; +import CourseCard from "../course_cards"; + +describe("CourseCard", () => { + beforeEach(() => { + global.Routes = { + course_path: id => `/courses/${id}`, + course_assignments_path: id => `/courses/${id}/assignments`, + }; + }); + + const baseProps = { + course_id: 1, + course_name: "CSC108", + course_display_name: "Intro to CS", + }; + + it("uses the course page link for instructors", () => { + render(); + expect(screen.getByRole("link")).toHaveAttribute("href", "/courses/1"); + }); + + it("uses the assignments page link for non-instructors", () => { + render(); + expect(screen.getByRole("link")).toHaveAttribute("href", "/courses/1/assignments"); + }); +}); diff --git a/app/javascript/Components/__tests__/course_list.test.jsx b/app/javascript/Components/__tests__/course_list.test.jsx new file mode 100644 index 0000000000..7c6cfc7f79 --- /dev/null +++ b/app/javascript/Components/__tests__/course_list.test.jsx @@ -0,0 +1,108 @@ +import React from "react"; +import {render, screen, waitFor} from "@testing-library/react"; +import {CourseList, makeCourseList} from "../course_list.jsx"; +import fetchMock from "jest-fetch-mock"; +import {createRoot} from "react-dom/client"; + +jest.mock("../course_cards", () => { + return function MockCourseCard(props) { + return {props.course_name}; + }; +}); + +jest.mock("react-dom/client", () => ({ + createRoot: jest.fn(() => ({ + render: jest.fn(), + })), +})); + +describe("CourseList", () => { + beforeAll(() => { + jest.useFakeTimers(); + jest.setSystemTime(new Date("2026-01-01T00:00:00-04:00")); + fetchMock.enableMocks(); + }); + + beforeEach(() => { + global.Routes = {courses_path: () => "/courses"}; + }); + + afterAll(() => { + jest.useRealTimers(); + }); + + afterEach(() => { + fetchMock.resetMocks(); + }); + + const createCourse = ({id, name, role, endAt}) => ({ + "courses.id": id, + "courses.name": name, + "roles.type": role, + "courses.end_at": endAt, + }); + + it("shows both headings and no courses message when no course related to the user", async () => { + fetchMock.mockResponseOnce(JSON.stringify({data: []})); + render(); + + await waitFor(() => { + expect(screen.getByText(I18n.t("courses.current_courses"))).toBeInTheDocument(); + expect(screen.getByText(I18n.t("courses.past_courses"))).toBeInTheDocument(); + expect(screen.getAllByText(I18n.t("courses.no_courses"))).toHaveLength(2); + }); + }); + + it("shows no course message under Past Courses if there are no past courses", async () => { + const courses = [ + createCourse({id: 1, name: "csc108", role: "Student", endAt: "2026-04-27T00:00:00-04:00"}), + ]; + + fetchMock.mockResponseOnce(JSON.stringify({data: courses})); + render(); + + await waitFor(() => { + expect(screen.getByText(I18n.t("courses.current_courses"))).toBeInTheDocument(); + expect(screen.getByText("csc108")).toBeInTheDocument(); + expect(screen.getByText(I18n.t("courses.past_courses"))).toBeInTheDocument(); + expect(screen.getByText(I18n.t("courses.no_courses"))).toBeInTheDocument(); + }); + }); + + it("shows no course message under Current Courses if there are no current courses", async () => { + const courses = [ + createCourse({id: 1, name: "csc108", role: "Student", endAt: "2025-04-27T00:00:00-04:00"}), + ]; + + fetchMock.mockResponseOnce(JSON.stringify({data: courses})); + render(); + + await waitFor(() => { + expect(screen.getByText(I18n.t("courses.past_courses"))).toBeInTheDocument(); + expect(screen.getByText("csc108")).toBeInTheDocument(); + expect(screen.getByText(I18n.t("courses.current_courses"))).toBeInTheDocument(); + expect(screen.getByText(I18n.t("courses.no_courses"))).toBeInTheDocument(); + }); + }); +}); + +describe("makeCourseList", () => { + beforeEach(() => { + createRoot.mockClear(); + }); + + it("calls createRoot and renders CourseList", () => { + const container = document.createElement("div"); + const props = {foo: "bar"}; + + makeCourseList(container, props); + + expect(createRoot).toHaveBeenCalledWith(container); + + const root = createRoot.mock.results[0].value; + expect(root.render).toHaveBeenCalledTimes(1); + + const element = root.render.mock.calls[0][0]; + expect(element.type).toBe(CourseList); + }); +}); diff --git a/app/javascript/Components/__tests__/course_summaries.test.jsx b/app/javascript/Components/__tests__/course_summaries.test.jsx index fa0c7b7b26..f3f1fdb85e 100644 --- a/app/javascript/Components/__tests__/course_summaries.test.jsx +++ b/app/javascript/Components/__tests__/course_summaries.test.jsx @@ -36,7 +36,7 @@ describe("CourseSummaryTable show/hide inactive students", () => { }); it("updateShowHidden correctly updates state and columnFilters", () => { - const table = new CourseSummaryTable({}); + const table = new CourseSummaryTable({assessments: [], marking_schemes: []}); // Spy on setState const setStateSpy = jest.spyOn(table, "setState"); @@ -69,7 +69,7 @@ describe("CourseSummaryTable show/hide inactive students", () => { }); it("updateShowHidden preserves other column filters", () => { - const table = new CourseSummaryTable({}); + const table = new CourseSummaryTable({assessments: [], marking_schemes: []}); const setStateSpy = jest.spyOn(table, "setState"); // Set up state with multiple filters @@ -109,7 +109,7 @@ describe("CourseSummaryTable show/hide inactive students", () => { describe("For CourseSummaryTable nameColumns,", () => { it("filterFn correctly hides rows when hidden=true", () => { - const table = new CourseSummaryTable({}); + const table = new CourseSummaryTable({assessments: [], marking_schemes: []}); const [hiddenColumn] = table.nameColumns(); const filterFn = hiddenColumn.filterFn; @@ -124,7 +124,7 @@ describe("For CourseSummaryTable nameColumns,", () => { }); it("filterFn shows all rows when filterValue is true", () => { - const table = new CourseSummaryTable({}); + const table = new CourseSummaryTable({assessments: [], marking_schemes: []}); const [hiddenColumn] = table.nameColumns(); const filterFn = hiddenColumn.filterFn; @@ -159,7 +159,7 @@ describe("CourseSummaryTable dataColumns", () => { const marking_schemes = [{id: 2, name: "Scheme1"}]; const table = new CourseSummaryTable({assessments, marking_schemes}); - const columns = table.dataColumns(); + const columns = table.dataColumns(assessments, marking_schemes); expect(columns.length).toBe(2); }); @@ -183,7 +183,7 @@ describe("CourseSummaryTable manual filtering", () => { const assessments = [{id: 1, name: "A1"}]; const marking_schemes = []; const table = new CourseSummaryTable({assessments, marking_schemes}); - const columns = table.dataColumns(); + const columns = table.dataColumns(assessments, marking_schemes); const assessmentColumn = columns[0]; const filterFn = assessmentColumn.filterFn; @@ -206,7 +206,7 @@ describe("CourseSummaryTable manual filtering", () => { const assessments = []; const marking_schemes = [{id: 1, name: "Scheme1"}]; const table = new CourseSummaryTable({assessments, marking_schemes}); - const columns = table.dataColumns(); + const columns = table.dataColumns(assessments, marking_schemes); const schemeColumn = columns[0]; const filterFn = schemeColumn.filterFn; @@ -233,7 +233,7 @@ describe("CourseSummaryTable manual filtering", () => { const assessments = [{id: 1, name: "A1"}]; const marking_schemes = []; const table = new CourseSummaryTable({assessments, marking_schemes}); - const columns = table.dataColumns(); + const columns = table.dataColumns(assessments, marking_schemes); const assessmentColumn = columns[0]; const filterFn = assessmentColumn.filterFn; diff --git a/app/javascript/Components/__tests__/grade_breakdown_chart.test.jsx b/app/javascript/Components/__tests__/grade_breakdown_chart.test.jsx new file mode 100644 index 0000000000..11a818b5a0 --- /dev/null +++ b/app/javascript/Components/__tests__/grade_breakdown_chart.test.jsx @@ -0,0 +1,158 @@ +import React from "react"; +import {render, screen} from "@testing-library/react"; +import {GradeBreakdownChart} from "../Assessment_Chart/grade_breakdown_chart"; + +jest.mock("react-chartjs-2", () => ({ + Bar: jest.fn(() => Bar Chart), +})); + +jest.mock("../Assessment_Chart/fraction_stat", () => ({ + FractionStat: ({numerator, denominator}) => ( + + {numerator}/{denominator} + + ), +})); + +jest.mock("../Assessment_Chart/core_statistics", () => ({ + CoreStatistics: () => , +})); + +jest.mock("../table/table", () => { + return function MockTable(props) { + const firstRow = props.data[0]; + + // Execute getRowCanExpand + if (props.getRowCanExpand) { + props.getRowCanExpand(); + } + + // Execute hidden column callbacks (header & cell) + const renderedCells = props.columns.map(col => { + if (typeof col.header === "function") { + col.header(); + } + + if (typeof col.cell === "function") { + return {col.cell({row: {original: firstRow}})}; + } + + return null; + }); + + return ( + + {props.columns.length} columns + {props.data.length} rows + {renderedCells} + + {props.renderSubComponent && props.renderSubComponent({row: {original: firstRow}})} + + ); + }; +}); + +describe("GradeBreakdownChart when summary data exists", () => { + const defaultProps = { + show_stats: true, + summary: [ + { + name: "Quiz 1", + position: 1, + average: 85, + median: 87, + max_mark: 100, + standard_deviation: 10, + num_zeros: 2, + }, + { + name: "Quiz 2", + position: 2, + average: 90, + median: 92, + max_mark: 100, + standard_deviation: 8, + num_zeros: 1, + }, + ], + chart_title: "Grade Distribution", + distribution_data: { + labels: ["0-10", "11-20", "21-30"], + datasets: [{data: [5, 10, 15]}], + }, + item_name: "Test Quiz", + num_groupings: 50, + create_link: "/quizzes/new", + }; + + it("renders the bar chart", () => { + render(); + expect(screen.getByTestId("bar-chart")).toBeInTheDocument(); + }); + + it("renders the summary table when show_stats is true", () => { + render(); + expect(screen.getByTestId("mock-table")).toBeInTheDocument(); + }); + + it("does not render the summary table when show_stats is false", () => { + render(); + expect(screen.queryByTestId("mock-table")).not.toBeInTheDocument(); + }); + + it("passes correct number of columns to table", () => { + render(); + // 3 columns: position (hidden), name, average + expect(screen.getByTestId("table-columns")).toHaveTextContent("3 columns"); + }); + + it("passes summary data to table", () => { + render(); + expect(screen.getByTestId("table-data")).toHaveTextContent("2 rows"); + }); + + it("renders FractionStat for average column", () => { + render(); + expect(screen.getByTestId("fraction-stat")).toHaveTextContent("85/100"); + }); + + it("renders CoreStatistics when row is expanded", () => { + render(); + expect(screen.getByTestId("core-statistics")).toBeInTheDocument(); + }); + + it("sorts legend labels and tables rows by position", () => { + render(); + + const BarMock = require("react-chartjs-2").Bar; + const barProps = BarMock.mock.calls[0][0]; + const sortFn = barProps.options.plugins.legend.labels.sort; + + const a = {text: "Quiz 2"}; + const b = {text: "Quiz 1"}; + expect(sortFn(a, b)).toBeGreaterThan(0); + + const table = screen.getByTestId("mock-table"); + expect(table).toBeInTheDocument(); + expect(screen.getByTestId("table-columns")).toHaveTextContent("3 columns"); + }); +}); + +describe("GradeBreakdownChart when summary data is empty", () => { + const emptyProps = { + show_stats: true, + summary: [], + chart_title: "Grade Distribution", + distribution_data: { + labels: ["0-10", "11-20", "21-30"], + datasets: [{data: [5, 10, 15]}], + }, + item_name: "Test Quiz", + num_groupings: 50, + create_link: "/quizzes/new", + }; + it("does not render the summary table", () => { + render(); + expect(screen.queryByTestId("mock-table")).not.toBeInTheDocument(); + }); +}); diff --git a/app/javascript/Components/__tests__/student_table.test.jsx b/app/javascript/Components/__tests__/student_table.test.jsx index 2584ee865a..cf6948c65b 100644 --- a/app/javascript/Components/__tests__/student_table.test.jsx +++ b/app/javascript/Components/__tests__/student_table.test.jsx @@ -2,10 +2,9 @@ * Tests for the StudentTable component */ -import {StudentTable} from "../student_table"; +import {StudentTable, StudentsActionBox} from "../student_table"; import {render, screen, within, fireEvent, waitFor} from "@testing-library/react"; import userEvent from "@testing-library/user-event"; -import {CourseSummaryTable} from "../course_summaries_table"; describe("For the StudentTable component's states and props", () => { describe("submitting the child StudentsActionBox component", () => { @@ -23,106 +22,46 @@ describe("For the StudentTable component's states and props", () => { }); describe("each filterable column has a custom filter method", () => { - let wrapper = React.createRef(); - let filter_method; - + let instance; beforeEach(() => { - render(); + render( (instance = r)} />); }); - describe("the filter method for the section column", () => { - beforeEach(() => { - filter_method = - wrapper.current.wrapped.checkboxTable.wrappedInstance.props.columns[6].filterMethod; - }); - - it("returns true when the selected value is all", () => { - expect(filter_method({value: "all"})).toEqual(true); - }); - - it("returns true when the row's section index equals to the selected value", () => { - // Sets data.sections - wrapper.current.wrapped.state.data.sections = {1: "LEC0101", 2: "LEC0201"}; - // Sample row - const sample_row = {section: 1}; - expect(filter_method({id: "section", value: "LEC0101"}, sample_row)).toEqual(true); - }); - - it("returns false when the row's section index doesn't equal to the selected value", () => { - // Sets data.sections - wrapper.current.wrapped.state.data.sections = {1: "LEC0101", 2: "LEC0201"}; - // Sample row - const sample_row = {section: 2}; - expect(filter_method({id: "section", value: "LEC0101"}, sample_row)).toEqual(false); - }); + const makeRow = values => ({ + getValue: columnId => values[columnId], + original: values, }); describe("the filter method for the grace credits column", () => { + let filterFn; beforeEach(() => { - filter_method = - wrapper.current.wrapped.checkboxTable.wrappedInstance.props.columns[7].filterMethod; + filterFn = instance + .getColumns(instance.state.data) + .find(c => c.id === "grace_credits").filterFn; }); it("returns true when the input equals to the row's remaining grace credits", () => { - const sample_row = { - _original: { - remaining_grace_credits: 4, - }, - }; - expect(filter_method({value: 4}, sample_row)).toEqual(true); + expect( + filterFn(makeRow({remaining_grace_credits: 4}), "remaining_grace_credits", "4") + ).toEqual(true); }); it("returns true when the input is not a number", () => { - const sample_row = { - _original: { - remaining_grace_credits: 4, - }, - }; - expect(filter_method({value: "unlimited"}, sample_row)).toEqual(true); - }); - - it("returns false when the input a number and doesn't equal to the row's remaining grace credits", () => { - const sample_row = { - _original: { - remaining_grace_credits: 4, - }, - }; - expect(filter_method({value: 3}, sample_row)).toEqual(false); - }); - }); - - describe("the filter method for the active column", () => { - beforeEach(() => { - filter_method = - wrapper.current.wrapped.checkboxTable.wrappedInstance.props.columns[8].filterMethod; - }); - - it("returns true when the selected value is all", () => { - expect(filter_method({value: "all"})).toEqual(true); - }); - - it("returns true when the selected value is active (i.e. not hidden) and hidden is false", () => { - // Sample row - const sample_row = {hidden: false}; - expect(filter_method({id: "hidden", value: "active"}, sample_row)).toEqual(true); - }); - - it("returns false when the selected value is active and hidden is true", () => { - // Sample row - const sample_row = {hidden: true}; - expect(filter_method({id: "hidden", value: "active"}, sample_row)).toEqual(false); + expect( + filterFn(makeRow({remaining_grace_credits: 4}), "remaining_grace_credits", "unlimited") + ).toEqual(true); }); - it("returns true when the selected value is inactive and hidden is true", () => { - // Sample row - const sample_row = {hidden: true}; - expect(filter_method({id: "hidden", value: "inactive"}, sample_row)).toEqual(true); + it("returns true when the filter value is empty", () => { + expect( + filterFn(makeRow({remaining_grace_credits: 4}), "remaining_grace_credits", "") + ).toEqual(true); }); - it("returns false when the selected value is inactive and hidden is false", () => { - // Sample row - const sample_row = {hidden: false}; - expect(filter_method({id: "hidden", value: "inactive"}, sample_row)).toEqual(false); + it("returns false when the input a number and doesn't equal to the row's remaining grace credits", () => { + expect( + filterFn(makeRow({remaining_grace_credits: 4}), "remaining_grace_credits", "3") + ).toEqual(false); }); }); }); @@ -339,3 +278,56 @@ describe("For each StudentTable's loading status", () => { expect(spinner).toBeInTheDocument(); }); }); + +describe("For the StudentTable onSubmit", () => { + beforeEach(() => { + global.$ = { + ajax: jest.fn(() => ({then: jest.fn()})), + }; + render(); + }); + it("calls $.ajax with bulk_modify path on submit", async () => { + fireEvent.submit(screen.getByTestId("student_action_box")); + expect($.ajax).toHaveBeenCalledWith( + expect.objectContaining({ + method: "patch", + url: Routes.bulk_modify_course_students_path(1), + }) + ); + }); +}); + +describe("For the StudentsActionBox", () => { + it("renders grace credits input by default", () => { + render( {}} disabled={false} />); + expect(screen.getByRole("spinbutton")).toBeInTheDocument(); + }); + + it("updates grace_credits state when input changes", async () => { + render( {}} disabled={false} />); + const input = screen.getByRole("spinbutton"); + await userEvent.clear(input); + await userEvent.type(input, "3"); + expect(input.value).toBe("3"); + }); + + it("renders section select when update_section action is chosen and sections exist", async () => { + render( + {}} + disabled={false} + /> + ); + const actionSelect = screen.getByTestId("student_action_box_select"); + await userEvent.selectOptions(actionSelect, "update_section"); + expect(screen.getByTestId("student_action_box_update_section")).toBeInTheDocument(); + }); + + it("renders no section message when update_section is chosen but no sections exist", async () => { + render( {}} disabled={false} />); + const actionSelect = screen.getByTestId("student_action_box_select"); + await userEvent.selectOptions(actionSelect, "update_section"); + expect(screen.getByText(I18n.t("sections.none"))).toBeInTheDocument(); + }); +}); diff --git a/app/javascript/Components/assignment_summary_table.jsx b/app/javascript/Components/assignment_summary_table.jsx index 7e74a88688..d2343829e2 100644 --- a/app/javascript/Components/assignment_summary_table.jsx +++ b/app/javascript/Components/assignment_summary_table.jsx @@ -24,6 +24,7 @@ export class AssignmentSummaryTable extends React.Component { lti_deployments: [], columnFilters: [{id: "inactive", value: false}], inactiveGroupsCount: 0, + columns: this.getColumns([], markingStates, "all"), }; } @@ -31,7 +32,7 @@ export class AssignmentSummaryTable extends React.Component { this.fetchData(); } - getColumns = () => { + getColumns = (criteriaColumns, marking_states, markingStateFilter) => { const columnHelper = createColumnHelper(); const fixedColumns = [ @@ -102,56 +103,56 @@ export class AssignmentSummaryTable extends React.Component { }, filterAllOptionText: I18n.t("all") + - (this.state.markingStateFilter === "all" - ? ` (${Object.values(this.state.marking_states).reduce((a, b) => a + b)})` + (markingStateFilter === "all" + ? ` (${Object.values(marking_states).reduce((a, b) => a + b)})` : ""), filterOptions: [ { value: "before_due_date", text: I18n.t("submissions.state.before_due_date") + - (["before_due_date", "all"].includes(this.state.markingStateFilter) - ? ` (${this.state.marking_states["before_due_date"]})` + (["before_due_date", "all"].includes(markingStateFilter) + ? ` (${marking_states["before_due_date"]})` : ""), }, { value: "not_collected", text: I18n.t("submissions.state.not_collected") + - (["not_collected", "all"].includes(this.state.markingStateFilter) - ? ` (${this.state.marking_states["not_collected"]})` + (["not_collected", "all"].includes(markingStateFilter) + ? ` (${marking_states["not_collected"]})` : ""), }, { value: "incomplete", text: I18n.t("submissions.state.in_progress") + - (["incomplete", "all"].includes(this.state.markingStateFilter) - ? ` (${this.state.marking_states["incomplete"]})` + (["incomplete", "all"].includes(markingStateFilter) + ? ` (${marking_states["incomplete"]})` : ""), }, { value: "complete", text: I18n.t("submissions.state.complete") + - (["complete", "all"].includes(this.state.markingStateFilter) - ? ` (${this.state.marking_states["complete"]})` + (["complete", "all"].includes(markingStateFilter) + ? ` (${marking_states["complete"]})` : ""), }, { value: "released", text: I18n.t("submissions.state.released") + - (["released", "all"].includes(this.state.markingStateFilter) - ? ` (${this.state.marking_states["released"]})` + (["released", "all"].includes(markingStateFilter) + ? ` (${marking_states["released"]})` : ""), }, { value: "remark", text: I18n.t("submissions.state.remark_requested") + - (["remark", "all"].includes(this.state.markingStateFilter) - ? ` (${this.state.marking_states["remark"]})` + (["remark", "all"].includes(markingStateFilter) + ? ` (${marking_states["remark"]})` : ""), }, ], @@ -199,7 +200,7 @@ export class AssignmentSummaryTable extends React.Component { }), ]; - const criteriaColumns = this.state.criteriaColumns.map(col => + const criteriaColumnDefs = criteriaColumns.map(col => columnHelper.accessor(col.accessor, { id: col.id, header: () => col.Header, @@ -222,7 +223,7 @@ export class AssignmentSummaryTable extends React.Component { sortDescFirst: true, }); - return [...fixedColumns, ...criteriaColumns, bonusColumn]; + return [...fixedColumns, ...criteriaColumnDefs, bonusColumn]; }; toggleShowInactiveGroups = showInactiveGroups => { @@ -291,6 +292,11 @@ export class AssignmentSummaryTable extends React.Component { marking_states: markingStates, lti_deployments: res.ltiDeployments, inactiveGroupsCount: inactive_groups_count, + columns: this.getColumns( + res.criteriaColumns, + markingStates, + this.state.markingStateFilter + ), }); }); }; @@ -328,10 +334,24 @@ export class AssignmentSummaryTable extends React.Component { const summaryTable = this.wrappedInstance; if (column.id != "marking_state") { const markingStates = getMarkingStates(summaryTable.state.sortedData); - this.setState({marking_states: markingStates}); + this.setState({ + marking_states: markingStates, + columns: this.getColumns( + this.state.criteriaColumns, + markingStates, + this.state.markingStateFilter + ), + }); } else { const markingStateFilter = filtered.find(filter => filter.id == "marking_state").value; - this.setState({markingStateFilter: markingStateFilter}); + this.setState({ + markingStateFilter, + columns: this.getColumns( + this.state.criteriaColumns, + this.state.marking_states, + markingStateFilter + ), + }); } }; @@ -424,7 +444,7 @@ export class AssignmentSummaryTable extends React.Component {
{label || } @@ -630,8 +627,9 @@ function MoveUpButton(props) { } export function makeAutotestManager(elem, props) { + const validator = customizeValidator({ajvOptionsOverrides: {discriminator: true}}); const root = createRoot(elem); const component = React.createRef(); - root.render(); + root.render(); return component; } diff --git a/app/javascript/Components/batch_test_run_table.jsx b/app/javascript/Components/batch_test_run_table.jsx index 0285846ea5..7b14f92681 100644 --- a/app/javascript/Components/batch_test_run_table.jsx +++ b/app/javascript/Components/batch_test_run_table.jsx @@ -12,7 +12,128 @@ const makeDefaultState = () => ({ class BatchTestRunTable extends React.Component { constructor(props) { super(props); - this.state = makeDefaultState(); + this.state = { + ...makeDefaultState(), + columns: [ + // The rows needs to be grouped by created_at timestamp, but we use a duplicate of the + // "created_at" column to show the expander icon by itself + { + Header: "", + id: "hidden_created_at", + accessor: "created_at", + maxWidth: 30, + PivotValue: () => "", + }, + { + Header: I18n.t("activerecord.attributes.test_batch.created_at"), + accessor: "created_at", + minWidth: 120, + sortMethod: dateSort, + aggregate: vals => vals[0], + }, + { + Header: I18n.t("activerecord.attributes.group.group_name"), + accessor: "group_name", + // If more than one value, show the total number of groups under this pivot + aggregate: vals => { + if (typeof vals[1] === "undefined") { + return vals[0]; + } else { + const numGroups = Object.keys(vals).length; + return numGroups + " " + I18n.t("activerecord.models.group", {count: numGroups}); + } + }, + sortable: true, + }, + { + Header: I18n.t("activerecord.attributes.test_run.status"), + accessor: "status", + minWidth: 70, + Cell: ({value}) => I18n.t(`automated_tests.test_runs_statuses.${value}`), + aggregate: (vals, pivots) => { + const batch = this.state.statuses[pivots[0].test_batch_id]; + if (pivots[0].test_batch_id === null) { + return `${pivots[0].status}`; + } else { + const total = batch.total; + const complete = total - batch.in_progress; + return `${complete} / ${total} ${I18n.t("poll_job.completed")}`; + } + }, + sortable: false, + filterable: true, + Filter: selectFilter, + filterMethod: (filter, row) => { + // Skip filter if value is "all" or the row is a pivoted row (in the latter case, + // react-table will automatically apply the filter to the subrows + if (filter.value === "all" || !!row._pivotID) { + return true; + } else { + return row[filter.id] === filter.value; + } + }, + filterOptions: [ + { + value: "cancelled", + text: I18n.t("automated_tests.test_runs_statuses.cancelled"), + }, + { + value: "complete", + text: I18n.t("automated_tests.test_runs_statuses.complete"), + }, + { + value: "failed", + text: I18n.t("automated_tests.test_runs_statuses.failed"), + }, + { + value: "in_progress", + text: I18n.t("automated_tests.test_runs_statuses.in_progress"), + }, + ], + Aggregated: row => {row.value}, + }, + { + Header: I18n.t("actions"), + accessor: "action", + minWidth: 70, + sortable: false, + aggregate: (vals, pivots) => { + return [ + pivots[0].test_batch_id, + this.state.statuses[pivots[0].test_batch_id], + pivots[0].action, + ]; + }, + Aggregated: row => { + if (row.value[1].in_progress > 0) { + if (row.value[0] === null) { + return row.value[2]; + } else { + const stop_tests_url = Routes.stop_batch_tests_course_assignment_path( + this.props.course_id, + this.props.assignment_id + ); + return ( + + + + ); + } + } else { + return ""; + } + }, + }, + { + // Kept but hidden because status is using it + Header: "", + accessor: "test_batch_id", + show: false, + }, + ], + }; this.fetchData = this.fetchData.bind(this); this.processData = this.processData.bind(this); } @@ -80,125 +201,7 @@ class BatchTestRunTable extends React.Component { "", - }, - { - Header: I18n.t("activerecord.attributes.test_batch.created_at"), - accessor: "created_at", - minWidth: 120, - sortMethod: dateSort, - aggregate: vals => vals[0], - }, - { - Header: I18n.t("activerecord.attributes.group.group_name"), - accessor: "group_name", - // If more than one value, show the total number of groups under this pivot - aggregate: vals => { - if (typeof vals[1] === "undefined") { - return vals[0]; - } else { - const numGroups = Object.keys(vals).length; - return numGroups + " " + I18n.t("activerecord.models.group", {count: numGroups}); - } - }, - sortable: true, - }, - { - Header: I18n.t("activerecord.attributes.test_run.status"), - accessor: "status", - minWidth: 70, - Cell: ({value}) => I18n.t(`automated_tests.test_runs_statuses.${value}`), - aggregate: (vals, pivots) => { - const batch = this.state.statuses[pivots[0].test_batch_id]; - if (pivots[0].test_batch_id === null) { - return `${pivots[0].status}`; - } else { - const total = batch.total; - const complete = total - batch.in_progress; - return `${complete} / ${total} ${I18n.t("poll_job.completed")}`; - } - }, - sortable: false, - filterable: true, - Filter: selectFilter, - filterMethod: (filter, row) => { - // Skip filter if value is "all" or the row is a pivoted row (in the latter case, - // react-table will automatically apply the filter to the subrows - if (filter.value === "all" || !!row._pivotID) { - return true; - } else { - return row[filter.id] === filter.value; - } - }, - filterOptions: [ - { - value: "cancelled", - text: I18n.t("automated_tests.test_runs_statuses.cancelled"), - }, - { - value: "complete", - text: I18n.t("automated_tests.test_runs_statuses.complete"), - }, - { - value: "failed", - text: I18n.t("automated_tests.test_runs_statuses.failed"), - }, - { - value: "in_progress", - text: I18n.t("automated_tests.test_runs_statuses.in_progress"), - }, - ], - Aggregated: row => {row.value}, - }, - { - Header: I18n.t("actions"), - accessor: "action", - minWidth: 70, - sortable: false, - aggregate: (vals, pivots) => { - return [ - pivots[0].test_batch_id, - this.state.statuses[pivots[0].test_batch_id], - pivots[0].action, - ]; - }, - Aggregated: row => { - if (row.value[1].in_progress > 0) { - if (row.value[0] === null) { - return row.value[2]; - } else { - const stop_tests_url = Routes.stop_batch_tests_course_assignment_path( - this.props.course_id, - this.props.assignment_id - ); - return ( - - - - ); - } - } else { - return ""; - } - }, - }, - { - // Kept but hidden because status is using it - Header: "", - accessor: "test_batch_id", - show: false, - }, - ]} + columns={this.state.columns} pivotBy={["hidden_created_at"]} defaultSorted={[ {id: "created_at", desc: true}, diff --git a/app/javascript/Components/course_cards.jsx b/app/javascript/Components/course_cards.jsx index 9e25ceb0dd..e90439d0cd 100644 --- a/app/javascript/Components/course_cards.jsx +++ b/app/javascript/Components/course_cards.jsx @@ -1,29 +1,26 @@ import React from "react"; -class CourseCard extends React.Component { - onClick = () => { - if (this.props.role_type === "Instructor") { - window.location = Routes.course_path(this.props.course_id); - } else { - window.location = Routes.course_assignments_path(this.props.course_id); - } - }; +function CourseCard({course_id, course_name, course_display_name, role_type}) { + let coursePath; + if (role_type === "Instructor") { + coursePath = Routes.course_path(course_id); + } else { + coursePath = Routes.course_assignments_path(course_id); + } - render() { - return ( - - - - {I18n.t(`activerecord.models.${this.props.role_type.toLowerCase()}.one`)} - - {this.props.course_name} - - - {this.props.course_display_name} + return ( + + + + {I18n.t(`activerecord.models.${role_type.toLowerCase()}.one`)} + {course_name} - ); - } + + {course_display_name} + + + ); } export default CourseCard; diff --git a/app/javascript/Components/course_list.jsx b/app/javascript/Components/course_list.jsx index cebeaf3e0b..50994d94b1 100644 --- a/app/javascript/Components/course_list.jsx +++ b/app/javascript/Components/course_list.jsx @@ -2,7 +2,7 @@ import React from "react"; import {createRoot} from "react-dom/client"; import CourseCard from "./course_cards"; -class CourseList extends React.Component { +export class CourseList extends React.Component { constructor(props) { super(props); this.state = { @@ -34,25 +34,54 @@ class CourseList extends React.Component { }); }; + isPastCourse = course => { + const endAt = course["courses.end_at"]; + return !!endAt && Date.parse(endAt) < Date.now(); + }; + render() { if (this.state.loading == true) { return ; - } else if (this.state.courses.length == 0) { - return {I18n.t("courses.no_courses")}; } + + const currentCourses = this.state.courses.filter(course => !this.isPastCourse(course)); + const pastCourses = this.state.courses.filter(course => this.isPastCourse(course)); + return ( - {this.state.courses.map(course => { - return ( - - ); - })} + {I18n.t("courses.current_courses")} + {currentCourses.length === 0 ? ( + {I18n.t("courses.no_courses")} + ) : ( + currentCourses.map(course => { + return ( + + ); + }) + )} + + {I18n.t("courses.past_courses")} + {pastCourses.length === 0 ? ( + {I18n.t("courses.no_courses")} + ) : ( + pastCourses.map(course => { + return ( + + ); + }) + )} ); } diff --git a/app/javascript/Components/course_summaries_table.jsx b/app/javascript/Components/course_summaries_table.jsx index c8feeced20..f3897aa052 100644 --- a/app/javascript/Components/course_summaries_table.jsx +++ b/app/javascript/Components/course_summaries_table.jsx @@ -3,14 +3,31 @@ import Table from "./table/table"; import {createColumnHelper, filterFns} from "@tanstack/react-table"; export class CourseSummaryTable extends React.Component { + columnHelper = createColumnHelper(); + constructor(props) { super(props); this.state = { showHidden: false, columnFilters: [{id: "inactive", value: false}], + columns: this.getColumns(props.student, props.assessments, props.marking_schemes), }; + } - this.columnHelper = createColumnHelper(); + componentDidUpdate(prevProps) { + if ( + prevProps.student !== this.props.student || + prevProps.assessments !== this.props.assessments || + prevProps.marking_schemes !== this.props.marking_schemes + ) { + this.setState({ + columns: this.getColumns( + this.props.student, + this.props.assessments, + this.props.marking_schemes + ), + }); + } } static defaultProps = { @@ -18,12 +35,21 @@ export class CourseSummaryTable extends React.Component { marking_schemes: [], data: [], }; + + getColumns = (student, assessments, marking_schemes) => { + if (student) { + return this.dataColumns(assessments, marking_schemes); + } else { + return [...this.nameColumns(), ...this.dataColumns(assessments, marking_schemes)]; + } + }; + nameColumns = () => { const columnHelper = this.columnHelper; return [ columnHelper.accessor("hidden", { id: "inactive", - filterFn: (row, columnId, filterValue) => { + filterFn: (row, _columnId, filterValue) => { // Show all rows if filter true, else only show non-hidden rows return filterValue || !row.original.hidden; }, @@ -69,11 +95,11 @@ export class CourseSummaryTable extends React.Component { this.setState({columnFilters, showHidden}); }; - dataColumns = () => { + dataColumns = (assessments, marking_schemes) => { const columnHelper = this.columnHelper; const columns = []; - this.props.assessments.forEach(data => { + assessments.forEach(data => { columns.push( columnHelper.accessor(`assessment_marks.${data.id}.mark`, { filterFn: filterFns.equalsString, @@ -87,7 +113,7 @@ export class CourseSummaryTable extends React.Component { }) ); }); - this.props.marking_schemes.forEach(data => { + marking_schemes.forEach(data => { columns.push( columnHelper.accessor(`weighted_marks.${data.id}.mark`, { filterFn: filterFns.equalsString, @@ -105,10 +131,6 @@ export class CourseSummaryTable extends React.Component { }; render() { - const columns = this.props.student - ? this.dataColumns() - : [...this.nameColumns(), ...this.dataColumns()]; - return ( <> {!this.props.student && ( @@ -126,7 +148,7 @@ export class CourseSummaryTable extends React.Component { )} { this.setState(prevState => { diff --git a/app/javascript/Components/graders_manager.jsx b/app/javascript/Components/graders_manager.jsx index 658d68fb15..df838b7ef8 100644 --- a/app/javascript/Components/graders_manager.jsx +++ b/app/javascript/Components/graders_manager.jsx @@ -453,85 +453,85 @@ class RawGradersTable extends React.Component { super(props); this.state = { filtered: [], + columns: [ + { + accessor: "hidden", + id: "hidden", + width: 0, + className: "rt-hidden", + headerClassName: "rt-hidden", + resizable: false, + }, + { + show: false, + accessor: "_id", + id: "_id", + }, + { + Header: I18n.t("activerecord.attributes.user.user_name"), + accessor: "user_name", + id: "user_name", + Cell: props => + props.original.hidden + ? `${props.value} (${I18n.t("activerecord.attributes.user.hidden")})` + : props.value, + filterMethod: (filter, row) => { + if (filter.value) { + return `${row._original.user_name}${ + row._original.hidden ? `, ${I18n.t("activerecord.attributes.user.hidden")}` : "" + }`.includes(filter.value); + } else { + return true; + } + }, + sortable: true, + minWidth: 90, + }, + { + Header: I18n.t("activerecord.attributes.user.full_name"), + accessor: "full_name", + id: "full_name", + filterable: true, + Filter: textFilter, + Cell: row => `${row.original.first_name} ${row.original.last_name}`, + filterMethod: (filter, row) => { + if (filter.value) { + const fullName = + `${row._original.first_name} ${row._original.last_name}`.toLowerCase(); + return fullName.includes(filter.value.toLowerCase()); + } else { + return true; + } + }, + sortable: true, + minWidth: 170, + }, + { + Header: I18n.t("activerecord.models.group.other"), + accessor: "groups", + className: "number", + filterable: false, + }, + { + Header: I18n.t("activerecord.models.criterion.other"), + accessor: "criteria", + filterable: false, + Cell: ({value}) => { + if (this.props.assign_graders_to_criteria) { + return ( + + {value}/{this.props.numCriteria} + + ); + } else { + return I18n.t("all"); + } + }, + }, + ], }; } - getColumns = () => [ - { - accessor: "hidden", - id: "hidden", - width: 0, - className: "rt-hidden", - headerClassName: "rt-hidden", - resizable: false, - }, - { - show: false, - accessor: "_id", - id: "_id", - }, - { - Header: I18n.t("activerecord.attributes.user.user_name"), - accessor: "user_name", - id: "user_name", - Cell: props => - props.original.hidden - ? `${props.value} (${I18n.t("activerecord.attributes.user.hidden")})` - : props.value, - filterMethod: (filter, row) => { - if (filter.value) { - return `${row._original.user_name}${ - row._original.hidden ? `, ${I18n.t("activerecord.attributes.user.hidden")}` : "" - }`.includes(filter.value); - } else { - return true; - } - }, - sortable: true, - minWidth: 90, - }, - { - Header: I18n.t("activerecord.attributes.user.full_name"), - accessor: "full_name", - id: "full_name", - filterable: true, - Filter: textFilter, - Cell: row => `${row.original.first_name} ${row.original.last_name}`, - filterMethod: (filter, row) => { - if (filter.value) { - const fullName = `${row._original.first_name} ${row._original.last_name}`.toLowerCase(); - return fullName.includes(filter.value.toLowerCase()); - } else { - return true; - } - }, - sortable: true, - minWidth: 170, - }, - { - Header: I18n.t("activerecord.models.group.other"), - accessor: "groups", - className: "number", - filterable: false, - }, - { - Header: I18n.t("activerecord.models.criterion.other"), - accessor: "criteria", - filterable: false, - Cell: ({value}) => { - if (this.props.assign_graders_to_criteria) { - return ( - - {value}/{this.props.numCriteria} - - ); - } else { - return I18n.t("all"); - } - }, - }, - ]; - static getDerivedStateFromProps(props, state) { let filtered = []; for (let i = 0; i < state.filtered.length; i++) { @@ -554,7 +554,7 @@ class RawGradersTable extends React.Component { (this.checkboxTable = r)} data={this.props.graders} - columns={this.getColumns()} + columns={this.state.columns} defaultSorted={[ { id: "user_name", @@ -575,10 +575,27 @@ class RawGroupsTable extends React.Component { super(props); this.state = { filtered: [], + columns: this.getColumns(props.showSections, props.sections, props.showCoverage), }; } - getColumns = () => { + componentDidUpdate(prevProps) { + if ( + prevProps.showSections !== this.props.showSections || + prevProps.sections !== this.props.sections || + prevProps.showCoverage !== this.props.showCoverage + ) { + this.setState({ + columns: this.getColumns( + this.props.showSections, + this.props.sections, + this.props.showCoverage + ), + }); + } + } + + getColumns = (showSections, sections, showCoverage) => { return [ { accessor: "inactive", @@ -597,7 +614,7 @@ class RawGroupsTable extends React.Component { Header: I18n.t("activerecord.models.section", {count: 1}), accessor: "section", id: "section", - show: this.props.showSections || false, + show: showSections || false, minWidth: 70, Cell: ({value}) => { return this.props.sections[value] || ""; @@ -610,7 +627,7 @@ class RawGroupsTable extends React.Component { } }, Filter: selectFilter, - filterOptions: Object.entries(this.props.sections).map(kv => ({ + filterOptions: Object.entries(sections).map(kv => ({ value: kv[1], text: kv[1], })), @@ -656,7 +673,7 @@ class RawGroupsTable extends React.Component { minWidth: 70, className: "number", filterable: false, - show: this.props.showCoverage, + show: showCoverage, }, ]; }; @@ -679,7 +696,7 @@ class RawGroupsTable extends React.Component { (this.checkboxTable = r)} data={this.props.groups} - columns={this.getColumns()} + columns={this.state.columns} defaultSorted={[ { id: "group_name", @@ -696,56 +713,59 @@ class RawGroupsTable extends React.Component { } class RawCriteriaTable extends React.Component { - getColumns = () => { - return [ - { - show: false, - accessor: "_id", - id: "_id", - }, - { - Header: I18n.t("activerecord.attributes.criterion.name"), - accessor: "name", - minWidth: 150, - }, - { - Header: I18n.t("activerecord.models.ta.other"), - accessor: "graders", - Cell: row => { - return row.value.map(ta_data => ( - - {ta_data.hidden - ? `${ta_data.grader} (${I18n.t("activerecord.attributes.user.hidden")})` - : ta_data.grader} - - this.props.unassignSingle(row.original._id, ta_data.grader, "criteria_table") - } - title={I18n.t("graders.actions.unassign_grader")} - > - - - - )); + constructor(props) { + super(props); + this.state = { + columns: [ + { + show: false, + accessor: "_id", + id: "_id", }, - filterable: false, - minWidth: 70, - }, - { - Header: I18n.t("graders.coverage"), - accessor: "coverage", - Cell: ({value}) => ( - - {value}/{this.props.numGroups} - - ), - minWidth: 70, - className: "number", - filterable: false, - }, - ]; - }; + { + Header: I18n.t("activerecord.attributes.criterion.name"), + accessor: "name", + minWidth: 150, + }, + { + Header: I18n.t("activerecord.models.ta.other"), + accessor: "graders", + Cell: row => { + return row.value.map(ta_data => ( + + {ta_data.hidden + ? `${ta_data.grader} (${I18n.t("activerecord.attributes.user.hidden")})` + : ta_data.grader} + + this.props.unassignSingle(row.original._id, ta_data.grader, "criteria_table") + } + title={I18n.t("graders.actions.unassign_grader")} + > + + + + )); + }, + filterable: false, + minWidth: 70, + }, + { + Header: I18n.t("graders.coverage"), + accessor: "coverage", + Cell: ({value}) => ( + + {value}/{this.props.numGroups} + + ), + minWidth: 70, + className: "number", + filterable: false, + }, + ], + }; + } render() { if (this.props.display) { @@ -753,7 +773,7 @@ class RawCriteriaTable extends React.Component { (this.checkboxTable = r)} data={this.props.criteria} - columns={this.getColumns()} + columns={this.state.columns} defaultSorted={[ { id: "_id", diff --git a/app/javascript/Components/groups_manager.jsx b/app/javascript/Components/groups_manager.jsx index 2847e74f10..c1563a4099 100644 --- a/app/javascript/Components/groups_manager.jsx +++ b/app/javascript/Components/groups_manager.jsx @@ -424,202 +424,202 @@ class RawGroupsTable extends React.Component { super(props); this.state = { filtered: [], - }; - } - - getColumns = () => [ - { - accessor: "inactive", - id: "inactive", - width: 0, - className: "rt-hidden", - headerClassName: "rt-hidden", - resizable: false, - }, - { - show: false, - accessor: "id", - id: "_id", - }, - { - Header: I18n.t("activerecord.models.group.one"), - accessor: "group_name", - id: "group_name", - Cell: row => { - return ( - - {row.value} - this.props.renameGroup(row.original._id, row.value)} - title={I18n.t("groups.rename_group")} - > - - - - ); - }, - }, - { - Header: I18n.t("activerecord.attributes.group.student_memberships"), - accessor: "members", - Cell: row => { - if (row.value.length > 0 || !this.props.scanned_exam) { - return row.value.map(member => { - let status; - if (member[1] === "pending") { - status = ({member[1]}); - } else { - status = member.display_label; - } + columns: [ + { + accessor: "inactive", + id: "inactive", + width: 0, + className: "rt-hidden", + headerClassName: "rt-hidden", + resizable: false, + }, + { + show: false, + accessor: "id", + id: "_id", + }, + { + Header: I18n.t("activerecord.models.group.one"), + accessor: "group_name", + id: "group_name", + Cell: row => { return ( - - {member[0]} {status} + + {row.value} this.props.unassign(row.original._id, member[0])} - title={I18n.t("delete")} + onClick={() => this.props.renameGroup(row.original._id, row.value)} + title={I18n.t("groups.rename_group")} > - + - + ); - }); - } else { - // Link to assigning a student to this scanned exam - const assign_url = Routes.assign_scans_course_assignment_groups_path( - this.props.course_id, - this.props.assignment_id, - {grouping_id: row.original._id} - ); - return {I18n.t("exam_templates.assign_scans.title")}; - } - }, - filterMethod: (filter, row) => { - if (filter.value) { - return row._original.members.some(member => member[0].includes(filter.value)); - } else { - return true; - } - }, - sortable: false, - }, - { - Header: I18n.t("groups.valid"), - Cell: row => { - let isValid = - row.original.instructor_approved || row.original.members.length >= this.props.groupMin; - if (isValid) { - return ( - this.props.invalidate(row.original._id)} - > - ✔ - - ); - } else { - return ( - this.props.validate(row.original._id)} - > - - - ); - } - }, - filterMethod: (filter, row) => { - if (filter.value === "all") { - return true; - } else { - // Either 'true' or 'false' - const val = filter.value === "true"; - let isValid = - row._original.instructor_approved || - row._original.members.length >= this.props.groupMin; - return isValid === val; - } - }, - Filter: selectFilter, - filterOptions: [ - {value: "true", text: I18n.t("groups.is_valid")}, - {value: "false", text: I18n.t("groups.is_not_valid")}, - ], - minWidth: 30, - sortable: false, - }, - { - Header: this.props.extensionColumnHeader, - accessor: "extension", - show: !this.props.scanned_exam, - Cell: row => { - const timeExtension = getTimeExtension(row.original.extension, this.props.times); - const lateSubmissionText = row.original.extension.apply_penalty - ? `(${I18n.t("groups.late_submissions_accepted")})` - : ""; - const extension = `${timeExtension} ${lateSubmissionText}`; - - if (!!timeExtension) { - return ( - - this.props.onExtensionModal(row.original.extension, true)} - > - {extension} - - - ); - } else { - return ( - this.props.onExtensionModal(row.original.extension, false)} - title={I18n.t("add")} - > - - - ); - } - }, - sortMethod: durationSort, - Filter: selectFilter, - filterMethod: (filter, row) => { - if (filter.value === "all") { - return true; - } - const applyPenalty = row._original.extension.apply_penalty; - const {withExtension, withLateSubmission} = JSON.parse(filter.value); - // If there is an extension applied, the extension object will contain a property called hours - const hasExtension = Object.hasOwn(row._original.extension, "hours"); - - if (!withExtension) { - return !hasExtension; - } - if (withLateSubmission) { - return hasExtension && applyPenalty; - } - return hasExtension && !applyPenalty; - }, - filterOptions: [ + }, + }, { - value: JSON.stringify({withExtension: false}), - text: I18n.t("groups.groups_without_extension"), + Header: I18n.t("activerecord.attributes.group.student_memberships"), + accessor: "members", + Cell: row => { + if (row.value.length > 0 || !this.props.scanned_exam) { + return row.value.map(member => { + let status; + if (member[1] === "pending") { + status = ({member[1]}); + } else { + status = member.display_label; + } + return ( + + {member[0]} {status} + this.props.unassign(row.original._id, member[0])} + title={I18n.t("delete")} + > + + + + ); + }); + } else { + // Link to assigning a student to this scanned exam + const assign_url = Routes.assign_scans_course_assignment_groups_path( + this.props.course_id, + this.props.assignment_id, + {grouping_id: row.original._id} + ); + return {I18n.t("exam_templates.assign_scans.title")}; + } + }, + filterMethod: (filter, row) => { + if (filter.value) { + return row._original.members.some(member => member[0].includes(filter.value)); + } else { + return true; + } + }, + sortable: false, }, { - value: JSON.stringify({withExtension: true, withLateSubmission: true}), - text: I18n.t("groups.groups_with_extension.with_late_submission"), + Header: I18n.t("groups.valid"), + Cell: row => { + let isValid = + row.original.instructor_approved || + row.original.members.length >= this.props.groupMin; + if (isValid) { + return ( + this.props.invalidate(row.original._id)} + > + ✔ + + ); + } else { + return ( + this.props.validate(row.original._id)} + > + + + ); + } + }, + filterMethod: (filter, row) => { + if (filter.value === "all") { + return true; + } else { + // Either 'true' or 'false' + const val = filter.value === "true"; + let isValid = + row._original.instructor_approved || + row._original.members.length >= this.props.groupMin; + return isValid === val; + } + }, + Filter: selectFilter, + filterOptions: [ + {value: "true", text: I18n.t("groups.is_valid")}, + {value: "false", text: I18n.t("groups.is_not_valid")}, + ], + minWidth: 30, + sortable: false, }, { - value: JSON.stringify({withExtension: true, withLateSubmission: false}), - text: I18n.t("groups.groups_with_extension.without_late_submission"), + Header: props.extensionColumnHeader, + accessor: "extension", + show: !props.scanned_exam, + Cell: row => { + const timeExtension = getTimeExtension(row.original.extension, this.props.times); + const lateSubmissionText = row.original.extension.apply_penalty + ? `(${I18n.t("groups.late_submissions_accepted")})` + : ""; + const extension = `${timeExtension} ${lateSubmissionText}`; + + if (!!timeExtension) { + return ( + + this.props.onExtensionModal(row.original.extension, true)} + > + {extension} + + + ); + } else { + return ( + this.props.onExtensionModal(row.original.extension, false)} + title={I18n.t("add")} + > + + + ); + } + }, + sortMethod: durationSort, + Filter: selectFilter, + filterMethod: (filter, row) => { + if (filter.value === "all") { + return true; + } + const applyPenalty = row._original.extension.apply_penalty; + const {withExtension, withLateSubmission} = JSON.parse(filter.value); + // If there is an extension applied, the extension object will contain a property called hours + const hasExtension = Object.hasOwn(row._original.extension, "hours"); + + if (!withExtension) { + return !hasExtension; + } + if (withLateSubmission) { + return hasExtension && applyPenalty; + } + return hasExtension && !applyPenalty; + }, + filterOptions: [ + { + value: JSON.stringify({withExtension: false}), + text: I18n.t("groups.groups_without_extension"), + }, + { + value: JSON.stringify({withExtension: true, withLateSubmission: true}), + text: I18n.t("groups.groups_with_extension.with_late_submission"), + }, + { + value: JSON.stringify({withExtension: true, withLateSubmission: false}), + text: I18n.t("groups.groups_with_extension.without_late_submission"), + }, + ], }, ], - }, - ]; + }; + } static getDerivedStateFromProps(props, state) { let filtered = state.filtered.filter(group => group.id !== "inactive"); @@ -639,7 +639,7 @@ class RawGroupsTable extends React.Component { (this.checkboxTable = r)} data={this.props.groups} - columns={this.getColumns()} + columns={this.state.columns} defaultSorted={[ { id: "group_name", @@ -660,77 +660,74 @@ class RawStudentsTable extends React.Component { super(props); this.state = { filtered: [], - }; - } - - getColumns = () => { - return [ - { - accessor: "hidden", - id: "hidden", - width: 0, - className: "rt-hidden", - headerClassName: "rt-hidden", - resizable: false, - }, - { - show: false, - accessor: "_id", - id: "_id", - }, - { - Header: I18n.t("activerecord.attributes.user.user_name"), - accessor: "user_name", - id: "user_name", - Cell: props => - props.original.hidden - ? `${props.value} (${I18n.t("activerecord.attributes.user.hidden")})` - : props.value, - filterMethod: (filter, row) => { - if (filter.value) { - return `${row._original.user_name}${ - row._original.hidden ? `, ${I18n.t("activerecord.attributes.user.hidden")}` : "" - }`.includes(filter.value); - } else { - return true; - } + columns: [ + { + accessor: "hidden", + id: "hidden", + width: 0, + className: "rt-hidden", + headerClassName: "rt-hidden", + resizable: false, }, - sortable: true, - minWidth: 90, - }, - { - Header: I18n.t("activerecord.attributes.user.last_name"), - accessor: "last_name", - id: "last_name", - }, - { - Header: I18n.t("activerecord.attributes.user.first_name"), - accessor: "first_name", - id: "first_name", - }, - { - Header: I18n.t("groups.assigned_students") + "?", - accessor: "assigned", - Cell: ({value}) => (value ? "✔" : ""), - sortable: false, - minWidth: 60, - filterMethod: (filter, row) => { - if (filter.value === "all") { - return true; - } else { - // Either 'true' or 'false' - const assigned = filter.value === "true"; - return row._original.assigned === assigned; - } + { + show: false, + accessor: "_id", + id: "_id", }, - Filter: selectFilter, - filterOptions: [ - {value: "true", text: I18n.t("groups.assigned_students")}, - {value: "false", text: I18n.t("groups.unassigned_students")}, - ], - }, - ]; - }; + { + Header: I18n.t("activerecord.attributes.user.user_name"), + accessor: "user_name", + id: "user_name", + Cell: props => + props.original.hidden + ? `${props.value} (${I18n.t("activerecord.attributes.user.hidden")})` + : props.value, + filterMethod: (filter, row) => { + if (filter.value) { + return `${row._original.user_name}${ + row._original.hidden ? `, ${I18n.t("activerecord.attributes.user.hidden")}` : "" + }`.includes(filter.value); + } else { + return true; + } + }, + sortable: true, + minWidth: 90, + }, + { + Header: I18n.t("activerecord.attributes.user.last_name"), + accessor: "last_name", + id: "last_name", + }, + { + Header: I18n.t("activerecord.attributes.user.first_name"), + accessor: "first_name", + id: "first_name", + }, + { + Header: I18n.t("groups.assigned_students") + "?", + accessor: "assigned", + Cell: ({value}) => (value ? "✔" : ""), + sortable: false, + minWidth: 60, + filterMethod: (filter, row) => { + if (filter.value === "all") { + return true; + } else { + // Either 'true' or 'false' + const assigned = filter.value === "true"; + return row._original.assigned === assigned; + } + }, + Filter: selectFilter, + filterOptions: [ + {value: "true", text: I18n.t("groups.assigned_students")}, + {value: "false", text: I18n.t("groups.unassigned_students")}, + ], + }, + ], + }; + } static getDerivedStateFromProps(props, state) { let filtered = []; @@ -754,7 +751,7 @@ class RawStudentsTable extends React.Component { (this.checkboxTable = r)} data={this.props.students} - columns={this.getColumns()} + columns={this.state.columns} defaultSorted={[ { id: "user_name", diff --git a/app/javascript/Components/marks_graders_manager.jsx b/app/javascript/Components/marks_graders_manager.jsx index 58741fe30e..0e1ff00404 100644 --- a/app/javascript/Components/marks_graders_manager.jsx +++ b/app/javascript/Components/marks_graders_manager.jsx @@ -225,7 +225,20 @@ class RawGradersTable extends React.Component { } class RawMarksStudentsTable extends React.Component { - getColumns = () => { + constructor(props) { + super(props); + this.state = { + columns: this.getColumns(props.showSections), + }; + } + + componentDidUpdate(prevProps) { + if (prevProps.showSections !== this.props.showSections) { + this.setState({columns: this.getColumns(this.props.showSections)}); + } + } + + getColumns = showSections => { return [ { show: false, @@ -233,7 +246,7 @@ class RawMarksStudentsTable extends React.Component { id: "_id", }, { - show: this.props.showSections, + show: showSections, Header: I18n.t("activerecord.models.section.one"), accessor: "section", minWidth: 70, @@ -287,7 +300,7 @@ class RawMarksStudentsTable extends React.Component { (this.checkboxTable = r)} data={this.props.students} - columns={this.getColumns()} + columns={this.state.columns} defaultSorted={[ { id: "user_name", diff --git a/app/javascript/Components/marks_spreadsheet.jsx b/app/javascript/Components/marks_spreadsheet.jsx index 0fb5d4074f..4e3a60c784 100644 --- a/app/javascript/Components/marks_spreadsheet.jsx +++ b/app/javascript/Components/marks_spreadsheet.jsx @@ -13,6 +13,7 @@ class RawMarksSpreadsheet extends React.Component { loading: true, show_hidden: false, filtered: [{id: "hidden", value: false}], + columns: this.getColumns([], {}), }; } @@ -52,7 +53,12 @@ class RawMarksSpreadsheet extends React.Component { defaultSortDesc: true, }) ); - this.setState({grade_columns}); + this.setState(state => { + return { + grade_columns, + columns: this.getColumns(grade_columns, state.sections), + }; + }); }); // Getting row data @@ -75,14 +81,14 @@ class RawMarksSpreadsheet extends React.Component { .then(response => { this.props.resetSelection(); - this.setState( - { + this.setState(state => { + return { data: response.data, loading: false, sections: response.sections, - }, - () => this.forceUpdate() - ); + columns: this.getColumns(state.grade_columns, response.sections), + }; + }); }); }; @@ -104,7 +110,7 @@ class RawMarksSpreadsheet extends React.Component { }).then(this.fetchData); }; - nameColumns = () => [ + nameColumns = (sections, show_sections) => [ { id: "hidden", accessor: "hidden", @@ -126,7 +132,7 @@ class RawMarksSpreadsheet extends React.Component { { Header: I18n.t("activerecord.models.section", {count: 1}), accessor: "section_id", - show: this.props.show_sections || false, + show: show_sections || false, minWidth: 70, Cell: ({value}) => { return this.state.sections[value] || ""; @@ -139,7 +145,7 @@ class RawMarksSpreadsheet extends React.Component { } }, Filter: selectFilter, - filterOptions: Object.entries(this.state.sections).map(kv => ({ + filterOptions: Object.entries(sections).map(kv => ({ value: kv[1], text: kv[1], })), @@ -245,8 +251,8 @@ class RawMarksSpreadsheet extends React.Component { ); } - getColumns = () => { - let columns = this.nameColumns().concat(this.state.grade_columns); + getColumns = (grade_columns, sections) => { + let columns = this.nameColumns(sections, this.props.show_sections).concat(grade_columns); if (this.props.show_total) { columns = columns.concat([this.totalColumn()]); } @@ -309,7 +315,7 @@ class RawMarksSpreadsheet extends React.Component { (this.checkboxTable = r)} data={data} - columns={this.getColumns()} + columns={this.state.columns} defaultSorted={[ { id: "user_name", diff --git a/app/javascript/Components/peer_review_table.jsx b/app/javascript/Components/peer_review_table.jsx index f9d1e6cbd9..d0825ffd38 100644 --- a/app/javascript/Components/peer_review_table.jsx +++ b/app/javascript/Components/peer_review_table.jsx @@ -14,6 +14,7 @@ class RawPeerReviewTable extends React.Component { loading: true, marking_states: markingStates, markingStateFilter: "all", + columns: this.getColumns(markingStates, "all"), }; } @@ -41,11 +42,12 @@ class RawPeerReviewTable extends React.Component { .then(res => { this.props.resetSelection(); const markingStates = getMarkingStates(res); - this.setState({ + this.setState(state => ({ peer_reviews: res, loading: false, marking_states: markingStates, - }); + columns: this.getColumns(markingStates, state.markingStateFilter), + })); }); }; @@ -53,14 +55,20 @@ class RawPeerReviewTable extends React.Component { const summaryTable = this.checkboxTable.getWrappedInstance(); if (column.id != "marking_state") { const markingStates = getMarkingStates(summaryTable.state.sortedData); - this.setState({marking_states: markingStates}); + this.setState(state => ({ + marking_states: markingStates, + columns: this.getColumns(markingStates, state.markingStateFilter), + })); } else { const markingStateFilter = filtered.find(filter => filter.id == "marking_state").value; - this.setState({markingStateFilter: markingStateFilter}); + this.setState(state => ({ + markingStateFilter, + columns: this.getColumns(state.marking_states, markingStateFilter), + })); } }; - columns = () => [ + getColumns = (marking_states, markingStateFilter) => [ { show: false, accessor: "_id", @@ -86,7 +94,7 @@ class RawPeerReviewTable extends React.Component { accessor: "reviewee_name", id: "reviewee_name", }, - markingStateColumn(this.state.marking_states, this.state.markingStateFilter, {minWidth: 70}), + markingStateColumn(marking_states, markingStateFilter, {minWidth: 70}), { Header: I18n.t("results.total_mark"), accessor: "final_grade", @@ -156,7 +164,7 @@ class RawPeerReviewTable extends React.Component { (this.checkboxTable = r)} data={this.state.peer_reviews} - columns={this.columns()} + columns={this.state.columns} defaultSorted={[ { id: "reviewer_name", diff --git a/app/javascript/Components/peer_reviews_manager.jsx b/app/javascript/Components/peer_reviews_manager.jsx index 5fd050f96a..9fa887f2f9 100644 --- a/app/javascript/Components/peer_reviews_manager.jsx +++ b/app/javascript/Components/peer_reviews_manager.jsx @@ -155,7 +155,23 @@ PeerReviewsManager.defaultProps = { }; class RawReviewersTable extends React.Component { - getColumns = () => { + constructor(props) { + super(props); + this.state = { + columns: this.getColumns(props.sections, props.showSections), + }; + } + + componentDidUpdate(prevProps) { + if ( + prevProps.sections !== this.props.sections || + prevProps.showSections !== this.props.showSections + ) { + this.setState({columns: this.getColumns(this.props.sections, this.props.showSections)}); + } + } + + getColumns = (sections, showSections) => { return [ { show: false, @@ -166,7 +182,7 @@ class RawReviewersTable extends React.Component { Header: I18n.t("activerecord.models.section", {count: 1}), accessor: "section", id: "section", - show: this.props.showSections, + show: showSections, minWidth: 70, Cell: ({value}) => { return value === "-" ? "" : value; @@ -179,7 +195,7 @@ class RawReviewersTable extends React.Component { } }, Filter: selectFilter, - filterOptions: Object.entries(this.props.sections).map(kv => ({ + filterOptions: Object.entries(sections).map(kv => ({ value: kv[1], text: kv[1], })), @@ -227,7 +243,7 @@ class RawReviewersTable extends React.Component { (this.checkboxTable = r)} data={groups_data} - columns={this.getColumns()} + columns={this.state.columns} defaultSorted={[ { id: "name", @@ -242,7 +258,23 @@ class RawReviewersTable extends React.Component { } class RawRevieweesTable extends React.Component { - getColumns = () => { + constructor(props) { + super(props); + this.state = { + columns: this.getColumns(props.sections, props.showSections), + }; + } + + componentDidUpdate(prevProps) { + if ( + prevProps.sections !== this.props.sections || + prevProps.showSections !== this.props.showSections + ) { + this.setState({columns: this.getColumns(this.props.sections, this.props.showSections)}); + } + } + + getColumns = (sections, showSections) => { return [ { show: false, @@ -253,7 +285,7 @@ class RawRevieweesTable extends React.Component { Header: I18n.t("activerecord.models.section", {count: 1}), accessor: "section", id: "section", - show: this.props.showSections, + show: showSections, minWidth: 70, Cell: ({value}) => { return value === "-" ? "" : value; @@ -266,7 +298,7 @@ class RawRevieweesTable extends React.Component { } }, Filter: selectFilter, - filterOptions: Object.entries(this.props.sections).map(kv => ({ + filterOptions: Object.entries(sections).map(kv => ({ value: kv[1], text: kv[1], })), @@ -347,7 +379,7 @@ class RawRevieweesTable extends React.Component { (this.checkboxTable = r)} data={groups_data} - columns={this.getColumns()} + columns={this.state.columns} defaultSorted={[ { id: "name", diff --git a/app/javascript/Components/student_peer_reviews_table.jsx b/app/javascript/Components/student_peer_reviews_table.jsx index 535b823b09..465fb1adf9 100644 --- a/app/javascript/Components/student_peer_reviews_table.jsx +++ b/app/javascript/Components/student_peer_reviews_table.jsx @@ -9,6 +9,27 @@ class StudentPeerReviewsTable extends React.Component { this.state = { peer_reviews: [], loading: true, + columns: [ + { + Header: I18n.t("activerecord.models.peer_review.one"), + Cell: row => { + return ( + + {`${I18n.t("activerecord.models.peer_review.one")} ${row.original["peer_reviews.id"]}`} + + ); + }, + }, + { + Header: I18n.t("submissions.status"), + accessor: "marking_state", + }, + ], }; } @@ -37,30 +58,11 @@ class StudentPeerReviewsTable extends React.Component { }); }; - columns = () => [ - { - Header: I18n.t("activerecord.models.peer_review.one"), - Cell: row => { - return ( - - {`${I18n.t("activerecord.models.peer_review.one")} ${row.original["peer_reviews.id"]}`} - - ); - }, - }, - { - Header: I18n.t("submissions.status"), - accessor: "marking_state", - }, - ]; - render() { return ( { - this.setState({ - data: res, - loading: false, - selection: [], - selectAll: false, - }); + this.setState({data: res, loading: false, columns: this.getColumns(res)}); }); }; @@ -49,8 +45,13 @@ class RawStudentTable extends React.Component { onSubmit = event => { event.preventDefault(); + // Convert rowSelection object to array of student IDs + const selectedIds = Object.keys(this.state.rowSelection).filter( + key => this.state.rowSelection[key] + ); + const data = { - student_ids: this.props.selection, + student_ids: selectedIds, bulk_action: this.actionBox.state.action, grace_credits: this.actionBox.state.grace_credits, section: this.actionBox.state.section, @@ -82,162 +83,140 @@ class RawStudentTable extends React.Component { }); }; + getColumns = data => { + return [ + columnHelper.accessor("user_name", { + header: I18n.t("activerecord.attributes.user.user_name"), + id: "user_name", + minSize: 120, + }), + columnHelper.accessor("first_name", { + header: I18n.t("activerecord.attributes.user.first_name"), + minSize: 120, + }), + columnHelper.accessor("last_name", { + header: I18n.t("activerecord.attributes.user.last_name"), + minSize: 120, + }), + columnHelper.accessor("email", { + header: I18n.t("activerecord.attributes.user.email"), + minSize: 150, + }), + columnHelper.accessor("id_number", { + header: I18n.t("activerecord.attributes.user.id_number"), + minSize: 90, + meta: { + className: "number", + }, + }), + columnHelper.accessor(row => data.sections[row.section] || "", { + header: I18n.t("activerecord.models.section", {count: 1}), + id: "section", + enableColumnFilter: Boolean(Object.keys(data.sections).length), + filterFn: "equals", + meta: { + filterVariant: "select", + }, + }), + columnHelper.accessor("remaining_grace_credits", { + header: I18n.t("activerecord.attributes.user.grace_credits"), + id: "grace_credits", + cell: ({getValue, row}) => { + return `${getValue()} / ${row.original.grace_credits}`; + }, + minSize: 90, + filterFn: (row, columnId, filterValue) => { + if (filterValue === "" || isNaN(filterValue)) { + return true; + } + return row.getValue(columnId) === Number(filterValue); + }, + meta: { + className: "number", + filterVariant: "number", + }, + }), + columnHelper.accessor( + row => (row.hidden ? I18n.t("roles.inactive") : I18n.t("roles.active")), + { + header: I18n.t("roles.active") + "?", + id: "hidden", + filterFn: "equals", + meta: { + filterVariant: "select", + }, + } + ), + columnHelper.accessor("_id", { + header: I18n.t("actions"), + cell: ({getValue}) => { + const id = getValue(); + + return ( + <> + + + + + + | + + this.removeStudent(id)} + aria-label={I18n.t("remove")} + title={I18n.t("remove")} + > + + + + + ); + }, + enableSorting: false, + enableColumnFilter: false, + }), + ]; + }; + render() { - const {data, loading} = this.state; + const {data, loading, rowSelection} = this.state; + const selectedCount = Object.keys(rowSelection).filter(key => rowSelection[key]).length; return ( (this.actionBox = r)} sections={data.sections} - disabled={this.props.selection.length === 0} + disabled={selectedCount === 0} onSubmit={this.onSubmit} authenticity_token={this.props.authenticity_token} /> - (this.checkboxTable = r)} + { - return data.sections[value] || ""; - }, - show: Boolean(data.sections), - filterMethod: (filter, row) => { - if (filter.value === "all") { - return true; - } else { - return data.sections[row[filter.id]] === filter.value; - } + columns={this.state.columns} + enableRowSelection={true} + rowSelection={rowSelection} + onRowSelectionChange={updater => { + this.setState(prevState => ({ + rowSelection: + typeof updater === "function" ? updater(prevState.rowSelection) : updater, + })); + }} + getRowId={row => row._id} + initialState={{ + sorting: [ + { + id: "user_name", }, - Filter: selectFilter, - filterOptions: Object.entries(data.sections).map(kv => ({ - value: kv[1], - text: kv[1], - })), - }, - { - Header: I18n.t("activerecord.attributes.user.grace_credits"), - id: "grace_credits", - accessor: "remaining_grace_credits", - className: "number", - Cell: row => `${row.value} / ${row.original.grace_credits}`, - minWidth: 90, - Filter: ({filter, onChange}) => ( - onChange(event.target.valueAsNumber)} - type="number" - min={0} - value={filter ? filter.value : ""} - /> - ), - filterMethod: (filter, row) => { - return ( - isNaN(filter.value) || filter.value === row._original.remaining_grace_credits - ); - }, - }, - { - Header: I18n.t("roles.active") + "?", - accessor: "hidden", - Cell: ({value}) => (value ? I18n.t("roles.inactive") : I18n.t("roles.active")), - filterMethod: (filter, row) => { - if (filter.value === "all") { - return true; - } else { - return ( - (filter.value === "active" && !row[filter.id]) || - (filter.value === "inactive" && row[filter.id]) - ); - } - }, - Filter: selectFilter, - filterOptions: [ - { - value: "active", - text: `${I18n.t("roles.active")} (${this.state.data.counts.active})`, - }, - { - value: "inactive", - text: `${I18n.t("roles.inactive")} (${this.state.data.counts.inactive})`, - }, - ], - filterAllOptionText: `${I18n.t("all")} (${this.state.data.counts.all})`, - }, - { - Header: I18n.t("actions"), - accessor: "_id", - Cell: data => ( - <> - - - - - - | - - this.removeStudent(data.value)} - aria-label={I18n.t("remove")} - title={I18n.t("remove")} - > - - - - - ), - sortable: false, - filterable: false, - }, - ]} - getNoDataProps={() => ({ - loading, - data, - })} - defaultSorted={[ - { - id: "user_name", - }, - ]} - filterable + ], + }} noDataText={I18n.t("students.empty_table")} - {...this.props.getCheckboxProps()} /> ); @@ -330,15 +309,11 @@ StudentsActionBox.propTypes = { sections: PropTypes.object, }; -RawStudentTable.propTypes = { +StudentTable.propTypes = { course_id: PropTypes.number, - selection: PropTypes.array.isRequired, authenticity_token: PropTypes.string, - getCheckboxProps: PropTypes.func.isRequired, }; -let StudentTable = withSelection(RawStudentTable); - function makeStudentTable(elem, props) { const root = createRoot(elem); root.render(); diff --git a/app/javascript/Components/submission_table.jsx b/app/javascript/Components/submission_table.jsx index e79fe010ed..b5f76abb85 100644 --- a/app/javascript/Components/submission_table.jsx +++ b/app/javascript/Components/submission_table.jsx @@ -15,8 +15,8 @@ import consumer from "../channels/consumer"; import {renderFlashMessages} from "../common/flash"; class RawSubmissionTable extends React.Component { - constructor() { - super(); + constructor(props) { + super(props); const markingStates = getMarkingStates([]); this.state = { groupings: [], @@ -28,6 +28,7 @@ class RawSubmissionTable extends React.Component { markingStateFilter: "all", inactiveGroupsCount: 0, filtered: [], + columns: this.getColumns({}, markingStates, "all"), }; } @@ -67,13 +68,14 @@ class RawSubmissionTable extends React.Component { const markingStates = getMarkingStates(res.groupings); - this.setState({ + this.setState(state => ({ groupings: res.groupings, sections: res.sections, loading: false, marking_states: markingStates, inactiveGroupsCount: inactive_groups_count, - }); + columns: this.getColumns(res.sections, markingStates, state.markingStateFilter), + })); }); }; @@ -81,13 +83,19 @@ class RawSubmissionTable extends React.Component { const summaryTable = this.checkboxTable.getWrappedInstance(); if (column.id != "marking_state") { const markingStates = getMarkingStates(summaryTable.state.sortedData); - this.setState({marking_states: markingStates}); + this.setState(state => ({ + marking_states: markingStates, + columns: this.getColumns(state.sections, markingStates, state.markingStateFilter), + filtered, + })); } else { const markingStateFilter = filtered.find(filter => filter.id == "marking_state").value; - this.setState({markingStateFilter: markingStateFilter}); + this.setState(state => ({ + markingStateFilter, + columns: this.getColumns(state.sections, state.marking_states, markingStateFilter), + filtered, + })); } - - this.setState({filtered}); }; groupNameWithMembers = row => { @@ -118,7 +126,7 @@ class RawSubmissionTable extends React.Component { } }; - columns = () => [ + getColumns = (sections, marking_states, markingStateFilter) => [ { show: false, accessor: "inactive", @@ -183,7 +191,7 @@ class RawSubmissionTable extends React.Component { } }, Filter: selectFilter, - filterOptions: Object.entries(this.state.sections).map(kv => ({ + filterOptions: Object.entries(sections).map(kv => ({ value: kv[1], text: kv[1], })), @@ -229,7 +237,7 @@ class RawSubmissionTable extends React.Component { minWidth: 100, style: {textAlign: "right"}, }, - markingStateColumn(this.state.marking_states, this.state.markingStateFilter, {minWidth: 70}), + markingStateColumn(marking_states, markingStateFilter, {minWidth: 70}), { Header: I18n.t("results.total_mark"), accessor: "final_grade", @@ -482,7 +490,7 @@ class RawSubmissionTable extends React.Component { (this.checkboxTable = r)} data={this.state.groupings} - columns={this.columns()} + columns={this.state.columns} defaultSorted={[ { id: "group_name", @@ -627,7 +635,7 @@ class SubmissionsActionBox extends React.Component { onClick={this.props.unreleaseMarks} title={I18n.t("submissions.unrelease_marks")} > - + + ) : ( - + ); } + +function FilterCell({size, column, filterValue, facetedUniqueValues}) { + return ( + + {column.getCanFilter() && ( + + )} + + ); +} + +export default React.memo(FilterCell); diff --git a/app/javascript/Components/table/search_filter.jsx b/app/javascript/Components/table/search_filter.jsx index a19f45dfa9..1827f8fc39 100644 --- a/app/javascript/Components/table/search_filter.jsx +++ b/app/javascript/Components/table/search_filter.jsx @@ -2,13 +2,13 @@ import React from "react"; export const defaultSearchPlaceholderText = () => I18n.t("table.search"); -export default function SearchFilter({column}) { +export default function SearchFilter({column, filterValue}) { return ( column.setFilterValue(e.target.value)} - value={column.getFilterValue()?.toString() || ""} + value={filterValue?.toString() || ""} style={{width: "100%"}} aria-label={defaultSearchPlaceholderText()} /> diff --git a/app/javascript/Components/table/select_filter.jsx b/app/javascript/Components/table/select_filter.jsx index 5d6af49afa..364f1711f3 100644 --- a/app/javascript/Components/table/select_filter.jsx +++ b/app/javascript/Components/table/select_filter.jsx @@ -1,26 +1,26 @@ import React from "react"; -export default function SelectFilter({column}) { - const uniqueValuesMap = column.getFacetedUniqueValues(); - +export default function SelectFilter({column, filterValue, facetedUniqueValues}) { const sortedUniqueValues = React.useMemo(() => { - return Array.from(uniqueValuesMap.keys()).sort(); - }, [uniqueValuesMap]); + return Array.from(facetedUniqueValues.keys()) + .filter(value => value !== "") + .sort(); + }, [facetedUniqueValues]); const totalRowCount = React.useMemo(() => { - return [...uniqueValuesMap.values()].reduce((sum, count) => sum + count, 0); - }, [uniqueValuesMap]); + return [...(facetedUniqueValues.values() || [])].reduce((sum, count) => sum + count, 0); + }, [facetedUniqueValues]); return ( column.setFilterValue(e.target.value)} - value={column.getFilterValue()?.toString() || ""} + value={filterValue?.toString() || ""} style={{width: "100%"}} > All ({totalRowCount}) {sortedUniqueValues.map(value => ( - {value} ({uniqueValuesMap.get(value).toString()}) + {value} ({facetedUniqueValues.get(value).toString()}) ))} diff --git a/app/javascript/Components/table/table.jsx b/app/javascript/Components/table/table.jsx index a3148da82c..406e223957 100644 --- a/app/javascript/Components/table/table.jsx +++ b/app/javascript/Components/table/table.jsx @@ -4,7 +4,6 @@ import {FontAwesomeIcon} from "@fortawesome/react-fontawesome"; import { createColumnHelper, - flexRender, getCoreRowModel, getExpandedRowModel, getFacetedRowModel, @@ -13,7 +12,9 @@ import { getSortedRowModel, useReactTable, } from "@tanstack/react-table"; -import Filter from "./filter"; +import FilterCell from "./filter"; +import TableHeaderCell from "./table_header_cell"; +import TableRow from "./table_row"; export const defaultNoDataText = () => I18n.t("table.no_data"); @@ -38,6 +39,41 @@ export const expanderColumn = columnHelper.display({ }, }); +export const selectionColumn = columnHelper.display({ + id: "select", + header: ({table}) => { + const checkboxRef = React.useRef(null); + + React.useEffect(() => { + if (checkboxRef.current) { + checkboxRef.current.indeterminate = + table.getIsSomeRowsSelected() && !table.getIsAllRowsSelected(); + } + }, [table.getIsSomeRowsSelected(), table.getIsAllRowsSelected()]); + + return ( + + ); + }, + size: 30, + maxSize: 30, + enableResizing: false, + enableSorting: false, + cell: ({row}) => ( + + ), +}); + export default function Table({ columns, data, @@ -46,23 +82,55 @@ export default function Table({ loading, renderSubComponent, getRowCanExpand, + getRowId, + enableRowSelection, + rowSelection: externalRowSelection, columnFilters: externalColumnFilters, onColumnFiltersChange: externalOnColumnFiltersChange, + onRowSelectionChange, }) { const [internalColumnFilters, setInternalColumnFilters] = React.useState([]); const [columnSizing, setColumnSizing] = React.useState({}); - const [columnVisibility, setColumnVisibility] = React.useState({inactive: false}); + const [columnVisibility, setColumnVisibility] = React.useState({ + inactive: false, + ...initialState?.columnVisibility, + }); const [expanded, setExpanded] = React.useState({}); + const [internalRowSelection, setInternalRowSelection] = React.useState({}); - const columnFilters = - externalColumnFilters !== undefined ? externalColumnFilters : internalColumnFilters; + const columnFilters = React.useMemo( + () => (externalColumnFilters !== undefined ? externalColumnFilters : internalColumnFilters), + [externalColumnFilters, internalColumnFilters] + ); + + const handleColumnFiltersChange = React.useMemo( + () => + externalOnColumnFiltersChange !== undefined + ? externalOnColumnFiltersChange + : setInternalColumnFilters, + [externalOnColumnFiltersChange] + ); + + const rowSelection = React.useMemo( + () => (externalRowSelection !== undefined ? externalRowSelection : internalRowSelection), + [externalRowSelection, internalRowSelection] + ); - const handleColumnFiltersChange = - externalOnColumnFiltersChange !== undefined - ? externalOnColumnFiltersChange - : setInternalColumnFilters; + const handleRowSelectionChange = React.useMemo( + () => (onRowSelectionChange !== undefined ? onRowSelectionChange : setInternalRowSelection), + [onRowSelectionChange] + ); - const finalColumns = renderSubComponent ? [expanderColumn, ...columns] : columns; + const finalColumns = React.useMemo(() => { + let cols = [...columns]; + if (enableRowSelection) { + cols = [selectionColumn, ...cols]; + } + if (renderSubComponent) { + cols = [expanderColumn, ...cols]; + } + return cols; + }, [columns, enableRowSelection, renderSubComponent]); const table = useReactTable({ data, @@ -72,12 +140,14 @@ export default function Table({ columnSizing, columnVisibility, expanded, + rowSelection, }, initialState: initialState, onColumnFiltersChange: handleColumnFiltersChange, onColumnSizingChange: setColumnSizing, onColumnVisibilityChange: setColumnVisibility, onExpandedChange: setExpanded, + onRowSelectionChange: handleRowSelectionChange, getCoreRowModel: getCoreRowModel(), getExpandedRowModel: getExpandedRowModel(), getFilteredRowModel: getFilteredRowModel(), @@ -85,108 +155,103 @@ export default function Table({ getFacetedUniqueValues: getFacetedUniqueValues(), getFacetedRowModel: getFacetedRowModel(), getRowCanExpand, + getRowId, enableSortingRemoval: false, enableColumnResizing: true, + enableRowSelection: enableRowSelection, columnResizeMode: "onChange", }); + const centerTotalSize = table.getCenterTotalSize(); + + const tableHeaders = ( + + {table.getHeaderGroups().map(headerGroup => ( + + {headerGroup.headers.map(header => ( + + ))} + + ))} + + ); + + const showFilters = React.useMemo( + () => table.getAllColumns().some(column => column.getCanFilter()), + [table, finalColumns] + ); + const tableFilters = showFilters && ( + + {table.getHeaderGroups().map(headerGroup => ( + + {headerGroup.headers.map(header => ( + + ))} + + ))} + + ); + return ( - - {table.getHeaderGroups().map(headerGroup => ( - - {headerGroup.headers.map(header => { - let class_name = - "rt-th rt-resizable-header --cursor-pointer" + - { - asc: " rt-resizable-header-content -sort-asc", - desc: " rt-resizable-header-content -sort-desc", - false: "", - }[header.column.getIsSorted()]; - return ( - - - {flexRender(header.column.columnDef.header, header.getContext())} - - - - ); - })} - + {tableHeaders} + {tableFilters} + + {table.getRowModel().rows.map(row => ( + ))} - - - {table.getHeaderGroups().map(headerGroup => ( - - {headerGroup.headers.map(header => { - return ( - - {header.column.getCanFilter() ? : null} - - ); - })} + {loading && table.getRowModel().rows.length > 0 && ( + + - ))} - - - {table.getRowModel().rows.map(row => { - return ( - - - {row.getVisibleCells().map(cell => { - const metaClass = cell.column.columnDef.meta?.className || ""; - return ( - - {flexRender(cell.column.columnDef.cell, cell.getContext())} - - ); - })} - - {row.getIsExpanded() && {renderSubComponent({row})}} - - ); - })} + )} {!table.getRowModel().rows.length && (loading ? ( diff --git a/app/javascript/Components/table/table_cell.jsx b/app/javascript/Components/table/table_cell.jsx new file mode 100644 index 0000000000..b458de2b2e --- /dev/null +++ b/app/javascript/Components/table/table_cell.jsx @@ -0,0 +1,21 @@ +import React from "react"; +import {flexRender} from "@tanstack/react-table"; + +function TableCell({cell, width}) { + const metaClass = cell.column.columnDef.meta?.className || ""; + return ( + + {flexRender(cell.column.columnDef.cell, cell.getContext())} + + ); +} + +export default React.memo(TableCell); diff --git a/app/javascript/Components/table/table_header_cell.jsx b/app/javascript/Components/table/table_header_cell.jsx new file mode 100644 index 0000000000..de20a8708e --- /dev/null +++ b/app/javascript/Components/table/table_header_cell.jsx @@ -0,0 +1,44 @@ +import React from "react"; +import {flexRender} from "@tanstack/react-table"; + +function TableHeaderCell({header, size, isSorted, isResizing}) { + const resizable = header.column.columnDef.enableResizing !== false; + const sortable = header.column.columnDef.enableSorting !== false; + + let class_name = "rt-th"; + if (resizable) { + class_name += " rt-resizable-header rt-resizable-header-content"; + } + if (sortable) { + class_name += " -cursor-pointer"; + class_name += {asc: " -sort-asc", desc: " -sort-desc", false: ""}[isSorted]; + } + + return ( + + + {flexRender(header.column.columnDef.header, header.getContext())} + + {resizable && ( + + )} + + ); +} + +export default React.memo(TableHeaderCell); diff --git a/app/javascript/Components/table/table_row.jsx b/app/javascript/Components/table/table_row.jsx new file mode 100644 index 0000000000..9e336d79f1 --- /dev/null +++ b/app/javascript/Components/table/table_row.jsx @@ -0,0 +1,36 @@ +import React from "react"; +import TableCell from "./table_cell"; + +function TableRow({row, isSelected, isExpanded, renderSubComponent}) { + return ( + + + {row.getVisibleCells().map(cell => { + // Only pass isSelected to the selection column. This prevents other cells from re-rendering + // if the row selection status changes. + const cellSelection = cell.column.columnDef.id === "select" ? isSelected : null; + return ( + + ); + })} + + {isExpanded && {renderSubComponent({row})}} + + ); +} + +export default React.memo( + TableRow, + (prev, next) => + // react-table creates new row objects when filter values change. + // We compare row.original rather than row to determine whether to re-render. + prev.row.original === next.row.original && + prev.isSelected === next.isSelected && + prev.isExpanded === next.isExpanded && + prev.columnSizing === next.columnSizing +); diff --git a/app/javascript/Components/test_group_result_table.jsx b/app/javascript/Components/test_group_result_table.jsx index fd1fc867fd..4f8faa474c 100644 --- a/app/javascript/Components/test_group_result_table.jsx +++ b/app/javascript/Components/test_group_result_table.jsx @@ -11,6 +11,90 @@ export class TestGroupResultTable extends React.Component { expanded: this.computeExpanded(props.data), filtered: [], filteredData: props.data, + columns: [ + { + id: "test_group_id", + Header: "", + accessor: row => row["test_groups.id"], + maxWidth: 30, + }, + { + id: "test_group_name", + Header: "", + accessor: row => row["test_groups.name"], + maxWidth: 30, + show: false, + }, + { + id: "name", + Header: I18n.t("activerecord.attributes.test_result.name"), + accessor: row => row["test_results.name"], + aggregate: (_vals, rows) => { + if (rows.length === 0) { + return ""; + } else { + return rows[0]["test_group_name"]; + } + }, + minWidth: 200, + }, + { + id: "test_status", + Header: I18n.t("activerecord.attributes.test_result.status"), + accessor: "test_results_status", + width: 80, + aggregate: (_vals, rows) => { + const hasTimeout = rows.some( + row => row._original["test_group_results.error_type"] === "timeout" + ); + return hasTimeout ? "timeout" : ""; + }, + Aggregated: row => { + return row.value === "timeout" + ? I18n.t("activerecord.attributes.test_group_result.timeout") + : ""; + }, + filterable: true, + Filter: selectFilter, + filterOptions: ["pass", "partial", "fail", "error", "error_all"].map(status => ({ + value: status, + text: status, + })), + // Disable the default filter method because this is a controlled component + filterMethod: () => true, + }, + { + id: "marks_earned", + Header: I18n.t("activerecord.attributes.test_result.marks_earned"), + accessor: row => row["test_results.marks_earned"], + Cell: row => { + const marksEarned = row.original["test_results.marks_earned"]; + const marksTotal = row.original["test_results.marks_total"]; + if (marksEarned !== null && marksTotal !== null) { + return `${marksEarned} / ${marksTotal}`; + } else { + return ""; + } + }, + width: 80, + className: "number", + aggregate: (vals, rows) => + rows.reduce( + (acc, row) => [ + acc[0] + (row._original["test_results.marks_earned"] || 0), + acc[1] + (row._original["test_results.marks_total"] || 0), + ], + [0, 0] + ), + Aggregated: row => { + const timeout_reached = row.value[0] === 0 && row.value[1] === 0; + const ret_val = timeout_reached + ? I18n.t("activerecord.attributes.test_group_result.no_test_results") + : `${row.value[0]} / ${row.value[1]}`; + return ret_val; + }, + }, + ], }; } @@ -46,91 +130,6 @@ export class TestGroupResultTable extends React.Component { } }; - columns = () => [ - { - id: "test_group_id", - Header: "", - accessor: row => row["test_groups.id"], - maxWidth: 30, - }, - { - id: "test_group_name", - Header: "", - accessor: row => row["test_groups.name"], - maxWidth: 30, - show: false, - }, - { - id: "name", - Header: I18n.t("activerecord.attributes.test_result.name"), - accessor: row => row["test_results.name"], - aggregate: (values, rows) => { - if (rows.length === 0) { - return ""; - } else { - return rows[0]["test_group_name"]; - } - }, - minWidth: 200, - }, - { - id: "test_status", - Header: I18n.t("activerecord.attributes.test_result.status"), - accessor: "test_results_status", - width: 80, - aggregate: (vals, rows) => { - const hasTimeout = rows.some( - row => row._original["test_group_results.error_type"] === "timeout" - ); - return hasTimeout ? "timeout" : ""; - }, - Aggregated: row => { - return row.value === "timeout" - ? I18n.t("activerecord.attributes.test_group_result.timeout") - : ""; - }, - filterable: true, - Filter: selectFilter, - filterOptions: ["pass", "partial", "fail", "error", "error_all"].map(status => ({ - value: status, - text: status, - })), - // Disable the default filter method because this is a controlled component - filterMethod: () => true, - }, - { - id: "marks_earned", - Header: I18n.t("activerecord.attributes.test_result.marks_earned"), - accessor: row => row["test_results.marks_earned"], - Cell: row => { - const marksEarned = row.original["test_results.marks_earned"]; - const marksTotal = row.original["test_results.marks_total"]; - if (marksEarned !== null && marksTotal !== null) { - return `${marksEarned} / ${marksTotal}`; - } else { - return ""; - } - }, - width: 80, - className: "number", - aggregate: (vals, rows) => - rows.reduce( - (acc, row) => [ - acc[0] + (row._original["test_results.marks_earned"] || 0), - acc[1] + (row._original["test_results.marks_total"] || 0), - ], - [0, 0] - ), - Aggregated: row => { - const timeout_reached = row.value[0] === 0 && row.value[1] === 0; - const ret_val = timeout_reached - ? I18n.t("activerecord.attributes.test_group_result.no_test_results") - : `${row.value[0]} / ${row.value[1]}`; - return ret_val; - }, - }, - ]; - filterByStatus = filtered => { let status; for (const filter of filtered) { @@ -202,7 +201,7 @@ export class TestGroupResultTable extends React.Component { { if (rowInfo) { diff --git a/app/javascript/application_webpack.js b/app/javascript/application_webpack.js index d66d2163b5..5213c6b3df 100644 --- a/app/javascript/application_webpack.js +++ b/app/javascript/application_webpack.js @@ -95,6 +95,7 @@ import "./common/menu"; import "./common/react_config"; import "./common/redirect"; import "./common/fetch_proxy"; +import "./common/annotations/globals"; // assets that export vars/functions/classes // TODO: We shouldn't need to make everything global. @@ -108,6 +109,8 @@ import {refreshOrLogout} from "./common/refresh_or_logout"; window.refreshOrLogout = refreshOrLogout; import {ModalMarkus} from "./common/modals"; window.ModalMarkus = ModalMarkus; +import {updateOcrSuggestions} from "./common/ocr_suggestions"; +window.updateOcrSuggestions = updateOcrSuggestions; import {makeDashboard} from "./Components/dashboard"; window.makeDashboard = makeDashboard; import {makeAssignmentSummary} from "./Components/assignment_summary"; diff --git a/app/assets/javascripts/Annotations/annotation_manager.js b/app/javascript/common/annotations/annotation_manager.js similarity index 86% rename from app/assets/javascripts/Annotations/annotation_manager.js rename to app/javascript/common/annotations/annotation_manager.js index bf07406755..67eec8091a 100644 --- a/app/assets/javascripts/Annotations/annotation_manager.js +++ b/app/javascript/common/annotations/annotation_manager.js @@ -1,7 +1,11 @@ +import {AnnotationText} from "./annotation_text"; +import {AnnotationTextDisplayer} from "./annotation_text_displayer"; +import {AnnotationTextManager} from "./annotation_text_manager"; + /** - * Abstract class AnnotationManager, used to manage the annotations for a submission. + * AbstractAnnotationManager class, used to manage the annotations for a submission. */ -class AnnotationManager { +export class AbstractAnnotationManager { constructor() { this.annotation_text_displayer = new AnnotationTextDisplayer(); this.annotation_text_manager = new AnnotationTextManager(); @@ -62,7 +66,7 @@ class AnnotationManager { /** * Returns the selection box coordinates (used when creating an annotation). - * This is an abstract method that should be overridden by each AnnotationManager subclass. + * This is an abstract method that should be overridden by each AbstractAnnotationManager subclass. * * @param warn_no_selection If true (default), display an alert to the user when there is no selection * @returns {object} diff --git a/app/assets/javascripts/Annotations/annotation_text.js b/app/javascript/common/annotations/annotation_text.js similarity index 90% rename from app/assets/javascripts/Annotations/annotation_text.js rename to app/javascript/common/annotations/annotation_text.js index 12c0dc93f2..e11e9b9001 100644 --- a/app/assets/javascripts/Annotations/annotation_text.js +++ b/app/javascript/common/annotations/annotation_text.js @@ -3,7 +3,7 @@ This class holds the annotation texts in client memory. */ -class AnnotationText { +export class AnnotationText { constructor(annotation_text_id, annotation_category_id, content) { this.annotation_text_id = annotation_text_id; this.annotation_category_id = annotation_category_id; diff --git a/app/assets/javascripts/Annotations/annotation_text_displayer.js b/app/javascript/common/annotations/annotation_text_displayer.js similarity index 95% rename from app/assets/javascripts/Annotations/annotation_text_displayer.js rename to app/javascript/common/annotations/annotation_text_displayer.js index a8218e5116..73b8d900ad 100644 --- a/app/assets/javascripts/Annotations/annotation_text_displayer.js +++ b/app/javascript/common/annotations/annotation_text_displayer.js @@ -5,12 +5,9 @@ displaying that div at given coordinates, and hiding that div. Multiple texts are displayed at once, and each one is contained with a tag. - - Rules: - - Assumes existence of AnnotationText class */ -class AnnotationTextDisplayer { +export class AnnotationTextDisplayer { constructor() { // Create the div that we will display in this.display_node = document.createElement("div"); diff --git a/app/assets/javascripts/Annotations/annotation_text_manager.js b/app/javascript/common/annotations/annotation_text_manager.js similarity index 95% rename from app/assets/javascripts/Annotations/annotation_text_manager.js rename to app/javascript/common/annotations/annotation_text_manager.js index 2deda63d3c..66eb06ee1d 100644 --- a/app/assets/javascripts/Annotations/annotation_text_manager.js +++ b/app/javascript/common/annotations/annotation_text_manager.js @@ -4,7 +4,7 @@ * This class is in charge of controlling the Annotation Texts */ -class AnnotationTextManager { +export class AnnotationTextManager { constructor() { this.annotation_texts = {}; } diff --git a/app/assets/javascripts/Annotations/globals.js b/app/javascript/common/annotations/globals.js similarity index 70% rename from app/assets/javascripts/Annotations/globals.js rename to app/javascript/common/annotations/globals.js index d1cfc29a74..2ecb9e0d5b 100644 --- a/app/assets/javascripts/Annotations/globals.js +++ b/app/javascript/common/annotations/globals.js @@ -1,8 +1,8 @@ // Global variables currently used by the annotation code // TODO: remove these! -var annotation_manager = null; +window.annotation_manager = null; -var ANNOTATION_TYPES = { +window.ANNOTATION_TYPES = { CODE: 0, IMAGE: 1, PDF: 2, @@ -11,4 +11,4 @@ var ANNOTATION_TYPES = { // Enum to tell the code if an image, code, or pdf is being shown // in the codeviewer -var annotation_type; +window.annotation_type = null; diff --git a/app/assets/javascripts/Annotations/html_annotations.js b/app/javascript/common/annotations/html_annotations.js similarity index 96% rename from app/assets/javascripts/Annotations/html_annotations.js rename to app/javascript/common/annotations/html_annotations.js index 836eed637d..9c0d3a57f4 100644 --- a/app/assets/javascripts/Annotations/html_annotations.js +++ b/app/javascript/common/annotations/html_annotations.js @@ -31,7 +31,7 @@ function check_annotation_overlap(range) { ); } -function get_html_annotation_range() { +export function get_html_annotation_range() { const iframe = document.getElementById("html-content"); const target = iframe.contentDocument; const selection = target.getSelection(); diff --git a/app/assets/javascripts/Annotations/image_annotation_manager.js b/app/javascript/common/annotations/image_annotation_manager.js similarity index 98% rename from app/assets/javascripts/Annotations/image_annotation_manager.js rename to app/javascript/common/annotations/image_annotation_manager.js index b4cf57b6eb..f6a14bce02 100644 --- a/app/assets/javascripts/Annotations/image_annotation_manager.js +++ b/app/javascript/common/annotations/image_annotation_manager.js @@ -1,9 +1,11 @@ +import {AbstractAnnotationManager} from "./annotation_manager"; + /** - * AnnotationManager subclass for PDF files. + * AbstractAnnotationManager subclass for PDF files. * * @param {boolean} enable_annotations Whether annotations can be modified */ -class ImageAnnotationManager extends AnnotationManager { +export class ImageAnnotationManager extends AbstractAnnotationManager { constructor(enable_annotations) { super(); this.enable_annotations = enable_annotations; @@ -67,9 +69,9 @@ class ImageAnnotationManager extends AnnotationManager { if (holder === null) { holder = document.createElement("div"); holder.id = "annotation_holder_" + annotation_id; - holder.addClass("annotation_holder"); + holder.classList.add("annotation_holder"); if (this.annotations[annotation_id].is_remark) { - holder.addClass("remark"); + holder.classList.add("remark"); } holder.onmousemove = this.check_for_annotations.bind(this); if (this.enable_annotations) { diff --git a/app/javascript/common/annotations/pdf_annotation_manager.js b/app/javascript/common/annotations/pdf_annotation_manager.js new file mode 100644 index 0000000000..8750f1de3c --- /dev/null +++ b/app/javascript/common/annotations/pdf_annotation_manager.js @@ -0,0 +1,424 @@ +import {AbstractAnnotationManager} from "./annotation_manager"; + +// CONSTANTS +const MOUSE_OFFSET = 10; // The offset from the mouse cursor point +const HIDE_BOX_THRESHOLD = 10; // Threshold for not displaying selection box in pixels +const COORDINATE_PRECISION = 5; // Keep 5 decimal places (used when converting back from ints) +const COORDINATE_MULTIPLIER = Math.pow(10, COORDINATE_PRECISION); + +/** + * AbstractAnnotationManager subclass for PDF files. + * + * @param {boolean} enable_annotations Whether annotations can be modified + */ +export class PdfAnnotationManager extends AbstractAnnotationManager { + constructor(enable_annotations) { + // Members + super(); + this.angle = 0; // current orientation of the PDF + + this.annotationControls = {}; // DOM elements added for annotations + + /** @type {{page: int, $control: HTMLElement}} */ + this.selectionBox = {}; + + // The current selection area. The x, y are stored as percentages + // for device independent resolution + /** @type {{x: number, y: number, width: number, height: number}} */ + this.currentSelection = {}; + + // Event Handlers + if (enable_annotations) { + this.bindPageEvents(); + } + } + + /** + * Get a selection for a specific page. + * @return {{page: {int}, $control: {HTMLElement}}} + */ + getSelectionBox($page) { + let pageNumber = $page.data("page-number"); + + if ( + this.selectionBox.page === pageNumber && + this.selectionBox.$control !== null && + $.contains(document, this.selectionBox.$control) + ) { + return this.selectionBox; + } else if (this.selectionBox.$control != null) { + this.selectionBox.$control.remove(); // Remove old control + } + + let $control = document.createElement("div"); + $control.id = "sel_box"; + $control.classList.add("annotation-holder-active"); + $control.style.display = "none"; + + // append $control before the first annotation_holder but after the annotationLayer + // or else you will be prevented from deleting/editing old annotations + let $first_anno = $page.find(".annotation_holder:first")[0]; + + if (!!$first_anno) { + $first_anno.parentNode.insertBefore($control, $first_anno); + } else { + $page.append($control); + } + + this.selectionBox = { + page: pageNumber, + $control: $control, + }; + + return this.selectionBox; + } + + /** + * Update and redraw the selection box. + * + * @param {jQuery} $page The page the control is for. + * @param {{x, y, width, height, visible}} params Values to update + */ + setSelectionBox($page, params) { + if (params) { + Object.assign(this.currentSelection, params); + + let sel_box = this.getSelectionBox($page).$control; + sel_box.style.top = this.currentSelection.y * 100 + "%"; + sel_box.style.left = this.currentSelection.x * 100 + "%"; + sel_box.style.width = this.currentSelection.width * 100 + "%"; + sel_box.style.height = this.currentSelection.height * 100 + "%"; + + sel_box.style.display = this.currentSelection.visible ? "block" : "none"; + } + } + + hide_selection_box() { + this.currentSelection.visible = false; + if (this.selectionBox.$control) { + this.selectionBox.$control.style.display = "none"; + } + } + + /** + * Returns the selection box coordinates (used when creating an annotation). + * @returns {{x1, y1, x2, y2, page}} + */ + getSelection(warn_no_selection = true) { + let box = this.get_pdf_box_attrs(); + if (!box) { + if (warn_no_selection) { + alert(I18n.t("results.annotation.select_an_area_pdf")); + } + return false; + } + let page = box.page; + box = getRotatedCoords(box, 360 - annotation_manager.angle); + + return {...box, page: page}; + } + + get_pdf_box_attrs() { + let box = this.selectionRectangleAsInts(); + let boxSize = this.selectionBoxSize(); + + if (!box || boxSize.width < HIDE_BOX_THRESHOLD || boxSize.height < HIDE_BOX_THRESHOLD) { + return false; + } else { + return box; + } + } + + /** + * Return the current selection bounding rectangle if there is one, and + * converts the floating point percentages to integers. + * + * @return {{x1, y1, x2, y2, page}} Bounding box (points are in percentages) + */ + selectionRectangleAsInts() { + if (!this.currentSelection.visible) { + return null; + } + + return { + x1: parseInt(this.currentSelection.x * COORDINATE_MULTIPLIER, 10), + y1: parseInt(this.currentSelection.y * COORDINATE_MULTIPLIER, 10), + x2: parseInt( + (this.currentSelection.x + this.currentSelection.width) * COORDINATE_MULTIPLIER, + 10 + ), + y2: parseInt( + (this.currentSelection.y + this.currentSelection.height) * COORDINATE_MULTIPLIER, + 10 + ), + page: this.selectionBox.page, + }; + } + + /** + * Get the selection box size in pixels. If there is no selection box + * return {width: 0, height: 0}. + * + * @return {{width: int, height: int}} The selection box size in pixels + */ + selectionBoxSize() { + let $box = this.selectionBox.$control; + + return $box ? {width: $box.offsetWidth, height: $box.offsetHeight} : {width: 0, height: 0}; + } + + /** + * Add an annotation to the PDF. + * + * @param {string} annotation_text_id [description] + * @param {string} content [description] + * @param {{x1: int, y1: int, x2: int, y2: int, page: int}} range + * @param {string} annotation_id the id of the annotation + * @param {boolean} is_remark + */ + addAnnotation(annotation_text_id, content, range, annotation_id, is_remark) { + let annotation = super.addAnnotation( + annotation_text_id, + content, + range, + annotation_id, + is_remark + ); + + // Update display + this.renderAnnotation(annotation); + this.hide_selection_box(); + } + + /** + * Remove an annotation + * @param {string} annotation_id Annotation ID + */ + removeAnnotation(annotation_id) { + let annotation = super.removeAnnotation(annotation_id); + if (annotation === undefined) { + return; + } + this.annotationControls[annotation_id].remove(); // Delete DOM node + } + + /** + * Draw the annotation on the screen. + * + * @param {{annotation_id: string, annotation_text: Object, range: Object}} annotation + */ + renderAnnotation = function (annotation) { + let {annotation_id, annotation_text, range} = annotation; + if (this.annotationControls[annotation_id]) { + this.annotationControls[annotation_id].remove(); // Remove old controls + } + + // The coords are in the unrotated form, but the PDF may be in a different orientation. + let newCoords = getRotatedCoords(range, this.angle); + + let $control = document.createElement("div"); + $control.id = "annotation_holder_" + annotation_id; + $control.classList.add("annotation_holder"); + if (this.annotations[annotation_id].is_remark) { + $control.classList.add("remark"); + } + $control.style.top = (newCoords.y1 / COORDINATE_MULTIPLIER) * 100 + "%"; + $control.style.left = (newCoords.x1 / COORDINATE_MULTIPLIER) * 100 + "%"; + $control.style.width = ((newCoords.x2 - newCoords.x1) / COORDINATE_MULTIPLIER) * 100 + "%"; + $control.style.height = ((newCoords.y2 - newCoords.y1) / COORDINATE_MULTIPLIER) * 100 + "%"; + + let annotation_text_displayer = this.annotation_text_displayer; + $control.onmousemove = function (ev) { + let point = getRelativePointForEvent(ev, $page, -1); + + annotation_text_displayer.setDisplayNodeParent($page[0]); + annotation_text_displayer.displayCollection( + [annotation_text], + point.x * 100, + point.y * 100, + "%" + ); + }; + + $control.onmouseleave = function () { + annotation_text_displayer.hide(); + }; + + this.annotationControls[annotation_id] = $control; + + let $page = $(`.page[data-page-number=${range.page}]`); + $page.append($control); + }; + + /** + * The following two functions are used to keep track of the orientation of + * the PDF so we know how to render the annotations. + */ + rotateClockwise90() { + this.hide_selection_box(); + this.angle += 90; + if (this.angle === 360) this.angle = 0; + } + + resetAngle() { + this.angle = 0; + } + + /** + * Set event handlers for PDF annotations. + */ + bindPageEvents() { + let $pages = $(".page"); + let selectionBoxActive = false; // Is the selection box in use + + // Start of click + let start = { + x: 0, + y: 0, + }; + + // Helper: Start selection box + const startSelection = (point, $target) => { + this.setSelectionBox($target, { + x: point.x, + y: point.y, + width: 0, + height: 0, + visible: true, + }); + + start = point; + selectionBoxActive = true; + }; + + // Helper: Update selection box dimensions + const updateSelection = (point, $target) => { + if (!selectionBoxActive) { + return; + } + + this.setSelectionBox($target, { + x: Math.min(start.x, point.x), + y: Math.min(start.y, point.y), + width: Math.abs(start.x - point.x), + height: Math.abs(start.y - point.y), + }); + }; + + // Helper: End selection box + const endSelection = () => { + let size = this.selectionBoxSize(); + + // If the box is REALLY small then hide it + if (size.width < HIDE_BOX_THRESHOLD && size.height < HIDE_BOX_THRESHOLD) { + this.hide_selection_box(); + } + + selectionBoxActive = false; + }; + + // Mouse event handlers + $pages.mousedown(ev => { + if (ev.which !== 1 && ev.target.id === "sel_box") { + return; + } + + let point = getRelativePointForEvent(ev); + startSelection(point, $(ev.delegateTarget)); + }); + + $pages.mousemove(ev => { + let point = getRelativePointForEvent(ev); + updateSelection(point, $(ev.delegateTarget)); + }); + + $pages.mouseup(() => { + endSelection(); + }); + + // Touch event handlers + $pages.on("touchstart", ev => { + // Prevent default to avoid scrolling while annotating + ev.preventDefault(); + + let touch = ev.originalEvent.touches[0]; + let point = getRelativePointForEvent(touch, ev.delegateTarget, undefined); + startSelection(point, $(ev.delegateTarget)); + }); + + $pages.on("touchmove", ev => { + // Prevent default to avoid scrolling while annotating + ev.preventDefault(); + + let touch = ev.originalEvent.touches[0]; + let point = getRelativePointForEvent(touch, ev.delegateTarget, undefined); + updateSelection(point, $(ev.delegateTarget)); + }); + + $pages.on("touchend", () => { + endSelection(); + }); + } +} + +/** + * Returns the selection point in percentage units for a mouse or touch event. + * + * @param {Event|Touch} eventOrTouch The event or touch object. + * @param {String|DOMNode|jQuery} relativeTo The element to calculate the offset for. + * @param {number} mouseOffset Custom mouse offset value. + * @return {{x: number, y:number}} The relative point in the element the event occurred in. + */ +function getRelativePointForEvent(eventOrTouch, relativeTo, mouseOffset) { + let $elem = relativeTo ? $(relativeTo) : $(eventOrTouch.delegateTarget); + let offset = $elem.offset(); + + let width = $elem.width(); + let height = $elem.height(); + + let x = eventOrTouch.pageX - offset.left - (mouseOffset || MOUSE_OFFSET); + let y = eventOrTouch.pageY - offset.top - (mouseOffset || MOUSE_OFFSET); + + return { + x: 1 - (width - x) / width, + y: 1 - (height - y) / height, + }; +} + +/** + * Returns the rotated coordinates of the annotation after applying + * the rotation specified by angle. + * + * @param {{x1: int, y1: int, x2: int, y2: int, page: int}} coords + * @param {number} angle + */ +function getRotatedCoords(coords, angle) { + let newCoords = { + x1: coords.x1, + x2: coords.x2, + y1: coords.y1, + y2: coords.y2, + }; + + switch (angle) { + case 90: + newCoords.x1 = COORDINATE_MULTIPLIER - coords.y2; + newCoords.x2 = COORDINATE_MULTIPLIER - coords.y1; + newCoords.y1 = coords.x1; + newCoords.y2 = coords.x2; + break; + case 180: + newCoords.x1 = COORDINATE_MULTIPLIER - coords.x2; + newCoords.x2 = COORDINATE_MULTIPLIER - coords.x1; + newCoords.y1 = COORDINATE_MULTIPLIER - coords.y2; + newCoords.y2 = COORDINATE_MULTIPLIER - coords.y1; + break; + case 270: + newCoords.x1 = coords.y1; + newCoords.x2 = coords.y2; + newCoords.y1 = COORDINATE_MULTIPLIER - coords.x2; + newCoords.y2 = COORDINATE_MULTIPLIER - coords.x1; + break; + } + return newCoords; +} diff --git a/app/assets/javascripts/Annotations/source_code_line.js b/app/javascript/common/annotations/source_code_line.js similarity index 95% rename from app/assets/javascripts/Annotations/source_code_line.js rename to app/javascript/common/annotations/source_code_line.js index bbfb07fb8e..76b3ccffd0 100755 --- a/app/assets/javascripts/Annotations/source_code_line.js +++ b/app/javascript/common/annotations/source_code_line.js @@ -14,7 +14,7 @@ to enable unglowing with overlapping annotations. */ -class SourceCodeLine { +export class SourceCodeLine { constructor(line_node) { // line_node is the DOM element that holds a line of source code this.line_node = line_node; @@ -87,9 +87,9 @@ class SourceCodeLine { newGlowDepth = (parseInt(glowDepth, 10) + 1).toString(); } parent.setAttribute("data-annotationDepth", newGlowDepth); - parent.addClass("source-code-glowing-" + newGlowDepth); + parent.classList.add("source-code-glowing-" + newGlowDepth); if (is_remark) { - parent.addClass("remark"); + parent.classList.add("remark"); } parent.addEventListener("mouseover", hoverOnFunction); parent.addEventListener("mouseout", hoverOffFunction); @@ -131,7 +131,7 @@ class SourceCodeLine { startNode.textContent = startNode.textContent.substr(startNodeOffset); // Maintain events - if (startSpanPlain.hasClass("source-code-glowing-1")) { + if (startSpanPlain.classList.contains("source-code-glowing-1")) { startSpanPlain.addEventListener("mouseover", hoverOnFunction); startSpanPlain.addEventListener("mouseout", hoverOffFunction); } @@ -196,9 +196,9 @@ class SourceCodeLine { } spanGlow.setAttribute("data-annotationDepth", newGlowDepth); spanGlow.setAttribute("data-annotationID" + annotationId, annotationId); - spanGlow.addClass("source-code-glowing-" + newGlowDepth); + spanGlow.classList.add("source-code-glowing-" + newGlowDepth); if (is_remark) { - spanGlow.addClass("remark"); + spanGlow.classList.add("remark"); } spanGlow.addEventListener("mouseover", hoverOnFunction); spanGlow.addEventListener("mouseout", hoverOffFunction); @@ -233,7 +233,7 @@ class SourceCodeLine { let glowDepth = parseInt(parent.getAttribute("data-annotationDepth"), 10); parent.setAttribute("data-annotationDepth", (glowDepth - 1).toString()); - parent.removeClass("source-code-glowing-" + glowDepth); + parent.classList.remove("source-code-glowing-" + glowDepth); // Remove mouse listeners if no longer glowing if (glowDepth === 1) { diff --git a/app/assets/javascripts/Annotations/text_annotation_manager.js b/app/javascript/common/annotations/text_annotation_manager.js similarity index 96% rename from app/assets/javascripts/Annotations/text_annotation_manager.js rename to app/javascript/common/annotations/text_annotation_manager.js index 2a5dc6101d..b37fe57d75 100644 --- a/app/assets/javascripts/Annotations/text_annotation_manager.js +++ b/app/javascript/common/annotations/text_annotation_manager.js @@ -1,8 +1,11 @@ +import {AbstractAnnotationManager} from "./annotation_manager"; +import {SourceCodeLine} from "./source_code_line"; + /** - * AnnotationManager subclass for plaintext files. Its constructor is given a list of DOM elements + * AbstractAnnotationManager subclass for plaintext files. Its constructor is given a list of DOM elements * (one for each line of text in the file), that have been transformed through syntax highlighting. */ -class TextAnnotationManager extends AnnotationManager { +export class TextAnnotationManager extends AbstractAnnotationManager { constructor(source_nodes) { super(); diff --git a/app/javascript/common/ocr_suggestions.js b/app/javascript/common/ocr_suggestions.js new file mode 100644 index 0000000000..c4529e60b9 --- /dev/null +++ b/app/javascript/common/ocr_suggestions.js @@ -0,0 +1,70 @@ +/** + * OCR Suggestions Module + * Handles display and interaction with OCR match data and student suggestions + * Used in the assign_scans view for exam template processing + */ + +export function updateOcrSuggestions(ocrMatch, suggestions = []) { + const container = $("#ocr_suggestions"); + container.empty(); + + if (!ocrMatch) { + container.hide(); + return; + } + + container.show(); + + // internationalization + const noId = I18n.t("exam_templates.assign_scans.no_id"); + const idNumber = I18n.t("activerecord.attributes.user.id_number"); + const userName = I18n.t("activerecord.attributes.user.user_name"); + const suggestedStudents = I18n.t("exam_templates.assign_scans.suggested_students"); + const noSimilarStudents = I18n.t("exam_templates.assign_scans.no_similar_students"); + + const ocrDisplay = $(""); + // Display the parsed OCR value + const parsedValue = ocrMatch.parsed_value; + const fieldType = ocrMatch.field_type === "id_number" ? idNumber : userName; + const ocrDetected = I18n.t("exam_templates.assign_scans.ocr_detected", {field_type: fieldType}); + + ocrDisplay.append(`${ocrDetected}`); + const codeElem = $("").text(parsedValue); + ocrDisplay.append(codeElem); + container.append(ocrDisplay); + + if (suggestions.length == 0) { + return container.append(`${noSimilarStudents}`); + } + + // Display suggestions if available + container.append(`${suggestedStudents}`); + const list = $(''); + + suggestions.forEach(function (suggestion) { + const similarity = suggestion.similarity; + const item = $(''); + const content = $(""); + + // Use .text() to safely insert user-supplied data and prevent XSS + const nameElem = $("").text(suggestion.display_name); + const infoText = `${suggestion.id_number || noId} | ${suggestion.user_name}`; + const infoElem = $('').text(infoText); + + content.append(nameElem); + content.append(` (${similarity}%)`); + content.append(""); + content.append(infoElem); + + content.on("click", function () { + $("#student_id").val(suggestion.id); + $("#names").val(suggestion.display_name); + $("#names").focus(); + }); + + item.append(content); + list.append(item); + }); + + container.append(list); +} diff --git a/app/javascript/common/theme_colors.js b/app/javascript/common/theme_colors.js index 6cf2cc9ea4..12716d4145 100644 --- a/app/javascript/common/theme_colors.js +++ b/app/javascript/common/theme_colors.js @@ -65,5 +65,5 @@ export function set_theme(theme) { document.documentElement.style.setProperty("--" + color, themes.light[color]); }); } - document.body.addClass("color-" + theme); + document.body.classList.add("color-" + theme); } diff --git a/app/javascript/pdf.worker.js b/app/javascript/pdf.worker.js deleted file mode 100644 index 51a86c93e3..0000000000 --- a/app/javascript/pdf.worker.js +++ /dev/null @@ -1 +0,0 @@ -import "pdfjs-dist/build/pdf.worker.entry"; diff --git a/app/jobs/auto_match_job.rb b/app/jobs/auto_match_job.rb index 50b540b53c..2d474557da 100644 --- a/app/jobs/auto_match_job.rb +++ b/app/jobs/auto_match_job.rb @@ -50,6 +50,16 @@ def perform(groupings, exam_template) next unless status.success? && parsed.length == 1 student = match_student(parsed[0], exam_template) + + # Store OCR match result in Redis for later suggestions + OcrMatchService.store_match( + grouping.id, + parsed[0], + exam_template.cover_fields, + matched: !student.nil?, + student_id: student&.id + ) + unless student.nil? StudentMembership.find_or_create_by(role: student, grouping: grouping, @@ -67,7 +77,7 @@ def perform(groupings, exam_template) def match_student(parsed, exam_template) case exam_template.cover_fields when 'id_number' - Student.joins(:user).find_by('user.id_number': parsed) + Student.joins(:user).find_by('users.id_number': parsed) when 'user_name' Student.joins(:user).find_by(User.arel_table[:user_name].matches(parsed)) end diff --git a/app/jobs/lti_sync_job.rb b/app/jobs/lti_sync_job.rb index f768a9bbfc..3787d9cee2 100644 --- a/app/jobs/lti_sync_job.rb +++ b/app/jobs/lti_sync_job.rb @@ -19,7 +19,7 @@ def perform(lti_deployments, assessment, can_create_users: false, can_create_rol can_create_users: can_create_users, can_create_roles: can_create_roles) if roster_error status.update(warning_message: [status[:warning_message], I18n.t('lti.roster_sync_errors')].compact - .join("\n")) + .join("\n")) end grade_sync(deployment, assessment) end diff --git a/app/lib/ocr_match_service.rb b/app/lib/ocr_match_service.rb new file mode 100644 index 0000000000..ce90db0df0 --- /dev/null +++ b/app/lib/ocr_match_service.rb @@ -0,0 +1,113 @@ +# Service for storing and retrieving OCR match data from Redis. +# Used to persist OCR parsing results for scanned exam assignments, +# enabling suggestions for manual student assignment. +class OcrMatchService + # Time-to-live for OCR match data in Redis (30 days) + TTL = 30.days.to_i + + class << self + # Store an OCR match result in Redis + def store_match(grouping_id, parsed_value, field_type, matched: false, student_id: nil) + data = { + parsed_value: parsed_value, + field_type: field_type, + timestamp: Time.current.iso8601, + matched: matched, + matched_student_id: student_id + } + + redis.setex(match_key(grouping_id), TTL, data.to_json) + + # Add to unmatched set if not auto-matched + unless matched + redis.sadd(unmatched_set_key, grouping_id) + redis.expire(unmatched_set_key, TTL) + end + end + + # Retrieve stored OCR match data for a grouping + def get_match(grouping_id) + data = redis.get(match_key(grouping_id)) + data ? JSON.parse(data, symbolize_names: true) : nil + end + + # Get student suggestions based on stored OCR match using fuzzy matching + # Only considers students not already assigned to a grouping for this assignment + # Returns students meeting the similarity threshold (default 80%), limited to top matches (default 5) + def get_suggestions(grouping_id, course_id, threshold: 0.8, limit: 5) + match_data = get_match(grouping_id) + return [] if match_data.nil? + + grouping = Grouping.find(grouping_id) + assignment = grouping.assignment + course = Course.find(course_id) + + # Get students who are not assigned to any grouping for this assignment + assigned_student_ids = assignment.groupings + .joins(:student_memberships) + .pluck('memberships.role_id') + students = course.students.includes(:user).where.not(id: assigned_student_ids) + + # Calculate similarity scores for each student + suggestions = students.filter_map do |student| + value_to_match = student_match_value(student, match_data[:field_type]) + next if value_to_match.blank? + + similarity = string_similarity(match_data[:parsed_value], value_to_match) + next if similarity < threshold + + { student: student, similarity: similarity } + end + + # Return top matches by similarity (highest first) + suggestions.max_by(limit) { |s| s[:similarity] } + end + + # Clear OCR match data after manual assignment + def clear_match(grouping_id) + redis.del(match_key(grouping_id)) + redis.srem(unmatched_set_key, grouping_id) + end + + private + + def match_key(grouping_id) + "ocr_matches:grouping:#{grouping_id}" + end + + def unmatched_set_key + 'ocr_matches:unmatched' + end + + def redis + Redis::Namespace.new(Rails.root.to_s, redis: Resque.redis) + end + + # Get the value to match against based on field type + def student_match_value(student, field_type) + case field_type + when 'id_number' then student.user.id_number + when 'user_name' then student.user.user_name + end + end + + # Calculate similarity between two strings using Levenshtein distance + # Returns a score between 0 and 1, where 1 is identical + def string_similarity(str1, str2) + return 1.0 if str1 == str2 + return 0.0 if str1.blank? || str2.blank? + + # Normalize strings for case-insensitive comparison + s1 = str1.to_s.downcase.strip + s2 = str2.to_s.downcase.strip + return 1.0 if s1 == s2 + + # Use Ruby's built-in Levenshtein distance calculation + distance = DidYouMean::Levenshtein.distance(s1, s2) + max_length = [s1.length, s2.length].max + return 0.0 if max_length.zero? + + 1.0 - (distance.to_f / max_length) + end + end +end diff --git a/app/models/admin_role.rb b/app/models/admin_role.rb index 18ff61a5a2..eea6ae315a 100644 --- a/app/models/admin_role.rb +++ b/app/models/admin_role.rb @@ -1,9 +1,40 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: roles +# +# id :bigint not null, primary key +# grace_credits :integer default(0), not null +# hidden :boolean default(FALSE), not null +# receives_invite_emails :boolean default(FALSE), not null +# receives_results_emails :boolean default(FALSE), not null +# type :string not null +# created_at :datetime not null +# updated_at :datetime not null +# course_id :bigint not null +# section_id :bigint +# user_id :bigint not null +# +# Indexes +# +# index_roles_on_course_id (course_id) +# index_roles_on_section_id (section_id) +# index_roles_on_user_id (user_id) +# index_roles_on_user_id_and_course_id (user_id,course_id) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# fk_rails_... (section_id => sections.id) +# fk_rails_... (user_id => users.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class AdminRole < Instructor validate :associated_user_is_an_admin def associated_user_is_an_admin unless self.user.nil? || self.user.admin_user? - errors.add(:base, 'only admin users can be assigned the admin role') + errors.add(:base, :must_be_admin) end end end diff --git a/app/models/admin_user.rb b/app/models/admin_user.rb index 6366835e75..9c10b19489 100644 --- a/app/models/admin_user.rb +++ b/app/models/admin_user.rb @@ -1,3 +1,29 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: users +# +# id :integer not null, primary key +# api_key :string +# display_name :string not null +# email :string +# first_name :string +# id_number :string +# last_name :string +# locale :string default("en"), not null +# theme :integer default("light"), not null +# time_zone :string not null +# type :string +# user_name :string not null +# created_at :datetime +# updated_at :datetime +# +# Indexes +# +# index_users_on_api_key (api_key) UNIQUE +# index_users_on_user_name (user_name) UNIQUE +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class AdminUser < User ADMIN_USERNAME = '.admin'.freeze diff --git a/app/models/annotation.rb b/app/models/annotation.rb index 22670ee400..4ea95528bb 100644 --- a/app/models/annotation.rb +++ b/app/models/annotation.rb @@ -1,3 +1,42 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: annotations +# +# id :integer not null, primary key +# annotation_number :integer +# column_end :integer +# column_start :integer +# creator_type :string +# end_node :string +# end_offset :integer +# is_remark :boolean default(FALSE), not null +# line_end :integer +# line_start :integer +# page :integer +# start_node :string +# start_offset :integer +# type :string +# x1 :integer +# x2 :integer +# y1 :integer +# y2 :integer +# annotation_text_id :integer +# creator_id :integer +# result_id :integer +# submission_file_id :integer +# +# Indexes +# +# index_annotations_on_creator_type_and_creator_id (creator_type,creator_id) +# index_annotations_on_submission_file_id (submission_file_id) +# +# Foreign Keys +# +# fk_annotations_annotation_texts (annotation_text_id => annotation_texts.id) +# fk_annotations_submission_files (submission_file_id => submission_files.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Annotation < ApplicationRecord belongs_to :submission_file belongs_to :annotation_text @@ -71,7 +110,7 @@ def check_if_released return if result.is_a_review? && !result.released_to_students - errors.add(:base, 'Cannot create/destroy annotation once results are released.') + errors.add(:base, :results_already_released) throw(:abort) end end diff --git a/app/models/annotation_category.rb b/app/models/annotation_category.rb index e6743716a9..fad4aa8aa0 100644 --- a/app/models/annotation_category.rb +++ b/app/models/annotation_category.rb @@ -1,3 +1,27 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: annotation_categories +# +# id :integer not null, primary key +# annotation_category_name :text +# position :integer +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint not null +# flexible_criterion_id :bigint +# +# Indexes +# +# index_annotation_categories_on_assessment_id (assessment_id) +# index_annotation_categories_on_flexible_criterion_id (flexible_criterion_id) +# +# Foreign Keys +# +# fk_annotation_categories_assignments (assessment_id => assessments.id) ON DELETE => cascade +# fk_rails_... (flexible_criterion_id => criteria.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class AnnotationCategory < ApplicationRecord before_update :check_if_marks_released, if: ->(c) { changes_to_save.key?('flexible_criterion_id') && c.annotation_texts.exists? @@ -106,14 +130,14 @@ def deductive_annotations_exist? def delete_allowed? if marks_released? && deductive_annotations_exist? - errors.add(:base, 'Cannot delete annotation category once deductions have been applied') + errors.add(:base, :cannot_delete_annotation) throw(:abort) end end def check_if_marks_released if marks_released? - errors.add(:base, I18n.t('activerecord.errors.models.annotation_category.cannot_update_flex')) + errors.add(:base, :cannot_update_flex) throw(:abort) end end diff --git a/app/models/annotation_text.rb b/app/models/annotation_text.rb index 0be1e15f31..743bd194f0 100644 --- a/app/models/annotation_text.rb +++ b/app/models/annotation_text.rb @@ -1,3 +1,26 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: annotation_texts +# +# id :integer not null, primary key +# content :text +# deduction :float +# created_at :datetime +# updated_at :datetime +# annotation_category_id :integer +# creator_id :integer +# last_editor_id :integer +# +# Indexes +# +# index_annotation_texts_on_annotation_category_id (annotation_category_id) +# +# Foreign Keys +# +# fk_annotation_labels_annotation_categories (annotation_category_id => annotation_categories.id) ON DELETE => cascade +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class AnnotationText < ApplicationRecord belongs_to :creator, class_name: 'Role' belongs_to :last_editor, class_name: 'Role', optional: true @@ -47,7 +70,7 @@ def check_if_released Result.where(submission_id: annotation_results.pluck('submissions.id')) .where.not(remark_request_submitted_at: nil) .empty? - errors.add(:base, 'Cannot update/destroy annotation_text once results are released.') + errors.add(:base, :results_already_released) throw(:abort) end diff --git a/app/models/application_record.rb b/app/models/application_record.rb index 47c850934d..b9a05eea14 100644 --- a/app/models/application_record.rb +++ b/app/models/application_record.rb @@ -12,7 +12,7 @@ def courses_should_match course_ids = associations.filter_map { |a| a.is_a?(Course) ? a.id : a&.course&.id } if course_ids.to_set.length > 1 names = associations.compact.map { |a| a.class.name.underscore }.join(', ') - errors.add(:base, "#{names} must all belong to the same course") + errors.add(:base, :courses_should_match, names: names) end end end diff --git a/app/models/assessment.rb b/app/models/assessment.rb index 97c6369f26..d905b4af76 100644 --- a/app/models/assessment.rb +++ b/app/models/assessment.rb @@ -1,5 +1,36 @@ # Assessment is an abstract model used for single-table-inheritance with Assignment and GradeEntryForm # It can represent any form of graded work (assignment, test, lab, exam...etc.) +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: assessments +# +# id :integer not null, primary key +# description :string not null +# due_date :datetime +# is_hidden :boolean default(TRUE), not null +# message :text default(""), not null +# short_identifier :string not null +# show_total :boolean default(FALSE), not null +# type :string not null +# visible_on :datetime +# visible_until :datetime +# created_at :datetime not null +# updated_at :datetime not null +# course_id :bigint not null +# parent_assessment_id :integer +# +# Indexes +# +# index_assessments_on_course_id (course_id) +# index_assessments_on_short_identifier_and_course_id (short_identifier,course_id) UNIQUE +# index_assessments_on_type_and_short_identifier (type,short_identifier) +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Assessment < ApplicationRecord # Constant for scheduled visibility option used in forms and controller SCHEDULED_VISIBILITY = 'scheduled'.freeze @@ -19,6 +50,8 @@ class Assessment < ApplicationRecord has_many :lti_line_items, dependent: :destroy + after_update_commit :sync_lti_line_items, if: :lti_sync_needed? + # Call custom validator in order to validate the :due_date attribute # date: true maps to DateValidator (custom_name: true maps to CustomNameValidator) # Look in lib/validators/* for more info @@ -40,14 +73,14 @@ def self.type def short_identifier_unchanged return unless short_identifier_changed? - errors.add(:short_id_change, 'short identifier should not be changed once an assessment has been created') + errors.add(:short_identifier, :short_identifier_changed) false end def visible_dates_are_valid return if visible_on.nil? || visible_until.nil? if visible_on >= visible_until - errors.add(:visible_until, 'must be after visible_on') + errors.add(:visible_until, :before_visible_on) end end @@ -56,6 +89,14 @@ def upcoming(*) self.due_date > Time.current end + def currently_hidden? + return true if is_hidden + return true if visible_on.present? && Time.current < visible_on + return true if visible_until.present? && Time.current > visible_until + + false + end + # Returns grade distribution histogram bins of the grades for this assessment, using the grades in # self.completed_result_marks. def grade_distribution_array(intervals = 20) @@ -130,4 +171,18 @@ def results_standard_deviation DescriptiveStatistics.standard_deviation(marks) end end + + private + + # Re-pushes line item metadata to any LMS that already has this assessment linked, + # so changes in MarkUs (notably due_date) propagate without manual re-trigger. + def sync_lti_line_items + deployment_ids = lti_line_items.distinct.pluck(:lti_deployment_id) + LtiLineItemJob.perform_later(deployment_ids, self) + end + + def lti_sync_needed? + return false unless lti_line_items.exists? + saved_change_to_due_date? || saved_change_to_description? + end end diff --git a/app/models/assessment_section_properties.rb b/app/models/assessment_section_properties.rb index 6006ea7f86..b576292bf7 100644 --- a/app/models/assessment_section_properties.rb +++ b/app/models/assessment_section_properties.rb @@ -1,4 +1,19 @@ # Represents properties of an assessment specific to a given section. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: assessment_section_properties +# +# id :integer not null, primary key +# due_date :datetime +# is_hidden :boolean +# start_time :datetime +# visible_on :datetime +# visible_until :datetime +# assessment_id :bigint +# section_id :integer +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class AssessmentSectionProperties < ApplicationRecord belongs_to :section belongs_to :assessment, inverse_of: :assessment_section_properties @@ -22,7 +37,7 @@ def self.due_date_for(section, assignment) def visible_dates_are_valid return if visible_on.nil? || visible_until.nil? if visible_on >= visible_until - errors.add(:visible_until, 'must be after visible_on') + errors.add(:visible_until, :before_visible_on) end end end diff --git a/app/models/assignment.rb b/app/models/assignment.rb index 7e475777e4..cb420174e9 100644 --- a/app/models/assignment.rb +++ b/app/models/assignment.rb @@ -1,3 +1,34 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: assessments +# +# id :integer not null, primary key +# description :string not null +# due_date :datetime +# is_hidden :boolean default(TRUE), not null +# message :text default(""), not null +# short_identifier :string not null +# show_total :boolean default(FALSE), not null +# type :string not null +# visible_on :datetime +# visible_until :datetime +# created_at :datetime not null +# updated_at :datetime not null +# course_id :bigint not null +# parent_assessment_id :integer +# +# Indexes +# +# index_assessments_on_course_id (course_id) +# index_assessments_on_short_identifier_and_course_id (short_identifier,course_id) UNIQUE +# index_assessments_on_type_and_short_identifier (type,short_identifier) +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective require 'csv' # Represents an assignment where students submit work to be graded @@ -1341,8 +1372,8 @@ def current_submission_data(current_role) groupings = self.groupings elsif current_role.ta? groupings = self.groupings.where(id: self.groupings.joins(:memberships) - .where('memberships.role_id': current_role.id) - .select(:'groupings.id')) + .where('memberships.role_id': current_role.id) + .select(:'groupings.id')) else return [] end diff --git a/app/models/assignment_file.rb b/app/models/assignment_file.rb index ee1ae0cd3e..59032ad66a 100644 --- a/app/models/assignment_file.rb +++ b/app/models/assignment_file.rb @@ -1,3 +1,24 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: assignment_files +# +# id :integer not null, primary key +# filename :string not null +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint +# +# Indexes +# +# index_assignment_files_on_assessment_id (assessment_id) +# index_assignment_files_on_assessment_id_and_filename (assessment_id,filename) UNIQUE +# +# Foreign Keys +# +# fk_assignment_files_assignments (assessment_id => assessments.id) ON DELETE => cascade +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class AssignmentFile < ApplicationRecord belongs_to :assignment, foreign_key: :assessment_id, inverse_of: :assignment_files has_many :criteria_assignment_files_joins, dependent: :destroy diff --git a/app/models/assignment_properties.rb b/app/models/assignment_properties.rb index b932619578..f1e31dbd97 100644 --- a/app/models/assignment_properties.rb +++ b/app/models/assignment_properties.rb @@ -1,4 +1,65 @@ # Internal model used to link assignment attributes with the assignment STI model +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: assignment_properties +# +# id :integer not null, primary key +# allow_remarks :boolean default(FALSE), not null +# allow_web_submits :boolean default(TRUE), not null +# anonymize_groups :boolean default(FALSE), not null +# api_submit :boolean default(FALSE), not null +# assign_graders_to_criteria :boolean default(FALSE), not null +# autotest_settings :json +# display_grader_names_to_students :boolean default(FALSE), not null +# display_median_to_students :boolean default(FALSE), not null +# duration :interval +# enable_student_tests :boolean default(FALSE), not null +# enable_test :boolean default(FALSE), not null +# group_max :integer default(1), not null +# group_min :integer default(1), not null +# group_name_autogenerated :boolean default(TRUE), not null +# has_peer_review :boolean default(FALSE), not null +# hide_unassigned_criteria :boolean default(FALSE), not null +# is_timed :boolean default(FALSE), not null +# non_regenerating_tokens :boolean default(FALSE), not null +# only_required_files :boolean default(FALSE), not null +# release_with_urls :boolean default(FALSE), not null +# remark_due_date :datetime +# remark_message :text +# repository_folder :string not null +# scanned_exam :boolean default(FALSE), not null +# section_due_dates_type :boolean default(FALSE), not null +# section_groups_only :boolean default(FALSE), not null +# start_time :datetime +# starter_file_type :string default("simple"), not null +# starter_file_updated_at :datetime +# starter_files_after_due :boolean default(TRUE), not null +# student_form_groups :boolean default(FALSE), not null +# token_end_date :datetime +# token_period :float +# token_start_date :datetime +# tokens_per_period :integer default(0), not null +# unlimited_tokens :boolean default(FALSE), not null +# url_submit :boolean default(FALSE), not null +# vcs_submit :boolean default(FALSE), not null +# created_at :datetime not null +# updated_at :datetime not null +# assessment_id :bigint +# default_starter_file_group_id :bigint +# remote_autotest_settings_id :integer +# +# Indexes +# +# index_assignment_properties_on_assessment_id (assessment_id) UNIQUE +# index_assignment_properties_on_default_starter_file_group_id (default_starter_file_group_id) +# +# Foreign Keys +# +# fk_rails_... (assessment_id => assessments.id) ON DELETE => cascade +# fk_rails_... (default_starter_file_group_id => starter_file_groups.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class AssignmentProperties < ApplicationRecord belongs_to :assignment, inverse_of: :assignment_properties, dependent: :destroy, foreign_key: :assessment_id @@ -100,13 +161,13 @@ def adjusted_duration def minimum_number_of_groups return unless group_max && group_min && group_max < group_min - errors.add(:group_max, 'must be greater than the minimum number of groups') + errors.add(:group_max, :less_than_group_min) false end def repository_folder_unchanged return unless repository_folder_changed? - errors.add(:repo_folder_change, 'repository folder should not be changed once an assignment has been created') + errors.add(:repo_folder_change, :repository_folder_unchanged) false end @@ -116,15 +177,13 @@ def repository_folder_unchanged # those values are checked by other validations and so should not be checked twice. def start_before_due return if start_time.nil? || duration.nil? - msg = I18n.t('activerecord.errors.models.assignment_properties.attributes.start_time.before_due_date') - errors.add(:start_time, msg) if start_time > assignment.due_date + errors.add(:start_time, :before_due_date) if start_time > assignment.due_date end # Add an error if the is_timed and scanned_exam attributes for this assignment # are both true. def not_timed_and_scanned - msg = I18n.t('activerecord.errors.models.assignment_properties.attributes.is_timed.not_scanned') - errors.add(:base, msg) if is_timed && scanned_exam + errors.add(:is_timed, :not_scanned) if is_timed && scanned_exam end # Ensure remote_autotest_settings_id is unique for a given autotester @@ -133,7 +192,6 @@ def remote_autotest_settings_id_uniqueness remote_autotest_settings_id: self.remote_autotest_settings_id, course: { autotest_setting_id: self.assignment.course.autotest_setting_id } ).where.not(id: self.id).exists? - msg = I18n.t('activerecord.errors.models.assignment_properties.attributes.remote_autotest_settings_id.taken') - errors.add(:remote_autotest_settings_id, msg) if remote_autotest_settings_id_is_taken + errors.add(:remote_autotest_settings_id, :taken) if remote_autotest_settings_id_is_taken end end diff --git a/app/models/autotest_setting.rb b/app/models/autotest_setting.rb index 53a50a0f43..0e99fd9da5 100644 --- a/app/models/autotest_setting.rb +++ b/app/models/autotest_setting.rb @@ -1,3 +1,14 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: autotest_settings +# +# id :bigint not null, primary key +# api_key :string not null +# schema :string not null +# url :string not null +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class AutotestSetting < ApplicationRecord include AutomatedTestsHelper::AutotestApi diff --git a/app/models/autotest_user.rb b/app/models/autotest_user.rb index 790024c88d..fdf87ffae5 100644 --- a/app/models/autotest_user.rb +++ b/app/models/autotest_user.rb @@ -1,4 +1,30 @@ # Model for Autotest user +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: users +# +# id :integer not null, primary key +# api_key :string +# display_name :string not null +# email :string +# first_name :string +# id_number :string +# last_name :string +# locale :string default("en"), not null +# theme :integer default("light"), not null +# time_zone :string not null +# type :string +# user_name :string not null +# created_at :datetime +# updated_at :datetime +# +# Indexes +# +# index_users_on_api_key (api_key) UNIQUE +# index_users_on_user_name (user_name) UNIQUE +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class AutotestUser < User include AutomatedTestsHelper::AutotestApi diff --git a/app/models/checkbox_criterion.rb b/app/models/checkbox_criterion.rb index 770dfe866a..b6b7d5a6af 100644 --- a/app/models/checkbox_criterion.rb +++ b/app/models/checkbox_criterion.rb @@ -1,3 +1,31 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: criteria +# +# id :bigint not null, primary key +# assigned_groups_count :integer default(0), not null +# bonus :boolean default(FALSE), not null +# description :text default(""), not null +# max_mark :decimal(10, 1) not null +# name :string not null +# peer_visible :boolean default(FALSE), not null +# position :integer not null +# ta_visible :boolean default(TRUE), not null +# type :string not null +# created_at :datetime not null +# updated_at :datetime not null +# assessment_id :bigint not null +# +# Indexes +# +# index_criteria_on_assessment_id (assessment_id) +# +# Foreign Keys +# +# fk_rails_... (assessment_id => assessments.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class CheckboxCriterion < Criterion DEFAULT_MAX_MARK = 1 diff --git a/app/models/course.rb b/app/models/course.rb index 4996b8aa16..a1e89ed7b5 100644 --- a/app/models/course.rb +++ b/app/models/course.rb @@ -1,4 +1,30 @@ # Class describing a course +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: courses +# +# id :bigint not null, primary key +# display_name :string not null +# end_at :datetime +# is_hidden :boolean default(TRUE), not null +# max_file_size :bigint default(5000000), not null +# name :string not null +# start_at :datetime +# created_at :datetime not null +# updated_at :datetime not null +# autotest_setting_id :bigint +# +# Indexes +# +# index_courses_on_autotest_setting_id (autotest_setting_id) +# index_courses_on_name (name) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (autotest_setting_id => autotest_settings.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Course < ApplicationRecord has_many :assessments, inverse_of: :course, dependent: :destroy has_many :assignments @@ -176,7 +202,7 @@ def update_repo_permissions def start_at_before_or_equal_to_end_at return if start_at.nil? || end_at.nil? if start_at > end_at - errors.add(:start_at, 'must be before or equal to end date') + errors.add(:start_at, :after_end_date) end end end diff --git a/app/models/criteria_assignment_files_join.rb b/app/models/criteria_assignment_files_join.rb index a3fa354eaf..aabfe36798 100644 --- a/app/models/criteria_assignment_files_join.rb +++ b/app/models/criteria_assignment_files_join.rb @@ -1,3 +1,19 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: criteria_assignment_files_joins +# +# id :integer not null, primary key +# created_at :datetime +# updated_at :datetime +# assignment_file_id :integer not null +# criterion_id :integer not null +# +# Foreign Keys +# +# fk_rails_... (assignment_file_id => assignment_files.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class CriteriaAssignmentFilesJoin < ApplicationRecord belongs_to :criterion belongs_to :assignment_file diff --git a/app/models/criterion.rb b/app/models/criterion.rb index 4705e3c7e2..95c3761c59 100644 --- a/app/models/criterion.rb +++ b/app/models/criterion.rb @@ -1,5 +1,33 @@ # The abstract base class that defines common behavior for all types of # criterion. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: criteria +# +# id :bigint not null, primary key +# assigned_groups_count :integer default(0), not null +# bonus :boolean default(FALSE), not null +# description :text default(""), not null +# max_mark :decimal(10, 1) not null +# name :string not null +# peer_visible :boolean default(FALSE), not null +# position :integer not null +# ta_visible :boolean default(TRUE), not null +# type :string not null +# created_at :datetime not null +# updated_at :datetime not null +# assessment_id :bigint not null +# +# Indexes +# +# index_criteria_on_assessment_id (assessment_id) +# +# Foreign Keys +# +# fk_rails_... (assessment_id => assessments.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Criterion < ApplicationRecord belongs_to :assignment, foreign_key: :assessment_id, inverse_of: :criteria before_validation :update_assigned_groups_count @@ -161,7 +189,7 @@ def scale_marks def results_unreleased? return true if self.assignment&.released_marks.blank? - errors.add(:base, 'Cannot update criterion once results are released.') + errors.add(:base, :results_already_released) false end @@ -262,7 +290,7 @@ def visible? if ta_visible || peer_visible true else - errors.add(:base, I18n.t('activerecord.errors.models.criterion.visibility_error')) + errors.add(:base, :visibility_error) false end end diff --git a/app/models/criterion_ta_association.rb b/app/models/criterion_ta_association.rb index e19bb4d67a..1c0371b389 100644 --- a/app/models/criterion_ta_association.rb +++ b/app/models/criterion_ta_association.rb @@ -1,3 +1,21 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: criterion_ta_associations +# +# id :integer not null, primary key +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint +# criterion_id :integer +# ta_id :integer +# +# Indexes +# +# index_criterion_ta_associations_on_criterion_id (criterion_id) +# index_criterion_ta_associations_on_ta_id (ta_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class CriterionTaAssociation < ApplicationRecord belongs_to :ta validates_associated :ta diff --git a/app/models/end_user.rb b/app/models/end_user.rb index 009701f4f3..3c5d6ae32f 100644 --- a/app/models/end_user.rb +++ b/app/models/end_user.rb @@ -1,4 +1,30 @@ # Subclass of User meant for regular users +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: users +# +# id :integer not null, primary key +# api_key :string +# display_name :string not null +# email :string +# first_name :string +# id_number :string +# last_name :string +# locale :string default("en"), not null +# theme :integer default("light"), not null +# time_zone :string not null +# type :string +# user_name :string not null +# created_at :datetime +# updated_at :datetime +# +# Indexes +# +# index_users_on_api_key (api_key) UNIQUE +# index_users_on_user_name (user_name) UNIQUE +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class EndUser < User CSV_ORDER = ( Settings.end_user_csv_order || %w[user_name last_name first_name id_number email] diff --git a/app/models/exam_template.rb b/app/models/exam_template.rb index 1950a84c84..687ecd0836 100644 --- a/app/models/exam_template.rb +++ b/app/models/exam_template.rb @@ -1,3 +1,31 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: exam_templates +# +# id :integer not null, primary key +# automatic_parsing :boolean default(FALSE), not null +# cover_fields :string default(""), not null +# crop_height :decimal(, ) +# crop_width :decimal(, ) +# crop_x :decimal(, ) +# crop_y :decimal(, ) +# filename :string not null +# name :string not null +# num_pages :integer not null +# created_at :datetime not null +# updated_at :datetime not null +# assessment_id :bigint +# +# Indexes +# +# index_exam_templates_on_assessment_id (assessment_id) +# +# Foreign Keys +# +# fk_rails_... (assessment_id => assessments.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective require 'fileutils' class ExamTemplate < ApplicationRecord diff --git a/app/models/extension.rb b/app/models/extension.rb index b8946b2768..eb5a70cc86 100644 --- a/app/models/extension.rb +++ b/app/models/extension.rb @@ -1,3 +1,25 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: extensions +# +# id :bigint not null, primary key +# apply_penalty :boolean default(FALSE), not null +# note :string +# time_delta :interval not null +# created_at :datetime not null +# updated_at :datetime not null +# grouping_id :bigint not null +# +# Indexes +# +# index_extensions_on_grouping_id (grouping_id) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (grouping_id => groupings.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Extension < ApplicationRecord belongs_to :grouping diff --git a/app/models/extra_mark.rb b/app/models/extra_mark.rb index d6eb30591a..a336df17dd 100644 --- a/app/models/extra_mark.rb +++ b/app/models/extra_mark.rb @@ -1,3 +1,25 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: extra_marks +# +# id :integer not null, primary key +# description :string +# extra_mark :float +# unit :string +# created_at :datetime +# updated_at :datetime +# result_id :integer +# +# Indexes +# +# index_extra_marks_on_result_id (result_id) +# +# Foreign Keys +# +# fk_extra_marks_results (result_id => results.id) ON DELETE => cascade +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class ExtraMark < ApplicationRecord # When a mark is created, or updated, we need to make sure that that # Result that it belongs to has a marking_state of "partial". diff --git a/app/models/feedback_file.rb b/app/models/feedback_file.rb index 4eab809d54..2bce4ed71f 100644 --- a/app/models/feedback_file.rb +++ b/app/models/feedback_file.rb @@ -1,3 +1,28 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: feedback_files +# +# id :integer not null, primary key +# file_content :binary not null +# filename :string not null +# mime_type :string not null +# created_at :datetime not null +# updated_at :datetime not null +# submission_id :integer +# test_group_result_id :bigint +# +# Indexes +# +# index_feedback_files_on_submission_id (submission_id) +# index_feedback_files_on_test_group_result_id (test_group_result_id) +# +# Foreign Keys +# +# fk_rails_... (submission_id => submissions.id) +# fk_rails_... (test_group_result_id => test_group_results.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class FeedbackFile < ApplicationRecord belongs_to :submission, optional: true belongs_to :test_group_result, optional: true diff --git a/app/models/flexible_criterion.rb b/app/models/flexible_criterion.rb index 4e0177ed9f..7eb6b33ef5 100644 --- a/app/models/flexible_criterion.rb +++ b/app/models/flexible_criterion.rb @@ -1,4 +1,32 @@ # Represents a flexible criterion used to mark an assignment. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: criteria +# +# id :bigint not null, primary key +# assigned_groups_count :integer default(0), not null +# bonus :boolean default(FALSE), not null +# description :text default(""), not null +# max_mark :decimal(10, 1) not null +# name :string not null +# peer_visible :boolean default(FALSE), not null +# position :integer not null +# ta_visible :boolean default(TRUE), not null +# type :string not null +# created_at :datetime not null +# updated_at :datetime not null +# assessment_id :bigint not null +# +# Indexes +# +# index_criteria_on_assessment_id (assessment_id) +# +# Foreign Keys +# +# fk_rails_... (assessment_id => assessments.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class FlexibleCriterion < Criterion has_many :annotation_categories diff --git a/app/models/grace_period_deduction.rb b/app/models/grace_period_deduction.rb index 753bae9421..7ee1309dee 100644 --- a/app/models/grace_period_deduction.rb +++ b/app/models/grace_period_deduction.rb @@ -1,3 +1,19 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: grace_period_deductions +# +# id :integer not null, primary key +# deduction :integer +# created_at :datetime +# updated_at :datetime +# membership_id :integer +# +# Indexes +# +# index_grace_period_deductions_on_membership_id (membership_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class GracePeriodDeduction < ApplicationRecord belongs_to :membership, optional: true has_one :course, through: :membership diff --git a/app/models/grace_period_submission_rule.rb b/app/models/grace_period_submission_rule.rb index 614a98b749..7f141680af 100644 --- a/app/models/grace_period_submission_rule.rb +++ b/app/models/grace_period_submission_rule.rb @@ -1,3 +1,20 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: submission_rules +# +# id :integer not null, primary key +# penalty_type :string default("percentage") +# type :string default("NoLateSubmissionRule") +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint not null +# +# Indexes +# +# index_submission_rules_on_assessment_id (assessment_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class GracePeriodSubmissionRule < SubmissionRule # This message will be displayed to Students on viewing their file manager # after the due date has passed, but before the calculated collection date. diff --git a/app/models/grade.rb b/app/models/grade.rb index 1ef3ad3208..2b8ada04d7 100644 --- a/app/models/grade.rb +++ b/app/models/grade.rb @@ -1,4 +1,27 @@ # Grade represents an entry in a grade entry form. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: grades +# +# id :integer not null, primary key +# grade :float +# created_at :datetime +# updated_at :datetime +# grade_entry_item_id :integer +# grade_entry_student_id :integer +# last_updated_by_id :bigint +# +# Indexes +# +# index_grades_on_grade_entry_item_id_and_grade_entry_student_id (grade_entry_item_id,grade_entry_student_id) UNIQUE +# index_grades_on_last_updated_by_id (last_updated_by_id) +# +# Foreign Keys +# +# fk_rails_... (last_updated_by_id => roles.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Grade < ApplicationRecord belongs_to :grade_entry_item belongs_to :grade_entry_student @@ -11,6 +34,8 @@ class Grade < ApplicationRecord validates :grade, numericality: { allow_nil: true }, if: :bonus_grade? + belongs_to :last_updated_by, class_name: 'Role', optional: true + # Return true if the associated grade_entry_item is a bonus column. # If grade_entry_item is NIL or a non-bonus column, return false. def bonus_grade? diff --git a/app/models/grade_entry_form.rb b/app/models/grade_entry_form.rb index be1a230287..50bd643d2a 100644 --- a/app/models/grade_entry_form.rb +++ b/app/models/grade_entry_form.rb @@ -2,6 +2,37 @@ # A grade entry form has many columns which represent the questions and their total # marks (i.e. GradeEntryItems) and many rows which represent students and their # marks on each question (i.e. GradeEntryStudents). +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: assessments +# +# id :integer not null, primary key +# description :string not null +# due_date :datetime +# is_hidden :boolean default(TRUE), not null +# message :text default(""), not null +# short_identifier :string not null +# show_total :boolean default(FALSE), not null +# type :string not null +# visible_on :datetime +# visible_until :datetime +# created_at :datetime not null +# updated_at :datetime not null +# course_id :bigint not null +# parent_assessment_id :integer +# +# Indexes +# +# index_assessments_on_course_id (course_id) +# index_assessments_on_short_identifier_and_course_id (short_identifier,course_id) UNIQUE +# index_assessments_on_type_and_short_identifier (type,short_identifier) +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class GradeEntryForm < Assessment has_many :grade_entry_items, -> { order(:position) }, @@ -83,25 +114,8 @@ def create_all_grade_entry_students GradeEntryStudent.insert_all(new_data, returning: false) unless new_data.empty? end - def export_as_csv(role) - if role.instructor? - students = Student.left_outer_joins(:grade_entry_students, :user, :section) - .where(hidden: false, 'grade_entry_students.assessment_id': self.id) - .order(:user_name) - .pluck_to_hash(:user_name, :last_name, :first_name, 'name as section_name', - :id_number, :email, 'grade_entry_students.id') - elsif role.ta? - - students = role.grade_entry_students - .joins(:user) - .joins('LEFT OUTER JOIN sections ON sections.id = roles.section_id') - .where(grade_entry_form: self, 'roles.hidden': false, - 'grade_entry_students.assessment_id': self.id) - .order(:user_name) - .pluck_to_hash(:user_name, :last_name, :first_name, 'name as section_name', - :id_number, :email, 'grade_entry_students.id') - - end + def export_as_csv(role, user_names: nil) + students = students_for_export(role, user_names: user_names) headers = [] titles = Student::CSV_ORDER.map { |field| GradeEntryForm.human_attribute_name(field) } + self.grade_entry_items.pluck(:name) @@ -115,21 +129,10 @@ def export_as_csv(role) totals << self.max_mark if self.show_total headers << totals - if role.instructor? - grade_data = self.grades - .joins(:grade_entry_item, grade_entry_student: :user) - .pluck('users.user_name', 'grade_entry_items.position', :grade) - .group_by { |x| x[0] } - num_items = self.grade_entry_items.count - elsif role.ta? - grade_data = self.grades - .joins(:grade_entry_item, grade_entry_student: :user) - .joins(grade_entry_student: :grade_entry_student_tas) - .where('grade_entry_student_tas.ta_id': role.id) - .pluck('users.user_name', 'grade_entry_items.position', 'grades.grade') - .group_by { |x| x[0] } - num_items = self.grade_entry_items.count - end + grade_data = grades_for_export(role, user_names: user_names) + .pluck('users.user_name', 'grade_entry_items.position', :grade) + .group_by { |x| x[0] } + num_items = self.grade_entry_items.count total_grades = GradeEntryStudent.get_total_grades(students.pluck('grade_entry_students.id')) @@ -152,6 +155,32 @@ def export_as_csv(role) end end + def export_as_json(role, user_names: nil) + students = students_for_export(role, user_names: user_names) + grade_data = grades_for_export(role, user_names: user_names) + .pluck('users.user_name', 'grade_entry_items.name', :grade) + .group_by { |x| x[0] } + .transform_values { |rows| rows.to_h { |_user, item, grade| [item, grade] } } + + total_grades = self.show_total ? GradeEntryStudent.get_total_grades(students.pluck('grade_entry_students.id')) : {} + + student_data = students.map do |student| + entry = student.slice(:user_name, :last_name, :first_name, :id_number, :email).merge( + section_name: student[:section_name], + grades: grade_data.fetch(student[:user_name], {}) + ) + entry[:total_grade] = total_grades[student['grade_entry_students.id']] if self.show_total + entry + end + + items = self.grade_entry_items.order(:position).as_json(only: [:id, :name, :out_of, :bonus]) + self.attributes.slice('id', 'short_identifier', 'description', 'due_date', + 'is_hidden', 'visible_on', 'visible_until', 'show_total').merge( + 'grade_entry_items' => items, + 'students' => student_data + ) + end + def from_csv(grades_data, overwrite) grade_entry_students = self.grade_entry_students.joins(:user).pluck('users.user_name', :id).to_h all_grades = Set.new( @@ -243,4 +272,36 @@ def update_grade_entry_items(names, totals, overwrite) def display_median_to_students false end + + private + + def students_for_export(role, user_names: nil) + if role.instructor? + query = Student.left_outer_joins(:grade_entry_students, :user, :section) + .where(hidden: false, 'grade_entry_students.assessment_id': self.id) + elsif role.ta? + query = role.grade_entry_students + .joins(:user) + .joins('LEFT OUTER JOIN sections ON sections.id = roles.section_id') + .where(grade_entry_form: self, 'roles.hidden': false, + 'grade_entry_students.assessment_id': self.id) + end + query = query.where('users.user_name': user_names) if user_names.present? + query.order(:user_name) + .pluck_to_hash(:user_name, :last_name, :first_name, 'name as section_name', + :id_number, :email, 'grade_entry_students.id') + end + + def grades_for_export(role, user_names: nil) + if role.instructor? + query = self.grades.joins(:grade_entry_item, grade_entry_student: :user) + elsif role.ta? + query = self.grades + .joins(:grade_entry_item, grade_entry_student: :user) + .joins(grade_entry_student: :grade_entry_student_tas) + .where('grade_entry_student_tas.ta_id': role.id) + end + query = query.where('users.user_name': user_names) if user_names.present? + query + end end diff --git a/app/models/grade_entry_item.rb b/app/models/grade_entry_item.rb index d5661cc61f..d251e1df47 100755 --- a/app/models/grade_entry_item.rb +++ b/app/models/grade_entry_item.rb @@ -1,5 +1,24 @@ # GradeEntryItem represents column names (i.e. question names and totals) # in a grade entry form. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: grade_entry_items +# +# id :integer not null, primary key +# bonus :boolean default(FALSE), not null +# name :string not null +# out_of :float +# position :integer +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint +# +# Indexes +# +# index_grade_entry_items_on_assessment_id_and_name (assessment_id,name) UNIQUE +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class GradeEntryItem < ApplicationRecord belongs_to :grade_entry_form, inverse_of: :grade_entry_items, foreign_key: :assessment_id diff --git a/app/models/grade_entry_student.rb b/app/models/grade_entry_student.rb index 1a1504bdaf..c0d9067ee1 100644 --- a/app/models/grade_entry_student.rb +++ b/app/models/grade_entry_student.rb @@ -1,5 +1,26 @@ # GradeEntryStudent represents a row (i.e. a student's grades for each question) # in a grade entry form. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: grade_entry_students +# +# id :integer not null, primary key +# released_to_student :boolean default(FALSE), not null +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint +# role_id :bigint not null +# +# Indexes +# +# index_grade_entry_students_on_role_id_and_assessment_id (role_id,assessment_id) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (role_id => roles.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class GradeEntryStudent < ApplicationRecord belongs_to :role validates_associated :role, on: :create diff --git a/app/models/grade_entry_student_ta.rb b/app/models/grade_entry_student_ta.rb index 061dd17463..7f032cf006 100644 --- a/app/models/grade_entry_student_ta.rb +++ b/app/models/grade_entry_student_ta.rb @@ -1,4 +1,18 @@ # Join model that associates a grade entry student and a TA. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: grade_entry_students_tas +# +# id :integer not null, primary key +# grade_entry_student_id :integer +# ta_id :integer +# +# Indexes +# +# index_grade_entry_students_tas (grade_entry_student_id,ta_id) UNIQUE +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class GradeEntryStudentTa < ApplicationRecord self.table_name = 'grade_entry_students_tas' diff --git a/app/models/grader_permission.rb b/app/models/grader_permission.rb index d47c311d30..f5ea8d1970 100644 --- a/app/models/grader_permission.rb +++ b/app/models/grader_permission.rb @@ -1,4 +1,24 @@ # Contains the grader permissions for a particular grader +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: grader_permissions +# +# id :bigint not null, primary key +# manage_assessments :boolean default(FALSE), not null +# manage_submissions :boolean default(FALSE), not null +# run_tests :boolean default(FALSE), not null +# role_id :bigint not null +# +# Indexes +# +# index_grader_permissions_on_role_id (role_id) +# +# Foreign Keys +# +# fk_rails_... (role_id => roles.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class GraderPermission < ApplicationRecord belongs_to :ta, class_name: 'Ta', foreign_key: :role_id, inverse_of: :grader_permission has_one :course, through: :ta diff --git a/app/models/group.rb b/app/models/group.rb index 396489d075..17f8b83911 100644 --- a/app/models/group.rb +++ b/app/models/group.rb @@ -1,4 +1,24 @@ # Represents groupings of students working on one or more assignments, within a shared repository. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: groups +# +# id :integer not null, primary key +# group_name :string +# repo_name :string +# course_id :bigint not null +# +# Indexes +# +# index_groups_on_course_id (course_id) +# index_groups_on_group_name_and_course_id (group_name,course_id) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Group < ApplicationRecord after_create :set_repo_name, :check_repo_uniqueness, :build_repository diff --git a/app/models/grouping.rb b/app/models/grouping.rb index d46570fbd0..fe8bfd2296 100644 --- a/app/models/grouping.rb +++ b/app/models/grouping.rb @@ -1,3 +1,30 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: groupings +# +# id :integer not null, primary key +# criteria_coverage_count :integer default(0) +# instructor_approved :boolean default(FALSE), not null +# is_collected :boolean default(FALSE), not null +# start_time :datetime +# starter_file_changed :boolean default(FALSE), not null +# test_tokens :integer default(0), not null +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint not null +# group_id :integer not null +# +# Indexes +# +# groupings_u1 (assessment_id,group_id) UNIQUE +# +# Foreign Keys +# +# fk_groupings_assignments (assessment_id => assessments.id) +# fk_groupings_groups (group_id => groups.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective require 'set' # Represents a grouping of students working together on a single assignment. This model manages various aspects of the @@ -288,7 +315,7 @@ def invite(members, all_errors = [] members.each do |m| m = m.strip - user = course.students.joins(:user).where(hidden: false).find_by('users.user_name': m) + user = course.students.joins(:user).find_by('users.user_name': m) begin if user.nil? raise I18n.t('groups.invite_member.errors.not_found', user_name: m) @@ -305,7 +332,7 @@ def invite(members, # Add a new member to base def add_member(role, set_membership_status = StudentMembership::STATUSES[:accepted]) - if role.has_accepted_grouping_for?(self.assessment_id) || role.hidden + if role.has_accepted_grouping_for?(self.assessment_id) nil else member = StudentMembership.new(role: role, membership_status: @@ -329,6 +356,8 @@ def add_member(role, set_membership_status = StudentMembership::STATUSES[:accept def can_invite?(role) if self.inviter == role raise I18n.t('groups.invite_member.errors.inviting_self') + elsif role.hidden + raise I18n.t('groups.invite_member.errors.inactive_student', user_name: role.user_name) elsif !extension.nil? raise I18n.t('groups.invite_member.errors.extension_exists') elsif self.student_membership_number >= self.assignment.group_max @@ -1079,7 +1108,7 @@ def use_section_due_date? def assignments_should_match return if assessment_id.nil? unless self.tags.pluck(:assessment_id).compact.all?(self.assessment_id) - errors.add(:base, 'tags must belong to the same assignment as this grouping') + errors.add(:base, :different_assignment_grouping) end end end diff --git a/app/models/grouping_starter_file_entry.rb b/app/models/grouping_starter_file_entry.rb index fab3df5048..c6253a74b8 100644 --- a/app/models/grouping_starter_file_entry.rb +++ b/app/models/grouping_starter_file_entry.rb @@ -1,5 +1,25 @@ # Class joining a grouping to a starter file entry that has been given # to the grouping as starter files. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: grouping_starter_file_entries +# +# id :bigint not null, primary key +# grouping_id :bigint not null +# starter_file_entry_id :bigint not null +# +# Indexes +# +# index_grouping_starter_file_entries_on_grouping_id (grouping_id) +# index_grouping_starter_file_entries_on_starter_file_entry_id (starter_file_entry_id) +# +# Foreign Keys +# +# fk_rails_... (grouping_id => groupings.id) +# fk_rails_... (starter_file_entry_id => starter_file_entries.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class GroupingStarterFileEntry < ApplicationRecord belongs_to :starter_file_entry belongs_to :grouping @@ -14,7 +34,7 @@ class GroupingStarterFileEntry < ApplicationRecord def assignments_should_match return if starter_file_entry.nil? || grouping.nil? unless grouping.assignment == starter_file_entry.starter_file_group.assignment - errors.add(:base, 'starter_file_entry and grouping must all belong to the same assignment') + errors.add(:base, :not_in_same_assignment) end end end diff --git a/app/models/html_annotation.rb b/app/models/html_annotation.rb index 83a534e64f..a723894e4e 100644 --- a/app/models/html_annotation.rb +++ b/app/models/html_annotation.rb @@ -1,3 +1,42 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: annotations +# +# id :integer not null, primary key +# annotation_number :integer +# column_end :integer +# column_start :integer +# creator_type :string +# end_node :string +# end_offset :integer +# is_remark :boolean default(FALSE), not null +# line_end :integer +# line_start :integer +# page :integer +# start_node :string +# start_offset :integer +# type :string +# x1 :integer +# x2 :integer +# y1 :integer +# y2 :integer +# annotation_text_id :integer +# creator_id :integer +# result_id :integer +# submission_file_id :integer +# +# Indexes +# +# index_annotations_on_creator_type_and_creator_id (creator_type,creator_id) +# index_annotations_on_submission_file_id (submission_file_id) +# +# Foreign Keys +# +# fk_annotations_annotation_texts (annotation_text_id => annotation_texts.id) +# fk_annotations_submission_files (submission_file_id => submission_files.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class HtmlAnnotation < Annotation validates :start_node, presence: true validates :start_offset, presence: true diff --git a/app/models/image_annotation.rb b/app/models/image_annotation.rb index 13618c8c95..b5704969b8 100644 --- a/app/models/image_annotation.rb +++ b/app/models/image_annotation.rb @@ -1,3 +1,42 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: annotations +# +# id :integer not null, primary key +# annotation_number :integer +# column_end :integer +# column_start :integer +# creator_type :string +# end_node :string +# end_offset :integer +# is_remark :boolean default(FALSE), not null +# line_end :integer +# line_start :integer +# page :integer +# start_node :string +# start_offset :integer +# type :string +# x1 :integer +# x2 :integer +# y1 :integer +# y2 :integer +# annotation_text_id :integer +# creator_id :integer +# result_id :integer +# submission_file_id :integer +# +# Indexes +# +# index_annotations_on_creator_type_and_creator_id (creator_type,creator_id) +# index_annotations_on_submission_file_id (submission_file_id) +# +# Foreign Keys +# +# fk_annotations_annotation_texts (annotation_text_id => annotation_texts.id) +# fk_annotations_submission_files (submission_file_id => submission_files.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class ImageAnnotation < Annotation # (x1, y1) is the top left corner and (x2, y2) is the bottom right corner # of the rectangle containing the annotation. diff --git a/app/models/instructor.rb b/app/models/instructor.rb index e242b3cc60..edaaf8add0 100644 --- a/app/models/instructor.rb +++ b/app/models/instructor.rb @@ -1,4 +1,35 @@ # Instructor user for a given course. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: roles +# +# id :bigint not null, primary key +# grace_credits :integer default(0), not null +# hidden :boolean default(FALSE), not null +# receives_invite_emails :boolean default(FALSE), not null +# receives_results_emails :boolean default(FALSE), not null +# type :string not null +# created_at :datetime not null +# updated_at :datetime not null +# course_id :bigint not null +# section_id :bigint +# user_id :bigint not null +# +# Indexes +# +# index_roles_on_course_id (course_id) +# index_roles_on_section_id (section_id) +# index_roles_on_user_id (user_id) +# index_roles_on_user_id_and_course_id (user_id,course_id) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# fk_rails_... (section_id => sections.id) +# fk_rails_... (user_id => users.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Instructor < Role after_create { Repository.get_class.update_permissions } after_destroy { Repository.get_class.update_permissions } diff --git a/app/models/job_messenger.rb b/app/models/job_messenger.rb index b046e8bbb9..9a591fc376 100644 --- a/app/models/job_messenger.rb +++ b/app/models/job_messenger.rb @@ -1,3 +1,20 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: job_messengers +# +# id :integer not null, primary key +# message :string +# status :string +# created_at :datetime not null +# updated_at :datetime not null +# job_id :string +# +# Indexes +# +# index_job_messengers_on_job_id (job_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class JobMessenger < ApplicationRecord def message_for_user case status diff --git a/app/models/key_pair.rb b/app/models/key_pair.rb index 489fb714cf..0e23a60f40 100644 --- a/app/models/key_pair.rb +++ b/app/models/key_pair.rb @@ -1,3 +1,19 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: key_pairs +# +# id :integer not null, primary key +# public_key :string +# created_at :datetime +# updated_at :datetime +# user_id :integer +# +# Foreign Keys +# +# fk_rails_... (user_id => users.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class KeyPair < ApplicationRecord belongs_to :user @@ -21,6 +37,6 @@ def public_key_format single_line = self.public_key.lines.one? { |line| line.strip.present? } key_type, key, _comment = self.public_key.split valid_key_type = KEY_TYPES.include? key_type - errors.add(:public_key, I18n.t('key_pairs.create.invalid_key')) unless single_line && valid_key_type && !key.nil? + errors.add(:public_key, :invalid_key) unless single_line && valid_key_type && !key.nil? end end diff --git a/app/models/level.rb b/app/models/level.rb index ea9035f330..ed9daa3d66 100644 --- a/app/models/level.rb +++ b/app/models/level.rb @@ -1,4 +1,26 @@ # Level represents a level within a Rubric Criterion +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: levels +# +# id :bigint not null, primary key +# description :string not null +# mark :float not null +# name :string not null +# created_at :datetime not null +# updated_at :datetime not null +# criterion_id :bigint not null +# +# Indexes +# +# index_levels_on_criterion_id (criterion_id) +# +# Foreign Keys +# +# fk_rails_... (criterion_id => criteria.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Level < ApplicationRecord belongs_to :criterion @@ -40,7 +62,7 @@ def unique_within_criterion(attr) def only_update_if_results_unreleased return if self.criterion.nil? # When the level is first being created unless self.criterion.results_unreleased? - errors.add(:base, 'Cannot update level once results are released.') + errors.add(:base, :results_already_released) end end diff --git a/app/models/lti_client.rb b/app/models/lti_client.rb index a4670f1617..83293acba8 100644 --- a/app/models/lti_client.rb +++ b/app/models/lti_client.rb @@ -1,3 +1,20 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: lti_clients +# +# id :bigint not null, primary key +# host :string not null +# created_at :datetime not null +# updated_at :datetime not null +# client_id :string not null +# course_id :bigint +# +# Indexes +# +# index_lti_clients_on_course_id (course_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class LtiClient < ApplicationRecord has_many :lti_deployments has_many :lti_users diff --git a/app/models/lti_deployment.rb b/app/models/lti_deployment.rb index 098daa255d..0b6642c419 100644 --- a/app/models/lti_deployment.rb +++ b/app/models/lti_deployment.rb @@ -1,3 +1,26 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: lti_deployments +# +# id :bigint not null, primary key +# lms_course_name :string not null +# lms_course_sourcedid :string +# lms_term_name :string +# created_at :datetime not null +# updated_at :datetime not null +# course_id :bigint +# external_deployment_id :string not null +# lms_course_id :integer not null +# lti_client_id :bigint not null +# resource_link_id :string +# +# Indexes +# +# index_lti_deployments_on_course_id (course_id) +# index_lti_deployments_on_lti_client_id (lti_client_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class LtiDeployment < ApplicationRecord belongs_to :course, optional: true belongs_to :lti_client @@ -12,6 +35,7 @@ class LtiDeployment < ApplicationRecord results: 'https://purl.imsglobal.org/spec/lti-ags/scope/result.readonly' }.freeze LTI_CLAIMS = { context: 'https://purl.imsglobal.org/spec/lti/claim/context', custom: 'https://purl.imsglobal.org/spec/lti/claim/custom', + lis: 'https://purl.imsglobal.org/spec/lti/claim/lis', names_role: 'https://purl.imsglobal.org/spec/lti-nrps/claim/namesroleservice', ags_lineitem: 'https://purl.imsglobal.org/spec/lti-ags/claim/endpoint', deployment_id: 'https://purl.imsglobal.org/spec/lti/claim/deployment_id', diff --git a/app/models/lti_line_item.rb b/app/models/lti_line_item.rb index f3401cc898..b921a25003 100644 --- a/app/models/lti_line_item.rb +++ b/app/models/lti_line_item.rb @@ -1,3 +1,27 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: lti_line_items +# +# id :bigint not null, primary key +# created_at :datetime not null +# updated_at :datetime not null +# assessment_id :bigint not null +# lti_deployment_id :bigint not null +# lti_line_item_id :string not null +# +# Indexes +# +# index_lti_line_items_on_assessment_id (assessment_id) +# index_lti_line_items_on_lti_deployment_id (lti_deployment_id) +# index_lti_line_items_on_lti_deployment_id_and_assessment_id (lti_deployment_id,assessment_id) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (assessment_id => assessments.id) +# fk_rails_... (lti_deployment_id => lti_deployments.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class LtiLineItem < ApplicationRecord belongs_to :assessment belongs_to :lti_deployment diff --git a/app/models/lti_service.rb b/app/models/lti_service.rb index d1ec3be0bc..985885d837 100644 --- a/app/models/lti_service.rb +++ b/app/models/lti_service.rb @@ -1,3 +1,25 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: lti_services +# +# id :bigint not null, primary key +# service_type :string not null +# url :string not null +# created_at :datetime not null +# updated_at :datetime not null +# lti_deployment_id :bigint not null +# +# Indexes +# +# index_lti_services_on_lti_deployment_id (lti_deployment_id) +# index_lti_services_on_lti_deployment_id_and_service_type (lti_deployment_id,service_type) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (lti_deployment_id => lti_deployments.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class LtiService < ApplicationRecord LTI_SERVICES = { namesrole: 'namesrole', diff --git a/app/models/lti_user.rb b/app/models/lti_user.rb index 4ec1fe5648..5bd4c7605e 100644 --- a/app/models/lti_user.rb +++ b/app/models/lti_user.rb @@ -1,3 +1,22 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: lti_users +# +# id :bigint not null, primary key +# created_at :datetime not null +# updated_at :datetime not null +# lti_client_id :bigint not null +# lti_user_id :string not null +# user_id :bigint not null +# +# Indexes +# +# index_lti_users_on_lti_client_id (lti_client_id) +# index_lti_users_on_user_id (user_id) +# index_lti_users_on_user_id_and_lti_client_id (user_id,lti_client_id) UNIQUE +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class LtiUser < ApplicationRecord belongs_to :lti_client belongs_to :user diff --git a/app/models/mark.rb b/app/models/mark.rb index 99a6d2f9a6..5a1d4a74d6 100644 --- a/app/models/mark.rb +++ b/app/models/mark.rb @@ -1,3 +1,30 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: marks +# +# id :integer not null, primary key +# mark :float +# override :boolean default(FALSE), not null +# created_at :datetime +# updated_at :datetime +# criterion_id :integer +# last_updated_by_id :bigint +# result_id :integer +# +# Indexes +# +# index_marks_on_criterion_id (criterion_id) +# index_marks_on_last_updated_by_id (last_updated_by_id) +# index_marks_on_result_id (result_id) +# +# Foreign Keys +# +# fk_marks_results (result_id => results.id) ON DELETE => cascade +# fk_rails_... (criterion_id => criteria.id) +# fk_rails_... (last_updated_by_id => roles.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Mark < ApplicationRecord # When a mark is saved, we need to make sure that that # Result has not been released to students @@ -24,6 +51,8 @@ class Mark < ApplicationRecord validate :assignments_should_match + belongs_to :last_updated_by, class_name: 'Role', optional: true + # Calculate the deduction for this mark. If the mark belongs to a remark result and no deductive # annotations for this mark have been applied to the result, then the deductive annotations of # the original result are used to calculate the mark. @@ -99,7 +128,7 @@ def assignments_should_match assignment = result.submission.grouping.assignment end unless assignment == criterion.assignment - errors.add(:base, 'result and criterion must all belong to the same assignment') + errors.add(:base, :not_in_same_assignment) end end end diff --git a/app/models/marking_scheme.rb b/app/models/marking_scheme.rb index 03e4864ab1..f71da6e934 100644 --- a/app/models/marking_scheme.rb +++ b/app/models/marking_scheme.rb @@ -1,3 +1,24 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: marking_schemes +# +# id :integer not null, primary key +# name :string +# created_at :datetime +# updated_at :datetime +# course_id :bigint not null +# +# Indexes +# +# index_marking_schemes_on_course_id (course_id) +# index_marking_schemes_on_course_id_and_name (course_id,name) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class MarkingScheme < ApplicationRecord include CourseSummariesHelper diff --git a/app/models/marking_weight.rb b/app/models/marking_weight.rb index 213f312984..57a9ba2c4a 100644 --- a/app/models/marking_weight.rb +++ b/app/models/marking_weight.rb @@ -1,3 +1,24 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: marking_weights +# +# id :integer not null, primary key +# weight :decimal(, ) +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint not null +# marking_scheme_id :integer +# +# Indexes +# +# index_marking_weights_on_assessment_id (assessment_id) +# +# Foreign Keys +# +# fk_rails_... (assessment_id => assessments.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class MarkingWeight < ApplicationRecord belongs_to :marking_scheme belongs_to :assessment diff --git a/app/models/membership.rb b/app/models/membership.rb index 9ea483d63f..9187981804 100644 --- a/app/models/membership.rb +++ b/app/models/membership.rb @@ -1,4 +1,27 @@ # Join model representing a member in a grouping +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: memberships +# +# id :integer not null, primary key +# membership_status :string +# type :string +# created_at :datetime +# updated_at :datetime +# grouping_id :integer not null +# role_id :bigint not null +# +# Indexes +# +# index_memberships_on_role_id (role_id) +# +# Foreign Keys +# +# fk_memberships_groupings (grouping_id => groupings.id) +# fk_rails_... (role_id => roles.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Membership < ApplicationRecord has_many :grace_period_deductions, dependent: :destroy diff --git a/app/models/no_late_submission_rule.rb b/app/models/no_late_submission_rule.rb index 9957654f38..df9ef0f4f2 100644 --- a/app/models/no_late_submission_rule.rb +++ b/app/models/no_late_submission_rule.rb @@ -1,6 +1,23 @@ # The NoLateSubmissionRule applies no penalties whatsoever. The collection # time is on the due date of the assignment + allow_submit_until +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: submission_rules +# +# id :integer not null, primary key +# penalty_type :string default("percentage") +# type :string default("NoLateSubmissionRule") +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint not null +# +# Indexes +# +# index_submission_rules_on_assessment_id (assessment_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class NoLateSubmissionRule < SubmissionRule def overtime_message(_grouping) NoLateSubmissionRule.human_attribute_name(:after_collection_message) diff --git a/app/models/note.rb b/app/models/note.rb index 340f81486b..f73a86b605 100644 --- a/app/models/note.rb +++ b/app/models/note.rb @@ -1,3 +1,21 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: notes +# +# id :integer not null, primary key +# noteable_type :string not null +# notes_message :text not null +# created_at :datetime +# updated_at :datetime +# creator_id :integer not null +# noteable_id :integer not null +# +# Indexes +# +# index_notes_on_creator_id (creator_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Note < ApplicationRecord belongs_to :noteable, polymorphic: true diff --git a/app/models/pdf_annotation.rb b/app/models/pdf_annotation.rb index bf5d4db16a..bb6d9f7028 100644 --- a/app/models/pdf_annotation.rb +++ b/app/models/pdf_annotation.rb @@ -1,3 +1,42 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: annotations +# +# id :integer not null, primary key +# annotation_number :integer +# column_end :integer +# column_start :integer +# creator_type :string +# end_node :string +# end_offset :integer +# is_remark :boolean default(FALSE), not null +# line_end :integer +# line_start :integer +# page :integer +# start_node :string +# start_offset :integer +# type :string +# x1 :integer +# x2 :integer +# y1 :integer +# y2 :integer +# annotation_text_id :integer +# creator_id :integer +# result_id :integer +# submission_file_id :integer +# +# Indexes +# +# index_annotations_on_creator_type_and_creator_id (creator_type,creator_id) +# index_annotations_on_submission_file_id (submission_file_id) +# +# Foreign Keys +# +# fk_annotations_annotation_texts (annotation_text_id => annotation_texts.id) +# fk_annotations_submission_files (submission_file_id => submission_files.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class PdfAnnotation < Annotation # (x1, y1) is the top left corner and (x2, y2) is the bottom right corner # of the rectangle containing the annotation. diff --git a/app/models/peer_review.rb b/app/models/peer_review.rb index 825719a151..7202eed002 100644 --- a/app/models/peer_review.rb +++ b/app/models/peer_review.rb @@ -1,3 +1,26 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: peer_reviews +# +# id :integer not null, primary key +# created_at :datetime not null +# updated_at :datetime not null +# result_id :integer not null +# reviewer_id :integer not null +# +# Indexes +# +# index_peer_reviews_on_result_id (result_id) +# index_peer_reviews_on_result_id_and_reviewer_id (result_id,reviewer_id) UNIQUE +# index_peer_reviews_on_reviewer_id (reviewer_id) +# +# Foreign Keys +# +# fk_rails_... (result_id => results.id) +# fk_rails_... (reviewer_id => groupings.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective require 'set' class PeerReview < ApplicationRecord @@ -17,7 +40,7 @@ def no_students_should_be_reviewer_and_reviewee reviewer.students.each { |student| student_id_set.add(student.id) } result.submission.grouping.students.each do |student| if student_id_set.include?(student.id) - errors.add(:reviewer_id, I18n.t('peer_reviews.errors.cannot_allow_reviewer_to_be_reviewee')) + errors.add(:reviewer_id, :cannot_allow_reviewer_to_be_reviewee) break end end @@ -149,7 +172,7 @@ def self.from_csv(assignment, data) def assignments_should_match return if result.nil? || reviewer.nil? unless result.submission.grouping.assignment == reviewer.assignment.parent_assignment - errors.add(:base, 'result and reviewer must all belong to the same assignment') + errors.add(:base, :not_in_same_assignment) end end end diff --git a/app/models/penalty_decay_period_submission_rule.rb b/app/models/penalty_decay_period_submission_rule.rb index 6abdc321a8..d01589aaec 100644 --- a/app/models/penalty_decay_period_submission_rule.rb +++ b/app/models/penalty_decay_period_submission_rule.rb @@ -1,3 +1,20 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: submission_rules +# +# id :integer not null, primary key +# penalty_type :string default("percentage") +# type :string default("NoLateSubmissionRule") +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint not null +# +# Indexes +# +# index_submission_rules_on_assessment_id (assessment_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class PenaltyDecayPeriodSubmissionRule < SubmissionRule # This message will be dislayed to Students on viewing their file manager # after the due date has passed, but before the calculated collection date. diff --git a/app/models/penalty_period_submission_rule.rb b/app/models/penalty_period_submission_rule.rb index 75a519a47a..a81c730367 100644 --- a/app/models/penalty_period_submission_rule.rb +++ b/app/models/penalty_period_submission_rule.rb @@ -1,3 +1,20 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: submission_rules +# +# id :integer not null, primary key +# penalty_type :string default("percentage") +# type :string default("NoLateSubmissionRule") +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint not null +# +# Indexes +# +# index_submission_rules_on_assessment_id (assessment_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class PenaltyPeriodSubmissionRule < SubmissionRule # This message will be dislayed to Students on viewing their file manager # after the due date has passed, but before the calculated collection date. diff --git a/app/models/period.rb b/app/models/period.rb index 916c2ccaf3..67c585eced 100644 --- a/app/models/period.rb +++ b/app/models/period.rb @@ -1,3 +1,22 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: periods +# +# id :integer not null, primary key +# deduction :float +# hours :float +# interval :float +# submission_rule_type :string +# created_at :datetime +# updated_at :datetime +# submission_rule_id :integer +# +# Indexes +# +# index_periods_on_submission_rule_id (submission_rule_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Period < ApplicationRecord belongs_to :submission_rule, polymorphic: true diff --git a/app/models/result.rb b/app/models/result.rb index 662055b012..4466537e2a 100644 --- a/app/models/result.rb +++ b/app/models/result.rb @@ -1,3 +1,29 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: results +# +# id :integer not null, primary key +# marking_state :string +# overall_comment :text +# released_to_students :boolean default(FALSE), not null +# remark_request_submitted_at :datetime +# view_token :string not null +# view_token_expiry :datetime +# created_at :datetime +# updated_at :datetime +# submission_id :integer +# +# Indexes +# +# index_results_on_submission_id (submission_id) +# index_results_on_view_token (view_token) UNIQUE +# +# Foreign Keys +# +# fk_results_submissions (submission_id => submissions.id) ON DELETE => cascade +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Result < ApplicationRecord MARKING_STATES = { complete: 'complete', @@ -111,7 +137,7 @@ def self.get_subtotals(result_ids, user_visibility: :ta_visible, criterion_ids: # +user_visibility+ is passed to the Assignment.max_mark method to determine the # max_mark value only if the +max_mark+ argument is nil. def self.get_total_extra_marks(result_ids, max_mark: nil, user_visibility: :ta_visible, subtotals: nil) - result_data = Result.joins(:extra_marks, submission: [grouping: :assignment]) + result_data = Result.joins(:extra_marks, submission: [{ grouping: :assignment }]) .where(id: result_ids) .pluck(:id, :extra_mark, :unit, 'assessments.id') subtotals ||= Result.get_subtotals(result_ids, user_visibility: user_visibility) @@ -315,9 +341,7 @@ def generate_print_pdf input_files.each do |sf| contents = sf.retrieve_file(repo: repo) FileUtils.mkdir_p(File.join(workdir, sf.path)) - f = File.open(File.join(workdir, sf.path, sf.filename), 'wb') - f.write(contents) - f.close + File.binwrite(File.join(workdir, sf.path, sf.filename), contents) end end @@ -423,7 +447,7 @@ def print_pdf_filename # Do not allow the marking state to be changed to incomplete if the result is released def check_for_released if released_to_students && marking_state_changed?(to: Result::MARKING_STATES[:incomplete]) - errors.add(:base, I18n.t('results.marks_released')) + errors.add(:base, :marks_released) throw(:abort) end true @@ -459,7 +483,7 @@ def check_for_nil_marks(user_visibility = :ta_visible) end if nil_marks || num_marks < criteria.count - errors.add(:base, I18n.t('results.criterion_incomplete_error')) + errors.add(:base, :criterion_incomplete_error) throw(:abort) end true diff --git a/app/models/role.rb b/app/models/role.rb index 10d1c9e367..69156217fe 100644 --- a/app/models/role.rb +++ b/app/models/role.rb @@ -1,4 +1,35 @@ # Model representing a user's role in a given course. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: roles +# +# id :bigint not null, primary key +# grace_credits :integer default(0), not null +# hidden :boolean default(FALSE), not null +# receives_invite_emails :boolean default(FALSE), not null +# receives_results_emails :boolean default(FALSE), not null +# type :string not null +# created_at :datetime not null +# updated_at :datetime not null +# course_id :bigint not null +# section_id :bigint +# user_id :bigint not null +# +# Indexes +# +# index_roles_on_course_id (course_id) +# index_roles_on_section_id (section_id) +# index_roles_on_user_id (user_id) +# index_roles_on_user_id_and_course_id (user_id,course_id) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# fk_rails_... (section_id => sections.id) +# fk_rails_... (user_id => users.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Role < ApplicationRecord scope :active, -> { where(hidden: false) } scope :inactive, -> { where(hidden: true) } @@ -16,6 +47,10 @@ class Role < ApplicationRecord has_many :split_pdf_logs has_many :assessments, through: :course has_many :tags + has_many :last_updated_marks, class_name: 'Mark', foreign_key: 'last_updated_by_id', inverse_of: :last_updated_by, + dependent: :nullify + has_many :last_updated_grades, class_name: 'Grade', foreign_key: 'last_updated_by_id', inverse_of: :last_updated_by, + dependent: :nullify validates :type, format: { with: /\AStudent|Instructor|Ta|AdminRole\z/ } validates :user_id, uniqueness: { scope: :course_id } @@ -102,7 +137,7 @@ def visible_assessments(assessment_type: nil, assessment_id: nil) # is an end user def associated_user_is_an_end_user unless self.user.nil? || self.user.end_user? - errors.add(:base, "non end users cannot be assigned the #{self.model_name.human} role") + errors.add(:base, :invalid_assignment, role_name: self.model_name.human) end end diff --git a/app/models/rubric_criterion.rb b/app/models/rubric_criterion.rb index 2a96449a1a..1fe647046f 100644 --- a/app/models/rubric_criterion.rb +++ b/app/models/rubric_criterion.rb @@ -1,3 +1,31 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: criteria +# +# id :bigint not null, primary key +# assigned_groups_count :integer default(0), not null +# bonus :boolean default(FALSE), not null +# description :text default(""), not null +# max_mark :decimal(10, 1) not null +# name :string not null +# peer_visible :boolean default(FALSE), not null +# position :integer not null +# ta_visible :boolean default(TRUE), not null +# type :string not null +# created_at :datetime not null +# updated_at :datetime not null +# assessment_id :bigint not null +# +# Indexes +# +# index_criteria_on_assessment_id (assessment_id) +# +# Foreign Keys +# +# fk_rails_... (assessment_id => assessments.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class RubricCriterion < Criterion before_validation :scale_marks_if_max_mark_changed before_save :round_max_mark diff --git a/app/models/section.rb b/app/models/section.rb index 5885cd460b..194cfa24b2 100644 --- a/app/models/section.rb +++ b/app/models/section.rb @@ -1,3 +1,24 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: sections +# +# id :integer not null, primary key +# name :string +# created_at :datetime +# updated_at :datetime +# course_id :bigint not null +# +# Indexes +# +# index_sections_on_course_id (course_id) +# index_sections_on_name_and_course_id (name,course_id) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Section < ApplicationRecord validates :name, presence: true, allow_blank: false, format: { with: /\A[a-zA-Z0-9\-_ ]+\z/ } diff --git a/app/models/section_starter_file_group.rb b/app/models/section_starter_file_group.rb index 693772aace..3a68059940 100644 --- a/app/models/section_starter_file_group.rb +++ b/app/models/section_starter_file_group.rb @@ -1,6 +1,26 @@ # Class joining a section to a starter file group. This starter file group # is used to assign starter files to groups within a section for assessments # with starter_file_rule_type == 'sections' +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: section_starter_file_groups +# +# id :bigint not null, primary key +# section_id :bigint not null +# starter_file_group_id :bigint not null +# +# Indexes +# +# index_section_starter_file_groups_on_section_id (section_id) +# index_section_starter_file_groups_on_starter_file_group_id (starter_file_group_id) +# +# Foreign Keys +# +# fk_rails_... (section_id => sections.id) +# fk_rails_... (starter_file_group_id => starter_file_groups.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class SectionStarterFileGroup < ApplicationRecord belongs_to :starter_file_group belongs_to :section @@ -19,6 +39,6 @@ def only_one_per_assessment .where('starter_file_groups.assessment_id': starter_file_group.assignment.id) .where(section_id: self.section_id) .where.not(starter_file_group_id: starter_file_group.id) - errors.add(:base, 'Only one allowed per assessment') if others.exists? + errors.add(:base, :more_than_one) if others.exists? end end diff --git a/app/models/split_page.rb b/app/models/split_page.rb index f6ca16bb2d..b2b4b85096 100644 --- a/app/models/split_page.rb +++ b/app/models/split_page.rb @@ -1,3 +1,29 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: split_pages +# +# id :integer not null, primary key +# exam_page_number :integer +# filename :string +# raw_page_number :integer +# status :string +# created_at :datetime not null +# updated_at :datetime not null +# group_id :integer +# split_pdf_log_id :integer +# +# Indexes +# +# index_split_pages_on_group_id (group_id) +# index_split_pages_on_split_pdf_log_id (split_pdf_log_id) +# +# Foreign Keys +# +# fk_rails_... (group_id => groups.id) +# fk_rails_... (split_pdf_log_id => split_pdf_logs.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class SplitPage < ApplicationRecord belongs_to :split_pdf_log belongs_to :group, optional: true diff --git a/app/models/split_pdf_log.rb b/app/models/split_pdf_log.rb index b7e65e7823..6d69edbf5a 100644 --- a/app/models/split_pdf_log.rb +++ b/app/models/split_pdf_log.rb @@ -1,3 +1,33 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: split_pdf_logs +# +# id :integer not null, primary key +# error_description :string +# filename :string +# num_groups_in_complete :integer +# num_groups_in_incomplete :integer +# num_pages_qr_scan_error :integer +# original_num_pages :integer +# qr_code_found :boolean default(FALSE), not null +# uploaded_when :datetime +# created_at :datetime not null +# updated_at :datetime not null +# exam_template_id :integer +# role_id :bigint not null +# +# Indexes +# +# index_split_pdf_logs_on_exam_template_id (exam_template_id) +# index_split_pdf_logs_on_role_id (role_id) +# +# Foreign Keys +# +# fk_rails_... (exam_template_id => exam_templates.id) +# fk_rails_... (role_id => roles.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class SplitPdfLog < ApplicationRecord belongs_to :role belongs_to :exam_template diff --git a/app/models/starter_file_entry.rb b/app/models/starter_file_entry.rb index bc477d4fcb..abc78a5259 100644 --- a/app/models/starter_file_entry.rb +++ b/app/models/starter_file_entry.rb @@ -1,4 +1,22 @@ # Class describing a top level file or directory in a starter files group +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: starter_file_entries +# +# id :bigint not null, primary key +# path :string not null +# starter_file_group_id :bigint not null +# +# Indexes +# +# index_starter_file_entries_on_starter_file_group_id (starter_file_group_id) +# +# Foreign Keys +# +# fk_rails_... (starter_file_group_id => starter_file_groups.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class StarterFileEntry < ApplicationRecord belongs_to :starter_file_group has_one :course, through: :starter_file_group @@ -65,6 +83,6 @@ def add_files_to_repo(repo, txn) private def entry_exists - errors.add(:base, 'entry does not exist') unless File.exist?(full_path) + errors.add(:base, :entry_does_not_exist) unless File.exist?(full_path) end end diff --git a/app/models/starter_file_group.rb b/app/models/starter_file_group.rb index c40081d46d..9e50293e3d 100644 --- a/app/models/starter_file_group.rb +++ b/app/models/starter_file_group.rb @@ -1,4 +1,24 @@ # Class describing a group of starter files +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: starter_file_groups +# +# id :bigint not null, primary key +# entry_rename :string default(""), not null +# name :string not null +# use_rename :boolean default(FALSE), not null +# assessment_id :bigint not null +# +# Indexes +# +# index_starter_file_groups_on_assessment_id (assessment_id) +# +# Foreign Keys +# +# fk_rails_... (assessment_id => assessments.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class StarterFileGroup < ApplicationRecord belongs_to :assignment, foreign_key: :assessment_id, inverse_of: :starter_file_groups has_many :section_starter_file_groups, dependent: :destroy diff --git a/app/models/student.rb b/app/models/student.rb index de9fbb35f5..b63c2b60cf 100644 --- a/app/models/student.rb +++ b/app/models/student.rb @@ -1,4 +1,35 @@ # Student user for a given course. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: roles +# +# id :bigint not null, primary key +# grace_credits :integer default(0), not null +# hidden :boolean default(FALSE), not null +# receives_invite_emails :boolean default(FALSE), not null +# receives_results_emails :boolean default(FALSE), not null +# type :string not null +# created_at :datetime not null +# updated_at :datetime not null +# course_id :bigint not null +# section_id :bigint +# user_id :bigint not null +# +# Indexes +# +# index_roles_on_course_id (course_id) +# index_roles_on_section_id (section_id) +# index_roles_on_user_id (user_id) +# index_roles_on_user_id_and_course_id (user_id,course_id) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# fk_rails_... (section_id => sections.id) +# fk_rails_... (user_id => users.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Student < Role has_many :grade_entry_students, dependent: :destroy, foreign_key: :role_id, inverse_of: :role has_many :accepted_memberships, diff --git a/app/models/student_membership.rb b/app/models/student_membership.rb index a94bc6729b..2ff0d89aa1 100644 --- a/app/models/student_membership.rb +++ b/app/models/student_membership.rb @@ -1,3 +1,26 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: memberships +# +# id :integer not null, primary key +# membership_status :string +# type :string +# created_at :datetime +# updated_at :datetime +# grouping_id :integer not null +# role_id :bigint not null +# +# Indexes +# +# index_memberships_on_role_id (role_id) +# +# Foreign Keys +# +# fk_memberships_groupings (grouping_id => groupings.id) +# fk_rails_... (role_id => roles.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class StudentMembership < Membership STATUSES = { accepted: 'accepted', @@ -31,11 +54,11 @@ class StudentMembership < Membership def must_be_valid_student if role && !role.is_a?(Student) - errors.add('base', 'User must be a student') + errors.add(:base, :not_student) return false end unless STATUSES.value?(membership_status) - errors.add('base', 'Invalid membership status') + errors.add(:base, :invalid_membership) false end end diff --git a/app/models/submission.rb b/app/models/submission.rb index 4a6ffcbc04..b781f5f610 100644 --- a/app/models/submission.rb +++ b/app/models/submission.rb @@ -1,3 +1,24 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: submissions +# +# id :integer not null, primary key +# is_empty :boolean default(TRUE), not null +# remark_request :text +# remark_request_timestamp :datetime +# revision_identifier :text +# revision_timestamp :datetime +# submission_version :integer +# submission_version_used :boolean default(FALSE), not null +# created_at :datetime +# grouping_id :integer +# +# Indexes +# +# index_submissions_on_grouping_id (grouping_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective require 'fileutils' # FileUtils used here # Handle for getting student submissions. Actual instance depend diff --git a/app/models/submission_file.rb b/app/models/submission_file.rb index b91e31e793..8e6b0502fe 100644 --- a/app/models/submission_file.rb +++ b/app/models/submission_file.rb @@ -1,3 +1,25 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: submission_files +# +# id :integer not null, primary key +# error_converting :boolean default(FALSE), not null +# filename :string +# is_converted :boolean default(FALSE), not null +# path :string default("/"), not null +# submission_id :integer +# +# Indexes +# +# index_submission_files_on_filename (filename) +# index_submission_files_on_submission_id (submission_id) +# +# Foreign Keys +# +# fk_submission_files_submissions (submission_id => submissions.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class SubmissionFile < ApplicationRecord belongs_to :submission validates_associated :submission diff --git a/app/models/submission_rule.rb b/app/models/submission_rule.rb index d97ae27bc9..d5a056cd8a 100644 --- a/app/models/submission_rule.rb +++ b/app/models/submission_rule.rb @@ -1,3 +1,20 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: submission_rules +# +# id :integer not null, primary key +# penalty_type :string default("percentage") +# type :string default("NoLateSubmissionRule") +# created_at :datetime +# updated_at :datetime +# assessment_id :bigint not null +# +# Indexes +# +# index_submission_rules_on_assessment_id (assessment_id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class SubmissionRule < ApplicationRecord class InvalidRuleType < RuntimeError def initialize(rule_name) diff --git a/app/models/ta.rb b/app/models/ta.rb index 3ff87ec217..de473cc9a0 100644 --- a/app/models/ta.rb +++ b/app/models/ta.rb @@ -1,4 +1,35 @@ # TA user for a given course. +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: roles +# +# id :bigint not null, primary key +# grace_credits :integer default(0), not null +# hidden :boolean default(FALSE), not null +# receives_invite_emails :boolean default(FALSE), not null +# receives_results_emails :boolean default(FALSE), not null +# type :string not null +# created_at :datetime not null +# updated_at :datetime not null +# course_id :bigint not null +# section_id :bigint +# user_id :bigint not null +# +# Indexes +# +# index_roles_on_course_id (course_id) +# index_roles_on_section_id (section_id) +# index_roles_on_user_id (user_id) +# index_roles_on_user_id_and_course_id (user_id,course_id) UNIQUE +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# fk_rails_... (section_id => sections.id) +# fk_rails_... (user_id => users.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Ta < Role has_one :grader_permission, dependent: :destroy, foreign_key: :role_id, inverse_of: :ta before_create :create_grader_permission diff --git a/app/models/ta_membership.rb b/app/models/ta_membership.rb index 6befb9ce64..3fc45c23a2 100644 --- a/app/models/ta_membership.rb +++ b/app/models/ta_membership.rb @@ -1,3 +1,26 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: memberships +# +# id :integer not null, primary key +# membership_status :string +# type :string +# created_at :datetime +# updated_at :datetime +# grouping_id :integer not null +# role_id :bigint not null +# +# Indexes +# +# index_memberships_on_role_id (role_id) +# +# Foreign Keys +# +# fk_memberships_groupings (grouping_id => groupings.id) +# fk_rails_... (role_id => roles.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class TaMembership < Membership validate :must_be_a_ta @@ -6,7 +29,7 @@ class TaMembership < Membership def must_be_a_ta if role && !role.is_a?(Ta) - errors.add('base', 'User must be a ta') + errors.add(:base, :not_ta) false end end diff --git a/app/models/tag.rb b/app/models/tag.rb index 2e775b07a5..69040a2dab 100644 --- a/app/models/tag.rb +++ b/app/models/tag.rb @@ -1,3 +1,25 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: tags +# +# id :integer not null, primary key +# description :string +# name :string not null +# assessment_id :bigint +# role_id :bigint not null +# +# Indexes +# +# index_tags_on_assessment_id (assessment_id) +# index_tags_on_role_id (role_id) +# +# Foreign Keys +# +# fk_rails_... (assessment_id => assessments.id) +# fk_rails_... (role_id => roles.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class Tag < ApplicationRecord has_and_belongs_to_many :groupings belongs_to :role diff --git a/app/models/template_division.rb b/app/models/template_division.rb index 7dd94f99a2..2d18016f41 100644 --- a/app/models/template_division.rb +++ b/app/models/template_division.rb @@ -1,3 +1,27 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: template_divisions +# +# id :integer not null, primary key +# end :integer not null +# label :string not null +# start :integer not null +# created_at :datetime not null +# updated_at :datetime not null +# assignment_file_id :integer +# exam_template_id :integer +# +# Indexes +# +# index_template_divisions_on_exam_template_id (exam_template_id) +# +# Foreign Keys +# +# fk_rails_... (assignment_file_id => assignment_files.id) +# fk_rails_... (exam_template_id => exam_templates.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class TemplateDivision < ApplicationRecord belongs_to :exam_template belongs_to :assignment_file, optional: true @@ -23,7 +47,7 @@ def hash end def end_should_be_less_than_or_equal_to_num_pages - errors.add(:end, 'should be less than or equal to num_pages') unless self.end <= self.exam_template.num_pages + errors.add(:end, :more_than_num_pages) unless self.end <= self.exam_template.num_pages end def set_defaults_for_assignment_file diff --git a/app/models/test_batch.rb b/app/models/test_batch.rb index 617ecda6d4..5a1bb7d3dc 100644 --- a/app/models/test_batch.rb +++ b/app/models/test_batch.rb @@ -1,3 +1,22 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: test_batches +# +# id :integer not null, primary key +# created_at :datetime not null +# updated_at :datetime not null +# course_id :bigint not null +# +# Indexes +# +# index_test_batches_on_course_id (course_id) +# +# Foreign Keys +# +# fk_rails_... (course_id => courses.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class TestBatch < ApplicationRecord has_many :test_runs, dependent: :nullify belongs_to :course diff --git a/app/models/test_group.rb b/app/models/test_group.rb index f957d91a28..a8e228846b 100644 --- a/app/models/test_group.rb +++ b/app/models/test_group.rb @@ -1,3 +1,28 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: test_groups +# +# id :integer not null, primary key +# autotest_settings :json not null +# display_output :integer default("instructors"), not null +# name :text not null +# position :integer not null +# created_at :datetime not null +# updated_at :datetime not null +# assessment_id :bigint not null +# criterion_id :bigint +# +# Indexes +# +# index_test_groups_on_assessment_id (assessment_id) +# index_test_groups_on_criterion_id (criterion_id) +# +# Foreign Keys +# +# fk_rails_... (assessment_id => assessments.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class TestGroup < ApplicationRecord enum :display_output, { instructors: 0, instructors_and_student_tests: 1, instructors_and_students: 2 }, diff --git a/app/models/test_group_result.rb b/app/models/test_group_result.rb index 36813c39f5..a06ee6c3d3 100644 --- a/app/models/test_group_result.rb +++ b/app/models/test_group_result.rb @@ -1,3 +1,30 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: test_group_results +# +# id :integer not null, primary key +# error_type :string +# extra_info :text +# marks_earned :float default(0.0), not null +# marks_total :float default(0.0), not null +# time :bigint not null +# created_at :datetime not null +# updated_at :datetime not null +# test_group_id :integer not null +# test_run_id :integer not null +# +# Indexes +# +# index_test_group_results_on_test_group_id (test_group_id) +# index_test_group_results_on_test_run_id (test_run_id) +# +# Foreign Keys +# +# fk_rails_... (test_group_id => test_groups.id) +# fk_rails_... (test_run_id => test_runs.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class TestGroupResult < ApplicationRecord has_many :test_results, dependent: :destroy belongs_to :test_group diff --git a/app/models/test_result.rb b/app/models/test_result.rb index f2d95a03a9..c76e33e214 100644 --- a/app/models/test_result.rb +++ b/app/models/test_result.rb @@ -1,3 +1,29 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: test_results +# +# id :integer not null, primary key +# marks_earned :float default(0.0), not null +# marks_total :float default(0.0), not null +# name :text not null +# output :text default(""), not null +# position :integer not null +# status :text not null +# time :bigint +# created_at :datetime +# updated_at :datetime +# test_group_result_id :bigint not null +# +# Indexes +# +# index_test_results_on_test_group_result_id (test_group_result_id) +# +# Foreign Keys +# +# fk_rails_... (test_group_result_id => test_group_results.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class TestResult < ApplicationRecord belongs_to :test_group_result has_one :course, through: :test_group_result diff --git a/app/models/test_run.rb b/app/models/test_run.rb index 0003aa3cd8..4cc18420b0 100644 --- a/app/models/test_run.rb +++ b/app/models/test_run.rb @@ -1,3 +1,35 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: test_runs +# +# id :integer not null, primary key +# problems :text +# revision_identifier :text +# status :integer not null +# created_at :datetime not null +# updated_at :datetime not null +# autotest_test_id :integer +# grouping_id :integer not null +# role_id :bigint not null +# submission_id :integer +# test_batch_id :integer +# +# Indexes +# +# index_test_runs_on_grouping_id (grouping_id) +# index_test_runs_on_role_id (role_id) +# index_test_runs_on_submission_id (submission_id) +# index_test_runs_on_test_batch_id (test_batch_id) +# +# Foreign Keys +# +# fk_rails_... (grouping_id => groupings.id) +# fk_rails_... (role_id => roles.id) +# fk_rails_... (submission_id => submissions.id) +# fk_rails_... (test_batch_id => test_batches.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class TestRun < ApplicationRecord enum :status, { in_progress: 0, complete: 1, cancelled: 2, failed: 3 } has_many :test_group_results, dependent: :destroy @@ -243,6 +275,6 @@ def autotest_test_id_uniqueness autotest_test_id: self.autotest_test_id) .where.not(id: self.id) .exists? - errors.add(:base, 'autotest_test_id must be unique scoped to autotest settings') if other_test_runs + errors.add(:base, :invalid_test_id) if other_test_runs end end diff --git a/app/models/text_annotation.rb b/app/models/text_annotation.rb index d0f2f0bb78..0c3697ee4f 100644 --- a/app/models/text_annotation.rb +++ b/app/models/text_annotation.rb @@ -1,3 +1,42 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: annotations +# +# id :integer not null, primary key +# annotation_number :integer +# column_end :integer +# column_start :integer +# creator_type :string +# end_node :string +# end_offset :integer +# is_remark :boolean default(FALSE), not null +# line_end :integer +# line_start :integer +# page :integer +# start_node :string +# start_offset :integer +# type :string +# x1 :integer +# x2 :integer +# y1 :integer +# y2 :integer +# annotation_text_id :integer +# creator_id :integer +# result_id :integer +# submission_file_id :integer +# +# Indexes +# +# index_annotations_on_creator_type_and_creator_id (creator_type,creator_id) +# index_annotations_on_submission_file_id (submission_file_id) +# +# Foreign Keys +# +# fk_annotations_annotation_texts (annotation_text_id => annotation_texts.id) +# fk_annotations_submission_files (submission_file_id => submission_files.id) +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective class TextAnnotation < Annotation validates :line_start, presence: true, numericality: { greater_than_or_equal_to: 1 } validates :line_end, presence: true, numericality: { greater_than_or_equal_to: 1 } diff --git a/app/models/user.rb b/app/models/user.rb index f8762d1b8f..55dedb7175 100644 --- a/app/models/user.rb +++ b/app/models/user.rb @@ -1,3 +1,29 @@ +# rubocop:disable Layout/LineLength, Lint/RedundantCopDisableDirective +# == Schema Information +# +# Table name: users +# +# id :integer not null, primary key +# api_key :string +# display_name :string not null +# email :string +# first_name :string +# id_number :string +# last_name :string +# locale :string default("en"), not null +# theme :integer default("light"), not null +# time_zone :string not null +# type :string +# user_name :string not null +# created_at :datetime +# updated_at :datetime +# +# Indexes +# +# index_users_on_api_key (api_key) UNIQUE +# index_users_on_user_name (user_name) UNIQUE +# +# rubocop:enable Layout/LineLength, Lint/RedundantCopDisableDirective require 'English' require 'digest' # required for {set,reset}_api_token require 'base64' # required for {set,reset}_api_token diff --git a/app/views/assignments/_list_manage.html.erb b/app/views/assignments/_list_manage.html.erb index 20b8842bb5..83d6c5ec24 100644 --- a/app/views/assignments/_list_manage.html.erb +++ b/app/views/assignments/_list_manage.html.erb @@ -20,7 +20,7 @@ <% assignments.each do |assignment| %> <% route = { controller: 'assignments', action: action, id: assignment.id } %> <% assignment_text = "#{h(assignment.short_identifier)}: #{h(assignment.description)}" %> - <% assignment_text = t('assignments.hidden', assignment_text: assignment_text) if assignment.is_hidden %> + <% assignment_text = formatted_assessment_visibility_label(assignment, assignment_text) %> <%= link_to assignment_text, route %> diff --git a/app/views/courses/_dashboard_list.html.erb b/app/views/courses/_dashboard_list.html.erb index 5267a612ed..b6151dd0a3 100644 --- a/app/views/courses/_dashboard_list.html.erb +++ b/app/views/courses/_dashboard_list.html.erb @@ -14,19 +14,12 @@ <% @assignments.each do |assignment| -%> - <% if assignment.is_hidden %> - <%= link_to truncate(t('assignments.hidden', - assignment_text: - "#{h(assignment.short_identifier)}: #{h(assignment.description)}")), - view_summary_course_assignment_path(@current_course, assignment.id), - data: { remote: true, id: assignment.short_identifier }, - class: (assignment.id == @current_assignment.id ? "inactive" : "") %> - <% else %> - <%= link_to assignment.short_identifier + ': ' + assignment.description, - view_summary_course_assignment_path(@current_course, assignment.id), - data: { remote: true, id: assignment.short_identifier }, - class: (assignment.id == @current_assignment.id ? "inactive" : "") %> - <% end %> + <% assignment_text = formatted_assessment_visibility_label(assignment, + "#{h(assignment.short_identifier)}: #{h(assignment.description)}") %> + <%= link_to truncate(assignment_text), + view_summary_course_assignment_path(@current_course, assignment.id), + data: { remote: true, id: assignment.short_identifier }, + class: (assignment.id == @current_assignment.id ? "inactive" : "") %> diff --git a/app/views/courses/_form.html.erb b/app/views/courses/_form.html.erb index b166473b59..8f3e37fec7 100644 --- a/app/views/courses/_form.html.erb +++ b/app/views/courses/_form.html.erb @@ -56,6 +56,20 @@ <% if @current_course.persisted? && allowed_to?(:edit?, with: Admin::CoursePolicy) %> <%= t('automated_tests.manage_connection.title') %> + + <%= link_to t('automated_tests.manage_connection.refresh_schema_bottom'), + refresh_autotest_schema_admin_course_path(@current_course), + method: :post, + class: 'button', + data: { confirm: I18n.t('automated_tests.manage_connection.refresh_schema_confirm') } %> + + + <%= I18n.t('automated_tests.manage_connection.refresh_schema_tooltip', + url: @current_course.autotest_setting&.url) %> + + + + <%= link_to I18n.t('automated_tests.manage_connection.test'), test_autotest_connection_admin_course_path(@current_course), diff --git a/app/views/exam_templates/_assign_errors.js.erb b/app/views/exam_templates/_assign_errors.js.erb index 7aa7bcbc11..47fe9b3e45 100644 --- a/app/views/exam_templates/_assign_errors.js.erb +++ b/app/views/exam_templates/_assign_errors.js.erb @@ -54,7 +54,6 @@ document.addEventListener("DOMContentLoaded", function() { var pdfViewer = new pdfjsViewer.PDFViewer({ eventBus: eventBus, container: container, - renderer: 'svg' }); eventBus.on('pagesinit', function () { pdfViewer.currentScaleValue = 'page-fit'; diff --git a/app/views/groups/assign_scans.html.erb b/app/views/groups/assign_scans.html.erb index e9515c3176..6012b91442 100644 --- a/app/views/groups/assign_scans.html.erb +++ b/app/views/groups/assign_scans.html.erb @@ -49,6 +49,10 @@ $("#assign_student").find("#skip").val("1").prop('checked', false); let current_group = $("#grouping_id").val(); update_bar(data.num_valid, data.num_total); + + // Update OCR suggestions + updateOcrSuggestions(data.ocr_match, data.ocr_suggestions); + // Anytime we advance to another assignment if (data.grouping_id !== current_group) { $("#grouping_id").val(data.grouping_id); @@ -70,7 +74,6 @@ let pdfViewer = new pdfjsViewer.PDFViewer({ eventBus: eventBus, container: container, - renderer: 'svg' }); eventBus.on('pagesinit', function() { pdfViewer.currentScaleValue = 'page-fit'; @@ -134,6 +137,12 @@ <%= t('save') %> + + + + + + <%= Group.human_attribute_name(:student_memberships) %> diff --git a/app/views/layouts/_head.html.erb b/app/views/layouts/_head.html.erb index e008a807ca..8f0cc48d15 100644 --- a/app/views/layouts/_head.html.erb +++ b/app/views/layouts/_head.html.erb @@ -4,6 +4,9 @@ <%= action_cable_meta_tag %> <%= csrf_meta_tags %> <%= csp_meta_tag %> + + <%= stylesheet_link_tag 'application' %> <%= stylesheet_link_tag 'application_webpack' %> <% if @current_user&.theme == 'dark' %> diff --git a/app/views/layouts/assignment_content.html.erb b/app/views/layouts/assignment_content.html.erb index bea91b1c58..d2f753f31a 100644 --- a/app/views/layouts/assignment_content.html.erb +++ b/app/views/layouts/assignment_content.html.erb @@ -4,7 +4,6 @@ <%= render partial: 'layouts/head' %> <%= t(:markus) + ' - ' + (content_for?(:html_title) ? yield(:html_title) : controller.action_name.titleize) %> <%= javascript_include_tag 'application_webpack', nonce: true %> - <%= javascript_include_tag 'application', nonce: true %> <% unless session[:auth_type] == 'remote' %> <%= javascript_include_tag 'check_timeout', nonce: true %> <% end %> diff --git a/app/views/layouts/content.html.erb b/app/views/layouts/content.html.erb index 5a9551f033..bb268b2053 100644 --- a/app/views/layouts/content.html.erb +++ b/app/views/layouts/content.html.erb @@ -4,7 +4,6 @@ <%= render partial: 'layouts/head' %> <%= t(:markus) %> - <%= controller.action_name.titleize %> <%= javascript_include_tag 'application_webpack', nonce: true %> - <%= javascript_include_tag 'application', nonce: true %> <% unless session[:auth_type] == 'remote' %> <%= javascript_include_tag 'check_timeout', nonce: true %> <% end %> diff --git a/app/views/layouts/menus/_instructor_ta_sub_menu_assessments.html.erb b/app/views/layouts/menus/_instructor_ta_sub_menu_assessments.html.erb index 5005f99771..89f58b221b 100644 --- a/app/views/layouts/menus/_instructor_ta_sub_menu_assessments.html.erb +++ b/app/views/layouts/menus/_instructor_ta_sub_menu_assessments.html.erb @@ -11,9 +11,7 @@ <% if assessment.is_a?(Assignment) && assessment.is_peer_review? %> <% title = "#{assessment.parent_assignment.short_identifier} #{PeerReview.model_name.human}" %> <% end %> - <% if assessment.is_hidden %> - <% title = t('assignments.hidden', assignment_text: title) %> - <% end %> + <% title = formatted_assessment_visibility_label(assessment, title) %> <%= title %> <% end %> diff --git a/app/views/layouts/no_menu_header.html.erb b/app/views/layouts/no_menu_header.html.erb index 4f711ba480..d1371ca8c3 100644 --- a/app/views/layouts/no_menu_header.html.erb +++ b/app/views/layouts/no_menu_header.html.erb @@ -4,7 +4,6 @@ <%= render partial: 'layouts/head' %> <%= t(:markus) %> - <%= controller.action_name %> <%= javascript_include_tag 'application_webpack', nonce: true %> - <%= javascript_include_tag 'application', nonce: true %> <%= javascript_include_tag 'menu', nonce: true %> <% unless session[:auth_type] == 'remote' %> <%= javascript_include_tag 'check_timeout', nonce: true %> diff --git a/app/views/layouts/result_content.erb b/app/views/layouts/result_content.erb index c9018d3daa..8e71685345 100644 --- a/app/views/layouts/result_content.erb +++ b/app/views/layouts/result_content.erb @@ -4,7 +4,6 @@ <%= render partial: 'layouts/head' %> <%= t(:markus) %> - <%= controller.action_name.titleize %> <%= javascript_include_tag 'application_webpack', nonce: true %> - <%= javascript_include_tag 'application', nonce: true %> <% unless session[:auth_type] == 'remote' %> <%= javascript_include_tag 'check_timeout', nonce: true %> <% end %> diff --git a/app/views/results/common/_syntax_highlighter_brushes.html.erb b/app/views/results/common/_syntax_highlighter_brushes.html.erb deleted file mode 100644 index ab9f9746b9..0000000000 --- a/app/views/results/common/_syntax_highlighter_brushes.html.erb +++ /dev/null @@ -1,12 +0,0 @@ -<%# SOURCE CODE GLOWER AND IMAGE ANNOTATION MANAGER %> -<%= javascript_include_tag 'Annotations/globals', - 'Annotations/annotation_manager', - 'Annotations/annotation_text', - 'Annotations/annotation_text_displayer', - 'Annotations/AnnotationTextManager', - 'Annotations/source_code_line', - 'Annotations/text_annotation_manager', - 'Annotations/image_annotation_manager', - 'Annotations/pdf_annotation_manager', - 'Annotations/html_annotations', - nonce: true %> diff --git a/app/views/shared/_assignment_dropdown_link.html.erb b/app/views/shared/_assignment_dropdown_link.html.erb index 0eaa679989..1795309d6d 100644 --- a/app/views/shared/_assignment_dropdown_link.html.erb +++ b/app/views/shared/_assignment_dropdown_link.html.erb @@ -1,8 +1,6 @@ <% link_text = assignment.short_identifier %> - <% if assignment.is_hidden %> - <% link_text = t('assignments.hidden', assignment_text: link_text) %> - <% end %> + <% link_text = formatted_assessment_visibility_label(assignment, link_text) %> <%= link_to link_text, switch_course_assignment_path(@current_course, assignment.id), diff --git a/bin/dev b/bin/dev old mode 100644 new mode 100755 index 5f91c20545..52088a3810 --- a/bin/dev +++ b/bin/dev @@ -1,2 +1,2 @@ #!/usr/bin/env ruby -exec "./bin/rails", "server", *ARGV +exec './bin/rails', 'server', *ARGV diff --git a/bin/setup b/bin/setup index 8c98f8038c..da0fad87e1 100755 --- a/bin/setup +++ b/bin/setup @@ -22,6 +22,7 @@ FileUtils.chdir APP_ROOT do puts '\n== Preparing database ==' system! 'bin/rails db:prepare' + system! 'bin/rails db:reset' if ARGV.include?('--reset') puts '\n== Removing old logs and tempfiles ==' system! 'bin/rails log:clear tmp:clear' diff --git a/compose-prod.yaml b/compose-prod.yaml index b33e7ac7db..39a6af6e88 100644 --- a/compose-prod.yaml +++ b/compose-prod.yaml @@ -1,12 +1,10 @@ -version: '3.7' - services: app: &app build: context: . dockerfile: ./.dockerfiles/Dockerfile target: prod - image: markus:1.0.1 + image: markus:1.1.0 tmpfs: - /tmp stdin_open: true @@ -73,12 +71,11 @@ services: command: bundle exec rails resque:scheduler postgres: - image: postgres:14 + image: postgres:17 volumes: - postgres:/var/lib/postgresql/data environment: - POSTGRES_PASSWORD=docker # change this to something secure and/or use a secret to set this - - POSTGRES_INITDB_ARGS="-A md5" redis: image: redis:7 diff --git a/compose.yaml b/compose.yaml index 6d48f9697d..b1440c7672 100644 --- a/compose.yaml +++ b/compose.yaml @@ -4,7 +4,7 @@ services: context: . dockerfile: ./.dockerfiles/Dockerfile target: dev - image: markus-dev:1.2.0 + image: markus-dev:1.3.0 tmpfs: - /tmp stdin_open: true @@ -37,7 +37,7 @@ services: rails: &rails <<: *app - image: markus-dev-rails:1.2.0 + image: markus-dev-rails:1.3.0 entrypoint: .dockerfiles/entrypoint-dev-rails.sh command: bundle exec rails server -b 0.0.0.0 environment: @@ -72,7 +72,7 @@ services: ssh: <<: *rails - image: markus-dev-ssh:1.2.0 + image: markus-dev-ssh:1.3.0 volumes: - log:/home/markus/log - repos:/home/markus/csc108 @@ -90,7 +90,7 @@ services: resque: &resque <<: *rails - image: markus-dev-resque:1.2.0 + image: markus-dev-resque:1.3.0 command: bundle exec rails resque:work QUEUE=* TERM_CHILD=1 depends_on: - redis @@ -98,18 +98,17 @@ services: resque-scheduler: <<: *resque - image: markus-dev-resque-scheduler:1.2.0 + image: markus-dev-resque-scheduler:1.3.0 command: bundle exec rails resque:scheduler postgres: - image: postgres:14 + image: postgres:17 volumes: - postgres:/var/lib/postgresql/data - log:/root/log:cached - tmp:/app/tmp environment: - POSTGRES_PASSWORD=docker - - POSTGRES_INITDB_ARGS="-A md5" ports: - '35432:5432' @@ -122,7 +121,7 @@ services: webpack: <<: *app - image: markus-dev-webpack:1.2.0 + image: markus-dev-webpack:1.3.0 command: npm run build-dev volumes: - bundle:/bundle diff --git a/config/application.rb b/config/application.rb index 2e558d88e4..8c58eb77f1 100644 --- a/config/application.rb +++ b/config/application.rb @@ -17,7 +17,12 @@ module Markus class Application < Rails::Application # Initialize configuration defaults for originally generated Rails version - config.load_defaults 8.0 + config.load_defaults 8.1 + + # Please, add to the `ignore` list any other `lib` subdirectories that do + # not contain `.rb` files, or that should not be reloaded or eager loaded. + # Common ones are `templates`, `generators`, or `middleware`, for example. + config.autoload_lib(ignore: %w[jupyter-notebook repo tasks]) # Change the format of the cache entry. # @@ -57,16 +62,6 @@ class Application < Rails::Application # Set conservative Regexp.timeout (Rails default is 1s) Regexp.timeout = 10 - ### - # Specifies whether `to_time` methods preserve the UTC offset of their receivers or preserves the timezone. - # If set to `:zone`, `to_time` methods will use the timezone of their receivers. - # If set to `:offset`, `to_time` methods will use the UTC offset. - # If `false`, `to_time` methods will convert to the local system UTC offset instead. - # - # Pre-Rails 8 the default was :offset; Rails 8 makes the default :zone. - #++ - config.active_support.to_time_preserves_timezone = :offset - # Settings below are configurable config.time_zone = Settings.rails.time_zone diff --git a/config/dummy_lti_config.rb b/config/dummy_lti_config.rb index 7a836be33a..2b3efb8bb6 100644 --- a/config/dummy_lti_config.rb +++ b/config/dummy_lti_config.rb @@ -4,4 +4,37 @@ module LtiConfig def self.allowed_to_create_course?(lti_deployment) lti_deployment.lms_course_name.start_with? 'csc' end + + def self.get_course_name(lti_deployment, course_code) + sis_id = lti_deployment.lms_course_sourcedid + # Perfect Scenario: (CourseCode)-(Session)-(Lecture)-(Term) + # Example: LSM999Y1-Y-LEC0101-20259 + match = sis_id&.match(/^([a-zA-Z0-9]+)-([a-zA-Z])-LEC\d{4}-(\d+)$/) + if match + generated_name = "#{match[1]}#{match[2]}-#{match[3]}" + else + term_suffix = get_course_suffix(lti_deployment.lms_term_name) + generated_name = "#{course_code}-#{term_suffix}" + end + generated_name.upcase.gsub(/[^A-Z0-9\-_]+/, '-').squeeze('-').chomp('-').delete_prefix('-') + end + + def self.get_course_suffix(term_string) + clean_term = term_string.to_s.strip + return Time.current.year.to_s if clean_term.blank? + is_scs = clean_term.downcase.include?('scs') + # Regex: find 4 digits (2024) or 2 digits (24) + year_match = clean_term.match(/\d{4}|\d{2}/).to_s + month = case clean_term + when /Fall/i then '9' + when /Summer|Spring/i then '5' + when /Winter/i then '1' + end + if !year_match.empty? && month + year = year_match.length == 2 ? "20#{year_match}" : year_match + suffix = "#{year}#{month}" + return is_scs ? "SCS-#{suffix}" : suffix + end + clean_term.upcase.gsub(/[^A-Z0-9]+/, '-').chomp('-').delete_prefix('-') + end end diff --git a/config/i18n-tasks.yml b/config/i18n-tasks.yml index f710ac9718..16e1872b24 100644 --- a/config/i18n-tasks.yml +++ b/config/i18n-tasks.yml @@ -28,13 +28,6 @@ data: ## Catch-all default: # - config/locales/%{locale}.yml - # External locale data (e.g. gems). - # This data is not considered unused and is never written to. - external: - - "<%= %x[bundle show rails-i18n].chomp %>/rails/locale/%{locale}.yml" - ## Example (replace %#= with %=): - # - "<%#= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml" - ## Specify the router (see Readme for details). Valid values: conservative_router, pattern_router, or a custom class. # router: conservative_router diff --git a/config/initializers/content_security_policy.rb b/config/initializers/content_security_policy.rb index 738d50ed94..ffc888d202 100644 --- a/config/initializers/content_security_policy.rb +++ b/config/initializers/content_security_policy.rb @@ -6,23 +6,39 @@ Rails.application.configure do config.content_security_policy do |policy| - # Rails defaults: - # policy.default_src :self, :https - # policy.font_src :self, :https, :data - # policy.img_src :self, :https, :data - # policy.object_src :none - # policy.script_src :self, :https - # policy.style_src :self, :https - policy.default_src :self - policy.script_src :self, "'strict-dynamic'" + policy.font_src :self policy.form_action :self - # Safari doesn't support worker-src and defaults to child-src, blob is required because of the way Safari - # handles dynamically generated images + + # img_src is overridden in specific controller methods. Rails default: + # policy.img_src :self, :https, :data + + policy.object_src :none + policy.style_src_elem :self #
tag. - - Rules: - - Assumes existence of AnnotationText class */ -class AnnotationTextDisplayer { +export class AnnotationTextDisplayer { constructor() { // Create the div that we will display in this.display_node = document.createElement("div"); diff --git a/app/assets/javascripts/Annotations/annotation_text_manager.js b/app/javascript/common/annotations/annotation_text_manager.js similarity index 95% rename from app/assets/javascripts/Annotations/annotation_text_manager.js rename to app/javascript/common/annotations/annotation_text_manager.js index 2deda63d3c..66eb06ee1d 100644 --- a/app/assets/javascripts/Annotations/annotation_text_manager.js +++ b/app/javascript/common/annotations/annotation_text_manager.js @@ -4,7 +4,7 @@ * This class is in charge of controlling the Annotation Texts */ -class AnnotationTextManager { +export class AnnotationTextManager { constructor() { this.annotation_texts = {}; } diff --git a/app/assets/javascripts/Annotations/globals.js b/app/javascript/common/annotations/globals.js similarity index 70% rename from app/assets/javascripts/Annotations/globals.js rename to app/javascript/common/annotations/globals.js index d1cfc29a74..2ecb9e0d5b 100644 --- a/app/assets/javascripts/Annotations/globals.js +++ b/app/javascript/common/annotations/globals.js @@ -1,8 +1,8 @@ // Global variables currently used by the annotation code // TODO: remove these! -var annotation_manager = null; +window.annotation_manager = null; -var ANNOTATION_TYPES = { +window.ANNOTATION_TYPES = { CODE: 0, IMAGE: 1, PDF: 2, @@ -11,4 +11,4 @@ var ANNOTATION_TYPES = { // Enum to tell the code if an image, code, or pdf is being shown // in the codeviewer -var annotation_type; +window.annotation_type = null; diff --git a/app/assets/javascripts/Annotations/html_annotations.js b/app/javascript/common/annotations/html_annotations.js similarity index 96% rename from app/assets/javascripts/Annotations/html_annotations.js rename to app/javascript/common/annotations/html_annotations.js index 836eed637d..9c0d3a57f4 100644 --- a/app/assets/javascripts/Annotations/html_annotations.js +++ b/app/javascript/common/annotations/html_annotations.js @@ -31,7 +31,7 @@ function check_annotation_overlap(range) { ); } -function get_html_annotation_range() { +export function get_html_annotation_range() { const iframe = document.getElementById("html-content"); const target = iframe.contentDocument; const selection = target.getSelection(); diff --git a/app/assets/javascripts/Annotations/image_annotation_manager.js b/app/javascript/common/annotations/image_annotation_manager.js similarity index 98% rename from app/assets/javascripts/Annotations/image_annotation_manager.js rename to app/javascript/common/annotations/image_annotation_manager.js index b4cf57b6eb..f6a14bce02 100644 --- a/app/assets/javascripts/Annotations/image_annotation_manager.js +++ b/app/javascript/common/annotations/image_annotation_manager.js @@ -1,9 +1,11 @@ +import {AbstractAnnotationManager} from "./annotation_manager"; + /** - * AnnotationManager subclass for PDF files. + * AbstractAnnotationManager subclass for PDF files. * * @param {boolean} enable_annotations Whether annotations can be modified */ -class ImageAnnotationManager extends AnnotationManager { +export class ImageAnnotationManager extends AbstractAnnotationManager { constructor(enable_annotations) { super(); this.enable_annotations = enable_annotations; @@ -67,9 +69,9 @@ class ImageAnnotationManager extends AnnotationManager { if (holder === null) { holder = document.createElement("div"); holder.id = "annotation_holder_" + annotation_id; - holder.addClass("annotation_holder"); + holder.classList.add("annotation_holder"); if (this.annotations[annotation_id].is_remark) { - holder.addClass("remark"); + holder.classList.add("remark"); } holder.onmousemove = this.check_for_annotations.bind(this); if (this.enable_annotations) { diff --git a/app/javascript/common/annotations/pdf_annotation_manager.js b/app/javascript/common/annotations/pdf_annotation_manager.js new file mode 100644 index 0000000000..8750f1de3c --- /dev/null +++ b/app/javascript/common/annotations/pdf_annotation_manager.js @@ -0,0 +1,424 @@ +import {AbstractAnnotationManager} from "./annotation_manager"; + +// CONSTANTS +const MOUSE_OFFSET = 10; // The offset from the mouse cursor point +const HIDE_BOX_THRESHOLD = 10; // Threshold for not displaying selection box in pixels +const COORDINATE_PRECISION = 5; // Keep 5 decimal places (used when converting back from ints) +const COORDINATE_MULTIPLIER = Math.pow(10, COORDINATE_PRECISION); + +/** + * AbstractAnnotationManager subclass for PDF files. + * + * @param {boolean} enable_annotations Whether annotations can be modified + */ +export class PdfAnnotationManager extends AbstractAnnotationManager { + constructor(enable_annotations) { + // Members + super(); + this.angle = 0; // current orientation of the PDF + + this.annotationControls = {}; // DOM elements added for annotations + + /** @type {{page: int, $control: HTMLElement}} */ + this.selectionBox = {}; + + // The current selection area. The x, y are stored as percentages + // for device independent resolution + /** @type {{x: number, y: number, width: number, height: number}} */ + this.currentSelection = {}; + + // Event Handlers + if (enable_annotations) { + this.bindPageEvents(); + } + } + + /** + * Get a selection for a specific page. + * @return {{page: {int}, $control: {HTMLElement}}} + */ + getSelectionBox($page) { + let pageNumber = $page.data("page-number"); + + if ( + this.selectionBox.page === pageNumber && + this.selectionBox.$control !== null && + $.contains(document, this.selectionBox.$control) + ) { + return this.selectionBox; + } else if (this.selectionBox.$control != null) { + this.selectionBox.$control.remove(); // Remove old control + } + + let $control = document.createElement("div"); + $control.id = "sel_box"; + $control.classList.add("annotation-holder-active"); + $control.style.display = "none"; + + // append $control before the first annotation_holder but after the annotationLayer + // or else you will be prevented from deleting/editing old annotations + let $first_anno = $page.find(".annotation_holder:first")[0]; + + if (!!$first_anno) { + $first_anno.parentNode.insertBefore($control, $first_anno); + } else { + $page.append($control); + } + + this.selectionBox = { + page: pageNumber, + $control: $control, + }; + + return this.selectionBox; + } + + /** + * Update and redraw the selection box. + * + * @param {jQuery} $page The page the control is for. + * @param {{x, y, width, height, visible}} params Values to update + */ + setSelectionBox($page, params) { + if (params) { + Object.assign(this.currentSelection, params); + + let sel_box = this.getSelectionBox($page).$control; + sel_box.style.top = this.currentSelection.y * 100 + "%"; + sel_box.style.left = this.currentSelection.x * 100 + "%"; + sel_box.style.width = this.currentSelection.width * 100 + "%"; + sel_box.style.height = this.currentSelection.height * 100 + "%"; + + sel_box.style.display = this.currentSelection.visible ? "block" : "none"; + } + } + + hide_selection_box() { + this.currentSelection.visible = false; + if (this.selectionBox.$control) { + this.selectionBox.$control.style.display = "none"; + } + } + + /** + * Returns the selection box coordinates (used when creating an annotation). + * @returns {{x1, y1, x2, y2, page}} + */ + getSelection(warn_no_selection = true) { + let box = this.get_pdf_box_attrs(); + if (!box) { + if (warn_no_selection) { + alert(I18n.t("results.annotation.select_an_area_pdf")); + } + return false; + } + let page = box.page; + box = getRotatedCoords(box, 360 - annotation_manager.angle); + + return {...box, page: page}; + } + + get_pdf_box_attrs() { + let box = this.selectionRectangleAsInts(); + let boxSize = this.selectionBoxSize(); + + if (!box || boxSize.width < HIDE_BOX_THRESHOLD || boxSize.height < HIDE_BOX_THRESHOLD) { + return false; + } else { + return box; + } + } + + /** + * Return the current selection bounding rectangle if there is one, and + * converts the floating point percentages to integers. + * + * @return {{x1, y1, x2, y2, page}} Bounding box (points are in percentages) + */ + selectionRectangleAsInts() { + if (!this.currentSelection.visible) { + return null; + } + + return { + x1: parseInt(this.currentSelection.x * COORDINATE_MULTIPLIER, 10), + y1: parseInt(this.currentSelection.y * COORDINATE_MULTIPLIER, 10), + x2: parseInt( + (this.currentSelection.x + this.currentSelection.width) * COORDINATE_MULTIPLIER, + 10 + ), + y2: parseInt( + (this.currentSelection.y + this.currentSelection.height) * COORDINATE_MULTIPLIER, + 10 + ), + page: this.selectionBox.page, + }; + } + + /** + * Get the selection box size in pixels. If there is no selection box + * return {width: 0, height: 0}. + * + * @return {{width: int, height: int}} The selection box size in pixels + */ + selectionBoxSize() { + let $box = this.selectionBox.$control; + + return $box ? {width: $box.offsetWidth, height: $box.offsetHeight} : {width: 0, height: 0}; + } + + /** + * Add an annotation to the PDF. + * + * @param {string} annotation_text_id [description] + * @param {string} content [description] + * @param {{x1: int, y1: int, x2: int, y2: int, page: int}} range + * @param {string} annotation_id the id of the annotation + * @param {boolean} is_remark + */ + addAnnotation(annotation_text_id, content, range, annotation_id, is_remark) { + let annotation = super.addAnnotation( + annotation_text_id, + content, + range, + annotation_id, + is_remark + ); + + // Update display + this.renderAnnotation(annotation); + this.hide_selection_box(); + } + + /** + * Remove an annotation + * @param {string} annotation_id Annotation ID + */ + removeAnnotation(annotation_id) { + let annotation = super.removeAnnotation(annotation_id); + if (annotation === undefined) { + return; + } + this.annotationControls[annotation_id].remove(); // Delete DOM node + } + + /** + * Draw the annotation on the screen. + * + * @param {{annotation_id: string, annotation_text: Object, range: Object}} annotation + */ + renderAnnotation = function (annotation) { + let {annotation_id, annotation_text, range} = annotation; + if (this.annotationControls[annotation_id]) { + this.annotationControls[annotation_id].remove(); // Remove old controls + } + + // The coords are in the unrotated form, but the PDF may be in a different orientation. + let newCoords = getRotatedCoords(range, this.angle); + + let $control = document.createElement("div"); + $control.id = "annotation_holder_" + annotation_id; + $control.classList.add("annotation_holder"); + if (this.annotations[annotation_id].is_remark) { + $control.classList.add("remark"); + } + $control.style.top = (newCoords.y1 / COORDINATE_MULTIPLIER) * 100 + "%"; + $control.style.left = (newCoords.x1 / COORDINATE_MULTIPLIER) * 100 + "%"; + $control.style.width = ((newCoords.x2 - newCoords.x1) / COORDINATE_MULTIPLIER) * 100 + "%"; + $control.style.height = ((newCoords.y2 - newCoords.y1) / COORDINATE_MULTIPLIER) * 100 + "%"; + + let annotation_text_displayer = this.annotation_text_displayer; + $control.onmousemove = function (ev) { + let point = getRelativePointForEvent(ev, $page, -1); + + annotation_text_displayer.setDisplayNodeParent($page[0]); + annotation_text_displayer.displayCollection( + [annotation_text], + point.x * 100, + point.y * 100, + "%" + ); + }; + + $control.onmouseleave = function () { + annotation_text_displayer.hide(); + }; + + this.annotationControls[annotation_id] = $control; + + let $page = $(`.page[data-page-number=${range.page}]`); + $page.append($control); + }; + + /** + * The following two functions are used to keep track of the orientation of + * the PDF so we know how to render the annotations. + */ + rotateClockwise90() { + this.hide_selection_box(); + this.angle += 90; + if (this.angle === 360) this.angle = 0; + } + + resetAngle() { + this.angle = 0; + } + + /** + * Set event handlers for PDF annotations. + */ + bindPageEvents() { + let $pages = $(".page"); + let selectionBoxActive = false; // Is the selection box in use + + // Start of click + let start = { + x: 0, + y: 0, + }; + + // Helper: Start selection box + const startSelection = (point, $target) => { + this.setSelectionBox($target, { + x: point.x, + y: point.y, + width: 0, + height: 0, + visible: true, + }); + + start = point; + selectionBoxActive = true; + }; + + // Helper: Update selection box dimensions + const updateSelection = (point, $target) => { + if (!selectionBoxActive) { + return; + } + + this.setSelectionBox($target, { + x: Math.min(start.x, point.x), + y: Math.min(start.y, point.y), + width: Math.abs(start.x - point.x), + height: Math.abs(start.y - point.y), + }); + }; + + // Helper: End selection box + const endSelection = () => { + let size = this.selectionBoxSize(); + + // If the box is REALLY small then hide it + if (size.width < HIDE_BOX_THRESHOLD && size.height < HIDE_BOX_THRESHOLD) { + this.hide_selection_box(); + } + + selectionBoxActive = false; + }; + + // Mouse event handlers + $pages.mousedown(ev => { + if (ev.which !== 1 && ev.target.id === "sel_box") { + return; + } + + let point = getRelativePointForEvent(ev); + startSelection(point, $(ev.delegateTarget)); + }); + + $pages.mousemove(ev => { + let point = getRelativePointForEvent(ev); + updateSelection(point, $(ev.delegateTarget)); + }); + + $pages.mouseup(() => { + endSelection(); + }); + + // Touch event handlers + $pages.on("touchstart", ev => { + // Prevent default to avoid scrolling while annotating + ev.preventDefault(); + + let touch = ev.originalEvent.touches[0]; + let point = getRelativePointForEvent(touch, ev.delegateTarget, undefined); + startSelection(point, $(ev.delegateTarget)); + }); + + $pages.on("touchmove", ev => { + // Prevent default to avoid scrolling while annotating + ev.preventDefault(); + + let touch = ev.originalEvent.touches[0]; + let point = getRelativePointForEvent(touch, ev.delegateTarget, undefined); + updateSelection(point, $(ev.delegateTarget)); + }); + + $pages.on("touchend", () => { + endSelection(); + }); + } +} + +/** + * Returns the selection point in percentage units for a mouse or touch event. + * + * @param {Event|Touch} eventOrTouch The event or touch object. + * @param {String|DOMNode|jQuery} relativeTo The element to calculate the offset for. + * @param {number} mouseOffset Custom mouse offset value. + * @return {{x: number, y:number}} The relative point in the element the event occurred in. + */ +function getRelativePointForEvent(eventOrTouch, relativeTo, mouseOffset) { + let $elem = relativeTo ? $(relativeTo) : $(eventOrTouch.delegateTarget); + let offset = $elem.offset(); + + let width = $elem.width(); + let height = $elem.height(); + + let x = eventOrTouch.pageX - offset.left - (mouseOffset || MOUSE_OFFSET); + let y = eventOrTouch.pageY - offset.top - (mouseOffset || MOUSE_OFFSET); + + return { + x: 1 - (width - x) / width, + y: 1 - (height - y) / height, + }; +} + +/** + * Returns the rotated coordinates of the annotation after applying + * the rotation specified by angle. + * + * @param {{x1: int, y1: int, x2: int, y2: int, page: int}} coords + * @param {number} angle + */ +function getRotatedCoords(coords, angle) { + let newCoords = { + x1: coords.x1, + x2: coords.x2, + y1: coords.y1, + y2: coords.y2, + }; + + switch (angle) { + case 90: + newCoords.x1 = COORDINATE_MULTIPLIER - coords.y2; + newCoords.x2 = COORDINATE_MULTIPLIER - coords.y1; + newCoords.y1 = coords.x1; + newCoords.y2 = coords.x2; + break; + case 180: + newCoords.x1 = COORDINATE_MULTIPLIER - coords.x2; + newCoords.x2 = COORDINATE_MULTIPLIER - coords.x1; + newCoords.y1 = COORDINATE_MULTIPLIER - coords.y2; + newCoords.y2 = COORDINATE_MULTIPLIER - coords.y1; + break; + case 270: + newCoords.x1 = coords.y1; + newCoords.x2 = coords.y2; + newCoords.y1 = COORDINATE_MULTIPLIER - coords.x2; + newCoords.y2 = COORDINATE_MULTIPLIER - coords.x1; + break; + } + return newCoords; +} diff --git a/app/assets/javascripts/Annotations/source_code_line.js b/app/javascript/common/annotations/source_code_line.js similarity index 95% rename from app/assets/javascripts/Annotations/source_code_line.js rename to app/javascript/common/annotations/source_code_line.js index bbfb07fb8e..76b3ccffd0 100755 --- a/app/assets/javascripts/Annotations/source_code_line.js +++ b/app/javascript/common/annotations/source_code_line.js @@ -14,7 +14,7 @@ to enable unglowing with overlapping annotations. */ -class SourceCodeLine { +export class SourceCodeLine { constructor(line_node) { // line_node is the DOM element that holds a line of source code this.line_node = line_node; @@ -87,9 +87,9 @@ class SourceCodeLine { newGlowDepth = (parseInt(glowDepth, 10) + 1).toString(); } parent.setAttribute("data-annotationDepth", newGlowDepth); - parent.addClass("source-code-glowing-" + newGlowDepth); + parent.classList.add("source-code-glowing-" + newGlowDepth); if (is_remark) { - parent.addClass("remark"); + parent.classList.add("remark"); } parent.addEventListener("mouseover", hoverOnFunction); parent.addEventListener("mouseout", hoverOffFunction); @@ -131,7 +131,7 @@ class SourceCodeLine { startNode.textContent = startNode.textContent.substr(startNodeOffset); // Maintain events - if (startSpanPlain.hasClass("source-code-glowing-1")) { + if (startSpanPlain.classList.contains("source-code-glowing-1")) { startSpanPlain.addEventListener("mouseover", hoverOnFunction); startSpanPlain.addEventListener("mouseout", hoverOffFunction); } @@ -196,9 +196,9 @@ class SourceCodeLine { } spanGlow.setAttribute("data-annotationDepth", newGlowDepth); spanGlow.setAttribute("data-annotationID" + annotationId, annotationId); - spanGlow.addClass("source-code-glowing-" + newGlowDepth); + spanGlow.classList.add("source-code-glowing-" + newGlowDepth); if (is_remark) { - spanGlow.addClass("remark"); + spanGlow.classList.add("remark"); } spanGlow.addEventListener("mouseover", hoverOnFunction); spanGlow.addEventListener("mouseout", hoverOffFunction); @@ -233,7 +233,7 @@ class SourceCodeLine { let glowDepth = parseInt(parent.getAttribute("data-annotationDepth"), 10); parent.setAttribute("data-annotationDepth", (glowDepth - 1).toString()); - parent.removeClass("source-code-glowing-" + glowDepth); + parent.classList.remove("source-code-glowing-" + glowDepth); // Remove mouse listeners if no longer glowing if (glowDepth === 1) { diff --git a/app/assets/javascripts/Annotations/text_annotation_manager.js b/app/javascript/common/annotations/text_annotation_manager.js similarity index 96% rename from app/assets/javascripts/Annotations/text_annotation_manager.js rename to app/javascript/common/annotations/text_annotation_manager.js index 2a5dc6101d..b37fe57d75 100644 --- a/app/assets/javascripts/Annotations/text_annotation_manager.js +++ b/app/javascript/common/annotations/text_annotation_manager.js @@ -1,8 +1,11 @@ +import {AbstractAnnotationManager} from "./annotation_manager"; +import {SourceCodeLine} from "./source_code_line"; + /** - * AnnotationManager subclass for plaintext files. Its constructor is given a list of DOM elements + * AbstractAnnotationManager subclass for plaintext files. Its constructor is given a list of DOM elements * (one for each line of text in the file), that have been transformed through syntax highlighting. */ -class TextAnnotationManager extends AnnotationManager { +export class TextAnnotationManager extends AbstractAnnotationManager { constructor(source_nodes) { super(); diff --git a/app/javascript/common/ocr_suggestions.js b/app/javascript/common/ocr_suggestions.js new file mode 100644 index 0000000000..c4529e60b9 --- /dev/null +++ b/app/javascript/common/ocr_suggestions.js @@ -0,0 +1,70 @@ +/** + * OCR Suggestions Module + * Handles display and interaction with OCR match data and student suggestions + * Used in the assign_scans view for exam template processing + */ + +export function updateOcrSuggestions(ocrMatch, suggestions = []) { + const container = $("#ocr_suggestions"); + container.empty(); + + if (!ocrMatch) { + container.hide(); + return; + } + + container.show(); + + // internationalization + const noId = I18n.t("exam_templates.assign_scans.no_id"); + const idNumber = I18n.t("activerecord.attributes.user.id_number"); + const userName = I18n.t("activerecord.attributes.user.user_name"); + const suggestedStudents = I18n.t("exam_templates.assign_scans.suggested_students"); + const noSimilarStudents = I18n.t("exam_templates.assign_scans.no_similar_students"); + + const ocrDisplay = $("
${noSimilarStudents}
${suggestedStudents}
+ <%= I18n.t('automated_tests.manage_connection.refresh_schema_tooltip', + url: @current_course.autotest_setting&.url) %> +