RubyGems - rails6-footnotes - Versions diffs - 5.0.0 - Mend

rails6-footnotes 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (68) hide show

checksums.yaml +7 -0
data/.github/workflows/ci.yml +25 -0
data/.gitignore +15 -0
data/.rspec.example +1 -0
data/CHANGELOG +129 -0
data/Gemfile +10 -0
data/Gemfile.lock +187 -0
data/MIT-LICENSE +21 -0
data/README.rdoc +188 -0
data/Rakefile +18 -0
data/bin/rake +29 -0
data/bin/rspec +29 -0
data/gemfiles/Gemfile.rails-3.2.22 +5 -0
data/gemfiles/Gemfile.rails-4.0.x +6 -0
data/gemfiles/Gemfile.rails-4.1.x +5 -0
data/gemfiles/Gemfile.rails-4.2.x +5 -0
data/gemfiles/Gemfile.rails-edge +5 -0
data/lib/generators/rails_footnotes/install_generator.rb +14 -0
data/lib/generators/templates/rails_footnotes.rb +26 -0
data/lib/rails-footnotes.rb +68 -0
data/lib/rails-footnotes/abstract_note.rb +178 -0
data/lib/rails-footnotes/each_with_rescue.rb +36 -0
data/lib/rails-footnotes/extension.rb +24 -0
data/lib/rails-footnotes/filter.rb +359 -0
data/lib/rails-footnotes/notes/all.rb +1 -0
data/lib/rails-footnotes/notes/assigns_note.rb +60 -0
data/lib/rails-footnotes/notes/controller_note.rb +55 -0
data/lib/rails-footnotes/notes/cookies_note.rb +17 -0
data/lib/rails-footnotes/notes/env_note.rb +24 -0
data/lib/rails-footnotes/notes/files_note.rb +49 -0
data/lib/rails-footnotes/notes/filters_note.rb +51 -0
data/lib/rails-footnotes/notes/javascripts_note.rb +16 -0
data/lib/rails-footnotes/notes/layout_note.rb +26 -0
data/lib/rails-footnotes/notes/log_note.rb +47 -0
data/lib/rails-footnotes/notes/log_note/note_logger.rb +59 -0
data/lib/rails-footnotes/notes/params_note.rb +21 -0
data/lib/rails-footnotes/notes/partials_note.rb +38 -0
data/lib/rails-footnotes/notes/queries_note.rb +121 -0
data/lib/rails-footnotes/notes/routes_note.rb +60 -0
data/lib/rails-footnotes/notes/session_note.rb +27 -0
data/lib/rails-footnotes/notes/stylesheets_note.rb +16 -0
data/lib/rails-footnotes/notes/view_note.rb +41 -0
data/lib/rails-footnotes/version.rb +3 -0
data/lib/rails6-footnotes.rb +1 -0
data/rails-footnotes.gemspec +22 -0
data/spec/abstract_note_spec.rb +89 -0
data/spec/app/assets/config/manifest.js +2 -0
data/spec/app/assets/javascripts/foobar.js +1 -0
data/spec/app/assets/stylesheets/foobar.css +0 -0
data/spec/app/views/files/index.html.erb +1 -0
data/spec/app/views/layouts/application.html.erb +12 -0
data/spec/app/views/partials/_foo.html.erb +1 -0
data/spec/app/views/partials/index.html.erb +1 -0
data/spec/controllers/files_note_controller_spec.rb +38 -0
data/spec/controllers/footnotes_controller_spec.rb +128 -0
data/spec/controllers/log_note_controller_spec.rb +32 -0
data/spec/controllers/partials_note_controller_spec.rb +28 -0
data/spec/env_note_spec.rb +73 -0
data/spec/fixtures/html_download.html +5 -0
data/spec/footnotes_spec.rb +234 -0
data/spec/notes/assigns_note_spec.rb +50 -0
data/spec/notes/controller_note_spec.rb +12 -0
data/spec/notes/files_note_spec.rb +26 -0
data/spec/notes/javascripts_note_spec.rb +18 -0
data/spec/notes/stylesheets_note_spec.rb +19 -0
data/spec/notes/view_note_spec.rb +12 -0
data/spec/spec_helper.rb +68 -0
metadata +153 -0

