Esse projeto contém uma série de informações sobre o que eu aprendi aqui na Trybe ao longo do curso de desenvolvimento web da Trybe.
Neste projeto foi possível utilizar a Programação Orientada a Objetos! Foi implementado um gerador de relatórios que recebe como entrada arquivos com dados de um estoque e gera, como saída, um relatório acerca destes dados.

Esses dados de estoque poderão ser obtidos de diversas fontes:

• Através da importação de um arquivo CSV;

• Através da importação de um arquivo JSON;

• Através da importação de um arquivo XML.

Além disso, o relatório final possuirá duas versões: simples e completa.

Esse projeto foi proposto pelo curso de desenvolvimento web da Trybe.

Esse projeto foi desenvolvido no bloco de ciências da computação e foi possível treinar a linguagem Python, os padrões: Iterator, Adapter, Strategy, Decorator, Observer, Factory.

Os commits foram feitos de acordo com os requisitos finalizados.

Todo o projeto foi feita na branch juliana-oliveira-inventory-report.

Antes de rodar a aplicação, é preciso criar e instalar o ambiente virtual, através dos comandos:

• python3 -m venv .venv && source .venv/bin/activate
  
• python3 -m pip install -r dev-requirements.txt

  $ python3 -m pytest

O arquivo pyproject.toml já configura corretamente o pytest. Entretanto, caso você tenha problemas com isso e queira explicitamente uma saída completa, o comando é:

python3 -m pytest -s -vv

Caso precise executar apenas um arquivo de testes basta executar o comando:

python3 -m pytest tests/nomedoarquivo.py

Caso precise executar apenas uma função de testes basta executar o comando:

python3 -m pytest -k nome_da_func_de_tests

Se desejar que os testes parem de ser executados quando acontecer o primeiro erro, use o parâmetro -x

python3 -m pytest -x tests/test_simple_report.py

Caso queria executar um teste especifico de um arquivo basta executar o comando:

python3 -m pytest -x tests/nomedoarquivo.py::test_nome_do_teste

Esse foi um projeto individual.

Foi usado Visual Studio Code, além do Trello que auxiliou na organização das tarefas.

Legenda:
🔸Arquivos que não podem ser alterados
🔹Arquivos a serem alterados para realizar os requisitos.
.
├── inventory_report
│   ├── data
│   │   ├── 🔸inventory.csv
│   │   ├── 🔸inventory.json
│   │   └── 🔸inventory.xml
│   ├── importer
│   │   ├── 🔹csv_importer.py
│   │   ├── 🔹importer.py
│   │   ├── 🔹json_importer.py
│   │   └── 🔹xml_importer.py
│   ├── inventory
│   │   ├── 🔹inventory_iterator.py
│   │   ├── 🔹inventory_refactor.py
│   │   └── 🔹inventory.py
│   │   └── 🔸product.py
│   ├── reports
│   │   ├── 🔸colored_report.py
│   │   ├── 🔹complete_report.py
│   │   └── 🔹simple_report.py
│   └── 🔹main.py
└── tests
│   ├── factories
│   │   ├── 🔸__init__.py
│   │   └── 🔸product_factory.py
│   ├── product
│   │   ├── 🔸__init__.py
│   │   ├── 🔸conftest.py
│   │   ├── 🔸mocks.py
│   │   └── 🔹test_product.py
│   ├── product_report
│   │   ├── 🔸__init__.py
│   │   ├── 🔸conftest.py
│   │   ├── 🔸mocks.py
│   │   └── 🔹test_product_report.py
│   ├── report_decorator
│   │   ├── 🔸__init__.py
│   │   ├── 🔸conftest.py
│   │   ├── 🔸mocks.py
│   │   └── 🔹test_report_decorator.py
│   ├── 🔸__init__.py
│   ├── 🔸marker.py
│   ├── 🔸test_complete_report.py
│   ├── 🔸test_importer.py
│   ├── 🔸test_inventory_refactor.py
│   ├── 🔸test_inventory.py
│   ├── 🔸test_main.py
│   └── 🔸test_simple_report.py
├── 🔹dev-requirements.txt
├── 🔸docker-compose.yml
├── 🔸Dockerfile
├── 🔸pyproject.toml
├── 🔸README.md
├── 🔸requirements.txt
├── 🔸setup.cfg
├── 🔸setup.py
└── 🔸trybe.yml

