blacklight 6.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56c35c6ca23b02b1ca6e11d7ba4eca20e6e98765
-  data.tar.gz: e84c2c02337bd0ff644922c8007b8aa700b1a0bc
+  metadata.gz: 38e64adb886cc4afffadc21d807dd85b7f919bef
+  data.tar.gz: 6d422b5862b493b3f5b4db3d163c3dbed749bae3
 SHA512:
-  metadata.gz: 9e78806fd48f0861fba67936341782d9411b45719688c9fc1fe08cd4e3cc1a8e5675ab3496c185ae16ad2b0a8019a9d2b0b535d36f6284e5a2d2c21623424064
-  data.tar.gz: 2e72ce5c749e044c9c60383341ef872ba427feeb4da4172adbf3bd257e41ea5cd7eb6d653d0a6fc0ee57cdee2fb70d5e0e2d55df2ae85b3045584a27eea819f1
+  metadata.gz: 0b9ff4de640f01ff5ee90d2a10b6b8d2d36b7c746890ab7f19403c85a6cc92a1afe058d5ea79a616aaefe4c8f4f777210c5452e112b26c066e2743cfb99f154c
+  data.tar.gz: 6ff37f57181bd54aa43531ef7beae404c787b2c94bab6a2fbe3d0652420ab3f3c1f03b1efb3e7a934ae09ba1c82c7bb381b87d992796742e899b81fc203cccb1

data/.rubocop.yml

@@ -14,3 +14,6 @@ Metrics/LineLength:
 
 Style/StringLiterals:
   Enabled: false
+
+Style/IndentationConsistency:
+  Enabled: false

data/.solr_wrapper

@@ -0,0 +1,5 @@
+# Place any default configuration for solr_wrapper here
+# port: 8983
+collection:
+  dir: solr/conf/
+  name: blacklight-core

data/.travis.yml

@@ -9,12 +9,10 @@ rvm:
 
 matrix:
   include:
-    - rvm: 2.1.9
+    - rvm: 2.3.1
       env: "RAILS_VERSION=4.2.6"
     - rvm: 2.2.5
-      env: "RAILS_VERSION=4.2.6"
-    - rvm: 2.3.1
-      env: "RAILS_VERSION=5.0.0.rc1"
+      env: "RAILS_VERSION=5.0.0"
     - rvm: jruby-9.0.5.0
       env: "RAILS_VERSION=4.2.6 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
   allow_failures:
@@ -25,7 +23,7 @@ before_install:
   - gem install bundler
 
 env:
- - "RAILS_VERSION=4.2.6"
+ - "RAILS_VERSION=5.0.0"
 
 notifications:
   irc: "irc.freenode.org#blacklight"

data/Gemfile

@@ -34,11 +34,11 @@ else
     end
   end
 
-  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^4\.2/
+  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^5\.0/ || ENV['RAILS_VERSION'] == 'edge'
+    gem 'rspec-rails', '>= 3.5.0.beta4', '~> 3.5'
+  elsif ENV['RAILS_VERSION'] =~ /^4\.2/
     gem 'responders', "~> 2.0"
     gem 'sass-rails', ">= 5.0"
-  elsif ENV['RAILS_VERSION'] =~ /^5\.0/ || ENV['RAILS_VERSION'] == 'edge'
-    # nop
   else
     gem 'bootstrap-sass', '< 3.3.5' # 3.3.5 requires sass 3.3, incompatible with sass-rails 4.x
     gem 'sass-rails', "< 5.0"

data/VERSION

@@ -1 +1 @@
-6.2.0
+6.3.0

data/app/assets/javascripts/blacklight/core.js

@@ -9,17 +9,31 @@ Blacklight = function() {
       for(var i = 0; i < buffer.length; i++) {
         buffer[i].call();
       }
+    },
+
+    listeners: function () {
+      var listeners = [];
+      if (Turbolinks && Turbolinks.supported) {
+        // Turbolinks 5
+        if (Turbolinks.BrowserAdapter) {
+          listeners.push('turbolinks:load');
+        } else {
+          // Turbolinks < 5
+          listeners.push('page:load', 'ready');
+        }
+      } else {
+        listeners.push('ready');
+      }
+
+      return listeners.join(' ');
     }
