feat: adds ira calculator with unit tests #229

lucasqueiroz23 · 2024-08-10T02:16:53Z

Descrição

Para a issue #206, criei a classe e os testes unitários (usando TDD) que calculam o IRA.

Tipo de alteração

Bug fix (alteração que corrige um problema)
New feature (alteração que adiciona funcionalidade)
Breaking change (correção ou funcionalidade que altera o comportamento de outras partes do sistema de maneira significativa)
Documentation update (alteração na documentação)

Como isso foi testado?

Por serem simples alterações de código, os testes foram criados no diretório de testes dos utils da API, e executados com make test.

Checklist

Meu código segue as diretrizes de contribuição deste projeto
Realizei uma revisão pessoal do meu código
Comentei meu código, especialmente em áreas de difícil compreensão
Fiz alterações correspondentes na documentação
Minhas alterações não geram novos warnings ou erros
Adicionei testes que comprovam que minha correção é eficaz ou que minha funcionalidade está funcionando corretamente
Todos os testes unitários novos e existentes passam localmente com minhas alterações

vercel · 2024-08-10T02:16:58Z

@lucasqueiroz23 is attempting to deploy a commit to the Sua Grade UnB Team on Vercel.

A member of the Team first needs to authorize it.

GabrielCastelo-31 · 2024-08-11T18:18:47Z

Boa tarde, @lucasqueiroz23! Em breve realizarei a revisão do seu PR. Obrigado pela contribuição!

api/utils/ira_calculator.py

caio-felipee

Boa noite. Muito obrigado pelas alterações!

Eu acredito que seria interessante o uso de funções que validam os parâmetros enviados para a calculadora para evitar erros inesperados e até mesmo facilitar na hora de enviar mais detalhes no erro da API.

Por exemplo, quando eu envio alguma matéria com zero créditos, possuo o erro de divisão por zero, algo que deveria ser evitado.

{
    'mencao': 'SS',
    'qtdCreditos': 0,
    'semestre': 3
}

Algumas verificações extras que seriam interessantes:

Falta de alguma informação
Tipo inválido (era pra ser um inteiro, recebi uma string, por exemplo)
Semestres e créditos não factíveis (0 créditos, por exemplo)
- O que aconteceria se eu colocasse um crédito muito grande?
- O que aconteceria se eu colocasse créditos/semestres negativos?

…eUnB into valida-ira

api/utils/ira_calculator.py

lucasqueiroz23 · 2024-08-12T16:35:23Z

boa tarde, @caio-felipee e @GabrielCastelo-31! Observei suas sugestões e realizei alterações conforme comentado. Além disso, percebi que o cálculo em si estava errado, e corrigi.

@caio-felipee quanto à validação do número de créditos, realmente não me atentei à divisão por zero. Fiz essa correção. No entanto, quando se trata de um número muito grande de créditos, o que complica é que não existe (até onde sei) um documento que diga qual o número máximo de créditos que uma disciplina pode ter.

GabrielCastelo-31 · 2024-08-12T16:45:57Z

boa tarde, @caio-felipee e @GabrielCastelo-31! Observei suas sugestões e realizei alterações conforme comentado. Além disso, percebi que o cálculo em si estava errado, e corrigi.

@caio-felipee quanto à validação do número de créditos, realmente não me atentei à divisão por zero. Fiz essa correção. No entanto, quando se trata de um número muito grande de créditos, o que complica é que não existe (até onde sei) um documento que diga qual o número máximo de créditos que uma disciplina pode ter.

Boa tarde, Lucas! Obrigado pelas alterações. Iremos reavaliar o PR em breve. Quanto a questão do número de créditos, a UnB calcula da seguinte maneira: 1 crédito = 15 horas, portanto a quantidade de créditos de uma disciplina qualquer é dada por carga_horária(em horas)/15. Há a necessidade, porém, de verificar se a atual fórmula do IRA utiliza os créditos ou carga horária como peso para o cálculo do IRA.

Creio que seria interessante incluir, no topo do arquivo, em forma de comentário, a atual fórmula do IRA para facilitar o entendimento do código.

lucasqueiroz23 · 2024-08-12T22:05:59Z

boa tarde, @caio-felipee e @GabrielCastelo-31! Observei suas sugestões e realizei alterações conforme comentado. Além disso, percebi que o cálculo em si estava errado, e corrigi.
@caio-felipee quanto à validação do número de créditos, realmente não me atentei à divisão por zero. Fiz essa correção. No entanto, quando se trata de um número muito grande de créditos, o que complica é que não existe (até onde sei) um documento que diga qual o número máximo de créditos que uma disciplina pode ter.

