josevalim-rails-footnotes 3.3.2 → 3.4

data/README

@@ -1,8 +1,6 @@
-Copyright (c) 2008 José Valim (jose.valim at gmail dot com)
-Site: http://www.pagestacker.com/
-Blog: http://josevalim.blogspot.com/
+Rails Footnotes
 License: MIT
-Version: 3.3.2
+Version: 3.4
 
 You can also read this README in pretty html at the GitHub project Wiki page
 
@@ -23,14 +21,11 @@ your backtrace lines.
 Installation
 ------------
 
-Install Rails Footnotes is very easy. It is stored in GitHub, so if you
-have never installed a gem via GitHub run the following:
+Install Rails Footnotes is very easy. If you are running on Rails 2.3 just run
+the following:
 
-  gem sources -a http://gems.github.com
-
-Then install the gem:
-
-  sudo gem install josevalim-rails-footnotes
+   gem sources -a http://gems.github.com
+   sudo gem install josevalim-rails-footnotes
 
 In RAILS_ROOT/config/environments/development.rb (yes, you want it only in development):
 
@@ -38,10 +33,18 @@ In RAILS_ROOT/config/environments/development.rb (yes, you want it only in devel
 
 If you want it as plugin, just do:
 
+   script/plugin install git://github.com/josevalim/rails-footnotes.git
+
+If you are running on Rails 2.2 or Rails 2.1 you should do:
+
     cd myapp
     git clone git://github.com/josevalim/rails-footnotes.git
-    rm -rf vendor/plugins/rails-footnotes/.git
+    cd vendor/plugins/rails-footnotes
+    git checkout VERSION_NUMBER
+    rm -rf ./.git
 
+Where you should replace VERSION_NUMBER for "v3.3.2" for Rails 2.2 and "v3.2.2"
+for Rails 2.1 (without the quotes).
 
 Configuration
 -------------
@@ -75,20 +78,6 @@ 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]
 
 
-Early versions
---------------
-
-If you are running on Rails 2.1.x, you should use Footnotes v3.2.2:
-
-    cd myapp
-    git clone git://github.com/josevalim/rails-footnotes.git
-    cd vendor/plugins/rails-footnotes
-    git checkout v3.2.2
-    rm -rf ./.git
-
-If you are using earlier than 2.1, please upgrade your app. =)
-
-
 Creating your own notes
 -----------------------
 
@@ -138,10 +127,21 @@ Then put in your environment:
   Footnotes::Filter.notes += [:current_user]
 
 
+Bugs and Feedback
+-----------------
+
+If you discover any bugs, please send an e-mail to jose.valim@gmail.com
+If you just want to give some positive feedback or drop a line, that's fine too! =)
+
+Copyright (c) 2009 José Valim
+http://www.pagestacker.com/
+http://josevalim.blogspot.com/
+
+
 Version 2.0
 -----------
 
 Until version 2.0, this plugin was created and maintained by:
 
 Duane Johnson (duane.johnson@gmail.com)
-http://blog.inquirylabs.com/
+http://blog.inquirylabs.com/

data/Rakefile

@@ -2,17 +2,18 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-desc 'Test Footnotes plugin.'
+desc 'Run tests for Footnotes.'
 Rake::TestTask.new(:test) do |t|
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
-desc 'Generate documentation for Footnotes plugin.'
+desc 'Generate documentation for Footnotes.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'SimpleLocalization'
+  rdoc.title    = 'Footnotes'
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('MIT-LICENSE')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/lib/{footnotes → rails-footnotes}/footnotes.rb

@@ -113,7 +113,7 @@ module Footnotes
 
     protected
       def valid?
-        performed_render? && first_render? && valid_format? && valid_content_type? && @body.is_a?(String) && !component_request? && !xhr?
+        performed_render? && valid_format? && valid_content_type? && @body.is_a?(String) && !component_request? && !xhr?
       end
 
       def add_footnotes_without_validation!
@@ -133,10 +133,6 @@ module Footnotes
         @controller.instance_variable_get(:@performed_render)
       end
 
-      def first_render?
-        @template.instance_variable_get(:@_first_render)
-      end
-
       def valid_format?
         [:html,:rhtml,:xhtml,:rxhtml].include?(@template.template_format.to_sym)
       end
@@ -187,16 +183,43 @@ module Footnotes
           #{links}
           #{content}
           <script type="text/javascript">
