blacklight 6.0.0.pre4 → 6.0.0.pre5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de33efb7e9513e4348986f8e64b4f2cfec107802
-  data.tar.gz: 74ac4159ee1072f93f3f54b8115e14d501d68773
+  metadata.gz: 7626335c66be4201927a8a1afbe8df051da1b4b0
+  data.tar.gz: 5bd3bfaac1b8b69940573d3172c7e0e8a97522af
 SHA512:
-  metadata.gz: f23fb77ae90ed8cbb00a6461643a4e3da47771ce25d02a717944722fe239b8d045d73206305e499d2b282f7cd6913eff624707c91adfba2721f83cd6ac37d1f9
-  data.tar.gz: 4c752134df04876f6bcc9831fe03071df4a7976657a5a15780226a02bc76d1b4ca5d77ab59d5b0f6c5e9cc67f8475ff0478a4f45643fd70312e414e51ff480b8
+  metadata.gz: 814188a4b39df6c79dc2c993e0bc1ab879028b071b4341efcd4ebdb30594d1c3a8efb64b317d2f8e808d9dbc7ad029f5d313aff387711f2c21d6e8d7ac9107b0
+  data.tar.gz: 11a6ea22038b58e3240397a7e36dfe16c8c28730e18cbcedbe6fca188887fcce3ad8ff511757b5fe0d7c013420a458a424de3cb0c10fc4d01415c6c703248b3a

data/VERSION

@@ -1 +1 @@
-6.0.0.pre4
+6.0.0.pre5

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

@@ -12,7 +12,7 @@ module Blacklight::Bookmarks
 
     copy_blacklight_config_from(CatalogController)
 
-    before_filter :verify_user
+    before_action :verify_user
 
     blacklight_config.add_results_collection_tool(:clear_bookmarks_widget)
 
@@ -97,7 +97,7 @@ module Blacklight::Bookmarks
   # Beware, :id is the Solr document_id, not the actual Bookmark id.
   # idempotent, as DELETE is supposed to be.
   def destroy
-    bookmark = current_or_guest_user.bookmarks.find_by(document_id: params[:id], document_type: blacklight_config.document_model)
+    bookmark = current_or_guest_user.bookmarks.find_by(document_id: params[:id], document_type: blacklight_config.document_model.to_s)
 
     if bookmark && bookmark.delete && bookmark.destroyed?
       if request.xhr?

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

@@ -249,6 +249,8 @@ module Blacklight::Catalog
     # CatalogController to do something else -- older BL displayed a Catalog#inde
     # page with a flash message and a 404 status.
     def invalid_document_id_error(exception)
