Projeto para a disciplina de Domínios de Software - 2019/02 - do curso de Engenharia de Software (INF/UFG).
Utilizamos os seguintes comandos maven para fazer testes, gerar documentação, análise de dependência e análise estática.
O relatório da documentação (javadocs) encontra-se aqui.
O relatório da cobertura dos testes encontra-se aqui.
O relatório de análise estática encontra-se aqui.
Para gerar relatório de spotbugs e dependency-check utilizar comandos.
- Identificação dos componentes do grupo
- Problema
- Objetivo
- Identificação dos componentes do sistema
- Identificação dos usuários finais
- Fontes de requisitos
- Requisitos funcionais
- Diagrama de casos de uso
- Casos de uso detalhados
- Diagrama de classes
- Programação das entregas dos requisitos
Desenvolvido pelos alunos: @alicefrancener, @caiobas, @danielfreitasbs e @ottoleggio.
Há várias instituições, ONGs e grupos de voluntários que promovem ações/eventos visando impactar positivamente a sociedade. Para que essas ações aconteçam são necessários voluntários, encontrar voluntários adequados é uma dificuldade para as instituições.
Há pessoas que têm vontade de participar de ações voluntárias porém enfrentam a dificuldade de não ter conhecimento adequado de quais ações existem, de que tipo, quando acontecem e como participar.
Há também pessoas que já têm conhecimento das ações e já são voluntários em instituições, porém para as quais a instituição/ONGs têm uma dificuldade em saber e gerenciar quem irá participar da ação.
O sistema LigAção será uma plataforma no qual instituições possam promover suas ações e na qual pessoas possam ter conhecimento dessas ações e possam se inscrever para participar delas.
O sistema será uma plataforma web com portabilidade para ambientes mobile.
Utilizaremos a API de login do Facebook para facilitar o login na plataforma.
Legislação pertinente ao domínio:
- Lei sobre voluntariado (Lei nº 9.608, de 18/02/1998)
- Lei sobre OSCIP (Lei nº 9.790, de 23/03/1999).
- Instituições, movimentos sociais, ONGs e grupos de voluntários que desejam divulgar suas ações sociais para atingir mais pessoas. Esses usuários são identificados no projeto como Promotores de Ações.
- Voluntários e pessoas interessadas em participar presencialmente de ações voluntárias. São identificados no projeto como Voluntários
| Necessidades gerais | Usuário |
|---|---|
| Cadastrar ações | Promotores de ações |
| Gerenciar quem poderá participar das ações | Promotores de ações |
| Ter conhecimento de quais ações existem em sua cidade | Voluntários |
| Escolher ações de acordo com seu interesse | Voluntários |
| Obter informações sobre a ação (data, hora, local, etc) | Voluntários |
| Se inscrever em ações | Voluntários |
| Fonte | Técnica de coleta | Motivação |
|---|---|---|
| Voluntários e promotores de ações | Questionário-online | O questionário nos permite atingir várias pessoas usando somente uma técnica |
| Voluntários e promotores de ações | Entrevistas | Com entrevistas, podemos ter maior compreensão das reais necessidades de ações dos usuários, validar e refinar requisitos |
| Promotores de ações1 | Observação direta de divulgação de ações na internet | Ao analisar como as ações são divulgadas atualmente poderemos compreender melhor de que forma nosso sistema pode ajudar, que lacuna poderia preencher |
| Sistemas existentes que conectam voluntários à instituições2 | Análise de concorrência | A observação de sistemas que já existem dentro do domínio nos permite analisar principais funções existentes e se atendem necessidades dos usuários |
| Sistemas para divulgar eventos3 | Análise de concorrência | Ações voluntárias têm características similares à eventos gerais (congressos, palestras, workshops). Dessa forma, observar sistemas que servem para divulgar eventos nos permite obter as funcionalidades gerais necessárias para promoção de eventos e inscrição de pessoas. |
1 Lista de promotores de ações: Projeto Solidarie, Ensinando Abraçar, Goiânia Invisível, Pão com Amor, Grupo Miau AuAu, Nós + Árvores, EcomAmor, Banho do Bem, Vida Lata
2 Lista de sistemas que conectam voluntários à instituições: Sistema Voluntário, Ação Voluntária, Voluntários, Parceiros Voluntários, Volunteer Match, GiveGab
3 Lista de sistemas para divulgar eventos e nos quais as pessoas podem se inscrever: Sympla, Eventuzz, Eventbrite, Meetup
RF <número único do requisito funcional>: como <ator/(sub)sistema> , desejo <ação/objetivo/meta> , para que <razão/benefício>.
RF01: como Promotor de ações, desejo cadastrar uma nova ação, para que possa recrutar novos candidatos. São os dados que comporão o perfil da ação: nome do Promotor da ação, categoria da ação, nome da ação, local, data, horário início, horário fim, descrição e imagem descritiva da ação (opcional). As categorias de ações serão: Projeto Social, Ambiental, Animal, Educação, Esportes, Arte e Cultura.
RF02: como Promotor de ações, desejo alterar dados (categoria da ação, nome da ação, descrição e imagem descritiva da ação) de uma ação existente, para que possa adequá-la a algum imprevisto.
RF03: como Promotor de ações, desejo cancelar uma ação existente com opção de adicionar uma justificativa, para que possa ajustá-la a algum imprevisto que a impossibilite de acontecer.
RF04: como Promotor de ações, desejo poder filtrar os candidatos de acordo com os atributos de seus perfis, para que eu possa selecionar as pessoas que se encaixam ao trabalho. Alguns atributos dos candidatos que poderão ser filtrados serão: idade, cidade, profissão, categorias de interesse do candidato, ações realizadas e avaliação do voluntário.
RF05: como Promotor de ações, desejo poder convidar os candidatos para minhas ações de acordo com os atributos de seus perfis, para que eu possa aumentar as chances de ter pessoas que mais se encaixam ao trabalho.
RF06: como Promotor de ações, desejo poder avaliar os voluntários através de uma pontuação de 0 a 5 em critérios (dedicação, pontualidade), para que no futuro aquele candidato possa ser selecionado de acordo com seu histórico.
RF07: como Voluntário, desejo filtrar ações disponíveis de acordo com seus atributos, para que possa selecionar uma que mais me agrada. Alguns atributos das ações que poderão ser filtrados serão: cidade, categoria da ação, nome do promotor de ações.
RF08: como Voluntário, desejo poder me inscrever em ações, para que possa participar como voluntário. Para se inscrever será necessário nome e e-mail do voluntário.
RF09: como Voluntário, desejo poder avaliar as organizações após a realização da ação, para que no futuro aquela organização possa ser selecionada de acordo com seu histórico.
RF10: como Promotor de ações, desejo criar (create) meu perfil no sistema LigAção, para que possa utilizar todas as funcionalidades do sistema. O promotor de ações poderá se cadastrado como pessoa física ou jurídica. Seguem os dados que comporão o perfil do promotor de ações: nome de pessoa física responsável, CPF do responsável, nome do promotor de ações, tipo de promotor (pessoa física ou jurídica), CNPJ do promotor (obrigatório somente se for pessoa jurídica), razão social (obrigatório somente se for pessoa jurídica), data da fundação, foto de perfil, links para redes sociais e site (opcionais), categorias das ações realizadas, descrição geral, telefone, endereço, nome de usuário, e-mail e senha.
RF11: como Promotor de ações, desejo ler (read) meu perfil no sistema LigAção, para que possa listar meus dados e verificar se estão corretos. Os dados retornados serão os mesmos citados no RF10.
RF12: como Promotor de ações, desejo editar (update) meu perfil no sistema LigAção, para que possa corrigir e manter atualizados meus dados. Os dados que poderão ser atualizados serão os mesmos citados no RF10.
RF13: como Promotor de ações, desejo excluir (delete) meu perfil no sistema LigAção, para que possa sair do sistema e não deixar os meus dados pessoais disponíveis. Ao excluir o perfil, todas as ações relacionadas ao Promotor serão excluídas também.
RF14: como Voluntário, desejo criar (create) meu perfil no sistema LigAção, para que possa utilizar todas as funcionalidades do sistema. Seguem os dados que comporão o perfil voluntário: nome, foto de perfil, links para redes sociais e site (opcionais), endereço (cidade e estado), profissão/área de atuação, categorias de ações de interesse, nome de usuário, e-mail e senha.
RF15: como Voluntário, desejo ler (read) meu perfil no sistema LigAção, para que possa listar meus dados e verificar se estão corretos. Os dados retornados serão os mesmos citados no RF14.
RF16: como Voluntário, desejo editar (update) meu perfil no sistema LigAção, para que possa corrigir e manter atualizados meus dados. Os dados que poderão ser atualizados serão os mesmos citados no RF14.
RF17: como Voluntário, desejo excluir (delete) meu perfil no sistema LigAção, para que possa sair do sistema e não deixar os meus dados pessoais disponíveis.
Os atores do diagrama abaixo se resumem aos promotores de ações (instituições, movimentos, ONGs e grupos de voluntários que desejam criar ações na plataforma) e aos Voluntários que são pessoas que desejam ter conhecimento e possivelmente se inscrever em ações voluntárias.
O promotor de ações deverá criar um perfil no sistema (cadastro) para poder publicar ações. Esse perfil poderá ser editado e excluído pelo promotor de ações. Além disso, ele poderá também filtrar voluntários (por características do perfil) e convidá-los para ações. As ações publicadas no sistema poderão ser alteradas ou canceladas. E os voluntários que participarem das ações poderão ser avaliados ao final da ação pelo promotor da ação.
Os voluntários poderão criar um perfil no sistema e editá-lo e excluí-lo quando quiserem. Poderão também pesquisar por ações de acordo com características (tipo de ação, data de realização, local) e se inscrever. Também poderão avaliar os promotores de ação após participarem de alguma ação.
Na primeira iteração, considerando o ator Promotor, foram implementados os casos de uso: cadastrar ação, editar ação, criar perfil e editar perfil. Para o ator Voluntário foram implementados: inscrever em ação.
Na segunda iteração, foram implementados os casos de uso - ator Promotor: excluir ação, excluir perfil. E para o ator Voluntário: criar perfil e editar perfil.
Os casos de uso que não foram implementados ainda incluem: avaliar ação (ator Voluntário) e avaliar voluntário (ator Promotor).
Ator: Promotor de ação
Pré-condições: Promotor de ação cadastrado e logado no sistema
Pós-condições: A ação foi cadastrada
Fluxo principal:
- O promotor de ação solicita a criação de uma nova ação
- O sistema exibe um formulário com os atributos de ações a serem preenchidos: nome da ação, data, horário início, horário fim, descrição, imagem descritiva da ação (opcional), categoria da ação
- O promotor de ação preenche e submete os dados da ação
- O sistema envia mensagem solicitando confirmação da criação da ação
- O sistema registra as informações e envia mensagem ao promotor de ação indicando que a ação foi registrada com sucesso
Fluxos alternativos:
- No passo 1 do fluxo principal, caso o promotor de ação ainda esteja logado, o sistema retornará uma mensagem indicando que o usuário não está logado
- No passo 3 do fluxo principal, caso o promotor não preencha algum dado obrigatório o sistema retornará uma mensagem indicando o(s) campo(s) ausente(s)
- No passo 4 do fluxo principal, se o promotor de ação desistir de cadastrar a ação será direcionado para a página inicial
Ator: Promotor de ação
Pré-condições: Promotor de ação cadastrado e logado no sistema
Pós-condições: A ação foi editada
Fluxo principal:
- O promotor de ação solicita a edição de uma ação
- O sistema exibe todas as ações do promotor presentes no banco de dados
- O promotor indica o nome da ação que deseja editar
- O sistema lista todos os campos que o promotor pode editar
- O promotor indica qual campo deseja editar
- O sistema mostra o valor atual do campo e solicita que o promotor entre com a modificação
- O promotor edita o campo
- O sistema indica que ação foi editada com sucesso
Fluxos alternativos:
- No passo 2 do fluxo principal, caso o promotor não possua ações, o sistema informará e voltará ao menu inicial
- No passo 3 do fluxo principal, caso o promotor indique um nome de ação inexistente o sistema indicará e ao voltará ao menu inicial
- No passo 8 do fluxo principal, se houver um erro na edição da ação, o promotor será informado e retornará ao menu principal
- No passo 8 do fluxo principal, o sistema indica que o promotor pode editar outro campo, caso confirme que deseja o sistema volta para o passo 4, caso cancele, o sistema o envia para o menu principal
Ator: Promotor de ação
Pré-condições: Promotor de ação cadastrado e logado no sistema
Pós-condições: A ação foi excluida
Fluxo principal:
- O promotor de ação solicita a exclusão de uma ação
- O sistema exibe todas as ações do promotor presentes no banco de dados
- O promotor indica o nome da ação que deseja excluir
- O sistema exclui a ação solicitada e retorna ao menu inicial
Fluxos alternativos:
- No passo 2 do fluxo principal, caso o promotor não possua ações, o sistema informará e voltará ao menu inicial
- No passo 3 do fluxo principal, caso o promotor indique um nome de ação inexistente o sistema indicará e ao voltará ao menu inicial
Ator: Promotor de Acao Pré-condições: Ação ter sido realizada Pós-condições: ator com perfil de Promotor de Ação com os dados excluidos da base de dados e assim também suas ações Fluxo principal:
- Ator aciona alternativa de avaliar voluntário;
- Exibicao de formulario para abrir sessao no sistema. Formulario contem atributos usuario e senha;
- Ator informa usuario e senha;
- Exibição de lista enumerada com ações já realizadas;
- Exibicao de mensagem solicitando qual acao o Ator deseja avaliar o voluntário;
- Ator informa numero identificador da acao na listagem;
- Exibicao de lista enumerada com voluntários participantes da ação;
- Exibicao de mensagem solicitando qual voluntario o Ator deseja avaliar;
- Ator informa numero identificador do voluntario na listagem;
- Exibicao de mensagem solicitando avaliacao numerica entre 0 e 5;
- Ator informa valor da avaliacao;
- Exibicao de mensagem confirmando a acao;
Fluxos alternativos:
- No passo 3:
- caso o usuario ou senha esteja incorreto será retornada uma mensagem de finalizacao da operacao e a rotina se encerrará.
- No passo 4:
- Caso não exista ação realizada, será exibida a mensagem nenhuma ação encontrada;
- Rotina será encerrada.
- No passo 6:
- Caso seja informado um valor que não esteja listado, será exibida a mensagem Ação não existe;
- Exibicao da mensagem de solicitacao de selecao da acao;
- No passo 9:
- Caso seja informado um valor que não esteja listado, será exibida a mensagem Voluntário não encontrado;
- Exibicao da mensagem de solicitacao de selecao do voluntário;
- No passo 11:
- Caso seja informado um valor abaixo ou acima do limite especificado, será exibida a mensagem não foi possivel avaliar o voluntário com este valor;
- Exibicao de mensagem de solicitacao de avaliação do voluntario;
- No passo 12:
- Caso informe acao positiva para confirmar a acao de avaliar o voluntario, os dados deverão ser registrados e a rotina será encerrada;
- Caso informe acao negativa para confirmar a acao de avaliar o voluntário, a rotina será encerrada.
Ator: Voluntário Pré-condições: Ação ter sido cadastrada Pós-condições: Voluntário estar cadastrado em uma ação Fluxo principal:
- Ator aciona alternativa de inscrever em ação;
- Exibição de todas as ações disponíveis;
- Ator seleciona a ação ao qual deseja se inscrever;
- Sistema solicita dados para login;
- Ator preenche os dados para login corretamente;
- Exibição de mensagem confirmando cadastro em ação;
Fluxos alternativos:
- No passo 5:
- caso o usuario ou senha esteja incorreto será retornada uma mensagem de finalizacao da operacao e a rotina se encerrará.
Ator: Organização ou pessoa física
Pré-condições: ator promotor de ação com acesso ao cadastro de perfil
Pós-condições: ator com perfil de Promotor de Ação devidamente cadastrado
Fluxo principal:
- Ator aciona solicitação de cadastro
- Exibição de opção de tipo de perfil do promotor(Pessoa Física ou Pessoa Júridica);
- Exibido o formulário de cadastro para Promotor de Ação;
- Ator preenche os atributos corretamente;
- Ator submete formulário de cadastro;
- Entrega de mensagem para o ator confirmar o cadastro ou cancelar a ação;
- Entrega de mensagem de sucesso da ação;
- Formulário é fechado.
Fluxos alternativos:
- No passo 3, caso o ator tenha escolhido a opção Pessoa Física, será exibido o formulário com os seguintes atributos:
- Tipo de promotor(Pessoa Física ou Pessoa Jurídica);
- Nome da pessoa física responsável pelo registro do perfil;
- CPF do responsável;
- Data de Nascimente;
- Foto de perfil;
- Links para redes sociais(opcional);
- Categoria de ações realizadas;
- Descrição geral;
- Telefone;
- Endereço;
- Nome de usuário;
- Email;
- Senha;
- No passo 3, caso o ator tenha escolhido a opção Pessoa Jurídica, será exibido o formulário com os seguintes atributos:
- Tipo de promotor(Pessoa Física ou Pessoa Jurídica);
- Nome da pessoa física responsável pelo registro do perfil;
- CPF do responsável;
- CNPJ;
- Razão Social;
- Data de Fundação;
- Foto de perfil;
- Links para redes sociais(opcional);
- Categoria de ações realizadas;
- Descrição geral;
- Telefone;
- Endereço;
- Nome de usuário;
- Email;
- Senha;
- No passo 5, caso o ator não tenha preenchido todos atributos obrigatórios(todos atributos não marcados como opcional), será entregue uma mensagem para o preenchimento de todos atributos e o formulário terão os dados atribuidos aos atributos limpos.
- No passo 7, caso o ator tenha acionado a ação de confirmar o cadastro no passo 6, será entregue uma mensagem de sucesso.
- No passo 7, caso o ator tenha acionado a ação de cancelar o cadastro no passo 6, será entregue uma mensagem de sucesso na ação de cancelamento.
Ator: Promotor de Acao Pré-condições: Perfil de promotor de acao com registro realizado Pós-condições: ator com perfil de Promotor de Ação com os dados alterados Fluxo principal:
- Ator aciona solicitacao de alteracao de perfil;
- Exibicao de formulario para abrir sessao no sistema. Formulario contem atributos usuario e senha;
- Ator informa usuario e senha;
- Validacao de registro de perfil.
- Exibicao de formulario com atributos que compõe o perfil do Promotor de Acao;
- Exibicao de solicitacao para alteracao de cada atributo que compõe o perfil. Texto solicita a confirmacao se o ator deseja alterar determinado atributo;
- Exibicao de texto solicitando encerramento da edicao de perfil;
Fluxos alternativos:
- No passo 4, caso o usuario ou senha esteja incorreto será retornada uma mensagem de finalizacao da operacao e a rotina se encerrará;
- No passo 6, caso o ator opte pela nao alteracao do atributo, os dados não seram alterados;
- NO passo 6, caso o ator opte pela alteracao do atributo. O mesmo deverá entrar com o novo dado e este substituir o anterior;
- No passo 7, caso o ator opte pelo cancelamento da edicao do perfil nenhum dado será alterado;
- No passo 7, caso o ator opte pela confirmacao da edicao do perfil, todos os dados que foram alterados deverão ser registrados.
Ator: Promotor de Acao Pré-condições: Ator ter registro em base de dados Pós-condições: ator com perfil de Promotor de Ação com os dados excluidos da base de dados e assim também suas ações Fluxo principal:
- Ator aciona a alternativa de exclusao do perfil;
- Exibicao de mensagem para selecao de tipo de perfil do promotor da acao;
- Ator seleciona a alternativa do tipo de perfil que deseja excluir;
- Exibicao de formulario para abrir sessao no sistema. Formulario contem atributos usuario e senha;
- Ator informa usuario e senha;
- Exibicao de mensagem solicitando confirmacao da acao de exclusao;
- Realizada a busca e exclusao de dados do promotor da base de dados;
- Exibicao de mensagem de status da acao;
Fluxos alternativos:
- No passo 5, caso o usuario ou senha esteja incorreto será retornada uma mensagem de finalizacao da operacao e a rotina se encerrará;
- No passo 6, caso o ator opte pela nao exclusao do perfil, os dados não seram alterados e a rotina se encerrará;
Ator: Voluntário Pré-condições: Voluntário com acesso ao cadastro de perfil Pós-condições: Voluntário estar com o perfil criado Fluxo principal:
- Ator aciona alternativa de ações em voluntário;
- Exibição de opções de cadastro ou edição de perfil de voluntário;
- Ator seleciona o cadastro de voluntário;
- Sistema solicita dados para cadastro;
- Ator preenche os dados para cadastro corretamente;
- Exibição de mensagem para confirmação de cadastro de voluntário;
- Ator confirma cadastro;
- Cadastro de voluntário é criado.
Fluxos alternativos:
- No passo 7:
- caso o voluntário não confirme o cadastro o perfil não é criado.
Ator: Voluntário Pré-condições: Voluntário estar cadastrado Pós-condições: Voluntário estar com o perfil editado Fluxo principal:
- Ator aciona alternativa de ações em voluntário;
- Exibição de opções de cadastro ou edição de perfil de voluntário;
- Ator seleciona a edição de voluntário;
- Sistema solicita confirmação e dados para edição;
- Ator preenche os dados para edição;
- Exibição de mensagem confirmando edição de voluntário;
- Edição de voluntário é finalizada.
Fluxos alternativos:
- No passo 3:
- caso o voluntário não selecione nenhuma opção existente a edição de perfil não acontece.
| Identificador | Assunto | Iteração | Fonte do requisito | Última atualização |
|---|---|---|---|---|
| RF01 | Cadastrar ação (Promotor) | #1 | Resultados da entrevista | 02/11/2019 |
| RF02 | Editar ação (Promotor) | #1 | Resultados da entrevista | 02/11/2019 |
| RF08 | Inscrever em ação (Voluntário) | #1 | Resultados da entrevista | 02/11/2019 |
| RF10 | Criar perfil (Promotor) | #1 | Resultados da entrevista | 02/11/2019 |
| RF12 | Editar perfil (Promotor) | #1 | Resultados da entrevista | 02/11/2019 |
| RF03 | Excluir ação (Promotor) | #2 | Resultados da entrevista | 26/11/2019 |
| RF13 | Excluir perfil (Promotor) | #2 | Resultados da entrevista | 26/11/2019 |
| RF14 | Criar perfil (Voluntário) | #2 | Resultados da entrevista | 26/11/2019 |
| RF17 | Editar perfil (Voluntário) | #3 | Resultados da entrevista | 03/12/2019 |