Boa tarde, Lucas! Obrigado pelas alterações. Iremos reavaliar o PR em breve. Quanto a questão do número de créditos, a UnB calcula da seguinte maneira: 1 crédito = 15 horas, portanto a quantidade de créditos de uma disciplina qualquer é dada por carga_horária(em horas)/15. Há a necessidade, porém, de verificar se a atual fórmula do IRA utiliza os créditos ou carga horária como peso para o cálculo do IRA.

Creio que seria interessante incluir, no topo do arquivo, em forma de comentário, a atual fórmula do IRA para facilitar o entendimento do código.

boa noite! Concordo, o cálculo do IRA deve ficar no topo (ou em algum lugar) do código. Quanto aos créditos, a fórmula do IRA utiliza a quantidade de créditos, e não a carga horária para realizar o cálculo. O documento que indica isso está linkado na issue #206. No entanto, pensei em uma solução. Na URL em que é realizado o webscraping, na coluna "docentes", a quantidade de horas totais daquela disciplina está descrita (como na imagem abaixo).

Ou seja: é possível realizar o cálculo da volta. A partir da quantidade de horas, podemos calcular a quantidade de créditos que tem numa disciplina. Sendo assim, é possível obter a quantidade de créditos. No entanto, acho que isso seria melhor realizado em outro branch (e talvez até outra issue), dado que seria uma tarefa de web-scraping. Qual a opinião de vocês?

lucasqueiroz23 · 2024-08-12T22:17:10Z

@GabrielCastelo-31 adicionei, no código da classe, os comentários explicando como é realizado o cálculo.

caio-felipee · 2024-08-13T18:10:07Z

Boa tarde, @lucasqueiroz23! Em breve revisarei o seu Pull Request.

O documento que indica isso está linkado na issue #206. No entanto, pensei em uma solução. Na URL em que é realizado o webscraping, na coluna "docentes", a quantidade de horas totais daquela disciplina está descrita (como na imagem abaixo).

Em relação a quantidade de horas totais da disciplina, nós já passamos por um problema semelhante que inviabiliza o uso fiel dessa técnica. Verificamos a existência de certas inconsistências:

Pode existir matérias que as turmas não estão definidas totalmente, logo, a quantidade de horas pode não aparecer.
Pode existir mais de um professor para a mesma turma
- Representação no qual a quantidade total de horas é a soma: primeira imagem abaixo
- Representação no qual a quantidade total de horas não é a soma (resultado 60h): segunda imagem abaixo
Qual semestre deveríamos considerar para realizar o cálculo (coleta de horas)?

O SIGAA apresenta inúmeros casos (talvez nem temos ciência de todos ainda) que confirma a inviabilidade do uso de certas informações a partir do site de listagem. O correto seria realizar uma busca direto pela matéria e/ou curso, algo que pretendemos por em prática no futuro.

caio-felipee

Boa tarde. Realizei algumas considerações, inclusive sobre a fórmula do cálculo do IRA.

Adicionalmente, gostaria de levantar sobre os nomes das variáveis: há o intercâmbio entre o português e o inglês. Para manter o padrão, poderia deixar tudo em apenas inglês?

Mais uma vez, agradeço pela colaboração!

api/utils/ira_calculator.py

lucasqueiroz23 · 2024-08-20T01:59:47Z

Boa noite, @caio-felipee! Fiz as mudanças como solicitado.

Quanto à colocar o código em inglês, eu inicialmente tive essa dúvida, pois "menção" em inglês é "grade". No entanto, "grade", pra esse projeto, tem um significado específico: o conjunto de matérias e horários de matérias, a grade. Por isso fiquei na dúvida. No entanto, alterei conforme sua orientação.

Mas mantive os comentários em português, visto que, nos outros arquivos, classes e métodos, os comentários estão na nossa língua.

caio-felipee

Muito bom!

codeclimate · 2024-08-22T18:13:32Z

Code Climate has analyzed commit a88402f and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	1

View more on Code Climate.

A pedido

vercel · 2024-08-22T19:38:00Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
suagradeunb	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 22, 2024 7:38pm

codecov · 2024-08-22T21:14:32Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (b3e8235) to head (a88402f).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #229   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           58        60    +2     
  Lines         2016      2075   +59     
=========================================
+ Hits          2016      2075   +59

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

feat: adds ira calculator with unit tests

88b8f5c

GabrielCastelo-31 self-requested a review August 11, 2024 18:15

GabrielCastelo-31 previously requested changes Aug 11, 2024

View reviewed changes

api/utils/ira_calculator.py Outdated Show resolved Hide resolved

api/utils/ira_calculator.py Outdated Show resolved Hide resolved

GabrielCastelo-31 requested a review from caio-felipee August 11, 2024 18:29

