Búsqueda y Filtrado de Posts por Título con TDD

Clase 16 de 33 • Curso de Creación de APIs con Ruby on Rails

Resumen

¿Cómo implementar búsquedas y filtros para posts por título con TDD?

La búsqueda eficiente en una base de datos es una habilidad esencial para cualquier desarrollador. Mediante el uso de Test-Driven Development (TDD), se garantiza que la lógica de búsqueda se implemente correctamente desde el inicio. En esta guía, aprenderás a implementar búsquedas y filtros para posts por título usando TDD.

¿Qué es TDD y por qué es importante?

TDD es una metodología de desarrollo de software que enfatiza la creación de pruebas antes de escribir el código funcional. Este enfoque asegura que el código satisfaga los requisitos definidos desde el principio y se mantenga limpio y fiable. Siguiendo este método, comenzamos creando pruebas que definan el comportamiento esperado.

¿Cómo crear pruebas para la búsqueda de posts?

Primero, es importante establecer el entorno de pruebas adecuadamente. Nos centraremos en pruebas unitarias para filtrar posts por título.

Implementación de pruebas: Debemos crear varios posts de prueba en la base de datos. Para ello, usaremos FactoryBot.

# Factory Bot Factories
FactoryBot.define do
  factory :post do
    title { "Titulo de prueba" }
    published { false }
  end

  factory :published_post, class: 'Post' do
    title { "Titulo de prueba" }
    published { true }
  end
end

Configuración de datos de prueba: Crearemos tres posts con títulos similares usando estos factories.

FactoryBot.create(:published_post, title: "Hola mundo")
FactoryBot.create(:published_post, title: "Hola Rails")
FactoryBot.create(:published_post, title: "Curso Rails")

Desarrollo de la prueba de búsqueda por título: Usamos query params para buscar palabras clave en los títulos de los posts.

# Prueba de búsqueda
it 'debería filtrar posts por título' do
  get '/posts', params: { query: 'Hola' }

  expect(response).not_to be_empty
  expect(JSON.parse(response.body).size).to eq(2)
  
  ids = JSON.parse(response.body).map { |post| post['id'] }.sort
  expect(ids).to eq([id_of_hola_mundo, id_of_hola_rails].sort)
end

¿Qué es un query param y cómo se usa?

Un query param es un parámetro adicional que se pasa en una solicitud HTTP, usualmente para filtrar o modificar resultados. Se agrega a la URL después de un ?, seguido por la clave y el valor del parámetro. Es una herramienta poderosa para personalizar consultas y búsquedas.

¿Cómo verificar que las pruebas fallen inicialmente?

En TDD, el objetivo inicial es que las pruebas fallen para asegurarse de que el test está correctamente configurado. Esto asegura que luego podamos proceder a escribir el código necesario para que las pruebas pasen.

Ejecutar pruebas: Inicia la ejecución de las pruebas en la terminal para verificar fallos intencionados.
```
rspec spec/requests/posts_spec.rb
```

Si se implementa correctamente, se espera que las pruebas indiquen que los resultados no son los esperados (e.g., recibir tres posts en lugar de dos).

¿Por qué es importante que la prueba falle primero?

Esto confirma que la prueba tiene sentido y que el código aún no está implementado. Sólo después de observar un fallo, se procede a escribir el código funcional para cumplir con la prueba. Este proceso refuerza la confianza en que cualquier hecho en el código es necesario y efectivo.

Sigue aprendiendo y practica tu habilidad con TDD, una técnica poderosa que asegura un código de alta calidad, y te prepara para dominar el desarrollo ágil y eficiente.

Victor Manuel Franco Cañon

student•

Podría utilizarse un operador ternario en esta condicional?

Nos ahorramos unas lineas de codigo ademas de ser mucho mas legible al implementar la prueba de la siguiente forma?

  factory :post do
    title { Faker::Lorem.sentence }
    content { Faker::Lorem.paragraph }
    published {
      r = rand(0..1)
      r == 0 ? false : true
    }
    user
  end

Original

  factory :post do
    title { Faker::Lorem.sentence }
    content { Faker::Lorem.paragraph }
    published {
      r = rand(0..1)
      if r == 0
        false
      else
        true
      end
    }
    user
  end```

Luis Rogelio Reyes Hernandez

student•

yo use

0 == rand(0..1)

y funciona, ya que el resultado sera un booleano

Mark Harmsen

student•

@vifrac y @luis_reyesh98 gracias por sus comentarios mucachos!

Antonio de Jesús Pérez Maldonado

student•

Espero sirva.

Tambien para implementar caracteristicas especificas, se pueden usar traits, para especificar y ser explicito en ciertas necesidades que debe de cumplir el factory:

FactoryBot.define do
  factory :post do
    title { 'Example title'}
    content { 'Example content' }
    published { false }
    user
  end

  trait :published_post do
    published { true }
  end
end

Y asi ya solo especificar el trait o traits que debera de cumplir el factory al momento de crear el objeto:

let(:example_post) { create :post, :published_post }

Piero Nolte

student•

Alguien entiende cual el motivo de agregar get '/posts?search=Hola' si al final no esta utilizan el query param?

Porque en el caso que lo utilizaría debería darle solo 2 post y no 3.

En el caso que te interese en esta prueba la utilidad de un query param puedes en agregar lo siguiente:

En "application_controller.rb":

# GET /posts
    def index
        if params[:search].present?
            @posts = Post.where("title LIKE ?", "%#{params[:search]}%")
          else
            @posts = Post.where(published: true)
          end
        
        render json: @posts, status: :ok
    end
```Ejemplo de prueba "search":


```js
describe "Search" do
            let!(:example_post_1) { create :post, :published_post, title: 'example_post_1'}
            let!(:example_post_2) { create :post, :published_post, title: 'example_post_2' }
            let!(:post_3) { create :post, :published_post, title: 'post_3' }

            it "should return posts by title"  do
                get '/posts?search=post'
                payload = JSON.parse(response.body)
                expect(payload).to_not be_empty
                expect(payload.size).to eq(2)
                expect(payload.map { |p| p["id"]}.sort).to eq([example_post_1.id, example_post_2.id].sort)
                expect(response).to have_http_status(200)
           end
        end

Si generas esta prueba teniendo en cuenta un query param "search", el valor de "payload.size" seria igual 2 y buscarías que la prueba tenga éxito. En el caso que quieres que falle cambiar : expect(payload.size).to eq(3).