blacklight 7.10.0 → 7.11.1

data/lib/blacklight/search_state.rb

@@ -16,24 +16,38 @@ module Blacklight
     # @param [Blacklight::Config] blacklight_config
     # @param [ApplicationController] controller used for the routing helpers
     def initialize(params, blacklight_config, controller = nil)
+      @params = self.class.normalize_params(params)
+      @blacklight_config = blacklight_config
+      @controller = controller
+    end
+
+    def self.normalize_params(untrusted_params = {})
+      params = untrusted_params
+
       if params.respond_to?(:to_unsafe_h)
         # This is the typical (not-ActionView::TestCase) code path.
-        @params = params.to_unsafe_h
+        params = params.to_unsafe_h
         # In Rails 5 to_unsafe_h returns a HashWithIndifferentAccess, in Rails 4 it returns Hash
-        @params = @params.with_indifferent_access if @params.instance_of? Hash
+        params = params.with_indifferent_access if params.instance_of? Hash
       elsif params.is_a? Hash
         # This is an ActionView::TestCase workaround for Rails 4.2.
-        @params = params.dup.with_indifferent_access
+        params = params.dup.with_indifferent_access
       else
-        @params = params.dup.to_h.with_indifferent_access
+        params = params.dup.to_h.with_indifferent_access
       end
 
-      @blacklight_config = blacklight_config
-      @controller = controller
+      # Normalize facet parameters mangled by facebook
+      if params[:f].is_a?(Hash) && params[:f].values.any? { |x| x.is_a?(Hash) }
+        params[:f] = params[:f].transform_values do |value|
+          value.is_a?(Hash) ? value.values : value
+        end
+      end
+
+      params
     end
 
     def to_hash
-      @params
+      @params.deep_dup
     end
     alias to_h to_hash
 

data/lib/blacklight/solr/response.rb

@@ -19,6 +19,7 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
 
   attr_reader :request_params
   attr_accessor :blacklight_config, :options
+
   delegate :document_factory, to: :blacklight_config
 
   def initialize(data, request_params, options = {})

data/lib/blacklight/solr/response/facets.rb

@@ -29,6 +29,7 @@ module Blacklight::Solr::Response::Facets
   # represents a facet; which is a field and its values
   class FacetField
     attr_reader :name, :items
+
     def initialize name, items, options = {}
       @name = name
       @items = items
@@ -138,14 +139,14 @@ module Blacklight::Solr::Response::Facets
     if solr_list.values.first.is_a? Hash
       solr_list
     else
-      solr_list.each_with_object({}) do |(key, values), hash|
-        hash[key] = if values.first.is_a? Array
-                      # arrarr
-                      Hash[values]
-                    else
-                      # flat
-                      Hash[values.each_slice(2).to_a]
-                    end
+      solr_list.transform_values do |values|
+        if values.first.is_a? Array
+          # arrarr
+          Hash[values]
+        else
+          # flat
+          Hash[values.each_slice(2).to_a]
+        end
       end
     end
   end

data/lib/generators/blacklight/models_generator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'rails/generators'
 require 'rails/generators/migration'
+require 'blacklight/version'
 
 module Blacklight
   class ModelsGenerator < Rails::Generators::Base
@@ -17,6 +18,7 @@ module Blacklight
     # Copy all files in templates/config directory to host config
     def create_configuration_files
       copy_file "config/blacklight.yml", "config/blacklight.yml"
+      gsub_file 'config/blacklight.yml', '__VERSION__', Blacklight::VERSION
     end
 
     # Setup the database migrations

data/lib/generators/blacklight/templates/config/blacklight.yml

@@ -1,3 +1,4 @@
+load_defaults: __VERSION__
 development:
   adapter: solr
   url: <%= ENV['SOLR_URL'] || "http://127.0.0.1:8983/solr/blacklight-core" %>

data/lib/railties/blacklight.rake

@@ -12,11 +12,18 @@ namespace :blacklight do
   end
 
   namespace :index do
-    desc "Put sample data into solr"
-    task seed: [:environment]  do
+    desc <<-EODESC.gsub(/\n\s*/, ' ')
+      Index sample data (from FILE, ./spec/fixtures/sample_solr_documents.yml in this application,
+        or the test fixtures from blacklight) into solr.
+    EODESC
+    task seed: [:environment] do
       require 'yaml'
 
