blacklight 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c37c9845bc5cd732386ab0fc43bbf2935022e25
-  data.tar.gz: f8aebbe56c4b6f9f7120d1e9901896da3dc0b71f
+  metadata.gz: fac08d13bf67f849e356efeeea75395d3dd66b44
+  data.tar.gz: 1ed742c6ae84f16f1361950eb4fdcdc7dbfb38f1
 SHA512:
-  metadata.gz: 5318ae2e9e5507c0afd82e057eeef478df545c8f17c2ba817ba0e216a455222392ab1a093ceca2d2223ac51d8be18386ec4b453693f1e4c2016ede24fdaea6a6
-  data.tar.gz: c4969efe9347576951e642bd6f9506624ea35a03eaf5dbf14fd1d428c9760de80481e3fc97d6fc0e5cc2dca4a0f22cb2e57f7566714e037340ee504cd19cb1c6
+  metadata.gz: b8106b0abf9286780e5446572ac0d47e375d75f628981086cd9101f6b994688ba9cc4f3329319be812edece3723c974be889f2a488cda8ae60929383bf1ff775
+  data.tar.gz: 5addaec1c1bfaf038aa6b1c010ec4942c40059345d344a805c4f062e47cce95eff2e15969ec6ddc3c7288ce0790453f06da79bab42ceca5b64964b7c4ff3e014

data/VERSION

@@ -1 +1 @@
-5.4.0
+5.5.0

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

@@ -102,27 +102,44 @@ Blacklight.ajaxModal.containerSelector    = "[data-ajax-modal~=container]";
 
 Blacklight.ajaxModal.modalCloseSelector   = "[data-ajax-modal~=close], span.ajax-close-modal";
 
