blacklight 4.9.0 → 5.0.0.pre1

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

@@ -0,0 +1,141 @@
+#sidebar, #facets {
+  @extend .clearfix;
+  padding-bottom: $padding-large-vertical;
+}
+
+.no-js {
+  #sidebar .collapse {
+    @extend .in;
+  }  
+}
+
+.facet_limit-active {
+  @extend .panel-success;
+}
+
+#facet-panel-collapse {
+  @extend .navbar-collapse;
+  padding-left: 0;
+  padding-right: 0;
+  border-top: none;
+  box-shadow: none;
+  max-height: none;
+}
+
+.facets-toggle {
+  @extend .navbar-toggle;
+  @extend .btn;
+  @extend .btn-default;
+
+  border-color: $navbar-default-toggle-border-color;
+
+  .icon-bar {
+    background-color: $navbar-default-toggle-icon-bar-bg;
+  }
+}
+
+.facet-values {
+  display: table;
+  width: 100%;
+
+  li {
+
+    display: table-row;
+
+    .selected {
+      @extend .text-success;
+    }
+
+    .remove {
+      @extend .text-muted;
+      text-indent: $padding-base-horizontal;
+    }
+  }
+
+  .facet-label {
+    display: table-cell;
+    padding-right: 1em;
+
+    text-indent: -15px;
+    padding-left: 15px;
+    padding-bottom: $padding-base-vertical;
+  }
+
+  .facet-count {
+    display: table-cell;
+    vertical-align: top;
+    text-align: right;
+  }
+}
+
+.facet_extended_list
+{
+  .sort_options
+  {
+    text-align:right;
+  }
+
+
+  .prev_next_links
+  {
+    float:left;
+  }
+
+}
+
+ul.facet_extended_list
+{
+  @extend .list-unstyled;
+
+}
+
+.collapse-toggle {
+  cursor: pointer;
+}
+
+.panel-heading.collapse-toggle .panel-title:after {
+    /* symbol for "opening" panels */
+    font-family: 'Glyphicons Halflings';  /* essential for enabling glyphicon */
+    content: "\e114";    /* adjust as needed, taken from bootstrap.css */
+    float: right;        /* adjust as needed */
+    color: grey;         /* adjust as needed */
+    font-size: 0.8em;
+    line-height: normal;
+}
+.panel-heading.collapse-toggle.collapsed .panel-title:after {
+    /* symbol for "collapsed" panels */
+    content: "\e080";    /* adjust as needed, taken from bootstrap.css */
+}
+
+/* Sidenav
+-------------------------------------------------- */
+
+.facet_pagination {
+  @extend .clearfix;
+}
+
+
+@media (max-width: $grid-float-breakpoint) {
+
+  .facets-toggle {
+    margin-top: 3px;
+  }
+
+  #facets .top-panel-heading {
+    border: 1px solid #ccc;
+    margin-bottom: 1em;
+    @include border-bottom-radius($panel-border-radius - 1);
+  }
+}
+
+/* style for pivot facet's nested list */
+
+.pivot-facet {
+  @extend .list-unstyled;
+
+  ul, .pivot-facet {
+    @extend .list-unstyled;
+    padding-bottom: $padding-base-vertical;
+    padding-left: $padding-large-horizontal;
+  }
+}

data/app/assets/stylesheets/blacklight/{_group.scss → _group.css.scss}

@@ -1,5 +1,5 @@
 .group-key {
-  border-bottom: 1px solid $dark_border_color;
+  border-bottom: 1px solid darken($table-border-color, 60%);
   clear: right;
 }
 

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

@@ -0,0 +1,44 @@
+/*
+  Header bar at top (Bootstrap nav-bar)
+*/
+
+#header-navbar {
+  .navbar-brand {  /* The main logo image for the Blacklight instance */
+  	width: 150px;
+	  background:transparent image_url($logo_image) no-repeat top left;
+	  display: inline-block;
+	  text-indent: 100%;
+	  white-space: nowrap;
+	  overflow: hidden;
+	  padding-right:0;
+	  margin-right:20px;
+	  padding-left: 0;
+  }
+}
+
+#search-navbar {
+  .search-query-form {
+    @extend .col-md-8;
+    padding-left: 0;
+  }
+
+  .search-query-form {
+    border: 0;
+  }
+  .submit-search-text {
+    // hide 'search' label at very small screens, magnifying glass
+    // icon should still be there. 
+    @media screen and (max-width: $screen-xs-min ) {      
+      // copied from .sr-only, sadly can't seem to use @extend in a media
+      // query like this, have to copy. 
+      position: absolute;
+      width: 1px;
+      height: 1px;
+      margin: -1px;
+      padding: 0;
+      overflow: hidden;
+      clip: rect(0,0,0,0);
+      border: 0;    
+    }    
+  }
+}

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

