rails-footnotes 4.1.8 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 21fa093ff6eaf5b53695cfaed61637fa8e4c8187
-  data.tar.gz: 79e79b4486adcd087d948cc6d2d9f4959b6ac2bd
+SHA256:
+  metadata.gz: 67dd876890a76a0d5907902934ec0fd233d143c002a5dc67572f2015f6f3ef0a
+  data.tar.gz: be6c1412e334b99111f4c0e5eb702c79f1e213aa39bc01750478b7c9823d7363
 SHA512:
-  metadata.gz: 0873a5dbe0233b3f87b43748bfe402227116892233b09fb964c2ab692c35dc0a09e6f02f348ba5696b5bb9922b08490afabb04805be9af994a72856420581826
-  data.tar.gz: 1b88bc094b480f831319fa08b8c56fe0ac43356b5ca31ad1d492eee4cbe1bdadd438b05fc46bb22a5232fa1447398dd2a7d64e776177238e24c8f59f2f23c2cc
+  metadata.gz: c752688540b1f643dc25faf90fcdb879ac0477aa463acb423ec24011eb76d3d84160b1a583630d7002699ae181dc083cff17f7e2a6d46bdf75ba52f4416dd270
+  data.tar.gz: a9010b8aead77c935804b045e4b227f04979a6a2b31bd367c90a06d5dcbf96cc31a2c83dd6d868c59824f650213d84bf9e4690bb7bf06d15e389b5fd6489a1c7

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - name: Run tests
+      run: bin/rspec

data/.github/workflows/merge-dependabot.yml

@@ -0,0 +1,33 @@
+name: "Merge updates"
+on:
+  workflow_run:
+    workflows: ["CI"]
+    types: ["completed"]
+    branches: ["dependabot/**"]
+jobs:
+  merge:
+    name: "Merge"
+    runs-on: "ubuntu-latest"
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+    if: >
+      github.event.workflow_run.event == 'pull_request' &&
+      github.event.workflow_run.conclusion == 'success' &&
+      github.actor == 'dependabot[bot]'
+    steps:
+      - name: "Merge pull request"
+        uses: "actions/github-script@v7"
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          script: |
+            const pullRequest = context.payload.workflow_run.pull_requests[0]
+            const repository = context.repo
+
+            await github.rest.pulls.merge({
+              merge_method: "merge",
+              owner: repository.owner,
+              pull_number: pullRequest.number,
+              repo: repository.repo,
+            })

data/.gitignore

@@ -1,16 +1,10 @@
-.*
-!.gitignore
-!.gitmodules
-!.travis.yml
-!*.example
 *.gem
 .bundle
