rails-footnotes 3.7.9 → 4.0.0

data/.gitignore

@@ -7,7 +7,8 @@
 .bundle
 Gemfile.lock
 pkg/*
-coverage
+/bin
+/coverage
 tags
-doc
-bin
+/doc
+/myapp

data/.travis.yml

@@ -1,9 +1,13 @@
 script: "bundle exec rake spec"
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - ree
-notifications:
-  recipients:
-    - romanvbabenko@gmail.com
+  - 2.0.0
+  - 2.1.1
+gemfile:
+  - gemfiles/Gemfile.rails-3.2.x
+  - gemfiles/Gemfile.rails-4.0.x
+  - gemfiles/Gemfile.rails-4.1.x
+  - gemfiles/Gemfile.rails-edge
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/Gemfile.rails-edge

data/CHANGELOG

@@ -1,3 +1,16 @@
+== Footnotes v4.0.0
+  * Drop support for ruby 1.8
+  * Drop support for rails < 3.2
+  * Add support for rails 4.x
+  * Rewrite of the log note to make it work on all supported rails versions
+  * Rewrite of the partials note to make it work on all supported rails versions
+  * Rewrite of the loading mechanism, allowing to load conditionally footnotes on a per-request basis if wanted
+  * Deprecate Footnotes.run!
+  * Remove backtrace cleaner monkey patchs
+  * Remove support of .rails_footnotes file
+  * New initializer format with ability to configure footnotes more easily
+  * Remove 'general' note
+
 == Footnotes v3.7.0
   * Migrate to Bundler
   * Support only Rails3

data/README.rdoc

@@ -1,7 +1,8 @@
 = 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,
+{<img src="https://travis-ci.org/josevalim/rails-footnotes.png" />}[https://travis-ci.org/josevalim/rails-footnotes]
+
+Rails footnotes 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
@@ -9,46 +10,22 @@ your backtrace lines.
 
 == Installation
 
-NOTE: 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.2+ support, if you want to use footnotes with Rails 2.3 you should use this branch:
+
+https://github.com/josevalim/rails-footnotes/tree/rails2
 
-    https://github.com/josevalim/rails-footnotes/tree/rails2
+Installing Rails Footnotes is very easy.
 
-Install Rails Footnotes is very easy.
+=== Rails 3.2.x/4.x
 
-=== Rails 3.x
+    gem 'rails-footnotes', '>= 4.0.0', '<5'
 
-   gem 'rails-footnotes', '>= 3.7.5.rc4', :group => :development
 
 After you install RailsFootnotes and add it to your Gemfile, you need to run the generator:
 
   rails generate rails_footnotes:install
 
-=== Rails 2.x
-
-In RAILS_ROOT/config/environments/development.rb (yes, you want it only in development):
-
-  gem "rails-footnotes", '< 3.7.0', :group => :development
-
-== Configuration
-
-For version greater than 3.7.0
-
-If you want to add alternate logic to enable or disable footnotes,
-add something like this to config/initializers/footnotes.rb:
-
-  if defined?(Footnotes) && Rails.env.development?
-    Footnotes.run! # first of all
-
-    # ... other init code
-  end
-
-=== Post initialization
-
-If you want to add alternate logic to config footnotes without commit it to SCM, add your code to .footnotes:
-
-    Footnotes::Filter.notes = []
-
-this code temporarily disables notes for all controllers
+This will create an initializer with default config and some examples.
 
 === Hooks
 
@@ -59,26 +36,28 @@ this code temporarily disables notes for all controllers
         controller.action_name == 'edit' }
     end
 
+=== Editors links
+
 If you are not using Textmate as text editor, MacVim and Sublime Text 2 are also compatible.
 
 *MacVim*
 
-In your environment.rb or in an initializer do:
+In the rails-footnotes initializer do :
 
-    Footnotes::Filter.prefix = 'mvim://open?url=file://%s&line=%d&column=%d'
+    f.prefix = 'mvim://open?url=file://%s&line=%d&column=%d'
 
 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.
 
-Take note that the order in which the file name (%s), line number (%d) and column number (%d) appears is important. 
+Take note that the order in which the file name (%s), line number (%d) and column number (%d) appears is important.
 We assume that they appear in that order. "foo://line=%d&file=%s" (%d precedes %s) would throw out an error.
 
 *Sublime* *Text* *2*
 
-1. Keep the Textmate prefix, Footnotes::Filter.prefix = 'txmt://open?url=file://%s&line=%d&column=%d'
+1. Keep the Textmate prefix, <tt>f.prefix = 'txmt://open?url=file://%s&line=%d&column=%d'</tt>
 
-2. Install {subl-hanlder}[https://github.com/asuth/subl-handler]
+2. Install {subl-handler}[https://github.com/asuth/subl-handler]
 
 3. Open subl-handler. Go to preferences (SublHandler > Preferences), and point "Path to subl" to your installed instance. (EG, /Applications/Sublime Text 2.app/Contents/SharedSupport/bin/subl). Note: do not escape the whitespaces, subl-handler accounts for those.
 
@@ -93,23 +72,23 @@ 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
+    f.no_style = true
 
 Another option is to allow multiple notes to be opened at the same time:
 
-    Footnotes::Filter.multiple_notes = true
+    f.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]
+    f.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general]
 
 == Creating your own notes
 
-Create your notes to integrate with Footnotes is easy.
+Creating 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):
+3. Append your example note in Footnotes::Filter.notes array (usually at the end of your environment file or in the initializer):
 
 For example, to create a note that shows info about the user logged in your application you just have to do:
 
@@ -144,9 +123,9 @@ For example, to create a note that shows info about the user logged in your appl
     end
   end
 
-Then put in your environment:
+Then put in your environment, add in your initializer:
 
-  Footnotes::Filter.notes += [:current_user]
+  f.notes += [:current_user]
 
 == Display of the notes
 
@@ -161,12 +140,18 @@ at an appropriate place, your notes will now appear inside div#footnotes_holder
 * Keenan Brock  - http://github.com/kbrock
 * Ivan Storck   - http://github.com/ivanoats
 * Kris Chamber  - http://github.com/kristopher
+* Roman Babenko - http://github.com/romanvbabenko
+* Adrien Siami  - http://github.com/intrepidd
 
 == Bugs and Feedback
 
-If you discover any bugs, please send an e-mail to keenan@thebrocks.net
+If you discover any bugs, please open an issue.
 If you just want to give some positive feedback or drop a line, that's fine too!
 
+=== Version 4.x
+
+Starting from version 4.0, Adren Siami is the maintainer of this plugin.
+
 === Version 3.x
 
 This plugin was maintained until version 3.6 by José Valim
@@ -174,6 +159,8 @@ 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
 
+Until version 4.0, Roman Babenko maintained this plugin.
+
 === Version 2.0
 
 This plugin was created and maintained until version 2.0 by Duane Johnson:

data/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 require "rspec/core/rake_task"
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 desc 'Default: run tests'
 task :default => :spec
@@ -13,7 +13,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
 end
 
 desc 'Generate documentation for Footnotes.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
+RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Footnotes'
   rdoc.options << '--line-numbers' << '--inline-source'

data/gemfiles/Gemfile.rails-3.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 3.2.0'

data/gemfiles/Gemfile.rails-4.0.x

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 4.0.0'
+

data/gemfiles/Gemfile.rails-4.1.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 4.1.0.rc1'

data/gemfiles/Gemfile.rails-edge

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', :github => 'rails/rails'

data/lib/generators/rails_footnotes/install_generator.rb

@@ -3,15 +3,12 @@ module RailsFootnotes
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../../templates", __FILE__)
 
-      desc "Creates and copy RailsFootnotes default files to your application."
+      desc "Copy rails-footnotes initializer to your application."
 
       def copy_initializer
         template "rails_footnotes.rb", "config/initializers/rails_footnotes.rb"
       end
 
-      def copy_dotfile
-        template "rails_footnotes", ".rails_footnotes"
-      end
     end
   end
 end

data/lib/generators/templates/rails_footnotes.rb

@@ -1,5 +1,21 @@
-if defined?(Footnotes) && Rails.env.development?
-  Footnotes.run! # first of all
+Footnotes.setup do |f|
+  # Wether or not to enable footnotes
+  f.enabled = Rails.env.development?
+  # You can also use a lambda / proc to conditionally toggle footnotes
+  # Example :
+  # f.enabled = -> { User.current.admin? }
+  # Beware of thread-safety though, Footnotes.enabled is NOT thread safe
+  # and should not be modified anywhere else.
 
-  # ... other init code
+  # Only toggle some notes :
+  # f.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general]
+
+  # Change the prefix :
+  # f.prefix = 'mvim://open?url=file://%s&line=%d&column=%d'
+
+  # Disable style :
+  # f.no_style = true
+
+  # Allow to open multiple notes :
+  # f.multiple_notes = true
 end

data/lib/rails-footnotes.rb

@@ -1,3 +1,12 @@
+require 'rails'
+require 'action_controller'
+require 'rails-footnotes/abstract_note'
+require 'rails-footnotes/each_with_rescue'
+require 'rails-footnotes/filter'
+require 'rails-footnotes/notes/all'
+require 'rails-footnotes/extension'
+require 'active_support/deprecation'
+
 module Footnotes
   mattr_accessor :before_hooks
   @@before_hooks = []
@@ -5,6 +14,28 @@ module Footnotes
   mattr_accessor :after_hooks
   @@after_hooks = []
 
+  mattr_accessor :enabled
+  @@enabled = false
+
+  class << self
+    delegate :notes, :to => Filter
+    delegate :notes=, :to => Filter
+
+    delegate :prefix, :to => Filter
+    delegate :prefix=, :to => Filter
+
+    delegate :no_style, :to => Filter
+    delegate :no_style=, :to => Filter
+
+    delegate :multiple_notes, :to => Filter
+    delegate :multiple_notes=, :to => Filter
+  end
+
+  def self.run!
+    ActiveSupport::Deprecation.warn "run! is deprecated and will be removed from future releases, use Footnotes.setup or Footnotes.enabled instead.", caller
+    Footnotes.enabled = true
+  end
+
   def self.before(&block)
     @@before_hooks << block
   end
@@ -13,22 +44,19 @@ module Footnotes
     @@after_hooks << block
   end
 
-  autoload :RailsFootnotesExtension, 'rails-footnotes/extension'
-
-  def self.run!
-    require 'rails-footnotes/footnotes'
-    require 'rails-footnotes/backtracer'
-    require 'rails-footnotes/abstract_note'
-    require 'rails-footnotes/notes/all'
-
-    ActionController::Base.send(:include, RailsFootnotesExtension)
-
-    load Rails.root.join('.rails_footnotes') if Rails.root.join('.rails_footnotes').exist?
-    #TODO DEPRECATED
-    load Rails.root.join('.footnotes') if Rails.root.join('.footnotes').exist?
+  def self.enabled?
+    if @@enabled.is_a? Proc
+      @@enabled.call
+    else
+      !!@@enabled
+    end
   end
 
   def self.setup
     yield self
   end
 end
+
+ActionController::Base.send(:include, Footnotes::RailsFootnotesExtension)
+
+load Rails.root.join('.rails_footnotes') if Rails.root && Rails.root.join('.rails_footnotes').exist?

data/lib/rails-footnotes/extension.rb

@@ -1,8 +1,27 @@
+require 'active_support/concern'
+
 module Footnotes
   module RailsFootnotesExtension
-    def self.included(base)
-      base.prepend_before_filter Footnotes::BeforeFilter
-      base.after_filter Footnotes::AfterFilter
+
+    extend ActiveSupport::Concern
+
+    included do
+      prepend_before_filter :rails_footnotes_before_filter
+      after_filter :rails_footnotes_after_filter
+    end
+
+    def rails_footnotes_before_filter
+      if Footnotes.enabled?
+        Footnotes::Filter.start!(self)
+      end
+    end
+
+    def rails_footnotes_after_filter
+      if Footnotes.enabled?
+        filter = Footnotes::Filter.new(self)
+        filter.add_footnotes!
+        filter.close!(self)
+      end
     end
   end
 end

data/lib/rails-footnotes/filter.rb

@@ -10,7 +10,7 @@ module Footnotes
     # Edit notes
     @@notes = [ :controller, :view, :layout, :partials, :stylesheets, :javascripts ]
     # Show notes
-    @@notes += [ :assigns, :session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general ]
+    @@notes += [ :assigns, :session, :cookies, :params, :filters, :routes, :env, :queries, :log]
 
     # :no_style       => If you don't want the style to be appended to your pages
     # :notes          => Class variable that holds the notes to be processed
@@ -78,7 +78,7 @@ module Footnotes
     protected
       def valid?
         @body.is_a?(String) && performed_render? && valid_format? && valid_content_type? &&
-          !component_request? && !xhr? && !footnotes_disabled?
+          !component_request? && !xhr? && !footnotes_disabled? && !attached_file?
       end
 
       def add_footnotes_without_validation!
@@ -90,7 +90,7 @@ module Footnotes
       def initialize_notes!
         each_with_rescue(@@klasses) do |klass|
           note = klass.new(@controller)
-          @notes << note if note.respond_to?(:valid?) && note.valid?
+          @notes << note if note.valid?
         end
       end
 
@@ -102,24 +102,11 @@ module Footnotes
       end
 
       def performed_render?
-        @controller.instance_variable_get(:@performed_render) || # rails 2.x
-          (@controller.respond_to?(:performed?) && @controller.performed?) # rails3, will break on redirect??
+        @controller.respond_to?(:performed?) && @controller.performed?
       end
 
       def valid_format?
-        if @template # Rails 2.x
-          [:html,:rhtml,:xhtml,:rxhtml].include?(@template.send(template_format_method.to_sym).to_sym)
-        else # Rails 3
-          @controller.response.content_type == 'text/html'
-        end
-      end
-
-      def template_format_method
-        if @template.respond_to?(:template_format)
-          return 'template_format'
-        else
-          return 'format'
-        end
+        ['text/html', nil].include? @controller.response.content_type
       end
 
       def valid_content_type?
@@ -139,6 +126,10 @@ module Footnotes
         @controller.params[:footnotes] == "false"
       end
 
+      def attached_file?
+        !!(@controller.headers['Content-Disposition'] =~ /attachment/)
+      end
+
       #
       # Insertion methods
       #