-            function footnotes_close(){
-              #{close unless @@multiple_notes}
-            }
-            function footnotes_toogle(id){
-              s = document.getElementById(id).style;
-              before = s.display;
-              footnotes_close();
-              s.display = (before != 'block') ? 'block' : 'none'
-              location.href = '#footnotes_debug';
-            }
+            var Footnotes = function() {
+
+              function hideAll(){
+                #{close unless @@multiple_notes}
+              }
+              
+              function hideAllAndToggle(id) {
+                hideAll();
+                toggle(id)
+              }  
+              
+              function toggle(id){
+                var el = document.getElementById(id);
+                if (el.style.display == 'none') {
+                  Footnotes.show(el);
+                } else {
+                  Footnotes.hide(el);
+                }
+              
+                location.href = '#footnotes_debug';
+              }
+            
+              function show(element) {
+                element.style.display = 'block'
+              }
+            
+              function hide(element) {
+                element.style.display = 'none'
+              }
+
+              return {
+                show: show,
+                hide: hide,
+                toggle: toggle,
+                hideAllAndToggle: hideAllAndToggle
+              }
+            }();
             /* Additional Javascript */
             #{@notes.map(&:javascript).compact.join("\n")}
           </script>
@@ -266,7 +289,7 @@ module Footnotes
       # Helper that creates the javascript code to close the note
       #
       def close_helper(note)
-        "document.getElementById('#{note.to_sym}_debug_info').style.display = 'none'\n"
+        "Footnotes.hide(document.getElementById('#{note.to_sym}_debug_info'));\n"
       end
 
       # Helper that creates the link and javascript code when note is clicked
@@ -275,7 +298,7 @@ module Footnotes
         onclick = note.onclick
         unless href = note.link
           href = '#'
-          onclick ||= "footnotes_toogle('#{note.to_sym}_debug_info');return false;" if note.has_fieldset?
+          onclick ||= "Footnotes.hideAllAndToggle('#{note.to_sym}_debug_info');return false;" if note.has_fieldset?
         end
 
         "<a href=\"#{href}\" onclick=\"#{onclick}\">#{note.title}</a>"

data/lib/{notes → rails-footnotes/notes}/env_note.rb

@@ -9,7 +9,7 @@ module Footnotes
 
       def content
         # Replace HTTP_COOKIE for a link
-        @env['HTTP_COOKIE'] = '<a href="#" style="color:#009" onclick="footnotes_toogle(\'cookies_debug_info\');return false;">See cookies on its tab</a>'
+        @env['HTTP_COOKIE'] = '<a href="#" style="color:#009" onclick="Footnotes.hideAllAndToggle(\'cookies_debug_info\');return false;">See cookies on its tab</a>'
 
         # Create the env table
         mount_table(@env.to_a.sort.unshift([:key, :value]))

data/lib/rails-footnotes/notes/layout_note.rb

@@ -0,0 +1,28 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module Footnotes
+  module Notes
+    class LayoutNote < AbstractNote
+      def initialize(controller)
+        @controller = controller
+      end
+
+      def row
+        :edit
+      end
+
+      def link
+        escape(Footnotes::Filter.prefix(filename, 1, 1))
+      end
+
+      def valid?
+        prefix? && @controller.active_layout
+      end
+
+      protected
+        def filename
+          @controller.active_layout.filename
+        end
+    end
+  end
+end

data/lib/{notes → rails-footnotes/notes}/queries_note.rb

@@ -27,23 +27,13 @@ module Footnotes
 STYLESHEET
       end
 
-      def javascript
-<<-JAVASCRIPT
-  function queries_toogle(type, id){
-    s = document.getElementById('q'+type+'_'+id).style
-    s.display = (s.display != 'block') ? 'block' : 'none'
-    location.href = '#qtitle_'+id
-  }
-JAVASCRIPT
-      end
-
       def content
         html = ''
 
         @@sql.each_with_index do |item, i|
           sql_links = []
-          sql_links << "<a href=\"#\" style=\"color:#A00;\" onclick=\"queries_toogle('table',#{i});return false\">explain</a>" if item.explain
-          sql_links << "<a href=\"#\" style=\"color:#00A;\" onclick=\"queries_toogle('trace',#{i});return false\">trace</a>" if item.trace
+          sql_links << "<a href=\"#\" style=\"color:#A00;\" onclick=\"Footnotes.toggle('qtable_#{i}');return false\">explain</a>" if item.explain
+          sql_links << "<a href=\"#\" style=\"color:#00A;\" onclick=\"Footnotes.toggle('qtrace_#{i}');return false\">trace</a>" if item.trace
 
 html << <<-HTML
   <b id="qtitle_#{i}">#{escape(item.type.to_s.upcase)}</b> (#{sql_links.join(' | ')})<br />
@@ -153,4 +143,4 @@ if Footnotes::Notes::QueriesNote.included?
     next if adapter =~ /SQLite.Adapter$/
     eval("ActiveRecord::ConnectionAdapters::#{adapter}").send :include, Footnotes::Extensions::QueryAnalyzer
   end
-end
+end

data/lib/{notes → rails-footnotes/notes}/view_note.rb

@@ -17,17 +17,13 @@ module Footnotes
       end
 
       def valid?
-        prefix? && first_render?
+        prefix? && @template && @template.template
       end
 
       protected