+      raise exception unless Pathname.new("#{Rails.root}/public/404.html").exist?
+
       error_info = {
         "status" => "404",
         "error"  => "#{exception.class}: #{exception.message}"

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

@@ -11,7 +11,7 @@ module Blacklight::SearchContext
   module ClassMethods
     # Save the submitted search parameters in the search session
     def record_search_parameters opts = { only: :index}
-      before_filter :current_search_session, opts
+      before_action :current_search_session, opts
     end
   end
   
@@ -93,7 +93,7 @@ module Blacklight::SearchContext
   def setup_next_and_previous_documents
     if search_session['counter'] and current_search_session
       index = search_session['counter'].to_i - 1
-      response, documents = get_previous_and_next_documents_for_search index, current_search_session.query_params.with_indifferent_access
+      response, documents = get_previous_and_next_documents_for_search index, ActiveSupport::HashWithIndifferentAccess.new(current_search_session.query_params)
 
       search_session['total'] = response.total
       @search_context_response = response

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

@@ -48,7 +48,7 @@ module Blacklight::SearchHelper
   include Blacklight::RequestBuilders
 
   # a solr query method
-  # @param [Hash,HashWithIndifferentAccess] user_params ({}) the user provided parameters (e.g. query, facets, sort, etc)
+  # @param [Hash] user_params ({}) the user provided parameters (e.g. query, facets, sort, etc)
   # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used. 
   # @return [Blacklight::Solr::Response] the solr response object
   def search_results(user_params)

data/app/controllers/saved_searches_controller.rb

@@ -2,8 +2,8 @@ class SavedSearchesController < ApplicationController
   include Blacklight::Configurable
 
   copy_blacklight_config_from(CatalogController)
-  before_filter :require_user_authentication_provider
-  before_filter :verify_user 
+  before_action :require_user_authentication_provider
+  before_action :verify_user
   
   def index
     @searches = current_user.searches

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -13,7 +13,7 @@ module Blacklight::UrlHelperBehavior
 
   # link_to_document(doc, 'VIEW', :counter => 3)
   # Use the catalog_path RESTful route to create a link to the show page for a specific item.
-  # catalog_path accepts a HashWithIndifferentAccess object. The solr query params are stored in the session,
+  # catalog_path accepts a hash. The solr query params are stored in the session,
   # so we only need the +counter+ param here. We also need to know if we are viewing to document as part of search results.
   def link_to_document(doc, field_or_opts = nil, opts={:counter => nil})
     if field_or_opts.is_a? Hash

data/app/models/bookmark.rb

@@ -14,7 +14,9 @@ class Bookmark < ActiveRecord::Base
   end
   
   def document_type
-    (super.constantize if defined?(super)) || default_document_type
+    value = super if defined?(super)
+    value &&= value.constantize
+    value ||= default_document_type
   end
   
   def default_document_type

data/app/models/concerns/blacklight/document.rb

@@ -39,7 +39,7 @@ module Blacklight::Document
   alias_method :solr_response, :response
 
   def initialize(source_doc={}, response=nil)
-    @_source = source_doc.with_indifferent_access
+    @_source = ActiveSupport::HashWithIndifferentAccess.new(source_doc)
     @response = response
     apply_extensions
   end

data/app/models/concerns/blacklight/document/active_model_shim.rb

@@ -59,6 +59,10 @@ module Blacklight::Document
       false
     end
 
+    def marked_for_destruction?
+      false
+    end
+
     ##
     # #to_partial_path is also defined in Blacklight::Document, but
     # ActiveModel::Conversion (included above) will overwrite that..

data/app/models/concerns/blacklight/document/export.rb

@@ -56,13 +56,9 @@ module Blacklight::Document::Export
   # registered. This is a bit sketchy though. 
   def will_export_as(short_name, content_type = nil)
     #Lookup in Rails Mime::Type, register if needed, otherwise take
-    # content-type from registration if needed. This uses
-    # some 'api' to Mime::Type that may or may not be entirely
-    # public, the fact that a Mime::CONST is registered for every
-    # type. But that's the only way to do the kind of check we need, sorry.
-    if defined?(Mime) && Mime.const_defined?(short_name.to_s.upcase)      
-      mime_type = "Mime::#{short_name.to_s.upcase}".constantize
-      content_type ||= mime_type.to_s
+    # content-type from registration if needed.
+    if defined?(Mime) && Mime[short_name.to_sym]
+      content_type ||= Mime[short_name.to_sym]
     else
       # not registered, we need to register. Use register_alias to be least
       # likely to interfere with host app. 

data/app/models/concerns/blacklight/user.rb

@@ -12,7 +12,7 @@ module Blacklight::User
 
   def bookmarks_for_documents documents = []
     if documents.length > 0
-      bookmarks.where(document_type: documents.first.class.base_class, document_id: documents.map(&:id))
+      bookmarks.where(document_type: documents.first.class.base_class.to_s, document_id: documents.map(&:id))
     else
       []
     end

data/app/views/layouts/blacklight.html.erb

@@ -18,7 +18,7 @@
 
     <title><%= render_page_title %></title>
     <%= opensearch_description_tag application_name, opensearch_catalog_url(:format => 'xml') %>
-    <%= favicon_link_tag 'favicon.ico' %>
+    <%= favicon_link_tag %>
     <%= stylesheet_link_tag "application", media: "all" %>
     <%= javascript_include_tag "application" %>
     <%= csrf_meta_tags %>

data/lib/blacklight.rb

@@ -1,6 +1,7 @@
 require 'kaminari'
 require 'deprecation'
 require 'blacklight/utils'
+require 'active_support/hash_with_indifferent_access'
 
 module Blacklight
   autoload :AbstractRepository, 'blacklight/abstract_repository'

data/lib/blacklight/abstract_repository.rb

@@ -16,6 +16,21 @@ module Blacklight
       @connection ||= build_connection
     end
 
+    ##
+    # Find a single document result by a known id
+    # @param [String] document's unique key value
+    # @param [Hash] additional query parameters
+    def find(id, params = {})
+      fail NotImplementedError
+    end
+
+    ##
+    # Execute a search query against a search index
+    # @param [Hash] query parameters
+    def search(params = {})
+      fail NotImplementedError
+    end
+
     protected
       def connection_config
         blacklight_config.connection_config

data/lib/blacklight/engine.rb

@@ -26,6 +26,10 @@ module Blacklight
       end
     end
 
+    initializer "blacklight.assets.precompile" do |app|
+      app.config.assets.precompile += %w(favicon.ico)
+    end
+
     Blacklight::Engine.config.sms_mappings = {
       'Virgin' => 'vmobl.com',
       'AT&T' => 'txt.att.net',

data/lib/blacklight/search_builder.rb

@@ -1,4 +1,8 @@
 module Blacklight
+  ##
+  # Blacklight's SearchBuilder converts blacklight request parameters into
+  # query parameters appropriate for search index. It does so by evaluating a
+  # chain of processing methods to populate a result hash (see {#to_hash}).
   class SearchBuilder
     extend Deprecation
     class_attribute :default_processor_chain
@@ -106,7 +110,7 @@ module Blacklight
     delegate :[], :key?, to: :to_hash
 
     # a solr query method
-    # @param [Hash,HashWithIndifferentAccess] extra_controller_params (nil) extra parameters to add to the search
+    # @param [Hash] extra_controller_params (nil) extra parameters to add to the search
     # @return [Blacklight::Solr::Response] the solr response object
     def to_hash
       if params_need_update?

data/lib/blacklight/search_state.rb

@@ -115,7 +115,7 @@ module Blacklight
     # Reset any search parameters that store search context
     # and need to be reset when e.g. constraints change
     def reset_search_params
-      Parameters.sanitize(params).except(:page, :counter).with_indifferent_access
+      ActiveSupport::HashWithIndifferentAccess.new(Parameters.sanitize(params).except(:page, :counter))
     end
 
     # TODO: this code is duplicated in Blacklight::FacetsHelperBehavior

data/lib/blacklight/solr/request.rb

@@ -1,6 +1,6 @@
 class Blacklight::Solr::InvalidParameter < ArgumentError; end
 
-class Blacklight::Solr::Request < HashWithIndifferentAccess
+class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess
 
   SINGULAR_KEYS = %w{facet fl q qt rows start spellcheck spellcheck.q sort per_page wt hl group defType}
   ARRAY_KEYS = %w{facet.field facet.query facet.pivot fq hl.fl}

data/lib/blacklight/solr/response.rb

@@ -1,4 +1,4 @@
-class Blacklight::Solr::Response < HashWithIndifferentAccess
+class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
   extend Deprecation
 
   # Using required_dependency to work around Rails autoloading
@@ -22,8 +22,8 @@ class Blacklight::Solr::Response < HashWithIndifferentAccess
   attr_accessor :document_model, :blacklight_config
 
   def initialize(data, request_params, options = {})
-    super(force_to_utf8(data))
-    @request_params = request_params
+    super(force_to_utf8(ActiveSupport::HashWithIndifferentAccess.new(data)))
+    @request_params = ActiveSupport::HashWithIndifferentAccess.new(request_params)
     self.document_model = options[:solr_document_model] || options[:document_model] || SolrDocument
     self.blacklight_config = options[:blacklight_config]
   end

data/lib/blacklight/utils.rb

@@ -153,7 +153,21 @@ module Blacklight
     # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
     def merge! other_hash
       @table.merge!(nested_class, (other_hash if other_hash.is_a? Hash) || other_hash.to_h)
-    end 
+    end
+
+    ##
+    # Override #method_missing from OpenStruct to ensure the default_proc logic
+    # gets triggered.
+    def method_missing(mid, *args)
+      len = args.length
+
+      if len == 0
+        new_ostruct_member(mid)
+        @table[mid]
+      else
+        super
+      end
+    end
 
     private
     def set_default_proc!

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

@@ -3,6 +3,15 @@ class <%= controller_name.classify %>Controller < ApplicationController
   include Blacklight::Catalog
 
   configure_blacklight do |config|
+    ## Class for sending and receiving requests from a search index
+    # config.repository_class = Blacklight::Solr::Repository
+    #
+    ## Class for converting Blacklight's url parameters to into request parameters for the search index
+    # config.search_builder_class = ::SearchBuilder
+    #
+    ## Model that maps search index responses to the blacklight response model
+    # config.response_model = Blacklight::Solr::Response
+
     ## Default parameters to send to solr for all search-like requests. See also SearchBuilder#processed_parameters
     config.default_solr_params = {
       rows: 10

data/spec/controllers/blacklight/base_spec.rb

@@ -5,7 +5,7 @@ describe Blacklight::Base do
   subject { controller}
 
   describe "#search_state" do
-    let(:params) { double }
+    let(:params) { { a: 1 } }
     before { allow(controller).to receive_messages(params: params) }
     subject { controller.send(:search_state) }
 

data/spec/helpers/catalog_helper_spec.rb

@@ -10,7 +10,7 @@ describe CatalogHelper do
     total = args[:total]
     start = (current_page - 1) * per_page
 
-    mock_docs = (1..total).to_a.map { {}.with_indifferent_access }
+    mock_docs = (1..total).to_a.map { ActiveSupport::HashWithIndifferentAccess.new }
 
     mock_response = Kaminari.paginate_array(mock_docs).page(current_page).per(per_page)
 

data/spec/helpers/facets_helper_spec.rb

@@ -111,7 +111,7 @@ describe FacetsHelper do
     end
 
     it "should not be collapsed if it is in the params" do
-      params[:f] = { basic_field: [1], no_collapse: [2] }.with_indifferent_access
+      params[:f] = ActiveSupport::HashWithIndifferentAccess.new(basic_field: [1], no_collapse: [2])
       expect(helper.should_collapse_facet?(@config.facet_fields['basic_field'])).to be false
       expect(helper.should_collapse_facet?(@config.facet_fields['no_collapse'])).to be false
     end

data/spec/models/blacklight/solr/repository_spec.rb

@@ -51,11 +51,11 @@ describe Blacklight::Solr::Repository do
     end
 
     it "should preserve the class of the incoming params" do
-      doc_params = HashWithIndifferentAccess.new
+      doc_params = ActiveSupport::HashWithIndifferentAccess.new
       allow(subject.connection).to receive(:send_and_receive).with('select', anything).and_return(mock_response)
       response = subject.find("123", doc_params)
       expect(response).to be_a_kind_of Blacklight::Solr::Response
-      expect(response.params).to be_a_kind_of HashWithIndifferentAccess
+      expect(response.params).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
     end
   end
 
@@ -84,13 +84,13 @@ describe Blacklight::Solr::Repository do
     end
     
     it "should preserve the class of the incoming params" do
-      search_params = HashWithIndifferentAccess.new
+      search_params = ActiveSupport::HashWithIndifferentAccess.new
       search_params[:q] = "query"
       allow(subject.connection).to receive(:send_and_receive).with('select', anything).and_return(mock_response)
       
       response = subject.search(search_params)
       expect(response).to be_a_kind_of Blacklight::Solr::Response
-      expect(response.params).to be_a_kind_of HashWithIndifferentAccess
+      expect(response.params).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
     end
   end
 

data/spec/models/blacklight/solr/response/facets_spec.rb

@@ -26,7 +26,7 @@ describe Blacklight::Solr::Response::Facets do
     let(:facet_field) { ['my_field', []] }
     let(:response_header) { { params: request_params }}
     let(:request_params) { Hash.new }
-    subject { Blacklight::Solr::Response.new({responseHeader: response_header, facet_counts: { facet_fields: [facet_field] }}.with_indifferent_access, request_params)  }
+    subject { Blacklight::Solr::Response.new({responseHeader: response_header, facet_counts: { facet_fields: [facet_field] }}, request_params)  }
 
     describe "#limit" do
       it "should extract a field-specific limit value" do

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

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe "catalog/_paginate_compact.html.erb" do
+  let(:user) { User.new.tap { |u| u.save(validate: false) } }
 
   describe "with a real solr response", :integration => true do  
     def blacklight_config
@@ -33,7 +34,7 @@ describe "catalog/_paginate_compact.html.erb" do
   end
 
   it "should render ActiveRecord collections" do
-    50.times { b = Bookmark.new;  b.user_id = 1; b.save! }
+    50.times { b = Bookmark.new;  b.user = user; b.save! }
     render :partial => 'catalog/paginate_compact', :object => Bookmark.page(1).per(25)
     expect(rendered).to have_selector ".page_entries"
     expect(rendered).to have_selector "a[@rel=next]"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 6.0.0.pre4
+  version: 6.0.0.pre5
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2015-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails