blacklight 7.3.0 → 7.4.0

data/lib/blacklight/configuration.rb

@@ -357,16 +357,28 @@ module Blacklight
     ##
     # Return a list of fields for the index display that should be used for the
     # provided document.  This respects any configuration made using for_display_type
-    def index_fields_for(document)
-      display_type = document.first(index.display_type_field)
+    def index_fields_for(document_or_display_type)
+      display_type = if document_or_display_type.is_a? Blacklight::Document
+                       Deprecation.warn self, "Calling index_fields_for with a #{document_or_display_type.class} is deprecated and will be removed in Blacklight 8. Pass the display type instead."
+                       document_or_display_type.first(index.display_type_field)
+                     else
+                       document_or_display_type
+                     end
+
       for_display_type(display_type).index_fields.merge(index_fields)
     end
 
     ##
     # Return a list of fields for the show page that should be used for the
     # provided document.  This respects any configuration made using for_display_type
-    def show_fields_for(document)
-      display_type = document.first(show.display_type_field)
+    def show_fields_for(document_or_display_type)
+      display_type = if document_or_display_type.is_a? Blacklight::Document
+                       Deprecation.warn self, "Calling show_fields_for with a #{document_or_display_type.class} is deprecated and will be removed in Blacklight 8. Pass the display type instead."
+                       document_or_display_type.first(show.display_type_field)
+                     else
+                       document_or_display_type
+                     end
+
       for_display_type(display_type).show_fields.merge(show_fields)
     end
 

data/spec/features/search_spec.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 RSpec.describe "Search Page" do
+  it 'declares the page language in the html lang attribute' do
+    visit root_path
+    expect(page).to have_selector('html[lang=en]')
+  end
+
   it "shows welcome" do
     visit root_path
     expect(page).to have_selector("input#q")

data/spec/helpers/blacklight/configuration_helper_behavior_spec.rb

@@ -103,6 +103,10 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
   describe "#document_show_link_field" do
     let(:document) { SolrDocument.new id: 123, a: 1, b: 2, c: 3 }
 
+    before do
+      allow(Deprecation).to receive(:warn)
+    end
+
     it "allows single values" do
       blacklight_config.index.title_field = :a
       f = helper.document_show_link_field document

data/spec/helpers/blacklight/layout_helper_behavior_spec.rb

@@ -35,4 +35,14 @@ RSpec.describe Blacklight::LayoutHelperBehavior do
       expect(helper.container_classes).to eq 'container'
     end
   end
+
+  describe '#html_tag_attributes' do
+    before do
+      allow(I18n).to receive(:locale).and_return('x')
+    end
+
+    it 'returns the current locale as the lang' do
+      expect(helper.html_tag_attributes).to include lang: 'x'
+    end
+  end
 end

data/spec/helpers/blacklight/url_helper_behavior_spec.rb

@@ -206,7 +206,7 @@ RSpec.describe Blacklight::UrlHelperBehavior do
     end
 
     it "consists of the document title wrapped in a <a>" do
-      expect(Deprecation).to receive(:warn)
+      allow(Deprecation).to receive(:warn)
       expect(helper.link_to_document(document, :title_tsim)).to have_selector("a", text: '654321', count: 1)
     end
 
@@ -215,7 +215,7 @@ RSpec.describe Blacklight::UrlHelperBehavior do
     end
 
     it "accepts and returns a Proc" do
-      expect(Deprecation).to receive(:warn).twice
+      allow(Deprecation).to receive(:warn)
       expect(helper.link_to_document(document, proc { |doc, _opts| doc[:id] + ": " + doc.first(:title_tsim) })).to have_selector("a", text: '123456: 654321', count: 1)
     end
 
@@ -223,12 +223,12 @@ RSpec.describe Blacklight::UrlHelperBehavior do
       let(:data) { { 'id' => id } }
 
       it "returns id" do
