blacklight 7.16.0 → 7.18.1

data/spec/helpers/catalog_helper_spec.rb

@@ -323,7 +323,7 @@ RSpec.describe CatalogHelper do
 
     it "supports view-specific field configuration" do
       allow(helper).to receive(:document_index_view_type).and_return(:some_view_type)
-      blacklight_config.view.some_view_type.display_type_field = :other_type
+      blacklight_config.view.some_view_type(display_type_field: :other_type)
       doc = { other_type: "document" }
       expect(helper.render_document_class(doc)).to eq "blacklight-document"
     end

data/spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb

@@ -23,4 +23,18 @@ RSpec.describe Blacklight::NestedOpenStructWithHashAccess do
       expect(subject.blah).to have_attributes(key: :blah)
     end
   end
+
+  describe 'adding new parameters' do
+    subject { described_class.new(Blacklight::Configuration::Field) }
+
+    it 'strips the trailing !' do
+      subject.blaH!
+      expect(subject.blah).to have_attributes(key: :blah)
+    end
+
+    it 'supports direct assignment' do
+      subject.blah = '123'
+      expect(subject.blah).to eq '123'
+    end
+  end
 end

data/spec/models/blacklight/solr/facet_paginator_spec.rb

@@ -20,5 +20,9 @@ RSpec.describe Blacklight::Solr::FacetPaginator, api: true do
     it 'defaults to "index" if no limit is given' do
       expect(described_class.new([]).sort).to eq 'index'
     end
+
+    it 'handles json facet api-style parameter sorts' do
+      expect(described_class.new([], sort: { count: :desc }).sort).to eq 'count'
+    end
   end
 end

data/spec/models/blacklight/solr/request_spec.rb

@@ -1,36 +1,69 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::Solr::Request, api: true do
-  before do
-    subject[:qt] = 'hey'
-    subject[:fq] = ["what's up.", "dood"]
-    subject['q'] = "what's"
-    subject[:wt] = "going"
-    subject[:start] = "on"
-    subject[:rows] = "Man"
-    subject['hl'] = "I"
-    subject['hl.fl'] = "wish"
-    subject['group'] = "I"
-    subject['defType'] = "had"
-    subject['spellcheck'] = "a"
-    subject['spellcheck.q'] = "fleece"
-    subject['f.title_facet.facet.limit'] = "vest"
-    subject['facet.field'] = []
+  context 'with some solr parameter keys' do
+    before do
+      subject[:qt] = 'hey'
+      subject[:fq] = ["what's up.", "dood"]
+      subject['q'] = "what's"
+      subject[:wt] = "going"
+      subject[:start] = "on"
+      subject[:rows] = "Man"
+      subject['hl'] = "I"
+      subject['hl.fl'] = "wish"
+      subject['group'] = "I"
+      subject['defType'] = "had"
+      subject['spellcheck'] = "a"
+      subject['spellcheck.q'] = "fleece"
+      subject['f.title_facet.facet.limit'] = "vest"
+      subject['facet.field'] = []
+    end
+
+    it "accepts valid parameters" do
+      expect(subject.to_hash).to eq("defType" => "had",
+                                    "f.title_facet.facet.limit" => "vest",
+                                    "fq" => ["what's up.", "dood"],
+                                    "group" => "I",
+                                    "hl" => "I",
+                                    "hl.fl" => "wish",
+                                    "q" => "what's",
+                                    "qt" => "hey",
+                                    "rows" => "Man",
+                                    "spellcheck" => "a",
+                                    "spellcheck.q" => "fleece",
+                                    "start" => "on",
+                                    "wt" => "going")
+    end
+  end
+
+  describe '#append_query' do
+    it 'populates the q parameter' do
+      subject.append_query 'this is my query'
+      expect(subject['q']).to eq 'this is my query'
+    end
+
+    it 'handles multiple queries by converting it to a boolean query' do
+      subject.append_query 'this is my query'
+      subject.append_query 'another:query'
+      expect(subject).not_to have_key 'q'
+      expect(subject.dig('json', 'query', 'bool', 'must')).to match_array ['this is my query', 'another:query']
+    end
   end
 
