lib/notes/components_note.rb @@ -3,16 +3,31 @@ module Footnotes @@no_style = false @@multiple_notes = false # Edit notes - @@notes = [ :controller, :view, :layout, :stylesheets, :javascripts ] + @@notes = [ :components, :controller, :view, :layout, :stylesheets, :javascripts ] # Show notes - @@notes += [:session, :cookies, :params, :filters, :routes, :queries, :log, :general] + @@notes += [ :session, :cookies, :params, :filters, :routes, :queries, :log, :general ] cattr_accessor :no_style, :notes, :prefix, :multiple_notes - def self.filter(controller) - filter = Footnotes::Filter.new(controller) - filter.add_footnotes! - filter.reset! + class << self + def before(controller) + Footnotes::Filter.start! + end + + def after(controller) + filter = Footnotes::Filter.new(controller) + filter.add_footnotes! + filter.close! + end + + def start! + @@notes.flatten.each do |note| + klass = eval("Footnotes::Notes::#{note.to_s.camelize}Note") if note.is_a?(Symbol) || note.is_a?(String) + klass.start! if klass.respond_to?(:start!) + end + rescue Exception => e + log_error("Footnotes Exception", e) + end end def initialize(controller) @@ -29,13 +44,13 @@ module Footnotes log_error("Footnotes Exception", e) end - def reset! - @notes.map(&:reset!) + def close! + @notes.map{|note| note.class.close!} end protected def valid? - performed_render? && first_render? && valid_format? && valid_content_type? && @body.is_a?(String) && !xhr? + performed_render? && first_render? && valid_format? && valid_content_type? && @body.is_a?(String) && !component_request? && !xhr? end def add_footnotes_without_validation! @@ -47,8 +62,8 @@ module Footnotes def initialize_notes! @@notes.flatten.each do |note| begin - instance_note = eval("Footnotes::Notes::#{note.to_s.camelize}Note").new(@controller) - @notes << instance_note if instance_note.valid? + note = eval("Footnotes::Notes::#{note.to_s.camelize}Note").new(@controller) if note.is_a?(Symbol) || note.is_a?(String) + @notes << note if note.respond_to?(:valid?) && note.valid? rescue Exception => e # Discard note if it has a problem log_error("Footnotes #{note.to_s.camelize}Note Exception", e) @@ -74,6 +89,10 @@ module Footnotes (c.nil? || c =~ /html/) end + def component_request? + @controller.instance_variable_get('@parent_controller') + end + def xhr? @controller.request.xhr? end @@ -144,7 +163,7 @@ module Footnotes html = '' order.uniq! order.each do |row| - html << "#{row.to_s.capitalize}: #{links[row].join(" | \n")}<br />" + html << "#{row.is_a?(String) ? row : row.to_s.camelize}: #{links[row].join(" | \n")}<br />" end html end lib/footnotes.rb @@ -9,5 +9,6 @@ end # application. Then you can cherrypick in which actions it will appear. # class ActionController::Base + prepend_before_filter Footnotes::Filter after_filter Footnotes::Filter end \ No newline at end of file lib/initializer.rb @@ -16,8 +16,20 @@ module Footnotes def included? Footnotes::Filter.notes.include?(self.to_sym) end + + # Action to be called to start the Note. + # This is applied as a before_filter. + # + def start! + end + + # Action to be called after the Note was used. + # This is applied as an after_filter. + # + def close! + end end - + # Initialize notes. # Always receives a controller. # @@ -76,11 +88,6 @@ module Footnotes def javascript end - # Action to be called after the Note was used. - # - def reset! - end - # Specifies when should create a note for it. # By default, if title exists, it's valid. # lib/notes/abstract_note.rb @@ -6,6 +6,10 @@ module Footnotes @@sql = [] cattr_accessor :sql + def self.start! + @@sql = [] + end + def self.to_sym :queries end @@ -19,7 +23,7 @@ module Footnotes end def stylesheet - '#queries_debug_info thead, #queries_debug_info tbody {text-align: center; color:#FF0000;}' + '.queries_debug_table thead, .queries_debug_table tbody {text-align: center; color:#FF0000;}' end def content @@ -28,14 +32,10 @@ module Footnotes html << "<b>#{item[0].to_s.upcase}</b>\n" html << "#{item[1] || 'SQL'} (#{sprintf('%f',item[2])}s)\n" html << "#{item[3].gsub(/(\s)+/,' ').gsub('`','')}\n" - html << (item[4] ? mount_table(item[4]) : "\n") + html << (item[4] ? mount_table(item[4], :class => 'queries_debug_table') : "\n") end "<pre>#{html}</pre>" end - - def reset! - @@sql = [] - end end end lib/notes/queries_note.rb @@ -98,8 +98,8 @@ class FootnotesTest < Test::Unit::TestCase def test_notes_are_reset footnotes_perform! - @footnotes.instance_variable_get('@notes').first.expects(:reset!) - @footnotes.send(:reset!) + @footnotes.instance_variable_get('@notes').first.class.expects(:close!) + @footnotes.send(:close!) end def test_links_helper test/footnotes_test.rb @@ -6,6 +6,11 @@ class AbstractNoteTest < Test::Unit::TestCase Footnotes::Filter.notes = [:abstract] end + def test_respond_to_start_and_close + assert_respond_to Footnotes::Notes::AbstractNote, :start! + assert_respond_to Footnotes::Notes::AbstractNote, :close! + end + def test_respond_to_sym assert_equal :abstract, Footnotes::Notes::AbstractNote.to_sym assert_equal :abstract, @note.to_sym @@ -75,19 +80,19 @@ class AbstractNoteTest < Test::Unit::TestCase def test_footnotes_mount_table assert_equal '', @note.send(:mount_table,[]) - assert_equal '', @note.send(:mount_table,[['h1','h2','h3']]) + assert_equal '', @note.send(:mount_table,[['h1','h2','h3']], :class => 'table') tab = <<-TABLE - <table> + <table class="table"> <thead><tr><th>H1</th></tr></thead> <tbody><tr><td>r1c1</td></tr></tbody> </table> TABLE - assert_equal tab, @note.send(:mount_table,[['h1'],['r1c1']]) + assert_equal tab, @note.send(:mount_table,[['h1'],['r1c1']], :class => 'table') tab = <<-TABLE - <table> + <table > <thead><tr><th>H1</th><th>H2</th><th>H3</th></tr></thead> <tbody><tr><td>r1c1</td><td>r1c2</td><td>r1c3</td></tr></tbody> </table> @@ -96,7 +101,7 @@ class AbstractNoteTest < Test::Unit::TestCase assert_equal tab, @note.send(:mount_table,[['h1','h2','h3'],['r1c1','r1c2','r1c3']]) tab = <<-TABLE - <table> + <table > <thead><tr><th>H1</th><th>H2</th><th>H3</th></tr></thead> <tbody><tr><td>r1c1</td><td>r1c2</td><td>r1c3</td></tr><tr><td>r2c1</td><td>r2c2</td><td>r2c3</td></tr></tbody> </table> test/notes/abstract_note_test.rb 24042f4a2cb9b3d6e55a4ff2a0bf8e9d65cfedfd josevalim jose.valim@gmail.com http://github.com/mhartl/rails-footnotes/commit/ab4edda689c8b75ad3ce1f8b1f6f58211c168a11 ab4edda689c8b75ad3ce1f8b1f6f58211c168a11 2008-06-11T14:51:36-07:00 2008-06-11T14:51:36-07:00 Added ComponentsNote (it shows renderized components links) 2fa3908826e3f04c1528418f70ccf693bc21f6d8 josevalim jose.valim@gmail.com