-        expect(Deprecation).to receive(:warn)
+        allow(Deprecation).to receive(:warn)
         expect(helper.link_to_document(document, :title_tsim)).to have_selector("a", text: '123456', count: 1)
       end
 
       it "is html safe" do
-        expect(Deprecation).to receive(:warn)
+        allow(Deprecation).to receive(:warn)
         expect(helper.link_to_document(document, :title_tsim)).to be_html_safe
       end
 
@@ -250,7 +250,7 @@ RSpec.describe Blacklight::UrlHelperBehavior do
     end
 
     it "converts the counter parameter into a data- attribute" do
-      expect(Deprecation).to receive(:warn)
+      allow(Deprecation).to receive(:warn)
       expect(helper.link_to_document(document, :title_tsim, counter: 5)).to include 'data-context-href="tracking url"'
       expect(helper.main_app).to have_received(:track_test_path).with(hash_including(id: have_attributes(id: '123456'), counter: 5))
     end

data/spec/helpers/catalog_helper_spec.rb

@@ -46,6 +46,15 @@ RSpec.describe CatalogHelper do
       expect(html).to be_blank
     end
 
+    context "when response.entry_name is nil" do
+      it "does not raise an error" do
+        collection = mock_response total: 10
+        allow(collection).to receive(:entry_name).and_return(nil)
+
+        expect { page_entries_info(collection) }.not_to raise_error
+      end
+    end
+
     describe "with a single result" do
       it "uses the provided entry name" do
         response = mock_response total: 1

data/spec/models/blacklight/configuration_spec.rb

@@ -87,16 +87,38 @@ RSpec.describe "Blacklight::Configuration", api: true do
     let(:image) { SolrDocument.new(format: 'Image') }
     let(:sound) { SolrDocument.new(format: 'Sound') }
 
+    context 'with deprecated behavior' do
+      before do
+        allow(Deprecation).to receive(:warn)
+      end
+
+      it 'accepts documents as an argument to index_fields_for' do
+        config.for_display_type "Image" do |c|
+          c.add_index_field :dimensions
+        end
+        config.add_index_field :title
+        expect(config.index_fields_for(image)).to have_key 'dimensions'
+      end
+
+      it 'accepts documents as an argument to show_fields_for' do
+        config.for_display_type "Image" do |c|
+          c.add_show_field :dimensions
+        end
+        config.add_show_field :title
+        expect(config.show_fields_for(image)).to have_key 'dimensions'
+      end
+    end
+
     it "adds index fields just for a certain type" do
       config.for_display_type "Image" do |c|
         c.add_index_field :dimensions
       end
       config.add_index_field :title
 
-      expect(config.index_fields_for(image)).to have_key 'dimensions'
-      expect(config.index_fields_for(image)).to have_key 'title'
-      expect(config.index_fields_for(sound)).not_to have_key 'dimensions'
-      expect(config.index_fields_for(image)).to have_key 'title'
+      expect(config.index_fields_for('Image')).to have_key 'dimensions'
+      expect(config.index_fields_for('Image')).to have_key 'title'
+      expect(config.index_fields_for('Sound')).not_to have_key 'dimensions'
+      expect(config.index_fields_for('Image')).to have_key 'title'
       expect(config.index_fields).not_to have_key 'dimensions'
     end
 
@@ -106,10 +128,10 @@ RSpec.describe "Blacklight::Configuration", api: true do
       end
       config.add_show_field :title
 
-      expect(config.show_fields_for(image)).to have_key 'dimensions'
-      expect(config.show_fields_for(image)).to have_key 'title'
-      expect(config.show_fields_for(sound)).not_to have_key 'dimensions'
-      expect(config.show_fields_for(image)).to have_key 'title'
+      expect(config.show_fields_for('Image')).to have_key 'dimensions'
+      expect(config.show_fields_for('Image')).to have_key 'title'
+      expect(config.show_fields_for('Sound')).not_to have_key 'dimensions'
+      expect(config.show_fields_for('Image')).to have_key 'title'
       expect(config.show_fields).not_to have_key 'dimensions'
     end
 