-      docs = YAML.safe_load(File.open(File.join(Blacklight.root, 'spec', 'fixtures', 'sample_solr_documents.yml')))
+      app_file = Rails.root && Rails.root + 'spec/fixtures/sample_solr_documents.yml'
+      file = ENV['FILE'] ||
+             (app_file && File.exist?(app_file) && app_file) ||
+             File.join(Blacklight.root, 'spec', 'fixtures', 'sample_solr_documents.yml')
+      docs = YAML.safe_load(File.open(file))
       conn = Blacklight.default_index.connection
       conn.add docs
       conn.commit
@@ -26,18 +33,16 @@ namespace :blacklight do
   namespace :check do
     desc "Check the Solr connection and controller configuration"
     task :solr, [:controller_name] => [:environment] do
-      begin
-        conn = Blacklight.default_index
-        if conn.ping
-          puts "OK"
-        else
-          puts "Unable to reach: #{conn.uri}"
-          exit 1
-        end
-      rescue => e
-        puts e.to_s
+      conn = Blacklight.default_index
+      if conn.ping
+        puts "OK"
+      else
+        puts "Unable to reach: #{conn.uri}"
         exit 1
       end
+    rescue => e
+      puts e.to_s
+      exit 1
     end
 
     task :controller, [:controller_name] => [:environment] do |_, args|

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "7.7.0",
+  "version": "7.10.0",
   "description": "[![Build Status](https://travis-ci.org/projectblacklight/blacklight.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=master)](https://coveralls.io/github/projectblacklight/blacklight?branch=master)",
   "main": "app/assets/javascripts/blacklight",
   "scripts": {

data/spec/components/blacklight/constraint_layout_component_spec.rb

@@ -36,6 +36,7 @@ RSpec.describe Blacklight::ConstraintLayoutComponent, type: :component do
         expect(s).to have_selector(".remove[href='http://remove']")
       end
     end
+
     it "has an accessible remove label" do
       expect(rendered).to have_selector(".remove") do |s|
         expect(s).to have_selector('.sr-only', text: 'Remove constraint my label: my value')

data/spec/components/blacklight/document_component_spec.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::DocumentComponent, type: :component do
+  subject(:component) { described_class.new(document: document, **attr) }
+
+  let(:attr) { {} }
+  let(:view_context) { controller.view_context }
+  let(:render) do
+    component.render_in(view_context)
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
+  let(:document) do
+    SolrDocument.new(
+      id: 'x',
+      thumbnail_path_ss: 'http://example.com/image.jpg',
+      title_tsim: 'Title',
+      isbn_ssim: ['Value']
+    )
+  end
+
+  let(:blacklight_config) do
+    CatalogController.blacklight_config.deep_copy.tap do |config|
+      config.track_search_session = false
+      config.index.thumbnail_field = 'thumbnail_path_ss'
+      config.index.document_actions[:bookmark].partial = '/catalog/bookmark_control.html.erb'
+    end
+  end
+
+  before do
+    allow(controller).to receive(:current_or_guest_user).and_return(User.new)
+    allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
+    allow(view_context).to receive(:search_session).and_return({})
+    allow(view_context).to receive(:current_search_session).and_return(nil)
+    allow(view_context).to receive(:current_bookmarks).and_return([])
+  end
+
+  it 'has some defined content areas' do
+    component.with(:title, 'Title')
+    component.with(:metadata, 'Metadata')
+    component.with(:thumbnail, 'Thumbnail')
+    component.with(:actions, 'Actions')
+
+    expect(rendered).to have_content 'Title'
+    expect(rendered).to have_content 'Metadata'
+    expect(rendered).to have_content 'Thumbnail'
+    expect(rendered).to have_content 'Actions'
+  end
+
+  it 'has schema.org properties' do
+    component.with(:body, '-')
+
+    expect(rendered).to have_selector 'article[@itemtype="http://schema.org/Thing"]'
+    expect(rendered).to have_selector 'article[@itemscope]'
+  end
+
+  context 'with a provided body' do
+    it 'opts-out of normal component content' do
+      component.with(:body, 'Body content')
+
+      expect(rendered).to have_content 'Body content'
+      expect(rendered).not_to have_selector 'header'
+      expect(rendered).not_to have_selector 'dl'
+    end
+  end
+
+  context 'index view' do
+    let(:attr) { { counter: 5 } }
+
+    it 'has data properties' do
+      component.with(:body, '-')
+
+      expect(rendered).to have_selector 'article[@data-document-id="x"]'
+      expect(rendered).to have_selector 'article[@data-document-counter="5"]'
+    end
+
+    it 'renders a linked title' do
+      expect(rendered).to have_link 'Title', href: '/catalog/x'
+    end
+
+    it 'renders a counter with the title' do
+      expect(rendered).to have_selector 'header', text: '5. Title'
+    end
+
+    it 'renders actions' do
+      expect(rendered).to have_selector '.index-document-functions'
+    end
+
+    it 'renders a thumbnail' do
+      expect(rendered).to have_selector 'a[href="/catalog/x"] img[src="http://example.com/image.jpg"]'
+    end
+  end
+
+  context 'show view' do
+    let(:attr) { { title_component: :h1, show: true } }
+
+    before do
+      allow(view_context).to receive(:action_name).and_return('show')
+    end
+
+    it 'renders with an id' do
+      component.with(:body, '-')
+
+      expect(rendered).to have_selector 'article#document'
+    end
+
+    it 'renders a title' do
+      expect(rendered).to have_selector 'h1', text: 'Title'
+    end
+
+    it 'renders with show-specific metadata' do
+      expect(rendered).to have_selector 'dl.document-metadata'
+      expect(rendered).to have_selector 'dt', text: 'ISBN:'
+      expect(rendered).to have_selector 'dd', text: 'Value'
+    end
+  end
+
+  it 'renders metadata' do
+    expect(rendered).to have_selector 'dl.document-metadata'
+    expect(rendered).to have_selector 'dt', text: 'Title:'
+    expect(rendered).to have_selector 'dd', text: 'Title'
+    expect(rendered).not_to have_selector 'dt', text: 'ISBN:'
+  end
+end

data/spec/components/blacklight/metadata_field_component_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::MetadataFieldComponent, type: :component do
+  subject(:render) do
+    render_inline(described_class.new(field: field))
+  end
+
+  let(:view_context) { controller.view_context }
+  let(:document) { SolrDocument.new('field' => ['Value']) }
+  let(:field_config) { Blacklight::Configuration::Field.new(key: 'field', field: 'field', label: 'Field label') }
+
+  let(:field) do
+    Blacklight::FieldPresenter.new(view_context, document, field_config)
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
+  it 'renders the field label' do
+    expect(rendered).to have_selector 'dt.blacklight-field', text: 'Field label'
+  end
+
+  it 'renders the field value' do
+    expect(rendered).to have_selector 'dd.blacklight-field', text: 'Value'
+  end
+
+  context 'from a show view' do
+    subject(:render) do
+      render_inline(described_class.new(field: field, show: true))
+    end
+
+    it 'renders the right field label' do
+      allow(field).to receive(:label).with('show').and_return('custom label')
+
+      expect(rendered).to have_selector 'dt.blacklight-field', text: 'custom label'
+    end
+  end
+end

data/spec/controllers/blacklight/search_fields_spec.rb

@@ -39,7 +39,7 @@ RSpec.describe Blacklight::SearchFields do
                                                                        config.add_search_field label: 'All Fields', qt: 'all_fields'
                                                                        config.add_search_field 'title', qt: 'title_search'
                                                                      end)
-      end .to raise_error ArgumentError
+      end.to raise_error ArgumentError
     end
   end
 
@@ -54,7 +54,7 @@ RSpec.describe Blacklight::SearchFields do
                                                                        config.add_search_field 'my_key', label: 'All Fields'
                                                                        config.add_search_field 'my_key', label: 'title'
                                                                      end)
-      end .to raise_error RuntimeError
+      end.to raise_error RuntimeError
     end
   end
 end

data/spec/controllers/catalog_controller_spec.rb

@@ -30,11 +30,13 @@ RSpec.describe CatalogController, api: true do
         expect(assigns(:response).docs).not_to be_empty
         assert_facets_have_values(assigns(:response).aggregations)
       end
+
       it "has docs and facets for existing facet value", integration: true do
         get :index, params: { f: { "format" => 'Book' } }
         expect(assigns(:response).docs).not_to be_empty
         assert_facets_have_values(assigns(:response).aggregations)
       end
+
       it "has docs and facets for non-default results per page", integration: true do
         num_per_page = 7
         get :index, params: { per_page: num_per_page }
@@ -98,6 +100,7 @@ RSpec.describe CatalogController, api: true do
           get :index
           expect(assigns(:response).docs).not_to be_empty
         end
+
         it "gets facets when no query", integration: true do
           get :index
           assert_facets_have_values(assigns(:response).aggregations)
