blacklight 5.13.0 → 5.13.1

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -20,11 +20,9 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
   # Render the search query constraint
   def render_search_to_s_q(params)
     return "".html_safe if params['q'].blank?
-    
-    label = (default_search_field && params[:search_field] == default_search_field[:key]) ? 
-      nil :
-      label_for_search_field(params[:search_field])
-    
+
+    label = label_for_search_field(params[:search_field]) unless default_search_field && params[:search_field] == default_search_field[:key]
+
     render_search_to_s_element(label , render_filter_value(params['q']) )
   end
 

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -25,7 +25,7 @@ module Blacklight::UrlHelperBehavior
   # 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.kind_of? Hash
+    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."

data/app/helpers/blacklight_configuration_helper.rb

@@ -1,3 +1,3 @@
 module BlacklightConfigurationHelper
   include Blacklight::ConfigurationHelperBehavior
-end
+end

data/app/helpers/blacklight_url_helper.rb

@@ -1,3 +1,3 @@
 module BlacklightUrlHelper
   include Blacklight::UrlHelperBehavior
-end
+end

data/app/helpers/component_helper.rb

@@ -1,3 +1,3 @@
 module ComponentHelper
   include Blacklight::ComponentHelperBehavior
-end
+end

data/app/models/bookmark.rb

@@ -4,7 +4,7 @@ class Bookmark < ActiveRecord::Base
   belongs_to :user, polymorphic: true
   belongs_to :document, polymorphic: true
 
-  validates_presence_of :user_id, :scope=>:document_id
+  validates :user_id, presence: true
 
   if Blacklight::Utils.needs_attr_accessible?
     attr_accessible :id, :document_id, :document_type, :title

data/app/models/search.rb

@@ -11,7 +11,7 @@ class Search < ActiveRecord::Base
 
   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.
@@ -23,7 +23,7 @@ class Search < ActiveRecord::Base
   def self.delete_old_searches(days_old)
     raise ArgumentError.new('days_old is expected to be a number') unless days_old.is_a?(Numeric)
     raise ArgumentError.new('days_old is expected to be greater than 0') if days_old <= 0
-    self.destroy_all(['created_at < ? AND user_id IS NULL', Date.today - days_old])
+    self.destroy_all(['created_at < ? AND user_id IS NULL', Time.zone.today - days_old])
   end
   
 end

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

@@ -4,7 +4,7 @@
   # but it was simpler to leave them seperate instead of DRYing them, got confusing trying that.
   # the data-doc-id attribute is used by our JS that converts to a checkbox/label.
   -%>
-  <% unless is_bookmarked? document %>
+  <% unless bookmarked? document %>
 
       <%= form_tag( bookmark_path( document ), :method => :put, :class => "bookmark_toggle", "data-doc-id" => document.id, :'data-present' => t('blacklight.search.bookmarks.present'), :'data-absent' => t('blacklight.search.bookmarks.absent'), :'data-inprogress' => t('blacklight.search.bookmarks.inprogress')) do %>
         <%= submit_tag(t('blacklight.bookmarks.add.button'), :id => "bookmark_toggle_#{document.id.to_s.parameterize}", :class => "bookmark_add") %>

data/app/views/catalog/_document_default.atom.builder

@@ -14,8 +14,8 @@ xml.entry do
   xml.id polymorphic_url(url_for_document(document))
   
   
-  if document.to_semantic_values[:author][0]   
-    xml.author { xml.name(document.to_semantic_values[:author][0]) }
+  if document.to_semantic_values.key? :author
+    xml.author { xml.name(document.to_semantic_values[:author].first) }
   end
   
   with_format("html") do

data/app/views/catalog/_document_default.rss.builder

@@ -1,5 +1,5 @@
 xml.item do  
-  xml.title( document.to_semantic_values[:title][0] || presenter(document).render_document_index_label(document_show_link_field(document)) )                              
-  xml.link(polymorphic_url(url_for_document(document)))                                   
-  xml.author( document.to_semantic_values[:author][0] ) if document.to_semantic_values[:author][0]       
+  xml.title(presenter(document).render_document_index_label(document_show_link_field(document)) || (document.to_semantic_values[:title].first if document.to_semantic_values.key?(:title)))
+  xml.link(polymorphic_url(url_for_document(document)))
+  xml.author( document.to_semantic_values[:author].first ) if document.to_semantic_values.key? :author
 end

data/blacklight.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["blacklight-development@googlegroups.com"]
   s.homepage    = "http://projectblacklight.org/"
   s.summary     = "Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr) index."
-  s.description = %q{Blacklight is an open source Solr user interface discovery platform. You can use Blacklight to enable searching and browsing of your collections. Blacklight uses the Apache Solr search engine to search full text and/or metadata.}
+  s.description = %{Blacklight is an open source Solr user interface discovery platform. You can use Blacklight to enable searching and browsing of your collections. Blacklight uses the Apache Solr search engine to search full text and/or metadata.}
   s.license     = "Apache 2.0"
 
   s.files         = `git ls-files`.split("\n")

data/lib/blacklight.rb

@@ -52,11 +52,11 @@ module Blacklight
 
   # @deprecated
   def self.solr_file
-    "#{::Rails.root.to_s}/config/solr.yml"
+    "#{::Rails.root}/config/solr.yml"
   end
 
   def self.blacklight_config_file
-    "#{::Rails.root.to_s}/config/blacklight.yml"
+    "#{::Rails.root}/config/blacklight.yml"
   end
 
   def self.add_routes(router, options = {})
@@ -100,14 +100,14 @@ module Blacklight
 
     begin
       blacklight_erb = ERB.new(IO.read(blacklight_config_file)).result(binding)
-    rescue Exception => e
-      raise("#{blacklight_config_file} was found, but could not be parsed with ERB. \n#{$!.inspect}")
+    rescue StandardError, SyntaxError => e
+      raise("#{blacklight_config_file} was found, but could not be parsed with ERB. \n#{e.inspect}")
     end
 
     begin
       @blacklight_yml = YAML::load(blacklight_erb)
-    rescue StandardError => e
-      raise("#{blacklight_config_file} was found, but could not be parsed.\n")
+    rescue => e
+      raise("#{blacklight_config_file} was found, but could not be parsed.\n#{e.inspect}")
     end
 
     if @blacklight_yml.nil? || !@blacklight_yml.is_a?(Hash)
@@ -128,14 +128,14 @@ module Blacklight
 
     begin
       @solr_erb = ERB.new(IO.read(solr_file)).result(binding)
-    rescue Exception => e
-      raise("solr.yml was found, but could not be parsed with ERB. \n#{$!.inspect}")
+    rescue StandardError, SyntaxError => e
+      raise("solr.yml was found, but could not be parsed with ERB. \n#{e.inspect}")
     end
 
     begin
       @solr_yml = YAML::load(@solr_erb)
-    rescue StandardError => e
-      raise("solr.yml was found, but could not be parsed.\n")
+    rescue => e
+      raise("solr.yml was found, but could not be parsed.\n#{e.inspect}")
     end
 
     if @solr_yml.nil? || !@solr_yml.is_a?(Hash)

data/lib/blacklight/bookmarks.rb

@@ -98,20 +98,21 @@ 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.where(document_id: params[:id], document_type: blacklight_config.document_model).first
+    bookmark = current_or_guest_user.bookmarks.find_by(document_id: params[:id], document_type: blacklight_config.document_model)
 
-    success = bookmark && bookmark.delete && bookmark.destroyed?
-
-    unless request.xhr?
-      if success
-        flash[:notice] =  I18n.t('blacklight.bookmarks.remove.success')
+    if bookmark && bookmark.delete && bookmark.destroyed?
+      if request.xhr?
+        render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }})
       else
-        flash[:error] = I18n.t('blacklight.bookmarks.remove.failure')
+        redirect_to :back, notice: I18n.t('blacklight.bookmarks.remove.success')
       end
-      redirect_to :back
     else
-      # ajaxy request needs no redirect and should not have flash set
-      success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(:text => "", :status => "500")
+      if request.xhr?
+        # ajaxy request needs no redirect and should not have flash set
+        render(:text => "", :status => "500")
+      else
+        redirect_to :back, flash: { error: I18n.t('blacklight.bookmarks.remove.failure') }
+      end
     end
   end
 

data/lib/blacklight/catalog.rb

@@ -14,7 +14,10 @@ module Blacklight::Catalog
   include Blacklight::Catalog::ComponentConfiguration
   include Blacklight::Facet
 
+  # rubocop:disable Style/ConstantName
+  # @deprecated use blacklight_config.search_history_window instead
   SearchHistoryWindow = 100 # how many searches to save in session history
+  # rubocop:enable Style/ConstantName
 
   # The following code is executed when someone includes blacklight::catalog in their
   # own controller.
