lib/backtracer.rb lib/footnotes.rb lib/initializer.rb lib/notes/abstract_note.rb lib/notes/controller_note.rb lib/notes/cookies_note.rb lib/notes/files_note.rb lib/notes/filters_note.rb lib/notes/general_note.rb lib/notes/javascripts_note.rb lib/notes/layout_note.rb lib/notes/log_note.rb lib/notes/params_note.rb lib/notes/queries_note.rb lib/notes/routes_note.rb lib/notes/session_note.rb lib/notes/stylesheets_note.rb lib/notes/view_note.rb test/footnotes_test.rb @@ -1,10 +1,12 @@ TODO: - * Use YAML files to load configuration files - * Create a profiler tab + * Create ProfilerNote + * Create Rakefile + * Create Tests == Footnotes v3.2 Author: José Valim (jose.valim@gmail.com) Site: http://www.pagestacker.com/ + * Now you can easily add your own notes; * Added numbers to tabs; * Added Queries note; * Added MySQL Query Analyzer. CHANGELOG @@ -1,4 +1,4 @@ -Footnotes plugin for Rails (v3.1) +Footnotes plugin for Rails (v3.2) --------------------------------- If you are developing in Rails you should know the plugin! @@ -34,23 +34,92 @@ If you are running on Rails 2.0.x or Rails 1.x, you should use Footnotes v3.0: Remember that in Rails 1.x, after filters appear first than before filters in the Filters tab. -Usage -===== +Usage notes +=========== -Detailed info about usage can be found in init.rb +* Footnotes are applied in all actions under development. If You want to change this behaviour, check the initializer.rb file. -Original Author -=============== +* Some features only work if you are under MacOSX. But if your editor support opening files like Textmate, e.g. txmt://open?url=file://, you can put in your environment file the following line: -Duane Johnson (duane.johnson@gmail.com) -http://blog.inquirylabs.com/ + Footnotes::Filter.prefix = "editor://open?file://" + +Another option is to automatically register the protocol in your browser and/or OS. To do this in Firefox, please read: http://kb.mozillazine.org/Register_protocol + +* If you want to use your own stylesheet, you can disable the Footnotes stylesheet with: + + Footnotes::Filter.no_style = true + +* Footnotes are appended at the end of the page, but if your page has a div with id "tm_footnotes", Footnotes will be inserted into this div. + +* Finally, you can cherry pick which notes you want to use, simply doing: + + Footnotes::Filter.notes = [:session, :cookies, :params, :filters, :routes, :queries, :log, :general] + +Creating your own notes +======================= + +Create your notes to integrate with Footnotes is easy: + +# Create a Footnotes::Notes::YoursExampleNote class +# Implement the necessary methods (check abstract_note.rb file in lib/notes) +# Append yours example note in Footnotes::Filter.notes (usually at the end of your environment file or an initializer): -Current developer -================= + Footnotes::Filter.notes += [:yours_example] + +To create a note that shows info about the user logged in your application (@current_user) you just have to do this: + + module Footnotes + module Notes + class CurrentUserNote < AbstractNote + # Always receives a controller + # + def initialize(controller) + @current_user = controller.instance_variable_get("@current_user") + end + + # Specifies the symbol that represent this note + # This is the one you will have to add to Footnotes::Filter.notes + # + def self.to_sym + :current_user + end + + # The name that will appear as link + # If title is nil, the other methods are not called + # + def title + 'Current User' if @current_user + end + + # The name that will appear as legend in fieldsets + # + def legend + "Current user: #{@current_user.name}" + end + + # The fieldset content + # + def content + escape(@current_user.inspect) + end + end + end + end + + Footnotes::Filter.notes += [:current_user] + +Current Developer (v3.0 and above) +================================== José Valim (jose.valim@gmail.com) http://josevalim.blogspot.com/ +Original Author (v2.0) +====================== + +Duane Johnson (duane.johnson@gmail.com) +http://blog.inquirylabs.com/ + License ======= README.markdown @@ -1,50 +1,16 @@ -# Footnotes is divided in five files: +# Footnotes is divided in three main files: # -# * textmate_footnotes.rb: Is the core and adds the debug options at the bottom -# of each page; +# * initialiazer.rb: Initialize the plugin and apply the footnotes as an after_filter; # -# * textmate_initialiaze.rb: Initialize the plugin and apply the footnotes as an -# after_filter; +# * footnotes.rb: Is the core and adds the debug options at the bottom of each page; # -# * textmate_links.rb: Provides links to open controller, layout, view and asset -# files in textmate; -# -# * textmate_backtracer.rb: Append links to Textmate in backtrace pages. -# -# * textmate_analyzer.rb: Append explain queries in log when using MySQL. -# -# The footnotes are applied in all actions under development. If You want to -# change this behaviour, check the textmate_initialize.rb file. -# -# And by default, the last two files are only loaded in MacOSX. If your editor -# support opening files like Textmate, e.g. txmt://open?url=file://, you can put -# in your environment file the following line: -# -# Footnotes::Filter.textmate_prefix = "editor://open?file://" -# -# If You want to use your own stylesheet, you can disable the Footnotes -# stylesheet with: -# -# Footnotes::Filter.no_style = true -# -# Footnotes try to append at the end of the page, but if your page have a div -# with id "tm_footnotes", Footnotes will be inserted into this div. -# -# In Footnotes 3.1, you also have the ability to cherry pick which notes do you -# want to use, simply doing: -# -# Footnotes::Filter.notes = [:session, :cookies, :params, :filters, :routes, :queries, :log, :general] +# * backtracer.rb: Append links to tour favorite editor in backtrace pages. # if (ENV['RAILS_ENV'] == 'development') - # Windows doesn't have 'uname', so rescue false - ::MAC_OS_X = RUBY_PLATFORM.include?('darwin') - require 'textmate_footnotes' - require 'textmate_links' - require 'textmate_analyzer' - require 'textmate_initialize' + dir = File.dirname(__FILE__) + require File.join(dir,'lib','footnotes') + require File.join(dir,'lib','initializer') + require File.join(dir,'lib','backtracer') - if ::MAC_OS_X - Footnotes::Filter.textmate_prefix = 'txmt://open?url=file://' - require 'textmate_backtracer' - end + Footnotes::Filter.prefix ||= 'txmt://open?url=file://' if RUBY_PLATFORM.include?('darwin') end \ No newline at end of file init.rb lib/textmate_analyzer.rb lib/textmate_backtracer.rb lib/textmate_footnotes.rb lib/textmate_initialize.rb lib/textmate_links.rb test/textmate_footnotes_test.rb 0d10539dba6addab1ad8174d7c82b6f0ff39f80d josevalim josevalim jose.valim@gmail.com http://github.com/josevalim/rails-footnotes/commit/f9a9e706a76ff3d0a7fbf340b2356f3eeed93824 f9a9e706a76ff3d0a7fbf340b2356f3eeed93824 2008-06-05T07:55:24-07:00 2008-06-05T07:55:24-07:00 Footnotes v3.2: Now you can easily add your notes 0fa5a59638d4cf9e3048c8a298b4fde5a47b700c josevalim josevalim jose.valim@gmail.com