blacklight 6.18.0 → 6.19.0

data/lib/blacklight/engine.rb

@@ -28,7 +28,8 @@ module Blacklight
     end
 
     initializer "blacklight.assets.precompile" do |app|
-      app.config.assets.precompile += %w(favicon.ico)
+      # When Rails has been generated in API mode, it does not have sprockets available
+      app.config.assets.precompile += %w(favicon.ico) if defined? Sprockets
     end
 
     Blacklight::Engine.config.sms_mappings = {

data/lib/blacklight/solr/repository.rb

@@ -22,8 +22,31 @@ module Blacklight::Solr
       send_and_receive blacklight_config.solr_path, params.reverse_merge(qt: blacklight_config.qt)
     end
 
+    # @param [Hash] params
+    # @return [Blacklight::Suggest::Response]
+    def suggestions(request_params)
+      suggest_results = connection.send_and_receive(suggest_handler_path, params: request_params)
+      Blacklight::Suggest::Response.new suggest_results, request_params, suggest_handler_path, suggester_name
+    end
+
+    ##
+    # Gets a list of available fields
+    # @return [Hash]
+    def reflect_fields
+      send_and_receive('admin/luke', params: { fl: '*', 'json.nl' => 'map' })['fields']
+    end
+
+    ##
+    # @return [boolean] true if the repository is reachable
+    def ping
+      response = connection.send_and_receive 'admin/ping', {}
+      Blacklight.logger.info("Ping [#{connection.uri}] returned: '#{response['status']}'")
+      response['status'] == "OK"
+    end
+
     ##
     # Execute a solr query
+    # TODO: Make this private after we have a way to abstract admin/luke and ping
     # @see [RSolr::Client#send_and_receive]
     # @overload find(solr_path, params)
     #   Execute a solr query at the given path with the parameters
@@ -51,8 +74,18 @@ module Blacklight::Solr
 
     protected
 
-      def build_connection
-        RSolr.connect(connection_config.merge(adapter: connection_config[:http_adapter]))
-      end
+    ##
+    # @return [String]
+    def suggest_handler_path
+      blacklight_config.autocomplete_path
+    end
+
+    def suggester_name
+      blacklight_config.autocomplete_suggester
+    end
+
+    def build_connection
+      RSolr.connect(connection_config.merge(adapter: connection_config[:http_adapter]))
+    end
   end
 end

data/lib/generators/blacklight/assets_generator.rb

@@ -1,8 +1,13 @@
-# frozen_string_literal: true
 module Blacklight
   class Assets < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
-  
+
+    # This could be skipped if you want to use webpacker
+    def add_javascript_dependencies
+      gem 'bootstrap-sass', '~> 3.0'
+      gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'
+    end
+
     def assets
       copy_file "blacklight.scss", "app/assets/stylesheets/blacklight.scss"
 

data/lib/generators/blacklight/install_generator.rb

@@ -12,7 +12,7 @@ module Blacklight
     class_option :devise      , type: :boolean, default: false, aliases: "-d", desc: "Use Devise as authentication logic."
     class_option :jettywrapper, type: :boolean, default: false, desc: "Use jettywrapper to download and control Jetty"
     class_option :marc        , type: :boolean, default: false, aliases: "-m", desc: "Generate MARC-based demo ."
-    class_option :'skip-assets', type: :boolean, default: false, desc: "Skip generating javascript and css assets into the application"
+    class_option :'skip-assets', type: :boolean, default: !defined?(Sprockets), desc: "Skip generating javascript and css assets into the application"
     class_option :'skip-solr', type: :boolean, default: false, desc: "Skip generating solr configurations."
 
     desc <<-EOS

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -190,5 +190,8 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # Configuration for autocomplete suggestor
     config.autocomplete_enabled = true
     config.autocomplete_path = 'suggest'
+    # if the name of the solr.SuggestComponent provided in your solrcongig.xml is not the 
+    # default 'mySuggester', uncomment and provide it below
+    # config.autocomplete_suggester = 'mySuggester'
   end
 end

data/lib/railties/blacklight.rake

@@ -2,11 +2,11 @@
 namespace :blacklight do
   # task to clean out old, unsaved searches
   # rake blacklight:delete_old_searches[days_old]
-  # example cron entry to delete searches older than 7 days at 2:00 AM every day: 
+  # example cron entry to delete searches older than 7 days at 2:00 AM every day:
   # 0 2 * * * cd /path/to/your/app && /path/to/rake blacklight:delete_old_searches[7] RAILS_ENV=your_env
   desc "Removes entries in the searches table that are older than the number of days given."
   task :delete_old_searches, [:days_old] => [:environment] do |t, args|
-    args.with_defaults(:days_old => 7)    
+    args.with_defaults(:days_old => 7)
     Search.delete_old_searches(args[:days_old].to_i)
   end
 
@@ -24,24 +24,19 @@ namespace :blacklight do
 
   namespace :check do
     desc "Check the Solr connection and controller configuration"
-    task :solr, [:controller_name] => [:environment] do |_, args|
-      errors = 0
-      verbose = ENV.fetch('VERBOSE', false).present?
-
-      conn = Blacklight.default_index.connection
-      puts "[#{conn.uri}]"
-
-      print " - admin/ping: "
+    task :solr, [:controller_name] => [:environment] do
       begin
-        response = conn.send_and_receive 'admin/ping', {}
-        puts response['status']
-        errors += 1 unless response['status'] == "OK"
+        conn = Blacklight.default_index
+        if conn.ping
+          puts "OK"
+        else
+          puts "Unable to reach: #{conn.uri}"
+          exit 1
+        end
       rescue => e
-        errors += 1
         puts e.to_s
+        exit 1
       end
-
-      exit 1 if errors > 0
     end
 
     task :controller, [:controller_name] => [:environment] do |_, args|

data/spec/controllers/bookmarks_controller_spec.rb

@@ -25,6 +25,25 @@ describe BookmarksController do
       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_success
+      expect(response.code).to eq "200"
+      expect(JSON.parse(response.body)["bookmarks"]["count"]).to eq 3
+    end
+  end
   
   describe "delete" do
     before do
@@ -39,6 +58,22 @@ describe BookmarksController do
       expect(JSON.parse(response.body)["bookmarks"]["count"]).to eq 0
     end
 
+    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_success
+      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)

data/spec/models/blacklight/configuration_spec.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 describe "Blacklight::Configuration" do
-  
+
   before(:each) do
-    @config = Blacklight::Configuration.new
+    @config = config
   end
 
+  let(:config) { Blacklight::Configuration.new }
+
   it "supports arbitrary configuration values" do
     @config.a = 1
 
@@ -78,7 +80,7 @@ describe "Blacklight::Configuration" do
     it "defaults to 5" do
       expect(Blacklight::Configuration.new.spell_max).to eq 5
     end
-    
+
     it "accepts config'd value" do
       expect(Blacklight::Configuration.new(:spell_max => 10).spell_max).to eq 10
     end
@@ -148,7 +150,7 @@ describe "Blacklight::Configuration" do
         config.add_my_custom_field 'qwerty', :label => "asdf"
       end
 
-      
+
 
       expect(config.my_custom_fields.keys).to include('qwerty')
     end
@@ -161,17 +163,17 @@ describe "Blacklight::Configuration" do
         config.add_my_custom_facet_field 'qwerty', :label => "asdf"
       end
 
-      
+
 
       expect(config.my_custom_facet_fields['qwerty']).to be_a_kind_of(Blacklight::Configuration::FacetField)
     end
 
   end
-  
+
   describe "add_facet_field" do
     it "accepts field name and hash form arg" do
       @config.add_facet_field('format',  :label => "Format", :limit => true)
-      
+
       expect(@config.facet_fields["format"]).to_not be_nil
       expect(@config.facet_fields["format"]["label"]).to eq "Format"
       expect(@config.facet_fields["format"]["limit"]).to be true
@@ -179,17 +181,17 @@ describe "Blacklight::Configuration" do
 
     it "accepts FacetField obj arg" do
       @config.add_facet_field("format", Blacklight::Configuration::FacetField.new( :label => "Format"))
-      
+
       expect(@config.facet_fields["format"]).to_not be_nil
       expect(@config.facet_fields["format"]["label"]).to eq "Format"
     end
-    
+
     it "accepts field name and block form" do
-      @config.add_facet_field("format") do |facet|        
+      @config.add_facet_field("format") do |facet|
         facet.label = "Format"
         facet.limit = true
       end
-      
+
       expect(@config.facet_fields["format"]).to_not be_nil
       expect(@config.facet_fields["format"].limit).to be true
     end
@@ -223,38 +225,38 @@ describe "Blacklight::Configuration" do
 
     it "creates default label from titleized solr field" do
       @config.add_facet_field("publication_date")
-        
+
       expect(@config.facet_fields["publication_date"].label).to eq "Publication Date"
     end
 
     it "allows you to not show the facet in the facet bar" do
       @config.add_facet_field("publication_date", :show=>false)
-        
+
       expect(@config.facet_fields["publication_date"]['show']).to be false
     end
-    
+
     it "raises on nil solr field name" do
       expect { @config.add_facet_field(nil) }.to raise_error ArgumentError
     end
 
     it "looks up and match field names" do
-      allow(@config).to receive_messages(luke_fields: { 
-        "some_field_facet" => {}, 
+      allow(config).to receive_messages(reflected_fields: {
+        "some_field_facet" => {},
         "another_field_facet" => {},
         "a_facet_field" => {},
         })
-      expect { |b| @config.add_facet_field match: /_facet$/, &b }.to yield_control.twice
+      expect { |b| config.add_facet_field match: /_facet$/, &b }.to yield_control.twice
 
       expect(@config.facet_fields.keys).to eq ["some_field_facet", "another_field_facet"]
     end
 
     it "takes wild-carded field names and dereference them to solr fields" do
-      allow(@config).to receive_messages(luke_fields: {
+      allow(config).to receive(:reflected_fields).and_return(
         "some_field_facet" => {},
         "another_field_facet" => {},
-        "a_facet_field" => {},
-        })
-      expect { |b| @config.add_facet_field "*_facet", &b }.to yield_control.twice
+        "a_facet_field" => {}
+        )
+      expect { |b| config.add_facet_field "*_facet", &b }.to yield_control.twice
 
       expect(@config.facet_fields.keys).to eq ["some_field_facet", "another_field_facet"]
     end
@@ -275,45 +277,45 @@ describe "Blacklight::Configuration" do
       end
     end
   end
-  
+
   describe "add_index_field" do
     it "takes hash form" do
       @config.add_index_field("title_display", :label => "Title")
-      
+
       expect(@config.index_fields["title_display"]).to_not be_nil
       expect(@config.index_fields["title_display"].label).to eq "Title"
     end
     it "takes IndexField param" do
       @config.add_index_field("title_display", Blacklight::Configuration::IndexField.new(:field => "title_display", :label => "Title"))
-      
+
       expect(@config.index_fields["title_display"]).to_not be_nil
       expect(@config.index_fields["title_display"].label).to eq "Title"
     end
     it "takes block form" do
-      @config.add_index_field("title_display") do |field|        
+      @config.add_index_field("title_display") do |field|
         field.label = "Title"
       end
       expect(@config.index_fields["title_display"]).to_not be_nil
       expect(@config.index_fields["title_display"].label).to eq "Title"
     end
-    
+
     it "creates default label from titleized field" do
       @config.add_index_field("title_display")
-      
+
       expect(@config.index_fields["title_display"].label).to eq "Title Display"
     end
-    
+
     it "raises on nil solr field name" do
       expect { @config.add_index_field(nil) }.to raise_error ArgumentError
     end
 
     it "takes wild-carded field names and dereference them to solr fields" do
-      allow(@config).to receive_messages(luke_fields: { 
-        "some_field_display" => {}, 
+      allow(config).to receive(:reflected_fields).and_return(
+        "some_field_display" => {},
         "another_field_display" => {},
-        "a_facet_field" => {},
-        })
-      @config.add_index_field "*_display"
+        "a_facet_field" => {}
+      )
+      config.add_index_field "*_display"
 
       expect(@config.index_fields.keys).to eq ["some_field_display", "another_field_display"]
     end
@@ -323,53 +325,53 @@ describe "Blacklight::Configuration" do
       expect(@config.index_fields.keys).to include "subtitle_display", "subtitle_vern_display", "title_display", "title_vern_display"
     end
   end
-  
+
   describe "add_show_field" do
     it "takes hash form" do
       @config.add_show_field("title_display", :label => "Title")
-      
+
       expect(@config.show_fields["title_display"]).to_not be_nil
       expect(@config.show_fields["title_display"].label).to eq "Title"
     end
     it "takes ShowField argument" do
       @config.add_show_field("title_display", Blacklight::Configuration::ShowField.new(:field => "title_display", :label => "Title"))
-      
+
       expect(@config.show_fields["title_display"]).to_not be_nil
       expect(@config.show_fields["title_display"].label).to eq  "Title"
     end
     it "takes block form" do
-      @config.add_show_field("title_display") do |f|        
+      @config.add_show_field("title_display") do |f|
         f.label = "Title"
       end
-      
+
       expect(@config.show_fields["title_display"]).to_not be_nil
       expect(@config.show_fields["title_display"].label).to eq  "Title"
     end
-    
+
     it "creates default label humanized from field" do
       @config.add_show_field("my_custom_field")
-      
+
       expect(@config.show_fields["my_custom_field"].label).to eq  "My Custom Field"
     end
-    
+
     it "raises on nil solr field name" do
       expect { @config.add_show_field(nil) }.to raise_error ArgumentError
     end
-       
+
     it "takes wild-carded field names and dereference them to solr fields" do
-      allow(@config).to receive_messages(luke_fields: { 
-        "some_field_display" => {}, 
+      allow(config).to receive(:reflected_fields).and_return(
+        "some_field_display" => {},
         "another_field_display" => {},
-        "a_facet_field" => {},
-        })
-      @config.add_show_field "*_display"
+        "a_facet_field" => {}
+      )
+      config.add_show_field "*_display"
 
       expect(@config.show_fields.keys).to eq ["some_field_display", "another_field_display"]
     end
 
   end
-    
-  
+
+
   describe "add_search_field" do
     it "accepts hash form" do
       c = Blacklight::Configuration.new
@@ -379,55 +381,55 @@ describe "Blacklight::Configuration" do
 
     it "accepts two-arg hash form" do
       c = Blacklight::Configuration.new
-      
+
       c.add_search_field("my_search_type",
           :key => "my_search_type",
-          :solr_parameters => { :qf => "my_field_qf^10" }, 
+          :solr_parameters => { :qf => "my_field_qf^10" },
           :solr_local_parameters => { :pf=>"$my_field_pf"})
-      
+
       field = c.search_fields["my_search_type"]
-      
+
       expect(field).to_not be_nil
-      
-      
+
+
       expect(field.solr_parameters).to_not be_nil
-      expect(field.solr_local_parameters).to_not be_nil  
-      
-      
+      expect(field.solr_local_parameters).to_not be_nil
+
+
     end
-    
+
     it "accepts block form" do
       c = Blacklight::Configuration.new
-      
-      c.add_search_field("some_field") do |field|        
+
+      c.add_search_field("some_field") do |field|
         field.solr_parameters = {:qf => "solr_field^10"}
         field.solr_local_parameters = {:pf => "$some_field_pf"}
       end
-      
+
       f = c.search_fields["some_field"]
-      
+
       expect(f).to_not be_nil
       expect(f.solr_parameters).to_not be_nil
-      expect(f.solr_local_parameters).to_not be_nil      
+      expect(f.solr_local_parameters).to_not be_nil
     end
-    
+
     it "accepts SearchField object" do
       c = Blacklight::Configuration.new
-      
+
       f = Blacklight::Configuration::SearchField.new( :foo => "bar")
-      
+
       c.add_search_field("foo", f)
-      
+
       expect(c.search_fields["foo"]).to_not be_nil
     end
-    
+
     it "raises on nil key" do
       expect {@config.add_search_field(nil, :foo => "bar")}.to raise_error ArgumentError
     end
-    
+
     it "creates default label from titleized field key" do
       @config.add_search_field("author_name")
-      
+
       expect(@config.search_fields["author_name"].label).to eq "Author Name"
     end
 
@@ -447,7 +449,7 @@ describe "Blacklight::Configuration" do
       end
     end
   end
-  
+
   describe "add_sort_field" do
     it "takes a hash" do
       c = Blacklight::Configuration.new
@@ -456,29 +458,29 @@ describe "Blacklight::Configuration" do
     end
 
     it "takes a two-arg form with a hash" do
-      @config.add_sort_field("score desc, pub_date_sort desc, title_sort asc", :label => "relevance") 
+      @config.add_sort_field("score desc, pub_date_sort desc, title_sort asc", :label => "relevance")
+
 
-      
       expect(@config.sort_fields.values.find{|f| f.label == "relevance"}).to_not be_nil
     end
-    
+
     it "takes a SortField object" do
       @config.add_sort_field(Blacklight::Configuration::SortField.new(:label => "relevance", :sort => "score desc, pub_date_sort desc, title_sort asc"
-))     
+))
       expect(@config.sort_fields.values.find{|f| f.label == "relevance"}).to_not be_nil
     end
-    
+
     it "takes block form" do
       @config.add_sort_field do |field|
         field.label = "relevance"
         field.sort = "score desc, pub_date_sort desc, title_sort asc"
       end
-      
+
       expect(@config.sort_fields.values.find{|f| f.label == "relevance"}).to_not be_nil
 
     end
   end
-  
+
   describe "#default_search_field" do
     it "uses the field with a :default key" do
       @config.add_search_field('search_field_1')