@@ -121,8 +143,8 @@ RSpec.describe "Blacklight::Configuration", api: true do
         c.add_show_field :photographer
       end
 
-      expect(config.show_fields_for(image)).to have_key 'dimensions'
-      expect(config.show_fields_for(image)).to have_key 'photographer'
+      expect(config.show_fields_for('Image')).to have_key 'dimensions'
+      expect(config.show_fields_for('Image')).to have_key 'photographer'
     end
   end
 

data/spec/presenters/blacklight/document_presenter_spec.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::DocumentPresenter do
-  let(:presenter) { described_class.new }
+  let(:presenter) { described_class.new(doc, view_context) }
   let(:doc) { instance_double(SolrDocument) }
-  let(:view_context) { double('View context', should_render_field?: true) }
-
-  before do
-    allow(presenter).to receive(:document).and_return(doc)
-    allow(presenter).to receive(:view_context).and_return(view_context)
-  end
+  let(:blacklight_config) { instance_double(Blacklight::Configuration) }
+  let(:view_context) { double('View context', should_render_field?: true, blacklight_config: blacklight_config) }
 
   describe '#fields_to_render' do
     subject { presenter.fields_to_render }
@@ -38,7 +34,7 @@ RSpec.describe Blacklight::DocumentPresenter do
     it { is_expected.to be true }
 
     context 'when the view context says not to render the field' do
-      let(:view_context) { double('View context', should_render_field?: false) }
+      let(:view_context) { double('View context', should_render_field?: false, blacklight_config: blacklight_config) }
 
       before do
         allow(field_config).to receive_messages(if: false)
@@ -52,10 +48,10 @@ RSpec.describe Blacklight::DocumentPresenter do
     subject { presenter.send(:has_value?, field_config) }
 
     context 'when the document has the field value' do
-      let(:field_config) { double(field: 'asdf') }
+      let(:field_config) { double(field: 'asdf', highlight: false, accessor: nil, default: nil, values: nil) }
 
       before do
-        allow(doc).to receive(:has?).with('asdf').and_return(true)
+        allow(doc).to receive(:fetch).with('asdf', nil).and_return(['value'])
       end
 
       it { is_expected.to be true }
@@ -66,18 +62,17 @@ RSpec.describe Blacklight::DocumentPresenter do
 
       before do
         allow(doc).to receive(:has_highlight_field?).with('asdf').and_return(true)
-        allow(doc).to receive(:has?).with('asdf').and_return(true)
+        allow(doc).to receive(:highlight_field).with('asdf').and_return(['value'])
       end
 
       it { is_expected.to be true }
     end
 
     context 'when the field is a model accessor' do
-      let(:field_config) { double(field: 'asdf', highlight: true, accessor: true) }
+      let(:field_config) { double(field: 'asdf', highlight: false, accessor: true) }
 
       before do
-        allow(doc).to receive(:has_highlight_field?).with('asdf').and_return(true)
-        allow(doc).to receive(:has?).with('asdf').and_return(true)
+        allow(doc).to receive(:send).with('asdf').and_return(['value'])
       end
 
       it { is_expected.to be true }

data/spec/presenters/blacklight/show_presenter_spec.rb

@@ -122,6 +122,7 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
         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_values', values: ->(_config, _doc) { ['some-value'] }
       end
     end
 
@@ -248,6 +249,14 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
         expect(subject).to eq '123'
       end
     end
+
+    context 'when the values lambda is provided' do
+      let(:field_name) { 'explicit_values' }
+
+      it 'calls the accessors on the return of the preceeding' do
+        expect(subject).to eq 'some-value'
+      end
+    end
   end
 
   describe '#fields' do
@@ -271,17 +280,21 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
     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")
