rails-footnotes 3.6.3 → 3.6.4

data/MIT-LICENSE

@@ -1,21 +1,21 @@
-Copyright (c) 2006 Coda Hale
-Copyright (c) 2008 José Valim (jose.valim at gmail dot com)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2006 Coda Hale
+Copyright (c) 2008 José Valim (jose.valim at gmail dot com)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -1,141 +1,140 @@
-Rails Footnotes
-License: MIT
-Version: 3.6.3
-
-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:
-
-   gem sources -a http://gemcutter.org
-   sudo gem install rails-footnotes
-
-In RAILS_ROOT/config/environments/development.rb (yes, you want it only in development):
-
-  config.gem "rails-footnotes", :source => "http://gemcutter.org"
-
-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&line=%d&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.
-
-1. Create a Footnotes::Notes::YourExampleNote class
-
-2. Implement the necessary methods (check abstract_note.rb file in lib/notes)
-
-3. 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       - http://github.com/scorpio
-* Keenan Brock  - http://github.com/kbrock
-* Ivan Storck   - http://github.com/ivanoats
-* Kris Chamber  - http://github.com/kristopher
-
-
-Bugs and Feedback
------------------
-
-If you discover any bugs, please send an e-mail to jose@plataformatec.com.br
-If you just want to give some positive feedback or drop a line, that's fine too!
-
-Copyright (c) 2009 José Valim (jose@plataformatec.com.br)
-http://blog.plataformatec.com.br/
-
-
-Version 2.0
------------
-
-This plugin was created and maintained until version 2.0 by Duane Johnson:
-
-Copyright (c) 2006 InquiryLabs, Inc.
-http://blog.inquirylabs.com/
+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.
+
+1. Create a Footnotes::Notes::YourExampleNote class
+
+2. Implement the necessary methods (check abstract_note.rb file in lib/notes)
+
+3. 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       - http://github.com/scorpio
+* Keenan Brock  - http://github.com/kbrock
+* Ivan Storck   - http://github.com/ivanoats
+* Kris Chamber  - http://github.com/kristopher
+
+
+Bugs and Feedback
+-----------------
+
+If you discover any bugs, please send an e-mail to jose@plataformatec.com.br
+If you just want to give some positive feedback or drop a line, that's fine too!
+
+Copyright (c) 2009 José Valim (jose@plataformatec.com.br)
+http://blog.plataformatec.com.br/
+
+
+Version 2.0
+-----------
+
+This plugin was created and maintained until version 2.0 by Duane Johnson:
+
+Copyright (c) 2006 InquiryLabs, Inc.
+http://blog.inquirylabs.com/

data/Rakefile

@@ -1,12 +1,12 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name = "rails-footnotes"
-    s.version = "3.6.3"
+    s.version = "3.6.4"
     s.rubyforge_project = "rails-footnotes"
     s.summary = "Every Rails page has footnotes that gives information about your application and links back to your editor."
     s.email = "jose@plataformatec.com.br"
@@ -20,19 +20,19 @@ begin
 rescue LoadError
   puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
-
-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.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  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
+
+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.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  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

data/lib/rails-footnotes.rb

@@ -1,20 +1,20 @@
-if RAILS_ENV == 'development'
-  dir = File.dirname(__FILE__)
-  require File.join(dir, 'rails-footnotes', 'footnotes')
-  require File.join(dir, 'rails-footnotes', 'backtracer')
-
-  # Load all notes
-  #
-  Dir[File.join(dir, 'rails-footnotes', 'notes', '*.rb')].each do |note|
-    require note  unless note =~ /queries/ && !defined?(ActiveRecord)
-  end
-
-  # The footnotes are applied by default to all actions. You can change this
-  # behavior commenting the after_filter line below and putting it in Your
-  # application. Then you can cherrypick in which actions it will appear.
-  #
-  class ActionController::Base
-    prepend_before_filter Footnotes::Filter
-    after_filter Footnotes::Filter
-  end
+if RAILS_ENV == 'development'
+  dir = File.dirname(__FILE__)
+  require File.join(dir, 'rails-footnotes', 'footnotes')
+  require File.join(dir, 'rails-footnotes', 'backtracer')
+
+  # Load all notes
+  #
+  Dir[File.join(dir, 'rails-footnotes', 'notes', '*.rb')].each do |note|
+    require note  unless note =~ /queries/ && !defined?(ActiveRecord)
+  end
+
+  # The footnotes are applied by default to all actions. You can change this
+  # behavior commenting the after_filter line below and putting it in Your
+  # application. Then you can cherrypick in which actions it will appear.
+  #
+  class ActionController::Base
+    prepend_before_filter Footnotes::Filter
+    after_filter Footnotes::Filter
+  end
 end

data/lib/rails-footnotes/backtracer.rb

@@ -1,34 +1,34 @@
-module Footnotes
-  module Extensions
-    module Exception
-      def self.included(base)
-        base.class_eval do
-          alias_method_chain :clean_backtrace, :links
-        end
-      end
-
-      def add_links_to_backtrace(lines)
-        lines.collect do |line|
-          expanded = line.gsub('#{RAILS_ROOT}', RAILS_ROOT)
-          if match = expanded.match(/^(.+):(\d+):in/) || match = expanded.match(/^(.+):(\d+)\s*$/)
-            file = File.expand_path(match[1])
-            line_number = match[2]
-            html = %[<a href="#{Footnotes::Filter.prefix(file, line_number, 1)}">#{line}</a>]
-          else
-            line
-          end
-        end
-      end
-
-      def clean_backtrace_with_links
-        unless ::Footnotes::Filter.prefix.blank?
-          add_links_to_backtrace(clean_backtrace_without_links)
-        else
-          clean_backtrace_without_links
-        end
-      end
-    end
-  end
-end
-
+module Footnotes
+  module Extensions
+    module Exception
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :clean_backtrace, :links
+        end
+      end
+
+      def add_links_to_backtrace(lines)
+        lines.collect do |line|
+          expanded = line.gsub('#{RAILS_ROOT}', RAILS_ROOT)
+          if match = expanded.match(/^(.+):(\d+):in/) || match = expanded.match(/^(.+):(\d+)\s*$/)
+            file = File.expand_path(match[1])
+            line_number = match[2]
+            html = %[<a href="#{Footnotes::Filter.prefix(file, line_number, 1)}">#{line}</a>]
+          else
+            line
+          end
+        end
+      end
+
+      def clean_backtrace_with_links
+        unless ::Footnotes::Filter.prefix.blank?
+          add_links_to_backtrace(clean_backtrace_without_links)
+        else
+          clean_backtrace_without_links
+        end
+      end
+    end
+  end
+end
+
 Exception.send :include, Footnotes::Extensions::Exception