blacklight 6.0.0.pre3 → 6.0.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ff860357fb3d2118c70ca7e8f1c4dc36bc496f4
-  data.tar.gz: 645e95ebad1081be628cd2c1f24f302b711fc2b1
+  metadata.gz: de33efb7e9513e4348986f8e64b4f2cfec107802
+  data.tar.gz: 74ac4159ee1072f93f3f54b8115e14d501d68773
 SHA512:
-  metadata.gz: c48d40732144a83f9708e0b12a1f6b29a603e667df94e2f7c79aeef0e86a58444241d2a63c32cd68e3835cad52716d7bf53f0a22a115416c0bb716153b1a4a3c
-  data.tar.gz: 0fb793e45aa4bb028cecc280a37f3c8a602b9d54d6fc70ebf52376edb16653bfe1492ec7f11703e4ee141efd9d4445e13dab39d2ec79220089a83cb2dac740f8
+  metadata.gz: f23fb77ae90ed8cbb00a6461643a4e3da47771ce25d02a717944722fe239b8d045d73206305e499d2b282f7cd6913eff624707c91adfba2721f83cd6ac37d1f9
+  data.tar.gz: 4c752134df04876f6bcc9831fe03071df4a7976657a5a15780226a02bc76d1b4ca5d77ab59d5b0f6c5e9cc67f8475ff0478a4f45643fd70312e414e51ff480b8

data/README.md

@@ -34,11 +34,11 @@ rails generate blacklight:install
 
 ## Dependencies
 
-* ruby v1.9.3 or higher 
+* ruby v2.0 or higher
 * git
 * access to a command prompt on the machine to install
 
-In addition, you must have the Bundler and Rails 4.0 gems installed. Other gem dependencies are defined in the blacklight.gemspec file and will be automatically loaded by Bundler.
+In addition, you must have the Bundler and Rails 4.1 (or greater) gems installed. Other gem dependencies are defined in the blacklight.gemspec file and will be automatically loaded by Bundler.
 
 ## Configuring Apache Solr 
 You'll also want some information about how Blacklight expects [Apache Solr](http://lucene.apache.org/solr ) to run, which you can find in [README_SOLR](https://github.com/projectblacklight/blacklight/wiki/README_SOLR)

data/VERSION

@@ -1 +1 @@
-6.0.0.pre3
+6.0.0.pre4

data/app/controllers/bookmarks_controller.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class BookmarksController < CatalogController  
 
   include Blacklight::Bookmarks

data/app/controllers/catalog_controller.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class CatalogController < ApplicationController  
 
   include Blacklight::Catalog

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Blacklight::Base
   extend ActiveSupport::Concern
 

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 # note that while this is mostly restful routing, the #update and #destroy actions
 # take the Solr document ID as the :id, NOT the id of the actual Bookmark action.
 module Blacklight::Bookmarks

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Blacklight::Catalog
   extend ActiveSupport::Concern
 
@@ -13,7 +12,7 @@ module Blacklight::Catalog
 
     helper Blacklight::Facet
 
-    # When an action raises Blacklight::Exceptions::RecordNotFound, handle 
+    # When an action raises Blacklight::Exceptions::RecordNotFound, handle
     # the exception appropriately.
     rescue_from Blacklight::Exceptions::RecordNotFound, with: :invalid_document_id_error
 
@@ -29,9 +28,11 @@ module Blacklight::Catalog
         format.rss  { render :layout => false }
         format.atom { render :layout => false }
         format.json do
-          render json: render_search_results_as_json
+          @presenter = Blacklight::JsonPresenter.new(@response,
+                                                     @document_list,
+                                                     facets_from_request,
+                                                     blacklight_config)
         end
-
         additional_response_formats(format)
         document_export_formats(format)
       end
@@ -76,7 +77,7 @@ module Blacklight::Catalog
       respond_to do |format|
         # Draw the facet selector for users who have javascript disabled:
         format.html
-        format.json { render json: render_facet_list_as_json }
+        format.json
 
         # Draw the partial for the "more" facet modal window:
         format.js { render :layout => false }
@@ -184,26 +185,6 @@ module Blacklight::Catalog
       render text: @response.documents.map { |x| x.export_as(format_name) if x.exports_as? format_name }.compact.join("\n"), layout: false
     end
 
-    # override this method to change the JSON response from #index 
-    def render_search_results_as_json
-      {response: {docs: @document_list, facets: search_facets_as_json, pages: pagination_info(@response)}}
-    end
-
-    def search_facets_as_json
-      facets_from_request.as_json.each do |f|
-        f.delete "options"
-        f["label"] = facet_configuration_for_field(f["name"]).label
-        f["items"] = f["items"].as_json.each do |i|
-          i['label'] ||= i['value']
-        end
-      end 
-    end
-
-    # override this method to change the JSON response from #facet 
-    def render_facet_list_as_json
-      {response: {facets: @pagination }}
-    end
-
     # Overrides the Blacklight::Controller provided #search_action_url.
     # By default, any search action from a Blacklight::Catalog controller
     # should use the current controller when constructing the route.
@@ -211,19 +192,6 @@ module Blacklight::Catalog
       url_for(options.merge(:action => 'index'))
     end
 
-    # extract the pagination info from the response object
-    def pagination_info response
-      h = {}
-
-      [:current_page, :next_page, :prev_page, :total_pages,
-       :limit_value, :offset_value, :total_count,
-       :first_page?, :last_page?].each do |k|
-        h[k] = response.send(k)
-      end
-
-      h
-    end
-
      # Email Action (this will render the appropriate view on GET requests and process the form and send the email on POST requests)
      def email_action documents
        mail = RecordMailer.email_record(documents, {:to => params[:to], :message => params[:message]}, url_options)

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

@@ -1,5 +1,3 @@
-# -*- encoding : utf-8 -*-
-#
 # Filters added to this controller apply to all controllers in the hosting application
 # as this module is mixed-in to the application controller in the hosting app on installation.
 module Blacklight::Controller 

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 ##
 # Module to deal with accessing (and setting some defaults) in an array of
 # hashes that describe Blacklight search fields.  Requires the base class this

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 # SearchHelper is a controller layer mixin. It is in the controller scope: request params, session etc.
 # 
 # NOTE: Be careful when creating variables here as they may be overriding something that already exists.
@@ -79,10 +78,6 @@ module Blacklight::SearchHelper
     if id.is_a? Array
       fetch_many(id, params, extra_controller_params)
     else
-      if id.nil?
-        Deprecation.warn Blacklight::SearchHelper, "Calling #fetch without an explicit id argument is deprecated and will be removed in Blacklight 6.0"
-        id ||= params[:id]
-      end
       fetch_one(id, extra_controller_params)
     end
   end

data/app/{models → controllers}/concerns/blacklight/token_based_user.rb

@@ -36,21 +36,17 @@ module Blacklight::TokenBasedUser
 
   # Used for #export action with encrypted user_id, available
   # as a helper method for views.
-  def encrypt_user_id(user_id)
-    message_encryptor.encrypt_and_sign([user_id, Time.zone.now])
+  def encrypt_user_id(user_id, current_time = nil)
+    current_time ||= Time.zone.now
+    message_encryptor.encrypt_and_sign([user_id, current_time])
   end
 
-  ##
-  # This method provides Rails 3 compatibility to our message encryptor.
-  # When we drop support for Rails 3, we can just use the AS::KeyGenerator
-  # directly instead of this helper.
-  def export_secret_token salt
-    OpenSSL::PKCS5.pbkdf2_hmac_sha1(Blacklight.secret_key, salt, 1000, 64)
+  def export_secret_token
+    ActiveSupport::KeyGenerator.new(Rails.application.secrets.secret_key_base).generate_key('encrypted user session key')
   end
 
   def message_encryptor
-    derived_secret = export_secret_token("encrypted user session key")
-    ActiveSupport::MessageEncryptor.new(derived_secret)
+    ActiveSupport::MessageEncryptor.new(export_secret_token)
   end
 
 end

