Como Fazer Minha Gem e o Rails Conversarem Bem

Vamos ver como é importante fazer sua gem saber gerar códigos para a instalação dela mesmo junto ao Rails e como é importante importante documentar bem.

Transcript

1. Como Fazer Minha Gem e o Rails Conversarem Bem @brenoholiveira Breno Oliveira
3. moip.github.io
4. Como anda o atual cenário de gems
6. Provavelmente sua idéia de Gem já existe Mas ainda há espaço para a sua …
7. Pelo menos 70% delas foram feitas para o Rails
10. E o sucesso do Rails foi só pelo rails?
15. Rails + Gems = App
18. Minha Gem + Rails
19. Rails Generators para sua gem http://guides.rubyonrails.org/generators.html
20. Gem initializer
21. class InitializerGenerator < Rails::Generators::Base def create_initializer_file create_file "config/initializers/initializer.rb", “# Seu código aqui" end end lib/generators/my_gem_name/initializer_generator.rb
22. Initializer: initializer $ rails g --help Running via Spring preloader in process 95922 Usage: rails generate GENERATOR [args] [options] General options: -h, [--help] # Print generator's options and usage -p, [--pretend] # Run but do not make any changes -f, [--force] # Overwrite files that already exist -s, [--skip] # Skip files that already exist -q, [--quiet] # Suppress status output Please choose a generator below. … … ?
23. Será que ficou claro o que meu generator faz?
24. lib/generators/my_gem_name/initializer_generator.rb module MyGemName module Generators class InitializerGenerator < Rails::Generators::NamedBase def create_initializer_file create_file "config/initializers/initializer2.rb", “# Seu código aqui" end end end end
25. $ rails g --help Running via Spring preloader in process 95922 Usage: rails generate GENERATOR [args] [options] General options: -h, [--help] # Print generator's options and usage -p, [--pretend] # Run but do not make any changes -f, [--force] # Overwrite files that already exist -s, [--skip] # Skip files that already exist -q, [--quiet] # Suppress status output Please choose a generator below. … … MyGemName: my_gem_name:initializer
26. $ rails generate my_gem_name:initializer Running via Spring preloader in process 98057 create config/initializers/initializer2.rb
27. Escrevendo uma documentação com Thor
28. module MyGemName module Generators class InitializerGenerator < Rails::Generators::NamedBase def create_initializer_file desc "This generator creates an initializer file at config/initializers” create_file "config/initializers/initializer2.rb", “# Seu código aqui" end end end end lib/generators/my_gem_name/initializer_generator.rb
29. $ rails g my_gem_name:initializer --help Running via Spring preloader in process 98283 Usage: rails generate my_gem_name:initializer NAME [options] Options: [--skip-namespace], [--no-skip-namespace] # Skip namespace (affects only isolated applications) Runtime options: -f, [--force] # Overwrite files that already exist -p, [--pretend], [--no-pretend] # Run but do not make any changes -q, [--quiet], [--no-quiet] # Suppress status output -s, [--skip], [--no-skip] # Skip files that already exist This generator creates an initializer file at config/initializers
30. Mas eu queria documentar com exemplos mais complexos
31. lib/generators/my_gem_name/USAGE Description: Explicação sobre o que minha Gem faz Example: rails generate my_gem_name:initializer This will create: config/initializers/my_gem_initializer.rb
32. $ rails g my_gem_name:initializer --help Running via Spring preloader in process 98741 Usage: rails generate my_gem_name:initializer NAME [options] Options: [--skip-namespace], [--no-skip-namespace] # Skip namespace (affects only isolate applications) Runtime options: -f, [--force] # Overwrite files that already exist -p, [--pretend], [--no-pretend] # Run but do not make any changes -q, [--quiet], [--no-quiet] # Suppress status output -s, [--skip], [--no-skip] # Skip files that already exist Description: Explicação sobre o que minha Gem faz Example: rails generate my_gem_name:initializer This will create: config/initializers/my_gem_initializer.rb
33. Mas eu tenho mesmo que usar o create_file?
34. Então vamos utilizar de template files
35. SimpleHubspot.configure do |config| config.hapikey= "YOUR API KEY" config.portal_id= "YOUR PORTAL ID" end # Seu código aqui lib/generators/my_gem_name/templates/my_gem_initializer.rb
36. module MyGemName module Generators class InitializerGenerator < Rails::Generators::NamedBase source_root File.expand_path('../templates', __FILE__) # desc "This generator creates an initializer file at config/initializers" def copy_initializer copy_file "my_gem_initializer.rb", "config/initializers/my_gem_initializer.rb" end end end end lib/generators/my_gem_name/initializer_generator.rb
37. se você estiver usando Rails
38. $ bin/rails generate generator initializer create lib/generators/initializer create lib/generators/initializer/initializer_generator.rb create lib/generators/initializer/USAGE create lib/generators/initializer/templates
39. Quer saber mais
40. guides.rubyonrails.org/generators.html
41. Olhe código fonte de bons projetos
42. github.com/plataformatec/devise