data/spec/controllers/log_note_controller_spec.rb ADDED Viewed

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'stringio'
+describe 'log note', type: :controller do
+  class ApplicationController < ActionController::Base
+  end
+  controller do
+    def index
+      Rails.logger.error 'foo'
+      Rails.logger.warn 'bar'
+      render inline: '<html><head></head><body></body></html>', content_type: 'text/html'
+    end
+  end
+  before :all do
+    Footnotes.enabled = true
+  end
+  after :all do
+    Footnotes.enabled = false
+  end
+  it 'Includes the log in the response' do
+    get :index
+    log_debug = first('fieldset#log_debug_info div', :visible => false)
+    expect(log_debug).to have_content('foo')
+    expect(log_debug).to have_content('bar')
+  end
+end

data/spec/controllers/partials_note_controller_spec.rb ADDED Viewed

@@ -0,0 +1,28 @@
+require 'spec_helper'
+class PartialsController < ActionController::Base
+  def index
+  end
+end
+describe PartialsController, type: :controller do
+  render_views
+  before :all do
+    Footnotes.enabled = true
+  end
+  after :all do
+    Footnotes.enabled = false
+  end
+  it 'lists the rendered partials' do
+    get :index
+    expect(response.body).to have_selector('#footnotes_debug #partials_debug_info table tr', :visible => false, :count => 2)
+  end
+end

data/spec/env_note_spec.rb ADDED Viewed

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'action_controller'
+require 'action_controller/test_case'
+class FootnotesEnvController < ActionController::Base
+  attr_accessor :template, :performed_render
+end
+describe Footnotes::Notes::EnvNote do
+  let(:controller) {
+    FootnotesEnvController.new.tap { |c|
+      c.template      = Object.new
+      c.request       = ActionDispatch::TestRequest.create
+      c.response      = ActionDispatch::TestResponse.new
+      c.response_body = %Q(<html><body></body></html>)
+      c.params        = {}
+    }
+  }
+  subject { described_class.new(controller) }
+  before do
+    @notes = Footnotes::Filter.notes
+    Footnotes::Filter.notes = [ :env ]
+  end
+  after do
+    Footnotes::Filter.notes = @notes
+  end
+  it '#to_sym is :env' do
+    expect(subject.to_sym).to eq(:env)
+  end
+  context 'with non-spec env keys' do
+    before :each do
+      controller.request.env.replace(:non_spec => 'symbol_env')
+    end
+    it 'does not raise an exception' do
+      expect { subject.content }.not_to raise_error
+    end
+    it 'includes the environment row' do
+      expect(subject).to receive(:mount_table).
+        with([ [ :key, 'value' ], [ 'non_spec', 'symbol_env' ] ])
+      subject.content
+    end
+  end
+  it 'includes values for all of the keys except HTTP_COOKIE' do
+    env = controller.request.env.dup
+    env.delete('HTTP_COOKIE')
+    env_data = env.map { |k, v| [ k.to_s, subject.escape(v.to_s) ] }.
+      sort.
+      unshift([ :key, 'value' ])
+    expect(subject).to receive(:mount_table).with(env_data)
+    subject.content
+  end
+  it 'gets a link for HTTP_COOKIE' do
+    controller.request.env.replace('HTTP_COOKIE' => 'foo')
+    expect(subject).to receive(:mount_table).
+      with([
+        [ :key, 'value' ],
+        [ 'HTTP_COOKIE',
+          '<a href="#" style="color:#009" onclick="Footnotes.hideAllAndToggle(\'cookies_debug_info\');return false;">See cookies on its tab</a>' ]
+    ])
+    subject.content
+  end
+end