-  it "accepts valid parameters" do
-    expect(subject.to_hash).to eq("defType" => "had",
-                                  "f.title_facet.facet.limit" => "vest",
-                                  "fq" => ["what's up.", "dood"],
-                                  "group" => "I",
-                                  "hl" => "I",
-                                  "hl.fl" => "wish",
-                                  "q" => "what's",
-                                  "qt" => "hey",
-                                  "rows" => "Man",
-                                  "spellcheck" => "a",
-                                  "spellcheck.q" => "fleece",
-                                  "start" => "on",
-                                  "wt" => "going")
+  describe '#append_boolean_query' do
+    it 'populates the boolean query with the queries' do
+      subject.append_boolean_query :must, 'required'
+      subject.append_boolean_query :should, 'optional'
+      subject.append_boolean_query :should, 'also optional'
+
+      expect(subject.dig('json', 'query', 'bool')).to include should: ['optional', 'also optional'], must: ['required']
+    end
+
+    it 'converts existing q parameters to a boolean query' do
+      subject['q'] = 'some query'
+      subject.append_boolean_query :must, 'also required'
+
+      expect(subject.dig('json', 'query', 'bool', 'must')).to match_array ['some query', 'also required']
+    end
   end
 end

data/spec/models/blacklight/solr/response/facets_spec.rb

@@ -160,6 +160,12 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
       expect(missing.label).to eq "[Missing]"
       expect(missing.fq).to eq "-some_field:[* TO *]"
     end
+
+    it 'extracts the missing field data to a separate facet field attribute' do
+      missing = subject.aggregations["some_field"].missing
+
+      expect(missing).to have_attributes(label: '[Missing]', hits: 2)
+    end
   end
 
   describe "query facets" do
@@ -278,4 +284,107 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
       expect(field.items.first.items.first.fq).to eq('field_a' => 'a')
     end
   end
+
+  describe 'json facets' do
+    subject { Blacklight::Solr::Response.new(response, {}, blacklight_config: blacklight_config) }
+
+    let(:response) do
+      {
+        facets: {
+          "count": 32,
+          "categories": {
+            "buckets": [
+              {
+                "val": "electronics",
+                "count": 12,
+                "max_price": 60
+              },
+              {
+                "val": "currency",
+                "count": 4
+              },
+              {
+                "val": "memory",
+                "count": 3
+              }
+            ]
+          }
+        }
+      }
+    end
+    let(:facet_config) do
+      Blacklight::Configuration::FacetField.new(key: 'categories', json: true, query: false)
+    end
+
+    let(:blacklight_config) { double(facet_fields: { 'categories' => facet_config }) }
+    let(:field) { subject.aggregations['categories'] }
+
+    it 'has access to the original response data' do
+      expect(field.data).to include 'buckets'
+    end
+
+    it 'converts buckets into facet items' do
+      expect(field.items.length).to eq 3
+    end
+
+    context 'with nested buckets' do
+      let(:response) do
+        {
+          facets: {
+            "categories": {
+              "buckets": [
+                {
+                  "val": "electronics",
+                  "count": 12,
+                  "top_manufacturer": {
+                    "buckets": [{
+                      "val": "corsair",
+                      "count": 3
+                    }]
+                  }
+                },
+                {
+                  "val": "currency",
+                  "count": 4,
+                  "top_manufacturer": {
+                    "buckets": [{
+                      "val": "boa",
+                      "count": 1
+                    }]
+                  }
+                }
+              ]
+            }
+          }
+        }
+      end
+
+      it 'converts nested buckets into pivot facets' do
+        expect(field.items.first).to have_attributes hits: 12
+        expect(field.items.first.items.first).to have_attributes field: 'top_manufacturer', value: 'corsair', hits: 3, fq: { "categories" => "electronics" }
+      end
+    end
+
+    context 'with missing values' do
+      let(:response) do
+        {
+          facets: {
+            "categories": {
+              "missing" => { "count" => 13 },
+              "buckets" => [{ "val" => "India", "count" => 2 }, { "val" => "Iran", "count" => 2 }]
+            }
+          }
+        }
+      end
+
+      it 'converts "missing" facet data into a missing facet item' do
+        expect(field.items.length).to eq 2
+        expect(field.missing).to have_attributes(hits: 13)
+      end
+    end
+
+    it 'exposes any extra query function results' do
+      expect(field.items.first.data).to include 'max_price' => 60
+    end
+  end
 end

data/spec/models/blacklight/solr/response_spec.rb

@@ -120,6 +120,16 @@ RSpec.describe Blacklight::Solr::Response, api: true do
     expect(r.params['test']).to eq :test
   end
 
+  it 'extracts json params' do
+    raw_response = eval(mock_query_response)
+    raw_response['responseHeader']['params']['test'] = 'from query'
+    raw_response['responseHeader']['params'].delete('rows')
+    raw_response['responseHeader']['params']['json'] = { limit: 5, params: { test: 'from json params' } }.to_json
+    r = described_class.new(raw_response, raw_response['params'])
+    expect(r.params['test']).to eq 'from query'
+    expect(r.rows).to eq 5
+  end
+
   it 'provides the solr-returned params and "rows" should be 11' do
     raw_response = eval(mock_query_response)
     r = described_class.new(raw_response, {})

data/spec/models/blacklight/solr/search_builder_spec.rb

@@ -259,6 +259,23 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       end
     end
 
+    describe 'with a json facet' do
+      let(:user_params) { { f: { json_facet: ['value'] } }.with_indifferent_access }
+
+      before do
+        blacklight_config.add_facet_field 'json_facet', field: 'foo', json: { bar: 'baz' }
+      end
+
+      it "has proper solr parameters" do
+        expect(subject[:fq]).to include('{!term f=foo}value')
+        expect(subject.dig(:json, :facet, 'json_facet')).to include(
+          field: 'foo',
+          type: 'terms',
+          bar: 'baz'
+        )
+      end
+    end
+
     describe 'with multi-valued facets' do
       let(:user_params) { { f_inclusive: { format: %w[Book Movie CD] } } }
 
@@ -783,4 +800,13 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       expect(subject.to_hash.with_indifferent_access.dig(:json, :query, :bool, :must, 1, :edismax, :qf)).to eq '${author_qf}'
     end
   end
+
+  describe '#where' do
+    let(:user_params) { {} }
+
+    it 'adds additional query filters on the search' do
+      subject.where(id: [1, 2, 3])
+      expect(subject.to_hash).to include q: '{!lucene}id:(1 OR 2 OR 3)'
+    end
+  end
 end

data/spec/services/blacklight/search_service_spec.rb

@@ -477,7 +477,7 @@ RSpec.describe Blacklight::SearchService, api: true do
     end
 
     before do
-      blacklight_config.view.opensearch.title_field = :field
+      blacklight_config.view.opensearch(title_field: :field)
       allow(repository).to receive(:search).and_return(mock_response)
     end
 

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

@@ -3,7 +3,7 @@
 RSpec.describe "catalog/constraints" do
   let :blacklight_config do
     Blacklight::Configuration.new do |config|
-      config.view.xyz
+      config.view.xyz({})
     end
   end
 

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

@@ -3,13 +3,9 @@
 RSpec.describe "catalog/_view_type_group" do
   let(:blacklight_config) { Blacklight::Configuration.new }
   let(:response) { instance_double(Blacklight::Solr::Response, empty?: false) }
-  let(:icon_instance) { instance_double(Blacklight::Icon) }
 
   before do
     allow(view).to receive(:view_label), &:to_s
-    allow(Blacklight::Icon).to receive(:new).and_return icon_instance
-    allow(icon_instance).to receive(:svg).and_return '<svg></svg>'
-    allow(icon_instance).to receive(:options).and_return({})
     allow(view).to receive_messages(how_sort_and_per_page?: true, blacklight_config: blacklight_config)
     controller.request.path_parameters[:action] = 'index'
     assign(:response, response)
@@ -24,13 +20,16 @@ RSpec.describe "catalog/_view_type_group" do
   it "displays the group" do
     blacklight_config.configure do |config|
       config.view.delete(:list)
-      config.view.a
-      config.view.b
-      config.view.c
+      config.view.a(icon: :list)
+      config.view.b(icon: :list)
+      config.view.c(icon: :list)
     end
     render partial: 'catalog/view_type_group'
     expect(rendered).to have_selector('.btn-group.view-type-group')
     expect(rendered).to have_selector('.view-type-a', text: 'a')
+    within '.view-type-a' do
+      expect(rendered).to have_selector 'svg'
+    end
     expect(rendered).to have_selector('.view-type-b', text: 'b')
     expect(rendered).to have_selector('.view-type-c', text: 'c')
   end
@@ -38,8 +37,8 @@ RSpec.describe "catalog/_view_type_group" do
   it "sets the current view to 'active'" do
     blacklight_config.configure do |config|
       config.view.delete(:list)
-      config.view.a
-      config.view.b
+      config.view.a(icon: :list)
+      config.view.b(icon: :list)
     end
     render partial: 'catalog/view_type_group'
     expect(rendered).to have_selector('.active', text: 'a')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.16.0
+  version: 7.18.1
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -14,10 +14,10 @@ authors:
 - Dan Funk
 - Naomi Dushay
 - Justin Coyne
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -129,14 +129,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.23.0
+        version: 2.28.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.23.0
+        version: 2.28.0
 - !ruby/object:Gem::Dependency
   name: rsolr
   requirement: !ruby/object:Gem::Requirement
@@ -402,6 +402,7 @@ files:
 - app/components/blacklight/constraint_layout_component.rb
 - app/components/blacklight/constraints_component.html.erb
 - app/components/blacklight/constraints_component.rb
+- app/components/blacklight/content_areas_shim.rb
 - app/components/blacklight/document/action_component.html.erb
 - app/components/blacklight/document/action_component.rb
 - app/components/blacklight/document/actions_component.html.erb
@@ -420,6 +421,8 @@ files:
 - app/components/blacklight/document_component.rb
 - app/components/blacklight/document_metadata_component.html.erb
 - app/components/blacklight/document_metadata_component.rb
+- app/components/blacklight/document_title_component.html.erb
+- app/components/blacklight/document_title_component.rb
 - app/components/blacklight/facet_field_checkboxes_component.html.erb
 - app/components/blacklight/facet_field_checkboxes_component.rb
 - app/components/blacklight/facet_field_component.html.erb
@@ -448,6 +451,8 @@ files:
 - app/components/blacklight/response/sort_component.rb
 - app/components/blacklight/response/spellcheck_component.html.erb
 - app/components/blacklight/response/spellcheck_component.rb
+- app/components/blacklight/response/view_type_button_component.html.erb
+- app/components/blacklight/response/view_type_button_component.rb
 - app/components/blacklight/response/view_type_component.html.erb
 - app/components/blacklight/response/view_type_component.rb
 - app/components/blacklight/search_bar_component.html.erb
@@ -691,6 +696,7 @@ files:
 - lib/blacklight/solr/response/group_response.rb
 - lib/blacklight/solr/response/more_like_this.rb
 - lib/blacklight/solr/response/pagination_methods.rb
+- lib/blacklight/solr/response/params.rb
 - lib/blacklight/solr/response/response.rb
 - lib/blacklight/solr/response/spelling.rb
 - lib/blacklight/solr/search_builder_behavior.rb
@@ -881,7 +887,7 @@ homepage: http://projectblacklight.org/
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -896,8 +902,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
   index.