rails-footnotes 4.1.5 → 5.0.0

data/gemfiles/{Gemfile.rails-3.2.x → Gemfile.rails-3.2.22}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec :path => '..'
 
-gem 'rails', '~> 3.2.0'
+gem 'rails', '~> 3.2.22'

data/lib/generators/templates/rails_footnotes.rb

@@ -1,11 +1,10 @@
-defined?(Footnotes) && Footnotes.setup do |f|
+Footnotes.setup do |f|
   # Whether or not to enable footnotes
   f.enabled = Rails.env.development?
-  # You can also use a lambda / proc to conditionally toggle footnotes
-  # Example :
+  # You can also use a lambda / proc to conditionally toggle footnotes, like
   # f.enabled = -> { User.current.admin? }
   # Beware of thread-safety though, Footnotes.enabled is NOT thread safe
-  # and should not be modified anywhere else.
+  # and should not be modified outside this initializer.
 
   # Only toggle some notes :
   # f.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log]
@@ -24,4 +23,4 @@ defined?(Footnotes) && Footnotes.setup do |f|
 
   # Allow to open multiple notes :
   # f.multiple_notes = true
-end
+end if defined?(Footnotes) && Footnotes.respond_to?(:setup)

data/lib/rails-footnotes.rb

@@ -5,7 +5,6 @@ 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
@@ -37,11 +36,6 @@ module Footnotes
     delegate :font_size=, :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
@@ -50,9 +44,13 @@ module Footnotes
     @@after_hooks << block
   end
 
-  def self.enabled?
+  def self.enabled?(controller)
     if @@enabled.is_a? Proc
-      @@enabled.call
+      if @@enabled.arity == 1
+        @@enabled.call(controller)
+      else
+        @@enabled.call
+      end
     else
       !!@@enabled
     end
@@ -63,6 +61,8 @@ module Footnotes
   end
 end
 
-ActionController::Base.send(:include, Footnotes::RailsFootnotesExtension)
+ActiveSupport.on_load(:action_controller) do
+  ActionController::Base.send(:include, Footnotes::RailsFootnotesExtension)
+end
 
 load Rails.root.join('.rails_footnotes') if Rails.root && Rails.root.join('.rails_footnotes').exist?

data/lib/rails-footnotes/extension.rb

@@ -2,26 +2,23 @@ require 'active_support/concern'
 
 module Footnotes
   module RailsFootnotesExtension
-
     extend ActiveSupport::Concern
 
     included do
-      prepend_before_filter :rails_footnotes_before_filter
-      after_filter :rails_footnotes_after_filter
+      prepend_before_action :rails_footnotes_before_filter
+      after_action :rails_footnotes_after_filter
     end
 
     def rails_footnotes_before_filter
-      if Footnotes.enabled?
-        Footnotes::Filter.start!(self)
-      end
+      Footnotes::Filter.start!(self) if Footnotes.enabled?(self)
     end
 
     def rails_footnotes_after_filter
-      if Footnotes.enabled?
-        filter = Footnotes::Filter.new(self)
-        filter.add_footnotes!
-        filter.close!(self)
-      end
+      return unless Footnotes.enabled?(self)
+
+      filter = Footnotes::Filter.new(self)
+      filter.add_footnotes!
+      filter.close!(self)
     end
   end
 end

data/lib/rails-footnotes/filter.rb

@@ -47,7 +47,7 @@ module Footnotes
         if args.empty?
           @@prefix
         else
-          args.map! { |arg| URI.escape(arg.to_s) }
+          args.map! { |arg| arg.to_s.split("/").map{|s| ERB::Util.url_encode(s) }.join("/") }
 
           if @@prefix.respond_to? :call
             @@prefix.call *args
@@ -116,7 +116,8 @@ module Footnotes
       end
 
       def valid_format?
-        ['text/html', nil].include? @controller.response.content_type
+        format = @controller.response.content_type
+        format.nil? || format.include?("text/html")
       end
 
       def valid_content_type?
