blacklight 6.5.0 → 6.6.0

data/lib/generators/blacklight/install_generator.rb

@@ -29,10 +29,9 @@ module Blacklight
 
     def add_solr_wrapper
       generator_options = '--jettywrapper' if options[:jettywrapper]
-      solr_generator = case
-                       when options[:jettywrapper]
+      solr_generator = if options[:jettywrapper]
                          'blacklight:solr4'
-                       when solr_version == 'latest'
+                       elsif solr_version == 'latest'
                          'blacklight:solr5'
                        else
                          "blacklight:solr#{solr_version}"
@@ -66,7 +65,6 @@ module Blacklight
     end
     
     def generate_blacklight_user
-
       generator_args = [model_name]
       if options[:devise]
         generator_args << "--devise #{options[:devise]}"
@@ -84,9 +82,7 @@ module Blacklight
     end
 
     def add_sass_configuration
-
       insert_into_file "config/application.rb", :after => "config.assets.enabled = true" do <<EOF
-
       # Default SASS Configuration, check out https://github.com/rails/sass-rails for details
       config.assets.compress = !Rails.env.development?
 EOF

data/lib/generators/blacklight/models_generator.rb

@@ -19,7 +19,6 @@ module Blacklight
       copy_file "config/blacklight.yml", "config/blacklight.yml"
     end
 
-
     # Setup the database migrations
     def copy_migrations
       rake "blacklight:install:migrations"
@@ -43,7 +42,5 @@ module Blacklight
   end
       EOF
     end
-
-
   end
 end

data/lib/generators/blacklight/search_builder_generator.rb

@@ -16,6 +16,5 @@ module Blacklight
     def create_search_builder
       template "search_builder.rb", "app/models/#{model_name}.rb"
     end
-
   end
 end

data/lib/generators/blacklight/solr4_generator.rb

@@ -3,7 +3,6 @@ require 'rails/generators'
 
 module Blacklight
   class Solr4Generator < Rails::Generators::Base
-
     source_root File.expand_path('../templates', __FILE__)
 
     class_option :jettywrapper, type: :boolean, default: false, desc: "Use jettywrapper to download and control Jetty"
@@ -28,6 +27,5 @@ module Blacklight
     def add_rsolr_gem
       gem "rsolr".dup, "~> 1.0"
     end
-
   end
 end

data/lib/generators/blacklight/solr5_generator.rb

@@ -2,10 +2,16 @@ require 'rails/generators'
 
 module Blacklight
   class Solr5Generator < Rails::Generators::Base
+    # Set source_root to grab .solr_wrapper and solr config dir
+    # from the root of the blacklight gem
+    source_root Blacklight.root
+
     desc <<-EOF
       This generator makes the following changes to your application:
        1. Installs solr_wrapper into your application
-       2. Adds rsolr to your Gemfile
+       2. Copies default blacklight solr config directory into your application
+       3. Copies default .solr_wrapper into your application
+       4. Adds rsolr to your Gemfile
     EOF
 
     def install_solrwrapper
@@ -16,6 +22,14 @@ module Blacklight
       append_to_file "Rakefile", "\nrequire 'solr_wrapper/rake_task' unless Rails.env.production?\n"
     end
 
+    def copy_solr_conf
+      directory 'solr', 'solr'
+    end
+
+    def solr_wrapper_config
+      copy_file '.solr_wrapper.yml', '.solr_wrapper.yml'
+    end
+
     def add_rsolr_gem
       gem 'rsolr', '~> 1.0'
     end

data/lib/generators/blacklight/test_support_generator.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 # Copy Blacklight test support material in place
 
-
 # Need the requires here so we can call the generator from environment.rb
 # as suggested above. 
 require 'rails/generators'

data/lib/railties/blacklight.rake

@@ -56,7 +56,7 @@ namespace :blacklight do
 
       begin
         response = controller.find q: '{!lucene}*:*'
-        if response.header['status'] == 0
+        if response.header['status'].zero?
           puts "OK"
         else
           errors += 1
@@ -78,7 +78,7 @@ namespace :blacklight do
       begin
         response, docs = controller.search_results(q: '{!lucene}*:*')
 
-        if response.header['status'] == 0 and docs.any?
+        if response.header['status'].zero? and docs.any?
           puts "OK"
         else
           errors += 1
@@ -101,7 +101,7 @@ namespace :blacklight do
         doc_id = response.documents.first.id
         response, doc = controller.fetch doc_id
 
-        if response.header['status'] == 0 and doc
+        if response.header['status'].zero? and doc
           puts "OK"
         else
           errors += 1

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

@@ -28,7 +28,4 @@ describe Blacklight::DefaultComponentConfiguration do
       expect(subject.new).not_to respond_to :some_missing_action
     end
   end
-
-  
-
-end
+end

data/spec/controllers/blacklight/search_helper_spec.rb

@@ -370,23 +370,21 @@ describe Blacklight::SearchHelper do
 
     describe "for 'true' configured values" do
       let(:blacklight_config) do
-        config = Blacklight::Configuration.new
-        config.add_facet_field "language_facet", limit: true
-        config
+        Blacklight::Configuration.new do |config|
+          config.add_facet_field "language_facet", limit: true
+        end
       end
       it "returns nil if no @response available" do
         expect(subject.facet_limit_for("some_unknown_field")).to be_nil
       end
       it "gets from @response facet.limit if available" do        
-        @response = double()
-        allow(@response).to receive(:aggregations).and_return("language_facet" => double(limit: nil))
+        @response = instance_double(Blacklight::Solr::Response, aggregations: { "language_facet" => double(limit: nil) })
         subject.instance_variable_set(:@response, @response)
         blacklight_config.facet_fields['language_facet'].limit = 10
         expect(subject.facet_limit_for("language_facet")).to eq 10
       end
       it "gets the limit from the facet field in @response" do
-        @response = double()
-        allow(@response).to receive(:aggregations).and_return("language_facet" => double(limit: 16))
+        @response = instance_double(Blacklight::Solr::Response, aggregations: { "language_facet" => double(limit: 16) })
         subject.instance_variable_set(:@response, @response)
         expect(subject.facet_limit_for("language_facet")).to eq 15
       end

data/spec/controllers/blacklight/suggest_search_spec.rb

@@ -3,8 +3,8 @@
 describe Blacklight::SuggestSearch do
   let(:params) { {q: 'test'} }
   let(:suggest_path) { 'suggest' }
-  let(:connection) { double('connection', send_and_receive: 'sent')}
-  let(:repository) { double('repository', connection: connection) }
+  let(:connection) { instance_double(RSolr::Client, send_and_receive: 'sent')}
+  let(:repository) { instance_double(Blacklight::Solr::Repository, connection: connection) }
   let(:suggest_search) { described_class.new(params, repository)}
   describe '#suggestions' do
     it 'returns a Blacklight::Suggest::Response' do

data/spec/controllers/bookmarks_controller_spec.rb

@@ -40,9 +40,9 @@ describe BookmarksController do
     end
 
    it "has a 500 status code when delete is not success" do
-      bm = double(Bookmark)
+      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(double('bookmark', delete: nil, destroyed?: false))
+      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 }
 

data/spec/controllers/catalog_controller_spec.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 describe CatalogController do
   let(:doc_id) { '2007020969' }
-  let(:mock_response) { double() }
-  let(:mock_document) { double() }
+  let(:mock_response) { instance_double(Blacklight::Solr::Response) }
+  let(:mock_document) { instance_double(SolrDocument) }
 
   describe "index action" do
     context "with format :html" do
@@ -370,7 +370,7 @@ describe CatalogController do
   end
 
   describe "email/sms" do
-    let(:mock_response) { double(documents: [SolrDocument.new(id: 'my_fake_doc'), SolrDocument.new(id: 'my_other_doc')]) }
+    let(:mock_response) { instance_double(Blacklight::Solr::Response, documents: [SolrDocument.new(id: 'my_fake_doc'), SolrDocument.new(id: 'my_other_doc')]) }
     before do
       allow(controller).to receive_messages(find: mock_response)
       request.env["HTTP_REFERER"] = "/catalog/#{doc_id}"
@@ -651,10 +651,10 @@ describe CatalogController do
     end
   end
 
-  describe "search_facet_url" do
-    it "is the same as the catalog url" do
+  describe "search_facet_path" do
+    it "is the same as the catalog path" do
       get :index, params: { page: 1 }
-      expect(controller.send(:search_facet_url, id: "some_facet", page: 5)).to eq facet_catalog_url(id: "some_facet")
+      expect(controller.send(:search_facet_path, id: "some_facet", page: 5)).to eq facet_catalog_path(id: "some_facet")
     end
   end
 end

data/spec/features/search_context_spec.rb

@@ -34,11 +34,10 @@ describe "Search Results context", js: true do
   context "navigating between search results using context pagination" do
     it "updates the back to search link with the current search pagination context" do
       search_for ''
-      first('.index_title a').click
-      10.times do
-        click_on "Next »"
-      end
-      
+      expect(page).to have_content "1 - 10"
+      find_all('.index_title a').last.click
+      click_on "Next »"
+
       click_on "Back to Search"
       expect(page).to have_content "11 - 20"
     end

data/spec/features/search_formats_spec.rb

@@ -1,12 +1,6 @@
 # frozen_string_literal: true
 
 describe "Search Formats" do
-  before do
-    # Get all the fields from Solr, so the #index documents have the MARC field (to trigger appropriate
-    # export formats)
-    CatalogController.blacklight_config.default_solr_params[:fl] = '*'
-  end
-
   it "has an RSS XML response" do
     visit "/catalog.rss?q="
     expect(page).to have_content "Blacklight Search Results"

data/spec/helpers/blacklight_helper_spec.rb

@@ -32,7 +32,7 @@ describe BlacklightHelper do
   end
 
   describe "render_link_rel_alternates" do
-    let(:document) { double }
+    let(:document) { instance_double(SolrDocument) }
     let(:result) { double }
     let(:presenter) { Blacklight::DocumentPresenter.new(document, self) }
     let(:blacklight_config) do
@@ -153,8 +153,8 @@ describe BlacklightHelper do
 
   context "render methods" do
     let(:field) { "some_field" }
-    let(:doc) { double }
-    let(:presenter) { double }
+    let(:doc) { instance_double(SolrDocument) }
+    let(:presenter) { instance_double(Blacklight::ShowPresenter) }
     before do
       allow(Deprecation).to receive(:warn) # TODO: purge Deprecations
       allow(helper).to receive(:presenter).with(doc).and_return(presenter)
@@ -196,7 +196,7 @@ describe BlacklightHelper do
   end
 
   describe "#document_has_value?" do
-    let(:doc) { double() }
+    let(:doc) { double(SolrDocument) }
     it "ifs the document has the field value" do
       allow(doc).to receive(:has?).with('asdf').and_return(true)
       field_config = double(:field => 'asdf')
@@ -218,12 +218,12 @@ describe BlacklightHelper do
 
   describe "render_grouped_response?" do
     it "checks if the response ivar contains grouped data" do
-      assign(:response, double("Solr::Response", :grouped? => true))
+      assign(:response, instance_double(Blacklight::Solr::Response, grouped?: true))
       expect(helper.render_grouped_response?).to be true
     end
 
     it "checks if the response param contains grouped data" do
-      response = double("Solr::Response", :grouped? => true)
+      response = instance_double(Blacklight::Solr::Response, grouped?: true)
       expect(helper.render_grouped_response?(response)).to be true
     end
   end
@@ -351,7 +351,7 @@ describe BlacklightHelper do
     let(:obj1) { SolrDocument.new }
     before do
       allow(helper).to receive(:blacklight_config).and_return(CatalogController.blacklight_config)
-      assign(:response, double("Solr::Response", grouped?: false, start: 0))
+      assign(:response, instance_double(Blacklight::Solr::Response, grouped?: false, start: 0))
       allow(helper).to receive(:link_to_document).and_return('<a/>')
       allow(helper).to receive(:render_index_doc_actions).and_return('<div/>')
     end

data/spec/helpers/catalog_helper_spec.rb

@@ -188,32 +188,32 @@ describe CatalogHelper do
   end
 
   describe "has_thumbnail?" do
+    let(:document) { instance_double(SolrDocument) }
     it "has a thumbnail if a thumbnail_method is configured" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
-      document = double()
       expect(helper.has_thumbnail? document).to be true
     end
 
     it "has a thumbnail if a thumbnail_field is configured and it exists in the document" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
-      document = double(:has? => true)
+      allow(document).to receive_messages(has?: true)
       expect(helper.has_thumbnail? document).to be true
     end
     
     it "does not have a thumbnail if the thumbnail_field is missing from the document" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
-      document = double(:has? => false)
+      allow(document).to receive_messages(has?: false)
       expect(helper.has_thumbnail? document).to be false
     end
 
     it "does not have a thumbnail if none of the fields are configured" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new() ))
-      expect(helper.has_thumbnail? double()).to be_falsey
+      expect(helper.has_thumbnail? document).to be_falsey
     end
   end
 
   describe "render_thumbnail_tag" do
-    let(:document) { double }
+    let(:document) { instance_double(SolrDocument) }
     it "calls the provided thumbnail method" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
       expect(helper).to receive_messages(:xyz => "some-thumbnail")
@@ -273,7 +273,7 @@ describe CatalogHelper do
   describe "thumbnail_url" do
     it "pulls the configured thumbnail field out of the document" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
-      document = double()
+      document = instance_double(SolrDocument)
       allow(document).to receive(:has?).with(:xyz).and_return(true)
       allow(document).to receive(:first).with(:xyz).and_return("asdf")
       expect(helper.thumbnail_url document).to eq("asdf")
@@ -281,7 +281,7 @@ describe CatalogHelper do
 
     it "returns nil if the thumbnail field doesn't exist" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
-      document = double()
+      document = instance_double(SolrDocument)
       allow(document).to receive(:has?).with(:xyz).and_return(false)
       expect(helper.thumbnail_url document).to be_nil
     end
@@ -289,19 +289,19 @@ describe CatalogHelper do
 
   describe "document_counter_with_offset" do
     it "renders the document index with the appropriate offset" do
-      assign(:response, double(start: 0, grouped?: false))
+      assign(:response, instance_double(Blacklight::Solr::Response, start: 0, grouped?: false))
       expect(helper.document_counter_with_offset(0)).to be(1)
       expect(helper.document_counter_with_offset(1)).to be(2)
     end
 
     it "renders the document index with the appropriate offset" do
-      assign(:response, double(start: 10, grouped?: false))
+      assign(:response, instance_double(Blacklight::Solr::Response, start: 10, grouped?: false))
       expect(helper.document_counter_with_offset(0)).to be(11)
       expect(helper.document_counter_with_offset(1)).to be(12)
     end
 
     it "does not provide a counter for grouped responses" do
-      assign(:response, double(start: 10, grouped?: true))
+      assign(:response, instance_double(Blacklight::Solr::Response, start: 10, grouped?: true))
       expect(helper.document_counter_with_offset(0)).to be_nil
     end
   end

data/spec/helpers/configuration_helper_spec.rb

@@ -111,7 +111,7 @@ describe BlacklightConfigurationHelper do
   end
 
   describe "#index_field_label" do
-    let(:document) { double }
+    let(:document) { instance_double(SolrDocument) }
     it "looks up the label to display for the given document and field" do
       allow(helper).to receive(:index_fields).and_return({ "my_field" => double(label: "some label") })
       allow(helper).to receive(:field_label).with(:"blacklight.search.fields.index.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
@@ -120,7 +120,7 @@ describe BlacklightConfigurationHelper do
   end
 
   describe "#document_show_field_label" do
-    let(:document) { double }
+    let(:document) { instance_double(SolrDocument) }
     it "looks up the label to display for the given document and field" do
       allow(helper).to receive(:document_show_fields).and_return({ "my_field" => double(label: "some label") })
       allow(helper).to receive(:field_label).with(:"blacklight.search.fields.show.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
@@ -129,7 +129,7 @@ describe BlacklightConfigurationHelper do
   end
 
   describe "#facet_field_label" do
-    let(:document) { double }
+    let(:document) { instance_double(SolrDocument) }
     it "looks up the label to display for the given document and field" do
       allow(blacklight_config).to receive(:facet_fields).and_return({ "my_field" => double(label: "some label") })
       allow(helper).to receive(:field_label).with(:"blacklight.search.fields.facet.my_field", :"blacklight.search.fields.my_field", "some label", "My field")

data/spec/helpers/facets_helper_spec.rb

@@ -107,8 +107,7 @@ describe FacetsHelper do
       facet_config = double(query: nil, field: 'b', key: 'a')
       facet_field = double()
       allow(helper).to receive(:facet_configuration_for_field).with('b').and_return(facet_config)
-      @response = double()
-      allow(@response).to receive(:aggregations).and_return('b' => facet_field)
+      @response = instance_double(Blacklight::Solr::Response, aggregations: { 'b' => facet_field })
 
       expect(helper.facet_by_field_name('b')).to eq facet_field
     end

data/spec/helpers/render_constraints_helper_spec.rb

@@ -56,6 +56,14 @@ describe RenderConstraintsHelper do
       expect(subject).to have_link "Remove constraint Item Type: journal", href: "/catalog?q=biz"
       expect(subject).to have_selector ".filterName", text: 'Item Type'
     end
+
+    context 'with string values' do
+      subject { helper.render_filter_element('type', 'journal', path) }
+
+      it "handles string values gracefully" do
+        expect(subject).to have_link "Remove constraint Item Type: journal", href: "/catalog?q=biz"
+      end
+    end
   end
 
   describe "#render_constraints_filters" do