blacklight 6.2.0 → 6.3.0

data/spec/presenters/pipeline_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Blacklight::Rendering::Pipeline do
+  include Capybara::RSpecMatchers
+  let(:document) { double }
+  let(:context) { double }
+  let(:options) { double }
+  let(:presenter) { described_class.new(values, field_config, document, context, options) }
+  describe "render" do
+    subject { presenter.render }
+    let(:values) { ['a', 'b'] }
+    let(:field_config) { Blacklight::Configuration::NullField.new } 
+    it { is_expected.to eq "a and b" }
+
+    context "when separator_options are in the config" do
+      let(:values) { ['c', 'd'] }
+      let(:field_config) { Blacklight::Configuration::NullField.new(separator: nil, itemprop: nil, separator_options: { two_words_connector: '; '}) } 
+      it { is_expected.to eq "c; d" }
+    end
+
+    context "when itemprop is in the config" do
+      let(:values) { ['a'] }
+      let(:field_config) { Blacklight::Configuration::NullField.new(separator: nil, itemprop: 'some-prop', separator_options: nil) } 
+      it { is_expected.to have_selector("span[@itemprop='some-prop']", :text => "a") }
+    end
+  end
+end

data/spec/presenters/show_presenter_spec.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Blacklight::ShowPresenter do
+  include Capybara::RSpecMatchers
+  let(:request_context) { double }
+  let(:config) { Blacklight::Configuration.new }
+
+  subject { presenter }
+  let(:presenter) { described_class.new(document, request_context, config) }
+  let(:parameter_class) { ActionController::Parameters }
+  let(:params) { parameter_class.new }
+  let(:search_state) { Blacklight::SearchState.new(params, config) }
+
+  let(:document) do
+    SolrDocument.new(id: 1,
+                     'link_to_search_true' => 'x',
+                     'link_to_search_named' => 'x',
+                     'qwer' => 'document qwer value',
+                     'mnbv' => 'document mnbv value')
+  end
+
+  before do
+    allow(request_context).to receive(:search_state).and_return(search_state)
+  end
+
+  describe "link_rel_alternates" do
+    before do
+      class MockDocument
+        include Blacklight::Solr::Document
+      end
+
+      module MockExtension
+         def self.extended(document)
+           document.will_export_as(:weird, "application/weird")
+           document.will_export_as(:weirder, "application/weirder")
+           document.will_export_as(:weird_dup, "application/weird")
+         end
+         def export_as_weird ; "weird" ; end
+         def export_as_weirder ; "weirder" ; end
+         def export_as_weird_dup ; "weird_dup" ; end
+      end
+
+      MockDocument.use_extension(MockExtension)
+
+      def mock_document_app_helper_url *args
+        solr_document_url(*args)
+      end
+
+      allow(request_context).to receive(:polymorphic_url) do |_, opts|
+        "url.#{opts[:format]}"
+      end
+    end
+
+    let(:document) { MockDocument.new(id: "MOCK_ID1") }
+
+    context "with no arguments" do
+      subject { presenter.link_rel_alternates }
+
+      it "generates <link rel=alternate> tags" do
+        tmp_value = Capybara.ignore_hidden_elements
+        Capybara.ignore_hidden_elements = false
+        document.export_formats.each_pair do |format, spec|
+          expect(subject).to have_selector("link[href$='.#{ format  }']") do |matches|
+            expect(matches).to have(1).match
+            tag = matches[0]
+            expect(tag.attributes["rel"].value).to eq "alternate"
+            expect(tag.attributes["title"].value).to eq format.to_s
+            expect(tag.attributes["href"].value).to eq mock_document_app_helper_url(document, format: format)
+          end
+        end
+        Capybara.ignore_hidden_elements = tmp_value
+      end
+
+      it { is_expected.to be_html_safe }
+    end
+
+    context "with unique: true" do
+      subject { presenter.link_rel_alternates(unique: true) }
+
+      it "respects unique: true" do
+        tmp_value = Capybara.ignore_hidden_elements
+        Capybara.ignore_hidden_elements = false
+        expect(subject).to have_selector("link[type='application/weird']", count: 1)
+        Capybara.ignore_hidden_elements = tmp_value
+      end
+    end
+
+    context "with exclude" do
+      subject { presenter.link_rel_alternates(unique: true) }
+      it "excludes formats from :exclude" do
+        tmp_value = Capybara.ignore_hidden_elements
+        Capybara.ignore_hidden_elements = false
+        expect(subject).to_not have_selector("link[href$='.weird_dup']")
+        Capybara.ignore_hidden_elements = tmp_value
+      end
+    end
+  end
+
+  describe "field_value" do
+    let(:config) do
+      Blacklight::Configuration.new.configure do |config|
+        config.add_show_field 'qwer'
+        config.add_show_field 'asdf', :helper_method => :render_asdf_document_show_field
+        config.add_show_field 'link_to_search_true', :link_to_search => true
+        config.add_show_field 'link_to_search_named', :link_to_search => :some_field
+        config.add_show_field 'highlight', :highlight => true
+        config.add_show_field 'solr_doc_accessor', :accessor => true
+        config.add_show_field 'explicit_accessor', :accessor => :solr_doc_accessor
+        config.add_show_field 'explicit_array_accessor', :accessor => [:solr_doc_accessor, :some_method]
+        config.add_show_field 'explicit_accessor_with_arg', :accessor => :solr_doc_accessor_with_arg
+      end
+    end
+
+    it 'html-escapes values' do
+      value = subject.field_value 'asdf', value: '<b>val1</b>'
+      expect(value).to eq '&lt;b&gt;val1&lt;/b&gt;'
+    end
+
+    it 'joins multivalued valued fields' do
+      value = subject.field_value 'asdf', value: ['<a', 'b']
+      expect(value).to eq '&lt;a and b'
+    end
+
+    it 'joins multivalued valued fields' do
+      value = subject.field_value 'asdf', value: ['a', 'b', 'c']
+      expect(value).to eq 'a, b, and c'
+    end
+
+    it "checks for an explicit value" do
+      expect(request_context).to_not receive(:render_asdf_document_show_field)
+      value = subject.field_value 'asdf', :value => 'val1'
+      expect(value).to eq 'val1'
+    end
+
+    it "checks for a helper method to call" do
+      allow(request_context).to receive(:render_asdf_document_show_field).and_return('custom asdf value')
+      value = subject.field_value 'asdf'
+      expect(value).to eq 'custom asdf value'
+    end
+
+    it "checks for a link_to_search" do
+      allow(request_context).to receive(:search_action_path).and_return('/foo')
+      allow(request_context).to receive(:link_to).with("x", '/foo').and_return('bar')
+      value = subject.field_value 'link_to_search_true'
+      expect(value).to eq 'bar'
+    end
+
+    it "checks for a link_to_search with a field name" do
+      allow(request_context).to receive(:search_action_path).and_return('/foo')
+      allow(request_context).to receive(:link_to).with("x", '/foo').and_return('bar')
+      value = subject.field_value 'link_to_search_named'
+      expect(value).to eq 'bar'
+    end
+
+    context "when no highlight field is available" do
+      before do
+        allow(document).to receive(:has_highlight_field?).and_return(false)
+      end
+      let(:value) { subject.field_value 'highlight' }
+      it "is blank" do
+        expect(value).to be_blank
+      end
+    end
+
+    it "checks for a highlighted field" do
+      allow(document).to receive(:has_highlight_field?).and_return(true)
+      allow(document).to receive(:highlight_field).with('highlight').and_return(['<em>highlight</em>'.html_safe])
+      value = subject.field_value 'highlight'
+      expect(value).to eq '<em>highlight</em>'
+    end
+
+    it 'respects the HTML-safeness of multivalued highlight fields' do
+      allow(document).to receive(:has_highlight_field?).and_return(true)
+      allow(document).to receive(:highlight_field).with('highlight').and_return(['<em>highlight</em>'.html_safe, '<em>other highlight</em>'.html_safe])
+      value = subject.field_value 'highlight'
+      expect(value).to eq '<em>highlight</em> and <em>other highlight</em>'
+    end
+
+    it "checks the document field value" do
+      value = subject.field_value 'qwer'
+      expect(value).to eq 'document qwer value'
+    end
+
+    it "works with show fields that aren't explicitly defined" do
+      value = subject.field_value 'mnbv'
+      expect(value).to eq 'document mnbv value'
+    end
+
+    it "calls an accessor on the solr document" do
+      allow(document).to receive_messages(solr_doc_accessor: "123")
+      value = subject.field_value 'solr_doc_accessor'
+      expect(value).to eq "123"
+    end
+
+    it "calls an explicit accessor on the solr document" do
+      allow(document).to receive_messages(solr_doc_accessor: "123")
+      value = subject.field_value 'explicit_accessor'
+      expect(value).to eq "123"
+    end
+
+    it "calls an explicit array-style accessor on the solr document" do
+      allow(document).to receive_message_chain(:solr_doc_accessor, some_method: "123")
+      value = subject.field_value 'explicit_array_accessor'
+      expect(value).to eq "123"
+    end
+
+    it "calls an accessor on the solr document with the field as an argument" do
+      allow(document).to receive(:solr_doc_accessor_with_arg).with('explicit_accessor_with_arg').and_return("123")
+      value = subject.field_value 'explicit_accessor_with_arg'
+      expect(value).to eq "123"
+    end
+  end
+
+  describe "#heading" do
+    it "falls back to an id" do
+      allow(document).to receive(:[]).with('id').and_return "xyz"
+      expect(subject.heading).to eq document.id
+    end
+
+    it "returns the value of the field" do
+      config.show.title_field = :x
+      allow(document).to receive(:has?).with(:x).and_return(true)
+      allow(document).to receive(:[]).with(:x).and_return("value")
+      expect(subject.heading).to eq "value"
+    end
+
+    it "returns the first present value" do
+      config.show.title_field = [:x, :y]
+      allow(document).to receive(:has?).with(:x).and_return(false)
+      allow(document).to receive(:has?).with(:y).and_return(true)
+      allow(document).to receive(:[]).with(:y).and_return("value")
+      expect(subject.heading).to eq "value"
+    end
+  end
+
+  describe "#html_title" do
+    it "falls back to an id" do
+      allow(document).to receive(:[]).with('id').and_return "xyz"
+      expect(subject.html_title).to eq document.id
+    end
+
+    it "returns the value of the field" do
+      config.show.html_title_field = :x
+      allow(document).to receive(:has?).with(:x).and_return(true)
+      allow(document).to receive(:fetch).with(:x, nil).and_return("value")
+      expect(subject.html_title).to eq "value"
+    end
+
+    it "returns the first present value" do
+      config.show.html_title_field = [:x, :y]
+      allow(document).to receive(:has?).with(:x).and_return(false)
+      allow(document).to receive(:has?).with(:y).and_return(true)
+      allow(document).to receive(:fetch).with(:y, nil).and_return("value")
+      expect(subject.html_title).to eq "value"
+    end
+  end
+
+  describe '#field_values' do
+    context 'for a field with the helper_method option' do
+      let(:field_name) { 'field_with_helper' }
+      let(:field_config) { config.add_facet_field 'field_with_helper', helper_method: 'render_field_with_helper' }
+
+      before do
+        document['field_with_helper'] = 'value'
+      end
+
+      it "checks call the helper method with arguments" do
+        allow(request_context).to receive(:render_field_with_helper) do |*args|
+          args.first
+        end
+
+        render_options = { a: 1 }
+
+        options = subject.send(:field_values, field_config, a: 1)
+
+        expect(options).to include :document, :field, :value, :config, :a
+        expect(options[:document]).to eq document
+        expect(options[:field]).to eq 'field_with_helper'
+        expect(options[:value]).to eq ['value']
+        expect(options[:config]).to eq field_config
+        expect(options[:a]).to eq 1
+      end
+    end
+  end
+end
+

data/spec/routing/catalog_routing_spec.rb

@@ -4,49 +4,49 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe "Routing" do
   describe "Paths Generated by Custom Routes:" do
     # paths generated by custom routes
-    it "should have a path for showing the email form" do
+    it "has a path for showing the email form" do
       expect(:get => "/catalog/email").to route_to(:controller => 'catalog', :action => 'email')
     end
-    it "should have a path for sending the email" do
+    it "has a path for sending the email" do
       expect(:post => "/catalog/email").to route_to(:controller => 'catalog', :action => 'email')
     end
-    it "should map GET {:controller => 'catalog', :action => 'sms'} to /catalog/sms" do
+    it "maps GET {:controller => 'catalog', :action => 'sms'} to /catalog/sms" do
       expect(:get => "/catalog/sms").to route_to(:controller => 'catalog', :action => 'sms')
     end
-    it "should map POST {:controller => 'catalog', :action => 'sms'} to /catalog/sms" do
+    it "maps POST {:controller => 'catalog', :action => 'sms'} to /catalog/sms" do
       expect(:post => "/catalog/sms").to route_to(:controller => 'catalog', :action => 'sms')
     end
-    it "should map { :controller => 'catalog', :action => 'show', :id => 666 } to /catalog/666" do
+    it "maps { :controller => 'catalog', :action => 'show', :id => 666 } to /catalog/666" do
       expect(:get => "/catalog/666").to route_to(:controller => 'catalog', :action => 'show', :id => "666")
     end
   end
 
 
   describe "solr_document_path for SolrDocument", :test => true do
