Como dominar seu fluxo de desenvolvimento com TDD em Ruby

RUBY
COMO DOMINAR SEU FLUXO DE
DESENVOLVIMENTO COM TDD

SOBRE
RACHID CALAZANS
▸Software Engineer at Tidy
▸Viciado em testes, fissurado em arquiteturas de software e
em qualidade de código
▸Github: /rachidcalazans
▸Medium: /@rachidcalazans
▸Podcast: http://2devs.simplecast.fm
▸Twitter: /rachidcalazans

DIFICULDADES
JÁ PASSOU POR ALGUMA?
▸Com Prazo?
▸Com solicitações mal escrita ou pouca informação?
▸Em saber como iniciar alguma Task?
▸Em aplicar testes na hora de implementar?
▸Em entregar um resultado meia boca ou insatisfatório?

SOLUÇÃO
O QUE PODEMOS FAZER?
▸Se organizar
▸Entender o que foi solicitado
▸Utilizar metodologia TDD (Desenvolvimento Orientado por Testes)
▸Entregar resultado final com qualidade

DOMINANDO FLUXO
OK, MAS COMO?
▸Utilizando uma metodologia de fluxo de desenvolvimento
▸Em apenas 3 Passos
▸Todo desenvolvedor deve realizar
▸Servirá sempre. Utilizando testes ou não

METODOLOGIA
OS 3 PASSOS
▸Passo 2 - Specs, Tickets, Tasks, Documentação
▸Passo 3 - Implementação
▸Passo 1 - Perguntas e Respostas

PASSO 1
PERGUNTAS CHAVES
▸1- Já estruturou o que será necessário fazer?
▸2- Qual camada(s) será necessário desenvolver?
▸Implementação de tela
▸Consumo da API
▸Criação de novo endpoint da API
▸3- Onde será preciso focar primeiro?

PASSO 1 - JÁ ESTRUTUROU O QUE SERÁ NECESSÁRIO FAZER?
RESPOSTA #1 - ESTRUTURAÇÃO
▸Sempre estruturar o que é necessário ANTES de botar a
mão no código.
▸Criar documentos auxiliares
▸Documentos ajudará a analisar o que foi solicitado
▸Documentos também ajudará a esclarecer se está tudo
dentro dos requerimentos
▸Ter um mapa de passo-a-passo do que irá realizar

PASSO 1 - QUAL CAMADA(S) SERÁ NECESSÁRIO DESENVOLVER?
RESPOSTA #2 - CAMADAS
▸Independente de qual for a camada, inicie priorizando pelo
topo (resultado final)
▸Realize um Fluxo de Desenvolvimento para cada Camada

PASSO 1 - ONDE SERÁ PRECISO FOCAR PRIMEIRO?
RESPOSTA #3 - FOCO
▸Na funcionalidade
▸Evite planejar toda a arquitetura que será utilizada
▸Foque no objetivo final
▸Foque na entrega que precisa ser realizada

PASSO 2
SPECS - TASKS - TICKETS
▸Extrair sempre o máximo as informações corretas
▸Montar seu DOCUMENTO auxiliar baseado nas
informações
▸Specs podem vir BEM estruturados ou NÃO

PASSO 2
EXEMPLO SPEC
▸Adicionar fotos para uma Inspeção
▸Cada foto pode ter uma descrição

PASSO 2
ESSA SPEC FOI BEM ESCRITA?
▸Não!

PASSO 2
EXTRAINDO INFORMAÇÕES
▸Uma Inspeção poderá ter muitas Fotos
▸Cada foto poderá ter uma descrição
▸Qual o formato do recebimento da foto (Url, Base64)?
▸Qual o formato de retorno da foto (Url, Base64)?
▸Como será o Endpoint?
▸Quais ações precisará ser feita?
▸Precisará criar apenas Foto?
▸Precisará enviar algum email ou confirmação?
▸Será recebido múltiplas fotos no endpoint?

PASSO 2
CRIAR DOCUMENTAÇÃO AUXILIAR
▸Vamos utilizar o Mapa Mental para documentar
▸Vamos Mapear:
▸Passo-a-passo
▸O que iremos utilizar
▸Estrutura
▸Adicionar nele toda a extração feita

PASSO 2
MAPA MENTAL
▸Local Link
▸Mostrar exemplo real também

PASSO 3
IMPLEMENTAÇÃO
▸Focar o resultado final
▸Utilizar TDD
▸Iniciar pelo Topo
▸Iniciar sem pensar muito a frente na Estrutura
▸Fazer em Baby steps (Passos de Bebê)

PASSO 3
NOVO PROJETO
$ rails new inspection_app --api

PASSO 3
group :development, :test do
gem 'pry'
end
group :test do
gem 'rspec-rails'
end
* GEMFILE
▸Atualizar o arquivo Gemfile

PASSO 3
$ rails generate rspec:install
* .rspec
* spec/spec_helper.rb
* spec/rails_helper.rb
▸Incializar a Gem rspec

PASSO 3
require 'rails_helper'
describe 'Api::V1::Inspections::PhotosController' do
it 'It is working' do
expect(true).to be true
end
end
▸Criar primeiro o arquivo de teste para verificar se está tudo funcionando
* spec/controllers/api/v1/inspections/photos_controller_spec.rb

PASSO 3
▸Teste passando
$ rspec --fd
$ rspec

PASSO 3
describe Api::V1::Inspections::PhotosController do
it 'It is working' do
expect(true).to be true
end
end
▸Atualizar o teste

PASSO 3
▸Teste falhando
$ rspec