-Gemfile.lock
-pkg/*
-/bin
+.rspec_results
 /coverage
-tags
 /doc
 /myapp
-spec/tmp
+pkg/*
 spec/log
+spec/tmp
+tags

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -1,3 +1,13 @@
 source "https://rubygems.org"
 
 gemspec
+
+ruby file: ".ruby-version"
+
+gem "capybara", "~> 3.35"
+gem "nokogiri", "~> 1.12"
+gem "pry", "~> 0.14.1"
+gem "rake", "~> 13.0"
+gem "rspec-rails", "~> 6.0"
+gem "sprockets-rails", "~> 3.2"
+gem "matrix", "~> 0.4.2"

data/Gemfile.lock

@@ -0,0 +1,217 @@
+PATH
+  remote: .
+  specs:
+    rails-footnotes (7.0.0)
+      rails (~> 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.8)
+      actionpack (= 7.0.8)
+      activesupport (= 7.0.8)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.8)
+      actionpack (= 7.0.8)
+      activejob (= 7.0.8)
+      activerecord (= 7.0.8)
+      activestorage (= 7.0.8)
+      activesupport (= 7.0.8)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.8)
+      actionpack (= 7.0.8)
+      actionview (= 7.0.8)
+      activejob (= 7.0.8)
+      activesupport (= 7.0.8)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.8)
+      actionview (= 7.0.8)
+      activesupport (= 7.0.8)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.8)
+      actionpack (= 7.0.8)
+      activerecord (= 7.0.8)
+      activestorage (= 7.0.8)
+      activesupport (= 7.0.8)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.8)
+      activesupport (= 7.0.8)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.8)
+      activesupport (= 7.0.8)
+      globalid (>= 0.3.6)
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activerecord (7.0.8)
+      activemodel (= 7.0.8)
+      activesupport (= 7.0.8)
+    activestorage (7.0.8)
+      actionpack (= 7.0.8)
+      activejob (= 7.0.8)
+      activerecord (= 7.0.8)
+      activesupport (= 7.0.8)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    builder (3.2.4)
+    capybara (3.39.2)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    date (3.3.4)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    matrix (0.4.2)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    net-imap (0.4.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.6.1)
+    nokogiri (1.15.5-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.5-x86_64-linux)
+      racc (~> 1.4)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.8)
+      actioncable (= 7.0.8)
+      actionmailbox (= 7.0.8)
+      actionmailer (= 7.0.8)
+      actionpack (= 7.0.8)
+      actiontext (= 7.0.8)
+      actionview (= 7.0.8)
+      activejob (= 7.0.8)
+      activemodel (= 7.0.8)
+      activerecord (= 7.0.8)
+      activestorage (= 7.0.8)
+      activesupport (= 7.0.8)
+      bundler (>= 1.15.0)
+      railties (= 7.0.8)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.8)
+      actionpack (= 7.0.8)
+      activesupport (= 7.0.8)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-rails (6.1.0)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.12)
+      rspec-expectations (~> 3.12)
+      rspec-mocks (~> 3.12)
+      rspec-support (~> 3.12)
+    rspec-support (3.12.1)
+    sprockets (4.2.1)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    thor (1.3.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  arm64-darwin-20
+  arm64-darwin-22
+  arm64-darwin-23
+  x86_64-linux
+
+DEPENDENCIES
+  capybara (~> 3.35)
+  matrix (~> 0.4.2)
+  nokogiri (~> 1.12)
+  pry (~> 0.14.1)
+  rails-footnotes!
+  rake (~> 13.0)
+  rspec-rails (~> 6.0)
+  sprockets-rails (~> 3.2)
+
+RUBY VERSION
+   ruby 3.2.2p53
+
+BUNDLED WITH
+   2.4.22

data/README.rdoc

@@ -1,6 +1,4 @@
-= Rails Footnotes
-
-{<img src="https://travis-ci.org/josevalim/rails-footnotes.png" />}[https://travis-ci.org/josevalim/rails-footnotes]
+= Rails 7 Footnotes
 
 Rails footnotes displays footnotes in your application for easy debugging, such as sessions,
 request parameters, cookies, filter chain, routes, queries, etc.
@@ -10,17 +8,11 @@ your backtrace lines.
 
 == Installation
 
-NOTE: Since this branch aims for 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
-
-Installing Rails Footnotes is very easy.
+Add to your `Gemfile`:
 
-=== Rails 3.2.x/4.x
+    gem "rails-footnotes", "~> 5.0"
 
-    gem 'rails-footnotes', '~> 4.0'
-
-After you install RailsFootnotes and add it to your Gemfile, you need to run the generator:
+Run `bundle install`, then the generator:
 
   rails generate rails_footnotes:install
 
@@ -37,7 +29,7 @@ This will create an initializer with default config and some examples.
 
 === Editor links
 
-Textmate, MacVim and Sublime Text 2 are compatible.
+Textmate, MacVim and Sublime Text 3 are compatible.
 
 *MacVim*
 
@@ -52,17 +44,11 @@ the second %d is replaced by the column number.
 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, <tt>f.prefix = 'txmt://open?url=file://%s&line=%d&column=%d'</tt>
+*Sublime* *Text* *3*
 
-2. Install {subl-handler}[https://github.com/asuth/subl-handler]
+Install {subl}[https://github.com/dhoulb/subl], then use:
 
-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.
-
-4. Install {RCDefault}[http://www.rubicode.com/Software/RCDefaultApp]. It's OSX 10.2, but it works.
-
-5. Go to RCDefaultApp (OS System Preferences > DefaultApps). Go to URL section, select "tmxt" extension, and set default applicaiton to "SublHandler".
+    f.prefix = 'subl://open?url=file://%s&line=%d&column=%d'
 
 *Use* *with* *Vagrant* (*and* *other* *virtual* *machines*)
 
@@ -156,39 +142,7 @@ If you'd like the footnote, to be at a different place (perhaps for aesthetical
   <div id="footnotes_holder"></div>
 at an appropriate place, your notes will now appear inside div#footnotes_holder
 
-== Collaborators
-
-* Leon Li       - http://github.com/scorpio
-* Keenan Brock  - http://github.com/kbrock
-* Ivan Storck   - http://github.com/ivanoats
-* Kris Chamber  - http://github.com/kristopher
-* Roman V. Babenko - http://github.com/romanvbabenko
-* Adrien Siami  - http://github.com/intrepidd
-
 == Bugs and Feedback
 
 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 4.0 by Roman V. Babenko
-
-Copyright (c) 2010-2014 Roman V. Babenko (romanvbabenko@gmail.com)
-http://romanvbabenko.com
-
-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
-
-=== 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/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/extension.rb

@@ -2,31 +2,23 @@ require 'active_support/concern'
 
 module Footnotes
   module RailsFootnotesExtension
-
     extend ActiveSupport::Concern
 
     included do
-      if Rails::VERSION::MAJOR >= 5
-        prepend_before_action :rails_footnotes_before_filter
-        after_action :rails_footnotes_after_filter
-      else
-        prepend_before_filter :rails_footnotes_before_filter
-        after_filter :rails_footnotes_after_filter
-      end
+      prepend_before_action :rails_footnotes_before_filter
+      after_action :rails_footnotes_after_filter
     end
 
     def rails_footnotes_before_filter
-      if Footnotes.enabled?(self)
-        Footnotes::Filter.start!(self)
-      end
+      Footnotes::Filter.start!(self) if Footnotes.enabled?(self)
     end
 
     def rails_footnotes_after_filter
-      if Footnotes.enabled?(self)
-        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;}

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/controller_note.rb

@@ -14,7 +14,7 @@ module Footnotes
       end
 
       def valid?
-        prefix? && controller_filename && File.exists?(controller_filename)
+        prefix? && controller_filename && File.exist?(controller_filename)
       end
 
       protected

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

@@ -24,14 +24,15 @@ module Footnotes
 
       protected
         def scan_text(text)
-          []
+          raise NotImplementedError, "implement this in your subclass"
         end
 
         def parse_files!
-          asset_paths = Rails.application.config.assets.paths
+          asset_paths = Rails.application.config.try(:assets).try(:paths) || []
           linked_files = []
 
           @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) + '*']

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>
@@ -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

@@ -27,13 +27,14 @@ module Footnotes
       end
 
       def valid?
-        prefix? && filename && File.exists?(filename)
+        prefix? && filename && File.exist?(filename)
       end
 
       protected
 
         def filename
-          @filename ||= self.class.template[:file]
+          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.8"
+  VERSION = "7.0.0"
 end

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
@@ -67,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/rails-footnotes.gemspec

@@ -6,22 +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", '~> 3.3.2'
-  s.add_development_dependency "sprockets-rails", '~> 2.0'
-  s.add_development_dependency "capybara"
+  s.add_dependency "rails", "~> 7.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/renovate.json

@@ -0,0 +1,5 @@
+{
+  "ruby-version": {
+    "enabled": true
+  }
+}

data/spec/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/app/views/files/index.html.erb

@@ -0,0 +1 @@
+FILES INDEX

data/spec/controllers/files_note_controller_spec.rb

@@ -1,10 +1,9 @@
 require 'spec_helper'
 
 class FilesController < ApplicationController
-
-    def index
-    end
+  def index
   end
+end
 
 describe FilesController, type: :controller do
   render_views
@@ -19,6 +18,7 @@ describe FilesController, type: :controller do
 
   it 'includes stylesheets assets in the response' do
     get :index
+    expect(response.body).to include("FILES INDEX")
     js_debug = first('fieldset#javascripts_debug_info div', visible: false)
     expect(js_debug).to have_selector('li a', visible: false, count: 1)
     expect(js_debug).to have_selector('li a', text: /foobar\.js/, visible: false)

data/spec/controllers/footnotes_controller_spec.rb

@@ -3,15 +3,15 @@ require 'spec_helper'
 class FootnotesController < ActionController::Base
 
   def foo
-    render :text => HTML_DOCUMENT, :content_type => 'text/html'
+    render inline: HTML_DOCUMENT, content_type: 'text/html'
   end
 
   def foo_holder
-    render :text => '<html><body><div id="footnotes_holder"></div></body></html>'
+    render inline: '<html><body><div id="footnotes_holder"></div></body></html>'
   end
 
   def foo_js
-    render :text => '<script></script>', :content_type => 'text/javascript'
+    render inline: '<script></script>', content_type: 'text/javascript'
   end
 
   def foo_download
@@ -75,7 +75,7 @@ describe FootnotesController, type: :controller do
     describe 'when request is xhr' do
       include_context 'has_no_footnotes'
       before do
-        xhr :get, :foo
+        get :foo, xhr: true
       end
     end
 

data/spec/controllers/log_note_controller_spec.rb

@@ -10,7 +10,7 @@ describe 'log note', type: :controller do
     def index
       Rails.logger.error 'foo'
       Rails.logger.warn 'bar'
-      render :text => '<html><head></head><body></body></html>', :content_type => 'text/html'
+      render inline: '<html><head></head><body></body></html>', content_type: 'text/html'
     end
   end
 

data/spec/env_note_spec.rb

@@ -9,11 +9,11 @@ end
 describe Footnotes::Notes::EnvNote do
   let(:controller) {
     FootnotesEnvController.new.tap { |c|
-      c.template = Object.new
-      c.request = ActionController::TestRequest.new
-      c.response = ActionController::TestResponse.new
+      c.template      = Object.new
+      c.request       = ActionDispatch::TestRequest.create
+      c.response      = ActionDispatch::TestResponse.new
       c.response_body = %Q(<html><body></body></html>)
-      c.params = {}
+      c.params        = {}
     }
   }
 

data/spec/footnotes_spec.rb

@@ -30,8 +30,8 @@ describe "Footnotes" do
   before do
     @controller = FootnotesController.new
     @controller.template = Object.new
-    @controller.request = ActionController::TestRequest.new
-    @controller.response = ActionController::TestResponse.new
+    @controller.request = ActionDispatch::TestRequest.create
+    @controller.response = ActionDispatch::TestResponse.new
     @controller.response_body = HTML_DOCUMENT.dup
     @controller.params = {}
 
@@ -48,6 +48,7 @@ describe "Footnotes" do
   context "response_body is file" do
     before do
       @file = Tempfile.new("test")
+      def @file.body; read; end
       @file.write "foobarbaz"
       @file.rewind
     end
@@ -89,7 +90,7 @@ describe "Footnotes" do
   end
 
   specify "footnotes_included_when_content_type_is_html" do
-    @controller.response.content_type = 'text/html'
+    @controller.response.content_type = 'text/html; charset=utf-8'
     footnotes_perform!
     expect(@controller.response.body).not_to eql HTML_DOCUMENT
   end

data/spec/notes/assigns_note_spec.rb

@@ -25,7 +25,7 @@ describe Footnotes::Notes::AssignsNote do
   specify {expect(note.send(:to_table)).to eql [
     ["Name", "Value"],
     ["<strong>@action_has_layout</strong><br /><em>TrueClass</em>", "true"],
-    ["<strong>@status</strong><br /><em>Fixnum</em>", "200"]
+    ["<strong>@status</strong><br /><em>Integer</em>", "200"]
   ]}
 
   describe "Ignored Assigns" do
@@ -43,7 +43,7 @@ describe Footnotes::Notes::AssignsNote do
       [
         ["Name", "Value"],
         ["<strong>@action_has_layout</strong><br /><em>TrueClass</em>", "true"],
-        ["<strong>@status</strong><br /><em>Fixnum</em>", "200"]
+        ["<strong>@status</strong><br /><em>Integer</em>", "200"]
       ], {:summary=>"Debug information for Assigns (2)"})
     note.content
   end

data/spec/notes/files_note_spec.rb

@@ -2,10 +2,16 @@ require 'spec_helper'
 require 'action_controller'
 require "rails-footnotes/notes/files_note"
 
+class ConcreteFilesNote < Footnotes::Notes::FilesNote
+  def scan_text(text)
+    []
+  end
+end
+
 describe Footnotes::Notes::FilesNote do
 
   let(:note) do
-    Footnotes::Notes::FilesNote.new(double('controller', :response => double('', :body => '')))
+    ConcreteFilesNote.new(double('controller', :response => double('', :body => '')))
   end
 
   subject { note }

data/spec/notes/view_note_spec.rb

@@ -2,11 +2,17 @@ require "spec_helper"
 require "rails-footnotes/notes/view_note"
 
 describe Footnotes::Notes::ViewNote do
-
   it "should not be valid if view file not exist" do
     note = Footnotes::Notes::ViewNote.new(double)
     allow(note).to receive(:filename).and_return(nil)
 
     expect(note).not_to be_valid
   end
+
+  it "should not explode if template is nil" do
+    Footnotes::Notes::ViewNote.template = nil
+
+    note = Footnotes::Notes::ViewNote.new(double)
+    expect(note).to_not be_valid
+  end
 end

data/spec/spec_helper.rb

@@ -35,6 +35,7 @@ RSpec.configure do |config|
 
   config.include Capybara::DSL
   config.include Helpers
+  config.example_status_persistence_file_path = ".rspec_results"
 
   Rails.application.routes.draw do
     get 'footnotes/foo'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-footnotes
 version: !ruby/object:Gem::Version
-  version: 4.1.8
+  version: 7.0.0
 platform: ruby
 authors:
 - Roman V. Babenko
@@ -9,83 +9,48 @@ authors:
 - Keenan Brock
 - Duane Johnson
 - Adrien Siami
-autorequire: 
+- André Arko
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.3.2
-- !ruby/object:Gem::Dependency
-  name: sprockets-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '7.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 description: Every Rails page has footnotes that gives information about your application
   and links back to your editor.
 email:
-- romanvbabenko@gmail.com
+- andre@arko.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/merge-dependabot.yml"
 - ".gitignore"
 - ".rspec.example"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG
 - Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
+- bin/rake
+- bin/rspec
 - gemfiles/Gemfile.rails-3.2.22
 - gemfiles/Gemfile.rails-4.0.x
 - gemfiles/Gemfile.rails-4.1.x
@@ -118,7 +83,9 @@ files:
 - lib/rails-footnotes/notes/view_note.rb
 - lib/rails-footnotes/version.rb
 - rails-footnotes.gemspec
+- renovate.json
 - spec/abstract_note_spec.rb
+- spec/app/assets/config/manifest.js
 - spec/app/assets/javascripts/foobar.js
 - spec/app/assets/stylesheets/foobar.css
 - spec/app/views/files/index.html.erb
@@ -139,10 +106,10 @@ files:
 - spec/notes/stylesheets_note_spec.rb
 - spec/notes/view_note_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/josevalim/rails-footnotes
+homepage: http://github.com/indirect/rails-footnotes
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,21 +117,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: rails-footnotes
-rubygems_version: 2.5.0
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Every Rails page has footnotes that gives information about your application
   and links back to your editor.
 test_files:
 - spec/abstract_note_spec.rb
+- spec/app/assets/config/manifest.js
 - spec/app/assets/javascripts/foobar.js
 - spec/app/assets/stylesheets/foobar.css
 - spec/app/views/files/index.html.erb

data/.travis.yml

@@ -1,25 +0,0 @@
-cache: bundler
-sudo: false
-script: "bundle exec rake"
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.7
-  - 2.2.3
-gemfile:
-  - gemfiles/Gemfile.rails-3.2.22
-  - gemfiles/Gemfile.rails-4.0.x
-  - gemfiles/Gemfile.rails-4.1.x
-  - gemfiles/Gemfile.rails-4.2.x
-  - gemfiles/Gemfile.rails-edge
-matrix:
-  allow_failures:
-    - gemfile: gemfiles/Gemfile.rails-edge
-    - gemfile: gemfiles/Gemfile.rails-3.2.22
-  exclude:
-    - rvm: 1.9.3
-      gemfile: gemfiles/Gemfile.rails-edge
-    - rvm: 2.0.0
-      gemfile: gemfiles/Gemfile.rails-edge
-    - rvm: 2.1.7
-      gemfile: gemfiles/Gemfile.rails-edge