blacklight 5.13.0 → 5.13.1

data/.rubocop_todo.yml

@@ -0,0 +1,253 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-04-13 15:13:47 -0700 using RuboCop version 0.30.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 19
+# Configuration parameters: AlignWith, SupportedStyles.
+Lint/EndAlignment:
+  Enabled: false
+
+# Offense count: 37
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# Offense count: 25
+# Cop supports --auto-correct.
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+# Offense count: 5
+Lint/UselessAssignment:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AccessModifierIndentation:
+  Enabled: false
+
+# Offense count: 9
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AlignParameters:
+  Enabled: false
+
+# Offense count: 87
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AndOr:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# Offense count: 25
+# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
+Style/CaseIndentation:
+  Enabled: false
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+# Offense count: 19
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredMethods.
+Style/CollectionMethods:
+  Enabled: false
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/DotPosition:
+  Enabled: false
+
+# Offense count: 24
+# Cop supports --auto-correct.
+Style/ElseAlignment:
+  Enabled: false
+
+# Offense count: 19
+# Cop supports --auto-correct.
+Style/EmptyLines:
+  Enabled: false
+
+# Offense count: 13
+# Cop supports --auto-correct.
+Style/EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+# Offense count: 22
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Offense count: 15
+# Cop supports --auto-correct.
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+# Offense count: 35
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# Offense count: 99
+# Cop supports --auto-correct.
+Style/ExtraSpacing:
+  Enabled: false
+
+# Offense count: 161
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues.
+Style/HashSyntax:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/IndentHash:
+  Enabled: false
+
+# Offense count: 61
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/IndentationConsistency:
+  Enabled: false
+
+# Offense count: 27
+# Cop supports --auto-correct.
+# Configuration parameters: Width.
+Style/IndentationWidth:
+  Enabled: false
+
+# Offense count: 13
+# Cop supports --auto-correct.
+Style/LeadingCommentSpace:
+  Enabled: false
+
+# Offense count: 177
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodDefParentheses:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/MultilineBlockLayout:
+  Enabled: false
+
+# Offense count: 36
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowSafeAssignment.
+Style/ParenthesesAroundCondition:
+  Enabled: false
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+Style/RedundantReturn:
+  Enabled: false
+
+# Offense count: 44
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Enabled: false
+
+# Offense count: 1
+Style/RescueModifier:
+  Enabled: false
+
+# Offense count: 10
+# Cop supports --auto-correct.
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+# Offense count: 30
+# Cop supports --auto-correct.
+Style/SpaceAfterComma:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleInsidePipes, SupportedStyles.
+Style/SpaceAroundBlockParameters:
+  Enabled: false
+
+# Offense count: 42
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+# Offense count: 24
+# Cop supports --auto-correct.
+# Configuration parameters: MultiSpaceAllowedForOperators.
+Style/SpaceAroundOperators:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SpaceBeforeBlockBraces:
+  Enabled: false
+
+# Offense count: 16
+# Cop supports --auto-correct.
+Style/SpaceBeforeComma:
+  Enabled: false
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+Style/SpaceInsideBlockBraces:
+  Enabled: false
+
+# Offense count: 14
+# Cop supports --auto-correct.
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+# Offense count: 32
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Offense count: 29
+# Cop supports --auto-correct.
+Style/SpaceInsideParens:
+  Enabled: false
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+# Offense count: 347
+# Cop supports --auto-correct.
+Style/TrailingWhitespace:
+  Enabled: false

data/.travis.yml

@@ -5,28 +5,26 @@ notifications:
   email: false
 
 rvm:
-  - 2.2.1
+  - 2.2.2
 
 matrix:
   include:
-    - rvm: 2.2.1
+    - rvm: 2.2.2
       env: "RAILS_VERSION=4.0.12"
-    - rvm: 2.2.1
+    - rvm: 2.2.2
       env: "RAILS_VERSION=4.1.9"
-    - rvm: 2.1.5
-      env: "RAILS_VERSION=4.2.0"
-    - rvm: 2.1.5
+    - rvm: 2.1.6
       env: "RAILS_VERSION=4.2.1"
     - rvm: jruby
-      env: "RAILS_VERSION=4.2.0 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
+      env: "RAILS_VERSION=4.2.1 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
     - rvm: 1.9.3
-      env: "RAILS_VERSION=4.2.0"
+      env: "RAILS_VERSION=4.2.1"
 
 before_install:
   - gem install bundler
 
 env:
- - "RAILS_VERSION=4.2.0"
+ - "RAILS_VERSION=4.2.1"
 
 notifications:
   irc: "irc.freenode.org#blacklight"

data/Rakefile

@@ -11,4 +11,4 @@ Bundler::GemHelper.install_tasks
 
 load "tasks/blacklight.rake"
 
-task :default => [:ci]
+task :default => [:ci]

data/VERSION