data/app/controllers/saved_searches_controller.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class SavedSearchesController < ApplicationController
   include Blacklight::Configurable
 

data/app/controllers/search_history_controller.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class SearchHistoryController < ApplicationController
   include Blacklight::Configurable
 

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -1,8 +1,4 @@
-# -*- encoding : utf-8 -*-
-# -*- coding: utf-8 -*-
-#
 # Methods added to this helper will be available to all templates in the hosting application
-#
 module Blacklight::BlacklightHelperBehavior
   include BlacklightUrlHelper
   include BlacklightConfigurationHelper

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Blacklight::CatalogHelperBehavior
 
   ##
@@ -179,7 +178,9 @@ module Blacklight::CatalogHelperBehavior
     value = if blacklight_config.view_config(document_index_view_type).thumbnail_method
       send(blacklight_config.view_config(document_index_view_type).thumbnail_method, document, image_options)
     elsif blacklight_config.view_config(document_index_view_type).thumbnail_field
-      image_tag thumbnail_url(document), image_options
+      url = thumbnail_url(document)
+
+      image_tag url, image_options if url.present?
     end
 
     if value

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 # Rails Helper methods to take a hash and turn it to form <input type="hidden">
 # fields, works with hash nested with other hashes and arrays, standard rails
 # serialization style.  Oddly while Hash#to_query will do this for a URL

data/app/helpers/blacklight/layout_helper_behavior.rb

@@ -30,5 +30,13 @@ module Blacklight
     def sidebar_classes
       'col-md-3 col-sm-4'
     end
+
+    ##
+    # Class used for specifying main layout container classes. Can be
+    # overwritten to return 'container-fluid' for Bootstrap full-width layout
+    # @return [String] 
+    def container_classes
+      'container'
+    end
   end
 end

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 # All methods in here are 'api' that may be over-ridden by plugins and local
 # code, so method signatures and semantics should not be changed casually.
 # implementations can be of course.

data/app/helpers/blacklight/render_partials_helper.rb

@@ -39,12 +39,7 @@ module Blacklight::RenderPartialsHelper
   # @param [String] base name for the partial
   # @param [Hash] locales to pass through to the partials
   def render_document_partial(doc, base_name, locals = {})
-    format = if method(:document_partial_name).arity == 1
-      Deprecation.warn self, "The #document_partial_name with a single argument is deprecated. Update your override to include a second argument for the 'base name'"
-      document_partial_name(doc)
-    else
-      document_partial_name(doc, base_name)
-    end
+    format = document_partial_name(doc, base_name)
 
     view_type = document_index_view_type
     template = cached_view ['show', view_type, base_name, format].join('_') do

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 # All methods in here are 'api' that may be over-ridden by plugins and local
 # code, so method signatures and semantics should not be changed casually.
 # implementations can be of course.

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -12,17 +12,12 @@ module Blacklight::UrlHelperBehavior
   end
 
   # link_to_document(doc, 'VIEW', :counter => 3)
-  # link_to_document(doc, :label=>'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,
   # 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
       opts = field_or_opts
-      if opts[:label]
-        Deprecation.warn self, "The second argument to link_to_document should now be the label."
-        field = opts.delete(:label)
-      end
     else
       field = field_or_opts
     end
@@ -151,7 +146,7 @@ module Blacklight::UrlHelperBehavior
 
   # Get url parameters to a search within a grouped result set
   #
-  # @param [Blacklight::SolrResponse::Group]
+  # @param [Blacklight::Solr::Response::Group]
   # @return [Hash]
   def add_group_facet_params_and_redirect group
     search_state.add_facet_params_and_redirect(group.field, group.key)

data/app/models/blacklight/solr/facet_paginator.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Blacklight::Solr
   # Pagination for facet values -- works by setting the limit to max
   # displayable. You have to ask Solr for limit+1, to get enough