-Blacklight.ajaxModal.receiveAjax = function (data) {
-      var contents = data.responseText;
-
-      // does it have a data- selector for container?
-      // important we don't execute script tags, we shouldn't. 
-      // code modelled off of JQuery ajax.load. https://github.com/jquery/jquery/blob/master/src/ajax/load.js?source=c#L62
-      var container =  $("<div>").
-        append( jQuery.parseHTML(contents) ).find( Blacklight.ajaxModal.containerSelector ).first();
-      if (container.size() !== 0) {
-        contents = container.html();
-      }
-
-      $(Blacklight.ajaxModal.modalSelector).find('.modal-content').html(contents);
-
-      // send custom event with the modal dialog div as the target
-      var e    = $.Event('loaded.blacklight.ajax-modal')
-      $(Blacklight.ajaxModal.modalSelector).trigger(e);
-      // if they did preventDefault, don't show the dialog
-      if (e.isDefaultPrevented()) return;
+// Called on fatal failure of ajax load, function returns content
+// to show to user in modal.  Right now called only for extreme
+// network errors. 
+Blacklight.ajaxModal.onFailure = function(data) {
+  var contents =  "<div class='modal-header'>" +
+           "<button type='button' class='close' data-dismiss='modal' aria-hidden='true'>×</button>" +
+           "Network Error</div>";
+  $(Blacklight.ajaxModal.modalSelector).find('.modal-content').html(contents);
+  $(Blacklight.ajaxModal.modalSelector).modal('show'); 
+}
 
-      $(Blacklight.ajaxModal.modalSelector).modal('show');      
+Blacklight.ajaxModal.receiveAjax = function (data) {      
+      if (data.readyState == 0) {
+        // Network error, could not contact server. 
+        Blacklight.ajaxModal.onFailure(data)
+      }
+      else {
+        var contents = data.responseText;
+      
+        // does it have a data- selector for container?
+        // important we don't execute script tags, we shouldn't. 
+        // code modelled off of JQuery ajax.load. https://github.com/jquery/jquery/blob/master/src/ajax/load.js?source=c#L62
+        var container =  $("<div>").
+          append( jQuery.parseHTML(contents) ).find( Blacklight.ajaxModal.containerSelector ).first();
+        if (container.size() !== 0) {
+          contents = container.html();
+        }
+
+        $(Blacklight.ajaxModal.modalSelector).find('.modal-content').html(contents);
+
+        // send custom event with the modal dialog div as the target
+        var e    = $.Event('loaded.blacklight.ajax-modal')
+        $(Blacklight.ajaxModal.modalSelector).trigger(e);
+        // if they did preventDefault, don't show the dialog
+        if (e.isDefaultPrevented()) return;
+
+        $(Blacklight.ajaxModal.modalSelector).modal('show');      
+      }
 };
 
 

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

@@ -13,6 +13,8 @@
        attribute (HTML5-style doc-*) that contains the id/primary key
        of the object in question -- used by plugin for a unique value for
        DOM id's. 
+
+  Uses HTML for a checkbox compatible with Bootstrap 3. 
        
    Pass in options for your class name and labels:
    $("form.something").bl_checkbox_submit({    
@@ -54,7 +56,6 @@
           .attr("id", options.css_class + "_" + unique_id);	  
         var label = $('<label>')
           .addClass( options.css_class )
-          .addClass('checkbox')
           .attr("for", options.css_class + '_' + unique_id)
           .attr("title", form.attr("title") || "");
         var span = $('<span>');
@@ -62,6 +63,10 @@
         label.append(checkbox);
         label.append(" ");
         label.append(span);  
+
+        var checkbox_div = $("<div class='checkbox' />")
+          .addClass(options.css_class)
+          .append(label);
           
         function update_state_for(state) {
             checkbox.prop("checked", state);
@@ -77,7 +82,7 @@
             }
           }
         
-        form.append(label);
+        form.append(checkbox_div);
         update_state_for(checked);
         
         checkbox.click(function() {

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

@@ -56,13 +56,17 @@ span.constraints-label {
     &:hover, &:active {
       background-color: $btn-default-bg;
       border-color: $btn-default-border;
+      box-shadow: none;
     }
   }
 
   .filterName:after
   {
     @extend .text-muted;
-    content: "\276F";
+    font-family: 'Glyphicons Halflings';
+    /* glyphicon-chevron-right */
+    content: "\e080";
+    font-size: 70%;
     padding-left: $caret-width-base;
   }
 
@@ -185,4 +189,4 @@ label.toggle_bookmark
   .caption {
     @extend .sr-only;
   }
-}
+}

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -505,7 +505,9 @@ module Blacklight::BlacklightHelperBehavior
       # XXX rather than handling this logic through exceptions, maybe there's a Rails internals method
       # for determining if a partial template exists..
       begin
-        return render :partial => (str % { :action_name => base_name, :format => format, :index_view_type => document_index_view_type }), :locals=>locals.merge(:document=>doc)
+        partial = str % { action_name: base_name, format: format, index_view_type: document_index_view_type }
+        logger.debug "Looking for document partial #{partial}"
+        return render partial: partial, locals: locals.merge(document: doc)
       rescue ActionView::MissingTemplate
         nil
       end

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -37,6 +37,24 @@ module Blacklight::ConfigurationHelperBehavior
     blacklight_config.show_fields
   end
 
+  ##
+  # Return a label for the currently selected search field.
+  # If no "search_field" or the default (e.g. "all_fields") is selected, then return nil
+  # Otherwise grab the label of the selected search field.
+  # @param [Hash] query parameters
+  # @return [String]
+  def constraint_query_label(localized_params = params)
+    label_for_search_field(localized_params[:search_field]) unless default_search_field?(localized_params[:search_field])
+  end
+
+  ##
+  # Is the search form using the default search field ("all_fields" by default)?
+  # @param [String] the currently selected search_field
+  # @return [Boolean]
+  def default_search_field?(selected_search_field)
+    selected_search_field.blank? || (default_search_field && selected_search_field == default_search_field[:key])
+  end
+
   ##
   # Look up the label for the index field
   def index_field_label document, field

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -50,6 +50,27 @@ module Blacklight::FacetsHelperBehavior
     render(options)
   end
 
+  ##
+  # 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)
+    safe_join(paginator.items.
+      map { |item| render_facet_item(solr_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)          
+    else
+      render_facet_value(solr_field, item)
+    end
+  end
+
   ##
   # Determine if Blacklight should render the display_facet or not
   #
@@ -77,7 +98,10 @@ module Blacklight::FacetsHelperBehavior
   end
 
   ##
-  # the name of the partial to use to render a facet field.
+  # The name of the partial to use to render a facet field.
+  # uses the value of the "partial" field if set in the facet configuration
+  # otherwise uses "facet_pivot" if this facet is a pivot facet 
+  # defaults to 'facet_limit'
   #
   # @return [String]
   def facet_partial_name(display_facet = nil)

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -33,21 +33,12 @@ module Blacklight::RenderConstraintsHelperBehavior
   # @return [String]
   def render_constraints_query(localized_params = params)
     # So simple don't need a view template, we can just do it here.
-    if (!localized_params[:q].blank?)
-      label = 
-        if (localized_params[:search_field].blank? || (default_search_field && localized_params[:search_field] == default_search_field[:key] ) )
-          nil
-        else
-          label_for_search_field(localized_params[:search_field])
-        end
-    
-      render_constraint_element(label,
-            localized_params[:q], 
-            :classes => ["query"], 
-            :remove => url_for(localized_params.merge(:q=>nil, :action=>'index')))
-    else
-      "".html_safe
-    end
+    return "".html_safe if localized_params[:q].blank?
+
+    render_constraint_element(constraint_query_label(localized_params),
+          localized_params[:q],
+          :classes => ["query"],
+          :remove => url_for(localized_params.merge(:q=>nil, :action=>'index')))
   end
 
   ##
@@ -76,8 +67,8 @@ module Blacklight::RenderConstraintsHelperBehavior
     facet_config = facet_configuration_for_field(facet)
 
     safe_join(values.map do |val|
-      render_constraint_element( blacklight_config.facet_fields[facet].label,
-                  facet_display_value(facet, val),
+      next if val.blank? # skip empty string
+      render_constraint_element( facet_field_label(facet), facet_display_value(facet, val),
                   :remove => search_action_path(remove_facet_params(facet, val, localized_params)),
                   :classes => ["filter", "filter-" + facet.parameterize]
                 )

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

@@ -1,34 +1,33 @@
-<%- # local params:
-    # label 
+<%  # local params:
+    # label
     # value
     # options =>
     #   :remove => url for a remove constraint link
     #   :classes => array of classes to add to container span
     options ||= {}
--%>
+%>
 
 <span class="btn-group appliedFilter constraint <%= options[:classes].join(" ") if options[:classes] %>">
-<a href="#" class="constraint-value btn btn-sm btn-default btn-disabled">
-      <%- unless label.blank? -%>
-        <span class="filterName"><%= label %></span> 
-      <%- end -%>
-      <%- unless value.blank? -%>
-        <span class="filterValue"><%= value %></span>
-      <%- end -%>          
-        </a>
+  <span class="constraint-value btn btn-sm btn-default btn-disabled">
+    <% unless label.blank? %>
+      <span class="filterName"><%= label %></span>
+    <% end %>
+    <% unless value.blank? %>
+      <span class="filterValue"><%= value %></span>
+    <% end %>
+  </span>
+  <% unless options[:remove].blank? %>
+    <% accessible_remove_label = content_tag :span, class: 'sr-only' do
+        if label.blank?
+          t('blacklight.search.filters.remove.value', value: value)
+        else
+          t('blacklight.search.filters.remove.label_value', label: label, value: value)
+        end
+      end
+    %>
 
-      <%- unless options[:remove].blank? -%>
-        <% accessible_remove_label = content_tag :span, :class => 'sr-only' do               
-                if label.blank?
-                  t('blacklight.search.filters.remove.value', :value => value)
-                else
-                  t('blacklight.search.filters.remove.label_value', :label => label, :value => value)
-                end 
-                end             
-        %>    
-
-        <%= link_to(content_tag(:span, '', :class => 'glyphicon glyphicon-remove') + accessible_remove_label,
-					options[:remove], :class => 'btn btn-default btn-sm remove dropdown-toggle'
-				) %>
-      <%- end -%>
+    <%= link_to(content_tag(:span, '', class: 'glyphicon glyphicon-remove') + accessible_remove_label,
+			options[:remove], class: 'btn btn-default btn-sm remove dropdown-toggle'
+		) %>
+  <%- end -%>
 </span>

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

@@ -1,18 +1,9 @@
 <ul class="facet-values list-unstyled">
-  <% paginator = facet_paginator(facet_field, display_facet)
-  %>
-  <% paginator.items.each do |item| -%>
-    <li>
-    <% if facet_in_params?( solr_field, item.value ) %>              
-        <%= render_selected_facet_value(solr_field, item) %>              
-      <% else %>              
-        <%= render_facet_value(solr_field, item) %>              
-    <% end -%>
-    </li>
-  <% end %>
+  <% paginator = facet_paginator(facet_field, display_facet) %>
+  <%= render_facet_limit_list paginator, solr_field %>
 
-  <% 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>
+  <% unless paginator.last_page? || 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 %>
-
 </ul>

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

@@ -0,0 +1,25 @@
+<h2 class="sr-only top-content-title"><%= t('blacklight.search.search_results_header') %></h2>
+
+<% @page_title = t('blacklight.search.title', :application_name => application_name) %>
+
+
+<% content_for(:head) do -%>
+  <%= render_opensearch_response_metadata %>
+  <%= auto_discovery_link_tag(:rss, url_for(params.merge(:format => 'rss')), :title => t('blacklight.search.rss_feed') ) %>
+  <%= auto_discovery_link_tag(:atom, url_for(params.merge(:format => 'atom')), :title => t('blacklight.search.atom_feed') ) %>
+<% end -%>
+
+
+<%= render 'search_header' %>
+
+<h2 class="sr-only"><%= t('blacklight.search.search_results') %></h2>
+
+<%- if @response.empty? %>
+  <%= render "zero_results" %>
+<%- elsif render_grouped_response? %>
+  <%= render_grouped_document_index %>
+<%- else %>
+  <%= render_document_index %>
+<%- end %>
+
+<%= render 'results_pagination' %>

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

@@ -1,41 +1,12 @@
-<div id="sidebar" class="col-md-3">
- <%= render 'search_sidebar' %>
+<div id="sidebar" class="col-md-3 col-sm-4">
+  <%= render 'search_sidebar' %>
 </div>
 
-<div id="content" class="col-md-9">
-
-    <% unless has_search_parameters? %>
-	    <%# if there are no input/search related params, display the "home" partial -%>
-	    <%= render 'home' %>
-    <% else %>
-
-      <h2 class="sr-only top-content-title"><%= t('blacklight.search.search_results_header') %></h2>
-
-      <% @page_title = t('blacklight.search.title', :application_name => application_name) %>
-
-
-      <% content_for(:head) do -%>
-        <%= render_opensearch_response_metadata %>
-        <%= auto_discovery_link_tag(:rss, url_for(params.merge(:format => 'rss')), :title => t('blacklight.search.rss_feed') ) %>
-        <%= auto_discovery_link_tag(:atom, url_for(params.merge(:format => 'atom')), :title => t('blacklight.search.atom_feed') ) %>
-      <% end -%>
-
-
-      <%= render 'search_header' %>
-
-      <h2 class="sr-only"><%= t('blacklight.search.search_results') %></h2>
-
-      <%- if @response.empty? %>
-        <%= render "zero_results" %>
-      <%- elsif render_grouped_response? %>
-        <%= render_grouped_document_index %>
-      <%- else %>
-        <%= render_document_index %>
-      <%- end %>
-
-	    <%= render 'results_pagination' %>
-
-
-    <% end %>
-
+<div id="content" class="col-md-9 col-sm-8">
+  <% unless has_search_parameters? %>
+    <%# if there are no input/search related params, display the "home" partial -%>
+    <%= render 'home' %>
+  <% else %>
+    <%= render 'search_results' %>
+  <% end %>
 </div>

data/blacklight.gemspec

@@ -26,7 +26,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "jettywrapper", ">= 1.7.0"
   s.add_development_dependency "blacklight-marc", "~> 5.0"
-  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "rspec-rails", "~> 2.99"
+  s.add_development_dependency "rspec-its"
   s.add_development_dependency "capybara"
   s.add_development_dependency "poltergeist"
   s.add_development_dependency 'engine_cart', ">= 0.1.0"

data/lib/blacklight/request_builders.rb

@@ -121,6 +121,7 @@ module Blacklight
         
         f_request_params.each_pair do |facet_field, value_list|
           Array(value_list).each do |value|
+            next if value.blank? # skip empty strings
             solr_parameters.append_filter_query facet_value_to_fq_string(facet_field, value)
           end              
         end      

data/lib/blacklight/solr/facet_paginator.rb

@@ -12,6 +12,10 @@ module Blacklight::Solr
   # so we cannot know how many "pages" there are.
   #
   class FacetPaginator    
+    extend Deprecation
+
+    self.deprecation_horizon = 'blacklight version 6.0.0'
+    
     # What request keys will we use for the parameters need. Need to
     # make sure they do NOT conflict with catalog/index request params,
     # and need to make them accessible in a list so we can easily
@@ -21,7 +25,7 @@ module Blacklight::Solr
     class << self; attr_accessor :request_keys end # create a class method
     def request_keys ; self.class.request_keys ; end # shortcut
     
-    attr_reader :total, :items, :offset, :limit, :sort
+    attr_reader :total_count, :items, :offset, :limit, :sort
     
     # all_facet_values is a list of facet value objects returned by solr,
     # asking solr for n+1 facet values.
@@ -33,54 +37,72 @@ module Blacklight::Solr
     def initialize(all_facet_values, arguments)
       # to_s.to_i will conveniently default to 0 if nil
       @offset = arguments[:offset].to_s.to_i 
-      @limit =  arguments[:limit].to_s.to_i if arguments[:limit]           
+      @limit =  arguments[:limit].to_s.to_i
       # count is solr's default
       @sort = arguments[:sort] || "count" 
-      
-      total = all_facet_values.size
-      if (@limit)
-        @items = all_facet_values.slice(0, @limit)
-        @has_next = total > @limit
-        @has_previous = @offset > 0
-      else # nil limit
-        @items = all_facet_values
-        @has_next = false
-        @has_previous = false
-      end
+      @total_count = all_facet_values.size
+      @items = items_for_limit(all_facet_values)
+    end
+
+    def prev_page
+      current_page - 1 unless first_page?
     end
 
     def current_page
-      1 + @offset/@limit
+      if limit == 0 #check for divide by zero
+        1
+      else
+        @offset / limit + 1
+      end
+    end
+
+    def next_page
+      current_page + 1 unless last_page?
     end
    
+    #@deprecated
     def has_next?
-      @has_next
+      !last_page?
     end
+    deprecation_deprecate :has_next?
 
+    #@deprecated
     def has_previous?
-      @has_previous
+      !first_page?
     end
+    deprecation_deprecate :has_next?
 
     def last_page?
-      !has_next?
+      current_page >= total_pages
     end
 
     def first_page?
-      !has_previous?
+      current_page == 1
     end
 
+    def total_pages
+      if limit == 0 #check for divide by zero
+        1
+      else
+        (total_count.to_f / limit).ceil
+      end
+    end      
 
-   # Pass in a desired solr facet solr key ('count' or 'index', see
-   # http://wiki.apache.org/solr/SimpleFacetParameters#facet.limit
-   # under facet.sort ), and your current request params.
-   # Get back params suitable to passing to an ActionHelper method for
-   # creating a url, to resort by that method.
-   def params_for_resort_url(sort_method, params)
-     # When resorting, we've got to reset the offset to start at beginning,
-     # no way to make it make sense otherwise.
-     return params.merge(request_keys[:sort] => sort_method, request_keys[:page] => nil)
-   end
-    
+    # Pass in a desired solr facet solr key ('count' or 'index', see
+    # http://wiki.apache.org/solr/SimpleFacetParameters#facet.limit
+    # under facet.sort ), and your current request params.
+    # Get back params suitable to passing to an ActionHelper method for
+    # creating a url, to resort by that method.
+    def params_for_resort_url(sort_method, params)
+      # When resorting, we've got to reset the offset to start at beginning,
+      # no way to make it make sense otherwise.
+      params.merge(request_keys[:sort] => sort_method, request_keys[:page] => nil)
+    end
+
+    private
+      # setting limit to 0 implies no limit
+      def items_for_limit(values)
+        limit != 0 ? values.slice(offset, limit) : values
+      end
   end
-  
 end

data/spec/helpers/facets_helper_spec.rb

@@ -17,7 +17,7 @@ describe FacetsHelper do
       empty = double(:items => [])
 
       fields = [a,b,empty]
-      expect(helper.has_facet_values?(fields)).to be_true
+      expect(helper.has_facet_values?(fields)).to be true
     end
 
     it "should be false if all facets are empty" do
@@ -25,7 +25,7 @@ describe FacetsHelper do
       empty = double(:items => [])
 
       fields = [empty]
-      expect(helper.has_facet_values?(fields)).to be_false
+      expect(helper.has_facet_values?(fields)).to be false
     end
   end
 
@@ -45,37 +45,37 @@ describe FacetsHelper do
 
     it "should render facets with items" do
       a = double(:items => [1,2], :name=>'basic_field')
-      expect(helper.should_render_facet?(a)).to be_true
+      expect(helper.should_render_facet?(a)).to be true
     end
     it "should not render facets without items" do
       empty = double(:items => [], :name=>'basic_field')
-      expect(helper.should_render_facet?(empty)).to be_false
+      expect(helper.should_render_facet?(empty)).to be false
     end
 
     it "should not render facets where show is set to false" do
       a = double(:items => [1,2], :name=>'no_show')
-      expect(helper.should_render_facet?(a)).to be_false
+      expect(helper.should_render_facet?(a)).to be false
     end
 
     it "should call a helper to determine if it should render a field" do
       helper.stub(:my_helper => true)
       a = double(:items => [1,2], :name=>'helper_show')
-      expect(helper.should_render_facet?(a)).to be_true
+      expect(helper.should_render_facet?(a)).to be true
     end
 
     it "should call a helper to determine if it should render a field" do
       a = double(:items => [1,2], :name=>'helper_with_an_arg_show')
       helper.should_receive(:my_helper_with_an_arg).with(@config.facet_fields['helper_with_an_arg_show'], a).and_return(true)
-      expect(helper.should_render_facet?(a)).to be_true
+      expect(helper.should_render_facet?(a)).to be true
     end
 
 
     it "should evaluate a Proc to determine if it should render a field" do
       a = double(:items => [1,2], :name=>'lambda_show')
-      expect(helper.should_render_facet?(a)).to be_true
+      expect(helper.should_render_facet?(a)).to be true
 
       a = double(:items => [1,2], :name=>'lambda_no_show')
-      expect(helper.should_render_facet?(a)).to be_false
+      expect(helper.should_render_facet?(a)).to be false
     end
   end
 
@@ -90,17 +90,17 @@ describe FacetsHelper do
     end
 
     it "should be collapsed by default" do
-      expect(helper.should_collapse_facet?(@config.facet_fields['basic_field'])).to be_true
+      expect(helper.should_collapse_facet?(@config.facet_fields['basic_field'])).to be true
     end
 
     it "should not be collapsed if the configuration says so" do
-      expect(helper.should_collapse_facet?(@config.facet_fields['no_collapse'])).to be_false
+      expect(helper.should_collapse_facet?(@config.facet_fields['no_collapse'])).to be false
     end
 
     it "should not be collapsed if it is in the params" do
       params[:f] = { basic_field: [1], no_collapse: [2] }.with_indifferent_access
-      expect(helper.should_collapse_facet?(@config.facet_fields['basic_field'])).to be_false
-      expect(helper.should_collapse_facet?(@config.facet_fields['no_collapse'])).to be_false
+      expect(helper.should_collapse_facet?(@config.facet_fields['basic_field'])).to be false
+      expect(helper.should_collapse_facet?(@config.facet_fields['no_collapse'])).to be false
     end
 
   end
@@ -152,7 +152,7 @@ describe FacetsHelper do
         field.should be_a_kind_of Blacklight::SolrResponse::Facets::FacetField
 
         expect(field.name).to eq'my_query_facet_field'
-        expect(field.items).to have(2).items
+        expect(field.items.size).to eq 2
         expect(field.items.map { |x| x.value }).to_not include 'field:not_appearing_in_the_config'
 
         facet_item = field.items.select { |x| x.value == 'a_simple_query' }.first
@@ -180,11 +180,11 @@ describe FacetsHelper do
 
         expect(field.name).to eq 'my_pivot_facet_field'
 
-        expect(field.items).to have(1).item
+        expect(field.items.size).to eq 1
 
         expect(field.items.first).to respond_to(:items)
 
-        expect(field.items.first.items).to have(1).item
+        expect(field.items.first.items.size).to eq 1
         expect(field.items.first.items.first.fq).to eq({ 'field_a' => 'a' })
       end
     end
@@ -281,11 +281,40 @@ describe FacetsHelper do
     end 
   end
 
+  describe "render_facet_limit_list" do
+    let(:f1) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '792', value: 'Book') }
+    let(:f2) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '65', value: 'Musical Score') }
+    let(:paginator) { Blacklight::Solr::FacetPaginator.new([f1, f2], limit: 10) }
+    subject { helper.render_facet_limit_list(paginator, 'type_solr_field') }
+    before do
+      allow(helper).to receive(:search_action_path) do |*args|
+        catalog_index_path *args
+      end
+    end
+    it "should draw a list of elements" do
+      expect(subject).to have_selector 'li', count: 2
+      expect(subject).to have_selector 'li:first-child a.facet_select', text: 'Book' 
+      expect(subject).to have_selector 'li:nth-child(2) a.facet_select', text: 'Musical Score' 
+    end
+
+    context "when one of the facet items is rendered as nil" do
+      # An app may override render_facet_item to filter out some undesired facet items by returning nil.
+      
+      before { allow(helper).to receive(:render_facet_item).and_return("<a class=\"facet_select\">Book</a>".html_safe, nil) }
+
+      it "should draw a list of elements" do
+        expect(subject).to have_selector 'li', count: 1
+        expect(subject).to have_selector 'li:first-child a.facet_select', text: 'Book' 
+      end
+
+    end
+  end
+
   describe "facet_field_in_params?" do
     it "should check if the facet field is selected in the user params" do
       helper.stub(:params => { :f => { "some-field" => ["x"]}})
-      expect(helper.facet_field_in_params?("some-field")).to be_true
-      expect(helper.facet_field_in_params?("other-field")).to_not be_true
+      expect(helper.facet_field_in_params?("some-field")).to be_truthy
+      expect(helper.facet_field_in_params?("other-field")).to_not be true
     end
   end
 
@@ -300,7 +329,7 @@ describe FacetsHelper do
       helper.should_receive(:facet_display_value).and_return('Z')
       helper.should_receive(:add_facet_params_and_redirect).and_return({controller:'catalog'})
       
-      helper.stub(:search_action_path) do |*args|
+      allow(helper).to receive(:search_action_path) do |*args|
         catalog_index_path *args
       end
     end

data/spec/helpers/render_constraints_helper_spec.rb

@@ -2,6 +2,12 @@ require 'spec_helper'
 
 describe RenderConstraintsHelper do
 
+  let(:config) do
+    Blacklight::Configuration.new do |config|
+      config.add_facet_field 'type'
+    end
+  end
+
   before do
     # the helper methods below infer paths from the current route
     controller.request.path_parameters["controller"] = 'catalog'
@@ -18,15 +24,25 @@ describe RenderConstraintsHelper do
 
   describe '#render_filter_element' do
     before do
-      @config = Blacklight::Configuration.new do |config|
-        config.add_facet_field 'type'
-      end
-      helper.stub(:blacklight_config => @config)
+      allow(helper).to receive(:blacklight_config).and_return(config)
+      expect(helper).to receive(:facet_field_label).with('type').and_return("Item Type")
     end
+    subject { helper.render_filter_element('type', ['journal'], {:q=>'biz'}) }
+
     it "should have a link relative to the current url" do
-      result = helper.render_filter_element('type', ['journal'], {:q=>'biz'})
-      expect(result).to have_link "Remove constraint Type: journal", href: "/catalog?q=biz"
+      expect(subject).to have_link "Remove constraint Item Type: journal", href: "/catalog?q=biz"
+      expect(subject).to have_selector ".filterName", text: 'Item Type'
     end
   end
 
+  describe "#render_constraints_filters" do
+    before do
+      allow(helper).to receive(:blacklight_config).and_return(config)
+    end
+    subject { helper.render_constraints_filters(:f=>{'type'=>['']}) }
+
+    it "should render nothing for empty facet limit param" do
+      expect(subject).to be_blank
+    end
+  end
 end

data/spec/lib/blacklight/facet_paginator_spec.rb

@@ -1,75 +1,67 @@
 require 'spec_helper'
 
 describe 'Blacklight::Solr::FacetPaginator' do
-  before(:all) do
-    require 'yaml'
-    @seven_facet_values = YAML::load("--- \n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 792\n  value: Book\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 65\n  value: Musical Score\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 58\n  value: Serial\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 48\n  value: Musical Recording\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 37\n  value: Microform\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 27\n  value: Thesis\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 0\n  value: \n")
-    @six_facet_values = @seven_facet_values.slice(1,6)
-    @limit = 6
 
-    @sort_key = Blacklight::Solr::FacetPaginator.request_keys[:sort]
-    @page_key = Blacklight::Solr::FacetPaginator.request_keys[:page]
-  end
-  context 'when there are limit+1 results' do
-    before(:each) do
-      @paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :limit => 6)
-    end
-    it 'should have next' do
-      expect(@paginator).to have_next
-    end
+  let(:f1) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '792', value: 'Book') }
+  let(:f2) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '65', value: 'Musical Score') }
+  let(:f3) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '58', value: 'Serial') }
+  let(:f4) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '48', value: 'Musical Recording') }
+  let(:f5) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '37', value: 'Microform') }
+  let(:f6) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '27', value: 'Thesis') }
+  let(:f7) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '0') }
+  let(:seven_facet_values) { [f1, f2, f3, f4, f5, f6, f7] }
+  let(:six_facet_values) { [f1, f2, f3, f4, f5, f6] }
+  let(:limit) { 6 }
 
+  context 'on the first page of two pages' do
+    subject { Blacklight::Solr::FacetPaginator.new(seven_facet_values, limit: limit) }
+    it { should be_first_page }
+    it { should_not be_last_page }
+    its(:current_page) { should eq 1 }
+    its(:prev_page) { should be_nil }
+    its(:next_page) { should eq 2 }
+    it 'should limit items to limit, if limit is smaller than items.length' do
+      expect(subject.items.size).to eq 6
+    end
   end
-  it 'should not have next when there are fewer results' do
-    paginator = Blacklight::Solr::FacetPaginator.new(@six_facet_values, :offset => 0, :limit => @limit)
 
-    expect(paginator).not_to have_next
-  end
-  context 'when offset is greater than 0' do
-    before(:each) do
-      @offset = 100
-      @paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :offset => @offset, :limit => @limit)
-    end
-  
-    it 'should have previous' do    
-      expect(@paginator).to have_previous
+  context 'on the last page of two pages' do
+    subject { Blacklight::Solr::FacetPaginator.new(seven_facet_values, offset: 6, limit: limit) }
+    it { should_not be_first_page }
+    it { should be_last_page }
+    its(:current_page) { should eq 2 }
+    its(:prev_page) { should eq 1 }
+    its(:next_page) { should be_nil }
+    it 'should return all items when limit is greater than items.length' do
+      expect(subject.items.size).to eq 1
     end