@@ -1 +1 @@
-5.13.0
+5.13.1

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -45,23 +45,19 @@ module Blacklight::BlacklightHelperBehavior
   #     content type, e.g. as required by atom
   # @option options [Array<String>] :exclude array of format shortnames to not include in the output 
   def render_link_rel_alternates(document=@document, options = {})
-    options = {:unique => false, :exclude => []}.merge(options)
+    return if document.nil?
 
-    return nil if document.nil?
+    options = { unique: false, exclude: [] }.merge(options)
 
     seen = Set.new
 
-    html = ""
-    document.export_formats.each_pair do |format, spec|
-      unless( options[:exclude].include?(format) ||
-             (options[:unique] && seen.include?(spec[:content_type]))
-             )
-        html << tag(:link, {:rel=>"alternate", :title=>format, :type => spec[:content_type], :href=> polymorphic_url(document, :format => format)}) << "\n"
+    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]) if options[:unique]
-      end
-    end
-    return html.html_safe
+      seen.add(spec[:content_type])
+
+      tag(:link, rel: "alternate", title: format, type: spec[:content_type], href: polymorphic_url(document, format: format))
+    end.compact, "\n")
   end
 
   ##
@@ -362,7 +358,7 @@ 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 = {}
-    if field.kind_of? Hash
+    if field.is_a? Hash
       Deprecation.warn self, "Calling render_document_index_label with a hash is deprecated"
       field = field[:label]
     end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -1,5 +1,7 @@
 # -*- encoding : utf-8 -*-
 module Blacklight::CatalogHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = "Blacklight 6.x"
 
   ##
   # Override the Kaminari page_entries_info helper with our own, blacklight-aware
@@ -99,8 +101,8 @@ module Blacklight::CatalogHelperBehavior
 
     return if types.blank?
 
-    Array(types).map do |t|
-      document_class_prefix + t.parameterize rescue nil
+    Array(types).compact.map do |t|
+      "#{document_class_prefix}#{t.try(:parameterize) || t}"
     end.join(' ')
   end
 
@@ -234,9 +236,14 @@ module Blacklight::CatalogHelperBehavior
     @current_bookmarks ||= current_or_guest_user.bookmarks_for_documents(response.documents).to_a
   end
 
-  def is_bookmarked? document
+  ##
+  # Check if the document is in the user's bookmarks
+  def bookmarked? document
     current_bookmarks.any? { |x| x.document_id == document.id and x.document_type == document.class }
   end
+
+  alias_method :is_bookmarked?, :bookmarked?
+  deprecation_deprecate :is_bookmarked?
   
   def render_marc_tools
     return unless defined? Blacklight::Marc
@@ -262,4 +269,8 @@ module Blacklight::CatalogHelperBehavior
     respond_to? :librarian_view_catalog_path and options[:document] and options[:document].respond_to?(:to_marc)
   end
 
+  def render_sms_action? config, options = {}
+    !sms_mappings.blank?
+  end
+
 end

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -164,7 +164,7 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # Default sort field
   def default_sort_field
-    (active_sort_fields.select { |k,config| config.respond_to? :default and config.default }.first || active_sort_fields.first).try(:last)
+    (active_sort_fields.find { |k,config| config.respond_to? :default and config.default } || active_sort_fields.first).try(:last)
   end
 
   ##

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -198,17 +198,17 @@ module Blacklight::FacetsHelperBehavior
       facet_value_for_facet_item(item)
     end
 
-    display_label = case
-      when facet_config.helper_method
-        display_label = send facet_config.helper_method, value 
-      when (facet_config.query and facet_config.query[value])
-        display_label = facet_config.query[value][:label]     
-      when facet_config.date
-        localization_options = {}
-        localization_options = facet_config.date unless facet_config.date === true
-        display_label = l(value.to_datetime, localization_options)
-      else
-        value
+    case
+    when facet_config.helper_method
+      send facet_config.helper_method, value
+    when (facet_config.query and facet_config.query[value])
+      facet_config.query[value][:label]
+    when facet_config.date
+      localization_options = {}
+      localization_options = facet_config.date unless facet_config.date === true
+      l(value.to_datetime, localization_options)
+    else
+      value
     end
   end
 
@@ -220,9 +220,9 @@ module Blacklight::FacetsHelperBehavior
 
   def facet_value_for_facet_item item
     if item.respond_to? :value
-      value = item.value
+      item.value
     else
-      value = item
+      item
     end
   end
 

data/app/helpers/blacklight/render_partials_helper.rb

@@ -150,6 +150,8 @@ module Blacklight::RenderPartialsHelper
     end
 
   private
+
+    # rubocop:disable Performance/Detect
     def find_document_show_template_with_view view_type, base_name, format, locals
       document_partial_path_templates.each do |str|
         partial = str % { action_name: base_name, format: format, index_view_type: view_type }
@@ -169,6 +171,7 @@ module Blacklight::RenderPartialsHelper
       end
       nil
     end
+    # rubocop:enable Performance/Detect
 
     ##
     # @param [Symbol] page the page type, either :index or :show