data/app/models/bookmark.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class Bookmark < ActiveRecord::Base
   
   belongs_to :user, polymorphic: true

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Blacklight::Configurable
   extend ActiveSupport::Concern
 

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 # This module provides the cache key which can be used by rails
 # caching to determine when to expire a particular object's cache
 # See http://apidock.com/rails/ActiveRecord/Integration/cache_key

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 # This module provides the body of an email export based on the document's semantic values
 module Blacklight::Document::Email
 

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 # This module provides the body of an email export based on the document's semantic values
 module Blacklight::Document::Sms
 

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'rsolr'
 ##
 ##
@@ -16,12 +15,6 @@ 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

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

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Blacklight::User
   # This gives us an is_blacklight_user method that can be included in
   # the containing applications models. 

data/app/models/record_mailer.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 # Only works for documents with a #to_marc right now. 
 class RecordMailer < ActionMailer::Base
   def email_record(documents, details, url_gen_params)

data/app/models/search.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 class Search < ActiveRecord::Base
 
   belongs_to :user
@@ -9,11 +8,6 @@ class Search < ActiveRecord::Base
     attr_accessible :query_params 
   end
 
-  unless respond_to?(:none)
-    # polyfill
-    scope :none, -> { where(id: nil).where("id IS NOT ?", nil) }
-  end
-
   # A Search instance is considered a saved search if it has a user_id.
   def saved?
     self.user_id?

data/app/presenters/blacklight/document_presenter.rb

@@ -99,29 +99,15 @@ module Blacklight
       options = {}
       options = field_config.separator_options if field_config && field_config.separator_options
 
-      if field_config && field_config.separator
-        Deprecation.warn(self.class, 'The field configuration #separator is deprecated. Use #separator_options instead')
-        options[:words_connector] ||= field_config.separator
-        options[:two_words_connector] ||= field_config.separator
-        options[:last_word_connector] ||= field_config.separator
-      end
-
       values.map { |x| html_escape(x) }.to_sentence(options).html_safe
     end
 
     ##
     # Render the document index heading
     #
-    # @param [Hash] opts (Deprecated)
-    # @option opts [Symbol] :label Render the given field from the document
-    # @option opts [Proc] :label Evaluate the given proc
-    # @option opts [String] :label Render the given string
     # @param [Symbol, Proc, String] field Render the given field or evaluate the proc or render the given string
-    def render_document_index_label field, opts ={}
-      if field.is_a? Hash
-        Deprecation.warn DocumentPresenter, "Calling render_document_index_label with a hash is deprecated"
-        field = field[:label]
-      end
+    # @param [Hash] opts
+    def render_document_index_label(field, opts = {})
       label = case field
       when Symbol
         @document[field]
@@ -211,7 +197,7 @@ module Blacklight
       # rendering values
       case
         when (field_config and field_config.helper_method)
-          @controller.send(field_config.helper_method, options.merge(:document => @document, :field => field, :value => value))
+          @controller.send(field_config.helper_method, options.merge(document: @document, field: field, config: field_config, value: value))
         when (field_config and field_config.link_to_search)
           link_field = if field_config.link_to_search === true
             field_config.key

data/app/presenters/blacklight/json_presenter.rb

@@ -0,0 +1,41 @@
+module Blacklight
+  class JsonPresenter
+    include Blacklight::Facet
+
+    # @param [Solr::Response] response raw solr response.
+    # @param [Array<SolrDocument>] documents a list of documents
+    # @param [Array] facets list of facets
+    def initialize(response, documents, facets, blacklight_config)
+      @response = response
+      @documents = documents
+      @facets = facets
+      @blacklight_config = blacklight_config
+    end
+
+    attr_reader :documents, :blacklight_config
+
+    def search_facets_as_json
+      @facets.as_json.each do |f|
+        f.delete "options"
+        f["label"] = facet_configuration_for_field(f["name"]).label
+        f["items"] = f["items"].as_json.each do |i|
+          i['label'] ||= i['value']
+        end
+      end
+    end
+
+
+    # extract the pagination info from the response object
+    def pagination_info
+      h = {}
+
+      [:current_page, :next_page, :prev_page, :total_pages,
+       :limit_value, :offset_value, :total_count,
+       :first_page?, :last_page?].each do |k|
+        h[k] = @response.send(k)
+      end
+
+      h
+    end
+  end
+end