blacklight 6.14.0 → 7.0.0

data/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "blacklight-frontend",
+  "version": "7.0.0-alpha.1",
+  "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": {
+    "js-compile-bundle": "shx cat app/javascript/blacklight/core.js app/javascript/blacklight/autocomplete.js app/javascript/blacklight/bookmark_toggle.js app/javascript/blacklight/checkbox_submit.js app/javascript/blacklight/collapsable.js app/javascript/blacklight/facet_load.js app/javascript/blacklight/modal.js app/javascript/blacklight/search_context.js | shx sed \"s/^(import|export).*//\" | babel --filename app/javascript/blacklight/blacklight.js > app/assets/javascripts/blacklight/blacklight.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/projectblacklight/blacklight.git"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/projectblacklight/blacklight/issues"
+  },
+  "homepage": "https://github.com/projectblacklight/blacklight#readme",
+  "devDependencies": {
+    "babel-cli": "^6.26.0",
+    "shx": "^0.2.2"
+  },
+  "dependencies": {
+    "bloodhound-js": "^1.2.3",
+    "bootstrap": "^4.1.3",
+    "jquery": "^3.3.1",
+    "typeahead.js": "^0.11.1"
+  }
+}

data/spec/controllers/alternate_controller_spec.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
-describe AlternateController do
+RSpec.describe AlternateController do
   describe "the search results tools" do
     it "inherits tools from CatalogController" do
-      expect(AlternateController.blacklight_config.index.document_actions).to have_key(:bookmark)
+      expect(described_class.blacklight_config.index.document_actions).to have_key(:bookmark)
     end
 
     context "when deleting partials from the AlternateController" do
       before do
-        AlternateController.blacklight_config.index.document_actions.delete(:bookmark)
+        described_class.blacklight_config.index.document_actions.delete(:bookmark)
       end
+
       it "does not affect the CatalogController" do
-        expect(AlternateController.blacklight_config.index.document_actions).to be_empty
+        expect(described_class.blacklight_config.index.document_actions).to be_empty
         expect(CatalogController.blacklight_config.index.document_actions).to have_key(:bookmark)
       end
     end

data/spec/controllers/application_controller_spec.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-describe ApplicationController do
-
+RSpec.describe ApplicationController do
   describe "#blacklight_config" do
-
     it "provides a default blacklight_config everywhere" do
       expect(controller.blacklight_config).to eq CatalogController.blacklight_config
     end
   end
-
 end
-

data/spec/controllers/blacklight/base_spec.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
-describe Blacklight::Base do
+RSpec.describe Blacklight::Base do
+  subject { controller }
+
   let(:controller) { (Class.new(ApplicationController) { include Blacklight::Base }).new }
-  subject { controller}
 
   describe "#search_state" do
+    subject { controller.send(:search_state) }
+
     let(:raw_params) { HashWithIndifferentAccess.new a: 1 }
     let(:params) { ActionController::Parameters.new raw_params }
+
     before { allow(controller).to receive_messages(params: params) }
-    subject { controller.send(:search_state) }
 
     it "creates a path object" do
       expect(subject).to be_kind_of Blacklight::SearchState

data/spec/controllers/blacklight/catalog/component_configuration_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Blacklight::DefaultComponentConfiguration do
+RSpec.describe Blacklight::DefaultComponentConfiguration do
   subject do
     Class.new do
       include Blacklight::Configurable
@@ -12,19 +12,23 @@ describe Blacklight::DefaultComponentConfiguration do
     end
   end
 
+  before do
+    allow(Deprecation).to receive(:warn)
+  end
+
   describe ".add_show_tools_partial" do
-    it "should define an action method" do
-      subject.add_show_tools_partial :xyz
+    it "defines an action method" do
+      subject.blacklight_config.add_show_tools_partial :xyz
       expect(subject.new).to respond_to :xyz
     end
 
-    it "should not replace an existing method" do
-      subject.add_show_tools_partial :some_existing_action
+    it "does not replace an existing method" do
+      subject.blacklight_config.add_show_tools_partial :some_existing_action
       expect(subject.new.some_existing_action).to eq 1
     end
 
-    it "should allow the configuration to opt out of creating a method" do
-      subject.add_show_tools_partial :some_missing_action, define_method: false
+    it "allows the configuration to opt out of creating a method" do
+      subject.blacklight_config.add_show_tools_partial :some_missing_action, define_method: false
       expect(subject.new).not_to respond_to :some_missing_action
     end
   end

data/spec/controllers/blacklight/facet_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Blacklight::Facet do
+RSpec.describe Blacklight::Facet do
   subject do
     Class.new do
       include Blacklight::Facet
@@ -30,5 +30,4 @@ describe Blacklight::Facet do
       expect(subject.facet_configuration_for_field('b')).to eq blacklight_config.facet_fields['a']
     end
   end
-
 end

data/spec/controllers/blacklight/search_fields_spec.rb

@@ -1,43 +1,30 @@
 # frozen_string_literal: true
 
-describe Blacklight::SearchFields do
-
+RSpec.describe Blacklight::SearchFields do
   class MockConfig
     include Blacklight::SearchFields
   end
 
   before(:all) do
     @config = Blacklight::Configuration.new do |config|
-      config.default_solr_params = { :qt => 'search' }
-      
-      config.add_search_field 'all_fields', :label => 'All Fields'
-      config.add_search_field 'title', :qt => 'title_search'
-      config.add_search_field 'author', :qt => 'author_search'
-      config.add_search_field 'subject', :qt => 'subject_search'
-      config.add_search_field 'no_display', :qt => 'something', :include_in_simple_select => false
+      config.default_solr_params = { qt: 'search' }
+
+      config.add_search_field 'all_fields', label: 'All Fields'
+      config.add_search_field 'title', qt: 'title_search'
+      config.add_search_field 'author', qt: 'author_search'
+      config.add_search_field 'subject', qt: 'subject_search'
+      config.add_search_field 'no_display', qt: 'something', include_in_simple_select: false
     end
   end
 
-  before(:each) do  
+  before do
     @search_field_obj = MockConfig.new
     allow(@search_field_obj).to receive(:blacklight_config).and_return(@config)
   end
 
   it "returns search field list with calculated :label when needed" do
-     @search_field_obj.search_field_list.each do |hash|        
-        expect(hash.label).not_to be_blank
-     end
-  end
-
-  describe "#search_field_def_for_key" do
-    it "fills in default qt where needed" do
-      expect(Deprecation).to receive(:warn).at_least(:once)
-      expect(@search_field_obj.search_field_def_for_key("all_fields").qt).to eq @config.default_solr_params[:qt]
-    end
-
-    it "lookups field definitions by key" do
-      expect(Deprecation).to receive(:warn).at_least(:once)
-      expect(@search_field_obj.search_field_def_for_key("title").key).to eq "title"
+    @search_field_obj.search_field_list.each do |hash|
+      expect(hash.label).not_to be_blank
     end
   end
 
@@ -45,11 +32,14 @@ describe Blacklight::SearchFields do
     before do
       @bad_config = MockConfig.new
     end
+
     it "raises exception on #search_field_list" do
-      expect { allow(@bad_config).to receive(:blacklight_config).and_return(Blacklight::Configuration.new { |config|
-           config.add_search_field :label => 'All Fields', :qt => 'all_fields'
-           config.add_search_field 'title', :qt => 'title_search'
-      })   }.to raise_error ArgumentError
+      expect do
+        allow(@bad_config).to receive(:blacklight_config).and_return(Blacklight::Configuration.new do |config|
+                                                                       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
   end
 
@@ -57,13 +47,14 @@ describe Blacklight::SearchFields do
     before do
       @bad_config = MockConfig.new
     end
-    it "raises on #search_field_list" do
-      expect { allow(@bad_config).to receive(:blacklight_config).and_return(Blacklight::Configuration.new { |config|
-        config.add_search_field 'my_key', :label => 'All Fields'
-        config.add_search_field 'my_key', :label => 'title'
 
-      }) }.to raise_error RuntimeError
+    it "raises on #search_field_list" do
+      expect do
+        allow(@bad_config).to receive(:blacklight_config).and_return(Blacklight::Configuration.new do |config|
+                                                                       config.add_search_field 'my_key', label: 'All Fields'
+                                                                       config.add_search_field 'my_key', label: 'title'
+                                                                     end)
+      end .to raise_error RuntimeError
     end
   end
-  
 end

data/spec/controllers/bookmarks_controller_spec.rb

@@ -1,49 +1,84 @@
 # frozen_string_literal: true
 
-describe BookmarksController do
+RSpec.describe BookmarksController do
   describe '#blacklight_config' do
     it 'uses POST requests for querying solr' do
       expect(@controller.blacklight_config.http_method).to eq :post
     end
   end
 
-  # jquery 1.9 ajax does error callback if 200 returns empty body. so use 204 instead. 
+  # jquery 1.9 ajax does error callback if 200 returns empty body. so use 204 instead.
   describe "update" do
     it "has a 200 status code when creating a new one" do
       put :update, xhr: true, params: { id: '2007020969', format: :js }
-      expect(response).to be_success
+      expect(response).to be_successful
       expect(response.code).to eq "200"
       expect(JSON.parse(response.body)["bookmarks"]["count"]).to eq 1
     end
-    
+
     it "has a 500 status code when create is not success" do
       allow(@controller).to receive_message_chain(:current_or_guest_user, :existing_bookmark_for).and_return(false)
       allow(@controller).to receive_message_chain(:current_or_guest_user, :persisted?).and_return(true)
-      allow(@controller).to receive_message_chain(:current_or_guest_user, :bookmarks, :where, :exists?).and_return(false)  
-      allow(@controller).to receive_message_chain(:current_or_guest_user, :bookmarks, :create).and_return(false)  
+      allow(@controller).to receive_message_chain(:current_or_guest_user, :bookmarks, :where, :exists?).and_return(false)
+      allow(@controller).to receive_message_chain(:current_or_guest_user, :bookmarks, :create).and_return(false)
       put :update, xhr: true, params: { id: 'iamabooboo', format: :js }
       expect(response.code).to eq "500"
     end
   end
-  
+
+  describe "create" do
+    it "can create bookmarks via params bookmarks attribute" do
+      @controller.send(:current_or_guest_user).save
+      put :create, xhr: true, params: {
+        id: "notused",
+        bookmarks: [
+          { document_id: "2007020969", document_type: "SolrDocument" },
+          { document_id: "2007020970", document_type: "SolrDocument" },
+          { document_id: "2007020971", document_type: "SolrDocument" }
+        ],
+        format: :js
+      }
+
+      expect(response).to be_successful
+      expect(response.code).to eq "200"
+      expect(JSON.parse(response.body)["bookmarks"]["count"]).to eq 3
+    end
+  end
+
   describe "delete" do
     before do
       @controller.send(:current_or_guest_user).save
       @controller.send(:current_or_guest_user).bookmarks.create! document_id: '2007020969', document_type: "SolrDocument"
     end
-    
+
     it "has a 200 status code when delete is success" do
       delete :destroy, xhr: true, params: { id: '2007020969', format: :js }
-      expect(response).to be_success
+      expect(response).to be_successful
       expect(response.code).to eq "200"
       expect(JSON.parse(response.body)["bookmarks"]["count"]).to eq 0
     end
 
-   it "has a 500 status code when delete is not success" do
+    it "can handle bookmark deletion via :bookmarks param" do
+      class FooDocument < SolrDocument; end
+      @controller.send(:current_or_guest_user).bookmarks.create! document_id: '2007020970', document_type: "FooDocument"
+      delete :destroy, xhr: true, params: {
+        id: 'notused',
+        bookmarks: [
+          { document_id: '2007020969', document_type: 'SolrDocument' },
+          { document_id: '2007020970', document_type: 'FooDocument' }
+        ],
+        format: :js
+      }
+      expect(response).to be_successful
+      expect(response.code).to eq "200"
+      expect(JSON.parse(response.body)["bookmarks"]["count"]).to eq 0
+    end
+
+    it "has a 500 status code when delete is not success" do
       bm = instance_double(Bookmark)
       allow(@controller).to receive_message_chain(:current_or_guest_user, :existing_bookmark_for).and_return(bm)
       allow(@controller).to receive_message_chain(:current_or_guest_user, :bookmarks, :find_by).and_return(instance_double(Bookmark, delete: nil, destroyed?: false))
-     
+
       delete :destroy, xhr: true, params: { id: 'pleasekillme', format: :js }
 
       expect(response.code).to eq "500"