rails-footnotes 7.1.0 → 7.1.1

data/spec/footnotes_spec.rb

@@ -1,267 +0,0 @@
-# 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
-  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
-      @file.close!
-    end
-
-    it "should not change file position" do
-      expect {
-        @footnotes = Footnotes::Filter.new(@controller)
-      }.not_to change{ @controller.response_body.pos }
-    end
-  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 = {}
-
-      Footnotes::Filter.notes = [ :test ]
-      Footnotes::Filter.multiple_notes = false
-      @footnotes = Footnotes::Filter.new(@controller)
-
-      @file = Rack::File::Iterator.new("README.md", (0..-1), {})
-      @controller.response_body = @file
-    end
-
-    it "should work" do
-      @footnotes = Footnotes::Filter.new(@controller)
-    end
-  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
-
-    it "footnotes_controller" do
-      index = @controller.response.body.index(/This is the HTML page/)
-      expect(index).to eql 334
-    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
-  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

@@ -1,68 +0,0 @@
-require "spec_helper"
-require "action_controller"
-require "rails-footnotes/notes/assigns_note"
-require "support/active_record"
-
-describe Footnotes::Notes::AssignsNote do
-  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) { Footnotes::Notes::AssignsNote.new(controller) }
-
-  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
-
-  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/notes/controller_note_spec.rb

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

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

data/spec/notes/javascripts_note_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-require "rails-footnotes/notes/javascripts_note"
-
-describe Footnotes::Notes::JavascriptsNote do
-  let(:note) {described_class.new(double('controller', :response => double('body', :body => '')))}
-  subject {note}
-
-  it {should be_valid}
-
-  it "should return js links from html after #scan_text mehtod call" do
-    expect(subject.send(:scan_text, HTML_WITH_JS)).to eql ['/javascripts/all.js', '/javascripts/jquery.js']
-  end
-end
-
-HTML_WITH_JS = <<-EOF
-  <script cache="false" src="/javascripts/all.js?1315913920" type="text/javascript"></script>
-  <script cache="false" src="/javascripts/jquery.js?1315913920" type="text/javascript"></script>
-EOF

data/spec/notes/stylesheets_note_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-require "rails-footnotes/notes/stylesheets_note"
-
-describe Footnotes::Notes::StylesheetsNote do
-
-  let(:note) {described_class.new(double('controller', :response => double('body', :body => '')))}
-  subject {note}
-
-  it {should be_valid}
-
-  it "should return css link from html text after #scan_text call" do
-    expect(subject.send(:scan_text, HTML_WITH_CSS)).to eql ['/stylesheets/compiled/print.css', '/stylesheets/compiled/print.css']
-  end
-end
-
-HTML_WITH_CSS = <<-EOF
-  <link href="/stylesheets/compiled/print.css?1315913920" media="print" rel="stylesheet" type="text/css" />'
-  '<link href="/stylesheets/compiled/print.css?1315913920" media="print" rel="stylesheet" type="text/css" />'
-EOF

data/spec/notes/view_note_spec.rb

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

@@ -1,68 +0,0 @@
-begin
-  require 'simplecov'
-  SimpleCov.start
-rescue LoadError
-end
-ENV["RAILS_ENV"] ||= 'test'
-require "sprockets/railtie"
-require "rails-footnotes"
-require 'capybara/rspec'
-
-module FooBar
-  class Application < Rails::Application
-    config.secret_key_base = 'foobar'
-    config.root = Dir.new('./spec')
-    config.eager_load = false
-  end
-end
-
-ActionController::Base.class_eval do
-  include Rails.application.routes.url_helpers
-end
-
-class ApplicationController < ActionController::Base
-end
-
-module Helpers
-  def page
-    Capybara::Node::Simple.new(response.body)
-  end
-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'
-    get 'footnotes/foo_holder'
-    get 'footnotes/foo_js'
-    get 'footnotes/foo_download'
-    get 'partials/index'
-    get 'files/index'
-  end
-end
-
-require 'rspec/rails'
-require 'capybara/rails'
-
-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

data/spec/support/active_record.rb

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