data/spec/fixtures/html_download.html ADDED Viewed

@@ -0,0 +1,5 @@
+<html>
+<body>
+  <p>Hello world</p>
+</body>
+</html>

data/spec/footnotes_spec.rb ADDED Viewed

@@ -0,0 +1,234 @@
+# encoding: utf-8
+require "spec_helper"
+require 'action_controller'
+require 'action_controller/test_case'
+require "tempfile"
+class FootnotesController < ActionController::Base
+  attr_accessor :template, :performed_render
+end
+module Footnotes::Notes
+  class TestNote < AbstractNote
+    def self.to_sym; :test; end
+    def valid?; true; end
+  end
+  class NoteXNote < TestNote; end
+  class NoteYNote < TestNote; end
+  class NoteZNote < TestNote; end
+  class FileURINote < TestNote
+    def link
+      "/example/local file path/with-special-chars/öäü/file"
+    end
+  end
+end
+describe "Footnotes" do
+  before do
+    @controller = FootnotesController.new
+    @controller.template = Object.new
+    @controller.request = ActionDispatch::TestRequest.create
+    @controller.response = ActionDispatch::TestResponse.new
+    @controller.response_body = HTML_DOCUMENT.dup
+    @controller.params = {}
+    Footnotes::Filter.notes = [ :test ]
+    Footnotes::Filter.multiple_notes = false
+    @footnotes = Footnotes::Filter.new(@controller)
+  end
+  it "footnotes_controller" do
+    index = @controller.response.body.index(/This is the HTML page/)
+    expect(index).to eql 334
+  end
+  context "response_body is file" do
+    before do
+      @file = Tempfile.new("test")
+      def @file.body; read; end
+      @file.write "foobarbaz"
+      @file.rewind
+    end
+    after do
+      @file.close!
+    end
+    it "should not change file position" do
+      @controller.response_body = @file
+      expect {
+        @footnotes = Footnotes::Filter.new(@controller)
+      }.not_to change{ @controller.response_body.pos }
+    end
+  end
+  it "foonotes_included" do
+    footnotes_perform!
+    expect(@controller.response_body).not_to eq(HTML_DOCUMENT)
+  end
+  it "should escape links with special chars" do
+    note_with_link = Footnotes::Notes::FileURINote.new
+    link = Footnotes::Filter.prefix(note_with_link.link, 1, 1, 1)
+    expect(link).to eql "txmt://open?url=file:///example/local%20file%20path/with-special-chars/%C3%B6%C3%A4%C3%BC/file&amp;line=1&amp;column=1"
+  end
+  specify "footnotes_not_included_when_request_is_xhr" do
+    @controller.request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
+    @controller.request.env['HTTP_ACCEPT'] = 'text/javascript, text/html, application/xml, text/xml, */*'
+    footnotes_perform!
+    expect(@controller.response.body).to eql HTML_DOCUMENT
+  end
+  specify "footnotes_not_included_when_content_type_is_javascript" do
+    @controller.response.content_type = 'text/javascript'
+    footnotes_perform!
+    expect(@controller.response.body).to eql HTML_DOCUMENT
+  end
+  specify "footnotes_included_when_content_type_is_html" do
+    @controller.response.content_type = 'text/html; charset=utf-8'
+    footnotes_perform!
+    expect(@controller.response.body).not_to eql HTML_DOCUMENT
+  end
+  specify "footnotes_included_when_content_type_is_nil" do
+    footnotes_perform!
+    expect(@controller.response.body).not_to eql HTML_DOCUMENT
+  end
+  specify "not_included_when_body_is_not_a_string" do
+    allow(@controller.response).to receive(:body).and_return(Time.now)# = Proc.new { Time.now }
+    expect(Footnotes::Filter.new(@controller).send(:valid?)).not_to be
+    expect(@controller.response.body).not_to match(/<!-- Footnotes/)
+  end
+  specify "notes_are_initialized" do
+    footnotes_perform!
+    test_note = @footnotes.instance_variable_get('@notes').first
+    expect(test_note.class.name).to eql 'Footnotes::Notes::TestNote'
+    expect(test_note.to_sym).to eql :test
+  end
+  specify "notes_links" do
+    note = Footnotes::Notes::TestNote.new
+    expect(note).to receive(:row).twice
+    @footnotes.instance_variable_set(:@notes, [note])
+    footnotes_perform!
+  end
+  specify "notes_fieldset" do
+    note = Footnotes::Notes::TestNote.new
+    expect(note).to receive(:has_fieldset?).exactly(3).times
+    @footnotes.instance_variable_set(:@notes, [note])
+    footnotes_perform!
+  end
+  specify "multiple_notes" do
+    Footnotes::Filter.multiple_notes = true
+    note = Footnotes::Notes::TestNote.new
+    expect(note).to receive(:has_fieldset?).twice
+    @footnotes.instance_variable_set(:@notes, [note])
+    footnotes_perform!
+  end
+  specify "notes_are_reset" do
+    note = Footnotes::Notes::TestNote.new
+    expect(note.class).to receive(:close!)
+    @footnotes.instance_variable_set(:@notes, [note])
+    @footnotes.send(:close!, @controller)
+  end
+  specify "links_helper" do
+    note = Footnotes::Notes::TestNote.new
+    expect(@footnotes.send(:link_helper, note)).to eql '<a href="#" onclick="">Test</a>'
+    expect(note).to receive(:link).once.and_return(:link)
+    expect(@footnotes.send(:link_helper, note)).to eql '<a href="link" onclick="">Test</a>'
+  end
+  specify "links_helper_has_fieldset?" do
+    note = Footnotes::Notes::TestNote.new
+    expect(note).to receive(:has_fieldset?).once.and_return(true)
+    expect(@footnotes.send(:link_helper, note)).to eql '<a href="#" onclick="Footnotes.hideAllAndToggle(\'test_debug_info\');return false;">Test</a>'
+  end
+  specify "links_helper_onclick" do
+    note = Footnotes::Notes::TestNote.new
+    expect(note).to receive(:onclick).twice.and_return(:onclick)
+    expect(@footnotes.send(:link_helper, note)).to eql '<a href="#" onclick="onclick">Test</a>'
+    expect(note).to receive(:has_fieldset?).once.and_return(true)
+    expect(@footnotes.send(:link_helper, note)).to eql '<a href="#" onclick="onclick">Test</a>'
+  end
+  specify "insert_style" do
+    @controller.response.body = "<head></head><split><body></body>"
+    @footnotes = Footnotes::Filter.new(@controller)
+    footnotes_perform!
+    expect(@controller.response.body.split('<split>').first.include?('<!-- Footnotes Style -->')).to be
+  end
+  specify "insert_footnotes_inside_body" do
+    @controller.response.body = "<head></head><split><body></body>"
+    @footnotes = Footnotes::Filter.new(@controller)
+    footnotes_perform!
+    expect(@controller.response.body.split('<split>').last.include?('<!-- End Footnotes -->')).to be
+  end
+  specify "insert_footnotes_inside_holder" do
+    @controller.response.body = "<head></head><split><div id='footnotes_holder'></div>"
+    @footnotes = Footnotes::Filter.new(@controller)
+    footnotes_perform!
+    expect(@controller.response.body.split('<split>').last.include?('<!-- End Footnotes -->')).to be
+  end
+  specify "insert_text" do
+    @footnotes.send(:insert_text, :after, /<head>/, "Graffiti")
+    after = "    <head>Graffiti"
+    expect(@controller.response.body.split("\n")[2]).to eql after
+    @footnotes.send(:insert_text, :before, /<\/body>/, "Notes")
+    after = "    Notes</body>"
+    expect(@controller.response.body.split("\n")[12]).to eql after
+  end
+  describe 'Hooks' do
+    before {Footnotes::Filter.notes = [:note_x, :note_y, :note_z]}
+    context 'before' do
+      specify do
+        Footnotes.setup {|config| config.before {|controller, filter| filter.notes -= [:note_y] }}
+        Footnotes::Filter.start!(@controller)
+        expect(Footnotes::Filter.notes).to eql [:note_x, :note_z]
+      end
+    end
+    context "after" do
+      specify do
+        Footnotes.setup {|config| config.after {|controller, filter| filter.notes -= [:note_y] }}
+        Footnotes::Filter.start!(@controller)
+        expect(Footnotes::Filter.notes).to eql [:note_x, :note_z]
+      end
+    end
+  end
+  protected
+  def footnotes_perform!
+    template_expects('html')
+    @controller.performed_render = true
+    Footnotes::Filter.start!(@controller)
+    @footnotes.add_footnotes!
+  end
+  def template_expects(format)
+    if @controller.template.respond_to?(:template_format)
+      allow(@controller.template).to receive(:template_format).and_return(format)
+    else
+      allow(@controller.template).to receive(:format).and_return(format)
+    end
+  end
+end

