rails-footnotes 7.0.0 → 7.1.0

data/spec/footnotes_spec.rb

@@ -27,30 +27,23 @@ module Footnotes::Notes
 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
+      @controller = FootnotesController.new
+      @controller.template = Object.new
+      @controller.request = ActionDispatch::TestRequest.create
+      @controller.response = ActionDispatch::TestResponse.new
+      @controller.params = {}
+
+      Footnotes::Filter.notes = [ :test ]
+      Footnotes::Filter.multiple_notes = false
+      @footnotes = Footnotes::Filter.new(@controller)
+
       @file = Tempfile.new("test")
       def @file.body; read; end
       @file.write "foobarbaz"
       @file.rewind
+      @controller.response_body = @file
     end
 
     after do
@@ -58,158 +51,198 @@ describe "Footnotes" do
     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
+  context "response_body is Rack::File::Iterator" do
+    before do
+      @controller = FootnotesController.new
+      @controller.template = Object.new
+      @controller.request = ActionDispatch::TestRequest.create
+      @controller.response = ActionDispatch::TestResponse.new
+      @controller.params = {}
 
-  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&line=1&column=1"
-  end
+      Footnotes::Filter.notes = [ :test ]
+      Footnotes::Filter.multiple_notes = false
+      @footnotes = Footnotes::Filter.new(@controller)
 
-  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
+      @file = Rack::File::Iterator.new("README.md", (0..-1), {})
+      @controller.response_body = @file
+    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
+    it "should work" do
+      @footnotes = Footnotes::Filter.new(@controller)
+    end
   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
+  context "response_body is HTML" 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
 
-  specify "footnotes_included_when_content_type_is_nil" do
-    footnotes_perform!
-    expect(@controller.response.body).not_to eql HTML_DOCUMENT
-  end
+    it "footnotes_controller" do
+      index = @controller.response.body.index(/This is the HTML page/)
+      expect(index).to eql 334
+    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
+    it "foonotes_included" do
+      footnotes_perform!
+      expect(@controller.response_body).not_to eq(HTML_DOCUMENT)
+    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
+    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 "notes_links" do
-    note = Footnotes::Notes::TestNote.new
-    expect(note).to receive(:row).twice
-    @footnotes.instance_variable_set(:@notes, [note])
-    footnotes_perform!
-  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 "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 "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 "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 "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 "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 "footnotes_included_when_content_type_is_nil" do
+      footnotes_perform!
+      expect(@controller.response.body).not_to eql HTML_DOCUMENT
+    end
 
-  specify "links_helper" do
-    note = Footnotes::Notes::TestNote.new
-    expect(@footnotes.send(:link_helper, note)).to eql '<a href="#" onclick="">Test</a>'
+    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
 
-    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 "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 "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 "notes_links" do
+      note = Footnotes::Notes::TestNote.new
+      expect(note).to receive(:row).twice
+      @footnotes.instance_variable_set(:@notes, [note])
+      footnotes_perform!
+    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>'
+    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
 
-    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 "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 "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 "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 "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 "links_helper" do
+      note = Footnotes::Notes::TestNote.new
+      expect(@footnotes.send(:link_helper, note)).to eql '<a href="#" onclick="">Test</a>'
 
-  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
+      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 "insert_text" do
-    @footnotes.send(:insert_text, :after, /<head>/, "Graffiti")
-    after = "    <head>Graffiti"
-    expect(@controller.response.body.split("\n")[2]).to eql after
+    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
 
-    @footnotes.send(:insert_text, :before, /<\/body>/, "Notes")
-    after = "    Notes</body>"
-    expect(@controller.response.body.split("\n")[12]).to eql after
-  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>'
 
-  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
+      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
-    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]
+
+    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
   end

data/spec/notes/assigns_note_spec.rb

@@ -1,20 +1,20 @@
 require "spec_helper"
-require 'action_controller'
+require "action_controller"
 require "rails-footnotes/notes/assigns_note"
+require "support/active_record"
 
 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)
+  let(:controller) do
+    double(instance_variables: [:@action_has_layout, :@status]).tap do |c|
+      c.instance_variable_set(:@action_has_layout, true)
+      c.instance_variable_set(:@status, 200)
+    end
   end
-  subject {note}
+  subject(:note) { Footnotes::Notes::AssignsNote.new(controller) }
 
   before(:each) {Footnotes::Notes::AssignsNote.ignored_assigns = []}
 
-  it {should be_valid}
+  it { should be_valid }
 
   describe '#title' do
     subject { super().title }
@@ -47,4 +47,22 @@ describe Footnotes::Notes::AssignsNote do
       ], {:summary=>"Debug information for Assigns (2)"})
     note.content
   end
+
+  describe "when it is an ActiveRecord::Relation" do
+    let(:controller) do
+      double(instance_variables: [:@widgets]).tap do |c|
+        c.instance_variable_set(:@widgets, Widget.all)
+      end
+    end
+
+    it "should still work" do
+      expect(note).to receive(:mount_table).with(
+        [
+          ["Name", "Value"],
+          ["<strong>@widgets</strong><br /><em>ActiveRecord::Relation</em>", "#&lt;ActiveRecord::Relation []&gt;"],
+        ], {:summary=>"Debug information for Assigns (1)"})
+      expect(note).to be_valid
+      note.content
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -30,12 +30,12 @@ module Helpers
 end
 
 RSpec.configure do |config|
-
   Rails.application.initialize!
 
   config.include Capybara::DSL
   config.include Helpers
   config.example_status_persistence_file_path = ".rspec_results"
+  config.filter_run_when_matching :focus
 
   Rails.application.routes.draw do
     get 'footnotes/foo'

data/spec/support/active_record.rb

@@ -0,0 +1,22 @@
+require "active_record"
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Migration.create_table :widgets do |t|
+  t.string :name
+  t.timestamps
+end
+
+class Widget < ActiveRecord::Base
+end
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-footnotes
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Roman V. Babenko
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-29 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -47,7 +47,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - bin/rake
 - bin/rspec
@@ -106,6 +106,7 @@ files:
 - spec/notes/stylesheets_note_spec.rb
 - spec/notes/view_note_spec.rb
 - spec/spec_helper.rb
+- spec/support/active_record.rb
 homepage: http://github.com/indirect/rails-footnotes
 licenses: []
 metadata: {}
@@ -152,3 +153,4 @@ test_files:
 - spec/notes/stylesheets_note_spec.rb
 - spec/notes/view_note_spec.rb
 - spec/spec_helper.rb
+- spec/support/active_record.rb