blacklight 5.9.4 → 5.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8126f3ed502a69a91c6d18d78257a088da61315f
-  data.tar.gz: 09ba87bc46a31e4fc41a425378a28fe5aeee9bd4
+  metadata.gz: a9591ba5deb7fc58aa9ec580987953fa4b4128ee
+  data.tar.gz: 10a20662083c88de9da4e5f8fb3a515f91293235
 SHA512:
-  metadata.gz: f7f98846b1ff0ce90bdf7c9b9e4012acfcad300ee7e59a8aa2b0fecba45c937440ec5bddc5c7ce56f463cc07b4385b6ffbaff72295c725611389a23d7eda038a
-  data.tar.gz: 885d1bcd43fea076f50fe2b7f4bc746799aaa7d6394a39b31594ea9d9c7fc28969e7708fefc4415236050c71484a83456bdd0fd16cafa049dc9f126e646fc92b
+  metadata.gz: 71cf3a717e8ac74e50db3851409f9f1229b1758f9da2c14b73509fe1fd3d7201ab5a39a7d2040a3b5e413df267c0fe5e0936a3642629e38d54e5873e861f92d5
+  data.tar.gz: b99e720d7d5a1975d7ab819a4e4c2af533891c372f2df3e6d63113a541f796b8091604340dcfa287fef6116954688b9c2ba87ca9b11860f08c12723b83a4c91a

data/Gemfile

@@ -9,7 +9,7 @@ gem 'simplecov', '~> 0.7.1', require: false
 gem 'coveralls', require: false
 
 group :test do
-  gem "blacklight-marc", "5.5.0"
+  gem "blacklight-marc", "~> 5.0", github: "projectblacklight/blacklight_marc"
   gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 end
 

data/VERSION

@@ -1 +1 @@
-5.9.4
+5.10.0

data/app/assets/stylesheets/blacklight/_facets.scss

@@ -46,20 +46,21 @@
       @extend .text-success;
     }
 
-    .remove {
-      @extend .text-muted;
-      text-indent: $padding-base-horizontal;
+  }
 