id,nome_do_produto,nome_da_empresa,data_de_fabricacao,data_de_validade,numero_de_serie,instrucoes_de_armazenamento
1,cadeira,Target Corporation,2021-02-18,2025-09-17,CR25,empilhadas
2,mesa,"Galena Madeira, Inc.",2022-12-06,2026-12-25,FR29,desmontadas
3,abajur,Keen Iluminação,2019-12-22,2025-11-07,CZ09,em caixas

[
  {
    "id":1,
    "nome_do_produto":"Borracha",
    "nome_da_empresa":"Papelaria Solar",
    "data_de_fabricacao":"2021-07-04",
    "data_de_validade":"2029-02-09",
    "numero_de_serie":"FR48",
    "instrucoes_de_armazenamento":"Ao abrigo de luz solar"
  }
]

<?xml version='1.0' encoding='UTF-8'?>
<dataset>
  <record>
    <id>1</id>
    <nome_do_produto>Microfone</nome_do_produto>
    <nome_da_empresa>Tecno Uau LTDA</nome_da_empresa>
    <data_de_fabricacao>2021-10-27</data_de_fabricacao>
    <data_de_validade>2032-08-31</data_de_validade>
    <numero_de_serie>MT08</numero_de_serie>
    <instrucoes_de_armazenamento>Longe de fonte de calor</instrucoes_de_armazenamento>
  </record>
</dataset>

No trabalho do desenvolvimento de software a gente sempre tem prazos, muitas vezes os prazos são apertados.
Por outro lado, eu não quero criar algo que não entendo perfeitamente, como também fazer códigos rápidos pode levar a erros que podem demorar muito pra corrigir.
Por isso, usei e sempre uso o método Baby Steps, que é uma estratégia de abordar o desafio passo à passo, defensivamente.
Baby steps é um termo em inglês que quer dizer passos de bebê. Refere-se a fazer as coisas, quaisquer que sejam, devagar, com calma, passo a passo.

Crie o teste em: tests/product/test_product.py

Ao analisar o código do projeto, você encontrará a classe do objeto produto já implementada neste arquivo: inventory_report/inventory/product.py, a classe Product.

Para termos confiança em continuar as implementações, precisamos que você implemente o teste, que certifique que o método __init__ da classe Product esta funcionando corretamente.

O nome deste teste deve ser test_cria_produto, ele deve verificar o correto preenchimento dos seguintes atributos:

• id (int)
• nome_da_empresa (string)
• nome_do_produto (string)
• data_de_fabricacao (string)
• data_de_validade (string)
• numero_de_serie (string)
• instrucoes_de_armazenamento (string)

Crie o teste em: tests/product_report/test_product_report.py

Boa novidade, o primeiro relatório já implementamos neste arquivo inventory_report/inventory/product.py. Formulamos uma frase construída com as informações do produto, que será muito útil para etiquetarmos o estoque.

Para desenvolver este relatório, utilizamos o recurso __repr__ do Python, que permite alterar a representatividade do objeto, para que sempre que usarmos um print nele, no lugar de endereço de memória, teremos uma String personalizada.

Dica: A reimplementação do __repr__ não faz o objeto retornar exatamente uma string, fazer um cast para string, pode te ajudar.

Exemplo da frase:

O produto farinha fabricado em 01-05-2021 por Farinini com validade até 02-06-2023 precisa ser armazenado ao abrigo de luz.

Agora para mantermos uma boa cobertura de testes, precisamos que você implemente o teste.

O nome deste teste deve ser test_relatorio_produto, ele deve instanciar um objeto Product e verificar se acessá-lo a frase de retorno esta correta.

Crie a classe em: inventory_report/reports/simple_report.py

