Instalando e usando o RDoc-ubiquity

Fazem alguns meses que Luiz Cipriani lançou uma extensão para Ubiquity, que faz busca em API no formato RDoc. Essa extensão chegou a ser comentada no podcast da RailsEnvy.

Cheguei a contribuir um bocadinho assim ó, bem pouquinho e estou usando direto!

Como instalar?

  1. Precisa ter instalado o Ubiquity para Firefox;
  2. Acessar o site do ubiquity-rdoc; !Página do RDoc-Ubiquity
  3. Se você notar, o Ubiquity vai pedir uma confirmação para assinar a extensão;
  4. Irá abrir a tela de confirmação para “assinatura” da extensão; Lembre-se de marcar a opção de auto-atualização (auto-update);
  5. Pressione o botão I know what I’m doing. Subscribe to it! (Eu sei o que estou fazendo. Assine!)
  6. Pronto para usar!

Como usar?

  1. Antes de mais nada, confirme as teclas de atalho para acionar o ubiquity digitando na barra de endereço: about:ubiquity; No meu caso, é ALT+ESPAÇO
  2. Então, quero consulta na API do Rails sobre o método assert_response, então digito rdoc assert_resp e conforme vou digitando, ele já vai exibindo o resultado.

No próprio site do rdoc-ubiquity, tem a documentação dos comandos, mas para agilizar, vou quebrar seu galho e colocar aqui.

rdoc <metodo> in <apidoc>

onde:

  • metodo - É o nome do método que você quer buscar;
  • apidoc - é o nome do alias para a API RDoc, a saber:

Quais APIs estão por padrão?

Exemplos:

  • rdoc stubs in mocha - Busca pelo método stubs na API do Mocha.
  • rdoc ActiveRecord#write - Busca pelo método write da classe ActiveRecord na API do Rails

Espero que essa extensão também seja útil para vocês!