RubyGems - rails-footnotes - Versions diffs - 4.1.5 → 5.0.0 - Mend

rails-footnotes 4.1.5 → 5.0.0

Files changed (47) hide show

checksums.yaml +5 -5
data/.github/workflows/ci.yml +25 -0
data/.gitignore +4 -3
data/CHANGELOG +8 -0
data/Gemfile +8 -1
data/Gemfile.lock +187 -0
data/README.rdoc +8 -54
data/Rakefile +1 -6
data/bin/rake +29 -0
data/bin/rspec +29 -0
data/gemfiles/{Gemfile.rails-3.2.x → Gemfile.rails-3.2.22} +1 -1
data/lib/generators/templates/rails_footnotes.rb +4 -5
data/lib/rails-footnotes.rb +9 -9
data/lib/rails-footnotes/extension.rb +8 -11
data/lib/rails-footnotes/filter.rb +13 -4
data/lib/rails-footnotes/notes/assigns_note.rb +2 -2
data/lib/rails-footnotes/notes/files_note.rb +12 -23
data/lib/rails-footnotes/notes/log_note.rb +1 -1
data/lib/rails-footnotes/notes/params_note.rb +5 -1
data/lib/rails-footnotes/notes/queries_note.rb +9 -10
data/lib/rails-footnotes/notes/view_note.rb +16 -7
data/lib/rails-footnotes/version.rb +1 -1
data/lib/rails6-footnotes.rb +1 -0
data/rails-footnotes.gemspec +5 -10
data/spec/abstract_note_spec.rb +17 -13
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/{views → app/views}/partials/_foo.html.erb +0 -0
data/spec/{views → app/views}/partials/index.html.erb +0 -0
data/spec/controllers/files_note_controller_spec.rb +38 -0
data/spec/controllers/footnotes_controller_spec.rb +49 -34
data/spec/controllers/log_note_controller_spec.rb +4 -8
data/spec/controllers/partials_note_controller_spec.rb +2 -3
data/spec/env_note_spec.rb +4 -4
data/spec/footnotes_spec.rb +38 -54
data/spec/notes/assigns_note_spec.rb +13 -9
data/spec/notes/controller_note_spec.rb +2 -2
data/spec/notes/files_note_spec.rb +12 -3
data/spec/notes/javascripts_note_spec.rb +1 -1
data/spec/notes/stylesheets_note_spec.rb +1 -1
data/spec/notes/view_note_spec.rb +18 -0
data/spec/spec_helper.rb +35 -3
metadata +38 -48
data/.travis.yml +0 -14

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

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

data/spec/app/assets/javascripts/foobar.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ // Foobar

data/spec/app/assets/stylesheets/foobar.css ADDED Viewed

File without changes

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

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

data/spec/app/views/layouts/application.html.erb ADDED Viewed

@@ -0,0 +1,12 @@
+<!doctype html>
+<html>
+  <head>
+    <%= javascript_include_tag 'foobar' %>
+    <%= javascript_include_tag 'http://google.com/whatever.js' %>
+    <%= stylesheet_link_tag 'foobar' %>
+    <%= stylesheet_link_tag 'http://google.com/whatever.css' %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/{views → app/views}/partials/_foo.html.erb RENAMED Viewed

File without changes

data/spec/{views → app/views}/partials/index.html.erb RENAMED Viewed

File without changes

data/spec/controllers/files_note_controller_spec.rb ADDED Viewed

@@ -0,0 +1,38 @@
+require 'spec_helper'
+class FilesController < ApplicationController
+  def index
+  end
+end
+describe FilesController, type: :controller do
+  render_views
+  before :all do
+    Footnotes.enabled = true
+  end
+  after :all do
+    Footnotes.enabled = false
+  end
+  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)
+    link = js_debug.first('a', visible: false)
+    expect(link['href']).to eq("txmt://open?url=file://#{Rails.root.join('app', 'assets', 'javascripts', 'foobar.js')}&line=1&column=1")
+  end
+  it 'includes css assets in the response' do
+    get :index
+    css_debug = first('fieldset#stylesheets_debug_info div', visible: false)
+    expect(css_debug).to have_selector('li a', visible: false, count: 1)
+    expect(css_debug).to have_selector('li a', text: /foobar\.css/, visible: false)
+    link = css_debug.first('a', visible: false)
+    expect(link['href']).to eq("txmt://open?url=file://#{Rails.root.join('app', 'assets', 'stylesheets', 'foobar.css')}&line=1&column=1")
+  end
+end

data/spec/controllers/footnotes_controller_spec.rb CHANGED Viewed

@@ -3,45 +3,41 @@ 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
-    send_file Rails.root.join('spec', 'fixtures', 'html_download.html'), :disposition => 'attachment'
+    send_file Rails.root.join('fixtures', 'html_download.html'), :disposition => 'attachment'
   end
 end
-describe FootnotesController do
-  def page
-    Capybara::Node::Simple.new(response.body)
-  end
+describe FootnotesController, type: :controller do
   shared_examples 'has_footnotes' do
     it 'includes footnotes' do
       get :foo
