Projeto de Programação 2

Sistema de Delivery de Produtos (MyFood)

O projeto desse semestre será um sistema simples de delivery (baseado no iFood). Vocês deverão implementar esse sistema baseando-se na ideia de testes de aceitação. Para aqueles que não tentaram o projeto enviado para treino, os testes de aceitação são um modo de avaliar se a sua implimentação atende aos requesitos para o sistema que queremos que vocês desenvolvam. Mas não se mantenham somente a isso.

Informações indispensaveis:

• Descrição
• User stories
• Milestones
• Testes de aceitação
• Linguagem de script

Os testes de aceitação acessam apenas a lógica do negócio, não a interface com o usuário. Em um sistema qualquer, interfaces bonitas e fáceis de usar são uma característica muito importante. Entretanto, para facilitar a vida de vocês, só faremos a lógica de negócio do sistema, sem implementação alguma de interface visual com o usuário. Também é uma regra importante separar a interface com o usuário da lógica de negócio e fazer com que seu projeto não tenha interface com o usuário é uma forma de você sacar esse ponto arquitetural importante.

Como no projeto "teste", aqui vocês terão que projetar e implementar o sistema de uma forma incremental. Haverá alguns milestones e, em cada um, novas funcionalidades serão adicionadas ao sistema. As funcionalidades estão descritas dentro de User Stories. Uma User Story (us) consiste de duas partes:

• uma descrição do que se deseja em termos de funcionalidade e das interações que o sistema deve suportar
• um conjunto formal de testes que, se executarem sem erros inesperados, comprovam que a funcionalidade foi implementada como desejada.

Em cada um dos milestones no repositorio do GitHub, haverá um conjunto de user stories que deverá ser implementado.

Descrição geral

O propósito do projeto é de construir um sistema de delivery. O sistema consiste de um aplicativo onde seja possível realizar cadatro de empresas (restaurantes, mercados, farmacias, etc...), clientes (usuários) e entregadores. Além dos seus dados associados tais como produtos e pedidos. O sistema deve ser capaz de atender a demanda de usuários famintos.

Você pode baixar os testes de aceitação pelo repositorio do GitHub. Os quais você deve rodar para saber se o seu sistema está atendendo direitinho os requisitos. Você usará o EasyAccept para rodar os testes. Para poder rodar os testes, vocês precisarão criar uma Facade que acessa a logica do seu sistema segundo uma linguagem de script que foi criada para os testes de aceitação.

Milestone 1
Milestone 2

Persistencia de dados

Num sistema de informação real, a persistência dos dados usaria provavelmente um banco de dados. Não faremos isso aqui. A informação persistente pode ser feita em arquivo XML (vejam java.beans.XMLEncoder e java.beans.XMLDecoder).

Para acessar a business logic de seu programa e poder realizar os testes de aceitação, você precisará implementar uma linguagem de script que consiste nos comandos abaixo. Esses são os comandos usados nos testes de aceitação. (us1.txt, us2.txt, etc.) Cada um deles deve corresponder a um método na sua facade. Observem que nos proprios testes existem algumas explicações sobre as variáveis, atributos e metodos correspondentes.

Obs: estão listados apenas os comandos usados nos testes das User Stories 1 a 4.

      <void> zerarSistema
      <void> encerrarSistema
      <void> criarUsuario nome=<String> email=<String> senha=<String> endereco=<String>
      <int> login email=<String> senha=<String>
      <String> getAtributoUsuario id=<int> atributo=<String>
      <int> criarEmpresa tipoEmpresa=<String> dono=<int> nome=<String> endereco=<String> tipoCozinha=<String>
      <List<List>> getEmpresasDoUsuario idDono=<int>
      <String> getAtributoEmpresa empresa=<int> atributo=<String>
      <int> getIdEmpresa idDono=<int> nome=<String> indice=<int>
      <int> criarProduto empresa=<int> nome=<String> valor=<Float> categoria=<String>
      <void> editarProduto produto=<int> nome=<String> valor=<Float> categoria=<String>
      <String> getProduto nome=<String> empresa=<int> atributo=<String>
      <List> listarProdutos empresa=<int>
      <int> criarPedido cliente=<int> empresa=<int>
      <void> adcionarProduto numero=<int> produto=<int>
      <String> getPedidos numero=<int> atributo=<String>
      <void> fecharPedido numero=<int>
      <void> removerProduto pedido=<int> produto=<String>
      <int> getNumeroPedido cliente=<int> empresa=<int> indice=<int>
    

