blacklight 5.0.3 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dabf17ff15de58d015662a3f76b993373abddd2
-  data.tar.gz: 8a05023c77d84fae2f3221740157c887789c74b7
+  metadata.gz: 5b2d38f9b220bd5f8964188bb0ee5789fb834a3c
+  data.tar.gz: a25ff32577292eada643a0b1410c48d9544b3cde
 SHA512:
-  metadata.gz: 9f3c1b6f201964e4481be952d25d53c85960351dd304c83c884ca2a5000e517e160738f4f7763b6c118cf98f7bb8888cc9006ec14673261ba798afce20cf945a
-  data.tar.gz: e997713b7968192f908ee5c6d251f9e5a3f86f4789745bb9605cd9a747520920f1e3cacac84a87758b00bcaf0b3e23819c7039e16c2a14b51a46993857fb149b
+  metadata.gz: 4130f90f31cbcc0bbe4650f508bc38b88ed7779ab8af2523311bac816a879f2790ebd39c079410f10070761291ed20e04678651a19aa11b81bfe079f7f28851e
+  data.tar.gz: 83af8dee407631644e94b28af90ad3b995584c0856071fcbfdb7c9440a02e099b3def65e11c162a045dab11cef9230c49ab0c06ff8fd803b8917c6441d83fb98

data/.gitignore

@@ -11,5 +11,5 @@ log/*
 solr_marc/solrmarc.log
 lib/solrmarc.log.*
 tmp/*
-pkg/*
-spec/internal
+spec/internal/
+pkg/*

data/Gemfile

@@ -1,21 +1,21 @@
 source 'https://rubygems.org'
 
 # Please see blacklight.gemspec for dependency information.
-gemspec path: File.expand_path('..', __FILE__)
+gemspec
 
 
 gem 'simplecov', require: false
 gem 'coveralls', require: false
 
-gem 'engine_cart', '~> 0.3.0'
-
 group :test do
-  gem "blacklight-marc", "~> 5.0", github: "projectblacklight/blacklight_marc"
-  gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+  gem 'devise'
+  gem 'devise-guests'
+  gem "bootstrap-sass"
+  gem 'turbolinks'
+  gem 'sass-rails'
+  gem 'blacklight-marc', :github => 'projectblacklight/blacklight_marc'
 end
 
-file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
-if File.exists?(file)
-  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
-  instance_eval File.read(file)
+if File.exists?('spec/test_app_templates/Gemfile.extra')
+  eval File.read('spec/test_app_templates/Gemfile.extra'), nil, 'spec/test_app_templates/Gemfile.extra'
 end

data/Rakefile

@@ -1,6 +1,5 @@
 # encoding: UTF-8
 require 'rubygems'
-require 'rails'
 begin
   require 'bundler/setup'
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-5.0.3
+5.1.0

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

@@ -83,7 +83,8 @@
 
 }
 
-ul.facet_extended_list
+/* deprecated in Blacklight 5.x */
+ul.facet_extended_list, .facet_extended_list ul
 {
   @extend .list-unstyled;
 

data/app/controllers/bookmarks_controller.rb

@@ -15,7 +15,6 @@ class BookmarksController < CatalogController
   def search_action_url *args
     catalog_index_url *args
   end
-  helper_method :search_action_url
 
   before_filter :verify_user
 

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -170,7 +170,7 @@ module Blacklight::BlacklightHelperBehavior
     document = args.first
 
     field = options[:field]
-    html_escape t(:'blacklight.search.index.label', label: index_fields(document)[field].label)
+    html_escape t(:"blacklight.search.index.#{document_index_view_type}.label", default: :'blacklight.search.index.label', label: index_field_label(document, field))
   end
 
   ##
@@ -226,7 +226,7 @@ module Blacklight::BlacklightHelperBehavior
 
     field = options[:field]
 
-    html_escape t(:'blacklight.search.show.label', label: document_show_fields(document)[field].label)
+    html_escape t(:'blacklight.search.show.label', label: document_show_field_label(document, field))
   end
 
   ##
@@ -364,7 +364,7 @@ module Blacklight::BlacklightHelperBehavior
         end
 
         Array(value).map do |v|
-          link_to render_field_value(v, field_config), search_action_url(add_facet_params(link_field, v, {}))
+          link_to render_field_value(v, field_config), search_action_path(add_facet_params(link_field, v, {}))
         end if field
       else
         value

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -167,7 +167,11 @@ module Blacklight::CatalogHelperBehavior
     end
 
     if value
-      link_to_document document, url_options.merge(:label => value)
+      if url_options === false || url_options[:suppress_link]
+        value
+      else
+        link_to_document document, url_options.merge(:label => value)
+      end
     end
   end
 

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -24,6 +24,66 @@ module Blacklight::ConfigurationHelperBehavior
     blacklight_config.show_fields
   end
 
+  ##
+  # Look up the label for the index field
+  def index_field_label document, field
+    label = index_fields(document)[field].label
+
+    solr_field_label(
+      label, 
+      :"blacklight.search.fields.index.#{field}",
+      :"blacklight.search.fields.#{field}"
+    )
+  end
+
+  ##
+  # Look up the label for the show field
+  def document_show_field_label document, field
+    label = document_show_fields(document)[field].label
+    
+    solr_field_label(
+      label, 
+      :"blacklight.search.fields.show.#{field}",
+      :"blacklight.search.fields.#{field}"
+    )
+  end
+
+  ##
+  # Look up the label for the facet field
+  def facet_field_label field
+    label = blacklight_config.facet_fields[field].label
+
+    solr_field_label(
+      label, 
+      :"blacklight.search.fields.facet.#{field}",
+      :"blacklight.search.fields.#{field}"
+    )
+  end
+
+  ##
+  # Look up the label for a solr field.
+  #
+  # @overload
+  #   @param [Symbol] an i18n key 
+  #
+  # @overload
+  #   @param [String] default label to display if the i18n look up fails
+  #   @param [Symbol] i18n keys to attempt to look up 
+  #     before falling  back to the label
+  #   @param [Symbol] any number of additional keys
+  #   @param [Symbol] ...
+  def solr_field_label label, *i18n_keys
+    if label.is_a? Symbol
+      return t(label)
+    end
+
+    first, *rest = i18n_keys
+
+    rest << label
+
+    t(first, default: rest)
+  end
+  
   ##
   # Get the default index view type
   def default_document_index_view_type

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -111,11 +111,9 @@ module Blacklight::FacetsHelperBehavior
   # @param [String] facet item
   # @param [Hash] options
   # @option options [Boolean] :suppress_link display the facet, but don't link to it
-  # @option options [Rails::Engine] :route_set route set to use to render the link
   # @return [String]
-  def render_facet_value(facet_solr_field, item, options ={})    
-    scope = options.delete(:route_set) || self
-    path = scope.url_for(add_facet_params_and_redirect(facet_solr_field, item).merge(only_path: true))
+  def render_facet_value(facet_solr_field, item, options ={})
+    path = search_action_path(add_facet_params_and_redirect(facet_solr_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")
     end + render_facet_count(item.hits)
@@ -128,7 +126,7 @@ module Blacklight::FacetsHelperBehavior
     content_tag(:span, :class => "facet-label") do
       content_tag(:span, facet_display_value(facet_solr_field, item), :class => "selected") +
       # remove link
-      link_to(content_tag(:span, '', :class => "glyphicon glyphicon-remove") + content_tag(:span, '[remove]', :class => 'sr-only'), 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_solr_field, item, params)), :class=>"remove")
     end + render_facet_count(item.hits, :classes => ["selected"])
   end
 

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -78,7 +78,7 @@ module Blacklight::RenderConstraintsHelperBehavior
     safe_join(values.map do |val|
       render_constraint_element( blacklight_config.facet_fields[facet].label,
                   facet_display_value(facet, val),
-                  :remove => url_for(remove_facet_params(facet, val, localized_params)),
+                  :remove => search_action_path(remove_facet_params(facet, val, localized_params)),
                   :classes => ["filter", "filter-" + facet.parameterize]
                 )
     end, "\n")

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -1,5 +1,13 @@
 module Blacklight::UrlHelperBehavior
 
+  ##
+  # Extension point for downstream applications
+  # to provide more interesting routing to 
+  # documents
+  def url_for_document doc
+    doc
+  end
+
   # 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,
@@ -7,13 +15,13 @@ module Blacklight::UrlHelperBehavior
   def link_to_document(doc, opts={:label=>nil, :counter => nil})
     opts[:label] ||= document_show_link_field(doc)
     label = render_document_index_label doc, opts
-    link_to label, doc, search_session_params(opts[:counter]).merge(opts.reject { |k,v| [:label, :counter].include? k  })
+    link_to label, url_for_document(doc), search_session_params(opts[:counter]).merge(opts.reject { |k,v| [:label, :counter].include? k  })
   end
 
   ##
   # Link to the previous document in the current search context
   def link_to_previous_document(previous_document)
-    link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), previous_document, search_session_params(search_session[:counter].to_i - 1).merge(:class => "previous", :rel => 'prev')  do
+    link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), url_for_document(previous_document), search_session_params(search_session[:counter].to_i - 1).merge(:class => "previous", :rel => 'prev')  do
       content_tag :span, raw(t('views.pagination.previous')), :class => 'previous'
     end
   end
@@ -21,7 +29,7 @@ module Blacklight::UrlHelperBehavior
   ##
   # Link to the next document in the current search context
   def link_to_next_document(next_document)
-    link_to_unless next_document.nil?, raw(t('views.pagination.next')), next_document, search_session_params(search_session[:counter].to_i + 1).merge(:class => "next", :rel => 'next') do
+    link_to_unless next_document.nil?, raw(t('views.pagination.next')), url_for_document(next_document), search_session_params(search_session[:counter].to_i + 1).merge(:class => "next", :rel => 'next') do
       content_tag :span, raw(t('views.pagination.next')), :class => 'next'
     end
   end
@@ -40,7 +48,7 @@ module Blacklight::UrlHelperBehavior
   def link_to_query(query)
     p = params.except(:page, :action)
     p[:q]=query
-    link_url = catalog_index_path(p)
+    link_url = search_action_path(p)
     link_to(query, link_url)
   end
 
@@ -52,7 +60,7 @@ module Blacklight::UrlHelperBehavior
     current_index_view_type = document_index_view_type(query_params)
     h[:view] = current_index_view_type unless current_index_view_type == default_document_index_view_type
 
-    search_action_url(h)
+    search_action_path(h)
   end
 
   # Create a link back to the index screen, keeping the user's facet, query and paging choices intact by using session.
@@ -76,7 +84,7 @@ module Blacklight::UrlHelperBehavior
 
   # Search History and Saved Searches display
   def link_to_previous_search(params)
-    link_to(render_search_to_s(params), catalog_index_path(params))
+    link_to(render_search_to_s(params), search_action_path(params))
   end
 
   # @overload params_for_search(source_params, params_to_merge)
@@ -126,7 +134,13 @@ module Blacklight::UrlHelperBehavior
     my_params = source_params.reject { |k,v| v.nil? }
 
     my_params.except(:action, :controller, :id, :commit, :utf8)
+  end
 
+  ##
+  # Reset any search parameters that store search context
+  # and need to be reset when e.g. constraints change
+  def reset_search_params source_params
+    sanitize_search_params(source_params).except :page, :counter
   end
 
   # adds the value and/or field to params[:f]
@@ -143,7 +157,7 @@ module Blacklight::UrlHelperBehavior
 
     value = facet_value_for_facet_item(item)
 
-    p = source_params.dup
+    p = reset_search_params(source_params)
     p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
     p[:f][field] = (p[:f][field] || []).dup
 
@@ -171,15 +185,12 @@ module Blacklight::UrlHelperBehavior
   # catalog/index with their new facet choice. 
   def add_facet_params_and_redirect(field, item)
     new_params = add_facet_params(field, item)
-    new_params.except! :page, :id
 
     # Delete any request params from facet-specific action, needed
     # to redir to index action properly. 
     new_params.except! *Blacklight::Solr::FacetPaginator.request_keys.values
 
-    # Force action to be index. 
-    new_params[:action] = "index"
-    new_params    
+    new_params 
   end
 
   # copies the current params (or whatever is passed in as the 3rd arg)
@@ -193,21 +204,15 @@ module Blacklight::UrlHelperBehavior
 
     value = facet_value_for_facet_item(item)
 
-    p = source_params.dup
+    p = reset_search_params(source_params)
     # need to dup the facet values too,
     # if the values aren't dup'd, then the values
     # from the session will get remove in the show view...
     p[:f] = (p[:f] || {}).dup
     p[:f][field] = (p[:f][field] || []).dup
-    p.except! :page, :id, :counter, :commit
     p[:f][field] = p[:f][field] - [value]
     p[:f].delete(field) if p[:f][field].size == 0
     p
   end
 
-  if ::Rails.version < "4.0"
-    def asset_url *args
-      "#{request.protocol}#{request.host_with_port}#{asset_path(*args)}"
-    end
-  end
-end
+end

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="<%= "collapsed" if should_collapse_facet?(facet_field) %> collapse-toggle panel-heading" data-toggle="collapse" data-target="#facet-<%= facet_field.label.parameterize %>">
     <h5 class="panel-title">
