blacklight 5.0.0.pre3 → 5.0.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d8794852e683729a57437dab41c12a7f163e935
-  data.tar.gz: 0475c260c2845e478307195be84b6c967e426469
+  metadata.gz: bf405f02c6be2140ca50f003ba8f9b39f7a0db26
+  data.tar.gz: c8bf97338f9612b578826b97cea817a7c8e9f5ab
 SHA512:
-  metadata.gz: 31df124b777472aa9a7f1c04cf66dce546dc61f53d5f7cc6d8f5b7ebd62d122405aa886f504c778a73a9f3976efbb207ff5f840a6ac56acbeb87499c469ab737
-  data.tar.gz: 0d3674651658046314cceed8ccecc82084aa4144eb9198f78bf74f0e3044d97e46436ee921e837edb10845946c51736f6b845f0992a00673c5705122e3eaa78a
+  metadata.gz: 576d597de0b7541de63349e3f99e46a0c9a84fa9425108a0e33c91b91a7f00dac8693635430ffc11df7deb1990bc353536de33808baa9fc6cbd4d8eeeaf4dee1
+  data.tar.gz: 56a327ccf26e7d3eade183580e1d75d85e3aaf4d6840e98fa8eaa4839bd2659098ef3e04840cf6e80692bbf3cad480f2454429967f7e7e1e728883562555ae81

data/.gitignore

@@ -1,22 +1,15 @@
 .DS_Store
-.svn
-coverage.data
+*.sw[pon]
+.bundle
+.rvmrc
+*.log
+Gemfile.lock
 coverage/
-db/*.sqlite3
-db/schema.rb
-jetty
+gemfiles/*.gemfile.lock
+jetty/
 log/*
-webrat-*
-config/SolrMarc/*.log*
-rerun.txt
 solr_marc/solrmarc.log
 lib/solrmarc.log.*
 tmp/*
-*.log
-.bundle
-Gemfile.lock
-spec/internal
-.rvmrc
-pkg/*
-*.sw[pon]
-gemfiles/*.gemfile.lock
+spec/internal/
+pkg/*

data/Gemfile

@@ -3,6 +3,10 @@ source 'https://rubygems.org'
 # Please see blacklight.gemspec for dependency information.
 gemspec
 
+
+gem 'simplecov', require: false
+gem 'coveralls', require: false
+
 group :test do
   gem 'devise'
   gem 'devise-guests'

data/README.md

@@ -9,6 +9,20 @@ to search full text and/or metadata.  Blacklight has a highly
 configurable Ruby on Rails front-end. Blacklight was originally developed at
 the University of Virginia Library and is made public under an Apache 2.0 license. 
 
+## Installation
+
+Add Blacklight to your `Gemfile`:
+
+```ruby
+gem "blacklight"
+```
+
+Run the install generator which will copy over some initial templates, migrations, routes, and configuration:
+
+```
+rails generate blacklight:install
+```
+
 
 ## Documentation, Information and Support
 
@@ -16,7 +30,7 @@ the University of Virginia Library and is made public under an Apache 2.0 licens
 * [Developer Documentation](https://github.com/projectblacklight/blacklight/wiki)
 * [Quickstart Guide](https://github.com/projectblacklight/blacklight/wiki/Quickstart)
 * [Issue Tracker](https://github.com/projectblacklight/blacklight/issues)
-* [Support](http://projectblacklight.org/support.html)
+* [Support](https://github.com/projectblacklight/blacklight/wiki/Support)
 
 ## Dependencies
 

data/VERSION

@@ -1 +1 @@
-5.0.0.pre3
+5.0.0.pre4

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

@@ -4,5 +4,5 @@
 }
 
 .clear-bookmarks {
-  margin-left: 4px;
+  margin-left: $border-radius-base;
 }

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

@@ -24,7 +24,7 @@
   .ind1, .ind2
   {
     display:inline;
-    padding:0 5px;
+    padding:0 $padding-xs-horizontal;
   }
 
   .subfields
@@ -114,16 +114,6 @@ span.constraints-label {
   text-align: center ;
 }
 
-
-.solrQuery
-{
-	background-color: $search_ui_bg_color;
-	border:1px dotted $search_ui_border_color;
-	font-size:90%;
-	margin:2em;
-	padding:.5em;
-}
-
 .dl-horizontal
 {
   dd {
@@ -185,7 +175,7 @@ label.toggle_bookmark
 
 .document-thumbnail {
   float: right;
-  padding-left: 20px;
+  padding-left: $line-height-computed;
   margin-bottom: $line-height-computed;
 }
 

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

@@ -122,7 +122,7 @@ ul.facet_extended_list
   }
 
   #facets .top-panel-heading {
-    border: 1px solid #ccc;
+    border: 1px solid $breadcrumb-color;
     margin-bottom: 1em;
     @include border-bottom-radius($panel-border-radius - 1);
   }

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

@@ -5,6 +5,7 @@
 #header-navbar {
   .navbar-brand {  /* The main logo image for the Blacklight instance */
   	width: 150px;
+    height: 50px;
 	  background:transparent image_url($logo_image) no-repeat top left;
 	  display: inline-block;
 	  text-indent: 100%;

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

@@ -22,6 +22,8 @@
 }
 
 
-button.close {
+/* app/views/catalog/facet.html.erb may be rendered as a modal or a whole page.
+   When it's a whole page, don't show the close button. */
+button.ajax-modal-close.close {
 	display: none;
-}
+}

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

@@ -2,11 +2,6 @@
 
 $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;
 

data/app/controllers/bookmarks_controller.rb

@@ -97,4 +97,8 @@ 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/helpers/blacklight/blacklight_helper_behavior.rb

@@ -4,22 +4,17 @@
 # Methods added to this helper will be available to all templates in the hosting application
 #
 module Blacklight::BlacklightHelperBehavior
+  include BlacklightUrlHelper
   include HashAsHiddenFieldsHelper
   include RenderConstraintsHelper
   include FacetsHelper
 
-
   def application_name
     return Rails.application.config.application_name if Rails.application.config.respond_to? :application_name
 
     t('blacklight.application_name')
   end
 
-  # Provide the full, absolute url for an image
-  def asset_url(*args)
-    "#{request.protocol}#{request.host_with_port}#{asset_path(*args)}"
-  end
-
   # Create <link rel="alternate"> links from a documents dynamically
   # provided export formats. Currently not used by standard BL layouts,
   # but available for your custom layouts to provide link rel alternates.
@@ -105,8 +100,8 @@ module Blacklight::BlacklightHelperBehavior
       solr_field.accessor
   end
 
-  def spell_check_max
-    blacklight_config.spell_max
+  def should_show_spellcheck_suggestions? response
+    response.total <= spell_check_max and response.spelling.words.size > 0
   end
 
   ##
@@ -127,7 +122,7 @@ module Blacklight::BlacklightHelperBehavior
     document = args.first
 
     field = options[:field]
-    html_escape index_fields(document)[field].label
+    html_escape t(:'blacklight.search.index.label', label: index_fields(document)[field].label)
   end
 
   ##
@@ -168,7 +163,18 @@ module Blacklight::BlacklightHelperBehavior
   # Used in the show view for displaying the main solr document heading
   def document_heading document=nil
     document ||= @document
-    document[blacklight_config.show.heading] || document.id
+    render_field_value document[blacklight_config.view_config(:show).title_field] || document.id
+  end
+
+  # Used in the show view for setting the main html document title
+  def document_show_html_title document=nil
+    document ||= @document
+
+    if blacklight_config.view_config(:show).html_title_field
+      render_field_value(document[blacklight_config.view_config(:show).html_title_field])
+    else
+      document_heading document
+    end
   end
 
   ##
@@ -193,17 +199,6 @@ module Blacklight::BlacklightHelperBehavior
     content_tag(tag, render_field_value(document_heading(document)), :itemprop => "name")
   end
 
-  # Used in the show view for setting the main html document title
-  def document_show_html_title document=nil
-    document ||= @document
-    render_field_value(document[blacklight_config.show.html_title])
-  end
-
-  # Used in citation view for displaying the title
-  def citation_title(document)
-    document[blacklight_config.show.html_title]
-  end
-
   # Used in the document_list partial (search view) for building a select element
   def sort_fields
     blacklight_config.sort_fields.map { |key, x| [x.label, x.key] }
@@ -211,7 +206,7 @@ module Blacklight::BlacklightHelperBehavior
 
   # Used in the document list partial (search view) for creating a link to the document show action
   def document_show_link_field document=nil
-    blacklight_config.index.show_link.to_sym
+    blacklight_config.view_config(document_index_view_type).title_field.to_sym
   end
 
   # Used in the search form partial for building a select tag
@@ -243,7 +238,7 @@ module Blacklight::BlacklightHelperBehavior
 
     field = options[:field]
 
-    html_escape document_show_fields(document)[field].label
+    html_escape t(:'blacklight.search.show.label', label: document_show_fields(document)[field].label)
   end
 
   ##
