blacklight 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: fd53955e7766d24bb6321e2f1c8276115ef7489f
-  data.tar.gz: 648c5e33395aa063a7b827e6c1418c12ab84aeae
-!binary "U0hBNTEy":
-  metadata.gz: e73973c3a91c7dfbd0dabea81280af47be472a0c12a89dc37b3060db482d7325c3d564cd510ea006282dc1303838131e1c2bf1106f0a4b52fa983a0c1a660e27
-  data.tar.gz: 63b8d103ae752c8cb697eb7c831501bb1b535fccdb2df53bb49c77546dd6e2f756bd904fb54eedfa65fef735ba9e9a9ec205a887ada8090149f8826f022d3fef
+SHA1:
+  metadata.gz: 85237ab5ca9df6a7dceedb02ee41c653bea8f99b
+  data.tar.gz: d8e94fa7a2eb458e6e072f5b9178a59874d28672
+SHA512:
+  metadata.gz: cd6f5b56a806020627da8539450d8b9e259960d8f6e74e1cfbc2b2be140868705c69f57edb245bcf3fa971aadef6ad3020c67b4c87d47c2a7d4a9d661767a01d
+  data.tar.gz: 3e1b35b3aa99e852e2d43c93135937d0ed4392b7356a08368768f0c2951cd756d0881147aa86e448957322ec2b3d44d5f3227fc4c40afb19eaf999257bed605e

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+H���&�]���]��g��D%��D7���y>�w�*j�燸�t��)+Yz	�^���<c��Ҩzv}�u�	�ς��/B�`�m��9�����VZ��@�@�����sF�-^��
+g籘𺍯�a

data/.gitignore

@@ -19,3 +19,4 @@ tmp/test_app
 .rvmrc
 pkg/*
 *.sw[pon]
+gemfiles/*.gemfile.lock

data/.travis.yml

@@ -1,14 +1,22 @@
 notifications:
   email: false
-  
+
 rvm:
-  # - 1.8.7
   - 1.9.3
-  # - rbx-2.0
-  # - jruby
+  - jruby-19mode
+  - 2.0.0
 
-env:
-  - RAILS_VERISON=3.2.8
+gemfile:
+  - gemfiles/rails3.gemfile
+  - gemfiles/rails4.gemfile
 
 script:
   - test_support/bin/test.sh
+
+notifications:
+  irc: "irc.freenode.org#blacklight"
+  email:
+      - blacklight-commits@googlegroups.com
+
+before_install:
+  - gem install bundler

data/Gemfile

@@ -3,7 +3,6 @@ source 'http://rubygems.org'
 # Please see blacklight.gemspec for dependency information.
 gemspec
 
-gem 'rcov', :platform => :mri_18
-gem 'simplecov', :platform => :mri_19
-gem 'simplecov-rcov', :platform => :mri_19
+gem 'simplecov', :platform => :mri
+gem 'simplecov-rcov', :platform => :mri
 

data/README.md

@@ -1,5 +1,7 @@
 # Blacklight
 
+[![Build Status](https://travis-ci.org/projectblacklight/blacklight.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight)
+
 Blacklight is an open source Solr user interface discovery platform.
 You can use Blacklight to enable searching and browsing of your collections.
 Blacklight uses the [Apache Solr](http://lucene.apache.org/solr) search engine
@@ -13,7 +15,7 @@ the University of Virginia Library and is made public under an Apache 2.0 licens
 * [Project Homepage](http://projectblacklight.org)
 * [Developer Documentation](https://github.com/projectblacklight/blacklight/wiki)
 * [Quickstart Guide](https://github.com/projectblacklight/blacklight/wiki/Quickstart)
-* [JIRA Issue Tracker](http://jira.projectblacklight.org/jira/secure/Dashboard.jspa)
+* [Issue Tracker](https://github.com/projectblacklight/blacklight/issues)
 * [Support](http://projectblacklight.org/support.html)
 
 ## Dependencies

data/VERSION

@@ -1 +1 @@
-4.0.1
+4.1.0

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

@@ -1,3 +1,4 @@
+@charset "UTF-8";
 
 /* This file is generated by Blacklight. You probably don't want to edit
    this file directly, or you'll have to manually merge your changes if later

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

@@ -25,6 +25,7 @@
 	ul {
 		list-style: none;
 		position: absolute;
+    z-index: $zindexDropdown;
 		top: 100%;
 		left: 0;
 		right: 0;
@@ -53,4 +54,4 @@
 		  }
 		}
 	}
-}
+}

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

@@ -32,7 +32,7 @@
     vertical-align: top; 
   }
 
-  .filterName, .label 
+  .filterName, .filterSeparator
   {
     color: gray; 
   }

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

@@ -1,3 +1,5 @@
+@charset "UTF-8";
+
 /* This is the default blacklight theme. */
 
 @import 'blacklight/blacklight_base';

data/app/assets/stylesheets/improved-modal/bootstrap-modal.css

@@ -1,3 +1,5 @@
+@charset "UTF-8";
+
 /*!
  * Bootstrap Modal
  *

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -105,8 +105,9 @@ module Blacklight::BlacklightHelperBehavior
     content_tag("div", content.join("\n").html_safe, :class=>"documentFunctions")
   end
 
-  # used in the catalog/_index_partials/_default view
-  def index_fields
+  ##
+  # Index fields to display for a type of document
+  def index_fields document=nil
     blacklight_config.index_fields
   end
 
@@ -115,50 +116,125 @@ module Blacklight::BlacklightHelperBehavior
       (document.has_highlight_field? solr_field.field if solr_field.highlight)
   end
 
-  def index_field_names
-    index_fields.keys
+  ##
+  # Field keys for the index fields
+  # @deprecated
+  def index_field_names document=nil
+    index_fields(document).keys
   end
 
-  # used in the catalog/_index_partials/_default partial
-  def index_field_labels
+  ##
+  # Labels for the index fields
+  # @deprecated
+  def index_field_labels document=nil
     # XXX DEPRECATED
-    Hash[*index_fields.map { |key, field| [key, field.label] }.flatten]
+    Hash[*index_fields(document).map { |key, field| [key, field.label] }.flatten]
   end
 
   def spell_check_max
     blacklight_config.spell_max
   end
 
-  def render_index_field_label args
-    field = args[:field]
-    html_escape index_fields[field].label
-  end
-
-  def render_index_field_value args
-    value = args[:value]
-
-    if args[:field] and blacklight_config.index_fields[args[:field]]
-      field_config = blacklight_config.index_fields[args[:field]]
-      value ||= send(blacklight_config.index_fields[args[:field]][:helper_method], args) if field_config.helper_method
-      value ||= args[:document].highlight_field(args[:field]) if field_config.highlight
+  ##
+  # Render the index field label for a document
+  #
+  # @overload render_index_field_label(options)
+  #   Use the default, document-agnostic configuration
+  #   @param [Hash] opts
+  #   @options opts [String] :field
+  # @overload render_index_field_label(document, options)
+  #   Allow an extention point where information in the document
+  #   may drive the value of the field
+  #   @param [SolrDocument] doc
+  #   @param [Hash] opts
+  #   @options opts [String] :field    
+  def render_index_field_label *args
+    options = args.extract_options!
+    document = args.first
+
+    field = options[:field]
+    html_escape index_fields(document)[field].label
+  end
+
+  ##
+  # Render the index field label for a document
+  #
+  # @overload render_index_field_value(options)
+  #   Use the default, document-agnostic configuration
+  #   @param [Hash] opts
+  #   @options opts [String] :field
+  #   @options opts [String] :value
+  #   @options opts [String] :document
+  # @overload render_index_field_value(document, options)
+  #   Allow an extention point where information in the document
+  #   may drive the value of the field
+  #   @param [SolrDocument] doc
+  #   @param [Hash] opts
+  #   @options opts [String] :field 
+  #   @options opts [String] :value
+  # @overload render_index_field_value(document, field, options)
+  #   Allow an extention point where information in the document
+  #   may drive the value of the field
+  #   @param [SolrDocument] doc
+  #   @param [String] field
+  #   @param [Hash] opts
+  #   @options opts [String] :value
+  def render_index_field_value *args
+    options = args.extract_options!
+    document = args.shift || options[:document]
+
+    field = args.shift || options[:field]
+    value = options[:value]
+
+
+    field_config = index_fields(document)[field]
+
+    value ||= case 
+      when value
+        value
+      when (field_config and field_config.helper_method)
+        send(field_config.helper_method, options.merge(:document => document, :field => field))
+      when (field_config and field_config.highlight)
+        document.highlight_field(field_config.field).map { |x| x.html_safe }
+      else
+        document.get(field, :sep => nil) if field
     end
 
-    value ||= args[:document].get(args[:field], :sep => nil) if args[:document] and args[:field]
     render_field_value value
   end
 
   # Used in the show view for displaying the main solr document heading
-  def document_heading
-    @document[blacklight_config.show.heading] || @document.id
-  end
+  def document_heading document=nil
+    document ||= @document
+    document[blacklight_config.show.heading] || document.id
+  end
+
+  ##
+  # Render the document "heading" (title) in a content tag
+  # @overload render_document_heading(tag)
+  # @overload render_document_heading(document, options)
+  #   @params [SolrDocument] document
+  #   @params [Hash] options
+  #   @options options [Symbol] :tag
+  def render_document_heading(*args)
+    options = args.extract_options!
+    if args.first.is_a? SolrDocument
+      document = args.shift
+      tag = options[:tag]
+    else
+      document = nil
+      tag = args.first || options[:tag]
+    end
+
+    tag ||= :h4
 
-  def render_document_heading(tag = :h4)
-    content_tag(tag, render_field_value(document_heading))
+    content_tag(tag, render_field_value(document_heading(document)))
   end
 
   # Used in the show view for setting the main html document title
-  def document_show_html_title
-    render_field_value(@document[blacklight_config.show.html_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
@@ -172,7 +248,7 @@ module Blacklight::BlacklightHelperBehavior
   end
 
   # Used in the document list partial (search view) for creating a link to the document show action
-  def document_show_link_field
+  def document_show_link_field document=nil
     blacklight_config.index.show_link.to_sym
   end
 
@@ -182,31 +258,84 @@ module Blacklight::BlacklightHelperBehavior
   end
 
   # used in the catalog/_show/_default partial
-  def document_show_fields
+  def document_show_fields document=nil
     blacklight_config.show_fields
   end
 
   # used in the catalog/_show/_default partial
-  def document_show_field_labels
+  # @deprecated
+  def document_show_field_labels document=nil
     # XXX DEPRECATED
-    Hash[*blacklight_config.show_fields.map { |key, field| [key, field.label] }.flatten]
-  end
-
-  def render_document_show_field_label args
-    field = args[:field]
-    html_escape blacklight_config.show_fields[field].label
+    Hash[*document_show_fields(document).map { |key, field| [key, field.label] }.flatten]
   end
 
-  def render_document_show_field_value args
-    value = args[:value]
-
-    if args[:field] and blacklight_config.show_fields[args[:field]]
-      field_config = blacklight_config.show_fields[args[:field]]
-      value ||= send(blacklight_config.show_fields[args[:field]][:helper_method], args) if field_config.helper_method
-      value ||= args[:document].highlight_field(args[:field]).map { |x| x.html_safe } if field_config.highlight
+  ##
+  # Render the show field label for a document
+  #
+  # @overload render_document_show_field_label(options)
+  #   Use the default, document-agnostic configuration
+  #   @param [Hash] opts
+  #   @options opts [String] :field
+  # @overload render_document_show_field_label(document, options)
+  #   Allow an extention point where information in the document
+  #   may drive the value of the field
+  #   @param [SolrDocument] doc
+  #   @param [Hash] opts
+  #   @options opts [String] :field   
+  def render_document_show_field_label *args
+    options = args.extract_options!
+    document = args.first
+
+    field = options[:field]
+
+    html_escape document_show_fields(document)[field].label
+  end
+
+  ##
+  # Render the index field label for a document
+  #
+  # @overload render_document_show_field_value(options)
+  #   Use the default, document-agnostic configuration
+  #   @param [Hash] opts
+  #   @options opts [String] :field
+  #   @options opts [String] :value
+  #   @options opts [String] :document
+  # @overload render_document_show_field_value(document, options)
+  #   Allow an extention point where information in the document
+  #   may drive the value of the field
+  #   @param [SolrDocument] doc
+  #   @param [Hash] opts
+  #   @options opts [String] :field 
+  #   @options opts [String] :value
+  # @overload render_document_show_field_value(document, field, options)
+  #   Allow an extention point where information in the document
+  #   may drive the value of the field
+  #   @param [SolrDocument] doc
+  #   @param [String] field
+  #   @param [Hash] opts
+  #   @options opts [String] :value
+  def render_document_show_field_value *args
+
+    options = args.extract_options!
+    document = args.shift || options[:document]
+
+    field = args.shift || options[:field]
+    value = options[:value]
+
+
+    field_config = document_show_fields(document)[field]
+
+    value ||= case 
+      when value
+        value
+      when (field_config and field_config.helper_method)
+        send(field_config.helper_method, options.merge(:document => document, :field => field))
+      when (field_config and field_config.highlight)
+        document.highlight_field(field_config.field).map { |x| x.html_safe }
+      else
+        document.get(field, :sep => nil) if field
     end
 
-    value ||= args[:document].get(args[:field], :sep => nil) if args[:document] and args[:field]
     render_field_value value
   end
 
@@ -359,24 +488,46 @@ module Blacklight::BlacklightHelperBehavior
   end
 
   def params_for_search(options={})
-    my_params = (options[:params] || params).dup
-    options[:omit_keys] ||= []
+    # special keys
+    # params hash to mutate
+    source_params = options.delete(:params) || params
+    omit_keys = options.delete(:omit_keys) || []
 
-    options[:omit_keys].each do |omit_key|
+    # 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[key]
+            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 and controller from duplicate params so that we don't get hidden fields for them.
     my_params.delete(:action)
     my_params.delete(:controller)