-      response.body.should have_selector('#footnotes_debug')
+      expect(response.body).to have_selector('#footnotes_debug')
     end
   end
   shared_examples 'has_no_footnotes' do
     it 'does not include footnotes' do
-      response.body.should_not have_selector('#footnotes_debug')
+      expect(response.body).not_to have_selector('#footnotes_debug')
     end
   end
   it 'does not alter the page by default' do
     get :foo
-    response.body.should == HTML_DOCUMENT
+    expect(response.body).to eq(HTML_DOCUMENT)
   end
   context 'with footnotes' do
@@ -62,24 +58,24 @@ describe FootnotesController do
       end
       it 'includes footnotes in the last div in body' do
-        all('body > :last-child')[0][:id].should == 'footnotes_debug'
+        expect(all('body > :last-child')[0][:id]).to eq('footnotes_debug')
       end
       it 'includes footnotes in the footnoted_holder div if present' do
         get :foo_holder
-        response.body.should have_selector('#footnotes_holder > #footnotes_debug')
+        expect(response.body).to have_selector('#footnotes_holder > #footnotes_debug')
       end
       it 'does not alter a html file download' do
         get :foo_download
-        response.body.should == File.open(Rails.root.join('spec', 'fixtures', 'html_download.html')).read
+        expect(response.body).to eq(File.open(Rails.root.join('fixtures', 'html_download.html')).read)
       end
     end
     describe 'when request is xhr' do
       include_context 'has_no_footnotes'
       before do
-        xhr :get, :foo
+        get :foo, xhr: true
       end
     end
@@ -90,24 +86,43 @@ describe FootnotesController do
       end
     end
-  end
+    describe 'when footnotes is disabled' do
+      include_context 'has_no_footnotes'
+      before do
+        Footnotes.enabled = false
+        get :foo
+      end
+    end
-end
+    describe 'with a proc' do
+      it 'yields the controller' do
+        c = nil
+        Footnotes.enabled = lambda { |controller| c = controller}
+        get :foo
+        expect(c).to be_kind_of(ActionController::Base)
+      end
+      context 'returning true' do
+        include_context 'has_footnotes'
+        before do
+          Footnotes.enabled = lambda { true }
+          get :foo
+        end
+      end
+      context 'returning false' do
+        include_context 'has_no_footnotes'
+        before do
+          Footnotes.enabled = lambda { false }
+          get :foo
+        end
+      end
-HTML_DOCUMENT = <<EOF
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-    <head>
-        <title>HTML to XHTML Example: HTML page</title>
-        <link rel="Stylesheet" href="htmltohxhtml.css" type="text/css" media="screen">
-        <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
-    </head>
-    <body>
-        <p>This is the HTML page. It works and is encoded just like any HTML page you
-         have previously done. View <a href="htmltoxhtml2.htm">the XHTML version</a> of
-         this page to view the difference between HTML and XHTML.</p>
-        <p>You will be glad to know that no changes need to be made to any of your CSS files.</p>
-    </body>
-</html>
-EOF
+    end
+  end
+end

data/spec/controllers/log_note_controller_spec.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'stringio'
-describe 'log note' do
+describe 'log note', type: :controller do
   class ApplicationController < ActionController::Base
   end
@@ -10,14 +10,10 @@ describe 'log note' 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
-  def page
-    Capybara::Node::Simple.new(response.body)
-  end
   before :all do
     Footnotes.enabled = true
   end
@@ -29,8 +25,8 @@ describe 'log note' do
   it 'Includes the log in the response' do
     get :index
     log_debug = first('fieldset#log_debug_info div', :visible => false)
-    log_debug.should have_content('foo')
-    log_debug.should have_content('bar')
+    expect(log_debug).to have_content('foo')
+    expect(log_debug).to have_content('bar')
   end
 end

data/spec/controllers/partials_note_controller_spec.rb CHANGED Viewed

@@ -3,12 +3,11 @@ require 'spec_helper'
 class PartialsController < ActionController::Base
   def index
-    prepend_view_path "#{Rails.root.join('spec', 'views')}"
   end
 end
-describe PartialsController do
+describe PartialsController, type: :controller do
   render_views
@@ -22,7 +21,7 @@ describe PartialsController do
   it 'lists the rendered partials' do
     get :index
-    response.body.should have_selector('#footnotes_debug #partials_debug_info table tr', :visible => false, :count => 2)
+    expect(response.body).to have_selector('#footnotes_debug #partials_debug_info table tr', :visible => false, :count => 2)
   end

data/spec/env_note_spec.rb CHANGED Viewed

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

@@ -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 = {}
@@ -42,12 +42,13 @@ describe "Footnotes" do
   it "footnotes_controller" do
     index = @controller.response.body.index(/This is the HTML page/)
-    index.should eql 334
+    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
@@ -66,62 +67,62 @@ describe "Footnotes" do
   it "foonotes_included" do
     footnotes_perform!
-    @controller.response_body.should_not == HTML_DOCUMENT
+    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)
-    link.should 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"
+    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!
-    @controller.response.body.should eql HTML_DOCUMENT
+    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!
-    @controller.response.body.should eql HTML_DOCUMENT
+    expect(@controller.response.body).to eql HTML_DOCUMENT
   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!