-        def first_render?
-          @template.instance_variable_get(:@_first_render)
-        end
-        
         def filename
-          @filename ||= @template.instance_variable_get(:@_first_render).filename
+          @template.template.filename
         end
     end
   end
-end
+end

data/lib/rails-footnotes.rb

@@ -1,11 +1,11 @@
 if RAILS_ENV == 'development'
   dir = File.dirname(__FILE__)
-  require File.join(dir, 'footnotes', 'footnotes')
-  require File.join(dir, 'backtracer', 'backtracer')
+  require File.join(dir, 'rails-footnotes', 'footnotes')
+  require File.join(dir, 'rails-footnotes', 'backtracer')
 
   # Load all notes
   #
-  Dir[File.join(dir, 'notes', '*.rb')].each do |note|
+  Dir[File.join(dir, 'rails-footnotes', 'notes', '*.rb')].each do |note|
     require note
   end
 

data/test/footnotes_test.rb

@@ -124,7 +124,7 @@ class FootnotesTest < Test::Unit::TestCase
   def test_links_helper_has_fieldset?
     note = Footnotes::Notes::TestNote.new
     note.expects(:has_fieldset?).times(1).returns(true)
-    assert_equal '<a href="#" onclick="footnotes_toogle(\'test_debug_info\');return false;">Test</a>', @footnotes.send(:link_helper, note)
+    assert_equal '<a href="#" onclick="Footnotes.hideAllAndToggle(\'test_debug_info\');return false;">Test</a>', @footnotes.send(:link_helper, note)
   end
 
   def test_links_helper_onclick

data/test/test_helper.rb

@@ -2,8 +2,8 @@ require 'test/unit'
 require 'rubygems'
 require 'mocha'
 
-ENV["RAILS_ENV"] = "test"
+ENV['RAILS_ENV'] = 'test'
 
 require 'active_support'
-require File.dirname(__FILE__) + '/../lib/footnotes'
-require File.dirname(__FILE__) + '/../lib/notes/abstract_note'
+require File.dirname(__FILE__) + '/../lib/rails-footnotes/footnotes'
+require File.dirname(__FILE__) + '/../lib/rails-footnotes/notes/abstract_note'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-rails-footnotes
 version: !ruby/object:Gem::Version 
-  version: 3.3.2
+  version: "3.4"
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-04 00:00:00 -08:00
+date: 2009-02-04 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -26,25 +26,25 @@ files:
 - README
 - Rakefile
 - lib/rails-footnotes.rb
-- lib/backtracer/backtracer.rb
-- lib/footnotes/footnotes.rb
-- lib/notes/abstract_note.rb
-- lib/notes/components_note.rb
-- lib/notes/controller_note.rb
-- lib/notes/cookies_note.rb
-- lib/notes/env_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
+- lib/rails-footnotes/backtracer.rb
+- lib/rails-footnotes/footnotes.rb
+- lib/rails-footnotes/notes/abstract_note.rb
+- lib/rails-footnotes/notes/components_note.rb
+- lib/rails-footnotes/notes/controller_note.rb
+- lib/rails-footnotes/notes/cookies_note.rb
+- lib/rails-footnotes/notes/env_note.rb
+- lib/rails-footnotes/notes/files_note.rb
+- lib/rails-footnotes/notes/filters_note.rb
+- lib/rails-footnotes/notes/general_note.rb
+- lib/rails-footnotes/notes/javascripts_note.rb
+- lib/rails-footnotes/notes/layout_note.rb
+- lib/rails-footnotes/notes/log_note.rb
+- lib/rails-footnotes/notes/params_note.rb
+- lib/rails-footnotes/notes/queries_note.rb
+- lib/rails-footnotes/notes/routes_note.rb
+- lib/rails-footnotes/notes/session_note.rb
+- lib/rails-footnotes/notes/stylesheets_note.rb
+- lib/rails-footnotes/notes/view_note.rb
 - test/footnotes_test.rb
 - test/test_helper.rb
 - test/notes/abstract_note_test.rb

data/lib/notes/layout_note.rb

@@ -1,33 +0,0 @@
-require "#{File.dirname(__FILE__)}/view_note"
-
-module Footnotes
-  module Notes
-    class LayoutNote < AbstractNote
-      def initialize(controller)
-        @controller = controller
-        @template = controller.instance_variable_get('@template')
-      end
-
-      def row
-        :edit
-      end
-
-      def link
-        escape(Footnotes::Filter.prefix(layout_filename, 1, 1))
-      end
-
-      def valid?
-        prefix? && @controller.active_layout && layout_template
-      end
-
-      protected
-        def layout_template
-          @layout_template ||= @template.send(:_pick_template, @controller.active_layout)
-        end
-
-        def layout_filename
-          layout_template.filename
-        end
-    end
-  end
-end