rails6-footnotes 5.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4cf3f2077c5570d6fc08f382591a4fd040dc62dd347a60929cf0064da1ce61c4
+  data.tar.gz: '0289cdc75a52af389ec658fc3073fb8c4a6112277297e24568ca29c1b9ccfc38'
+SHA512:
+  metadata.gz: bfbf16034f96a3ccb75212285d971b7eb0080440bd5029492bef9fb03f83ea8ac34deadb92052af7b6a6adbd5138576cb1c223f0b321551203958c8639d3d18d
+  data.tar.gz: 0e4e15e81e5c89169f21b65d1c2dba0ca89992b2b9d7ac01cd77db591e2939a6cefb417b4ebc3a573d4b7e8a0630e2b17f19a04017b03f62732fbab7489f0203

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bin/rspec

data/.gitignore

@@ -0,0 +1,15 @@
+.*
+!.github
+!.gitignore
+!.gitmodules
+!*.example
+*.gem
+.bundle
+.rspec_results
+pkg/*
+/coverage
+tags
+/doc
+/myapp
+spec/tmp
+spec/log

data/.rspec.example

@@ -0,0 +1 @@
+--color

data/CHANGELOG

@@ -0,0 +1,129 @@
+== Footnotes v4.1.8 ==
+  * Fix the issue of undefined method using Log4r and Rails 3.2
+  * Fix some rails 5 compatibility issues (#140) *
+  * Fix bad timing shown in SQL note (#145) *
+== Footnotes v4.1.7 ==
+  * Fix notes not collapsing when clicking on them again (#130)*
+== Footnotes v4.1.6 ==
+  * Fix incorrect handler link to css/js files (#127)*
+== Footnotes v4.1.5 ==
+  * Remove use of non-existing note in initializer introduced in v4, impacting new installations *
+== Footnotes v4.1.4 ==
+  * Allow to click on links if filenames contain special chars
+== Footnotes v4.1.3 ==
+  * Improve fix done in 4.1.2 that broke support with rails 3 (thanks kirikiriyamama)
+== Footnotes v4.1.2 ==
+  * Fix errors when some log formatters return nil
+== Footnotes v4.1.1 ==
+  * Fix uninitialized constant with Log4r and probably other libraries using the Logger module ( Thanks Brian Tatnall )
+== Footnotes v4.1.0 ==
+  * Allow footnotes url prefix to be a lambda ( Thanks Jamie Lawrence )
+  * Sexier assigns note ( Thanks Joshua Paling )
+  * Fix issues with environment keys not being the same type causing some gems to break ( Thanks Austin Ziegler )
+
+== Footnotes v4.0.2
+  * Fix bad display of footnotes table
+  * Fix error with the queries note under Rails 4.1.2 (thanks Panayotis Matsinopoulos)
+== Footnotes v4.0.1
+  * Fix bad count for log note
+  * More robust initializer (thanks kayhide)
+  * Ability to lock the notes on the top right instead of the footer (thanks joshuapaling)
+  * More readable notes (thanks joshuapaling)
+== 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
+
+== Footnotes v3.6.7
+  * fixed log_note error - long overdue (thanks to many including Moritz Heidkamp)
+  * 1.9: ignore more assigns (thanks to justin case)
+  * 1.9 fixed test mocking (thanks to lsylvester)
+  * sort notes includes (thanks Alexey Smolianiov)
+  * handle controller paths in gems / others (thanks ubilabs)
+  * more graceful fallback when controller not found
+  * fixes for table entries being double encoded
+  * moved rpm exclude sql explain logic to config option
+
+== Footnotes v3.6.6
+  * fix for ruby 1.9 compat (thanks to ivanoats)
+  * fix for log note (thanks to tobias)
+  * pre rails 2.3 support fixes (thanks to tobias)
+  * better disabling of query notes (thanks to tobias)
+  * fixed variable assignment escaping (thanks to gdelvino)
+  * fixed cookie value escaping (thanks to indirect)
+  * Turn off footnotes with a parameter footnotes=false (thanks to indirect)
+
+== Footnotes v3.6
+  * Cookies, sessions and params notes now use table;
+  * Old components note removed;
+  * Added assigns notes (thanks to scorpio);
+  * Improve query note, count query time and display it with several configurable
+    options (:alert_db_time and :alert_sql_number) (thanks to scorpio);
+  * Fixed bugs of layout link and route note related (thanks to scorpio).
+
+== Footnotes v3.5
+  * Added NewRelic RPM footnote (thanks to kbrock);
+  * Several bug fixes (thanks to kbrock, ivanoats and kristopher).
+
+== Footnotes v3.4
+  * Rails 2.3 compatible.
+
+== Footnotes v3.3.1
+  * Changed prefix to support %s and %d;
+  * Created gemspec;
+  * Some code refactoring (called eval just once instead of three times).
+
+== Footnotes v3.3
+  * Rails Edge (aka 2.2) compatibility;
+  * Initial Ruby 1.9 compatibility.
+
+== Footnotes v3.2.2
+  * Added trace to QueriesNote;
+  * Fixed incompatibility with Ultrasphinx (thanks to mhartl);
+  * Added W3C compatibility (thanks to tapajos);
+  * Added support to other log mechanisms in LogNote.
+
+== Footnotes v3.2.1
+  * Added some tests;
+  * Redefined Footnotes CSS and Javascripts to use concise names.
+
+== Footnotes v3.2
+  * Now you can easily add your own notes;
+  * Added numbers to tabs;
+  * Added Queries note;
+  * Added MySQL Query Analyzer.
+
+== Footnotes v3.1
+  * Code refactoring (using modules, except backtracer);
+  * Ability to cherry pick notes;
+  * Working on Rails 2.1.
+
+== Footnotes v3.0
+  * Some code refactoring;
+  * Stylesheets bug fixed: was showing not only css in Stylesheets div;
+  * Logtail fix: working with Rails 2.0 logger and in all OS, since it's Regexp based;
+  * Rails 1.2 (except backtrace) and 2.0 compatible;
+  * RoutingNavigator (based on Rick Olson plugin);
+  * FilterChain.
+
+== Textmate Footnotes v2.0
+Copyright (c) 2006 InquiryLabs, Inc.
+http://inquirylabs.com/
+
+Description:
+  Creates clickable footnotes on each rendered page, as well as clickable
+  links in the backtrace should an error occur in your Rails app. Links take
+  you to the right place inside TextMate.
+  Enable only the TextMate on Macs in development mode

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "capybara", "~> 3.35"
+gem "nokogiri", "~> 1.12"
+gem "pry", "~> 0.14.1"
+gem "rake", "~> 13.0"
+gem "rspec-rails", "~> 5.0"
+gem "sprockets-rails", "~> 3.2"

data/Gemfile.lock

@@ -0,0 +1,187 @@
+PATH
+  remote: .
+  specs:
+    rails6-footnotes (5.0.0)
+      rails (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4)
+      actionpack (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activesupport (= 6.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4)
+      actionview (= 6.1.4)
+      activesupport (= 6.1.4)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4)
+      actionpack (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4)
+      activesupport (= 6.1.4)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activestorage (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activesupport (= 6.1.4)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    builder (3.2.4)
+    capybara (3.35.3)
+      addressable
+      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.1.9)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mini_mime (1.1.0)
+    minitest (5.14.4)
+    nio4r (2.5.8)
+    nokogiri (1.12.3-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.12.3-x86_64-linux)
+      racc (~> 1.4)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4)
+      actioncable (= 6.1.4)
+      actionmailbox (= 6.1.4)
+      actionmailer (= 6.1.4)
+      actionpack (= 6.1.4)
+      actiontext (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activemodel (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.1)
+      loofah (~> 2.3)
+    railties (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  capybara (~> 3.35)
+  nokogiri (~> 1.12)
+  pry (~> 0.14.1)
+  rails6-footnotes!
+  rake (~> 13.0)
+  rspec-rails (~> 5.0)
+  sprockets-rails (~> 3.2)
+
+BUNDLED WITH
+   2.2.23

data/MIT-LICENSE

@@ -0,0 +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.

data/README.rdoc

@@ -0,0 +1,188 @@
+= Rails Footnotes
+
+{<img src="https://travis-ci.org/Intrepidd/rails-footnotes.svg?branch=master" />}[https://travis-ci.org/Intrepidd/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
+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.
+
+=== Rails 3.2.x/4.x
+
+    gem 'rails-footnotes', '~> 4.0'
+
+After you install RailsFootnotes and add it to your Gemfile, you need to run the generator:
+
+  rails generate rails_footnotes:install
+
+This will create an initializer with default config and some examples.
+
+=== Hooks
+
+    Footnotes.setup do |config|
+      config.before {|controller, filter| filter.notes = controller.class.name =~ /Message/ && \
+        controller.action_name == 'index' ? [:assigns] : []}
+      config.before {|controller, filter| filter.notes |= [:params] if controller.class.name =~ /Profile/ && \
+        controller.action_name == 'edit' }
+    end
+
+=== Editor links
+
+Textmate, MacVim and Sublime Text 3 are compatible.
+
+*MacVim*
+
+In the rails-footnotes initializer do :
+
+    f.prefix = 'mvim://open?url=file://%s&line=%d&column=%d'
+
+Here you need 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 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* *3*
+
+Install {subl}[https://github.com/dhoulb/subl], then use:
+
+    f.prefix = 'subl://open?url=file://%s&line=%d&column=%d'
+
+*Use* *with* *Vagrant* (*and* *other* *virtual* *machines*)
+
+If you're running your app in Vagrant, you'll find that the edit links won't work because the paths point to the Vagrant directory not your native directory. To solve this, you can use a lambda for the prefix and modify the pathname accordingly.
+
+For example,
+
+    f.prefix = ->(*args) do
+      filename = args[0].sub '/vagrant', '/Users/jamie/projects/myproject'
+      "subl://open?url=file://#{filename}&line=#{args[1]}&column=#{args[2]}"
+    end
+
+replaces the vm directory /vagrant with OS X directory where the code is being edited.
+
+*Footnotes* *Display* *Options*
+
+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:
+
+    f.no_style = true
+
+You can also lock the footnotes to the top of the window, hidden by default, and accessible
+via a small button fixed to the top-right of your browser:
+
+    f.lock_top_right = true
+
+To set the font-size for the footnotes:
+
+    f.font_size = '13px'
+
+Another option is to allow multiple notes to be opened at the same time:
+
+    f.multiple_notes = true
+
+Finally, you can control which notes you want to show. The default are:
+
+    f.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log]
+
+Setting <tt>f.notes = []</tt> will show none of the available notes, although the supporting CSS and JavaScript will still be included. To completely disable all rails-footnotes content on a page, include <tt>params[:footnotes] = 'false'</tt> in the request.
+
+== Creating your own notes
+
+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[link:lib/rails-footnotes/abstract_note.rb] file in lib/rails-footnotes)
+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:
+
+  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
+
+        # Returns the title that represents this note.
+        #
+        def title
+          "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, add in your initializer:
+
+  f.notes += [:current_user]
+
+== Footnote position
+
+By default the notes will be showed at the bottom of your page (appended just before </body>).
+If you'd like the footnote, to be at a different place (perhaps for aesthetical reasons) you can edit one of your views and add:
+  <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