Debugování Rails aplikací pomocí Rails Footnotes

Jedna z možností jak při běhu aplikace v Ruby on Rails zjistit o aktuální adrese několik informací s možností vlastního snadného rozšíření a nastavení.

Rails Footnotes není určen přímo k debugování, ale spíše bychom mohli napsat, že jej můžeme použít k zjištění informací o aktuální relaci. Plugin dokáže v aktuální stránce vypsat informace o běhu a to konkrétně:

• Assign – vytvořené globální proměnné předané do templaty
• Session – aktuálně nastavené session v aplikaci
• Cookies – aktuálně nastavené cookies v aplikaci
• Params – parametry, předávané do aplikace
• Routes – aktuálně využívané routy
• Queries – provedené dotazy na databázi, včetně času vykonání
• Stylesheets – aktuálně načítané css soubory
• Javascripts – aktuálně načítané js soubory
• a mnohé další

Jak už z názvu plyne, v základním nastavení vypisuje informace v patičce dokumentu, kde zobrazí jednoduchou lištu.

Instalce Rails Footnotes

Instalace je velmi jednoduchá, jelikož je distribuován jako GEM balíček, můžeme jej využít a instalovat klasicky přes gem install:

gem install rails-footnotes

Po nainstalování je nutné gem v aplikaci povolit. Uděláte to jednoduše v developement.rb (/config/enviroments/development.rb).

Tím dosáhnete toho, že bude fungovat pouze v development módu a v produkčním režimu se zobrazovat nebude. Případně můžete využít zápisu:

ENABLE_RAILS_FOOTNOTES = (Rails.env.production? == False) 

Nastavení Rails Footnotes

Plugin nabízí několik základních možností nastavení, kterým můžete ovlivnit jeho chování a vzhled.

Propojení s Textmate

Rails Footnotes lze jednoduše propojit s Textmate editorem. Jiné editory bohužel propojení nepodporují. Do enviroment.rb je nutné dopsat:

if defined?(Footnotes)
    Footnotes::Filter.prefix = 'txmt://open?url=file://%s&line=%d&column=%d'
end

V pluginu bude poté možné se proklikávat do controlleru, šablon, a podobně.

Vlastní styly

Můžete vytvořit vlastní styly pro div “footnotes_holder”, kde předefinujete defaultní styly. Navíc je nutné zakázat zobrazení výchozích stylů:

Footnotes::Filter.no_style = true

Upravení zobrazených poznámek

Snadno můžete upravit, které poznámky se budou zobrazovat a které ne, případně upravit pořadí poznámek:

Footnotes::Filter.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general]

Vytvoření vlastní poznámky

Poslední vlastnost, kterou Rails Footnotes umožňuje je nadefinovat si vlastní poznámku, kterou je možné do lišty přidat. Postup je snadný:

• vytvoříme si novou třídu, například: Footnotes::Notes::YourExampleNote
• implementujeme nezbytné metody (uvedeny v abstract_note.rb v lib/notes)
• přidání poznámky do pluginu v poli Footnotes::Filter.notes.

Závěrem

Použití Rails Footnotes je velmi jednoduché, jeho sprovoznění v projektu je otázkou několika sekund, a práci občas určitě dokáže ulehčit.

Odkaz na web: https://git...ls-footnotes