@@ -169,7 +170,7 @@ module Footnotes
           #footnotes_debug table td {padding: 5px; border-bottom: 1px solid #ccc;}
           #footnotes_debug table td strong {color: #9b1b1b;}
           #footnotes_debug table th {padding: 5px; border-bottom: 1px solid #ccc;}
-          #footnotes_debug table tr:nth-child(2n) td {background: #eee;}
+          #footnotes_debug table tr:nth-child(2n) td {background: #f5f5f5;}
           #footnotes_debug table tr:nth-child(2n + 1) td {background: #fff;}
           #footnotes_debug tbody {text-align: left;}
           #footnotes_debug .name_values td {vertical-align: top;}
@@ -207,14 +208,22 @@ module Footnotes
               }
 
               function hideAllAndToggle(id) {
+                var n = note(id);
+                var display = n.style.display;
                 hideAll();
+                // Restore original display to allow toggling
+                n.style.display = display;
                 toggle(id)
 
                 location.href = '#footnotes_debug';
               }
 
+              function note(id) {
+                return (document.getElementById(id));
+              }
+
               function toggle(id){
-                var el = document.getElementById(id);
+                var el = note(id);
                 if (el.style.display == 'none') {
                   Footnotes.show(el);
                 } else {

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

@@ -16,9 +16,9 @@ module Footnotes
                             :@view_runtime,
                             :@marked_for_same_origin_verification
                           ]
-      cattr_accessor :ignored_assigns, :instance_writter => false
+      cattr_accessor :ignored_assigns, :instance_writer => false
       @@ignored_assigns_pattern = /^@_/
-      cattr_accessor :ignored_assigns_pattern, :instance_writter => false
+      cattr_accessor :ignored_assigns_pattern, :instance_writer => false
 
       def initialize(controller)
         @controller = controller

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

@@ -24,36 +24,25 @@ module Footnotes
 
       protected
         def scan_text(text)
-          []
+          raise NotImplementedError, "implement this in your subclass"
         end
 
         def parse_files!
-          if Rails.version >= '3.1' && Rails.application.config.assets[:enabled]
-            asset_paths = Rails.application.config.assets.paths
-            linked_files = []
+          asset_paths = Rails.application.config.try(:assets).try(:paths) || []
+          linked_files = []
 
-            @files.collect do |file|
-              base_name = File.basename(file)
-              asset_paths.each do |asset_path|
-                results = Dir[File.expand_path(base_name, asset_path) + '*']
-                results.each do |r|
-                  linked_files << %[<a href="#{Footnotes::Filter.prefix(r, 1, 1)}">#{File.basename(r)}</a>]
-                end
-                break if results.present?
-              end
-            end
-            @files = linked_files
-          else
-            #Original Implementation
-            @files.collect! do |filename|
-              if filename =~ %r{^/}
-                full_filename = File.join(File.expand_path(Rails.root), 'public', filename)
-                %[<a href="#{Footnotes::Filter.prefix(full_filename, 1, 1)}">#{filename}</a>]
-              else
-                %[<a href="#{filename}">#{filename}</a>]
+          @files.collect do |file|
+            file.gsub!(/-[a-f0-9]{64}\./, '.')
+            base_name = File.basename(file)
+            asset_paths.each do |asset_path|
+              results = Dir[File.expand_path(base_name, asset_path) + '*']
+              results.each do |r|
+                linked_files << %[<a href="#{Footnotes::Filter.prefix(r, 1, 1)}">#{File.basename(r)}</a>]
               end
+              break if results.present?
             end
           end
+          @files = linked_files
         end
     end
   end

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

@@ -20,7 +20,7 @@ module Footnotes
           end
         # Rails 3 don't have ActiveSupport::Logger#broadcast so we backported it
         extend_module = defined?(ActiveSupport::Logger) ? ActiveSupport::Logger.broadcast(note_logger) : NoteLogger.broadcast(note_logger)
-        Rails.logger = self.original_logger.dup.extend(extend_module)
+        Rails.logger = self.original_logger.clone.extend(extend_module)
       end
 
       def title

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

@@ -2,7 +2,11 @@ module Footnotes
   module Notes
     class ParamsNote < AbstractNote
       def initialize(controller)
-        @params = controller.params.symbolize_keys
+        @params = if Rails::VERSION::MAJOR >= 5
+          controller.params.to_unsafe_h
+        else
+          controller.params
+        end
       end
 
       def title

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

@@ -1,7 +1,7 @@
 module Footnotes
   module Notes
     class QueriesNote < AbstractNote
-      cattr_accessor :alert_db_time, :alert_sql_number, :orm, :ignored_regexps, :instance_writter => false
+      cattr_accessor :alert_db_time, :alert_sql_number, :orm, :ignored_regexps, :instance_writer => false
       @@alert_db_time    = 16.0
       @@alert_sql_number = 8
       @@query_subscriber = nil
@@ -23,8 +23,8 @@ module Footnotes
       def title
         queries = self.events.count
         total_time = self.events.map(&:duration).sum
-        query_color = generate_red_color(self.events.count, alert_sql_number)
-        db_color    = generate_red_color(total_time, alert_db_time)
+        query_color = alert_color(self.events.count, alert_sql_number)
+        db_color    = alert_color(total_time, alert_db_time)
 
         <<-TITLE
         <span style="background-color:#{query_color}">Queries (#{queries})</span>
@@ -47,7 +47,7 @@ module Footnotes
             <td>
               <span id="sql_#{index}">#{print_query(event.payload[:sql])}</span>
             </td>
-            <td>#{print_name_and_time(event.payload[:name], event.duration / 1000.0)}</td>
+            <td>#{print_name_and_time(event.payload[:name], event.duration)}</td>
           </tr>
           HTML
         end
@@ -57,17 +57,16 @@ module Footnotes
 
       protected
       def print_name_and_time(name, time)
-        "<span style='background-color:#{generate_red_color(time, alert_ratio)}'>#{escape(name || 'SQL')} (#{'%.3fms' % time})</span>"
+        "<span style='background-color:#{alert_color(time, alert_ratio)}'>#{escape(name || 'SQL')} (#{'%.3fms' % time})</span>"
       end
 
       def print_query(query)
         escape(query.to_s.gsub(/(\s)+/, ' ').gsub('`', ''))
       end
 
-      def generate_red_color(value, alert)
-        c = ((value.to_f/alert).to_i - 1) * 16
-        c = 0  if c < 0; c = 15 if c > 15; c = (15-c).to_s(16)
-        "#ff#{c*4}"
+      def alert_color(value, threshold)
+        return 'transparent' if value < threshold
+        '#ffff00'
       end
 
       def alert_ratio
@@ -103,7 +102,7 @@ module Footnotes
       attr_accessor :events, :ignore_regexps
 
       def initialize(orm)
-        super() 
+        super()
         @events = []
         orm.each {|adapter| ActiveSupport::LogSubscriber.attach_to adapter, self}
       end

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

@@ -1,31 +1,40 @@
 module Footnotes
   module Notes
     class ViewNote < AbstractNote
+      cattr_accessor :template
+
+      def self.start!(controller)
+        @subscriber ||= ActiveSupport::Notifications.subscribe('render_template.action_view') do |*args|
+          event = ActiveSupport::Notifications::Event.new *args
+          self.template = {:file => event.payload[:identifier], :duration => event.duration}
+        end
+      end
+
       def initialize(controller)
         @controller = controller
-        @template = controller.instance_variable_get(:@template)
       end
 
       def row
         :edit
       end
 
+      def title
+        "View (#{"%.3f" % self.template[:duration]}ms)"
+      end
+
       def link
         escape(Footnotes::Filter.prefix(filename, 1, 1))
       end
 
       def valid?
-        prefix? && first_render?
+        prefix? && filename && File.exists?(filename)
       end
 
       protected
 
-        def first_render?
-          @template.instance_variable_get(:@_first_render)
-        end
-
         def filename
-          @filename ||= @template.instance_variable_get(:@_first_render).filename
+          return @filename if defined?(@filename)
+          @filename = self.class.template.try(:[], :file)
         end
 
     end

data/lib/rails-footnotes/version.rb

@@ -1,3 +1,3 @@
 module Footnotes
-  VERSION = "4.1.5"
+  VERSION = "5.0.0"
 end

data/lib/rails6-footnotes.rb

@@ -0,0 +1 @@
+require_relative "./rails-footnotes"

data/rails-footnotes.gemspec

@@ -6,21 +6,16 @@ Gem::Specification.new do |s|
   s.name        = "rails-footnotes"
   s.version     = Footnotes::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Roman V. Babenko", "José Valim", "Keenan Brock", "Duane Johnson", "Adrien Siami"]
-  s.email       = ["romanvbabenko@gmail.com"]
-  s.homepage    = "http://github.com/josevalim/rails-footnotes"
+  s.authors     = ["Roman V. Babenko", "José Valim", "Keenan Brock", "Duane Johnson", "Adrien Siami", "André Arko"]
+  s.email       = ["andre@arko.net"]
+  s.homepage    = "http://github.com/indirect/rails-footnotes"
   s.summary     = %q{Every Rails page has footnotes that gives information about your application and links back to your editor.}
   s.description = %q{Every Rails page has footnotes that gives information about your application and links back to your editor.}
 
-  s.rubyforge_project = "rails-footnotes"
-
-  s.add_dependency "rails", ">= 3.2"
-
-  s.add_development_dependency "rspec-rails", '~> 2.14.0'
-  s.add_development_dependency "capybara"
+  s.add_dependency "rails", "~> 6.0"
+  s.required_ruby_version = "~> 3.0"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/spec/abstract_note_spec.rb

@@ -11,17 +11,21 @@ describe Footnotes::Notes::AbstractNote do
     Footnotes::Filter.notes = @notes
   end
 
-  it {described_class.should respond_to :start!}
-  it {described_class.should respond_to :close!}
-  it {described_class.should respond_to :title}
+  it {expect(described_class).to respond_to :start!}
+  it {expect(described_class).to respond_to :close!}
+  it {expect(described_class).to respond_to :title}
 
   it {should respond_to :to_sym}
-  its(:to_sym) {should eql :abstract}
 
-  it { described_class.should be_included }
+  describe '#to_sym' do
+    subject { super().to_sym }
+    it {should eql :abstract}
+  end
+
+  it { expect(described_class).to be_included }
   specify do
     Footnotes::Filter.notes = []
-    described_class.should_not be_included
+    expect(described_class).not_to be_included
   end
 
   it { should respond_to :row }
@@ -45,12 +49,12 @@ describe Footnotes::Notes::AbstractNote do
 
   #TODO should be moved to builder
   #helpers
-  specify { subject.escape('<').should eql '&lt;' }
-  specify { subject.escape('&').should eql '&amp;' }
-  specify { subject.escape('>').should eql '&gt;' }
+  specify { expect(subject.escape('<')).to eql '&lt;' }
+  specify { expect(subject.escape('&')).to eql '&amp;' }
+  specify { expect(subject.escape('>')).to eql '&gt;' }
 
-  specify { subject.mount_table([]).should be_blank }
-  specify { subject.mount_table([['h1', 'h2', 'h3']], :class => 'table').should be_blank }
+  specify { expect(subject.mount_table([])).to be_blank }
+  specify { expect(subject.mount_table([['h1', 'h2', 'h3']], :class => 'table')).to be_blank }
 
   specify {
     tab = <<-TABLE
@@ -60,7 +64,7 @@ describe Footnotes::Notes::AbstractNote do
           </table>
           TABLE
 
-    subject.mount_table([['h1'],['r1c1']], :class => 'table').should eql tab
+    expect(subject.mount_table([['h1'],['r1c1']], :class => 'table')).to eql tab
   }
 
   specify {
@@ -70,7 +74,7 @@ describe Footnotes::Notes::AbstractNote do
             <tbody><tr><td>r1c1</td><td>r1c2</td><td>r1c3</td></tr></tbody>
           </table>
           TABLE
-    subject.mount_table([['h1', 'h2', 'h3'],['r1c1', 'r1c2', 'r1c3']]).should eql tab
+    expect(subject.mount_table([['h1', 'h2', 'h3'],['r1c1', 'r1c2', 'r1c3']])).to eql tab
   }
 
   specify {