Skip to content

[Feature] Habilitar para a criação de novos currículos e Universidades #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,6 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*

.eslintcache
.eslintcache

package-lock.json
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"react": "^17.0.1",
"react-dom": "^17.0.1",
"react-icons": "^4.1.0",
"react-router-dom": "^5.3.0",
"react-scripts": "4.0.1",
"typescript": "^4.0.3",
"web-vitals": "^0.2.4"
Expand Down Expand Up @@ -52,6 +53,7 @@
]
},
"devDependencies": {
"@types/react-router-dom": "^5.3.1",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Por algum motivo o yarn tá me mostrando um aviso de dependência (abaixo), pode ser um falso negativo, mas dá uma olhada se tá tudo certinho.

warning " > [email protected]" has incorrect peer dependency "eslint@^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0".

"@typescript-eslint/eslint-plugin": "^4.14.1",
"@typescript-eslint/parser": "^4.14.1",
"eslint": "^7.2.0",
Expand Down
14 changes: 14 additions & 0 deletions public/university/university.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[
{
"key": "UFPE",
"name": "Universidade Federal de Pernambuco",
"website": "",
"logo": "",
"courses": [
{
"key": "engenharia-da-computacao",
"name": "Engenharia da Computação"
}
]
}
Comment on lines +2 to +13
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

É necessário refatorar e adicionar o currículo de Ciência da Computação da UFRPE, que está em ./public/university/UFRPE/cienciaDaComputacao.json para o padrão utilizado nesse documento.

]
56 changes: 21 additions & 35 deletions src/App.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import React, { useEffect, useState } from 'react';
import React, { useEffect } from 'react';
import { Box, SimpleGrid } from '@chakra-ui/react';
import { useParams } from 'react-router-dom';

import Header from './components/Header';
import Navigator from './components/Navigator';
Expand All @@ -8,39 +9,21 @@ import StatsContainer from './components/StatsContainer';
import NextSteps from './components/NextSteps';
import Footer from './components/Footer';

import { CurriculumType } from './models/Curriculum';
import useCurriculum from './service/hook';

function App(): React.ReactElement {
const [curriculum, setCurriculum] = useState<
CurriculumType | Record<string, never>
>({});
const [academicTotalDone, setAcademicTotalDone] = useState(0);
const [academicObligatoryDone, setAcademicObligatoryDone] = useState(0);
const [academicElectiveDone, setAcademicElectiveDone] = useState(0);
type ParamsType = {
course: string;
university: string;
};

const handleClick = ({ isActive, isObligatory, hours }) => {
if (isActive) {
if (isObligatory) {
setAcademicObligatoryDone(academicObligatoryDone + hours);
} else {
setAcademicElectiveDone(academicElectiveDone + hours);
}
setAcademicTotalDone(academicTotalDone + hours);
} else {
if (isObligatory) {
setAcademicObligatoryDone(academicObligatoryDone - hours);
} else {
setAcademicElectiveDone(academicElectiveDone - hours);
}
setAcademicTotalDone(academicTotalDone - hours);
}
};
function App(): React.ReactElement {
const { loadCurriculum, curriculum, updateState, completed } =
useCurriculum();
const params = useParams<ParamsType>();

useEffect(() => {
fetch('./university/UFPE/engenhariaDaComputacao.json')
.then((response) => response.json())
.then((json) => setCurriculum(json));
}, []);
loadCurriculum(params.university, params.course);
}, [loadCurriculum, params]);

const arrayOfSemesters = Array.from(
{ length: curriculum?.semesters },
Expand All @@ -50,7 +33,10 @@ function App(): React.ReactElement {
return (
<Box m="5">
<Header />
<Navigator />
<Navigator
university={curriculum.university}
course={curriculum.course}
/>
<Box w="100%" maxH="60vh" overflow="scroll">
{arrayOfSemesters.map((semester) => (
<Box d="flex" w="100%" key={`row-${semester}`}>
Expand All @@ -60,7 +46,7 @@ function App(): React.ReactElement {
<DisciplineBox
key={item.name}
id={item.code}
onClick={handleClick}
onClick={updateState}
{...item}
/>
))}
Expand All @@ -69,9 +55,9 @@ function App(): React.ReactElement {
</Box>
<SimpleGrid columns={[1, 2]} spacing="5">
<StatsContainer
academicTotalDone={academicTotalDone}
academicObligatoryDone={academicObligatoryDone}
academicElectiveDone={academicElectiveDone}
academicTotal={completed.academicTotal}
academicObligatory={completed.academicObligatory}
academicElective={completed.academicElective}
totalHours={curriculum?.totalHours}
totalHoursObligatory={curriculum?.totalHoursObligatory}
totalHoursElective={curriculum?.totalHoursElective}
Expand Down
16 changes: 13 additions & 3 deletions src/components/Navigator/index.tsx
Original file line number Diff line number Diff line change
@@ -1,16 +1,26 @@
/* eslint-disable react/require-default-props */
import React from 'react';

import { Breadcrumb, BreadcrumbItem, BreadcrumbLink } from '@chakra-ui/react';

const Navigator = (): React.ReactElement => {
type NavigatorProps = {
university?: string;
course?: string;
};

const Navigator = ({
university,
course,
}: NavigatorProps): React.ReactElement => {
if (!university && !course) return <></>;
return (
<Breadcrumb size="20" m="3" separator="/">
<BreadcrumbItem>
<BreadcrumbLink href="#">UFPE</BreadcrumbLink>
<BreadcrumbLink href="#">{university}</BreadcrumbLink>
</BreadcrumbItem>
<BreadcrumbItem>
<BreadcrumbLink href="#" isCurrentPage>
Engenharia da Computação
{course}
</BreadcrumbLink>
</BreadcrumbItem>
</Breadcrumb>
Expand Down
22 changes: 9 additions & 13 deletions src/components/StatsContainer/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ import { Stack, Heading, Box } from '@chakra-ui/react';
import StatsHours from '../StatsHours';

type StatsContainerProps = {
academicTotalDone: number;
academicObligatoryDone: number;
academicElectiveDone: number;
academicTotal: number;
academicObligatory: number;
academicElective: number;
totalHours: number;
totalHoursObligatory: number;
totalHoursElective: number;
};

const StatsContainer = ({
academicTotalDone,
academicObligatoryDone,
academicElectiveDone,
academicTotal,
academicObligatory,
academicElective,
totalHours,
totalHoursObligatory,
totalHoursElective,
Expand All @@ -26,19 +26,15 @@ const StatsContainer = ({
Aproveitamento Acadêmico
</Heading>
<Box w="100%" d="flex" flexWrap="wrap">
<StatsHours
title="Total"
partial={academicTotalDone}
total={totalHours}
/>
<StatsHours title="Total" partial={academicTotal} total={totalHours} />
<StatsHours
title="Obrigatória"
partial={academicObligatoryDone}
partial={academicObligatory}
total={totalHoursObligatory}
/>
<StatsHours
title="Eletivas"
partial={academicElectiveDone}
partial={academicElective}
total={totalHoursElective}
/>
</Box>
Expand Down
7 changes: 6 additions & 1 deletion src/index.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import React from 'react';
import ReactDOM from 'react-dom';
import { BrowserRouter as Router, Switch, Route } from 'react-router-dom';
import { ChakraProvider, CSSReset, ColorModeScript } from '@chakra-ui/react';

import App from './App';
Expand All @@ -10,7 +11,11 @@ ReactDOM.render(
<ChakraProvider>
<CSSReset />
<ColorModeScript />
<App />
<Router>
<Switch>
<Route path="/:university/:course" component={App} />
</Switch>
</Router>
</ChakraProvider>
</React.StrictMode>,
document.getElementById('root')
Expand Down
59 changes: 59 additions & 0 deletions src/service/hook.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
import { useCallback, useMemo, useState, useEffect } from 'react';
import { useRouteMatch } from 'react-router-dom';

import { CurriculumType } from '../models/Curriculum';
import Service from './service';

export default function useCurriculum() {
const { params } = useRouteMatch<{ university: string; course: string }>();

const [curriculum, setCurriculum] = useState<
CurriculumType | Record<string, never>
>({});
const [academicTotal, setAcademicTotal] = useState(0);
const [academicObligatory, setAcademicObligatory] = useState(0);
const [academicElective, setAcademicElective] = useState(0);
const service = useMemo(() => new Service(), []);

useEffect(() => {
service.setCurrent(params.university, params.course);
}, [params, service]);

const updateState = ({ isActive, isObligatory, hours }): void => {
if (isActive) {
if (isObligatory) {
setAcademicObligatory(academicObligatory + hours);
} else {
setAcademicElective(academicElective + hours);
}
setAcademicTotal(academicTotal + hours);
} else {
if (isObligatory) {
setAcademicObligatory(academicObligatory - hours);
} else {
setAcademicElective(academicElective - hours);
}
setAcademicTotal(academicTotal - hours);
}
};

const loadCurriculum = useCallback(
async (university: string, course: string) => {
const data = await service.loadCurriculum(university, course);
setCurriculum(data);
},
[service]
);

return {
curriculum,
updateState,
loadCurriculum,
completed: {
academicTotal,
academicElective,
academicObligatory,
},
};
}
28 changes: 28 additions & 0 deletions src/service/service.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/* eslint-disable no-console */
/* eslint-disable class-methods-use-this */

import { CurriculumType } from '../models/Curriculum';

export default class Service {
currentUniversity = '';

currentCourse = '';

setCurrent(university: string, course: string): void {
this.currentUniversity = university;
this.currentCourse = course;
}

async loadCurriculum(
university: string,
course: string
): Promise<CurriculumType | Record<string, never>> {
try {
const response = await fetch(`/university/${university}/${course}.json`);
return await (response.json() as Promise<CurriculumType>);
} catch (err) {
console.error(err);
return {};
}
}
}
Loading