-    it "should route correctly" do
+    it "routes correctly" do
       expect(:get => solr_document_path(SolrDocument.new(:id => 'asdf'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'asdf')
     end
 
     context "should escape solr document ids" do
 
-      it "should pass-through url-valid ids" do
+      it "pass-throughs url-valid ids" do
         expect(:get => solr_document_path(SolrDocument.new(:id => 'qwerty'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'qwerty')
       end
 
-      it "should route url-like ids" do
+      it "routes url-like ids" do
         skip "This works if you configure your routing to have very liberal constraints on :id.. not sure how to go about testing it though"
         expect(:get => solr_document_path(SolrDocument.new(:id => 'http://example.com'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'http://example.com')
       end
 
-      it "should route ids with whitespace" do
+      it "routes ids with whitespace" do
         expect(:get => solr_document_path(SolrDocument.new(:id => 'mm 123'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'mm 123')
       end
 
-      it "should route ids with a literal '+'" do
+      it "routes ids with a literal '+'" do
         expect(:get => solr_document_path(SolrDocument.new(:id => 'this+that'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'this+that')
       end
 
-      it "should route ids with a literal '/" do
+      it "routes ids with a literal '/" do
         skip "This works if you configure your routing to have very liberal constraints on :id.. not sure how to go about testing it though"
         expect(:get => solr_document_path(SolrDocument.new(:id => 'and/or'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'and/or')
       end

data/spec/spec_helper.rb

@@ -53,7 +53,12 @@ RSpec.configure do |config|
   # instead of true.
   config.use_transactional_fixtures = true
 
-  config.include Devise::TestHelpers, type: :controller
+  if Rails.version > '5'
+    # This is for an unreleased version of Devise (will either be 4.2 or 5.0)
+    config.include Devise::Test::ControllerHelpers, type: :controller
+  else
+    config.include Devise::TestHelpers, type: :controller
+  end
   config.infer_spec_type_from_file_location!
 
   config.include(ControllerLevelHelpers, type: :helper)
@@ -61,4 +66,8 @@ RSpec.configure do |config|
 
   config.include(ControllerLevelHelpers, type: :view)
   config.before(:each, type: :view) { initialize_controller_helpers(view) }
+
+  unless Rails.version > '5'
+    config.include BackportTest, type: :controller
+  end
 end

data/spec/support/backport_test.rb

@@ -0,0 +1,38 @@
+# Backport the Rails 5 controller test methods to Rails 4
+module BackportTest
+  def delete(*args)
+    (action, rest) = *args
+    rest ||= {}
+    if rest[:xhr]
+      @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
+    end
+    super(action, rest[:params])
+  end
+
+  def get(*args)
+    (action, rest) = *args
+    rest ||= {}
+    if rest[:xhr]
+      @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
+    end
+    super(action, rest[:params])
+  end
+
+  def post(*args)
+    (action, rest) = *args
+    rest ||= {}
+    if rest[:xhr]
+      @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
+    end
+    super(action, rest[:params])
+  end
+
+  def put(*args)
+    (action, rest) = *args
+    rest ||= {}
+    if rest[:xhr]
+      @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
+    end
+    super(action, rest[:params])
+  end
+end

data/spec/test_app_templates/Gemfile.extra

@@ -1,12 +1,4 @@
-
-if ENV['RAILS_VERSION'] =~ /^5\.0/ || ENV['RAILS_VERSION'] == 'edge'
-  gem 'rails-controller-testing', github: 'rails/rails-controller-testing'
-  gem 'rspec-mocks', github: 'rspec/rspec-mocks' # we need 3.5.0 to be released
-  gem 'rspec-expectations', github: 'rspec/rspec-expectations' # we need 3.5.0 to be released
-  gem 'rspec-support', github: 'rspec/rspec-support' # we need 3.5.0 to be released
-  gem 'rspec', github: 'rspec/rspec' # we need 3.5.0 to be released
-  gem 'rspec-core', github: 'rspec/rspec-core' # we need 3.5.0 to be released
-  gem 'rspec-rails', github: 'rspec/rspec-rails' # we need 3.5.0 to be released
-  gem 'kaminari', github: 'amatsuda/kaminari' # need > 0.16.3
+if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^5\.0/ || ENV['RAILS_VERSION'] == 'edge'
+  gem 'rails-controller-testing'
   gem 'deprecation', github: 'jcoyne/deprecation', branch: 'no_alias_method_chain'
 end