@@ -159,8 +162,6 @@ module Blacklight::Catalog
             instance_exec &config
           when Symbol, String
             send config
-          else
-            # no-op, just render the page
           end
         end
       end
@@ -194,11 +195,9 @@ module Blacklight::Catalog
     # First, try to render an appropriate template (e.g. index.endnote.erb)
     # If that fails, just concatenate the document export responses with a newline. 
     def render_document_export_format format_name
-      begin
-        render
-      rescue ActionView::MissingTemplate
-        render text: @response.documents.map { |x| x.export_as(format_name) if x.exports_as? format_name }.compact.join("\n"), layout: false
-      end    
+      render
+    rescue ActionView::MissingTemplate
+      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 
@@ -278,14 +277,7 @@ module Blacklight::Catalog
     end
 
     def sms_mappings
-      {'Virgin' => 'vmobl.com',
-      'AT&T' => 'txt.att.net',
-      'Verizon' => 'vtext.com',
-      'Nextel' => 'messaging.nextel.com',
-      'Sprint' => 'messaging.sprintpcs.com',
-      'T Mobile' => 'tmomail.net',
-      'Alltel' => 'message.alltel.com',
-      'Cricket' => 'mms.mycricket.com'}
+      Blacklight::Engine.config.sms_mappings
     end
 
     def validate_email_params

data/lib/blacklight/catalog/component_configuration.rb

@@ -13,7 +13,7 @@ module Blacklight
       add_show_tools_partial(:refworks, if: :render_refworks_action?, modal: false)
       add_show_tools_partial(:endnote, if: :render_endnote_action?, modal: false, path: :single_endnote_catalog_path )
       add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
-      add_show_tools_partial(:sms, callback: :sms_action, validator: :validate_sms_params)
+      add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
       add_show_tools_partial(:citation)
       add_show_tools_partial(:librarian_view, if: :render_librarian_view_control?)
 

data/lib/blacklight/catalog/search_context.rb

@@ -62,7 +62,7 @@ module Blacklight::Catalog::SearchContext
 
     return if params_copy.reject { |k,v| [:action, :controller].include? k.to_sym }.blank?
 
-    saved_search = searches_from_history.select { |x| x.query_params == params_copy }.first
+    saved_search = searches_from_history.find { |x| x.query_params == params_copy }
 
     saved_search ||= begin
       s = Search.create(:query_params => params_copy)

data/lib/blacklight/configuration.rb

@@ -95,7 +95,7 @@ module Blacklight
             # what field, if any, to use to render grouped results
             group: false,
             # additional response formats for search results
-            respond_to: OpenStructWithHashAccess.new()
+            respond_to: OpenStructWithHashAccess.new
             ),
           # Additional configuration when displaying a single document
           show: ViewConfig::Show.new(
@@ -244,7 +244,7 @@ module Blacklight
     # if not set, defaults to first defined search field
     def default_search_field
       field = super
-      field ||= search_fields.values.select { |field| field.default == true }.first
+      field ||= search_fields.values.find { |f| f.default == true }
       field ||= search_fields.values.first
 
       field
@@ -255,7 +255,7 @@ module Blacklight
     # if not set, defaults to first defined sort field
     def default_sort_field
       field = super
-      field ||= sort_fields.values.select { |field| field.default == true }.first
+      field ||= sort_fields.values.find { |f| f.default == true }
       field ||= sort_fields.values.first
 
       field

data/lib/blacklight/configuration/tool_config.rb

@@ -1,4 +1,4 @@
 module Blacklight
   class Configuration::ToolConfig < OpenStructWithHashAccess
   end
-end
+end

data/lib/blacklight/configuration/view_config.rb

@@ -68,4 +68,4 @@ class Blacklight::Configuration
 
     end
   end
-end
+end

data/lib/blacklight/controller.rb

@@ -148,4 +148,3 @@ module Blacklight::Controller
     end
   
 end
-

data/lib/blacklight/document/active_model_shim.rb

@@ -59,4 +59,4 @@ module Blacklight::Document
     end
 
   end
-end
+end

data/lib/blacklight/document/dublin_core.rb

@@ -26,16 +26,21 @@ module Blacklight::Document::DublinCore
              'xmlns:dc' => "http://purl.org/dc/elements/1.1/",
              'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
              'xsi:schemaLocation' => %{http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd}) do
-       self.to_semantic_values.select { |field, values| dublin_core_field_names.include? field.to_sym }.each do |field,values|
-         values.each do |v|
-           xml.tag! 'dc:' + field.to_s, v
-         end
-       end
-     end
+      self.to_semantic_values.select { |field, values| dublin_core_field_name? field  }.each do |field,values|
+        Array.wrap(values).each do |v|
+          xml.tag! "dc:#{field}", v
+        end
+      end
+    end
     xml.target!
   end
 
   alias_method :export_as_xml, :export_as_oai_dc_xml
   alias_method :export_as_dc_xml, :export_as_oai_dc_xml
 
+  private
+
+  def dublin_core_field_name? field
+    dublin_core_field_names.include? field.to_sym
+  end
 end

data/lib/blacklight/document/export.rb

@@ -62,22 +62,14 @@ module Blacklight::Document::Export
     # 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 unless content_type      
+      content_type ||= mime_type.to_s
     else
       # not registered, we need to register. Use register_alias to be least
       # likely to interfere with host app. 
       Mime::Type.register_alias(content_type, short_name)
     end
-    
-    # if content_type is nil, look it up from Rails Mime::Type
-    if content_type.nil?
-      # Accurate lookup in Rails Mime::Type is kind of pain, it doesn't
-      # really provide the right API.
-      if defined?(type_const_name)
-        content_type = type_const_name.constantize.to_s
-      end    
-    end    
-    export_formats[short_name] =  {content_type: content_type}
+
+    export_formats[short_name] =  { content_type: content_type }
   end
   
   # Collects formats that this doc can export as.
@@ -98,10 +90,10 @@ module Blacklight::Document::Export
   # on the convention, so clients should call this method so
   # they'll still keep working if we do that. 
   def export_as(short_name)
-    send("export_as_#{short_name.to_s}")
+    send("export_as_#{short_name}")
   end
   
   def exports_as? short_name
-    respond_to? "export_as_#{short_name.to_s}"
+    respond_to? "export_as_#{short_name}"
   end
 end

data/lib/blacklight/document/schema_org.rb

@@ -4,4 +4,4 @@ module Blacklight::Document::SchemaOrg
     "http://schema.org/Thing"
   end
 
-end
+end

data/lib/blacklight/document/semantic_fields.rb

@@ -33,19 +33,15 @@ module Blacklight::Document
     # but extensions should call super and modify hash returned, to avoid
     # unintentionally erasing values provided by other extensions. 
     def to_semantic_values
-      unless @semantic_value_hash
-        @semantic_value_hash = Hash.new([]) # default to empty array   
-        self.class.field_semantics.each_pair do |key, field_name|
-          value = self[field_name]
-          # Make single and multi-values all arrays, so clients
-          # don't have to know.
-          unless value.nil?
-            value = [value] unless value.kind_of?(Array)      
-            @semantic_value_hash[key] = value
-          end
-        end
+      @semantic_value_hash ||= self.class.field_semantics.each_with_object(Hash.new([])) do |(key, field_name), hash|
+        value = self[field_name]
+
+        # Make single and multi-values all arrays, so clients
+        # don't have to know.
+        hash[key] = Array.wrap(value) unless value.nil?
       end
-      return @semantic_value_hash
+
+      @semantic_value_hash ||= {}
     end    
   end
-end
+end

data/lib/blacklight/document_presenter.rb

@@ -76,7 +76,7 @@ module Blacklight
     # @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.kind_of? Hash
+      if field.is_a? Hash
         Deprecation.warn DocumentPresenter, "Calling render_document_index_label with a hash is deprecated"
         field = field[:label]
       end
@@ -141,7 +141,7 @@ module Blacklight
       value = case    
         when (field_config and field_config.highlight)
           # retrieve the document value from the highlighting response
-          @document.highlight_field(field_config.field).map { |x| x.html_safe } if @document.has_highlight_field? field_config.field
+          @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

data/lib/blacklight/engine.rb

@@ -28,5 +28,16 @@ module Blacklight
       end
     end
 
+    Blacklight::Engine.config.sms_mappings = {
+      'Virgin' => 'vmobl.com',
+      'AT&T' => 'txt.att.net',
+      'Verizon' => 'vtext.com',
+      'Nextel' => 'messaging.nextel.com',
+      'Sprint' => 'messaging.sprintpcs.com',
+      'T Mobile' => 'tmomail.net',
+      'Alltel' => 'message.alltel.com',
+      'Cricket' => 'mms.mycricket.com'
+    }
+
   end
 end