O relatório deve ser gerado através de um método estático ou de classe chamado generate escrito dentro da classe SimpleReport.

• Ao rodar os testes localmente, você terá um teste para cada validação de cada informação
• Deve ser possível executar o método generate sem instanciar um objeto de SimpleReport
• O método deve receber um parâmetro que representa uma list (estrutura de dados), onde cada posição contém um dict(estrutura de dados).

Exemplo de formato de entrada

   [
     {
       "id": 1,
       "nome_do_produto": "CADEIRA",
       "nome_da_empresa": "Forces of Nature",
       "data_de_fabricacao": "2022-04-04",
       "data_de_validade": "2023-02-09",
       "numero_de_serie": "FR48",
       "instrucoes_de_armazenamento": "Conservar em local fresco"
     }
   ]

• O método deverá retornar uma string de saída com o seguinte formato:

  Data de fabricação mais antiga: YYYY-MM-DD
  Data de validade mais próxima: YYYY-MM-DD
  Empresa com mais produtos: NOME DA EMPRESA

• A data de validade mais próxima, somente considera itens que ainda não venceram.

Dica: O módulo datetime pode te ajudar.

Crie em: inventory_report/reports/complete_report.py

O relatório deve ser gerado através de um método generate para a classe CompleteReport. Ele deverá receber dados numa lista contendo estruturas do tipo dict e deverá retornar uma string formatada como um relatório.

• A classe CompleteReport deve herdar da classe SimpleReport e sobrescrever o método generate, de modo a especializar seu comportamento.

• Deve ser possível executar o método generate sem instanciar um objeto de CompleteReport

• O método deve receber de parâmetro uma lista de dicionários no seguinte formato:

  [
    {
      "id": 1,
      "nome_do_produto": "MESA",
      "nome_da_empresa": "Forces of Nature",
      "data_de_fabricacao": "2022-05-04",
      "data_de_validade": "2023-02-09",
      "numero_de_serie": "FR48",
      "instrucoes_de_armazenamento": "Conservar ao abrigo de luz"
    }
  ]

• O método deverá retornar uma saída com o seguinte formato:

Data de fabricação mais antiga: YYYY-MM-DD
Data de validade mais próxima: YYYY-MM-DD
Empresa com mais produtos: NOME DA EMPRESA
Produtos estocados por empresa:
- Physicians Total Care, Inc.: QUANTIDADE
- Newton Laboratories, Inc.: QUANTIDADE
- Forces of Nature: QUANTIDADE

Crie em: inventory_report/inventory/inventory.py

A importação do arquivo CSV deve ser realizada através do método import_data que você deve criar em uma classe chamada Inventory.

O método deve ser estático ou de classe, ou seja, deve ser possível chamá-lo sem instanciar um objeto da classe.

O método receberá como primeiro parâmetro uma string como caminho para o arquivo CSV e como segundo parâmetro uma string que representa o tipo de relatório a ser gerado. Tipos:

• "simples"
• "completo"

De acordo com os parâmetros recebidos, deve recuperar os dados do arquivo e chamar o método de gerar relatório correspondente à entrada passada. Ou seja, o método da classe Inventory deve chamar o método generate da classe que vai gerar o relatório (SimpleReport, CompleteReport).

Incremente em: inventory_report/inventory/inventory.py.

📌 Utilize o mesmo método do requisito anterior.

Altere o método import_data para que ele também seja capaz de carregar arquivos JSON.

Como no requisito anterior, o método ainda receberá como primeiro parâmetro uma string como caminho para o arquivo, e como segundo parâmetro uma string que representa o tipo de relatório a ser gerado. Tipos:

• "simples"
• "completo"

De acordo com os parâmetros recebidos, deve recuperar os dados do arquivo e chamar o método de gerar relatório correspondente à entrada passada. Ou seja, o método da classe Inventory deve chamar o método generate da classe que vai gerar o relatório (SimpleReport, CompleteReport).

Incremente em: inventory_report/inventory/inventory.py.

📌 Utilize o mesmo método do requisito anterior.

