Ruby on Rails: Wie listen Sie die Teilpfade auf, die für eine Seite gerendert werden?

Question

Ich möchte die Teiltöne für jede Seite in meiner App auflisten. Zum Beispiel, wenn die app/Aufgaben/index.html.erb Seite gezeigt wird, würde Ich mag so etwas wie die folgenden, um den Benutzer anzuzeigen:

Partials für diese Seite gemacht:

Aufgaben/_list.html.erb
Aufgaben/_button.html.erb
Aufgaben/_navigation.html.erb

gibt es eine Möglichkeit, um auf Rails in Ruby zu tun?

ActiveSupport::Notifications.subscribe("render") do |*args| 
    events << ActiveSupport::Notifications::Event.new(*args) 
end 

Für Ihren Fall (Tracking gemacht partials) können Sie die 'render_partial.action_view' Benachrichtigung wünschen:

Answer 1

Ja, es ist so ganz ein Weg, dies zu tun in Schienen!

Wie bdares in seinem Kommentar darauf hingewiesen hat, erscheinen die Zeilen für das Template-Rendering in den Protokollen. Aber wie kommen sie überhaupt dorthin? Nun, das hat mit einem little something in Active Support called LogSubscriber zu tun. Die Dokumentation dafür ist ziemlich gründlich:

ActiveSupport :: LogSubscriber ist ein Objekt, das ActiveSupport :: Notifications mit dem einzigen Zweck verwendet, sie zu protokollieren. Der Protokollteilnehmer sendet basierend auf seinem angegebenen Namespace Benachrichtigungen an ein registriertes Objekt.

Die Sache, die die „Übertragene ...“ Linien in den Protokollen ist setzen, ist ActionView::LogSubscriber die like this within Rails 3.2 definiert ist. Nimm dir einen Moment, um den Code zu lesen. Es ist nett und ordentlich.

Was dies tut, um ein paar Ereignisse innerhalb Rails abonniert, nämlich die render_template, render_partial und render_collection Methoden. Dazu wird die Methode ActiveSupport::LogSubscriber.attach_to aufgerufen, die einigen Ereignissen einen Protokollabonnenten anfügt. Das Verfahren ist auch interessant, und wie folgt definiert:

def attach_to(namespace, log_subscriber=new, notifier=ActiveSupport::Notifications) 
    log_subscribers << log_subscriber 
    @@flushable_loggers = nil 

    log_subscriber.public_methods(false).each do |event| 
    next if 'call' == event.to_s 

    notifier.subscribe("#{event}.#{namespace}", log_subscriber) 
    end 
end 

ich diesen Code in Zeile gesetzt habe, weil es unsere Interessenäußerst relevant ist. Was das tut, ruft subscribe auf dem notifier Objekt auf. Das Objekt notifier ist standardmäßig ActiveSupport::Notifications, was wichtig zu erinnern ist. Die documentation for that class in Rails is in the API too.

Wenn subscribe aufgerufen wird, wird der Name event übergeben. Was ist das? Nun, es ist jede einzelne öffentliche Methode in der Klasse.Wenn die Unterklasse LogSubscriber definiert ist, definiert sie ein paar öffentliche Methoden: render_template, render_partial und render_collection. Dies sind die Ereignisse, die für diesen Protokollteilnehmer abonniert werden.

Nun, das ist relevant für unsere Interessen, weil wir das gleiche verwenden werden, um diese Ereignisse in der Ansicht zu abonnieren. Der erste Schritt ist ActiveSupport::Notfications, dass wir alle partiellen Rendering-Ereignisse abonnieren möchten. Wir können dies tun, indem Sie einen neuen before_filter innerhalb ApplicationController erstellen:

before_filter :log_partial_events 

def log_partial_events 
    @partial_events = [] 
    ActiveSupport::Notifications.subscribe("render_partial.action_view") do |event_name, start_at, end_at, id, payload| 
    @partial_events << payload[:identifier] 
end 

Die Veranstaltung wir sind der abonnieren möchte die render_partial Ereignis innerhalb des action_view Namensraum ist, der genau eines der Ereignisse, die ActionView::LogSubscriber zu abonniert. Was passiert, wenn ein Partial gerendert wird, ist, dass dieser Block in einigen Daten aufgerufen und übergeben wird.

event_name: Der Name des Ereignisses. start_at: Die Zeit, zu der das Ereignis begann. end_at: Die Zeit, zu der das Ereignis endete. id: Eine eindeutige ID für dieses Ereignis. payload: Einige Nutzinformationen zu diesem Ereignis.

Wenn der Hook aufgerufen wird, fügt er den identifier Schlüssel aus dem payload dem Array hinzu, das am Anfang der Methode definiert ist.

Dann in der Ansicht, eine Liste dieser zuzugreifen, dies zu tun:

<%= debug @partial_events %> 

Answer 2

Das folgende Beispiel aus dem Notification API sollte Ihnen helfen. Der Code könnte wie folgt aussehen:

class ApplicationController < ActionController::Base 
    before_filter :subscribe_to_render 

    private 
    def subscribe_to_render 
    @render_events = [] 
    ActiveSupport::Notifications.subscribe("render_partial.action_view") do |*args| 
     @render_events << ActiveSupport::Notifications::Event.new(*args) 
    end 
    end 
end 

und wo immer Sie diese Informationen angezeigt werden möchten, können Sie diese Hilfsmethode verwenden:

def display_render_events 
    raw(@render_events.map do |event| 
    event.payload[:identifier].gsub(/^.*app\/views\//, '') 
    end.join('<br/>')) 
end 

Answer 3

Für viele Debugging-Informationen wie diese, haben einen Blick auf rails-footnotes

Answer 4

Sie auch überprüfen möchten RailsPanel Dies ist eine Chrome-Erweiterung.