Obs: estão listados apenas os comandos novos nos testes das User Stories 5 a 8.

      <int> criarEmpresa tipoEmpresa=<String> dono=<int> nome=<String> endereco=<String> tipoCozinha=<String> abre=<String> fecha=<String> tipoMercado=<String>
      <int> criarEmpresa tipoEmpresa=<String> dono=<int> nome=<String> aberto24Horas=<Boolean> numeroFuncionarios=<int>
      <void> alterarFuncionamento mercado=<int> abre=<String> fecha=<String>
      <void> cadastrarEntregador empresa=<int> entregador=<int>
      <int> criarUsuario nome=<String> email=<String> senha=<String> endereco=<String> veiculo=<String> endereco=<placa>
      <List> getEntregadores empresa=<int>
      <List> getEmpresas entregador=<int>
      <void> liberarPedido numero=<int>
      <int> obterPedido entregador=<int>
      <int> criarEntrega pedido=<int> entregador=<int> destino=<String>
      <String> getEntrega id=<int> atributo=<String>
      <int> getIdEntrega pedido=<int>
      <void> entregar entrega=<int>
    

Teremos 2 milestones.
Vocês vão observar que não pedi interface gráfica (Swing ou Web). Tem dois motivos:

• Não quero que você gaste tempo com GUI
• Não haverá perigo de colocar lógica de negócio na interface se não tiver GUI

Instruções de Entrega do Projeto My Food

1. Formato de Entrega:
   • O projeto deve ser entregue em link para um repositório GitHub.
   • O repositório deve conter:
     • O código que foi desenvolvido;
     • O relatório especificado abaixo;
   • Será considerado o último commit antes da data final.
2. Testes em Máquina Diferente:
   • É fundamental testar o projeto em uma máquina diferente daquela onde foi desenvolvido.
   • Garanta que todas as funcionalidades operem adequadamente nesse ambiente.
3. Penalidade por Falha na Compilação:
   • Caso o projeto não compile, será aplicada uma penalidade equivalente a 20% do prazo total do projeto.
   • É essencial realizar testes abrangentes em várias máquinas para evitar esse problema.
4. Conteúdo do Relatório::
   • Descrição geral do design arquitetural do sistema.
   • Principais componentes e suas interações.
   • Para cada padrão de projeto adotado no desenvolvimento do sistema, inclua uma seção dedicada com os seguintes tópicos:
     • Nome do Padrão de Projeto.
     • Descrição Geral: Explique o padrão de projeto em termos gerais, focando em sua estrutura e propósito.
     • Problema Resolvido: Descreva o tipo específico de problema que o padrão é destinado a resolver.
     • Identificação da Oportunidade: Explique como e por que a oportunidade de aplicar este padrão foi identificada no contexto do seu projeto.
     • Aplicação no Projeto: Detalhe como o padrão foi implementado no desenvolvimento do sistema, com exemplos práticos de seu uso.
5. Critérios de Avaliação::
   • Compilação (0%): O programa deve compilar corretamente. Caso contrário, o projeto será penalizado.
   • Testes de Aceitação (50%): Todos os testes de aceitação devem ser executados com sucesso. Cada teste não funcional retira 1 ponto (sobre 8).
   • Qualidade do Código (20%): Avaliação da legibilidade, modularidade e manutenção do código.
   • Qualidade do Design (20%): Análise das entidades principais, seus métodos e relacionamentos. Atribuindo uma nota de 0 a 10.
   • Qualidade do Relatório (10%): Avaliado a clareza e abrangência do relatório, atribuindo uma nota de 0 a 10.
6. Revisão do Projeto::
   • A correção do projeto seguirá os critérios e pesos estabelecidos.
   • A falta de compilação ou falha nos testes de aceitação resultará em penalidades.
   • No Milestone 1, apenas as user stories us1_1 até us4_2 serão testadas.
   • No Milestone 2, todas as stories serão testadas.