-
   end
-  it 'should not have previous when offset is 0' do
-    paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :offset => 0, :limit => @limit)
 
-    expect(paginator).not_to have_previous
+  context 'on the first page of one page' do
+    subject { Blacklight::Solr::FacetPaginator.new(six_facet_values, offset: 0, limit: limit) }
+    it { should be_first_page }
+    it { should be_last_page }
   end
-  it 'should know a manually set sort, and produce proper sort url' do
-      paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :offset => 100, :limit => @limit, :sort => 'index')
 
-      expect(paginator.sort).to eq 'index'
-      
-      click_params = paginator.params_for_resort_url('count', {})
+  describe "params_for_resort_url" do
+    let(:sort_key) { Blacklight::Solr::FacetPaginator.request_keys[:sort] }
+    let(:page_key) { Blacklight::Solr::FacetPaginator.request_keys[:page] }
+    let(:paginator) { Blacklight::Solr::FacetPaginator.new(seven_facet_values, offset: 100, limit: limit, sort: 'index') }
 
-      expect(click_params[ @sort_key ]).to eq 'count'
-      expect(click_params[ @page_key ]).to be_nil
-  end
-  it 'should limit items to limit, if limit is smaller than items.length' do
-    paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :offset => 100, :limit => 6, :sort => 'index')
-    expect(paginator.items).to have(6).items
-  end
-  it 'should return all items when limit is greater than items.length' do
-    paginator = Blacklight::Solr::FacetPaginator.new(@six_facet_values, :offset => 100, :limit => 6, :sort => 'index')
-    expect(paginator.items).to have(6).items
-  end
-  describe "for a nil :limit" do
-    before(:all) do
-      @paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :offset => 100, :limit => nil, :sort => 'index')
-    end
-    it 'should return all items' do
-      expect(@paginator.items).to eq @seven_facet_values      
-    end
-    it 'should not has_next?' do
-      expect(@paginator).not_to have_next
+    it 'should know a manually set sort, and produce proper sort url' do
+        expect(paginator.sort).to eq 'index'
+        
+        click_params = paginator.params_for_resort_url('count', {})
+
+        expect(click_params[ sort_key ]).to eq 'count'
+        expect(click_params[ page_key ]).to be_nil
     end
-    it 'should not has_previous?' do
-      expect(@paginator).not_to have_previous
+  end
+
+  context "for a nil :limit" do
+    subject { Blacklight::Solr::FacetPaginator.new(seven_facet_values, offset: 0, limit: nil) }
+    it "should return all the items" do
+      expect(subject.items).to eq seven_facet_values
     end
   end
   

data/spec/lib/blacklight/solr_helper_spec.rb

@@ -191,6 +191,14 @@ describe Blacklight::SolrHelper do
       end
     end
 
+    describe "for an empty facet limit param" do
+      it "should not add any fq to solr" do
+        solr_params = subject.solr_search_params(:f => {"format" => [""]})
+
+        expect(solr_params[:fq]).to be_blank
+      end
+    end
+
     describe "with Multi Facets, No Query" do
       it 'should have fq set properly' do
         solr_params = subject.solr_search_params(:f => @multi_facets)

data/spec/spec_helper.rb

@@ -22,6 +22,7 @@ require 'engine_cart'
 EngineCart.load_application!
 
 require 'rspec/rails'
+require 'rspec/its'
 require 'capybara/rspec'
 require 'capybara/poltergeist'
 
@@ -43,15 +44,6 @@ end
 Dir[Pathname.new(File.expand_path("../support/**/*.rb", __FILE__))].each {|f| require f}
 
 RSpec.configure do |config|