caio-felipee reviewed Aug 11, 2024

View reviewed changes

api/utils/ira_calculator.py Outdated Show resolved Hide resolved

caio-felipee requested changes Aug 11, 2024

View reviewed changes

lucasqueiroz23 and others added 9 commits August 12, 2024 12:31

refac: removes magic numbers

b033e21

Merge branch 'main' into valida-ira

8c143cf

refac: adds typing to discipline dict

7ae8be5

refac: adds messages to captured exceptions

6360117

fix: changes math for ira calculation

d4b0ff1

fix: fixes math again

04a18d7

feat: adds testing for some disciplines during first semester

e3432c5

feat: adds more input validation

d6eefbd

Merge branch 'valida-ira' of github.com:lucasqueiroz23/2023-2-SuaGrad…

978b02a

…eUnB into valida-ira

codeclimate bot reviewed Aug 12, 2024

View reviewed changes

api/utils/ira_calculator.py Show resolved Hide resolved

refac: adds comments that explain the calculation

d618007

caio-felipee requested changes Aug 19, 2024

View reviewed changes

api/utils/ira_calculator.py Outdated Show resolved Hide resolved

api/utils/ira_calculator.py Outdated Show resolved Hide resolved

api/utils/ira_calculator.py Outdated Show resolved Hide resolved

api/utils/ira_calculator.py Outdated Show resolved Hide resolved

lucasqueiroz23 added 2 commits August 19, 2024 22:39

refac: changes variable names to english and return value

b2c5f0d

refac: corrects error handling

3299797

caio-felipee approved these changes Aug 20, 2024

View reviewed changes

caio-felipee requested a review from GabrielCastelo-31 August 20, 2024 14:11

artrsousa1 removed the request for review from GabrielCastelo-31 August 22, 2024 18:11

artrsousa1 added 2 commits August 22, 2024 15:11

Merge branch 'main' into valida-ira

bab47bc

Merge branch 'main' into valida-ira

a88402f

caio-felipee approved these changes Aug 22, 2024 •

edited

Loading

View reviewed changes

vercel bot deployed to Preview August 22, 2024 19:38 View deployment

caio-felipee merged commit 8442bd6 into unb-mds:main Aug 22, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adds ira calculator with unit tests #229

feat: adds ira calculator with unit tests #229

lucasqueiroz23 commented Aug 10, 2024

vercel bot commented Aug 10, 2024

GabrielCastelo-31 commented Aug 11, 2024

caio-felipee left a comment •

edited

Loading

lucasqueiroz23 commented Aug 12, 2024 •

edited

Loading

GabrielCastelo-31 commented Aug 12, 2024

lucasqueiroz23 commented Aug 12, 2024 •

edited

Loading

lucasqueiroz23 commented Aug 12, 2024

caio-felipee commented Aug 13, 2024

caio-felipee left a comment

lucasqueiroz23 commented Aug 20, 2024 •

edited

Loading

caio-felipee left a comment

codeclimate bot commented Aug 22, 2024

vercel bot commented Aug 22, 2024 •

edited

Loading

codecov bot commented Aug 22, 2024 •

edited

Loading

feat: adds ira calculator with unit tests #229

feat: adds ira calculator with unit tests #229

Conversation

lucasqueiroz23 commented Aug 10, 2024

Descrição

Tipo de alteração

Como isso foi testado?

Checklist

vercel bot commented Aug 10, 2024

GabrielCastelo-31 commented Aug 11, 2024

caio-felipee left a comment • edited Loading

Choose a reason for hiding this comment

lucasqueiroz23 commented Aug 12, 2024 • edited Loading

GabrielCastelo-31 commented Aug 12, 2024

lucasqueiroz23 commented Aug 12, 2024 • edited Loading

lucasqueiroz23 commented Aug 12, 2024

caio-felipee commented Aug 13, 2024

caio-felipee left a comment

Choose a reason for hiding this comment

lucasqueiroz23 commented Aug 20, 2024 • edited Loading

caio-felipee left a comment

Choose a reason for hiding this comment

codeclimate bot commented Aug 22, 2024

vercel bot commented Aug 22, 2024 • edited Loading

codecov bot commented Aug 22, 2024 • edited Loading

Codecov Report

caio-felipee left a comment •

edited

Loading

lucasqueiroz23 commented Aug 12, 2024 •

edited

Loading

lucasqueiroz23 commented Aug 12, 2024 •

edited

Loading

lucasqueiroz23 commented Aug 20, 2024 •

edited

Loading

vercel bot commented Aug 22, 2024 •

edited

Loading

codecov bot commented Aug 22, 2024 •

edited

Loading