scovl / orgset

MIT License
1 stars 0 forks source link

Solid #3

Open scovl opened 1 year ago

scovl commented 1 year ago

O código precisa obedecer os princípios SOLID https://medium.com/backticks-tildes/the-s-o-l-i-d-principles-in-pictures-b34ce2f1e898. Por exemplo, em src/orgset.py, O código está violando o princípio SOLID de Responsabilidade Única (SRP), pois a classe OrgSet está lidando com várias responsabilidades diferentes, como ler o arquivo de configuração, configurar o arquivo de configuração do Maven, configurar as variáveis de ambiente do HTTP Proxy, configurar o VSCode e o IntelliJ, etc. Essas responsabilidades devem ser divididas em classes distintas para tornar o código mais modular e coeso.

Para corrigir a violação do SRP, pode-se considerar a seguinte refatoração:

Com essa abordagem, cada classe terá uma única responsabilidade e será mais fácil de manter, testar e reutilizar em outras partes do código.

scovl commented 1 year ago

Outro ponto a considerar, é que o código em src/orgset.py, há uma violação do Princípio da Inversão de Dependência, já que a classe OrgSet está dependendo diretamente de classes como configparser, jinja2 e check_os. Isso significa que se essas classes forem modificadas, a classe OrgSet também precisará ser modificada, o que vai contra o Princípio da Inversão de Dependência.

Para melhorar a conformidade com o DIP, pode-se utilizar a injeção de dependência, criando abstrações (interfaces) para cada uma das dependências externas da classe OrgSet. Em seguida, é possível injetar as implementações corretas por meio do construtor da classe, em vez de instanciar diretamente as classes dependentes. Essa abordagem torna a classe OrgSet menos acoplada a essas dependências externas e mais flexível para ser utilizada em diferentes contextos. Além disso, permite que as dependências externas sejam substituídas por outras implementações sem afetar a lógica da classe OrgSet. Isso torna o código mais modular, reutilizável e fácil de manter, de acordo com o Princípio da Inversão de Dependência.