@@ -0,0 +1,5 @@
+/* Generic layout stuff */
+
+.navbar + .navbar {
+  margin-top: -$navbar-margin-bottom;
+}

data/app/assets/stylesheets/blacklight/{_modal.scss → _modal.css.scss}

@@ -1,10 +1,9 @@
-.modal-header {
-	h1 {
-		font-size: 24px; line-height: 40px;
-	}
-}
-
 #ajax-modal {
+
+  .modal-content {
+    @extend .clearfix;
+  }
+
   #email_form {
     width: auto;
   }
@@ -18,10 +17,11 @@
   }
 
   button.close {
-	display: block;
+	  display: block;
   }
 }
 
+
 button.close {
 	display: none;
 }

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

@@ -0,0 +1,20 @@
+/* Search History */
+.search_history
+{
+
+  .constraint 
+  {
+    display: block;
+    text-indent: -$padding-large-horizontal;
+    padding-left: $padding-large-horizontal;
+
+  }
+
+  .filterName, .filterSeparator
+  {
+    @extend .text-muted;
+  }
+}
+
+
+

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

@@ -0,0 +1,14 @@
+/* Warning! If you want to change these, just copy them into your own theme css. But you want to remove the !default, which only will set them if not already set. */
+
+$logo_image: 'blacklight/logo.png' !default;
+
+/* Various elements of search customization share these colors */
+
+$search_ui_border_color: #FFFFFF !default;
+$search_ui_bg_color: #FFFFFF !default;
+
+/* label (field names) */
+$field_name_color: $text-muted !default;
+
+/* border between items on marc view */
+$marc_item_separator: 1px solid $text-muted !default;

data/app/controllers/bookmarks_controller.rb

@@ -97,8 +97,4 @@ class BookmarksController < CatalogController
   def verify_user
     flash[:notice] = I18n.t('blacklight.bookmarks.need_login') and raise Blacklight::Exceptions::AccessDenied  unless current_or_guest_user
   end
-
-  def start_new_search_session?
-    action_name == "index"
-  end
 end

data/app/controllers/feedback_controller.rb

@@ -1,9 +1,6 @@
 # -*- encoding : utf-8 -*-
 class FeedbackController < ApplicationController
   
-  extend Deprecation
-  self.deprecation_horizon = 'Blacklight 5.x'
-
   # http://expressica.com/simple_captcha/
   # include SimpleCaptcha::ControllerHelpers
   
@@ -17,7 +14,6 @@ class FeedbackController < ApplicationController
       end
     end
   end
-  deprecation_deprecate :show
   
   protected
   

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -4,13 +4,8 @@
 # Methods added to this helper will be available to all templates in the hosting application
 #
 module Blacklight::BlacklightHelperBehavior
-
-  extend Deprecation
-  self.deprecation_horizon = 'Blacklight 5.x'
-
   include HashAsHiddenFieldsHelper
   include RenderConstraintsHelper
-  include HtmlHeadHelper
   include FacetsHelper
 
 
@@ -62,19 +57,6 @@ module Blacklight::BlacklightHelperBehavior
     extra_body_classes.join " "
   end
 
-  # collection of items to be rendered in the @sidebar
-  # @deprecated
-  def sidebar_items
-    @sidebar_items ||= []
-  end
-  deprecation_deprecate :sidebar_items
-
-  # collection of items to be rendered in the @topbar
-  def topbar_items
-    @topbar_items ||= []
-  end
-  deprecation_deprecate :topbar_items
-
   def render_search_bar
     render :partial=>'catalog/search_form'
   end
@@ -86,7 +68,6 @@ module Blacklight::BlacklightHelperBehavior
   def render_document_list_partial options={}
     render :partial=>'catalog/document_list'
   end
-  deprecation_deprecate :render_document_list_partial
 
   # Save function area for search results 'index' view, normally
   # renders next to title.
@@ -96,7 +77,7 @@ module Blacklight::BlacklightHelperBehavior
     content = []
     content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if render_bookmarks_control?
 
-    content_tag("div", content.join("\n").html_safe, :class=> wrapping_class)
+    content_tag("div", safe_join(content, "\n".html_safe), :class=> wrapping_class)
   end
 
   # Save function area for item detail 'show' view, normally
@@ -104,16 +85,12 @@ module Blacklight::BlacklightHelperBehavior
   def render_show_doc_actions(document=@document, options={})
     # I'm not sure why this key is documentFunctions and #render_index_doc_actions uses wrapping_class.
     # TODO: remove documentFunctions key in Blacklight 5.x
-    if options.has_key? :documentFunctions
-      Deprecation.warn(Blacklight::BlacklightHelperBehavior, "Calling #render_show_doc_actions with the :documentFunctions option is deprecated; use :wrapping_class instead")
-    end
-
     wrapping_class = options.delete(:documentFunctions) || options.delete(:wrapping_class) || "documentFunctions"
 
     content = []
     content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if render_bookmarks_control?
 
-    content_tag("div", content.join("\n").html_safe, :class=> wrapping_class)
+    content_tag("div", safe_join(content, "\n".html_safe), :class=> wrapping_class)
   end
 
   ##
@@ -127,26 +104,8 @@ module Blacklight::BlacklightHelperBehavior
       (document.has_highlight_field? solr_field.field if solr_field.highlight)
   end
 
-  ##
-  # Field keys for the index fields
-  # @deprecated
-  def index_field_names document=nil
-    Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#index_field_names helper is deprecated, and should be replaced by overriding the appropriate partial")
-    index_fields(document).keys
-  end
-
-  ##
-  # Labels for the index fields
-  # @deprecated
-  def index_field_labels document=nil
-    # XXX DEPRECATED
-    Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#index_field_labels helper is deprecated, and should be replaced by overriding the appropriate partial")
-  
-    Hash[*index_fields(document).map { |key, field| [key, field.label] }.flatten]
-  end
-
-  def should_show_spellcheck_suggestions? response
-    response.total <= spell_check_max and response.spelling.words.size > 0
+  def spell_check_max
+    blacklight_config.spell_max
   end
 
   ##
@@ -167,7 +126,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 index_fields(document)[field].label
   end
 
   ##
@@ -241,7 +200,6 @@ module Blacklight::BlacklightHelperBehavior
 
   # Used in citation view for displaying the title
   def citation_title(document)
-    Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#citation_title is deprecated; use #document_heading instead")
     document[blacklight_config.show.html_title]
   end
 
@@ -265,15 +223,6 @@ module Blacklight::BlacklightHelperBehavior
     blacklight_config.show_fields
   end
 
-  # used in the catalog/_show/_default partial
-  # @deprecated
-  def document_show_field_labels document=nil
-    # XXX DEPRECATED
-    Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#document_show_field_labels helper is deprecated, and should be replaced by overriding the appropriate partial")
-    
-    Hash[*document_show_fields(document).map { |key, field| [key, field.label] }.flatten]
-  end
-
   ##
   # Render the show field label for a document
   #
@@ -293,7 +242,7 @@ module Blacklight::BlacklightHelperBehavior
 
     field = options[:field]
 
-    html_escape t(:'blacklight.search.show.label', label: document_show_fields(document)[field].label)
+    html_escape document_show_fields(document)[field].label
   end
 
   ##
@@ -374,18 +323,14 @@ module Blacklight::BlacklightHelperBehavior
     ', '
   end
 
-  def document_index_view_type query_params=params
-    if blacklight_config.document_index_view_types.include? query_params[:view]
-      query_params[:view]
+  def document_index_view_type
+    if blacklight_config.document_index_view_types.include? params[:view]
+      params[:view]
     else
-      default_document_index_view_type
+      blacklight_config.document_index_view_types.first
     end
   end
 
-  def default_document_index_view_type
-    blacklight_config.document_index_view_types.first
-  end
-
   def render_document_index documents = nil, locals = {}
     documents ||= @document_list
     render_document_index_with_view(document_index_view_type, documents)
@@ -457,9 +402,14 @@ module Blacklight::BlacklightHelperBehavior
 
   # 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(raw(render_search_to_s(params)), catalog_index_path(params)).html_safe
   end
 
+  #
+  # shortcut for built-in Rails helper, "number_with_delimiter"
+  #
+  def format_num(num); number_with_delimiter(num) end
+
   #
   # link based helpers ->
   #
@@ -474,17 +424,6 @@ module Blacklight::BlacklightHelperBehavior
     link_to(query, link_url)
   end
 
-  ##
-  # Get the path to the search action with any parameters (e.g. view type)
-  # that should be persisted across search sessions.
-  def start_over_path query_params = params
-    h = { }
-    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)
-  end
-
   def render_document_index_label doc, opts
     label = nil
     label ||= doc.get(opts[:label], :sep => nil) if opts[:label].instance_of? Symbol
@@ -508,74 +447,34 @@ module Blacklight::BlacklightHelperBehavior
     { :'data-counter' => counter, :'data-search_id' => current_search_session.try(:id) }
   end
 
-  # link_back_to_catalog(:label=>'Back to Search')
   # Create a link back to the index screen, keeping the user's facet, query and paging choices intact by using session.
+  # @example
+  #   link_back_to_catalog(label: 'Back to Search')
+  #   link_back_to_catalog(label: 'Back to Search', route_set: my_engine)
   def link_back_to_catalog(opts={:label=>nil})