-      .glyphicon {
-        top: 0.1em;
-        vertical-align: text-top;
-      }
+  .remove {
+    @extend .text-muted;
+    text-indent: $padding-base-horizontal;
 
-      &:hover {
-        color: $brand-danger;
-      }
+    .glyphicon {
+      top: 0.1em;
+      vertical-align: text-top;
+    }
 
+    &:hover {
+      color: $brand-danger;
     }
+
   }
 
   @mixin hyphens-auto {

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -97,27 +97,27 @@ module Blacklight::BlacklightHelperBehavior
   # Determine whether to render a given field in the index view.
   #  
   # @param [SolrDocument] document
-  # @param [Blacklight::Solr::Configuration::SolrField] solr_field
+  # @param [Blacklight::Solr::Configuration::Field] field_config
   # @return [Boolean]
-  def should_render_index_field? document, solr_field
-    should_render_field?(solr_field, document) && document_has_value?(document, solr_field)
+  def should_render_index_field? document, field_config
+    should_render_field?(field_config, document) && document_has_value?(document, field_config)
   end
 
   ##
   # Determine whether to render a given field in the show view
   #
   # @param [SolrDocument] document
-  # @param [Blacklight::Solr::Configuration::SolrField] solr_field
+  # @param [Blacklight::Solr::Configuration::Field] field_config
   # @return [Boolean]
-  def should_render_show_field? document, solr_field
-    should_render_field?(solr_field, document) && document_has_value?(document, solr_field)
+  def should_render_show_field? document, field_config
+    should_render_field?(field_config, document) && document_has_value?(document, field_config)
   end
   
   ##
   # 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::SolrField] solr_field
+  # @param [Blacklight::Solr::Configuration::Field] field_config
   # @return [Boolean]
   def document_has_value? document, field_config
     document.has?(field_config.field) ||
@@ -272,7 +272,7 @@ module Blacklight::BlacklightHelperBehavior
   #   @options options [Symbol] :tag
   def render_document_heading(*args)
     options = args.extract_options!
-    if args.first.is_a? blacklight_config.solr_document_model
+    if args.first.is_a? blacklight_config.document_model
       document = args.shift
       tag = options[:tag]
     else
@@ -298,7 +298,7 @@ module Blacklight::BlacklightHelperBehavior
   # simplified by pushing some of this logic into the "model"
   # @param [SolrDocument] document
   # @param [String] field name
-  # @param [Blacklight::Solr::Configuration::SolrField] solr field configuration
+  # @param [Blacklight::Solr::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
@@ -309,10 +309,9 @@ module Blacklight::BlacklightHelperBehavior
   #
   # @deprecated Use DocumentPresenter instead
   # @param [String] value or list of values to display
-  # @param [Blacklight::Solr::Configuration::SolrField] solr field configuration
+  # @param [Blacklight::Solr::Configuration::Field] solr field configuration
   # @return [String]
   def render_field_value value=nil, field_config=nil
-    Deprecation.warn self, "render_field_value is deprecated. Use DocumentPresenter.render_field_value instead"
     safe_values = Array(value).collect { |x| x.respond_to?(:force_encoding) ? x.force_encoding("UTF-8") : x }
 
     if field_config and field_config.itemprop
@@ -321,15 +320,16 @@ module Blacklight::BlacklightHelperBehavior
 
     safe_join(safe_values, (field_config.separator if field_config) || field_value_separator)
   end
+  deprecation_deprecate render_field_value: "use DocumentPresenter.render_field_value instead"
 
   ##
   # Default separator to use in #render_field_value
   #
   # @return [String]
   def field_value_separator
-    Deprecation.warn self, "field_value_separator is deprecated. Use DocumentPresenter.field_value_separator instead"
     ', '
   end
+  deprecation_deprecate field_value_separator: "use DocumentPresenter.field_value_separator instead"
 
   ##
   # Get the current "view type" (and ensure it is a valid type)
@@ -356,13 +356,13 @@ module Blacklight::BlacklightHelperBehavior
   # @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 doc, field, opts = {}
-    Deprecation.warn self, "render_document_index_label is deprecated"
     if field.kind_of? Hash
       Deprecation.warn self, "Calling render_document_index_label with a hash is deprecated"
       field = field[:label]
     end
     presenter(doc).render_document_index_label field, opts
   end
+  deprecation_deprecate render_document_index_label: "use presenter(doc).render_document_index_label instead"
 
   ##
   # Render a partial of an arbitrary format inside a
@@ -409,7 +409,7 @@ module Blacklight::BlacklightHelperBehavior
   ##
   # Override this method if you want to use a different presenter class
   def presenter_class
-    blacklight_config.document_presenter_class || Blacklight::DocumentPresenter
+    blacklight_config.document_presenter_class
   end
   
   ##

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -1,10 +1,12 @@
 module Blacklight::ConfigurationHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'blacklight 6.0'
 
   ##
   # Index fields to display for a type of document
   # 
   # @param [SolrDocument] document
-  # @return [Array<Blacklight::Solr::Configuration::SolrField>] 
+  # @return [Array<Blacklight::Solr::Configuration::Field>] 
   def index_fields document=nil
     blacklight_config.index_fields
   end
@@ -60,7 +62,7 @@ module Blacklight::ConfigurationHelperBehavior
   def index_field_label document, field
     field_config = index_fields(document)[field]
 
-    solr_field_label(
+    field_label(
       :"blacklight.search.fields.index.#{field}",
       :"blacklight.search.fields.#{field}",
       (field_config.label if field_config),
@@ -73,7 +75,7 @@ module Blacklight::ConfigurationHelperBehavior
   def document_show_field_label document, field
     field_config = document_show_fields(document)[field]
 
-    solr_field_label(
+    field_label(
       :"blacklight.search.fields.show.#{field}",
       :"blacklight.search.fields.#{field}",
       (field_config.label if field_config),
@@ -85,11 +87,13 @@ module Blacklight::ConfigurationHelperBehavior
   # Look up the label for the facet field
   def facet_field_label field
     field_config = blacklight_config.facet_fields[field]
-    defaults = [:"blacklight.search.fields.facet.#{field}", :"blacklight.search.fields.#{field}"]
-    defaults << field_config.label if field_config
-    defaults << field.to_s.humanize
 
-    solr_field_label *defaults
+    field_label(
+      :"blacklight.search.fields.facet.#{field}",
+      :"blacklight.search.fields.#{field}",
+      (field_config.label if field_config),
+      field.to_s.humanize
+    )
   end
 
   ##
@@ -104,11 +108,13 @@ module Blacklight::ConfigurationHelperBehavior
   #     before falling  back to the label
   #   @param [Symbol] any number of additional keys
   #   @param [Symbol] ...
-  def solr_field_label *i18n_keys
-    first, *rest = i18n_keys.compact
+  def field_label *i18n_keys
+    first, *rest = i18n_keys
 
     t(first, default: rest)
   end
+  alias_method :solr_field_label, :field_label
+  deprecation_deprecate solr_field_label: :field_label
   
   def document_index_views
     blacklight_config.view.select do |k, config|
@@ -169,7 +175,7 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # Determine whether to render a field by evaluating :if and :unless conditions
   #
-  # @param [Blacklight::Solr::Configuration::SolrField] solr_field
+  # @param [Blacklight::Solr::Configuration::Field] field_config
   # @return [Boolean]
   def should_render_field? field_config, *args
     evaluate_if_unless_configuration field_config, *args

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -43,7 +43,8 @@ module Blacklight::FacetsHelperBehavior
     options[:partial] ||= facet_partial_name(display_facet)
     options[:layout] ||= "facet_layout" unless options.has_key?(:layout)
     options[:locals] ||= {}
-    options[:locals][:solr_field] ||= display_facet.name 
+    options[:locals][:field_name] ||= display_facet.name
+    options[:locals][:solr_field] ||= display_facet.name # deprecated
     options[:locals][:facet_field] ||= facet_configuration_for_field(display_facet.name)
     options[:locals][:display_facet] ||= display_facet 
 
@@ -54,20 +55,20 @@ module Blacklight::FacetsHelperBehavior
   # Renders the list of values 
   # removes any elements where render_facet_item returns a nil value. This enables an application
   # to filter undesireable facet items so they don't appear in the UI
-  def render_facet_limit_list(paginator, solr_field, wrapping_element=:li)
+  def render_facet_limit_list(paginator, facet_field, wrapping_element=:li)
     safe_join(paginator.items.
-      map { |item| render_facet_item(solr_field, item) }.compact.
+      map { |item| render_facet_item(facet_field, item) }.compact.
       map { |item| content_tag(wrapping_element,item)}
     )
   end
 
   ##
   # Renders a single facet item
-  def render_facet_item(solr_field, item)
-    if facet_in_params?( solr_field, item.value )
-      render_selected_facet_value(solr_field, item)          
+  def render_facet_item(facet_field, item)
+    if facet_in_params?(facet_field, item.value )
+      render_selected_facet_value(facet_field, item)          
     else
-      render_facet_value(solr_field, item)
+      render_facet_value(facet_field, item)
     end
   end
 
@@ -121,21 +122,21 @@ module Blacklight::FacetsHelperBehavior
   # @param [Hash] options
   # @option options [Boolean] :suppress_link display the facet, but don't link to it
   # @return [String]
-  def render_facet_value(facet_solr_field, item, options ={})
-    path = search_action_path(add_facet_params_and_redirect(facet_solr_field, item))
+  def render_facet_value(facet_field, item, options ={})
+    path = search_action_path(add_facet_params_and_redirect(facet_field, item))
     content_tag(:span, :class => "facet-label") do
-      link_to_unless(options[:suppress_link], facet_display_value(facet_solr_field, item), path, :class=>"facet_select")
+      link_to_unless(options[:suppress_link], facet_display_value(facet_field, item), path, :class=>"facet_select")
     end + render_facet_count(item.hits)
   end
 
   ##
   # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
   # @params (see #render_facet_value)
-  def render_selected_facet_value(facet_solr_field, item)
+  def render_selected_facet_value(facet_field, item)
     content_tag(:span, :class => "facet-label") do
-      content_tag(:span, facet_display_value(facet_solr_field, item), :class => "selected") +
+      content_tag(:span, facet_display_value(facet_field, item), :class => "selected") +
       # remove link
-      link_to(content_tag(:span, '', :class => "glyphicon glyphicon-remove") + content_tag(:span, '[remove]', :class => 'sr-only'), search_action_path(remove_facet_params(facet_solr_field, item, params)), :class=>"remove")
+      link_to(content_tag(:span, '', :class => "glyphicon glyphicon-remove") + content_tag(:span, '[remove]', :class => 'sr-only'), search_action_path(remove_facet_params(facet_field, item, params)), :class=>"remove")
     end + render_facet_count(item.hits, :classes => ["selected"])
   end
 
@@ -208,7 +209,7 @@ module Blacklight::FacetsHelperBehavior
   end
 
   def facet_field_id facet_field
-    "facet-#{facet_field.field.parameterize}"
+    "facet-#{facet_field.key.parameterize}"
   end
 
   private

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -68,7 +68,7 @@ module Blacklight::UrlHelperBehavior
   def search_session_params counter 
     { :'data-counter' => counter, :'data-search_id' => current_search_session.try(:id) }
   end
-  deprecation_deprecate :search_session_params
+  deprecation_deprecate search_session_params: :session_tracking_params
 
   ##
   # Attributes for a link that gives a URL we can use to track clicks for the current search session

data/app/models/bookmark.rb

@@ -5,10 +5,7 @@ class Bookmark < ActiveRecord::Base
   belongs_to :document, polymorphic: true
 
   validates_presence_of :user_id, :scope=>:document_id
-
-  if Blacklight::Utils.needs_attr_accessible?
-    attr_accessible :id, :document_id, :document_type, :title
-  end
+  attr_accessible :id, :document_id, :document_type, :title if Rails::VERSION::MAJOR < 4
 
   def document
     document_type.new document_type.unique_key => document_id

data/app/models/search.rb

@@ -5,13 +5,10 @@ class Search < ActiveRecord::Base
 
   serialize :query_params
 
-  if Blacklight::Utils.needs_attr_accessible?
+  if Rails::VERSION::MAJOR < 4
     attr_accessible :query_params 
-  end
-
-  unless respond_to?(:none)
-    # polyfill
-    scope :none, where(id: nil).where("id IS NOT ?", nil)
+  
+    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.

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

@@ -1,7 +1,7 @@
-<div class="panel panel-default facet_limit blacklight-<%= facet_field.field.parameterize %> <%= 'facet_limit-active' if facet_field_in_params?(facet_field.field) %>">
+<div class="panel panel-default facet_limit blacklight-<%= facet_field.key.parameterize %> <%= 'facet_limit-active' if facet_field_in_params?(facet_field.key) %>">
   <div class="<%= "collapsed" if should_collapse_facet?(facet_field) %> collapse-toggle panel-heading" data-toggle="collapse" data-target="#<%= facet_field_id(facet_field) %>">
     <h5 class="panel-title">
-      <%= link_to facet_field_label(facet_field.field), "#", :"data-no-turbolink" => true %>
+      <%= link_to facet_field_label(facet_field.key), "#", :"data-no-turbolink" => true %>
     </h5>
   </div>
   <div id="<%= facet_field_id(facet_field) %>" class="panel-collapse facet-content <%= should_collapse_facet?(facet_field) ? 'collapse' : 'in' %>">

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

@@ -1,9 +1,11 @@
 <ul class="facet-values list-unstyled">
   <% paginator = facet_paginator(facet_field, display_facet) %>
-  <%= render_facet_limit_list paginator, solr_field %>
+  <%= render_facet_limit_list paginator, field_name %>
 
   <% unless paginator.last_page? || params[:action] == "facet" %>
-    <li class="more_facets_link"><%= link_to t('blacklight.search.facets.more'), 
-       search_facet_url(id: solr_field), class: "more_facets_link" %></li>
+    <li class="more_facets_link">
+      <%= link_to t("more_#{field_name}_html", scope: 'blacklight.search.facets', default: :more_html, field_name: facet_field.label), 
+        search_facet_url(id: field_name), class: "more_facets_link" %>
+    </li>
   <% end %>
 </ul>

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

@@ -2,15 +2,15 @@
   <% display_facet.items.each do |item| -%>
     <li>
     <span class="facet-values">
-    <% if facet_in_params?( solr_field, item ) %>              
-        <%= render_selected_facet_value(solr_field, item) %>              
+    <% if facet_in_params?(field_name, item) %>              
+        <%= render_selected_facet_value(field_name, item) %>              
       <% else %>              
-        <%= render_facet_value(solr_field, item) %>              
+        <%= render_facet_value(field_name, item) %>              
     <% end -%>
     </span>
 
     <% unless item.items.blank? %>
-      <%= render :partial => 'facet_pivot', :locals => { :display_facet => item, :solr_field => solr_field } %>
+      <%= render partial: 'facet_pivot', locals: { display_facet: item, field_name: field_name, solr_field: field_name } %>
     <% end %>
     </li>
   <% end %>

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

@@ -1,49 +1,9 @@
-<div class="page-header row">
-  <h1 class="col-md-8"><%= t('blacklight.welcome') %></h1>
-  
-  <ul class="nav nav-pills col-md-4">
-    <li><a href="https://github.com/projectblacklight/blacklight/">Github</a></li>
-    <li><a href="https://github.com/projectblacklight/blacklight/wiki">Wiki</a></li>
-    <li><a href="https://github.com/projectblacklight/blacklight/releases/tag/v<%= Blacklight::VERSION %>">Release Notes</a></li>
-  </ul>
+<h4><%= t('blacklight.welcome') %></h4>
+<p>&nbsp;</p>
+<p>To modify this text to your specifications, copy this file located in the blacklight plugin directory:<br/>
+&nbsp;&nbsp;&nbsp;<%= Blacklight.root %>/app/views/catalog/_home_text.html.erb</p>
+<p>to your top level rails app:<br/>
+&nbsp;&nbsp;&nbsp;<%= Rails.root %>/app/views/catalog/_home_text.html.erb</p>
+<p>Note that you will need to create the 'catalog' directory under views.</p>
+<% #Creates a bit space in the page -%>
 
-
-</div>
-
-<div id="getting-started">
-  <h2>Here&rsquo;s how to get started:</h2>
-  
-  <ol>
-    <li>To modify this text, you need to <a href="http://guides.rubyonrails.org/engines.html#improving-engine-functionality">override the Blacklight-provided view</a>.
-You can copy this file, located in the blacklight gem: <br />
-<%= Blacklight.root %>/app/views/catalog/_home_text.html.erb <br />
-to your own application: <br />
- <%= Rails.root %>/app/views/catalog/_home_text.html.erb 
-    </li>
-    <li><a href="https://github.com/projectblacklight/blacklight/wiki/Indexing-your-data-into-solr">Index your own data</a> into Solr</li>
-    <li><a href="https://github.com/projectblacklight/blacklight/wiki#blacklight-configuration">Configure Blacklight</a> to match your data and user-experience needs</li>
-    <li><a href="https://github.com/projectblacklight/blacklight/wiki#support">Get in touch</a> with your comments, questions, and ideas</li>
-  </ol>
-</div>
-
-<%# This is the same panel shown in the Rails welcome template %>
-<div id="about">
-  <h3><a href="/rails/info/properties">About your application&rsquo;s environment</a></h3>
-  <div id="about-content" class="well" style="display: none"></div>
-</div>
-
-<script>
-  $(function() {
-    $('#about a').on('click', function(e) {
-      e.preventDefault();
-
-      if ($('#about-content').html() == "") {
-        $('#about-content').load($(this).attr("href"), function() {
-          $('#about-content').show();
-        });
-      } else {
-        $('#about-content').toggle();
-      }
-    });
-  });
-</script>