-  }
+  };
 }();
 
 // turbolinks triggers page:load events on page transition
 // If app isn't using turbolinks, this event will never be triggered, no prob. 
-$(document).on('page:load', function() {
+$(document).on(Blacklight.listeners(), function() {
   Blacklight.activate();  
 });
 
-$(document).ready(function() {
-  Blacklight.activate();  
-});
 

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -7,6 +7,8 @@ module Blacklight::BlacklightHelperBehavior
   include RenderConstraintsHelper
   include RenderPartialsHelper
   include FacetsHelper
+  extend Deprecation
+  self.deprecation_horizon = 'Blacklight version 7.0.0'
 
   ##
   # Get the name of this application, from either:
@@ -77,7 +79,7 @@ module Blacklight::BlacklightHelperBehavior
   # Determine whether to render a given field in the index view.
   #
   # @param [SolrDocument] document
-  # @param [Blacklight::Solr::Configuration::Field] field_config
+  # @param [Blacklight::Configuration::Field] field_config
   # @return [Boolean]
   def should_render_index_field? document, field_config
     should_render_field?(field_config, document) && document_has_value?(document, field_config)
@@ -87,7 +89,7 @@ module Blacklight::BlacklightHelperBehavior
   # Determine whether to render a given field in the show view
   #
   # @param [SolrDocument] document
-  # @param [Blacklight::Solr::Configuration::Field] field_config
+  # @param [Blacklight::Configuration::Field] field_config
   # @return [Boolean]
   def should_render_show_field? document, field_config
     should_render_field?(field_config, document) && document_has_value?(document, field_config)
@@ -97,7 +99,7 @@ module Blacklight::BlacklightHelperBehavior
   # Check if a document has (or, might have, in the case of accessor methods) a value for
   # the given solr field
   # @param [SolrDocument] document
-  # @param [Blacklight::Solr::Configuration::Field] field_config
+  # @param [Blacklight::Configuration::Field] field_config
   # @return [Boolean]
   def document_has_value? document, field_config
     document.has?(field_config.field) ||
@@ -158,12 +160,17 @@ module Blacklight::BlacklightHelperBehavior
   #   @param [String] field
   #   @param [Hash] opts
   #   @options opts [String] :value
+  # TODO: deprecate and use render_field_value
   def render_index_field_value *args
+    render_field_value(*args)
+  end
+
+  def render_field_value(*args)
     options = args.extract_options!
     document = args.shift || options[:document]
 
     field = args.shift || options[:field]
-    presenter(document).render_index_field_value field, options.except(:document, :field)
+    presenter(document).field_value field, options.except(:document, :field)
   end
 
   ##
@@ -211,12 +218,9 @@ module Blacklight::BlacklightHelperBehavior
   #   @param [String] field
   #   @param [Hash] opts
   #   @options opts [String] :value
+  # TODO: deprecate and use render_field_value
   def render_document_show_field_value *args
-    options = args.extract_options!
-    document = args.shift || options[:document]
-
-    field = args.shift || options[:field]
-    presenter(document).render_document_show_field_value field, options.except(:document, :field)
+    render_field_value(*args)
   end
 
   ##
@@ -227,7 +231,7 @@ module Blacklight::BlacklightHelperBehavior
   # @return [String]
   def document_heading document=nil
     document ||= @document
-    presenter(document).document_heading
+    presenter(document).heading
   end
 
   ##
@@ -240,7 +244,7 @@ module Blacklight::BlacklightHelperBehavior
   def document_show_html_title document=nil
     document ||= @document
 
-    presenter(document).document_show_html_title
+    presenter(document).html_title
   end
 
   ##
@@ -258,7 +262,7 @@ module Blacklight::BlacklightHelperBehavior
     tag = options.fetch(:tag, :h4)
     document ||= @document
 
-    content_tag(tag, presenter(document).document_heading, itemprop: "name")
+    content_tag(tag, presenter(document).heading, itemprop: "name")
   end
 
   ##
@@ -270,15 +274,14 @@ module Blacklight::BlacklightHelperBehavior
   # Rendering:
   #   - helper_method
   #   - link_to_search
-  # TODO : maybe this should be merged with render_field_value, and the ugly signature
-  # simplified by pushing some of this logic into the "model"
   # @param [SolrDocument] document
   # @param [String] field name
-  # @param [Blacklight::Solr::Configuration::Field] solr field configuration
+  # @param [Blacklight::Configuration::Field] solr field configuration
   # @param [Hash] options additional options to pass to the rendering helpers
-  def get_field_values document, field, field_config, options = {}
-    presenter(document).get_field_values field, field_config, options
+  def get_field_values document, _field, field_config, options = {}
+    presenter(document).field_values field_config, options
   end
+  deprecation_deprecate :get_field_values
 
   ##
   # Get the current "view type" (and ensure it is a valid type)
@@ -321,15 +324,40 @@ module Blacklight::BlacklightHelperBehavior
 
   ##
   # Returns a document presenter for the given document
+  # TODO: Move this to the controller. It can just pass a presenter or set of presenters.
   def presenter(document)
-    presenter_class.new(document, self)
+    case action_name
+    when 'show', 'citation'
+      show_presenter(document)
+    when 'index'
+      index_presenter(document)
+    else
+      raise "Unable to determine presenter type for #{action_name} on #{controller_name}"
+    end
+  end
+
+  def show_presenter(document)
+    show_presenter_class(document).new(document, self)
+  end
+
+  def index_presenter(document)
+    index_presenter_class(document).new(document, self)
   end
 
-  ##
-  # Override this method if you want to use a different presenter class
   def presenter_class
     blacklight_config.document_presenter_class
   end
+  deprecation_deprecate presenter_class: "replaced by show_presenter_class and index_presenter_class"
+
+  ##
+  # Override this method if you want to use a different presenter class
+  def show_presenter_class(_document)
+    blacklight_config.show.document_presenter_class
+  end
+
+  def index_presenter_class(_document)
+    blacklight_config.index.document_presenter_class
+  end
 
   ##
   # Open Search discovery tag for HTML <head> links

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -5,7 +5,7 @@ module Blacklight::ConfigurationHelperBehavior
   # Index fields to display for a type of document
   # 
   # @param [SolrDocument] document
-  # @return [Array<Blacklight::Solr::Configuration::Field>] 
+  # @return [Array<Blacklight::Configuration::Field>] 
   def index_fields document=nil
     blacklight_config.index_fields
   end

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -16,6 +16,7 @@ module Blacklight::UrlHelperBehavior
   # Use the catalog_path RESTful route to create a link to the show page for a specific item.
   # 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.
+  # TODO: move this to the IndexPresenter
   def link_to_document(doc, field_or_opts = nil, opts={:counter => nil})
     if field_or_opts.is_a? Hash
       opts = field_or_opts
@@ -24,7 +25,7 @@ module Blacklight::UrlHelperBehavior
     end
 
     field ||= document_show_link_field(doc)
-    label = presenter(doc).render_document_index_label field, opts
+    label = index_presenter(doc).label field, opts
     link_to label, url_for_document(doc), document_link_params(doc, opts)
   end
 

data/app/presenters/blacklight/document_presenter.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 module Blacklight
+  # @deprecated
   class DocumentPresenter
-    include ActionView::Helpers::OutputSafetyHelper
-    include ActionView::Helpers::TagHelper
     extend Deprecation
+    self.deprecation_horizon = 'Blacklight version 7.0.0'
 
     # @param [SolrDocument] document
     # @param [ActionController::Base] controller scope for linking and generating urls
@@ -20,39 +20,25 @@ module Blacklight
     #
     # @param [SolrDocument] document
     # @return [String]
+    # @deprecated use ShowPresenter#heading instead
     def document_heading
-      fields = Array(@configuration.view_config(:show).title_field)
-      f = fields.find { |field| @document.has? field }
-
-      if f.nil?
-        render_field_value(@document.id)
-      else
-        render_field_value(@document[f])
-      end
+      show_presenter.heading
     end
+    deprecation_deprecate document_heading: "use ShowPresenter#heading instead"
 
     ##
     # Create <link rel="alternate"> links from a documents dynamically
     # provided export formats. Returns empty string if no links available.
     #
-    # @params [SolrDocument] document
     # @params [Hash] options
     # @option options [Boolean] :unique ensures only one link is output for every
     #     content type, e.g. as required by atom
     # @option options [Array<String>] :exclude array of format shortnames to not include in the output
+    # @deprecated moved to ShowPresenter#link_rel_alternates
     def link_rel_alternates(options = {})
-      options = { unique: false, exclude: [] }.merge(options)
-
-      seen = Set.new
-
-      safe_join(@document.export_formats.map do |format, spec|
-        next if options[:exclude].include?(format) || (options[:unique] && seen.include?(spec[:content_type]))
-
-        seen.add(spec[:content_type])
-
-        tag(:link, rel: "alternate", title: format, type: spec[:content_type], href: @controller.polymorphic_url(@document, format: format))
-      end.compact, "\n")
+      show_presenter.link_rel_alternates(options)
     end
+    deprecation_deprecate link_rel_alternates: "use ShowPresenter#link_rel_alternates instead"
 
     ##
     # Get the document's "title" to display in the <title> element.
@@ -60,80 +46,36 @@ module Blacklight
     #
     # @see #document_heading
     # @return [String]
+    # @deprecated use ShowPresenter#html_title instead
     def document_show_html_title
-      if @configuration.view_config(:show).html_title_field
-        fields = Array(@configuration.view_config(:show).html_title_field)
-        f = fields.find { |field| @document.has? field }
-
-        if f.nil?
-          render_field_value(@document.id)
-        else
-          render_field_value(@document[f])
-        end
-      else
-        document_heading
-      end
-    end
-
-    ##
-    # Render a value (or array of values) from a field
-    #
-    # @param [String] value or list of values to display
-    # @param [Blacklight::Solr::Configuration::Field] solr field configuration
-    # @return [String]
-    def render_field_value value=nil, field_config=nil
-      safe_values = recode_values(Array(value))
-
-      if field_config and field_config.itemprop
-        safe_values = safe_values.map { |x| content_tag :span, x, :itemprop => field_config.itemprop }
-      end
-
-      render_values(safe_values, field_config)
-    end
-
-    ##
-    # Render a fields values as a string
-    # @param [Array] values to display
-    # @param [Blacklight::Solr::Configuration::Field] solr field configuration
-    # @return [String]
-    def render_values(values, field_config = nil)
-      options = {}
-      options = field_config.separator_options if field_config && field_config.separator_options
-
-      values.map { |x| html_escape(x) }.to_sentence(options).html_safe
+      show_presenter.html_title
     end
+    deprecation_deprecate document_show_html_title: "use ShowPresenter#html_title instead"
 
     ##
     # Render the document index heading
     #
     # @param [Symbol, Proc, String] field Render the given field or evaluate the proc or render the given string
     # @param [Hash] opts
-    def render_document_index_label(field, opts = {})
-      label = case field
-      when Symbol
-        @document[field]
-      when Proc
-        field.call(@document, opts)
-      when String
-        field
-      end
-      render_field_value label || @document.id
+    # @deprecated use IndexPresenter#label instead
+    def render_document_index_label(*args)
+      index_presenter.label(*args)
     end
+    deprecation_deprecate render_document_index_label: "use IndexPresenter#label instead"
 
     ##
     # Render the index field label for a document
     #
-    #   Allow an extention point where information in the document
-    #   may drive the value of the field
-    #   @param [String] field
-    #   @param [Hash] opts
-    #   @options opts [String] :value
-    def render_index_field_value field, options = {}
-      field_config = @configuration.index_fields[field]
-      value = options[:value] || get_field_values(field, field_config, options)
-
-      render_field_value value, field_config
+    # Allow an extention point where information in the document
+    # may drive the value of the field
+    # @param [String] field
+    # @param [Hash] opts
+    # @options opts [String] :value
+    # @deprecated use IndexPresenter#field_value instead
+    def render_index_field_value *args
+      index_presenter.field_value(*args)
     end
+    deprecation_deprecate render_index_field_value: "use IndexPresenter#field_value instead"
 
     ##
     # Render the show field value for a document
@@ -143,12 +85,11 @@ module Blacklight
     #   @param [String] field
     #   @param [Hash] options
     #   @options opts [String] :value
-    def render_document_show_field_value field, options={}
-      field_config = @configuration.show_fields[field]
-      value = options[:value] || get_field_values(field, field_config, options)
-
-      render_field_value value, field_config
+    #   @deprecated use ShowPresenter#field_value
+    def render_document_show_field_value *args
+      show_presenter.field_value(*args)
     end
+    deprecation_deprecate render_document_show_field_value: "use ShowPresenter#field_value instead"
 
     ##
     # Get the value for a document's field, and prepare to render it.
@@ -159,78 +100,45 @@ module Blacklight
     # Rendering:
     #   - helper_method
     #   - link_to_search
-    # TODO : maybe this should be merged with render_field_value, and the ugly signature 
-    # simplified by pushing some of this logic into the "model"
-    # @param [SolrDocument] document
     # @param [String] field name
-    # @param [Blacklight::Solr::Configuration::Field] solr field configuration
+    # @param [Blacklight::Configuration::Field] solr field configuration
     # @param [Hash] options additional options to pass to the rendering helpers
-    def get_field_values field, field_config, options = {}
-      # retrieving values
-      value = case    
-        when (field_config and field_config.highlight)
-          # retrieve the document value from the highlighting response
-          @document.highlight_field(field_config.field).map(&:html_safe) if @document.has_highlight_field? field_config.field
-        when (field_config and field_config.accessor)
-          # implicit method call
-          if field_config.accessor === true
-            @document.send(field)
-          # arity-1 method call (include the field name in the call)
-          elsif !field_config.accessor.is_a?(Array) && @document.method(field_config.accessor).arity != 0
-            @document.send(field_config.accessor, field)
-          # chained method calls
-          else
-            Array(field_config.accessor).inject(@document) do |result, method|
-              result.send(method)
-            end
-          end
-        when field_config
-          # regular document field
-          if field_config.default and field_config.default.is_a? Proc
-            @document.fetch(field_config.field, &field_config.default)
-          else
-            @document.fetch(field_config.field, field_config.default)
-          end
-        when field
-          @document[field]
-      end
-
-      # rendering values
-      case
-        when (field_config and field_config.helper_method)
-          @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
-          else
-            field_config.link_to_search
-          end
+    # @deprecated
+    def get_field_values _field, field_config, options = {}
+      field_values(field_config, options)
+    end
+    deprecation_deprecate get_field_values: 'Use field_values instead'
 
-          Array(value).map do |v|
-            @controller.link_to render_field_value(v, field_config), @controller.search_action_path(@controller.search_state.reset.add_facet_params(link_field, v))
-          end if field
-        else
-          value
-        end
+    ##
+    # Get the value for a document's field, and prepare to render it.
+    # - highlight_field
+    # - accessor
+    # - solr field
+    #
+    # Rendering:
+    #   - helper_method
+    #   - link_to_search
+    # @param [Blacklight::Configuration::Field] solr field configuration
+    # @param [Hash] options additional options to pass to the rendering helpers
+    def field_values(field_config, options={})
+      FieldPresenter.new(@controller, @document, field_config, options).render
     end
+    deprecation_deprecate field_values: 'Use ShowPresenter or IndexPresenter field_values instead'
 
-    def html_escape(*args)
-      ERB::Util.html_escape(*args)
+    # @deprecated
+    def render_field_value(values, field_config = Configuration::NullField.new)
+      FieldPresenter.new(@controller, @document, field_config, value: values).render
     end
+    deprecation_deprecate render_field_value: 'Use FieldPresenter instead'
 
     private
 
-      # @param [Array<String,Fixnum>] values
-      # @return [Array] an array with all strings converted to UTF-8
-      def recode_values(values)
-        values.collect do |value|
-          if value.respond_to?(:encoding) && value.encoding != Encoding::UTF_8
-            Rails.logger.warn "Found a non utf-8 value in Blacklight::DocumentPresenter. \"#{value}\" Encoding is #{value.encoding}"
-            value.dup.force_encoding('UTF-8')
-          else
-            value
-          end
-        end
+      def index_presenter
+        @controller.index_presenter(@document)
+      end
+
+      def show_presenter
+        @controller.show_presenter(@document)
       end
   end
 end