blacklight 5.15.0 → 5.16.0

data/{lib/blacklight/solr_response → app/models/blacklight/solr/response}/group.rb

@@ -1,6 +1,6 @@
-class Blacklight::SolrResponse::Group
+class Blacklight::Solr::Response::Group
 
-  include Blacklight::SolrResponse::PaginationMethods
+  include Blacklight::Solr::Response::PaginationMethods
 
   attr_reader :key, :group, :response
   

data/{lib/blacklight/solr_response → app/models/blacklight/solr/response}/group_response.rb

@@ -1,6 +1,6 @@
-class Blacklight::SolrResponse::GroupResponse
+class Blacklight::Solr::Response::GroupResponse
 
-  include Blacklight::SolrResponse::PaginationMethods
+  include Blacklight::Solr::Response::PaginationMethods
 
   attr_reader :key, :group, :response
 
@@ -14,7 +14,7 @@ class Blacklight::SolrResponse::GroupResponse
 
   def groups
     @groups ||= group["groups"].map do |g|
-      Blacklight::SolrResponse::Group.new g[:groupValue], g, self
+      Blacklight::Solr::Response::Group.new g[:groupValue], g, self
     end
   end
 

data/{lib/blacklight/solr_response → app/models/blacklight/solr/response}/more_like_this.rb

@@ -1,4 +1,4 @@
-module Blacklight::SolrResponse::MoreLikeThis
+module Blacklight::Solr::Response::MoreLikeThis
   def more_like document
     mlt = more_like_this[document.id]
     return [] unless mlt and mlt['docs']

data/{lib/blacklight/solr_response → app/models/blacklight/solr/response}/pagination_methods.rb

@@ -1,4 +1,4 @@
-module Blacklight::SolrResponse::PaginationMethods
+module Blacklight::Solr::Response::PaginationMethods
 
   include Kaminari::PageScopeMethods
   include Kaminari::ConfigurationMethods::ClassMethods

data/{lib/blacklight/solr_response → app/models/blacklight/solr/response}/response.rb

@@ -1,4 +1,4 @@
-module Blacklight::SolrResponse::Response
+module Blacklight::Solr::Response::Response
   def response
     self[:response] || {}
   end

data/{lib/blacklight/solr_response → app/models/blacklight/solr/response}/spelling.rb

@@ -2,7 +2,7 @@
 #
 # response.spelling.words
 #
-module Blacklight::SolrResponse::Spelling
+module Blacklight::Solr::Response::Spelling
 
   def spelling
     @spelling ||= Base.new(self)

data/{lib → app/models/concerns}/blacklight/document.rb

@@ -13,17 +13,14 @@
 # transformation formats.
 #
 module Blacklight::Document
-  autoload :ActiveModelShim, 'blacklight/document/active_model_shim'
-  autoload :SchemaOrg, 'blacklight/document/schema_org'
-  autoload :CacheKey, 'blacklight/document/cache_key'
-  autoload :DublinCore, 'blacklight/document/dublin_core'
-  autoload :Email, 'blacklight/document/email'
-  autoload :SemanticFields, 'blacklight/document/semantic_fields'
-  autoload :Sms, 'blacklight/document/sms'
-  autoload :Extensions, 'blacklight/document/extensions'
-  autoload :Export, 'blacklight/document/export'
-
   extend ActiveSupport::Concern
+
+  require_relative 'document/active_model_shim'
+  require_relative 'document/schema_org'
+  require_relative 'document/semantic_fields'
+  require_relative 'document/cache_key'
+  require_relative 'document/export'
+
   include Blacklight::Document::SchemaOrg
   include Blacklight::Document::SemanticFields
   include Blacklight::Document::CacheKey

data/{lib → app/models/concerns}/blacklight/solr/document.rb

@@ -16,19 +16,14 @@ require 'rsolr'
 #
 
 module Blacklight::Solr::Document
-  autoload :SchemaOrg, 'blacklight/solr/document/schema_org'
-  autoload :DublinCore, 'blacklight/solr/document/dublin_core'
-  autoload :Email, 'blacklight/solr/document/email'
-  autoload :Sms, 'blacklight/solr/document/sms'
-  autoload :Extensions, 'blacklight/solr/document/extensions'
-  autoload :Export, 'blacklight/solr/document/export'
-  autoload :MoreLikeThis, 'blacklight/solr/document/more_like_this'
-
   extend ActiveSupport::Concern
   include Blacklight::Document
+  require_relative 'document/more_like_this'
+
   include Blacklight::Document::ActiveModelShim
   include Blacklight::Solr::Document::MoreLikeThis
 
+
   def has_highlight_field? k
     return false if response['highlighting'].blank? or response['highlighting'][self.id].blank?
     

data/{lib → app/models/concerns}/blacklight/solr/search_builder_behavior.rb

@@ -282,7 +282,12 @@ module Blacklight::Solr
 
       case
         when (facet_config and facet_config.query)
-          facet_config.query[value][:fq]
+          if facet_config.query[value]
+            facet_config.query[value][:fq]
+          else
+            # exclude all documents if the custom facet key specified was not found
+            '-*:*'
+          end
         when (facet_config and facet_config.date)
           # in solr 3.2+, this could be replaced by a !term query
           "#{prefix}#{solr_field}:#{RSolr.solr_escape(value)}"

data/app/views/catalog/_paginate_compact.html.erb

@@ -1,4 +1,4 @@
-<%# Call with a Blacklight::SolrResponse or any other kaminari-compatible collection
+<%# Call with a Blacklight::Solr::Response or any other kaminari-compatible collection
     to render Blacklight's compact pagination info component:
 
         <%= render :partial => "paginate_compact", :object => @response

data/blacklight.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency "capybara"
   s.add_development_dependency "poltergeist"
-  s.add_development_dependency 'engine_cart', ">= 0.6.0"
+  s.add_development_dependency 'engine_cart', '~> 0.8.0'
   s.add_development_dependency "equivalent-xml"
 end

data/lib/blacklight.rb

@@ -4,44 +4,19 @@ require 'deprecation'
 require 'blacklight/utils'
 
 module Blacklight
-  autoload :Configurable, 'blacklight/configurable'
-  autoload :Configuration, 'blacklight/configuration'
-  autoload :SearchFields, 'blacklight/search_fields'
-  autoload :SearchBuilder, 'blacklight/search_builder'
-  autoload :SearchBuilderBehavior, 'blacklight/search_builder_behavior'
-
-  autoload :Document, 'blacklight/document'
-  autoload :Solr, 'blacklight/solr'
-
-  autoload :SearchHelper,       'blacklight/search_helper'
-  autoload :SolrHelper,         'blacklight/solr_helper'
-  autoload :AbstractRepository, 'blacklight/abstract_repository'
-  autoload :SolrRepository,     'blacklight/solr_repository'
-  autoload :RequestBuilders,    'blacklight/request_builders'
-
   autoload :Exceptions, 'blacklight/exceptions'
-
-  autoload :User, 'blacklight/user'
-
-  autoload :Controller,        'blacklight/controller'
-  autoload :Base,              'blacklight/base'
-  autoload :Catalog,           'blacklight/catalog'
-  autoload :TokenBasedUser,    'blacklight/token_based_user'
-  autoload :Bookmarks,         'blacklight/bookmarks'
-  autoload :DocumentPresenter, 'blacklight/document_presenter'
-
   autoload :Routes, 'blacklight/routes'
-  
-  autoload :SolrResponse, 'blacklight/solr_response'
-  autoload :Facet, 'blacklight/facet'
-  autoload :FacetPaginator, 'blacklight/facet_paginator'
+  autoload :Solr, 'blacklight/solr'
+
+  SolrRepository = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('Blacklight::SolrRepository', 'Blacklight::Solr::Repository')
+  SolrResponse = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('Blacklight::SolrResponse', 'Blacklight::Solr::Response')
+  autoload :SolrHelper, 'blacklight/solr_helper'
 
-  extend SearchFields
   extend Deprecation
 
   require 'blacklight/version'
   require 'blacklight/engine' if defined?(Rails)
-  
+
   class << self
     attr_accessor :solr, :solr_config
   end
@@ -70,7 +45,7 @@ module Blacklight
   end
 
   def self.default_index
-    @default_index ||=  Blacklight::SolrRepository.new(Blacklight::Configuration.new)
+    @default_index ||= Blacklight::Solr::Repository.new(Blacklight::Configuration.new)
   end
 
   def self.solr_config

data/lib/blacklight/engine.rb

@@ -11,6 +11,12 @@ module Blacklight
       ActionView::Base.send :include, BlacklightHelper
     end
 
+    config.autoload_paths += %W(
+      #{config.root}/app/presenters
+      #{config.root}/app/controllers/concerns
+      #{config.root}/app/models/concerns
+    )
+
     # This makes our rake tasks visible.
     rake_tasks do
       Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..'))) do

data/lib/blacklight/solr.rb

@@ -1,8 +1,6 @@
-# -*- encoding : utf-8 -*-
-module Blacklight::Solr
-  autoload :FacetPaginator, 'blacklight/solr/facet_paginator'
-  autoload :Document, 'blacklight/solr/document'
-  autoload :Request, 'blacklight/solr/request'
-  autoload :SearchBuilder, 'blacklight/solr/search_builder'
-  autoload :SearchBuilderBehavior, 'blacklight/solr/search_builder_behavior'
+module Blacklight
+  module Solr
+    require File.join(Blacklight::Engine.config.root, 'app', 'models', 'concerns', 'blacklight', 'document')
+    require File.join(Blacklight::Engine.config.root, 'app', 'models', 'concerns', 'blacklight', 'solr', 'document')
+  end
 end

data/lib/railties/blacklight.rake

@@ -12,7 +12,9 @@ namespace :blacklight do
 
   namespace :index do
     desc "Put sample data into solr"
-    task :seed do
+    task :seed => [:environment]  do
+      require 'yaml'
+
       docs = YAML::load(File.open(File.join(Blacklight.root, 'solr', 'sample_solr_documents.yml')))
       conn = Blacklight.default_index.connection
       conn.add docs

data/spec/{lib → controllers}/blacklight/catalog/component_configuration_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe Blacklight::Catalog::ComponentConfiguration do
+describe Blacklight::DefaultComponentConfiguration do
   subject do
     Class.new do
       include Blacklight::Configurable
-      include Blacklight::Catalog::ComponentConfiguration
+      include Blacklight::DefaultComponentConfiguration
 
       def some_existing_action
         1
@@ -22,6 +22,11 @@ describe Blacklight::Catalog::ComponentConfiguration do
       subject.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
+      expect(subject.new).not_to respond_to :some_missing_action
+    end
   end
 
   

data/spec/{lib → controllers}/blacklight/search_fields_spec.rb

@@ -53,7 +53,7 @@ describe Blacklight::SearchFields 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
+      })   }.to raise_error ArgumentError
     end
   end
 
@@ -66,7 +66,7 @@ describe Blacklight::SearchFields do
         config.add_search_field 'my_key', :label => 'All Fields'
         config.add_search_field 'my_key', :label => 'title'
 
-      }) }.to raise_error
+      }) }.to raise_error RuntimeError
     end
   end
   

data/spec/{lib → controllers}/blacklight/search_helper_spec.rb

@@ -24,7 +24,7 @@ describe Blacklight::SearchHelper do
 
     def initialize blacklight_config, conn
       self.blacklight_config = blacklight_config
-      self.repository = Blacklight::SolrRepository.new(blacklight_config)
+      self.repository = Blacklight::Solr::Repository.new(blacklight_config)
       self.repository.connection = conn
     end
 
@@ -163,7 +163,7 @@ describe Blacklight::SearchHelper do
       end
 
       it "should return a grouped response" do
-        expect(@solr_response).to be_a_kind_of Blacklight::SolrResponse::GroupResponse
+        expect(@solr_response).to be_a_kind_of Blacklight::Solr::Response::GroupResponse
 
       end
     end
@@ -183,7 +183,7 @@ describe Blacklight::SearchHelper do
       end
 
       it "should return a grouped response" do
-        expect(@solr_response).to be_a_kind_of Blacklight::SolrResponse::GroupResponse
+        expect(@solr_response).to be_a_kind_of Blacklight::Solr::Response::GroupResponse
         expect(@solr_response.group_field).to eq "title_sort"
       end
     end

data/spec/controllers/catalog_controller_spec.rb

@@ -3,21 +3,6 @@ require 'spec_helper'
 describe CatalogController do
 
   describe "index action" do
-    
-    # In Rails 3 ActionDispatch::TestProcess#assigns() converts anything that 
-    # descends from Hash to a HashWithIndifferentAccess. Therefore our Solr
-    # response object gets replaced if we call assigns(:response)
-    # Fixed by https://github.com/rails/rails/commit/185c3dbc6ab845edfc94e8d38ef5be11c417dd81
-    if ::Rails.version < "4.0"
-      def assigns_response
-        controller.instance_variable_get("@response")
-      end
-    else
-      def assigns_response
-        assigns(:response)
-      end
-    end
-    
     describe "with format :html" do
       let(:user_query) { 'history' } # query that will get results
 
@@ -38,41 +23,53 @@ describe CatalogController do
       # check each user manipulated parameter
       it "should have docs and facets for query with results", :integration => true do
         get :index, q: user_query
-        expect(assigns_response.docs).to_not be_empty
-        assert_facets_have_values(assigns_response.aggregations)
+        expect(assigns(:response).docs).to_not be_empty
+        assert_facets_have_values(assigns(:response).aggregations)
       end
       it "should have docs and facets for existing facet value", :integration => true do
         get :index, f: {"format" => 'Book'}
-        expect(assigns_response.docs).to_not be_empty
-        assert_facets_have_values(assigns_response.aggregations)
+        expect(assigns(:response).docs).to_not be_empty
+        assert_facets_have_values(assigns(:response).aggregations)
       end
       it "should have docs and facets for non-default results per page", :integration => true do
         num_per_page = 7
         get :index, :per_page => num_per_page
-        expect(assigns_response.docs).to have(num_per_page).items
-        assert_facets_have_values(assigns_response.aggregations)
+        expect(assigns(:response).docs).to have(num_per_page).items
+        assert_facets_have_values(assigns(:response).aggregations)
       end
 
       it "should have docs and facets for second page", :integration => true do
         page = 2
         get :index, :page => page
-        expect(assigns_response.docs).to_not be_empty
-        expect(assigns_response.params[:start].to_i).to eq (page-1) * @controller.blacklight_config[:default_solr_params][:rows]
-        assert_facets_have_values(assigns_response.aggregations)
+        expect(assigns(:response).docs).to_not be_empty
+        expect(assigns(:response).params[:start].to_i).to eq (page-1) * @controller.blacklight_config[:default_solr_params][:rows]
+        assert_facets_have_values(assigns(:response).aggregations)
       end
 
       it "should have no docs or facet values for query without results", :integration => true do
         get :index, q: 'sadfdsafasdfsadfsadfsadf' # query for no results
 
-        expect(assigns_response.docs).to be_empty
-        assigns_response.aggregations.each do |key, facet|
+        expect(assigns(:response).docs).to be_empty
+        assigns(:response).aggregations.each do |key, facet|
           expect(facet.items).to be_empty
         end
       end
+      
+      it "should show 0 results when the user asks for an invalid value to a custom facet query", :integration => true do
+        get :index, f: {example_query_facet_field: 'bogus'} # bogus custom facet value
+        expect(assigns(:response).docs).to be_empty
+      end
 
+      it "should return results (possibly 0) when the user asks for a valid value to a custom facet query", :integration => true do
+        get :index, f: {example_query_facet_field: 'years_10'} # valid custom facet value with some results
+        expect(assigns(:response).docs).to_not be_empty
+        get :index, f: {example_query_facet_field: 'years_5'}  # valid custom facet value with NO results
+        expect(assigns(:response).docs).to be_empty
+      end
+      
       it "should have a spelling suggestion for an appropriately poor query", :integration => true do
         get :index, :q => 'boo'
-        expect(assigns_response.spelling.words).to_not be_nil
+        expect(assigns(:response).spelling.words).to_not be_nil
       end
 
       describe "session" do
@@ -93,11 +90,11 @@ describe CatalogController do
       describe "for default query" do
         it "should get documents when no query", :integration => true do
           get :index
-          expect(assigns_response.docs).to_not be_empty
+          expect(assigns(:response).docs).to_not be_empty
         end
         it "should get facets when no query", :integration => true do
           get :index
-          assert_facets_have_values(assigns_response.aggregations)
+          assert_facets_have_values(assigns(:response).aggregations)
         end
       end
 
@@ -206,6 +203,11 @@ describe CatalogController do
 
   describe "track action" do
     doc_id = '2007020969'
+    
+    it "should persist the search session id value into session[:search]" do
+      put :track, :id => doc_id, :counter => 3, search_id: "123"
+      expect(session[:search]['id']).to eq "123"
+    end
 
     it "should set counter value into session[:search]" do
       put :track, :id => doc_id, :counter => 3
@@ -524,7 +526,7 @@ describe CatalogController do
       allow(controller).to receive(:get_search_results) { |*args| raise fake_error }
       allow(controller.flash).to receive(:sweep)
       allow(controller).to receive(:flash).and_return(:notice => I18n.t('blacklight.search.errors.request_error'))
-      expect { get :index, q: "+" }.to raise_error
+      expect { get :index, q: "+" }.to raise_error Blacklight::Exceptions::InvalidRequest
     end
 
   end
@@ -553,9 +555,9 @@ describe CatalogController do
       it "should be successful" do
         get :facet, id: 'format'
         expect(response).to be_successful
-        expect(assigns[:response]).to be_kind_of Blacklight::SolrResponse
+        expect(assigns[:response]).to be_kind_of Blacklight::Solr::Response
         expect(assigns[:facet]).to be_kind_of Blacklight::Configuration::FacetField
-        expect(assigns[:display_facet]).to be_kind_of Blacklight::SolrResponse::Facets::FacetField
+        expect(assigns[:display_facet]).to be_kind_of Blacklight::Solr::Response::Facets::FacetField
         expect(assigns[:pagination]).to be_kind_of Blacklight::Solr::FacetPaginator
       end
     end