blacklight 7.15.2 → 7.18.0

data/lib/generators/blacklight/assets_generator.rb

@@ -68,11 +68,15 @@ module Blacklight
     private
 
     def turbolinks?
-      @turbolinks ||= IO.read("app/assets/javascripts/application.js").include?('turbolinks')
+      @turbolinks ||= application_js.include?('turbolinks')
     end
 
     def has_blacklight_assets?
-      IO.read("app/assets/javascripts/application.js").include?('blacklight/blacklight')
+      application_js.include?('blacklight/blacklight')
+    end
+
+    def application_js
+      IO.read(File.expand_path("app/assets/javascripts/application.js", destination_root))
     end
   end
 end

data/lib/generators/blacklight/user_generator.rb

@@ -47,7 +47,7 @@ module Blacklight
     # Add Blacklight to the user model
     def inject_blacklight_user_behavior
       file_path = "app/models/#{model_name.underscore}.rb"
-      if File.exist?(file_path)
+      if File.exist?(File.expand_path(file_path, destination_root))
         inject_into_class file_path, model_name.classify do
           "\n  # Connects this user object to Blacklights Bookmarks." \
           "\n  include Blacklight::User\n"

data/spec/components/blacklight/document_component_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::DocumentComponent, type: :component do
-  subject(:component) { described_class.new(document: document, **attr) }
+  subject(:component) { described_class.new(document: document, presenter: view_context.document_presenter(document), **attr) }
 
   let(:attr) { {} }
   let(:view_context) { controller.view_context }
@@ -47,7 +47,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     component.with(:embed, 'Embed')
     component.with(:metadata, 'Metadata')
     component.with(:thumbnail, 'Thumbnail')
-    component.with(:actions, 'Actions')
+    component.with(:actions) { 'Actions' }
 
     expect(rendered).to have_content 'Title'
     expect(rendered).to have_content 'Embed'
@@ -65,7 +65,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
 
   context 'with a provided body' do
     it 'opts-out of normal component content' do
-      component.with(:body, 'Body content')
+      component.with(:body) { 'Body content' }
 
       expect(rendered).to have_content 'Body content'
       expect(rendered).not_to have_selector 'header'

data/spec/helpers/blacklight/configuration_helper_behavior_spec.rb

@@ -33,9 +33,8 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
 
   describe "#default_document_index_view_type" do
     it "uses the first view with default set to true" do
-      blacklight_config.view.a
-      blacklight_config.view.b
-      blacklight_config.view.b.default = true
+      blacklight_config.view.a({})
+      blacklight_config.view.b(default: true)
       expect(helper.default_document_index_view_type).to eq :b
     end
 
@@ -48,8 +47,8 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
   describe "#document_index_views" do
     before do
       blacklight_config.view.abc = false
-      blacklight_config.view.def.if = false
-      blacklight_config.view.xyz.unless = true
+      blacklight_config.view.def(if: false)
+      blacklight_config.view.xyz(unless: true)
     end
 
     it "filters views using :if/:unless configuration" do
@@ -62,8 +61,8 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
 
   describe '#document_index_view_controls' do
     before do
-      blacklight_config.view.a
-      blacklight_config.view.b.display_control = false
+      blacklight_config.view.a({})
+      blacklight_config.view.b(display_control: false)
     end
 
     it "filters index views to those set to display controls" do

data/spec/helpers/blacklight_helper_spec.rb

@@ -127,7 +127,7 @@ RSpec.describe BlacklightHelper do
 
       it "renders view type specific actions" do
         allow(helper).to receive(:document_index_view_type).and_return(:custom)
-        config.view.custom.document_actions = []
+        config.view.custom(document_actions: [])
         expect(helper.render_index_doc_actions(document)).to be_blank
       end
     end
@@ -315,7 +315,7 @@ RSpec.describe BlacklightHelper do
     end
 
     it "ignores missing templates" do
-      blacklight_config.view.view_type.partials = %w[index_header a b]
+      blacklight_config.view.view_type(partials: %w[index_header a b])
 
       response = helper.render_document_index_with_view :view_type, [obj1, obj1]
       expect(response).to have_selector "div#documents"

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/configuration/view_config_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Blacklight::Configuration::ViewConfig do
   describe '#display_label' do
     it "looks up the label to display for the given document and field" do
       allow(I18n).to receive(:t).with(:"blacklight.search.view_title.my_view", default: [:"blacklight.search.view.my_view", label, nil, "My view"]).and_return('x')
-      expect(subject.display_label(key)).to eq 'x'
+      expect(subject.display_label).to eq 'x'
     end
   end
 end

data/spec/lib/blacklight/open_struct_with_hash_access_spec.rb

@@ -123,6 +123,18 @@ RSpec.describe Blacklight::OpenStructWithHashAccess do
     end
   end
 
+  describe '#reverse_merge' do
+    before do
+      @h = described_class.new
+      @h[:a] = 1
+      @h[:b] = 2
+    end
+
+    it 'reverse merges the object with the hash, preserving the object class' do
+      expect(@h.reverse_merge(b: 3, c: 4)).to have_attributes a: 1, b: 2, c: 4
+    end
+  end
+
   describe "#to_json" do
     subject { described_class.new a: 1, b: 2 }
 

data/spec/models/blacklight/configuration_spec.rb

@@ -557,4 +557,68 @@ RSpec.describe "Blacklight::Configuration", api: true do
       expect(config.facet_paginator_class).to eq Blacklight::Solr::FacetPaginator
     end
   end
+
+  describe '#view_config' do
+    before do
+      config.index.title_field = 'title_tsim'
+    end
+
+    context 'with a view that does not exist' do
+      it 'defaults to the index config' do
+        expect(config.view_config('this-doesnt-exist')).to have_attributes config.index.to_h
+      end
+    end
+
+    context 'with the :show view' do
+      it 'includes the show config' do
+        expect(config.view_config(:show)).to have_attributes config.show.to_h
+      end
+
+      it 'uses the show document presenter' do
+        expect(config.view_config(:show)).to have_attributes document_presenter_class: Blacklight::ShowPresenter
+      end
+
+      it 'includes index config defaults' do
+        expect(config.view_config(:show)).to have_attributes title_field: 'title_tsim'
+      end
+    end
+
+    context 'with just an action name' do
+      it 'includes the action config' do
+        expect(config.view_config(action_name: :show)).to have_attributes config.show.to_h
+      end
+
+      it 'includes the default action mapping configuration' do
+        config.action_mapping.default.whatever = :some_value
+
+        expect(config.view_config(action_name: :show)).to have_attributes whatever: :some_value
+      end
+
+      it 'includes the action-specific mappings' do
+        config.action_mapping.foo.document_presenter_class = Blacklight::DocumentPresenter
+
+        expect(config.view_config(action_name: :foo)).to have_attributes config.action_mapping.foo.to_h
+      end
+
+      it 'allows the action mapping to specific a parent configuration with some more defaults' do
+        config.action_mapping.foo.parent_config = :bar
+        config.action_mapping.bar.whatever = :bar_value
+
+        expect(config.view_config(action_name: :foo)).to have_attributes whatever: :bar_value
+      end
+
+      context 'with the :citation action' do
+        it 'also includes the show config' do
+          expect(config.view_config(action_name: :citation)).to have_attributes config.show.to_h
+        end
+      end
+    end
+
+    context 'with a view' do
+      it 'includes the configuration-level view parameters' do
+        expect(config.view_config(:atom)).to have_attributes config.index.to_h.except(:partials)
+        expect(config.view_config(:atom)).to have_attributes partials: [:document]
+      end
+    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