File: README — Documentation for rails-footnotes (3.6.5)

Rails Footnotes License: MIT Version: 3.6.4

You can also read this README in pretty html at the GitHub project Wiki page

http://wiki.github.com/josevalim/rails-footnotes

Description

If you are developing in Rails you should know the plugin! It displays footnotes in your application for easy debugging, such as sessions, request parameters, cookies, filter chain, routes, queries, etc.

Even more, it contains links to open files directly in your editor including your backtrace lines.

Installation

Install Rails Footnotes is very easy. If you are running on Rails 2.3 just run the following:

sudo gem install rails-footnotes

In RAILS_ROOT/config/environments/development.rb (yes, you want it only in development):

config.gem "rails-footnotes"

If you want it as plugin, just do:

script/plugin install git://github.com/josevalim/rails-footnotes.git

Configuration

If you are not using Textmate as text editor, in your environment.rb or in an initializer do:

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

Where you are going to choose a prefix compatible with your text editor. The %s is replaced by the name of the file, the first %d is replaced by the line number and the second %d is replaced by the column.

By default, footnotes are appended at the end of the page with default stylesheet. If you want to change their position, you can define a div with id “footnotes_holder” or define your own stylesheet by turning footnotes stylesheet off:

Footnotes::Filter.no_style = true

Another option is to allow multiple notes to be opened at the same time:

Footnotes::Filter.multiple_notes = true

Finally, you can control which notes you want to show. The default are:

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

Creating your own notes

Create your notes to integrate with Footnotes is easy.

Create a Footnotes::Notes::YourExampleNote class
Implement the necessary methods (check abstract_note.rb file in lib/notes)
Append your example note in Footnotes::Filter.notes array (usually at the end of your environment file or in an initializer):

For example, to create a note that shows info about the user logged in your application you just have to do:

module Footnotes
  module Notes
    class CurrentUserNote < AbstractNote
      # This method always receives a controller
      #
      def initialize(controller)
        @current_user = controller.instance_variable_get("@current_user")
      end

      # The name that will appear as legend in fieldsets
      #
      def legend
        "Current user: #{@current_user.name}"
      end

      # This Note is only valid if we actually found an user
      # If it's not valid, it won't be displayed
      #
      def valid?
        @current_user
      end

      # The fieldset content
      #
      def content
        escape(@current_user.inspect)
      end
    end
  end
end

Then put in your environment:

Footnotes::Filter.notes += [:current_user]

Colaborators

Leon Li - github.com/scorpio
Keenan Brock - github.com/kbrock
Ivan Storck - github.com/ivanoats
Kris Chamber - github.com/kristopher

Bugs and Feedback

If you discover any bugs, please send an e-mail to [email protected] If you just want to give some positive feedback or drop a line, that’s fine too!

Version 2.0

This plugin was created and maintained until version 2.0 by Duane Johnson: