blacklight 6.0.0.pre5 → 6.0.0

data/lib/blacklight/solr.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   module Solr
     autoload :Repository, 'blacklight/solr/repository'

data/lib/blacklight/solr/repository.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::Solr
   class Repository < Blacklight::AbstractRepository
 

data/lib/blacklight/solr/request.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Blacklight::Solr::InvalidParameter < ArgumentError; end
 
 class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess

data/lib/blacklight/solr/response.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
   extend Deprecation
 
@@ -91,7 +92,12 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
       when Array
         value.each { |v| force_to_utf8(v) }
       when String
-        value.force_encoding("utf-8")  if value.respond_to?(:force_encoding) 
+        if value.encoding != Encoding::UTF_8
+          Rails.logger.warn "Found a non utf-8 value in Blacklight::Solr::Response. \"#{value}\" Encoding is #{value.encoding}"
+          value.dup.force_encoding('UTF-8')
+        else
+          value
+        end
       end
       value
     end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ostruct'
 
 module Blacklight::Solr::Response::Facets

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Blacklight::Solr::Response::Group
 
   include Blacklight::Solr::Response::PaginationMethods

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Blacklight::Solr::Response::GroupResponse
 
   include Blacklight::Solr::Response::PaginationMethods

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::Solr::Response::MoreLikeThis
   def more_like document
     mlt = more_like_this[document.id]

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::Solr::Response::PaginationMethods
 
   include Kaminari::PageScopeMethods

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::Solr::Response::Response
   def response
     self[:response] || {}

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # A mixin for making access to the spellcheck component data easy.
 #
 # response.spelling.words

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::Solr
   module SearchBuilderBehavior
     extend ActiveSupport::Concern
@@ -107,16 +108,6 @@ module Blacklight::Solr
     # taking account of our facet paging/'more'.  This is not
     # about solr 'fq', this is about solr facet.* params.
     def add_facetting_to_solr(solr_parameters)
-      # While not used by BL core behavior, legacy behavior seemed to be
-      # to accept incoming params as "facet.field" or "facets", and add them
-      # on to any existing facet.field sent to Solr. Legacy behavior seemed
-      # to be accepting these incoming params as arrays (in Rails URL with []
-      # on end), or single values. At least one of these is used by
-      # Stanford for "faux hieararchial facets".
-      if blacklight_params.has_key?("facet.field") || blacklight_params.has_key?("facets")
-        solr_parameters[:"facet.field"].concat( [blacklight_params["facet.field"], blacklight_params["facets"]].flatten.compact ).uniq!
-      end
-
       facet_fields_to_include_in_request.each do |field_name, facet|
         solr_parameters[:facet] ||= true
 
@@ -139,10 +130,8 @@ module Blacklight::Solr
           end
         end
 
-        # Support facet paging and 'more'
-        # links, by sending a facet.limit one more than what we
-        # want to page at, according to configured facet limits.
-        solr_parameters[:"f.#{facet.field}.facet.limit"] = (facet_limit_for(field_name) + 1) if facet_limit_for(field_name)
+        limit = facet_limit_with_pagination(field_name)
+        solr_parameters[:"f.#{facet.field}.facet.limit"] = limit if limit
       end
     end
 
@@ -254,6 +243,22 @@ module Blacklight::Solr
       end
     end
 
+    # Support facet paging and 'more'
+    # links, by sending a facet.limit one more than what we
+    # want to page at, according to configured facet limits.
+    def facet_limit_with_pagination(field_name)
+      limit = facet_limit_for(field_name)
+
+      return if limit.nil?
+
+      if limit > 0
+        limit + 1
+      else
+        limit
+      end
+    end
+
+
     ##
     # A helper method used for generating solr LocalParams, put quotes
     # around the term unless it's a bare-word. Escape internal quotes

data/lib/blacklight/utils.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ostruct'
 module Blacklight
 

data/lib/blacklight/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   unless Blacklight.const_defined? :VERSION
     def self.version

data/lib/generators/blacklight/assets_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class Assets < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)

data/lib/generators/blacklight/controller_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class ControllerGenerator < Rails::Generators::Base
     

data/lib/generators/blacklight/document_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators'
 
 module Blacklight

data/lib/generators/blacklight/install_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class Install < Rails::Generators::Base
     

data/lib/generators/blacklight/models_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators'
 require 'rails/generators/migration'
 

data/lib/generators/blacklight/search_builder_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators'
 
 module Blacklight

data/lib/generators/blacklight/solr4_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators'
 
 module Blacklight

data/lib/generators/blacklight/solr5_generator.rb

@@ -9,8 +9,8 @@ module Blacklight
     EOF
 
     def install_solrwrapper
-      gem 'solr_wrapper', '>= 0.3' 
-   
+      gem 'solr_wrapper', '>= 0.3'
+
       append_to_file "Rakefile", "\nrequire 'solr_wrapper/rake_task'\n"
     end
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class AlternateController < CatalogController  
   configure_blacklight do |config|
     config.index.thumbnail_method = :xyz

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class <%= controller_name.classify %>Controller < ApplicationController
 
   include Blacklight::Catalog

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class SearchBuilder < Blacklight::SearchBuilder
   include Blacklight::Solr::SearchBuilderBehavior
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class <%= model_name.classify %> 
 
   include Blacklight::Solr::Document

data/lib/generators/blacklight/test_support_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copy Blacklight test support material in place
 
 

data/lib/generators/blacklight/user_generator.rb

@@ -18,7 +18,11 @@ This generator makes the following changes to your application:
     # Install Devise?
     def generate_devise_assets
       if options[:devise]
-        gem "devise"
+        if ENV['RAILS_VERSION'] =~ /^5\.0/ || ENV['RAILS_VERSION'] == 'edge'
+          gem 'devise', github: 'plataformatec/devise' # Need > 3.5.3
+        else
+          gem "devise"
+        end
         gem "devise-guests", "~> 0.3"
 
         Bundler.with_clean_env do
@@ -31,11 +35,11 @@ This generator makes the following changes to your application:
 
         # add the #to_s to the model.
         insert_into_file("app/models/#{model_name}.rb", before: /end(\n| )*$/) do
-          "\n  # Method added by Blacklight; Blacklight uses #to_s on your\n" +
-          "  # user class to get a user-displayable login/identifier for\n" +
-          "  # the account.\n" +
-          "  def to_s\n" +
-          "    email\n" +
+          "\n  # Method added by Blacklight; Blacklight uses #to_s on your\n" \
+          "  # user class to get a user-displayable login/identifier for\n" \
+          "  # the account.\n" \
+          "  def to_s\n" \
+          "    email\n" \
           "  end\n"
         end
         gsub_file("config/initializers/devise.rb", "config.sign_out_via = :delete", "config.sign_out_via = :get")

data/lib/railties/blacklight.rake

@@ -73,10 +73,10 @@ namespace :blacklight do
         puts e.to_s
       end
 
-      print " - get_search_results: "
-  
+      print " - search_results: "
+
       begin
-        response, docs = controller.get_search_results({}, q: '{!lucene}*:*')
+        response, docs = controller.search_results(q: '{!lucene}*:*')
 
         if response.header['status'] == 0 and docs.length > 0
           puts "OK"

data/spec/controllers/alternate_controller_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe AlternateController do

data/spec/controllers/application_controller_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe ApplicationController do

data/spec/controllers/blacklight/base_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Blacklight::Base do
@@ -5,13 +6,14 @@ describe Blacklight::Base do
   subject { controller}
 
   describe "#search_state" do
-    let(:params) { { a: 1 } }
+    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
-      expect(subject.params).to be params
+      expect(subject.params).to eq raw_params
     end
   end
-end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Blacklight::DefaultComponentConfiguration do

data/spec/controllers/blacklight/facet_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Blacklight::Facet do

data/spec/controllers/blacklight/search_fields_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Blacklight::SearchFields do

data/spec/controllers/blacklight/search_helper_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 # check the methods that do solr requests. Note that we are not testing if

data/spec/controllers/blacklight/suggest_search_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Blacklight::SuggestSearch do

data/spec/controllers/bookmarks_controller_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe BookmarksController do

data/spec/controllers/catalog_controller_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe CatalogController do
@@ -6,8 +7,8 @@ describe CatalogController do
     describe "with format :html" do
       let(:user_query) { 'history' } # query that will get results
 
-      it "should have no search history if no search criteria" do
-        allow(controller).to receive(:get_search_results) 
+      it "has no search history if no search criteria" do
+        allow(controller).to receive(:search_results)
         session[:history] = []
         get :index
         expect(session[:history]).to be_empty
@@ -74,13 +75,13 @@ describe CatalogController do
 
       describe "session" do
         before do
-          allow(controller).to receive(:get_search_results) 
+          allow(controller).to receive(:search_results)
         end
-        it "should include search hash with key :q" do
+        it "includes search hash with key :q" do
           get :index, q: user_query
           expect(session[:search]).to_not be_nil
           expect(session[:search].keys).to include 'id'
-          
+
           search = Search.find(session[:search]['id'])
           expect(search.query_params['q']).to eq user_query
         end
@@ -98,8 +99,8 @@ describe CatalogController do
         end
       end
 
-      it "should render index.html.erb" do
-        allow(controller).to receive(:get_search_results)
+      it "renders index.html.erb" do
+        allow(controller).to receive(:search_results)
         get :index
         expect(response).to render_template(:index)
       end
@@ -162,7 +163,7 @@ describe CatalogController do
 
       before :each do
         allow(@controller).to receive_messages blacklight_config: blacklight_config
-        allow(@controller).to receive_messages get_search_results: [double, double]
+        allow(@controller).to receive_messages search_results: [double, double]
       end
 
       it "should not render when the config is false" do
@@ -170,7 +171,7 @@ describe CatalogController do
         expect { get :index, format: 'yaml' }.to raise_error ActionController::RoutingError
       end
 
-      it "should render the default when the config is true" do
+      it "renders the default when the config is true" do
         # TODO: this should really stub a template and see if it gets rendered,
         # but how to do that is non-obvious..
         blacklight_config.index.respond_to.yaml = true
@@ -524,7 +525,7 @@ describe CatalogController do
 
     it "should return status 500 if the catalog path is raising an exception" do
       fake_error = Blacklight::Exceptions::InvalidRequest.new
-      allow(controller).to receive(:get_search_results) { |*args| raise fake_error }
+      allow(controller).to receive(: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 Blacklight::Exceptions::InvalidRequest
@@ -598,16 +599,18 @@ describe CatalogController do
   end
 
   describe "current_search_session" do
+    let(:parameter_class) { ActionController::Parameters }
+
     it "should create a session if we're on an search action" do
       allow(controller).to receive_messages(:action_name => "index")
-      allow(controller).to receive_messages(:params => { :q => "x", :page => 5})
+      allow(controller).to receive_messages(params: parameter_class.new(q: "x", page: 5))
       session = controller.send(:current_search_session)
       expect(session.query_params).to include(:q => "x")
       expect(session.query_params).to_not include(:page => 5)
     end
 
     it "should create a session if a search context was provided" do
-      allow(controller).to receive_messages(:params => { :search_context => JSON.dump(:q => "x")})
+      allow(controller).to receive_messages(params: parameter_class.new(search_context: JSON.dump(:q => "x")))
       session = controller.send(:current_search_session)
       expect(session.query_params).to include("q" => "x")
     end
@@ -616,7 +619,7 @@ describe CatalogController do
       s = Search.create(:query_params => { :q => "x" })
       session[:history] ||= []
       session[:history] << s.id
-      allow(controller).to receive_messages(:params => { :search_id => s.id})
+      allow(controller).to receive_messages(params: parameter_class.new(search_id: s.id))
       session = controller.send(:current_search_session)
       expect(session.query_params).to include(:q => "x")
       expect(session).to eq(s)
@@ -660,7 +663,7 @@ describe CatalogController do
         get 'catalog/like', as: :catalog_like
       end
     end
- 
+
     after do
       CatalogController.blacklight_config.show.document_actions.delete(:like)
       Rails.application.reload_routes!