@@ -237,6 +240,11 @@ RSpec.describe CatalogController, api: true do
       expect(session[:search]['per_page']).to eq "15"
     end
 
+    it "records the document id being viewed" do
+      put :track, params: { id: doc_id, counter: 3, document_id: 1234 }
+      expect(session[:search]['document_id']).to eq "1234"
+    end
+
     it "redirects to show action for doc id" do
       put :track, params: { id: doc_id, counter: 3 }
       assert_redirected_to(solr_document_path(doc_id))
@@ -456,6 +464,7 @@ RSpec.describe CatalogController, api: true do
       get :suggest, params: { format: 'json' }
       expect(response.body).to eq [].to_json
     end
+
     it 'returns suggestions' do
       get :suggest, params: { format: 'json', q: 'new' }
       json = JSON.parse(response.body)
@@ -485,14 +494,17 @@ RSpec.describe CatalogController, api: true do
         post :email, params: { id: doc_id }
         expect(request.flash[:error]).to eq "You must enter a recipient in order to send this message"
       end
+
       it "gives an error if the email address is not valid" do
         post :email, params: { id: doc_id, to: 'test_bad_email' }
         expect(request.flash[:error]).to eq "You must enter a valid email address"
       end
+
       it "does not give error if no Message parameter is set" do
         post :email, params: { id: doc_id, to: 'test_email@projectblacklight.org' }
         expect(request.flash[:error]).to be_nil
       end
+
       it "redirects back to the record upon success" do
         allow(RecordMailer).to receive(:email_record)
           .with(anything, { to: 'test_email@projectblacklight.org', message: 'xyz' }, hash_including(host: 'test.host'))
@@ -501,6 +513,7 @@ RSpec.describe CatalogController, api: true do
         expect(request.flash[:error]).to be_nil
         expect(request).to redirect_to(solr_document_path(doc_id))
       end
+
       it "renders email_success for XHR requests" do
         post :email, xhr: true, params: { id: doc_id, to: 'test_email@projectblacklight.org' }
         expect(request).to render_template 'email_success'
@@ -513,23 +526,28 @@ RSpec.describe CatalogController, api: true do
         post :sms, params: { id: doc_id, carrier: 'att' }
         expect(request.flash[:error]).to eq "You must enter a recipient's phone number in order to send this message"
       end
+
       it "gives an error when a carrier is not provided" do
         post :sms, params: { id: doc_id, to: '5555555555', carrier: '' }
         expect(request.flash[:error]).to eq "You must select a carrier"
       end
+
       it "gives an error when the phone number is not 10 digits" do
         post :sms, params: { id: doc_id, to: '555555555', carrier: 'txt.att.net' }
         expect(request.flash[:error]).to eq "You must enter a valid 10 digit phone number"
       end
+
       it "gives an error when the carrier is not in our list of carriers" do
         post :sms, params: { id: doc_id, to: '5555555555', carrier: 'no-such-carrier' }
         expect(request.flash[:error]).to eq "You must enter a valid carrier"
       end
+
       it "allows punctuation in phone number" do
         post :sms, params: { id: doc_id, to: '(555) 555-5555', carrier: 'txt.att.net' }
         expect(request.flash[:error]).to be_nil
         expect(request).to redirect_to(solr_document_path(doc_id))
       end
+
       it "sends to the appropriate carrier email address" do
         expect(RecordMailer)
           .to receive(:sms_record)
@@ -537,11 +555,13 @@ RSpec.describe CatalogController, api: true do
           .and_return double(deliver: nil)
         post :sms, params: { id: doc_id, to: '5555555555', carrier: 'txt.att.net' }
       end
+
       it "redirects back to the record upon success" do
         post :sms, params: { id: doc_id, to: '5555555555', carrier: 'txt.att.net' }
         expect(request.flash[:error]).to eq nil
         expect(request).to redirect_to(solr_document_path(doc_id))
       end
+
       it "renders sms_success template for XHR requests" do
         post :sms, xhr: true, params: { id: doc_id, to: '5555555555', carrier: 'txt.att.net' }
         expect(request).to render_template 'sms_success'