-  # == Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
-  config.mock_with :rspec
-
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
   config.fixture_path = "#{::Rails.root}/spec/fixtures"
 
@@ -61,4 +53,5 @@ RSpec.configure do |config|
   config.use_transactional_fixtures = true
 
   config.include Devise::TestHelpers, type: :controller
+  config.infer_spec_type_from_file_location!
 end

data/spec/views/catalog/_constraints_element.html.erb_spec.rb

@@ -7,8 +7,10 @@ describe "catalog/_constraints_element.html.erb" do
     end
     it "should render label and value" do
       expect(rendered).to have_selector("span.appliedFilter.constraint") do |s|
+        expect(s).to have_css("span.constraint-value")
+        expect(s).to_not have_css("a.constraint-value")
         expect(s).to have_selector "span.filterName", :content => "my label"
-        expect(s).to have_selector "span.filterValue", :content => "my value" 
+        expect(s).to have_selector "span.filterValue", :content => "my value"
       end
     end
   end
@@ -20,7 +22,7 @@ describe "catalog/_constraints_element.html.erb" do
     it "should include remove link" do
       expect(rendered).to have_selector("span.appliedFilter") do |s|
         expect(s).to have_selector(".remove[href='http://remove']")
-      end    
+      end
     end
 
     it "should have an accessible remove label" do