data/spec/notes/assigns_note_spec.rb ADDED Viewed

@@ -0,0 +1,50 @@
+require "spec_helper"
+require 'action_controller'
+require "rails-footnotes/notes/assigns_note"
+describe Footnotes::Notes::AssignsNote do
+  let(:note) do
+    @controller = double
+    allow(@controller).to receive(:instance_variables).and_return([:@action_has_layout, :@status])
+    @controller.instance_variable_set(:@action_has_layout, true)
+    @controller.instance_variable_set(:@status, 200)
+    Footnotes::Notes::AssignsNote.new(@controller)
+  end
+  subject {note}
+  before(:each) {Footnotes::Notes::AssignsNote.ignored_assigns = []}
+  it {should be_valid}
+  describe '#title' do
+    subject { super().title }
+    it {should eql 'Assigns (2)'}
+  end
+  specify {expect(note.send(:assigns)).to eql [:@action_has_layout, :@status]}
+  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>Integer</em>", "200"]
+  ]}
+  describe "Ignored Assigns" do
+    before(:each) {Footnotes::Notes::AssignsNote.ignored_assigns = [:@status]}
+    it {expect(note.send(:assigns)).not_to include :@status}
+  end
+  describe "Ignored Assigns by regexp" do
+    before(:each) {Footnotes::Notes::AssignsNote.ignored_assigns_pattern = /^@status$/}
+    it {expect(note.send(:assigns)).not_to include :@status}
+  end
+  it "should call #mount_table method with correct params" do
+    expect(note).to receive(:mount_table).with(
+      [
+        ["Name", "Value"],
+        ["<strong>@action_has_layout</strong><br /><em>TrueClass</em>", "true"],
+        ["<strong>@status</strong><br /><em>Integer</em>", "200"]
+      ], {:summary=>"Debug information for Assigns (2)"})
+    note.content
+  end
+end

data/spec/notes/controller_note_spec.rb ADDED Viewed

@@ -0,0 +1,12 @@
+require "spec_helper"
+require "rails-footnotes/notes/controller_note"
+describe Footnotes::Notes::ControllerNote do
+  # Issue #60
+  it "should not be valid if conftroller file not exist" do
+    note = Footnotes::Notes::ControllerNote.new(double)
+    allow(note).to receive(:controller_filename).and_return(nil)
+    expect(note).not_to be_valid
+  end
+end

data/spec/notes/files_note_spec.rb ADDED Viewed

@@ -0,0 +1,26 @@
+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
+    ConcreteFilesNote.new(double('controller', :response => double('', :body => '')))
+  end
+  subject { note }
+  it { should be_valid }
+  describe '#row' do
+    subject { super().row }
+    it { should eql :edit }
+  end
+end