-    @controller.response.body.should_not eql HTML_DOCUMENT
+    expect(@controller.response.body).not_to eql HTML_DOCUMENT
   end
   specify "footnotes_included_when_content_type_is_nil" do
     footnotes_perform!
-    @controller.response.body.should_not eql HTML_DOCUMENT
+    expect(@controller.response.body).not_to eql HTML_DOCUMENT
   end
   specify "not_included_when_body_is_not_a_string" do
-    @controller.response.stub(:body).and_return(Time.now)# = Proc.new { Time.now }
-    Footnotes::Filter.new(@controller).send(:valid?).should_not be
-    @controller.response.body.should_not =~ /<!-- Footnotes/
+    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
-    test_note.class.name.should eql 'Footnotes::Notes::TestNote'
-    test_note.to_sym.should eql :test
+    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
-    note.should_receive(:row).twice
+    expect(note).to receive(:row).twice
     @footnotes.instance_variable_set(:@notes, [note])
     footnotes_perform!
   end
   specify "notes_fieldset" do
     note = Footnotes::Notes::TestNote.new
-    note.should_receive(:has_fieldset?).exactly(3).times
+    expect(note).to receive(:has_fieldset?).exactly(3).times
     @footnotes.instance_variable_set(:@notes, [note])
     footnotes_perform!
   end
@@ -129,70 +130,70 @@ describe "Footnotes" do
   specify "multiple_notes" do
     Footnotes::Filter.multiple_notes = true
     note = Footnotes::Notes::TestNote.new
-    note.should_receive(:has_fieldset?).twice
+    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
-    note.class.should_receive(:close!)
+    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
-    @footnotes.send(:link_helper, note).should eql '<a href="#" onclick="">Test</a>'
+    expect(@footnotes.send(:link_helper, note)).to eql '<a href="#" onclick="">Test</a>'
-    note.should_receive(:link).once.and_return(:link)
-    @footnotes.send(:link_helper, note).should eql '<a href="link" 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
-    note.should_receive(:has_fieldset?).once.and_return(true)
-    @footnotes.send(:link_helper, note).should eql '<a href="#" onclick="Footnotes.hideAllAndToggle(\'test_debug_info\');return false;">Test</a>'
+    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
-    note.should_receive(:onclick).twice.and_return(:onclick)
-    @footnotes.send(:link_helper, note).should eql '<a href="#" onclick="onclick">Test</a>'
+    expect(note).to receive(:onclick).twice.and_return(:onclick)
+    expect(@footnotes.send(:link_helper, note)).to eql '<a href="#" onclick="onclick">Test</a>'
-    note.should_receive(:has_fieldset?).once.and_return(true)
-    @footnotes.send(:link_helper, note).should 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!
-    @controller.response.body.split('<split>').first.include?('<!-- Footnotes Style -->').should be
+    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!
-    @controller.response.body.split('<split>').last.include?('<!-- End Footnotes -->').should be
+    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!
-    @controller.response.body.split('<split>').last.include?('<!-- End Footnotes -->').should be
+    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"
-    @controller.response.body.split("\n")[2].should eql after
+    expect(@controller.response.body.split("\n")[2]).to eql after
     @footnotes.send(:insert_text, :before, /<\/body>/, "Notes")
     after = "    Notes</body>"
-    @controller.response.body.split("\n")[12].should eql after
+    expect(@controller.response.body.split("\n")[12]).to eql after
   end
   describe 'Hooks' do
@@ -201,14 +202,14 @@ describe "Footnotes" do
       specify do
         Footnotes.setup {|config| config.before {|controller, filter| filter.notes -= [:note_y] }}
         Footnotes::Filter.start!(@controller)
-        Footnotes::Filter.notes.should eql [:note_x, :note_z]
+        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)
-        Footnotes::Filter.notes.should eql [:note_x, :note_z]
+        expect(Footnotes::Filter.notes).to eql [:note_x, :note_z]
       end
     end
   end
@@ -224,27 +225,10 @@ describe "Footnotes" do
   def template_expects(format)
     if @controller.template.respond_to?(:template_format)
-      @controller.template.stub(:template_format).and_return(format)
+      allow(@controller.template).to receive(:template_format).and_return(format)
     else
-      @controller.template.stub(:format).and_return(format)
+      allow(@controller.template).to receive(:format).and_return(format)
     end
   end
-HTML_DOCUMENT = <<EOF
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-    <head>
-        <title>HTML to XHTML Example: HTML page</title>
-        <link rel="Stylesheet" href="htmltohxhtml.css" type="text/css" media="screen">
-        <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
-    </head>
-    <body>
-        <p>This is the HTML page. It works and is encoded just like any HTML page you
-         have previously done. View <a href="htmltoxhtml2.htm">the XHTML version</a> of
-         this page to view the difference between HTML and XHTML.</p>
-        <p>You will be glad to know that no changes need to be made to any of your CSS files.</p>
-    </body>
-</html>
-EOF
 end