-      <%= link_to facet_field.label, "#", :"data-no-turbolink" => true %>
+      <%= link_to facet_field_label(facet_field.field), "#", :"data-no-turbolink" => true %>
     </h5>
   </div>
   <div id="facet-<%= facet_field.label.parameterize %>" class="panel-collapse facet-content <%= should_collapse_facet?(facet_field) ? 'collapse' : 'in' %>">

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

@@ -1,7 +1,5 @@
 <ul class="facet-values list-unstyled">
-  <% paginator =    
-      Blacklight::Solr::FacetPaginator.new(display_facet.items,        
-        :limit => facet_limit_for(solr_field))
+  <% paginator = facet_paginator(facet_field, display_facet)
   %>
   <% paginator.items.each do |item| -%>
     <li>
@@ -13,7 +11,7 @@
     </li>
   <% end %>
 
-  <% if(paginator.has_next?)  %>
+  <% if paginator.has_next? and params[:action] != "facet" %>
     <li class="more_facets_link"><%= link_to(t('blacklight.search.facets.more'), params.merge(:id => solr_field, :action=>"facet", :page => nil), :class => "more_facets_link") %></li>
   <% end %>
 

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

@@ -1,4 +1,3 @@
-
     <div class="prev_next_links btn-group pull-left">
       <%= link_to_previous_page @pagination, raw(t('views.pagination.previous')), :params => params, :param_name => Blacklight::Solr::FacetPaginator.request_keys[:page], :class => 'btn btn-link', :data => {:ajax_modal => "preserve"} do %>
        <span class="disabled btn btn-disabled"><%= raw(t('views.pagination.previous')) %></span>

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

@@ -4,22 +4,11 @@
 
 <div class="modal-header">
   <button type="button" class="ajax-modal-close close" data-dismiss="modal" aria-hidden="true">×</button>
-  <h3 class="modal-title"><%= blacklight_config.facet_fields[params[:id]].label %></h3>
+  <h3 class="modal-title"><%= facet_field_label(@facet.field) %></h3>
 </div>
 <div class="modal-body">
   <div class="facet_extended_list">
-
-    <ul class="facet_extended_list facet-values">
-      <% @pagination.items.each do |item| %>
-        <li>
-          <% if facet_in_params?( params[:id], item.value ) %>              
-            <%= render_selected_facet_value(params[:id], item) %>              
-          <% else %>              
-            <%= render_facet_value(params[:id], item) %>              
-          <% end -%>
-        </li>
-      <% end %>
-    </ul>
+  <%= render_facet_limit(@display_facet, layout: false) %>
   </div>
 </div>
   

data/blacklight.gemspec

@@ -17,18 +17,18 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  # PRODUCTION GEM REQUIREMENTS
+  # ---------------------------------------   
   s.add_dependency "rails",     ">= 3.2.6", "< 5"
   s.add_dependency "nokogiri",  "~>1.6"     # XML Parser
   s.add_dependency "kaminari", "~> 0.13"  # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "rsolr",     "~> 1.0.6"  # Library for interacting with rSolr.
+  s.add_dependency "sass-rails"
   s.add_dependency "bootstrap-sass", "~> 3.0"
   s.add_dependency "deprecation"
-
   s.add_development_dependency "jettywrapper", ">= 1.5.2"
   s.add_development_dependency "blacklight-marc", "~> 5.0"
   s.add_development_dependency "rspec-rails"
-  s.add_development_dependency "capybara"
-  s.add_development_dependency "poltergeist"
   s.add_development_dependency 'engine_cart', ">= 0.1.0"
   s.add_development_dependency "equivalent-xml"
 end

data/gemfiles/rails3.gemfile

@@ -1,9 +1,23 @@
 source 'http://rubygems.org'
 
-file = File.expand_path("../../Gemfile", __FILE__)
-if File.exists?(file)
-  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
-  instance_eval File.read(file)
+# Please see blacklight.gemspec for dependency information.
+gemspec :path=>"../"
+
+gem 'rails', "~> 3.2"
+
+gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+
+group :test do
+  gem 'simplecov', require: false
+  gem 'coveralls', require: false
+  gem 'devise'
+  gem 'devise-guests'
+  gem "bootstrap-sass"
+  gem 'turbolinks'
+  gem 'uglifier'
 end
 
-gem 'rails', "3.2.17"
+f = File.expand_path(File.dirname(__FILE__) + '/../spec/test_app_templates/Gemfile.extra')
+if File.exists?(f)
+  eval File.read(f), nil, f
+end