blacklight 6.10.1 → 6.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13a1d0a576ef05724c0d14346328fd7650055bde
-  data.tar.gz: 5698a8f2653b6dca110bc5d7367000bc42c61e96
+  metadata.gz: 741267e0943b9248b05baca938f10fe8c3454717
+  data.tar.gz: 333367da063309c42774d31396aadaa17480bc43
 SHA512:
-  metadata.gz: 9ab3959efcc3a80dc1058ca760252c99f831199aace9019136d34691f5d92d6af4f8d9199657713ef945f149b91341d8845a15716043b8ad2c0e272e3ae15f09
-  data.tar.gz: 155d327f094f45c424f98c56466606af7057db4b814fe62fb5f5b1ad7da0ce584447e6278d99f66b116f68e29c894559c3e10dafc4994a0a99561d3d19185c4a
+  metadata.gz: 9e86f64f778efb7e43db4b0acd10999bb8c151ba30f59272522354469ad79ba28b04979864d381b2532c478b28fac33e712961bd5ca85aef41a04c0849e1dbe6
+  data.tar.gz: b6c6bc62fa20aeb936610a14de238f99f39f66cc3597255f7ab8c440897526bd95d6aad5eecb56f43ce50716f3af4eac7700147203cd367c13ab78be7f83d3a7

data/.rubocop_todo.yml

@@ -86,12 +86,12 @@ Metrics/BlockLength:
 Metrics/BlockNesting:
   Max: 4
 
-# Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 186
+  Max: 100
   Exclude:
     - 'lib/blacklight/configuration.rb'
+    - 'lib/blacklight/search_builder.rb'
 
 # Offense count: 20
 Metrics/CyclomaticComplexity:

data/VERSION

@@ -1 +1 @@
-6.10.1
+6.11.0

data/app/controllers/concerns/blacklight/request_builders.rb

@@ -29,7 +29,11 @@ module Blacklight
     # Pagination parameters for selecting the previous and next documents
     # out of a result set.
     def previous_and_next_document_params(index, window = 1)
-      solr_params = {}
+      solr_params = blacklight_config.document_pagination_params.dup
+
+      if solr_params.empty?
+        solr_params[:fl] = '*'
+      end
 
       if index > 0
         solr_params[:start] = index - window # get one before
@@ -39,7 +43,6 @@ module Blacklight
         solr_params[:rows] = 2*window # but there should be one after
       end
 
-      solr_params[:fl] = '*'
       solr_params[:facet] = false
       solr_params
     end

data/app/controllers/concerns/blacklight/search_context.rb

@@ -36,7 +36,9 @@ module Blacklight::SearchContext
   end
 
   def find_search_session
-    if params[:search_context].present?
+    if agent_is_crawler?
+      nil
+    elsif params[:search_context].present?
       find_or_initialize_search_session_from_params JSON.parse(params[:search_context])
     elsif params[:search_id].present?
       begin
@@ -63,6 +65,16 @@ module Blacklight::SearchContext
     false
   end
 
+  ##
+  # Determine if the current request is coming from an anonymous bot
+  # or search crawler
+  #
+  def agent_is_crawler?
+    crawler_proc = blacklight_config.crawler_detector
+    return false if crawler_proc.nil? || current_user.present?
+    crawler_proc.call(request)
+  end
+
   def find_or_initialize_search_session_from_params params
     params_copy = params.reject { |k,v| blacklisted_search_session_params.include?(k.to_sym) or v.blank? }
 

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -17,7 +17,10 @@ module Blacklight::BlacklightHelperBehavior
   #
   # @return [String] the application name
   def application_name
-    return Rails.application.config.application_name if Rails.application.config.respond_to? :application_name
+    if Rails.application.config.respond_to? :application_name
+      Deprecation.warn(self, "BlacklightHelper#application_name will no longer delegate to config.application_name in version 7.0. Set the i18n for blacklight.application_name instead")
+      return Rails.application.config.application_name
+    end
 
     t('blacklight.application_name')
   end

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 module Blacklight::ConfigurationHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'blacklight 7.x'
+
   ##
   # Index fields to display for a type of document
   # 
@@ -13,6 +16,7 @@ module Blacklight::ConfigurationHelperBehavior
   def sort_fields
     active_sort_fields.map { |key, x| [x.label, x.key] }
   end
+  deprecation_deprecate :sort_fields
   
   def active_sort_fields
     blacklight_config.sort_fields.select { |sort_key, field_config| should_render_field?(field_config) }

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

@@ -1,4 +1,4 @@
-<% if show_sort_and_per_page? and !active_sort_fields.blank? %>
+<% if show_sort_and_per_page? and active_sort_fields.many? %>
 <div id="sort-dropdown" class="btn-group">
   <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
       <%= t('blacklight.search.sort.label', :field =>current_sort_field.label) %> <span class="caret"></span>

data/blacklight.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "rails", ">= 4.2", "< 6"
   s.add_dependency "globalid"
+  s.add_dependency "jbuilder"
   s.add_dependency "nokogiri",  "~>1.6"     # XML Parser
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.

data/lib/blacklight/configuration.rb

@@ -56,6 +56,7 @@ module Blacklight
             #facet: false,
             #rows: 1
           },
+          document_pagination_params: {},
           ##
           # == Response models
           ## Class for sending and receiving requests from a search index
@@ -137,7 +138,10 @@ module Blacklight
           # how many searches to save in session history
           search_history_window: 100,
           default_facet_limit: 10,
-          default_more_limit: 20
+          default_more_limit: 20,
+          # proc for determining whether the session is a crawler/bot
+          # ex.: crawler_detector: lambda { |req| req.env['HTTP_USER_AGENT'] =~ /bot/ }
+          crawler_detector: nil
           }
         end
       end

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

@@ -73,10 +73,12 @@ module Blacklight::Solr::Response::Spelling
       return unless spellcheck && spellcheck[:suggestions]
       suggestions = spellcheck[:suggestions]
 
-      if suggestions.index("collation")
+      if suggestions.is_a?(Array) && suggestions.index("collation")
+        # solr < 5 response
         suggestions[suggestions.index("collation") + 1]
       elsif spellcheck.key?("collations")
-        spellcheck['collations'].last
+        # solr 5+ response
+        spellcheck['collations'].last if spellcheck.key?("collations")
       end
     end
   end

data/spec/controllers/blacklight/search_helper_spec.rb

@@ -458,5 +458,13 @@ describe Blacklight::SearchHelper do
       expect(docs.last).to be_nil
       expect(docs.first).to be_nil
     end
+
+    it 'allows the query parameters to be customized using configuration' do
+      blacklight_config.document_pagination_params[:fl] = 'id,format'
+
+      response, docs = subject.get_previous_and_next_documents_for_search(0, :q => '')
+
+      expect(docs.last.to_h).to eq @all_docs[1].to_h.slice('id', 'format')
+    end
   end
 end

data/spec/features/search_crawler_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+RSpec.describe "Search History Page" do
+
+  describe "crawler search" do
+    let(:original_proc) { ::CatalogController.blacklight_config.crawler_detector }
+
+    before do
+      ::CatalogController.blacklight_config.crawler_detector = lambda { |req| req.env['HTTP_USER_AGENT'] =~ /Googlebot/ }
+    end
+
+    after do
+      ::CatalogController.blacklight_config.crawler_detector = original_proc
+    end
+
+    it "remembers human searches" do
+      visit root_path
+      fill_in "q", with: 'chicken'
+      expect { click_button 'search' }.to change { Search.count }.by(1)
+    end
+
+    it "doesn't remember bot searches" do
+      page.driver.header('User-Agent', 'Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)')
+      visit root_path
+      fill_in "q", with: 'chicken'
+      expect { click_button 'search' }.to_not change { Search.count }
+    end
+  end
+
+end

data/spec/views/catalog/_sort_widget.html.erb_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+RSpec.describe "catalog/_sort_widget" do
+  let(:blacklight_config) { Blacklight::Configuration.new }
+  let(:response) { instance_double(Blacklight::Solr::Response, empty?: false, sort: 'one') }
+
+  before do
+    allow(view).to receive_messages(blacklight_config: blacklight_config)
+    assign(:response, response)
+    controller.request.path_parameters[:action] = 'index'
+  end
+
+  context 'with no sort fields configured' do
+    it 'renders nothing' do
+      render
+      expect(rendered).to be_blank
+    end
+  end
+
+  context 'with a single sort field configured' do
+    before do
+      blacklight_config.add_sort_field 'one'
+    end
+    it 'renders nothing' do
+      render
+      expect(rendered).to be_blank
+    end
+  end
+
+  context 'with multiple sort fields configured' do
+    before do
+      blacklight_config.add_sort_field 'one'
+      blacklight_config.add_sort_field 'two'
+    end
+    it 'renders a dropdown with the various options' do
+      render
+      
+      expect(rendered).to have_button 'One'
+      expect(rendered).to have_link 'One'
+      expect(rendered).to have_link 'Two'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 6.10.1
+  version: 6.11.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,6 +53,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -635,6 +649,7 @@ files:
 - spec/features/record_view_spec.rb
 - spec/features/saved_searches_spec.rb
 - spec/features/search_context_spec.rb
+- spec/features/search_crawler_spec.rb
 - spec/features/search_filters_spec.rb
 - spec/features/search_formats_spec.rb
 - spec/features/search_history_spec.rb
@@ -717,6 +732,7 @@ files:
 - spec/views/catalog/_show_sidebar.erb_spec.rb
 - spec/views/catalog/_show_tools.html.erb_spec.rb
 - spec/views/catalog/_sort_and_per_page.html.erb_spec.rb
+- spec/views/catalog/_sort_widget.html.erb_spec.rb
 - spec/views/catalog/_thumbnail_default.erb_spec.rb
 - spec/views/catalog/_view_type_group.html.erb_spec.rb
 - spec/views/catalog/facet.html.erb_spec.rb
@@ -774,6 +790,7 @@ test_files:
 - spec/features/record_view_spec.rb
 - spec/features/saved_searches_spec.rb
 - spec/features/search_context_spec.rb
+- spec/features/search_crawler_spec.rb
 - spec/features/search_filters_spec.rb
 - spec/features/search_formats_spec.rb
 - spec/features/search_history_spec.rb
@@ -856,6 +873,7 @@ test_files:
 - spec/views/catalog/_show_sidebar.erb_spec.rb
 - spec/views/catalog/_show_tools.html.erb_spec.rb
 - spec/views/catalog/_sort_and_per_page.html.erb_spec.rb
+- spec/views/catalog/_sort_widget.html.erb_spec.rb
 - spec/views/catalog/_thumbnail_default.erb_spec.rb
 - spec/views/catalog/_view_type_group.html.erb_spec.rb
 - spec/views/catalog/facet.html.erb_spec.rb