rails-footnotes 3.7.1.pre → 3.7.1

data/.gitignore

@@ -6,3 +6,4 @@
 Gemfile.lock
 pkg/*
 tags
+doc

data/{README → README.rdoc}

@@ -1,13 +1,4 @@
-Rails Footnotes
-License: MIT
-Version: 3.7.0
-
-You can also read this README in pretty html at the GitHub project Wiki page
-
-  http://wiki.github.com/josevalim/rails-footnotes
-
-Description
------------
+= Rails Footnotes
 
 If you are developing in Rails you should know the plugin! It displays
 footnotes in your application for easy debugging, such as sessions,
@@ -16,28 +7,25 @@ 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
 
-Installation
-------------
-
-Since this branch aims Rails 3 support, if you want to use it with Rails 2.3 you should check this branch:
+NOTE: Since this branch aims Rails 3 support, if you want to use it with Rails 2.3 you should check this branch:
 
-  https://github.com/josevalim/rails-footnotes/tree/rails2
+    https://github.com/josevalim/rails-footnotes/tree/rails2
 
 Install Rails Footnotes is very easy.
 
-Rails 2.x
+=== Rails 3.x
 
-In RAILS_ROOT/config/environments/development.rb (yes, you want it only in development):
+   gem 'rails-footnotes', '>= 3.7', :group => :development
 
-  gem "rails-footnotes", '< 3.7.0', :group => :development
+=== Rails 2.x
 
-Rails 3.x
+In RAILS_ROOT/config/environments/development.rb (yes, you want it only in development):
 
-   gem 'rails-footnotes', '>= 3.7', :group => :development
+  gem "rails-footnotes", '< 3.7.0', :group => :development
 
-Configuration
--------------
+== Configuration
 
 For version greater then 3.7.0
 
@@ -50,8 +38,7 @@ add something like this to config/initializers/footnotes.rb:
     # ... other init code
   end
 
-Hooks
--------------
+=== Hooks
 
     Footnotes.setup do |config|
       config.before {|controller, filter| filter.notes = controller.class.name =~ /Message/ && \
@@ -63,7 +50,7 @@ Hooks
 If you are not using Textmate as text editor, in your environment.rb or
 in an initializer do:
 
-  Footnotes::Filter.prefix = 'mvim://open?url=file://%s&amp;line=%d&amp;column=%d'
+    Footnotes::Filter.prefix = 'mvim://open?url=file://%s&amp;line=%d&amp;column=%d'
 
 for MacVim
 
@@ -75,31 +62,27 @@ By default, footnotes are appended at the end of the page with default styleshee
 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
+    Footnotes::Filter.no_style = true
 
 Another option is to allow multiple notes to be opened at the same time:
 
-  Footnotes::Filter.multiple_notes = true
+    Footnotes::Filter.multiple_notes = true
 
 If you have New Relic RPM installed, you may want to turn off query explains
 (explains can slows things down)
 
-  Footnotes::Notes::QueriesNote.sql_explain = false
+    Footnotes::Notes::QueriesNote.sql_explain = false
 
 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]
+    Footnotes::Filter.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general]
 
-
-Creating your own notes
------------------------
+== 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:
@@ -139,35 +122,28 @@ Then put in your environment:
 
   Footnotes::Filter.notes += [:current_user]
 
-
-Colaborators
-------------
+== 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
------------------
+== Bugs and Feedback
 
 If you discover any bugs, please send an e-mail to keenan@thebrocks.net
 If you just want to give some positive feedback or drop a line, that's fine too!
 
-
-Version 3.x
------------
+=== Version 3.x
 
 This plugin was maintained until version 3.6 by José Valim
 
 Copyright (c) 2009 José Valim (jose@plataformatec.com.br)
-http://blog.plataformatec.com.br/
+http://blog.plataformatec.com.br
 
-Version 2.0
------------
+=== 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/
+http://blog.inquirylabs.com

data/lib/rails-footnotes/version.rb

@@ -1,3 +1,3 @@
 module Footnotes
-  VERSION = "3.7.1.pre"
+  VERSION = "3.7.1"
 end

data/rails-footnotes.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |s|
   s.add_dependency "rails", ">= 3.0.0"
 
   s.add_development_dependency "autotest"
-  s.add_development_dependency "redgreen"
   s.add_development_dependency "mocha"
   s.add_development_dependency "rails", ">= 3.0.0"
 

data/test/footnotes_test.rb

@@ -10,6 +10,10 @@ module Footnotes::Notes
     def self.to_sym; :test; end
     def valid?; true; end
   end
+
+  class NoteXNote < TestNote; end
+  class NoteYNote < TestNote; end
+  class NoteZNote < TestNote; end
 end
 
 class FootnotesTest < Test::Unit::TestCase
@@ -30,7 +34,7 @@ class FootnotesTest < Test::Unit::TestCase
     index = @controller.response.body.index(/This is the HTML page/)
     assert_equal 334, index
   end
-  
+
   def test_foonotes_included
     footnotes_perform!
     assert_not_equal $html, @controller.response.body
@@ -167,7 +171,18 @@ class FootnotesTest < Test::Unit::TestCase
     after = "    Notes</body>"
     assert_equal after, @controller.response.body.split("\n")[12]
   end
-  
+
+  def test_hooks
+    Footnotes::Filter.notes = [:note_x, :note_y, :note_z]
+    Footnotes.setup {|config| config.before {|controller, filter| filter.notes -= [:note_y] }}
+    Footnotes::Filter.start!(@controller)
+    assert_equal [:note_x, :note_z], Footnotes::Filter.notes
+
+    Footnotes.setup {|config| config.after {|controller, filter| filter.notes -= [:note_y] }}
+    @footnotes.close!(@controller)
+    assert_equal [:note_x, :note_z], Footnotes::Filter.notes
+  end
+
   protected
     # First we make sure that footnotes will perform (long life to mocha!)
     # Then we call add_footnotes!
@@ -204,4 +219,4 @@ $html = <<HTML
         <p>You will be glad to know that no changes need to be made to any of your CSS files.</p>
     </body>
 </html>
-HTML
+HTML

data/test/test_helper.rb

@@ -1,5 +1,5 @@
-require 'test/unit'
 require 'rubygems'
+require 'test/unit'
 require 'mocha'
 
 ENV['RAILS_ENV'] = 'test'
@@ -7,4 +7,5 @@ ENV['RAILS_ENV'] = 'test'
 require 'active_support'
 require 'active_support/all' unless Class.respond_to?(:cattr_accessor)
 require 'rails-footnotes/footnotes'
-require 'rails-footnotes/notes/abstract_note'
+require 'rails-footnotes/notes/abstract_note'
+require "rails-footnotes"

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: rails-footnotes
 version: !ruby/object:Gem::Version 
-  prerelease: 6
-  version: 3.7.1.pre
+  prerelease: 
+  version: 3.7.1
 platform: ruby
 authors: 
 - Keenan Brock
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-23 00:00:00 Z
+date: 2011-04-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -35,7 +35,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: redgreen
+  name: mocha
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -45,28 +45,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rails
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 3.0.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id004
 description: Every Rails page has footnotes that gives information about your application and links back to your editor.
 email: 
 - keenan@thebrocks.net
@@ -82,7 +71,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README
+- README.rdoc
 - Rakefile
 - lib/rails-footnotes.rb
 - lib/rails-footnotes/backtracer.rb
@@ -128,9 +117,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.3.1
+      version: "0"
 requirements: []
 
 rubyforge_project: rails-footnotes