+    scope = opts.delete(:route_set) || self
     query_params = current_search_session.try(:query_params) || {}
-    link_url = url_for(query_params)
+    link_url = scope.url_for(query_params)
+    label = opts.delete(:label)
+
     if link_url =~ /bookmarks/
-      opts[:label] ||= t('blacklight.back_to_bookmarks')
+      label ||= t('blacklight.back_to_bookmarks')
     end
 
-    opts[:label] ||= t('blacklight.back_to_search')
-
-    link_to opts[:label], link_url
-  end
-
-  # @overload params_for_search(source_params, params_to_merge)
-  #   Merge the source params with the params_to_merge hash
-  #   @param [Hash] Hash 
-  #   @param [Hash] Hash to merge into above
-  # @overload params_for_search(params_to_merge)
-  #   Merge the current search parameters with the 
-  #      parameters provided. 
-  #   @param [Hash] Hash to merge into the parameters
-  # @overload params_for_search
-  #   Returns the current search parameters after being sanitized by #sanitize_search_params
-  # @overload legacy_method
-  #   @params [Hash] Hash of params to merge, may include:
-  #      - :omit_keys
-  #      - :params
-  # @yield [params] The merged parameters hash before being sanitized
-  def params_for_search(*args, &block)
-
-    omit_keys = []
-    
-    source_params, params_to_merge = case args.length
-    when 0
-      [params, {}]
-    when 1
-      options = args.first
-
-      if options.has_key? :omit_keys
-        Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#params_for_search with :omit_keys is deprecated; use params_for_search to generate the hash, and either provide a block or clean up the params after the fact")
-        omit_keys = options.delete(:omit_keys)
-      end
-
-      if options.has_key? :params
-        Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#params_for_search with :params option is deprecated; use the 2-arg form of #params_for_search(params, params_to_merge)")
-      end
+    label ||= t('blacklight.back_to_search')
 
-      [options.delete(:params) || params, options]
-    when 2
-      options = args.last
+    link_to label, link_url, opts
+  end
 
-      if options.has_key? :omit_keys
-        Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#params_for_search with :omit_keys is deprecated; use params_for_search to generate the hash, and either provide a block or clean up the params after the fact")
-        omit_keys = options.delete(:omit_keys)
-      end
-
-      [args.first, options]
-    else
-      raise ArgumentError.new "wrong number of arguments (#{args.length} for 0..2)"
-    end
+  def params_for_search(options={})
+    # special keys
+    # params hash to mutate
+    source_params = options.delete(:params) || params
+    omit_keys = options.delete(:omit_keys) || []
 
     # params hash we'll return
-    my_params = source_params.dup.merge(params_to_merge.dup)
+    my_params = source_params.dup.merge(options.dup)
 
-    if block_given?
-      yield my_params
-    end
 
     # remove items from our params hash that match:
     #   - a key
@@ -606,44 +505,39 @@ module Blacklight::BlacklightHelperBehavior
       my_params[:page] = 1
     end
 
-    sanitize_search_params(my_params)
-  end
-
-  ##
-  # Sanitize the search parameters by removing unnecessary parameters
-  # from the provided parameters
-  # @param [Hash] Hash of parameters
-  def sanitize_search_params source_params
-
-    my_params = source_params.reject { |k,v| v.nil? }
+    my_params.reject! { |k,v| v.nil? }
 
-    my_params.except(:action, :controller, :id, :commit, :utf8)
+    # removing action, controller, and id from duplicate params so that we don't get hidden fields for them.
+    my_params.delete(:action)
+    my_params.delete(:controller)
+    my_params.delete(:id)
+    # commit is just an artifact of submit button, we don't need it, and
+    # don't want it to pile up with another every time we press submit again!
+    my_params.delete(:commit)
 
+    my_params
   end
 
-
   # Create form input type=hidden fields representing the entire search context,
   # for inclusion in a form meant to change some aspect of it, like
   # re-sort or change records per page. Can pass in params hash
   # as :params => hash, otherwise defaults to #params. Can pass
   # in certain top-level params keys to _omit_, defaults to :page
   def search_as_hidden_fields(options={})
-    Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#search_as_hidden_fields is deprecated; use render_hash_as_hidden_fields(params_for_search(..)..) instead")
-    
     my_params = params_for_search({:omit_keys => [:page]}.merge(options))
 
     # hash_as_hidden_fields in hash_as_hidden_fields.rb
-    return render_hash_as_hidden_fields(my_params)
+    return hash_as_hidden_fields(my_params)
   end
 
   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')), 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
 
   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')), 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
@@ -699,8 +593,4 @@ module Blacklight::BlacklightHelperBehavior
     has_user_authentication_provider? and current_or_guest_user.present?
   end
 
-  def spell_check_max
-    blacklight_config.spell_max
-  end
-
 end