diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..18c9147 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..13e51a6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,173 @@ +# Primeiros passos - BACKEND + +**Antes de começar a contribuir de fato, veja o guia [Ambiente de Desenvolvimento](https://unb-mds.github.io/2024-1-EducaMinas-frontend/environment/) para configurá-lo corretamente.** + +--- + +Guia para o [**Repositório backend**](https://github.com/unb-mds/2024-1-EducaMinas-backend). + +Você pode contribuir com o **EducaMinas** de duas formas: **Relatando um problema** e **Implementando uma funcionalidade**. + +## **Relatando um problema** + +- Para relatar poblemas no código, abra uma nova issue em nosso [**repositório backend**](https://github.com/unb-mds/2024-1-EducaMinas-backend) no GitHub, com o template **Bug report** e com o _label_ de `bug`. +- Verifique se já existe alguma issue que reporte o problema encontrado. +- Preencha as informações solicitadas pelo template. +- Para relatar problemas na documentação, siga os mesmos passos acima, adicionando o _label_ de `docs`. + +--- + +## **Implementando uma funcionalidade** + +Verifique as [**issues do backend**](https://github.com/unb-mds/2024-1-EducaMinas-backend/issues) abertas para encontrar alguma tarefa a ser realizada. + +### **Clonar o Repositório** + +Para clonar o repositório em um diretório de sua máquina, abra o terminal e execute: + +```bash +git clone https://github.com/unb-mds/2024-1-EducaMinas-backend.git +``` + +### **Instalar dependências** + +#### **Express/API** + +Navegue até o diretório raiz do repositório clonado: + +```bash +cd 2024-1-EducaMinas-backend +``` +Em seguida instale as dependências do EducaMinas: + +```bash +npm install +``` + +#### **Scraper** + +Navegue até o diretório `WebScrapper`: + +```bash +cd WebScrapper +``` +Crie um ambiente virtual com conda: + +```bash +conda create --name +``` + +Ative o ambiente criado: + +```bash +conda activate +``` + +Instale as dependências e bibliotecas dentro do ambiente virtual: + +```bash +conda install --yes --file requirements.txt +``` + +O script ETL acessa o banco de dados por meio de um `.env` encontrado no caminho +`WebScrapper/DataETL/.env`. A sua estrutura está escrita abaixo: + +```bash +DATABASE_USERNAME= +DATABASE_PASSWORD= +DATABASE_NAME= +DATABASE_PORT= +DATABASE_HOST= +``` + + +### **Criar uma nova Branch** + +A partir da branch padrão develop, crie uma nova branch para trabalhar nas modificações, executando: + +```bash +git checkout -b feature/nome-da-issue +``` + +Faça as alterações para implementar a tarefa. + +### **Executando** + +#### **Express/API** + +Para executar a aplicação Express em sua máquina, execute no diretório raiz: + +```bash +npm run start +``` +O servidor será inicializado e estará disponível na porta 3001 do localhost: + +```bash +http://localhost:3001/ +``` + +Demais comandos para execução de testes, builds e linter podem ser encontrados na guia _scripts_ do arquivo `package.json` na pasta raiz. + +Com a api rodando localmente é possível acessar sua documentação e testá-la no **Swagger**, basta acessar: + +```bash +http://localhost:3001/api-docs +``` + +#### **Scraper** + +Com o ambiente ativado como instruído acima, para extrair os dados do Oracle Data com o selenium execute: + +```bash +DataScraper/InepScrapper.py +``` + +#### **ETL** + +Para tratar e carregar os dados extraídos, em modo debugger, acesse `WebScrapper/DataETL`, lembre-se de selecionar o ambiente conda que foi criado, e então para rodar o programa por partes, execute: + +```bash +ETLDebugger.ipynb +``` + +Se preferir, e não precisar/quiser rodar em modo debugger(por partes), execute o código para produção: + +```bash +python3 WebSrapper/DataETL/main.py +``` + +## **Commitar mudanças** + +Adicione as alterações feitas: + +```bash +git add nome-dos-arquivos-alterados +``` + +Commite as alterações seguindo o padrão das [**Conventional Commits**](https://www.conventionalcommits.org/en/v1.0.0/), com a seguinte estrutura: + +```bash +git commit -m "tipo(#idIssue): descrição" +``` + +## **Abrir um Pull Request** + +Após fazer seus commits, empurre a branch para o repositório remoto: + +```bash +git push origin nome-da-sua-branch +``` + +No GitHub, abra um Pull Request, e preencha o **template** disponível para descrever suas implementações. + +## **Revisão e Merge** + +O **EducaMinas** conta com três validações padrão para os Pull Requests. Assim, é necessário atendê-las para que sua solicitação seja considerada: + +- **Qualidade:** São executados os testes, linter e build para validação básica da qualidade do código. +- **Cobertura:** A cobertura dos testes é comparada com a cobertura atual, e não deve ser menor. +- **Review:** Para aprovação, é necessário que ao menos um desenvolvedor faça o code review. + +Após a aprovação, o Pull Request será mergeado e suas implementações serão incorporadas ao **EducaMinas**! + +--- diff --git a/README.md b/README.md index 770266e..d3b3adb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,236 @@ -# 2024-1-Squad05 +# [EducaMinas](https://educaminas.vercel.app/) [![codecov](https://codecov.io/gh/unb-mds/2024-1-EducaMinas-backend/graph/badge.svg?token=RL1Q0kz1Ay)](https://codecov.io/gh/unb-mds/2024-1-EducaMinas-backend) -## Equipe +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE) +[![GitHub issues](https://img.shields.io/github/issues/unb-mds/2024-1-EducaMinas-backend)](https://img.shields.io/github/issues/unb-mds/2024-1-EducaMinas-backend) +[![GitHub contributors](https://img.shields.io/github/contributors/unb-mds/2024-1-EducaMinas-backend)](https://img.shields.io/github/contributors/unb-mds/2024-1-EducaMinas-backend) + +--- + +
+ +
+ + +--- + +Para melhor divisão e organização, o EducaMinas está dividido em dois repositórios. + +Você está no **Backend**. Acesse também: + +- [📊 **Frontend**](https://github.com/unb-mds/2024-1-EducaMinas-frontend) + +--- + +O [EducaMinas](https://educaminas.vercel.app/) é um projeto desenvolvido na disciplina Métodos de Desenvolvimento de Software (MDS) ofertada no curso de Engenharia de Software na Universidade de Brasília (UnB), que visa reunir em um único local dados sobre a educação no estado de Minas Gerais, utilizando informações extraídas da pesquisa educacional realizada pelo INEP. A plataforma permite diferentes interpretações dos dados, com ênfase no aspecto social do ensino mineiro. + +O projeto é um software livre e está sob a licença [MIT](./LICENSE). + +--- + +## 🗒️ Sumário + +- [🚩 EducaMinas](#educaminas) + - [🗒️ Sumário](#-sumário) + - [🏁 Início](#-início) + - [🏞️ Ambiente e Pré-requisitos](#️-ambiente-e-pré-requisitos) + - [📲 Instalação](#-instalação) + - [⚙️ Execução](#️-execução) + - [🛠️ Guia de contribuição](#️-guia-de-contribuição) + - [📒 Documentação e muito mais!](#-documentação-e-muito-mais) + - [🏛️ Arquitetura](#️-arquitetura) + - [📆 Board](#-board) + - [🖼️ Protótipo](#-protótipo) + - [🧑🏽‍💻 Desenvolvedores](#-desenvolvedores) + +--- + +## 🏁 Início + +Siga os passos abaixo para executar o **backend** do [**EducaMinas**](https://educaminas.vercel.app/): + +### 🏞️ Ambiente e Pré-requisitos + +Para rodar o projeto é fundamental ter algumas dependências globais: + +- Node +- Miniconda/Python + +Para visualizar versões, links e as instruções completas de configuração do ambiente: [**Ambiente e Pré-requisitos**](https://unb-mds.github.io/2024-1-EducaMinas-frontend/environment/) + + +### 📲 Instalação + +Após configurar o [**Ambiente e Pré-requisitos**](https://unb-mds.github.io/2024-1-EducaMinas-frontend/environment/), em um diretório de sua máquina, abra o terminal e execute: + +```bash +git clone https://github.com/unb-mds/2024-1-EducaMinas-backend.git +``` + +Com o repositório do backend devidamente clonado, você terá acesso à aplicação **Express** e ao **Scraper**: + +#### **Express/API** + +Navegue até o diretório raiz do repositório clonado: + +```bash +cd 2024-1-EducaMinas-backend +``` +Em seguida instale as dependências do EducaMinas: + +```bash +npm install +``` + +#### **Scraper** + +Navegue até o diretório `WebScrapper`: + +```bash +cd WebScrapper +``` +Crie um ambiente virtual com conda: + +```bash +conda create --name +``` + +Ative o ambiente criado: + +```bash +conda activate +``` + +Instale as dependências e bibliotecas dentro do ambiente virtual: + +```bash +conda install --yes --file requirements.txt +``` + +O script ETL acessa o banco de dados por meio de um `.env` encontrado no caminho +`WebScrapper/DataETL/.env`. A sua estrutura está escrita abaixo: + +```bash +DATABASE_USERNAME= +DATABASE_PASSWORD= +DATABASE_NAME= +DATABASE_PORT= +DATABASE_HOST= +``` + + +### ⚙️ Execução + +#### **Express/API** + +Para executar a aplicação Express em sua máquina, execute no diretório raiz: + +```bash +npm run start +``` +O servidor será inicializado e estará disponível na porta 3001 do localhost: + +```bash +http://localhost:3001/ +``` + +Demais comandos para execução de testes, builds e linter podem ser encontrados na guia _scripts_ do arquivo `package.json` na pasta raiz. + +Com a api rodando localmente é possível acessar sua documentação e testá-la no **Swagger**, basta acessar: + +```bash +http://localhost:3001/api-docs +``` + +#### **Scraper** + +Com o ambiente ativado como instruído acima, para extrair os dados do Oracle Data com o selenium execute: + +```bash +DataScraper/InepScrapper.py +``` + +#### **ETL** + +Para tratar e carregar os dados extraídos, em modo debugger, acesse `WebScrapper/DataETL`, lembre-se de selecionar o ambiente conda que foi criado, e então para rodar o programa por partes, execute: + +```bash +ETLDebugger.ipynb +``` + +Se preferir, e não precisar/quiser rodar em modo debugger(por partes), execute o código para produção: + +```bash +python3 WebSrapper/DataETL/main.py +``` + +--- + +## 🛠️ Guia de contribuição + +**Para acessar o guia completo de contribuição**: [**Guia de Contribuição**](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-frontend/) + +Nele, você encontra as respostas para as seguintes questões: + +- [Relatar um problema](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-frontend/) +- [Implementar uma funcionalidade](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-frontend/): + - [Clone](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-frontend/) + - [Dependências](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-frontend/) + - [Branches](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-frontend/) + - [Execução](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-frontend/) + - [Commits](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-frontend/) + - [Pull Requests](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-frontend/) + - [Revisão e Merge](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-frontend/) + +--- + +## 📒 Documentação e muito mais! + +**Para acessar a documentação completa**: [**Documentação EducaMinas**](https://unb-mds.github.io/2024-1-EducaMinas-frontend/) + +Nela, você encontra os seguintes tópicos: + +- [Início](https://unb-mds.github.io/2024-1-EducaMinas-frontend/) +- [Sprints](https://unb-mds.github.io/2024-1-EducaMinas-frontend/sprints/sprint-0/) +- [Projeto](https://unb-mds.github.io/2024-1-EducaMinas-frontend/project/personas/): + - [Personas](https://unb-mds.github.io/2024-1-EducaMinas-frontend/project/personas/) + - [StoryMap](https://unb-mds.github.io/2024-1-EducaMinas-frontend/project/storymap/) + - [Requisitos](https://unb-mds.github.io/2024-1-EducaMinas-frontend/project/requirements/) + - [EAP](https://unb-mds.github.io/2024-1-EducaMinas-frontend/project/eap/) + - [API](https://unb-mds.github.io/2024-1-EducaMinas-frontend/project/servicos/) + - [Arquitetura e Tecnologias](https://unb-mds.github.io/2024-1-EducaMinas-frontend/project/arquitetura/) + - [Protótipo](https://unb-mds.github.io/2024-1-EducaMinas-frontend/project/prototipo/) +- [Como contribuir](https://unb-mds.github.io/2024-1-EducaMinas-frontend/environment/): + - [Ambiente de desenvolvimento](https://unb-mds.github.io/2024-1-EducaMinas-frontend/environment/) + - [Primeiros passos - frotend](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-frontend/) + - [Primeiros passos - backend](https://unb-mds.github.io/2024-1-EducaMinas-frontend/contributing-backend/) +- [Sobre](https://unb-mds.github.io/2024-1-EducaMinas-frontend/about/) + +--- + +## 🏛️ Arquitetura + +Confira a visualização geral da arquitetura do [**EducaMinas**](https://educaminas.vercel.app): + +
+ +
+ +--- + +## 📆 Board + +Acesse nosso [**Board no GitHub**](https://github.com/orgs/unb-mds/projects/22/views/2) e acompanhe o desenvolvimento dos dois repositórios simultâneamente: [**Board EducaMinas**](https://github.com/orgs/unb-mds/projects/22/views/2) + +--- + +## 🖼️ Protótipo + +Visualize nosso protótipo diretamente no FIGMA: [**Protótipo EducaMinas**](https://www.figma.com/proto/S3GrGX5HUojoKvHAnFNiXy/EducaMinas?type=design&node-id=1-3&t=5Cn41AoersmZdQp3-0&scaling=scale-down&page-id=0%3A1) + +--- + +## 🧑🏽‍💻 Desenvolvedores
@@ -19,7 +248,7 @@ -
- +
João Pedro
 @@ -43,6 +272,5 @@
Daniel Ferreira
diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..034e848 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,21 @@ +# Security Policy + +## Supported Versions + +Use this section to tell people about which versions of your project are +currently being supported with security updates. + +| Version | Supported | +| ------- | ------------------ | +| 5.1.x | :white_check_mark: | +| 5.0.x | :x: | +| 4.0.x | :white_check_mark: | +| < 4.0 | :x: | + +## Reporting a Vulnerability + +Use this section to tell people how to report a vulnerability. + +Tell them where to go, how often they can expect to get an update on a +reported vulnerability, what to expect if the vulnerability is accepted or +declined, etc. diff --git a/api/src/controllers/indicatorController.ts b/api/src/controllers/indicatorController.ts index afdc45e..eb2eed1 100644 --- a/api/src/controllers/indicatorController.ts +++ b/api/src/controllers/indicatorController.ts @@ -1,35 +1,32 @@ import { Request, Response } from 'express'; +import { IndicadoresRepositoryPSQL } from '../database/psql/indicadoresRepositoryPSQL'; +import { IndicadoresService } from '../services/indicadoresServices'; export const IndicatorController = async (req: Request, res: Response) => { - const { municipio, etapa, indicador, rede } = req.query; - console.log( - `Indicador Município: ${municipio} - Etapa: ${etapa} - Indicador: ${indicador} - Rede: ${rede}`, - ); + try { + const { indicador, etapa, municipio } = req.query; - const response = { - categories: [2019, 2020, 2021, 2022, 2023], - series: [ - { - name: 'Brancos', - data: [ - Math.floor(Math.random() * 10001), - Math.floor(Math.random() * 10001), - Math.floor(Math.random() * 10001), - Math.floor(Math.random() * 10001), - Math.floor(Math.random() * 10001), - ], - }, - { - name: 'Pretos/Pardos', - data: [ - Math.floor(Math.random() * 10001), - Math.floor(Math.random() * 10001), - Math.floor(Math.random() * 10001), - Math.floor(Math.random() * 10001), - Math.floor(Math.random() * 10001), - ], - }, - ], - }; - res.json(response); + if ( + typeof indicador !== 'string' || + typeof etapa !== 'string' || + typeof municipio !== 'string' + ) { + return res + .status(400) + .json({ message: 'Indicador, Etapa ou Município inválidos.' }); + } + if (!indicador || !etapa || !municipio) { + return res + .status(400) + .json({ message: 'Indicador, Etapa e Município são obrigatórios.' }); + } + + const service = new IndicadoresService(new IndicadoresRepositoryPSQL()); + const result = await service.execute({ indicador, etapa, municipio }); + + res.json(result); + } catch (error) { + console.error('Erro ao processar a solicitação:', error); + res.status(400).json({ message: (error as any).message }); + } }; diff --git a/api/src/controllers/rankingController.ts b/api/src/controllers/rankingController.ts index 2333082..e818fc0 100644 --- a/api/src/controllers/rankingController.ts +++ b/api/src/controllers/rankingController.ts @@ -1,41 +1,24 @@ import { Request, Response } from 'express'; +import { RankingRepositoryPSQL } from '../database/psql/rankingRepositoryPSQL'; +import { RankingService } from '../services/rankingServices'; export const RankingController = async (req: Request, res: Response) => { - const { ano, etapa } = req.query; - console.log(`Ranking Ano: ${ano} - Etapa: ${etapa}`); + try { + const { ano, etapa } = req.query; - const response = [ - { name: 'Belo Horizonte', value: Math.floor(Math.random() * 101) }, - { name: 'Patos de Minas', value: Math.floor(Math.random() * 101) }, - { name: 'Uberlândia', value: Math.floor(Math.random() * 101) }, - { name: 'Santana de Cataguases', value: Math.floor(Math.random() * 101) }, - { name: 'Tiros', value: Math.floor(Math.random() * 101) }, - { name: 'Uberaba', value: Math.floor(Math.random() * 101) }, - { name: 'Vargem Bonita', value: Math.floor(Math.random() * 101) }, - { name: 'Governador Valadares', value: Math.floor(Math.random() * 101) }, - { name: 'São João del Rei', value: Math.floor(Math.random() * 101) }, - { name: 'Borda da Mata', value: Math.floor(Math.random() * 101) }, - { name: 'Brumadinho', value: Math.floor(Math.random() * 101) }, - { name: 'Extrema', value: Math.floor(Math.random() * 101) }, - { name: 'Barra Longa', value: Math.floor(Math.random() * 101) }, - { name: 'Barroso', value: Math.floor(Math.random() * 101) }, - { name: 'Cambuí', value: Math.floor(Math.random() * 101) }, - { name: 'Cambuquira', value: Math.floor(Math.random() * 101) }, - { name: 'Campanha', value: Math.floor(Math.random() * 101) }, - { name: 'Caraí', value: Math.floor(Math.random() * 101) }, - { name: 'Engenheiro Caldas', value: Math.floor(Math.random() * 101) }, - { name: 'Entre Folhas', value: Math.floor(Math.random() * 101) }, - { name: 'Felixlândia', value: Math.floor(Math.random() * 101) }, - { name: 'Fernandes Tourinho', value: Math.floor(Math.random() * 101) }, - { name: 'Guarani', value: Math.floor(Math.random() * 101) }, - { name: 'Igarapé', value: Math.floor(Math.random() * 101) }, - { name: 'Ipiaçu', value: Math.floor(Math.random() * 101) }, - { name: 'Jacutinga', value: Math.floor(Math.random() * 101) }, - { name: 'Luisburgo', value: Math.floor(Math.random() * 101) }, - { name: 'Medina', value: Math.floor(Math.random() * 101) }, - { name: 'Lassance', value: Math.floor(Math.random() * 101) }, - { name: 'Passabém', value: Math.floor(Math.random() * 101) }, - ]; + if (typeof ano !== 'string' || typeof etapa !== 'string') { + return res.status(400).json({ message: 'Ano, Etapa ou Ordem inválidos.' }); + } + if (!ano || !etapa) { + return res.status(400).json({ message: 'Ano, Etapa e Ordem são obrigatórios.' }); + } - res.json(response); + const service = new RankingService(new RankingRepositoryPSQL()); + const result = await service.execute({ ano: parseInt(ano), etapa }); + + res.json(result); + } catch (error) { + console.error('Erro ao processar a solicitação:', error); + res.status(400).json({ message: (error as any).message }); + } }; diff --git a/api/src/database/memory/data/indicadoresMemoryData.ts b/api/src/database/memory/data/indicadoresMemoryData.ts index b6bc716..ee186ef 100644 --- a/api/src/database/memory/data/indicadoresMemoryData.ts +++ b/api/src/database/memory/data/indicadoresMemoryData.ts @@ -1,267 +1,182 @@ export const genericData = [ - { - ano: 2019, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Brancos', - rede: 'Pública', - valor: 10, - municipio: 'Patos de Minas', - }, - - { - ano: 2019, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Pretos', - rede: 'Pública', - valor: 33, - municipio: 'Patos de Minas', - }, - { ano: 2020, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Brancos', - rede: 'Pública', - valor: 11, - municipio: 'Patos de Minas', + rede: 'Estadual', + etapa: 'EF2', + taxa_de_aprovacao: 96.8, + taxa_de_reprovacao: 0.2, + taxa_de_abandono: 3, + municipio: 3101102, }, - { ano: 2020, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Pretos', - rede: 'Pública', - valor: 36, - municipio: 'Patos de Minas', + rede: 'Municipal', + etapa: 'EF2', + taxa_de_aprovacao: 99.8, + taxa_de_reprovacao: 0, + taxa_de_abandono: 0.2, + municipio: 3101102, }, - { ano: 2020, - etapa: 'Ensino Médio', - indicador: 'Evasão', - raca: 'Pretos', - rede: 'Pública', - valor: 5, - municipio: 'Buritizeiro', + rede: 'Privada', + etapa: 'EF2', + taxa_de_aprovacao: 100, + taxa_de_reprovacao: 0, + taxa_de_abandono: 0, + municipio: 3101102, }, -]; - -export const disorderedData = [ { ano: 2020, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Pretos', - rede: 'Pública', - valor: 22, - municipio: 'Patos de Minas', - }, - - { - ano: 2019, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Brancos', rede: 'Pública', - valor: 33, - municipio: 'Patos de Minas', + etapa: 'EF2', + taxa_de_aprovacao: 97.9, + taxa_de_reprovacao: 0.2, + taxa_de_abandono: 1.9, + municipio: 3101102, }, - { ano: 2020, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Brancos', - rede: 'Privada', - valor: 55, - municipio: 'Patos de Minas', - }, - - { - ano: 2019, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Brancos', - rede: 'Privada', - valor: 10, - municipio: 'Patos de Minas', + rede: 'Total', + etapa: 'EF2', + taxa_de_aprovacao: 98, + taxa_de_reprovacao: 0.1, + taxa_de_abandono: 1.9, + municipio: 3101102, }, - { - ano: 2020, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Brancos', - rede: 'Pública', - valor: 44, - municipio: 'Patos de Minas', + ano: 2021, + rede: 'Estadual', + etapa: 'EF2', + taxa_de_aprovacao: 95.9, + taxa_de_reprovacao: 1.5, + taxa_de_abandono: 2.6, + municipio: 3101102, }, - { - ano: 2019, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Pretos', - rede: 'Pública', - valor: 50, - municipio: 'Patos de Minas', + ano: 2021, + rede: 'Municipal', + etapa: 'EF2', + taxa_de_aprovacao: 100, + taxa_de_reprovacao: 0, + taxa_de_abandono: 0, + municipio: 3101102, }, - { - ano: 2020, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Pretos', + ano: 2021, rede: 'Privada', - valor: 7, - municipio: 'Patos de Minas', + etapa: 'EF2', + taxa_de_aprovacao: 99, + taxa_de_reprovacao: 1, + taxa_de_abandono: 0, + municipio: 3101102, }, - { - ano: 2019, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - raca: 'Pretos', - rede: 'Privada', - valor: 26, - municipio: 'Patos de Minas', - }, -]; - -export const incompleteData = [ - { - ano: 2019, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - valor: 26, - municipio: 'Patos de Minas', - raca: 'Pretos', + ano: 2021, rede: 'Pública', + etapa: 'EF2', + taxa_de_aprovacao: 97.3, + taxa_de_reprovacao: 1, + taxa_de_abandono: 1.7, + municipio: 3101102, }, - { - ano: 2020, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - valor: 44, - municipio: 'Patos de Minas', - raca: 'Brancos', - rede: 'Privada', + ano: 2021, + rede: 'Total', + etapa: 'EF2', + taxa_de_aprovacao: 97.5, + taxa_de_reprovacao: 1, + taxa_de_abandono: 1.5, + municipio: 3101102, }, - { - ano: 2020, - etapa: 'Ensino Médio', - indicador: 'Reprovação', - valor: 39, - municipio: 'Patos de Minas', - raca: 'Brancos', - rede: 'Pública', + ano: 2022, + rede: 'Estadual', + etapa: 'EF2', + taxa_de_aprovacao: 90.3, + taxa_de_reprovacao: 6.7, + taxa_de_abandono: 3, + municipio: 3101102, }, -]; - -export const perfectData = [ { - ano: 2019, - indicador: 'Reprovação', - raca: 'Pretos', - rede: 'Pública', - etapa: 'Ensino Médio', - valor: 26, - municipio: 'Patos de Minas', + ano: 2022, + rede: 'Municipal', + etapa: 'EF2', + taxa_de_aprovacao: 98.3, + taxa_de_reprovacao: 1.2, + taxa_de_abandono: 0.5, + municipio: 3101102, }, { - ano: 2019, - indicador: 'Reprovação', - raca: 'Brancos', + ano: 2022, rede: 'Privada', - etapa: 'Ensino Médio', - valor: 44, - municipio: 'Patos de Minas', + etapa: 'EF2', + taxa_de_aprovacao: 100, + taxa_de_reprovacao: 0, + taxa_de_abandono: 0, + municipio: 3101102, }, { - ano: 2019, - indicador: 'Reprovação', - raca: 'Brancos', + ano: 2022, rede: 'Pública', - etapa: 'Ensino Médio', - valor: 39, - municipio: 'Patos de Minas', + etapa: 'EF2', + taxa_de_aprovacao: 93, + taxa_de_reprovacao: 4.8, + taxa_de_abandono: 2.2, + municipio: 3101102, }, { - ano: 2020, - indicador: 'Reprovação', - raca: 'Pretos', - rede: 'Pública', - etapa: 'Ensino Médio', - valor: 22, - municipio: 'Patos de Minas', + ano: 2022, + rede: 'Total', + etapa: 'EF2', + taxa_de_aprovacao: 93.4, + taxa_de_reprovacao: 4.5, + taxa_de_abandono: 2.1, + municipio: 3101102, }, { - ano: 2020, - indicador: 'Reprovação', - raca: 'Brancos', - rede: 'Privada', - etapa: 'Ensino Médio', - valor: 55, - municipio: 'Patos de Minas', + ano: 2023, + rede: 'Estadual', + etapa: 'EF2', + taxa_de_aprovacao: 92.7, + taxa_de_reprovacao: 5.9, + taxa_de_abandono: 1.4, + municipio: 3101102, }, { - ano: 2020, - indicador: 'Reprovação', - raca: 'Brancos', - rede: 'Pública', - etapa: 'Ensino Médio', - valor: 44, - municipio: 'Patos de Minas', + ano: 2023, + rede: 'Municipal', + etapa: 'EF2', + taxa_de_aprovacao: 99.5, + taxa_de_reprovacao: 0.3, + taxa_de_abandono: 0.2, + municipio: 3101102, }, { - ano: 2020, - indicador: 'Reprovação', - raca: 'Pretos', + ano: 2023, rede: 'Privada', - etapa: 'Ensino Médio', - valor: 7, - municipio: 'Patos de Minas', + etapa: 'EF2', + taxa_de_aprovacao: 100, + taxa_de_reprovacao: 0, + taxa_de_abandono: 0, + municipio: 3101102, }, { - ano: 2021, - indicador: 'Reprovação', - raca: 'Pretos', - rede: 'Pública', - etapa: 'Ensino Médio', - valor: 35, - municipio: 'Patos de Minas', - }, - { - ano: 2021, - indicador: 'Reprovação', - raca: 'Brancos', + ano: 2023, rede: 'Pública', - etapa: 'Ensino Médio', - valor: 40, - municipio: 'Patos de Minas', + etapa: 'EF2', + taxa_de_aprovacao: 95, + taxa_de_reprovacao: 4, + taxa_de_abandono: 1, + municipio: 3101102, }, { - ano: 2021, - indicador: 'Reprovação', - raca: 'Brancos', - rede: 'Privada', - etapa: 'Ensino Médio', - valor: 28, - municipio: 'Patos de Minas', - }, - { - ano: 2021, - indicador: 'Reprovação', - raca: 'Pretos', - rede: 'Privada', - etapa: 'Ensino Médio', - valor: 18, - municipio: 'Patos de Minas', + ano: 2023, + rede: 'Total', + etapa: 'EF2', + taxa_de_aprovacao: 95.3, + taxa_de_reprovacao: 3.8, + taxa_de_abandono: 0.9, + municipio: 3101102, }, ]; diff --git a/api/src/database/memory/data/rankingMemoryData.ts b/api/src/database/memory/data/rankingMemoryData.ts index 07bcdff..b1ffed0 100644 --- a/api/src/database/memory/data/rankingMemoryData.ts +++ b/api/src/database/memory/data/rankingMemoryData.ts @@ -1,113 +1,365 @@ export const rankingData = [ { - ano: 2022, - raca: 'Brancos', - etapa: 'Ensino Médio', - municipio: 'Vargem Bonita', - reprovacao: 12.5, - evasao: 13.2, - atraso: 18.3, + ano: 2020, + raca: 'Branca', + rede: 'Municipal', + etapa: 'EF1', + matricula: 91, + municipio: 'Abadia dos Dourados', + }, + { + ano: 2020, + raca: 'Branca', + rede: 'Privada', + etapa: 'EF1', + matricula: 1, + municipio: 'Abadia dos Dourados', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Municipal', + etapa: 'EF1', + matricula: 41, + municipio: 'Abadia dos Dourados', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Privada', + etapa: 'EF1', + matricula: 2, + municipio: 'Abadia dos Dourados', + }, + { + ano: 2020, + raca: 'Preta', + rede: 'Municipal', + etapa: 'EF1', + matricula: 1, + municipio: 'Abadia dos Dourados', + }, + { + ano: 2020, + raca: 'Preta', + rede: 'Privada', + etapa: 'EF1', + matricula: 1, + municipio: 'Abadia dos Dourados', + }, + { + ano: 2020, + raca: 'Branca', + rede: 'Estadual', + etapa: 'EF1', + matricula: 270, + municipio: 'Abaeté', + }, + { + ano: 2020, + raca: 'Branca', + rede: 'Municipal', + etapa: 'EF1', + matricula: 219, + municipio: 'Abaeté', + }, + { + ano: 2020, + raca: 'Branca', + rede: 'Privada', + etapa: 'EF1', + matricula: 71, + municipio: 'Abaeté', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Estadual', + etapa: 'EF1', + matricula: 204, + municipio: 'Abaeté', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Municipal', + etapa: 'EF1', + matricula: 298, + municipio: 'Abaeté', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Privada', + etapa: 'EF1', + matricula: 11, + municipio: 'Abaeté', + }, + { + ano: 2020, + raca: 'Preta', + rede: 'Estadual', + etapa: 'EF1', + matricula: 7, + municipio: 'Abaeté', + }, + { + ano: 2020, + raca: 'Preta', + rede: 'Municipal', + etapa: 'EF1', + matricula: 15, + municipio: 'Abaeté', + }, + { + ano: 2020, + raca: 'Preta', + rede: 'Privada', + etapa: 'EF1', + matricula: 2, + municipio: 'Abaeté', + }, + { + ano: 2020, + raca: 'Branca', + rede: 'Estadual', + etapa: 'EF1', + matricula: 188, + municipio: 'Abre Campo', + }, + { + ano: 2020, + raca: 'Branca', + rede: 'Municipal', + etapa: 'EF1', + matricula: 87, + municipio: 'Abre Campo', + }, + { + ano: 2020, + raca: 'Branca', + rede: 'Privada', + etapa: 'EF1', + matricula: 17, + municipio: 'Abre Campo', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Estadual', + etapa: 'EF1', + matricula: 261, + municipio: 'Abre Campo', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Municipal', + etapa: 'EF1', + matricula: 129, + municipio: 'Abre Campo', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Privada', + etapa: 'EF1', + matricula: 15, + municipio: 'Abre Campo', }, { - ano: 2022, - raca: 'Pretos', - etapa: 'Ensino Médio', - municipio: 'Vargem Bonita', - reprovacao: 22.5, - evasao: 23.2, - atraso: 28.3, + ano: 2020, + raca: 'Preta', + rede: 'Estadual', + etapa: 'EF1', + matricula: 29, + municipio: 'Abre Campo', }, { - ano: 2022, - raca: 'Brancos', - etapa: 'Ensino Médio', - municipio: 'Belo Horizonte', - reprovacao: 12.5, - evasao: 13.2, - atraso: 18.3, + ano: 2020, + raca: 'Preta', + rede: 'Municipal', + etapa: 'EF1', + matricula: 23, + municipio: 'Abre Campo', }, { - ano: 2022, - raca: 'Pretos', - etapa: 'Ensino Médio', - municipio: 'Belo Horizonte', - reprovacao: 20.5, - evasao: 20.2, - atraso: 20.3, + ano: 2020, + raca: 'Preta', + rede: 'Privada', + etapa: 'EF1', + matricula: 1, + municipio: 'Abre Campo', }, { ano: 2020, - raca: 'Brancos', - etapa: 'Ensino Fundamental 1', - municipio: 'Belo Horizonte', - reprovacao: 10.5, - evasao: 0.5, - atraso: 4.0, + raca: 'Branca', + rede: 'Municipal', + etapa: 'EF1', + matricula: 45, + municipio: 'Acaiaca', }, { ano: 2020, - raca: 'Pretos', - etapa: 'Ensino Fundamental 1', - municipio: 'Belo Horizonte', - reprovacao: 9, - evasao: 6.5, - atraso: 11.5, + raca: 'Branca', + rede: 'Estadual', + etapa: 'EF1', + matricula: 270, + municipio: 'Todos', }, { ano: 2020, - raca: 'Pretos', - etapa: 'Ensino Fundamental 1', - municipio: 'Patos de Minas', - reprovacao: 2, - evasao: 2, - atraso: 2, + raca: 'Branca', + rede: 'Municipal', + etapa: 'EF1', + matricula: 219, + municipio: 'Todos', }, { ano: 2020, - raca: 'Brancos', - etapa: 'Ensino Fundamental 1', - municipio: 'Patos de Minas', - reprovacao: 3, - evasao: 6, - atraso: 0, + raca: 'Branca', + rede: 'Privada', + etapa: 'EF1', + matricula: 71, + municipio: 'Todos', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Estadual', + etapa: 'EF1', + matricula: 204, + municipio: 'Todos', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Municipal', + etapa: 'EF1', + matricula: 298, + municipio: 'Todos', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Privada', + etapa: 'EF1', + matricula: 11, + municipio: 'Todos', + }, + { + ano: 2020, + raca: 'Preta', + rede: 'Estadual', + etapa: 'EF1', + matricula: 7, + municipio: 'Todos', + }, + { + ano: 2020, + raca: 'Preta', + rede: 'Municipal', + etapa: 'EF1', + matricula: 15, + municipio: 'Todos', + }, + { + ano: 2020, + raca: 'Preta', + rede: 'Privada', + etapa: 'EF1', + matricula: 2, + municipio: 'Todos', }, ]; -export const disorderedData = [ - { - ano: 2021, - raca: 'Brancos', - etapa: 'Ensino Fundamental 1', - municipio: 'Belo Horizonte', - reprovacao: 10.5, - evasao: 0.5, - atraso: 4.0, - }, - { - ano: 2021, - raca: 'Pretos', - etapa: 'Ensino Fundamental 1', - municipio: 'Patos de Minas', - reprovacao: 2, - evasao: 2, - atraso: 2, - }, - { - ano: 2021, - raca: 'Pretos', - etapa: 'Ensino Fundamental 1', - municipio: 'Belo Horizonte', - reprovacao: 9, - evasao: 6.5, - atraso: 11.5, - }, - { - ano: 2021, - raca: 'Brancos', - etapa: 'Ensino Fundamental 1', - municipio: 'Patos de Minas', - reprovacao: 3, - evasao: 6, - atraso: 0, +export const DataEM = [ + { + ano: 2020, + raca: 'Branca', + rede: 'Estadual', + etapa: 'EM', + matricula: 189, + municipio: 'Águas Formosas', + }, + { + ano: 2020, + raca: 'Branca', + rede: 'Privada', + etapa: 'EM', + matricula: 8, + municipio: 'Águas Formosas', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Estadual', + etapa: 'EM', + matricula: 560, + municipio: 'Águas Formosas', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Privada', + etapa: 'EM', + matricula: 6, + municipio: 'Águas Formosas', + }, + { + ano: 2020, + raca: 'Preta', + rede: 'Estadual', + etapa: 'EM', + matricula: 22, + municipio: 'Águas Formosas', + }, + { + ano: 2020, + raca: 'Branca', + rede: 'Estadual', + etapa: 'EM', + matricula: 133, + municipio: 'Águas Vermelhas', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Estadual', + etapa: 'EM', + matricula: 382, + municipio: 'Águas Vermelhas', + }, + { + ano: 2020, + raca: 'Preta', + rede: 'Estadual', + etapa: 'EM', + matricula: 25, + municipio: 'Águas Vermelhas', + }, + { + ano: 2020, + raca: 'Branca', + rede: 'Estadual', + etapa: 'EM', + matricula: 221, + municipio: 'Aimorés', + }, + { + ano: 2020, + raca: 'Parda', + rede: 'Estadual', + etapa: 'EM', + matricula: 380, + municipio: 'Aimorés', + }, + { + ano: 2020, + raca: 'Preta', + rede: 'Estadual', + etapa: 'EM', + matricula: 18, + municipio: 'Aimorés', }, ]; diff --git a/api/src/database/memory/indicadoresRepositoryMemory.ts b/api/src/database/memory/indicadoresRepositoryMemory.ts index 39a72c7..76fe364 100644 --- a/api/src/database/memory/indicadoresRepositoryMemory.ts +++ b/api/src/database/memory/indicadoresRepositoryMemory.ts @@ -8,13 +8,9 @@ export class IndicadoresRepositoryMemory extends IndicadoresRepository { public DATA_IN_MEMORY: IndicadoresRepositoryOutput[] = []; async fetch(input: IndicadoresInput): Promise { - const { municipio, etapa, indicador, rede } = input; + const { municipio, etapa } = input; const response = this.DATA_IN_MEMORY.filter( - (item) => - item.etapa === etapa && - item.indicador === indicador && - item.rede === rede && - item.municipio === municipio, + (item) => item.etapa === etapa && item.municipio === municipio, ); return response; } diff --git a/api/src/database/psql/indicadoresRepositoryPSQL.ts b/api/src/database/psql/indicadoresRepositoryPSQL.ts new file mode 100644 index 0000000..f20ce1a --- /dev/null +++ b/api/src/database/psql/indicadoresRepositoryPSQL.ts @@ -0,0 +1,43 @@ +import { supabase } from '../..'; +import { + IndicadoresRepository, + IndicadoresRepositoryOutput, +} from '../../repositories/indicadoresRepository'; +import { IndicadoresInput } from '../../services/indicadoresServices'; + +export class IndicadoresRepositoryPSQL extends IndicadoresRepository { + async fetch(input: IndicadoresInput): Promise { + const { data, error } = await supabase + .from('Filtro') + .select( + ` + id, + municipio_id, + etapa_de_ensino, + ano, + Indicador(dependencia_administrativa, taxa_de_aprovacao, taxa_de_reprovacao, taxa_de_abandono) + `, + ) + .eq('municipio_id', Number(input.municipio)) + .eq('etapa_de_ensino', input.etapa); // Filtrando por município + if (error) { + throw new Error(error.message); + } else { + // Processar e retornar os dados no formato esperado + const result: IndicadoresRepositoryOutput[] = data + .map((filtro: any) => { + return filtro.Indicador.map((mr: any) => ({ + ano: filtro.ano, + rede: mr.dependencia_administrativa, + etapa: filtro.etapa_de_ensino, + taxa_de_aprovacao: mr.taxa_de_aprovacao, + taxa_de_reprovacao: mr.taxa_de_reprovacao, + taxa_de_abandono: mr.taxa_de_abandono, + municipio: filtro.municipio_id, + })); + }) + .flat(); + return result; + } + } +} diff --git a/api/src/database/psql/rankingRepositoryPSQL.ts b/api/src/database/psql/rankingRepositoryPSQL.ts new file mode 100644 index 0000000..8503f0d --- /dev/null +++ b/api/src/database/psql/rankingRepositoryPSQL.ts @@ -0,0 +1,65 @@ +import { supabase } from '../..'; +import { + RankingRepository, + RankingRepositoryOutput, +} from '../../repositories/rankingRepository'; +import { RankingInput } from '../../services/rankingServices'; + +export class RankingRepositoryPSQL extends RankingRepository { + async fetch(input: RankingInput): Promise { + const { data: idFiltro, error: municipiosError } = await supabase + .from('Filtro') + .select('*') + .eq('ano', input.ano) + .eq('etapa_de_ensino', input.etapa); + + if (municipiosError) { + throw new Error(`Erro ao obter filtros: ${municipiosError.message}`); + } + + const filterIds = idFiltro.map((idFiltro) => idFiltro.id); + const municipioIds = idFiltro.map((idFiltro) => idFiltro.municipio_id); + + const racas = ['Branca', 'Preta', 'Parda']; + + const { data: matriculas, error: matriculasError } = await supabase + .from('Matricula') + .select('*') + .in('cor_raca', racas) + .in('id_filtro', filterIds); + + if (matriculasError) { + throw new Error(`Erro ao obter matrículas: ${matriculasError.message}`); + } + + const { data: municipios, error: municipiosError2 } = await supabase + .from('Municipio') + .select('id, nome') + .in('id', municipioIds); + + if (municipiosError2) { + throw new Error(`Erro ao obter municípios: ${municipiosError2.message}`); + } + + const municipioMap = new Map( + municipios?.map((municipio) => [municipio.id, municipio.nome]), + ); + + const result: RankingRepositoryOutput[] = idFiltro + .map((idFiltro) => { + return matriculas + .filter((matricula) => matricula.id_filtro === idFiltro.id) + .map((matricula) => ({ + ano: idFiltro.ano, + raca: matricula.cor_raca, + rede: matricula.dependencia_administrativa, + etapa: idFiltro.etapa_de_ensino, + matricula: matricula.quantidade, + municipio: municipioMap.get(idFiltro.municipio_id) || 'Desconhecido', + })); + }) + .flat(); + + return result; + } +} diff --git a/api/src/repositories/indicadoresRepository.ts b/api/src/repositories/indicadoresRepository.ts index ae13323..74be662 100644 --- a/api/src/repositories/indicadoresRepository.ts +++ b/api/src/repositories/indicadoresRepository.ts @@ -2,11 +2,11 @@ import { IndicadoresInput } from '../services/indicadoresServices'; export type IndicadoresRepositoryOutput = { ano: number; - indicador: string; - raca: string; rede: string; etapa: string; - valor: number; + taxa_de_aprovacao: number; + taxa_de_reprovacao: number; + taxa_de_abandono: number; municipio: string; }; diff --git a/api/src/repositories/rankingRepository.ts b/api/src/repositories/rankingRepository.ts index 61c427a..92e7f77 100644 --- a/api/src/repositories/rankingRepository.ts +++ b/api/src/repositories/rankingRepository.ts @@ -4,11 +4,10 @@ import { RankingInput } from '../services/rankingServices'; export type RankingRepositoryOutput = { ano: number; raca: string; + rede: string; etapa: string; + matricula: number; municipio: string; - reprovacao: number; - evasao: number; - atraso: number; }; export abstract class RankingRepository { diff --git a/api/src/services/indicadoresService.spec.ts b/api/src/services/indicadoresService.spec.ts index 5eac2da..040e381 100644 --- a/api/src/services/indicadoresService.spec.ts +++ b/api/src/services/indicadoresService.spec.ts @@ -1,10 +1,5 @@ import { describe, expect, test } from 'vitest'; -import { - disorderedData, - genericData, - incompleteData, - perfectData, -} from '../database/memory/data/indicadoresMemoryData'; +import { genericData } from '../database/memory/data/indicadoresMemoryData'; import { IndicadoresRepositoryMemory } from '../database/memory/indicadoresRepositoryMemory'; import { IndicadoresInput, IndicadoresService } from './indicadoresServices'; @@ -12,28 +7,30 @@ describe('Indicadores Service', () => { const indicadoresRepository = new IndicadoresRepositoryMemory(); const indicadoresService = new IndicadoresService(indicadoresRepository); - indicadoresRepository.DATA_IN_MEMORY = genericData; + indicadoresRepository.DATA_IN_MEMORY = genericData.map((item) => ({ + ...item, + municipio: item.municipio.toString(), + })); const input: IndicadoresInput = { - indicador: 'Reprovação', - etapa: 'Ensino Médio', - rede: 'Pública', - municipio: 'Patos de Minas', + indicador: 'taxa_de_aprovacao', + etapa: 'EF2', + municipio: '3101102', }; test('should return categories length with success', async () => { const output = await indicadoresService.execute(input); - expect(output.categories).toHaveLength(2); + expect(output.categories).toHaveLength(4); }); test('should return first category with success', async () => { const output = await indicadoresService.execute(input); - expect(output.categories[0]).toEqual(2019); + expect(output.categories[0]).toEqual(2020); }); - test('should return second categorie with success', async () => { + test('should return last categorie with success', async () => { const output = await indicadoresService.execute(input); - expect(output.categories[1]).toEqual(2020); + expect(output.categories[3]).toEqual(2023); }); test('should return series length with success', async () => { @@ -43,98 +40,25 @@ describe('Indicadores Service', () => { test('should return first series with success', async () => { const output = await indicadoresService.execute(input); - expect(output.series[0].name).toEqual('pretos'); - expect(output.series[0].data).toHaveLength(2); - expect(output.series[0].data[0]).toEqual(33); - expect(output.series[0].data[1]).toEqual(36); + expect(output.series[0].name).toEqual('Pública'); + expect(output.series[0].data).toHaveLength(4); + expect(output.series[0].data[0]).toEqual(97.9); + expect(output.series[0].data[1]).toEqual(97.3); }); test('should return second series with success', async () => { const output = await indicadoresService.execute(input); - expect(output.series[1].name).toEqual('brancos'); - expect(output.series[1].data).toHaveLength(2); - expect(output.series[1].data[0]).toEqual(10); - expect(output.series[1].data[1]).toEqual(11); - }); - - test('should return output with other city with success', async () => { - const otherCityInput: IndicadoresInput = { - indicador: 'Reprovação', - etapa: 'Ensino Médio', - rede: 'Pública', - municipio: 'Tiros', - }; - - indicadoresRepository.DATA_IN_MEMORY = [ - ...genericData, - { - ano: 2020, - indicador: 'Reprovação', - valor: 5, - municipio: 'Tiros', - raca: 'Pretos', - rede: 'Pública', - etapa: 'Ensino Médio', - }, - ]; - const output = await indicadoresService.execute(otherCityInput); - expect(output.categories).toHaveLength(1); - expect(output.categories[0]).toEqual(2020); - expect(output.series[0].name).toEqual('pretos'); - expect(output.series[0].data).toHaveLength(1); - expect(output.series[0].data[0]).toEqual(5); + expect(output.series[1].name).toEqual('Privada'); + expect(output.series[1].data).toHaveLength(4); + expect(output.series[1].data[0]).toEqual(100); + expect(output.series[1].data[1]).toEqual(99); }); - test('should return an Error when not exists register with indicador filter', async () => { - const incorrectIndicadorInput = { ...input, indicador: 'Taxa Inexistente' }; + test('should return an Error when not exists data with municipio filter', async () => { + const incorrectIndicadorInput = { ...input, municipio: 'Onde Judas perdeu as botas' }; await expect(indicadoresService.execute(incorrectIndicadorInput)).rejects.toThrow( 'Nenhum dado foi encontrado para estes filtros.', ); }); - - test('should return data in order', async () => { - indicadoresRepository.DATA_IN_MEMORY = disorderedData; - - const response = await indicadoresService.execute({ - indicador: 'Reprovação', - etapa: 'Ensino Médio', - rede: 'Pública', - municipio: 'Patos de Minas', - }); - - expect(response.series[0].name).toEqual('pretos'); - expect(response.series[0].data).toEqual([50, 22]); - expect(response.series[1].name).toEqual('brancos'); - expect(response.series[1].data).toEqual([33, 44]); - expect(response.categories).toEqual([2019, 2020]); - }); - - test('should return completed data', async () => { - indicadoresRepository.DATA_IN_MEMORY = incompleteData; - - const response = await indicadoresService.execute({ - ...input, - municipio: 'Patos de Minas', - }); - - expect(response.series[0].name).toEqual('pretos'); - expect(response.series[0].data).toEqual([26, 0]); - expect(response.series[1].name).toEqual('brancos'); - expect(response.series[1].data).toEqual([0, 39]); - expect(response.categories).toEqual([2019, 2020]); - }); - - test('should return all data correct', async () => { - indicadoresRepository.DATA_IN_MEMORY = perfectData; - const response = await indicadoresService.execute({ - ...input, - municipio: 'Patos de Minas', - }); - expect(response.series[0].name).toEqual('pretos'); - expect(response.series[0].data).toEqual([26, 22, 35]); - expect(response.series[1].name).toEqual('brancos'); - expect(response.series[1].data).toEqual([39, 44, 40]); - expect(response.categories).toEqual([2019, 2020, 2021]); - }); }); diff --git a/api/src/services/indicadoresServices.ts b/api/src/services/indicadoresServices.ts index f5903d6..ae25ab6 100644 --- a/api/src/services/indicadoresServices.ts +++ b/api/src/services/indicadoresServices.ts @@ -3,7 +3,6 @@ import { IndicadoresRepository } from '../repositories/indicadoresRepository'; export type IndicadoresInput = { indicador: string; etapa: string; - rede: string; municipio: string; }; @@ -26,52 +25,36 @@ export class IndicadoresService { } const newData: { [key: string]: number[] } = { - pretos: [], - brancos: [], + Pública: [], + Privada: [], }; const categories: number[] = []; // Definindo os anos esperados - const anos = [2019, 2020, 2021, 2022]; + const anos = [2020, 2021, 2022, 2023]; // Criando combinações de ano anos.forEach((ano) => { categories.push(ano); - newData.pretos.push(0); - newData.brancos.push(0); + newData.Pública.push(0); + newData.Privada.push(0); }); // Atualizando dados de indicadores - data.forEach((entry) => { - if ( - entry.indicador !== input.indicador || - entry.etapa !== input.etapa || - entry.rede !== input.rede || - entry.municipio !== input.municipio - ) { - throw new Error('Indicador, etapa, rede ou municipio errados.'); - } + data.forEach((entry: { [key: string]: any }) => { const index = categories.indexOf(entry.ano); - if (entry.raca === 'Pretos') { - newData.pretos[index] += entry.valor; - } else if (entry.raca === 'Brancos') { - newData.brancos[index] += entry.valor; + if (entry.rede === 'Pública') { + newData.Pública[index] += entry[input.indicador]; + } else if (entry.rede === 'Privada') { + newData.Privada[index] += entry[input.indicador]; } }); - for (let i = categories.length - 1; i >= 0; i--) { - if (newData.pretos[i] === 0 && newData.brancos[i] === 0) { - newData.pretos.splice(i, 1); - newData.brancos.splice(i, 1); - categories.splice(i, 1); - } - } const series = Object.entries(newData).map(([name, data]) => ({ name, - data, + data: data.map((value: number) => parseFloat(value.toFixed(1))), })); - return { series, categories, diff --git a/api/src/services/matriculasServices.ts b/api/src/services/matriculasServices.ts index a7be754..d11291c 100644 --- a/api/src/services/matriculasServices.ts +++ b/api/src/services/matriculasServices.ts @@ -42,10 +42,6 @@ export class MatriculasService { }); data.forEach((entry) => { - if (entry.etapa !== input.etapa || entry.municipio.toString() !== input.municipio) { - throw new Error('Erro ao processar solicitação.'); - } - if ( entry.rede === 'Municipal' || entry.rede === 'Estadual' || diff --git a/api/src/services/rankingServices.spec.ts b/api/src/services/rankingServices.spec.ts index 33d1f5c..7675e3a 100644 --- a/api/src/services/rankingServices.spec.ts +++ b/api/src/services/rankingServices.spec.ts @@ -1,76 +1,47 @@ -import { describe, expect, test } from 'vitest'; -import { disorderedData, rankingData } from '../database/memory/data/rankingMemoryData'; +import { beforeEach, describe, expect, test } from 'vitest'; +import { rankingData } from '../database/memory/data/rankingMemoryData'; import { RankingRepositoryMemory } from '../database/memory/rankingRepositoryMemory'; import { RankingInput, RankingService } from './rankingServices'; describe('Ranking Service', () => { - const rankingRepository = new RankingRepositoryMemory(); - const rankingService = new RankingService(rankingRepository); + let rankingRepository: RankingRepositoryMemory; + let rankingService: RankingService; - rankingRepository.DATA_IN_MEMORY = rankingData; + beforeEach(() => { + rankingRepository = new RankingRepositoryMemory(); + rankingService = new RankingService(rankingRepository); + rankingRepository.DATA_IN_MEMORY = rankingData; // Reset data before each test + }); const input: RankingInput = { - ano: 2022, - etapa: 'Ensino Médio', - ordem: 'maior', + ano: 2020, + etapa: 'EF1', }; + test('should return data with success', async () => { const output = await rankingService.execute(input); - expect(output[0].name).toEqual('Vargem Bonita'); - expect(output[0].value).toEqual(10); + expect(output[0].name).toEqual('Abaeté'); + expect(output[0].value).toEqual(36.25); }); - test('should return data lenght with succces', async () => { + + test('should return data length with success', async () => { const output = await rankingService.execute(input); - expect(output).toHaveLength(2); - }); - test('should return data in another order with success', async () => { - const output = await rankingService.execute({ ...input, ordem: 'menor' }); - expect(output[0].name).toEqual('Belo Horizonte'); - expect(output[0].value).toEqual(5.67); - }); - test('should return data with another filter with success', async () => { - const output = await rankingService.execute({ - ...input, - etapa: 'Ensino Fundamental 1', - ano: 2020, - }); - expect(output[0].name).toEqual('Belo Horizonte'); - expect(output[0].value).toEqual(4); - expect(output[1].name).toEqual('Patos de Minas'); - expect(output[1].value).toEqual(1); - }); - test('should return disorderedData input with success', async () => { - rankingRepository.DATA_IN_MEMORY = disorderedData; - const output = await rankingService.execute({ - ...input, - etapa: 'Ensino Fundamental 1', - ano: 2021, - }); - rankingRepository.DATA_IN_MEMORY = disorderedData; - expect(output[0].name).toEqual('Belo Horizonte'); - expect(output[0].value).toEqual(4); - expect(output[1].name).toEqual('Patos de Minas'); - expect(output[1].value).toEqual(1); + expect(output).toHaveLength(3); }); - test('should return an Erro when not exists register with ano filter', async () => { - const incorrectEtapaInput = { ...input, ano: 2024 }; - await expect(rankingService.execute(incorrectEtapaInput)).rejects.toThrowError( + test('should return an Error when no register exists with ano filter', async () => { + const incorrectAnoInput = { ...input, ano: 2024 }; + + await expect(rankingService.execute(incorrectAnoInput)).rejects.toThrowError( 'Nenhum dado foi encontrado para estes filtros.', ); }); - test('should return an Error when not exists register with etapa filter', async () => { + + test('should return an Error when no register exists with etapa filter', async () => { const incorrectEtapaInput = { ...input, etapa: 'Ensino' }; await expect(rankingService.execute(incorrectEtapaInput)).rejects.toThrowError( 'Nenhum dado foi encontrado para estes filtros.', ); }); - test('should return an Error when order filter is wrong', async () => { - const incorrectMunicipioInput = { ...input, ordem: 'crescente' }; - rankingRepository.DATA_IN_MEMORY = rankingData; - await expect(rankingService.execute(incorrectMunicipioInput)).rejects.toThrowError( - 'Ordem inválida.', - ); - }); }); diff --git a/api/src/services/rankingServices.ts b/api/src/services/rankingServices.ts index 3321e67..982dd69 100644 --- a/api/src/services/rankingServices.ts +++ b/api/src/services/rankingServices.ts @@ -3,12 +3,13 @@ import { RankingRepository } from '../repositories/rankingRepository'; export type RankingInput = { ano: number; etapa: string; - ordem: string; }; + type Output = { name: string; // Nome do município - value: number; // Valor do índice calculado -}[]; // Será um vetor ordenado de acordo com a chave value e com a ordem recebida: maior ou menor + value: number; // Módulo da diferença percentual entre rede pública e privada +}[]; + export class RankingService { constructor(private rankingRepository: RankingRepository) {} @@ -17,36 +18,75 @@ export class RankingService { if (!data || data.length === 0) { throw new Error('Nenhum dado foi encontrado para estes filtros.'); } - const newData: { [key: string]: number } = {}; + + const newData: { + [key: string]: { + pretoPublica: number; + pretoPrivada: number; + brancoPublica: number; + brancoPrivada: number; + }; + } = {}; + data.forEach((entry) => { - if (entry.etapa !== input.etapa || entry.ano !== input.ano) { - throw new Error('Etapa ou ano errados.'); + if (entry.municipio === 'Todos') { + entry.municipio = 'Minas Gerais'; } + const isPublica = ['Municipal', 'Estadual', 'Federal'].includes(entry.rede); + const isPretosPardos = ['Preta', 'Parda'].includes(entry.raca); + if (!newData[entry.municipio]) { - newData[entry.municipio] = (entry.reprovacao + entry.evasao + entry.atraso) / 3; - } else { - newData[entry.municipio] = parseFloat( - Math.abs( - newData[entry.municipio] - - (entry.reprovacao + entry.evasao + entry.atraso) / 3, - ).toFixed(2), - ); + newData[entry.municipio] = { + pretoPublica: 0, + pretoPrivada: 0, + brancoPublica: 0, + brancoPrivada: 0, + }; + } + + if (isPublica) { + if (isPretosPardos) { + newData[entry.municipio].pretoPublica += entry.matricula; + } else if (entry.raca === 'Branca') { + newData[entry.municipio].brancoPublica += entry.matricula; + } + } else if (entry.rede === 'Privada') { + if (isPretosPardos) { + newData[entry.municipio].pretoPrivada += entry.matricula; + } else if (entry.raca === 'Branca') { + newData[entry.municipio].brancoPrivada += entry.matricula; + } } }); const response: Output = Object.keys(newData) - .map((key) => ({ - name: key, - value: newData[key], - })) - .sort((a, b) => { - if (input.ordem === 'maior') { - return a.value < b.value ? 1 : -1; - } else if (input.ordem === 'menor') { - return a.value > b.value ? 1 : -1; + .map((municipio) => { + const totalPublica = + newData[municipio].pretoPublica + newData[municipio].brancoPublica; + const totalPrivada = + newData[municipio].pretoPrivada + newData[municipio].brancoPrivada; + + // Exclui o município se qualquer um dos valores totais for inferior a 10 + if (totalPublica < 10 || totalPrivada < 10) { + delete newData[municipio]; + return null; } - throw new Error('Ordem inválida.'); - }); + + const porcentagemPretosPublica = + (newData[municipio].pretoPublica / totalPublica) * 100; + const porcentagemPretosPrivada = + (newData[municipio].pretoPrivada / totalPrivada) * 100; + + const diferencaPorcentagem = Math.abs( + porcentagemPretosPublica - porcentagemPretosPrivada, + ); + return { + name: municipio, + value: parseFloat(diferencaPorcentagem.toFixed(2)), + }; + }) + .filter((item) => item !== null); // Filtra os municípios que foram excluídos + return response; } }