marlysson / appevents

Modelagem e aplicação de um sistema de gerenciamento de eventos.

Projeto AppEventos

Projeto com o objetivo de inicialmente construir um design de classes coeso e claro, para criar uma estrutura orientada a objetos consistente e de fácil manutenção.

Como o projeto está estruturado?

• Abstrações : Contém as classes que servem de base para a existência de outras, uma estrutura padrão para classes derivadas implementarem determinado comportamento. Pode conter classes normais, e classes de comportamento ( interfaces ).

• Documentação : Contém a modelagem das classes. Possui o arquivo de requisitos do projeto, e imagem + arquivo modelado( no software asta ) com o diagrama.

• Fábricas : Aqui ficarão classes responsáveis pela construção de objetos, não expondo o construtor do mesmo, assim , encapsulando o processo de criação dos objetos.

• Enums : Nessa pasta estão os Enums implementados em python, onde cada um deles definem constantes e alguns atributos essenciais para poder servir de suporte à algumas implementações.

• Modelo : As classes responsáveis por implementar as entidades que interagem dentro do sistema, fazendo ele funcionar.

• Services : Nessa pasta estarão localizados as classes que servirão de suporte para representar algum comportamento/abstração de alguma lib built-in do Python , criando uma abstração legível para se trabalhar no modelo.

Exemplo:

• Abstração da lib date e tratamento de intervalos de tempo.

>>> horario = Horario()
>>> horario.mais("1 dia")
21/09/2016 07:50

>>> duracao = Duracao(horario,durando="20 minutos")
>>> duracao.inicio
21/09/2016 07:50
>>> duracao.final
21/09/2016 08:10

• Testes : Pacote responsável pelos testes de integridade e comportamento dos objetos que serão criados ao longo da app. Cada requisito do pdf que está em documentação há um teste na medida do possível para ele.

E como está a modelagem ?

E como executar ele ?

O projeto inicialmente não possui dependência. Então é só dá um clone e começar a dá uma mexida. 😄 👍

git clone https://github.com/Marlysson/AppEvents.git
cd AppEvents
...coding...

Testando

Recomenda-se a versão 3.x do Python.

Basta entrar na pasta testes do projeto e rodar o comando:

python3 -m unittest discover

Assim rodará todos os testes que estão na pasta respectiva. 👍

E para contribuir ?

Assim como em qualquer outro projeto os passos são basicamente esses.

git clone https://github.com/Marlysson/AppEvents.git
git branch <funcionalidade> #Criar um branch para a sugestão
git push origin funcionalidade

E mandar um Pull Request do seu novo branch no repositório original.

appevents's Issues

Verificar a exceção quando se cadastrar com prazo expirado.

Usar a lib unittest.mock pois o prazo está utilizando datas , e não tem como avançar no tempo e validar no futuro :p

Usar mock pra emular a data do prazo de inscrições.

Mover enumerações para suas respectivas classes

Remanejar "Enums" ( simulados ) para de arquivo para dentro das classes associadas.

Exemplo:

class TipoEvento(Enum):
    SIMPOSIO = "Simpósio"
    SEMANA_CIENTIFICA = "Semana científica"
...

Para:

class Evento(object):
    SIMPOSIO , SEMANA_CIENTIFICA = "Simpósio", "Semana Científica"

print(Evento.SIMPOSIO)

Separar responsabilidades da classe Horario()

• Deixar ela somente representando um horário legível
• Encapsular em uma classe o formato dela nativo
• Criar classe DisplayHorario(horario) recebendo um horario e o formato.

Separar responsabilidades.