diff --git a/src/libs/convert/potentialRevenue.js b/src/libs/convert/potentialRevenue.js new file mode 100644 index 0000000000000000000000000000000000000000..ae7855bdadd3c63b6996bbfa96d50eac34357152 --- /dev/null +++ b/src/libs/convert/potentialRevenue.js @@ -0,0 +1,34 @@ +/* +Copyright (C) 2024 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of simcaq-node. + +simcaq-node is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +simcaq-node is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-node. If not, see <https://www.gnu.org/licenses/>. +*/ + +module.exports = function regionCode(id) { + switch (id) { + case 1: + return "Ano"; + case 2: + return "Nome Ente"; + case 3: + return 'Receitas'; + case 4: + return 'Matrículas Públicas'; + case 5: + return 'Matrículas Públicas Mais Conveniada'; + } +}; diff --git a/src/libs/middlewares/aggregateData.js b/src/libs/middlewares/aggregateData.js index e004f653d6410bfe8fa1b95677b363e6cf31bcf9..af02c0db4d425a5288d617947128911e11c11ca3 100644 --- a/src/libs/middlewares/aggregateData.js +++ b/src/libs/middlewares/aggregateData.js @@ -37,6 +37,7 @@ const convert = { education_degree_entity: "educationDegreeEntity", government_agreement: "governmentAgreement", despesas_alunos: "expenses", + receita_potencial: "potentialRevenue", receitas: "revenue", despesas: "studentCost" } @@ -68,6 +69,7 @@ function aggregateData(req, res, next) { 'education_degree_entity', 'despesas_alunos', 'receitas', + 'receita_potencial', 'despesas' ]; const baseFields = ["school"] diff --git a/src/libs/middlewares/id2str.js b/src/libs/middlewares/id2str.js index 7cd8e0fce1074c56a010ff04cf8fd8ac2194cce3..f7ccbcc66c9d6fded2cf82d72f172b4d2236946a 100644 --- a/src/libs/middlewares/id2str.js +++ b/src/libs/middlewares/id2str.js @@ -129,6 +129,7 @@ const postGraduationEntity = require(`${libs}/convert/postGraduationEntity`); const totalDoc = require(`${libs}/convert/totalDoc`); const educationDegreeEntity = require(`${libs}/convert/educationDegreeEntity`); const expenses = require(`${libs}/convert/expenses.js`) +const potentialRevenue = require(`${libs}/convert/potentialRevenue.js`) const revenue = require(`${libs}/convert/revenue`); const studentCost = require(`${libs}/convert/studentCost`); const ageRangeOutSchool = require(`${libs}/convert/ageRangePopSchool`); @@ -253,6 +254,7 @@ const ids = { total_doc: totalDoc, education_degree_entity: educationDegreeEntity, despesas_id: expenses, + receita_potencial_id: potentialRevenue, receitas_id: revenue, student_cost: studentCost, age_range_pop_school_id: ageRangePopSchool, @@ -400,6 +402,7 @@ module.exports = { totalDoc, educationDegreeEntity, expenses, + potentialRevenue, revenue, studentCost, ageRangePopSchool, diff --git a/src/libs/middlewares/potentialRevenueParser.js b/src/libs/middlewares/potentialRevenueParser.js new file mode 100644 index 0000000000000000000000000000000000000000..23ceb6529632b2f1abe21f4770d04716ec8f9d19 --- /dev/null +++ b/src/libs/middlewares/potentialRevenueParser.js @@ -0,0 +1,21 @@ +/* +Middleware que remove o campo "region" quando o campo "city" está ativo nos filtros. +Devido à limitações na tabela de dados, quando ambos campos estão ativos o filtro por +"região" funciona incorretamente. +*/ +module.exports = function potentialRevenueParser(req, res, next) { + if (req.query && req.query.filter) { + const jsonString = `{${req.query.filter.replace(/(\w+):/g, '"$1":')}}`; + const obj = JSON.parse(jsonString); + + if ("city" in obj && "region" in obj) { + delete obj.region; + const customString = Object.entries(obj) + .map(([key, value]) => `${key}:"${value}"`) + .join(','); + req.query.filter = customString; + } + } + + next(); +}; diff --git a/src/libs/middlewares/studentRevenueParser.js b/src/libs/middlewares/studentRevenueParser.js index d11f98f5c7f02a508e8bf51b40c9d4554019a905..876dfb753dd59c0977aafdb5d49b352746dfe34f 100644 --- a/src/libs/middlewares/studentRevenueParser.js +++ b/src/libs/middlewares/studentRevenueParser.js @@ -19,4 +19,4 @@ module.exports = function studentRevenueParser(req, res, next) { } next(); -}; +}; \ No newline at end of file diff --git a/src/libs/routes_v1/api.js b/src/libs/routes_v1/api.js index 3fa49554da76ccd99017862e6b1f8b6f10d9f0fd..d49ecac0f15898ed35e7c4ab309d478840023489 100644 --- a/src/libs/routes_v1/api.js +++ b/src/libs/routes_v1/api.js @@ -161,6 +161,10 @@ const expenses = require(`${libs}/routes_v1/expenses`); const expensesParser = require(`${libs}/middlewares/expensesParser`); +const potentialRevenue = require(`${libs}/routes_v1/potentialRevenue`); + +const potentialRevenueParser = require(`${libs}/middlewares/potentialRevenueParser`); + const yearsOfStudy = require(`${libs}/routes_v1/yearsOfStudy`) const studentsReceivingAidTax = require(`${libs}/routes_v1/studentsReceivingAidTax`) @@ -254,6 +258,7 @@ api.use('/course_aggregate', courseAggregate); api.use('/federativeEntity', federativeEntity); api.use('/uni_offer_aggregate', uniLocalOfferAggregate); api.use('/expenses', expensesParser, expenses); +api.use('/potential_revenue', potentialRevenueParser, potentialRevenue); api.use('/years_of_study', yearsOfStudy) api.use('/students_receiving_aid_tax', studentsReceivingAidTax); api.use('/superior_education_conclusion_tax', superiorEducationConclusionTax) diff --git a/src/libs/routes_v1/potentialRevenue.js b/src/libs/routes_v1/potentialRevenue.js new file mode 100644 index 0000000000000000000000000000000000000000..3355791612e2f339d01bf6fab489e4ca94c1ea76 --- /dev/null +++ b/src/libs/routes_v1/potentialRevenue.js @@ -0,0 +1,127 @@ +/* +Copyright (C) 2024 Centro de Computacao Cientifica e Software Livre +Departamento de Informatica - Universidade Federal do Parana - C3SL/UFPR + +This file is part of simcaq-node. + +simcaq-node is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +simcaq-node is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with simcaq-node. If not, see <https://www.gnu.org/licenses/>. +*/ + +const express = require('express'); + +const potentialRevenueApp = express.Router(); + +const libs = `${process.cwd()}/libs`; + +const squel = require('squel'); + +const query = require(`${libs}/middlewares/query`).query; + +const response = require(`${libs}/middlewares/response`); + +const ReqQueryFields = require(`${libs}/middlewares/reqQueryFields`); + +const id2str = require(`${libs}/middlewares/id2str`); + +const config = require(`${libs}/config`); + +const cache = require('apicache').options({ debug: config.debug, statusCodes: {include: [200]} }).middleware; + +const aggregateData = require(`${libs}/middlewares/aggregateData`); + +let rqf = new ReqQueryFields(); + +potentialRevenueApp.use(cache('15 day')); + +potentialRevenueApp.get('/years', (req, res, next) => { + req.sql.from('receitas') + .field('DISTINCT receitas.ano', 'year') + .where('receitas.ano is not null') + next(); +}, query, response('years')) + +rqf.addField({ + name: 'filter', + field: false, + where: true +}).addField({ + name: 'dims', + field: true, + where: false +}).addValue({ + name: 'min_year', + table: 'receitas', + tableField: 'ano', + resultField: 'year', + where: { + relation: '>=', + type: 'integer', + field: 'ano' + } +}).addValue({ + name: 'max_year', + table: 'receitas', + tableField: 'ano', + resultField: 'year', + where: { + relation: '<=', + type: 'integer', + field: 'ano' + } +}).addValue({ + name: 'region', + table: 'estado', + tableField: ['nome_ente', 'cod_ibge', 'id', 'regiao_id'], + resultField: ['state_name', 'state_cod_ibge', 'state_id', 'region_id'], + where: { + relation: '=', + type: 'integer', + field: 'regiao_id', + }, + join: { + primary: 'id', + foreign: 'cod_ibge', + foreignTable: 'receitas' + } +}) + + +potentialRevenueApp.get('/', rqf.parse(), rqf.build(), (req, res, next) => { + + if (req.query.dims && req.query.dims.includes('receita_potencial')) { + let whereCondition = req.query.filter.includes("region") ? "" : "receitas.cod_ibge = 0"; + let filterId; + const filters = req.query.filter.split(","); + filters.forEach((filter) => { + if (filter.includes("state") || filter.includes("city")) { + filterId = Number(filter.split(":")[1].replace(/"/g, "")); + whereCondition = `receitas.cod_ibge = ${filterId}` + } + }) + + req.sql.from('receitas') + .field('receitas.ano', 'year') + .field('receitas.ano', 'total_ano') + .field('receitas.nome_ente', 'total_nome_ente') + .field('receitas.receitas', 'total_receitas') + .field('matriculas_publica', 'total_matriculas_publica') + .field('matriculas_publicas_mais_conveniada', 'total_matriculas_publicas_mais_conveniada') + .where(`${whereCondition}`) + .order('receitas.ano'); + } + + next(); +}, query, aggregateData, id2str.transform(false), response('potentialRevenue')); + +module.exports = potentialRevenueApp; \ No newline at end of file diff --git a/src/libs/routes_v1/studentRevenue.js b/src/libs/routes_v1/studentRevenue.js index 271566af3a7fc1ebe53641a7889161c03d601d0c..488e08039260f130236451bb5ad4abf00bd0c5bd 100644 --- a/src/libs/routes_v1/studentRevenue.js +++ b/src/libs/routes_v1/studentRevenue.js @@ -42,7 +42,7 @@ const cache = require('apicache').options({ debug: config.debug, statusCodes: { let rqf = new ReqQueryFields(); -studentRevenueApp.use(cache('15 day')); +// studentRevenueApp.use(cache('15 day')); studentRevenueApp.get('/years', (req, res, next) => { req.sql.from('receitas') @@ -123,10 +123,12 @@ studentRevenueApp.get('/', rqf.parse(), rqf.build(), (req, res, next) => { const jsonString = `{${req.query.filter.replace(/(\w+):/g, '"$1":')}}`; obj = JSON.parse(jsonString); if (obj.type) { - if (obj.type.includes("1") && !obj.type.includes("2")) + if (obj.type.includes("1") && !obj.type.includes("2")) { whereCondition = "receitas.cod_ibge >= 11 and receitas.cod_ibge <= 53" - else if (obj.type.includes("2") && !obj.type.includes("1")) + } + else if (obj.type.includes("2") && !obj.type.includes("1")) { whereCondition = "receitas.cod_ibge > 53" + } typeFilter = true; } @@ -134,10 +136,10 @@ studentRevenueApp.get('/', rqf.parse(), rqf.build(), (req, res, next) => { if (!typeFilter || (typeFilter && (!obj.state && !obj.city && !obj.region))) { req.sql.from('receitas') .field('receitas.ano', 'year') - .field('SUM(receuta_aluno_ano_publica)', '(total_receita_aluno_ano_publica)') - .field('SUM(receita_aluno_mes_publica)', 'total_receita_aluno_mes_publica') - .field('SUM(receita_aluno_ano_publica_mais_conveniada)', 'total_receita_aluno_ano_publica_mais_conveniada') - .field('SUM(receita_aluno_mes_publica_mais_conveniada)', 'total_receita_aluno_mes_publica_mais_conveniada') + .field(`SUM(receitas) / SUM(matriculas_publica)`, '(total_receita_aluno_ano_publica)') + .field(`SUM(receitas) / SUM(matriculas_publica) / 12`, 'total_receita_aluno_mes_publica') + .field(`SUM(receitas) / SUM(matriculas_publicas_mais_conveniada)`, 'total_receita_aluno_ano_publica_mais_conveniada') + .field(`SUM(receitas) / SUM(matriculas_publicas_mais_conveniada) / 12`, 'total_receita_aluno_mes_publica_mais_conveniada') .where(`${whereCondition}`) .group('receitas.ano') }