Altere o método import_data para que ele também seja capaz de carregar arquivos XML.

Como no requisito anterior, o método ainda receberá como primeiro parâmetro uma string como caminho para o arquivo, e como segundo parâmetro uma string que representa o tipo de relatório a ser gerado. Tipos:

• "simples"
• "completo"

De acordo com os parâmetros recebidos, deve recuperar os dados do arquivo e chamar o método de gerar relatório correspondente à entrada passada. Ou seja, o método da classe Inventory deve chamar o método generate da classe que vai gerar o relatório (SimpleReport, CompleteReport).

Dica: 👀 Dê uma olhada na biblioteca externa xmltodict

Crie em: inventory_report/importer/importer.py

Como pôde observar até aqui, o método import_data está com muitas responsabilidades, e, com o intuito de resolver isso, podemos dividir a sua complexidade para cada formato de arquivo.

O padrão de projeto Strategy nos ajuda a isolar cada estratégia em um objeto, e por meio de uma Interface podemos padronizar a assinatura dos métodos, garantindo que todas elas possuam o comportamento similar.

• Ao rodar os testes localmente, você terá um teste para cada validação de cada informação

• Crie uma classe abstrata Importer para ser a interface da estratégia

• A Interface será uma classe abstrata Importer terá três classes de estratégias herdeiras: CsvImporter, JsonImporter e XmlImporter.

• Crie as classes nos respectivos arquivos:

  inventory_report/importer/csv_importer.py inventory_report/importer/json_importer.py inventory_report/importer/xml_importer.py

• A classe abstrata deve definir a assinatura do método import_data a ser implementado por cada classe herdeira. Esse método deve ser estático ou de classe, e deve receber como parâmetro o nome do arquivo a ser importado.

• O método import_data definido por cada classe herdeira deve lançar uma exceção do tipo ValueError caso a extensão do arquivo passado por parâmetro seja inválida. Por exemplo, quando se passa um caminho de um arquivo com extensão .csv para o JsonImporter. A mensagem de erro da exceção deve ser "Arquivo inválido".

• O método deverá ler os dados do arquivo passado e retorná-los estruturados em uma lista de dicionários conforme exemplo abaixo:

  [
    {
      "id": 1,
      "nome_do_produto": "Cafe",
      "nome_da_empresa": "Cafes Nature",
      "data_de_fabricacao": "2020-07-04",
      "data_de_validade": "2023-02-09",
      "numero_de_serie": "FR48",
      "instrucoes_de_armazenamento": "instrucao"
    }
  ]

Crie o teste em: tests/report_decorator/test_report_decorator.py

Uma versão deste relatório será exibida em letreiros em Led, estes letreiros são coloridos, para isso, já implementamos o método responsável por retornar este relatório em cores.

Implementamos em : inventory_report/reports/colored_report.py

Em vez de criarmos uma classe que herda os relatórios originais, utilizamos o padrão Decorator para receber o tipo do relatório por composição (SimpleReport ou CompleteReport) e, assim, colorir o retorno do método generate, que recebe uma lista de produtos e retorna o relatório já colorido.

Para termos confiança que as cores sairão corretamente, precisamos que você implemente o teste, que certifique que o método generate de ColoredReport funciona corretamente.

Para que o Python consiga colorir as strings, é preciso que a string contenha o início do código da cor, e o reset da cor.

📌 Execute este print teste em um terminal interativo python3 -i. O resultado das cores podem não ser exatos, por isso, atente-se aos códigos deste exemplo:

print("\033[36mAzul\033[0m \033[32mVerde\033[0m \033[31mVermelho\033[0m")

O nome deste teste deve ser test_decorar_relatorio, ele deve verificar se o relatório está devidamente colorido. Representamos abaixo como deve ser a disposição das cores:

🟩Data de fabricação mais antiga:🟩 🟦10-05-2022🟦

🟩Data de validade mais próxima:🟩 🟦14-06-2021🟦

🟩Empresa com mais produtos:🟩 🟥Farinini🟥