@@ -356,15 +351,15 @@ 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]
+    if query_params[:view] and blacklight_config.view.keys.include? query_params[:view].to_sym
+      query_params[:view].to_sym
     else
       default_document_index_view_type
     end
   end
 
   def default_document_index_view_type
-    blacklight_config.document_index_view_types.first
+    blacklight_config.view.keys.first
   end
 
   def render_document_index documents = nil, locals = {}
@@ -399,7 +394,7 @@ module Blacklight::BlacklightHelperBehavior
     # .to_s is necessary otherwise the default return value is not always a string
     # using "_" as sep. to more closely follow the views file naming conventions
     # parameterize uses "-" as the default sep. which throws errors
-    display_type = document[blacklight_config.show.display_type]
+    display_type = document[blacklight_config.view_config(:show).display_type_field]
 
     return 'default' unless display_type
     display_type = display_type.join(" ") if display_type.respond_to?(:join)
@@ -442,35 +437,6 @@ module Blacklight::BlacklightHelperBehavior
   end
 
 
-  # Search History and Saved Searches display
-  def link_to_previous_search(params)
-    link_to(raw(render_search_to_s(params)), catalog_index_path(params)).html_safe
-  end
-
-  #
-  # link based helpers ->
-  #
-
-  # create link to query (e.g. spelling suggestion)
-  def link_to_query(query)
-    p = params.dup
-    p.delete :page
-    p.delete :action
-    p[:q]=query
-    link_url = catalog_index_path(p)
-    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
@@ -481,115 +447,6 @@ module Blacklight::BlacklightHelperBehavior
     render_field_value label
   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,
-  # so we only need the +counter+ param here. We also need to know if we are viewing to document as part of search results.
-  def link_to_document(doc, opts={:label=>nil, :counter => nil})
-    opts[:label] ||= blacklight_config.index.show_link.to_sym
-    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  })
-  end
-
-  def search_session_params counter
-    { :'data-counter' => counter, :'data-search_id' => current_search_session.try(:id) }
-  end
-
-  # 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 = scope.url_for(query_params)
-    label = opts.delete(:label)
-
-    if link_url =~ /bookmarks/
-      label ||= t('blacklight.back_to_bookmarks')
-    end
-
-    label ||= t('blacklight.back_to_search')
-
-    link_to label, link_url, opts
-  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(options.dup)
-
-
-    # remove items from our params hash that match:
-    #   - a key
-    #   - a key and a value
-    omit_keys.each do |omit_key|
-      case omit_key
-        when Hash
-          omit_key.each do |key, values|
-            next unless my_params.has_key? key
-
-            # make sure to dup the source key, we don't want to accidentally alter the original
-            my_params[key] = my_params[key].dup
-
-            values = [values] unless values.respond_to? :each
-            values.each { |v| my_params[key].delete(v) }
-
-            if my_params[key].empty?
-              my_params.delete(key)
-            end
-          end
-
-        else
-          my_params.delete(omit_key)
-      end
-    end
-
-    if my_params[:page] and (my_params[:per_page] != source_params[:per_page] or my_params[:sort] != source_params[:sort] )
-      my_params[:page] = 1
-    end
-
-    my_params.reject! { |k,v| v.nil? }
-
-    # 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={})
-    my_params = params_for_search({:omit_keys => [:page]}.merge(options))
-
-    # hash_as_hidden_fields in hash_as_hidden_fields.rb
-    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
-      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
-      content_tag :span, raw(t('views.pagination.next')), :class => 'next'
-    end
-  end
-
   # Use case, you want to render an html partial from an XML (say, atom)
   # template. Rails API kind of lets us down, we need to hack Rails internals
   # a bit. code taken from:
@@ -602,28 +459,6 @@ module Blacklight::BlacklightHelperBehavior
     nil
   end
 
-  # puts together a collection of documents into one refworks export string
-  def render_refworks_texts(documents)
-    val = ''
-    documents.each do |doc|
-      if doc.respond_to?(:to_marc)
-        val += doc.export_as_refworks_marc_txt + "\n"
-      end
-    end
-    val
-  end
-
-  # puts together a collection of documents into one endnote export string
-  def render_endnote_texts(documents)
-    val = ''
-    documents.each do |doc|
-      if doc.respond_to?(:to_marc)
-        val += doc.export_as_endnote + "\n"
-      end
-    end
-    val
-  end
-
   ##
   # Should we render a grouped response (because the response 
   # contains a grouped response instead of the normal response) 
@@ -641,4 +476,8 @@ module Blacklight::BlacklightHelperBehavior
     has_user_authentication_provider? and current_or_guest_user.present?
   end
 
+  def spell_check_max
+    blacklight_config.spell_max
+  end
+
 end