@@ -37,7 +39,7 @@ describe "catalog/_constraints_element.html.erb" do
     it "should not include checkmark" do
       expect(rendered).to have_selector("span.appliedFilter") do |s|
         expect(s).to_not have_selector("img[src$='checkmark.gif']")
-      end   
+      end
     end
   end
 
@@ -60,6 +62,6 @@ describe "catalog/_constraints_element.html.erb" do
     end
 
   end
- 
+
 
 end

data/template.demo.rb

@@ -3,13 +3,17 @@ gem "blacklight", ">= 5.3.0"
 run "bundle install"
 
 # run the blacklight install generator
-generate 'blacklight:install', '--devise --marc --jettywrapper'
+options = ENV.fetch("BLACKLIGHT_INSTALL_OPTIONS", '--devise --marc --jettywrapper')
+
+generate 'blacklight:install', options
 
 # run the database migrations
 rake "db:migrate"
 
 # index some data
-rake "jetty:clean"
-rake "jetty:start"
-rake "blacklight:solr:seed"
-rake "jetty:stop"
+if options =~ /jettywrapper/
+  rake "jetty:clean"
+  rake "jetty:start"
+  rake "blacklight:solr:seed"
+  rake "jetty:stop"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -139,6 +139,20 @@ dependencies:
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -308,6 +322,7 @@ files:
 - app/views/catalog/_results_pagination.html.erb
 - app/views/catalog/_search_form.html.erb
 - app/views/catalog/_search_header.html.erb
+- app/views/catalog/_search_results.html.erb
 - app/views/catalog/_search_sidebar.html.erb
 - app/views/catalog/_show_default.html.erb
 - app/views/catalog/_show_header_default.html.erb