Dominando o Composer

Dominando o Composer

Apresentação realizada em Agosto de 2022, em treinamento interno da IXCSoft, Chapecó - SC, Brasil.

---

Mastering Composer

Presentation held in August 2022, in internal training at IXCSoft, Chapecó - SC, Brazil.

Transcript

1. Dominando o Composer Marcos Marcolin
2. Tópicos • O que é Composer? • Utilização • Dependências • Schema composer.json • Repositórios públicos e privados • Packagist • Publicação de pacotes públicos e privados
3. O que é Composer? Inspirado no npm do Node e no Bundler do Ruby, o Composer foi desenvolvido por Nils Adermann e Jordi Boggiano e foi lançado no ano de 2012 sobre a licença MIT.
4. O que é Composer? O Composer é uma ferramenta para gerenciamento de dependências em PHP. Ele permite que você declare as bibliotecas(códigos reutilizáveis) das quais seu projeto depende e as gerenciará (instalará/atualizará) para você.
5. Requisitos do sistema • Última versão: PHP >= 7.2.5 • Versão mínima: PHP >= 5.3.2 • Windows, Linux ou macOS
6. Instalação • Manual ◦ Instruções: https://getcomposer.org/download/ • Docker ◦ Imagem: https://hub.docker.com/r/composer/composer
7. Uso básico • composer.json ◦ Controla as dependências ◦ Recomendado estar no diretório raíz do projeto ◦ Para publicar no Packagist, é obrigatório atender o item anterior.
8. Uso básico • Chave require
9. Nomes dos pacotes • Para evitar duplicação: ◦ marcosmarcolin/json ◦ joaomaria/json • phpunit/phpunit • monorepo/monorepo
10. Restrições de versão do pacote
11. Instalação das dependências • composer update ◦ Resolve as dependências e grava todas no arquivo composer.lock. • composer install ◦ Faz o download das dependências para a pasta vendor.
12. Instalação das dependências • Faça commit do composer.lock ◦ Versionar este arquivo é importante porque fará com que qualquer pessoa que configure o projeto use exatamente as mesmas versões das dependências que você está usando.
13. Atualizando dependências
14. Exigindo dependência
15. Removendo dependência
16. Carregamento das dependências
17. Adicionando seu próprio autoload
18. Adicionando seu próprio autoload • composer dump-autoload ◦ Geração do arquivo vendor/autoload.php.
19. Dúvida: Porque o PHP não encontra meu pacote?
20. Principais comandos
21. composer init • Criação do composer.json de forma interativa. ◦ Nome ◦ Descrição ◦ Licença ◦ Autor(es) ◦ Etc. • https://getcomposer.org/doc/03-cli.md#init
22. composer install • Lê o arquivo composer.json do diretório atual, resolve as dependências e as instala. ◦ --dev ◦ --no-dev ◦ --no-autoloader ◦ --no-progress ◦ etc. • https://getcomposer.org/doc/03-cli.md#install-i
23. composer update • Resolverá as dependências do composer.lock e poderá fazer: ◦ Upgrade ◦ Downgrade ◦ Options: --dev, --no-dev, --dry-run, etc. • https://getcomposer.org/doc/03-cli.md#update-u
24. composer require • Adicionar nova dependência. ◦ Options: --dev, --dry-run, --prefer-stable, etc. • https://getcomposer.org/doc/03-cli.md#require-r
25. composer remove • Remove uma determinada dependência: • https://getcomposer.org/doc/03-cli.md#remove
26. composer reinstall • Remove a dependência e instala novamente. • https://getcomposer.org/doc/03-cli.md#reinstall
27. Schema composer.json
28. description • Uma breve descrição do pacote. Normalmente, esta é uma linha longa. Necessário para pacotes publicados (bibliotecas). • https://getcomposer.org/doc/04-schema.md#description
29. version • A versão do pacote. Na maioria dos casos, isso não é necessário e deve ser omitido. • Exemplos: ◦ 1.0.0 ◦ 1.0.2 ◦ 1.1.0 ◦ 1.0.0-alpha3 ◦ 1.0.0-beta2 ◦ 1.0.0-RC5 • https://getcomposer.org/doc/04-schema.md#version
30. type • The type of the package. It defaults to library. ◦ library ◦ project ◦ metapackage ◦ composer-plugin • https://getcomposer.org/doc/04-schema.md#type
31. keywords • Uma matriz de palavras-chave às quais o pacote está relacionado. Estes podem ser usados para pesquisa e filtragem. • Exemplo: ◦ logging ◦ database ◦ templating • https://getcomposer.org/doc/04-schema.md#keywords
32. license • A licença do pacote. Isso pode ser uma string ou uma matriz de strings. • Exemplo: ◦ Apache-2.0 ◦ BSD-2-Clause - BSD-3-Clause - BSD-4-Clause ◦ GPL-2.0-only / GPL-2.0-or-later - GPL-3.0-only / GPL-3.0-or-later ◦ LGPL-2.1-only / LGPL-2.1-or-later - LGPL-3.0-only / LGPL-3.0-or-later ◦ MIT • https://getcomposer.org/doc/04-schema.md#license
33. authors https://getcomposer.org/doc/04- schema.md#authors
34. require https://getcomposer.org/doc/04- schema.md#package-links
35. autoload PSR-4 https://getcomposer.org/doc/04- schema.md#package-links
36. classmap https://getcomposer.org/doc/04schema.md#classmap
37. files https://getcomposer.org/doc/04- schema.md#files
38. Outros • funding • suggest • minimum-stability • prefer-stable • scripts • abandoned, etc. • https://getcomposer.org/doc/04-schema.md#json-schema
39. Scripts
40. O que são scripts? Um script, nos termos do Composer, pode ser um retorno de chamada PHP (definido como um método estático) ou qualquer comando executável de linha de comando. Os scripts são úteis para executar o código personalizado de um pacote ou comandos específicos do pacote durante o processo de execução do Composer.
41. Command Eventos • pre-install-cmd: ocorre antes que o comando de instalação seja executado com um arquivo de bloqueio presente. • post-install-cmd: ocorre após o comando de instalação ter sido executado com um arquivo de bloqueio presente. • pre-update-cmd: ocorre antes que o comando de atualização seja executado ou antes que o comando de instalação seja executado sem um arquivo de bloqueio presente. • post-update-cmd: ocorre após a execução do comando de atualização ou após a execução do comando de instalação sem a presença de um arquivo de bloqueio. • etc. • https://getcomposer.org/doc/articles/scripts.md#event-names
42. Eventos • Exemplo:
43. Eventos • Exemplo: ◦ composer cs-check ◦ composer release ◦ composer changelog
44. Eventos
45. Outros eventos • Installer Events ◦ https://getcomposer.org/doc/articles/scripts.md#installer-events • Package Events ◦ https://getcomposer.org/doc/articles/scripts.md#package-events • Plugin Events ◦ https://getcomposer.org/doc/articles/scripts.md#plugin-events
47. Dúvida: Preciso alterar um pacote de terceiro, como devo proceder?
48. Alteração em pacote de terceiros • Pasta vendor é apenas para leitura, é desencorajado o seu versionamento. • Contribuição ao pacote: ◦ Correção de falhas; ◦ Implementação de novos testes; ◦ Nova funcionalidades; ◦ Etc. • Pull Request para GitHub ou Merge Request para GitLab. • Sua alteração pode ser aceita ou não. • Fork.
49. Conflito de dependências
50. Como escolher o melhor pacote?
51. Dúvida: Qual a relação do docker-compose com o composer?
52. Docker • O Docker é uma plataforma open source que facilita a criação e administração de ambientes isolados. Ele possibilita o empacotamento de uma aplicação ou ambiente dentro de um container, se tornando portátil para qualquer outro host que contenha o Docker instalado. • No final das contas: o que é o Docker e como ele funciona? | Blog TreinaWeb
53. Docker • De forma bem resumida, podemos dizer que o Docker é uma plataforma aberta, criada com o objetivo de facilitar o desenvolvimento, a implantação e a execução de aplicações em ambientes isolados. Foi desenhada especialmente para disponibilizar uma aplicação da forma mais rápida possível. • O que é Docker
54. Docker • O Docker tem como objetivo criar, testar e implementar aplicações em um ambiente separado da máquina original, chamado de container. Dessa forma, o desenvolvedor consegue empacotar o software de maneira padronizada. • Docker | O que é Docker, o que são Containers e como isolar ambientes?
55. Docker vs VM
56. Docker-compose • Docker Compose é o orquestrador de containers da Docker. E como funciona um orquestrador em uma orquestra? Ele rege como uma banda deve se comportar/tocar durante uma determinada apresentação ou música. • Com o Docker Compose é a mesma coisa, mas os maestros somos nós! Nós iremos reger esse comportamento através do arquivo chamado docker-compose, semelhante ao Dockerfile, escrito em YAML. • Docker Compose: O que é? Para que serve? O que come? | iMasters
57. Docker-compose • O Docker Compose é utilizado justamente para facilitar o provisionamento e gerenciamento de multi-contêineres principalmente em ambientes de desenvolvimento, testes automatizados ou cenários de execução em um único host. • Docker Compose - Explicado - Blog 4Linux
58. Docker-compose • docker-compose up: cria e inicia os contêineres; • docker-compose build: realiza apenas a etapa de build das imagens que serão utilizadas; • docker-compose logs: visualizar os logs dos contêineres; • docker-compose restart: reinicia os contêineres; • docker-compose ps: lista os contêineres; • docker-compose scale: permite aumentar o número de réplicas de um contêiner; • docker-compose start: inicia os contêineres; • docker-compose stop: paralisa os contêineres; • docker-compose down: paralisa e remove todos os contêineres e seus componentes como rede, imagem e volume.
59. Docker + Docker-compose + Composer
60. Docker + Docker-compose + Composer
61. Docker + Docker-compose + Composer
62. Repositórios
63. O que são repositórios? Um repositório é uma fonte de pacote. É uma lista de pacotes/versões. O Composer irá procurar em todos os seus repositórios para encontrar os pacotes que seu projeto requer. Por padrão, apenas o repositório Packagist.org é registrado no Composer. Você pode adicionar mais repositórios ao seu projeto declarando-os em composer.json.
64. O que são repositórios?
65. Packagist Packagist é o repositório principal do Composer. Ele agrega pacotes PHP públicos instaláveis com o Composer. https://packagist.org
66. Packagist
67. Packagist
68. Packagist
69. Dúvida: O que é necessário para publicar um pacote?
70. Publicação de pacotes • Versionamento(git, svn, etc.) • Código-fonte + composer.json • Lançamento de tag • Publicação • Instalação
71. Onde publicar • Packagist • Private Packagist • GitHub • GitLab • BitBucket • Etc.
72. Entendendo o processo de publicação • https://whimsical.com/publish-package-4kuoVEP6CJYugpbFetjED6
73. Contribua
74. Referências • https://getcomposer.org • https://packagist.org • https://www.treinaweb.com.br/blog/no-final-das-contas-o-que-e-o-docker-e-como-ele-fun ciona • https://stack.desenvolvedor.expert/appendix/docker/oquee.html • https://www.opservices.com.br/o-que-e-docker/ • https://4linux.com.br/diferenca-containers-maquinas-virtuais/ • https://imasters.com.br/banco-de-dados/docker-compose-o-que-e-para-que-serve-o-que- come
75. Obrigado!