+      allow(document).to receive(:fetch).with(:x, nil).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")
+      allow(document).to receive(:fetch).with(:x, nil).and_return(nil)
+      allow(document).to receive(:fetch).with(:y, nil).and_return("value")
       expect(subject.heading).to eq "value"
     end
+
+    it "can use explicit field configuration" do
+      config.show.title_field = Blacklight::Configuration::Field.new(field: 'x', values: ->(*_) { 'hardcoded' })
+      expect(subject.heading).to eq 'hardcoded'
+    end
   end
 
   describe "#html_title" do
@@ -299,11 +312,15 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
 
     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(:x, nil).and_return(nil)
       allow(document).to receive(:fetch).with(:y, nil).and_return("value")
       expect(subject.html_title).to eq "value"
     end
+
+    it "can use explicit field configuration" do
+      config.show.html_title_field = Blacklight::Configuration::Field.new(field: 'x', values: ->(*_) { 'hardcoded' })
+      expect(subject.html_title).to eq 'hardcoded'
+    end
   end
 
   describe '#field_values' do

data/spec/presenters/thumbnail_presenter_spec.rb

@@ -105,14 +105,13 @@ RSpec.describe Blacklight::ThumbnailPresenter do
       end
 
       it "creates an image tag from the given field" do
-        allow(document).to receive(:first).with(:xyz).and_return("http://example.com/some.jpg")
+        allow(document).to receive(:fetch).with(:xyz, nil).and_return("http://example.com/some.jpg")
         allow(view_context).to receive(:image_tag).with("http://example.com/some.jpg", {}).and_return('<img src="image.jpg">')
         expect(view_context).to receive(:link_to_document).with(document, '<img src="image.jpg">', {})
         subject
       end
 
       it "returns nil if no thumbnail is in the document" do
-        allow(document).to receive(:first).with(:xyz).and_return(nil)
         expect(subject).to be_nil
       end
     end

data/spec/views/catalog/_facet_layout.html.erb_spec.rb

@@ -27,14 +27,15 @@ RSpec.describe "catalog/facet_layout" do
 
   it "is collapsable" do
     render partial: 'catalog/facet_layout', locals: { facet_field: facet_field }
-    expect(rendered).to have_selector 'button.collapsed'
+    expect(rendered).to have_selector 'button[data-toggle="collapse"][aria-expanded="false"]'
     expect(rendered).to have_selector '.collapse .card-body'
   end
 
   it "is configured to be open by default" do
     allow(facet_field).to receive_messages(collapse: false)
     render partial: 'catalog/facet_layout', locals: { facet_field: facet_field }
+    expect(rendered).to have_selector 'button[data-toggle="collapse"][aria-expanded="true"]'
     expect(rendered).not_to have_selector '.card-header.collapsed'
-    expect(rendered).to have_selector '.show .card-body'
+    expect(rendered).to have_selector '.collapse.show .card-body'
   end
 end

data/spec/views/catalog/index.html.erb_spec.rb

@@ -23,7 +23,7 @@ RSpec.describe "catalog/index.html.erb" do
       stub_template "catalog/_search_header.html.erb" => "header_content"
       allow(view).to receive(:blacklight_config).and_return(Blacklight::Configuration.new)
       allow(view).to receive(:render_opensearch_response_metadata).and_return("")
-      assign(:response, instance_double(Blacklight::Solr::Response, empty?: true))
+      @response = instance_double(Blacklight::Solr::Response, empty?: true, total: 11, start: 1, limit_value: 10)
     end
 
     it "renders the search_header partial" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.3.0
+  version: 7.4.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-30 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -503,6 +503,7 @@ files:
 - app/views/shared/_user_util_links.html.erb
 - blacklight.gemspec
 - config/i18n-tasks.yml
+- config/locales/blacklight.ar.yml
 - config/locales/blacklight.de.yml
 - config/locales/blacklight.en.yml
 - config/locales/blacklight.es.yml