PASSO 3
module Api
module V1
module Inspections
class PhotosController < ApplicationController
end
end
end
end
▸Criar PhotosController
* app/controllers/api/v1/inspections/photos_controller.rb

PASSO 3
▸Teste passando
$ rspec

PASSO 3
describe Api::V1::Inspections::PhotosController, type: :controller do
describe 'POST /api/v1/inspections/:inspection_id/photos' do
before do
post :create, params: { inspection_id: 1 }
end
it 'Should create an inspection photo' do
expect(response.status).to be == 201
end
end
end
▸Adicionar primeiro endpoint

PASSO 3
module Api
module V1
module Inspections
class PhotosController < ApplicationController
def create
render json: {}, status: 201
end
end
end
end
end
▸Atualizar Controller - Adicionar o create método

PASSO 3
Rails.application.routes.draw do
namespace :api do
namespace :v1 do
namespace :inspections do
post ':inspection_id/photos', to: 'photos#create'
end
end
end
end
▸Editar Rotas
* config/routes.rb

PASSO 3
let(:json) { JSON.parse response.body }
before do
post :create, params: { inspection_id: 1 }
end
expected_response = {
'id' => 11,
'inspection_id' => 1,
'photo_url' => 'http://chid.com/inspection/photo_some_hash_64',
'caption' => nil,
}
expect(json).to match expected_response
end
end
▸Atualizar o Expect result no teste

PASSO 3
def create
Struct.new('InspectionPhotoPresenter',
:id, :inspection_id, :photo_url, :caption, keyword_init: true)
presenter_params = {
id: 11,
inspection_id: 1,
photo_url: 'http://chid.com/inspection/photo_some_hash_64',
caption: nil,
}
presenter = Struct::InspectionPhotoPresenter.new(presenter_params)
render json: presenter, status: 201
end
▸Atualizar Controller - Editar método create

PASSO 3
before do
post :create, params: { inspection_id: 1, photo_base_64: 'some_hash_64' }
end
'id' => 11,
'inspection_id' => 1,
'caption' => nil,
}
end
end
▸Atualizar parâmetros de request

PASSO 3
def create
Struct.new('InspectionPhotoPresenter', :id, :inspection_id, :photo_url, :caption, keyword_init: true)
presenter_params = photo_params
.merge(id: 11, photo_url: url_from_base_64(photo_params[:photo_base_64]))
.except(:photo_base_64)
.to_h
end
private
def url_from_base_64(base_64)
"http://chid.com/inspection/photo_#{base_64}"
end
def photo_params
permitted_keys = %i[inspection_id photo_base_64 caption]
params.permit(permitted_keys)
end
▸Atualizar método create - Utilizar request params

PASSO 3
class CreateInspection < ActiveRecord::Migration[5.2]
def change
create_table :inspections do |t|
t.string :description
t.timestamps null: false
end
end
end
▸Adicionar Banco de Dados - Inspection Migration
* db/migrate/20180922035522_create_inspection.rb

PASSO 3
class CreateInspectionPhoto < ActiveRecord::Migration[5.2]
def change
create_table :inspection_photos do |t|
t.references :inspection, foreign_key: true, null: false
t.string :photo_url, null: false
t.string :caption
t.timestamps null: false
end
end
end
▸InspectionPhoto Migration
* db/migrate/20180922035631_create_inspection_photo.rb

PASSO 3
$ RAILS_ENV=test rake db:migrate
▸Run migrations

PASSO 3
let(:inspection) { ::Inspection.create(description: 'Inspection 001') }
before do
post :create, params: { inspection_id: inspection.id, photo_base_64: 'some_hash_64' }
end
'id' => 11,
'inspection_id' => inspection.id,
'caption' => nil,
}
end
end
▸Atualizar Setup para utilizar Banco de Dados

PASSO 3
class Inspection < ApplicationRecord
end
▸Criar Model - Inspection
* app/models/inspection.rb

PASSO 3
▸Criar Model - InspectionPhoto
* app/models/inspection_photo.rb
class InspectionPhoto < ApplicationRecord
belongs_to :inspection
end

PASSO 3
▸Utilizar ActiveRecord para registrar no Banco
def create
Struct.new('InspectionPhotoPresenter', :id, :inspection_id, :photo_url,
:caption, keyword_init: true)
request_params = photo_params
.merge(photo_url: url_from_base_64(photo_params[:photo_base_64]))
.except(:photo_base_64)
.to_h
inspection_photo = ::InspectionPhoto.create(request_params)
presenter_params = inspection_photo
.attributes
.except('created_at', 'updated_at')
end

PASSO 3
O QUE TEMOS ATÉ AGORA?
▸Cobertura do código com os testes de Integração
▸Resultado final de acordo com o que foi solicitado

PASSO 3
IMPLEMENTAÇÃO ACABOU?
▸Agora que é a hora de:
▸ Começar a Refatorar para valer!
▸Arquiteturar o necessário para seu projeto
▸Nada!
▸Adicionar UseCases, Services, Presenters, Repositories etc

PASSO 3
IMPLEMENTAÇÃO - RESULTADO FINAL
▸Github repositório:
https://github.com/rachidcalazans/inspection_app_final.git

Como dominar seu fluxo de desenvolvimento com TDD em Ruby

Recommended

Recommended

More Related Content

What's hot

What's hot (11)

Similar to Como dominar seu fluxo de desenvolvimento com TDD em Ruby

Similar to Como dominar seu fluxo de desenvolvimento com TDD em Ruby (20)

Como dominar seu fluxo de desenvolvimento com TDD em Ruby