/* CODIFICANDO */

Neste sábado, dia 26 de setembro, vai rolar o 6o encontro do Guru-SP, o Grupo de Usuários Ruby de São Paulo. O evento vai acontecer no auditório do prédio da GoNow. Tive o prazer de ser convidado para participar da mesa como debatedor, espero não fazer muito feio no meio de todos os feras que estarão participando comigo :)

Vamos fazer um debate sobre diversos tópicos relacionados a utilização de testes automatizados, TDD, BDD e tudo mais. Acho que será uma ótima oportunidade para aprender e mostrar as diversas vantagens que da utilização de testes.

Mais informações no rubyinside.com.br e no site do Guru-SP.

Vejo vocês por lá!

É comum testarmos métodos que retornam arrays de models. Um bom exemplo disso é quando testamos named_scopes (eu gosto de testar named_scopes pra valer, batendo no banco e não somente usando macros como as do Remarkable). A grande pagadinha é que a ordem na qual os objetos serão retornados do banco é totalmente imprevisível, a não ser que seu método já traga os itens ordenados por padrão. Assim, testes como o exemplo abaixo podem hora passar, hora não:

describe ".active" do
  before :each do
    @user1 = User.make :active => true
    @user2 = User.make :active => false
    @user3 = User.make :active => true
    @user4 = User.make :active => false
  end

  it "retorna somente usuários ativos" do
    User.active.should == [@user1, @user4]
  end
end

Uma maneira segura de testar isso é usar a classe Set, da biblioteca padrão do Ruby. Um Set representa um conjunto matemático, sendo que a igualdade entre dois conjuntos existe quando ambos os conjuntos possuem exatamente os mesmos elementos, independentemente da ordenação. Assim, podemos reescrever a linha da spec que faz a asserção e termos certeza de que ele terá sempre o mesmo comportamento:

User.active.to_set.should == Set.new([@user1, @user4])

Rails Summit

Ok, acho que a maioria das pessoas que costuma ler o blog já deve estar sabendo que este ano teremos mais uma edição do Rails Summit. Para quem não conhece, esse é maior evento da América Latina sobre Rails. Ano passado eu fui e posso dizer que foi um evento excelente.
Inicialmente eu não ia escrever nada específico sobre o evento aqui, mas estão sorteando dois ingressos este ano e tudo o que eu precisei fazer para concorrer foi: a) Seguir o @railssmummit no Twitter, o que eu já fazia e b) Escrever este post.

Seria legal se eu ganhasse um desses ingressos e pudesse economizar 400 mangos :)

Para quem for, vejo vocês por lá!

O problema

Quando usamos caching no Rails, precisamos criar também algum mecanismo para expirar esses caches quando os mesmos não forem mais válidos. Geralmente um cache não é mais válido quando o recurso exibido teve seu estado alterado na aplicação. Por exemplo: Você tem um blog e usa caching para não ter que ir ao banco toda vez que os posts forem exibidos. Entretanto, se um post for atualizado, seu respectivo cache deve ser expirado, caso contrário as alterações nunca serão visualizadas.

Um mecanismo bastante utilizado para expirar caches são os sweepers. Sweepers são objetos compartilhados, muito semelhantes aos observers do ActiveRecord (na verdade um Sweeper é uma subclasse de Observer), que podem ser registrados nos controllers de forma semelhante a filtros, para observar alterações em models e expirar os respectivos caches.

O problema que eu tive foi que queria testar um sweeper com meu querido Rspec. Mais especificamente, um sweeper que expirava um fragment cache, que é um cache para apenas um pedaço da minha página. Não achei nada pronto pra isso, nenhuma facilidade. Resolvi coçar minha própria coceira e criar alguma coisa que pudesse me ajudar.

Não vou explicar aqui como funciona caching no Rails, nem como usar Sweepers. Você pode pesquisar mais sobre isso aqui.

Vamos seguir utilizando o velho e muito mais que manjado exemplo da Blog App. Vamos considerar que a página inicial da nossa app possui uma área com os posts mais recentes, sobre a qual foi aplicado fragment caching. Para expirar este cache, poderiamos ter um sweeper mais ou menos assim:

class PostSweeper < ActionController::Caching::Sweeper
  observe Post

  def expire_post(post)
    expire_fragment "post_#{post.id}"
  end

  alias_method :after_save, :expire_post
  alias_method :after_destroy, :expire_post
end

Como testar isso? Como saber que o fragmento correto é expirado quando alteramos o registro no banco?

A solução

Para testar esse sweeper, criei um controller “de teste”, sem utilidade para a aplicação. Porque eu não usei um controller já existente? Porque eu não queria criar dependência entre os testes. Não gosto da idéia de ter que depender de uma classe diferente da que está sendo testada para que meu teste passe, pelo menos não se eu puder evitar.
Usei um nome diferente de PostsController, para não redefinir a classe durante os testes, isso poderia causar problemas. O código abaixo pode ser definido no próprio arquivo da spec, logo acima do seu bloco describe principal, por exemplo.

class FooBarsController < ApplicationController
  cache_sweeper :post_sweeper

  def update
    @post = Post.find(params[:id])
    @post.update_attributes :contents, "hello world!"
  end

  def destroy
    @post = Post.find(params[:id])
    @post.destroy
  end
end

describe PostSweeper do
  #...
end

O próximo passo é criar uma forma de habilitar o caching em nossos testes. Por padrão ele fica desabilitado no ambiente de teste, para tornar tudo mais rápido. Vamos ter que habilitá-lo se quisermos que nosso teste funcione. Aqui habilito o caching somente para a spec em questão, sem alterar o comportamento para os demais testes da nossa aplicação. Para isso, criei um helper:

def performing_cache
  ActionController::Base.perform_caching = true
  yield
  ActionController::Base.perform_caching = false
end

A idéia para o teste é invocar as actions do FooBarsController e ver se o cache é expirado quando o post é atualizado ou removido. Simples né? Hum… depende… como vamos invocar as actions? Como este é uma spec para o sweeper e não para o controller, não podemos simplesmente fazer algo como

  put :update, :id => "1"

como fariamos em um teste de controller. Nossa spec não saberia qual controller é dono da action update em questão. Vamos precisar cavar um pouco e descobrir outra forma:

describe PostSweeper do
  before :all do
    @app = ActionController::Integration::Session.new
    ActionController::Routing::Routes.draw do |map|
      map.resources :foo_bars, :only => [:update, :destroy]
    end
  end

  #...
end

No código acima criamos a variável de instância @app. Ela representa uma app Rails, sobre a qual podemos invocar actions. Criamos também uma rota para nosso controller, de forma a podermos usar URIs para as actions.

Agora precisamos criar um matcher do Rspec para verificar se o fragmento está sendo devidamente expirado. Fiz de forma bem simples, poderia ser melhorado. Basicamente o que faço aqui é verificar se o cache store do controller de teste recebe uma mensagem pedindo para que o fragment cache seja expirado.

Spec::Matchers.define :expire_fragment do |fragment, options|
  match do |controller|
    controller.cache_store.should_receive(:delete).with("views/#{fragment}", options)
  end
end

Ok, precisei dar uma fuçadinha no código do Rails para descobrir como fazer isso :)

Agora juntando tudo, podemos escrever uma spec assim:

describe PostSweeper do
  before :all do
    @app = ActionController::Integration::Session.new
    ActionController::Routing::Routes.draw do |map|
      map.resources :foo_bars, :only => [:update, :destroy]
    end
  end

  before :each do
    @post = Post.create(:contents => "blablabla")
  end

  it "deve limpar o cache quando o post for atualizado" do
    FooBarsController.should expire_fragment("post_#{@post.id}", nil)
    performing_cache do
      @app.put("/foo_bars/#{@post.id}")
    end
  end

  it "deve limpar o cache quando o post for removido" do
    FooBarsController.should expire_fragment("post_#{@post.id}", nil)
    performing_cache do
      @app.delete("/foo_bars/#{@post.id}")
    end
  end
end

Precisamos passar nil como segundo argumento para o matcher, porque ali iriam as opções para expirar o cache, as quais não estamos usando. Preciso pensar em uma forma melhor de fazer isso depois, para passar um segundo argumento somente quando ele for utilizado. Com Ruby 1.9 isso poderia ser resolvido facilmente, pois argumentos de blocos aceitam valores default, como acontece com argumentos de métodos.