blacklight 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4fe52e90e46cbe15dd254d6a09d75d0e9e652cb
-  data.tar.gz: 93664d12f7ab1ad41476a4c7dcedc16cc5d1ef04
+  metadata.gz: b1463e41c998a83ef595ee4dafe4a390d5cd90be
+  data.tar.gz: a9b62fea9a0454a432ac5ecd95e8f8952438da5d
 SHA512:
-  metadata.gz: e508d1e83f7f38a6527e7ed21e31ed36546e1c2e66c974b47c02cdde164391fde2c848d6166ce75681e2c106090efebde185521f0abb4a16726ef82592bd8ad7
-  data.tar.gz: a377322e06b7ddf13ce83865d580c4add9df4353abbe9d9b023a8f0149fa2e5bc8a49ad7c994c78ec66b3193b0b2df687ac407e61b3a0ece97cbb7a3a79f73f5
+  metadata.gz: 57b6f5e61c7ed3faf05c151ff3915fe48fedac1be2edb2b9f0deae5879265118e8d1f7b961541915a54b41ac2098cea36fb1d4c5d77eaf125360c60a17721b5b
+  data.tar.gz: 54d4dc8f7f4fe286dd0ec6faae2c73e95e1e7fb644f6418d3cf6b52de96cd7cacc84c5baa5e6ce65472f507c4548d83f38a3d884134bf5e0047fda2f69be42dd

data/.gitignore

@@ -10,6 +10,7 @@ webrat-*
 config/SolrMarc/*.log*
 rerun.txt
 solr_marc/solrmarc.log
+lib/solrmarc.log.*
 tmp/*
 *.log
 .bundle

data/.travis.yml

@@ -16,9 +16,3 @@ notifications:
       - blacklight-commits@googlegroups.com
 
 env: JRUBY_OPTS="-J-Xms512m -J-Xmx1024m"        
-# jruby + rails 4.0.0 don't work well together
-# jruby and rails 3.2.14 don't work well together either: 
-# https://github.com/rails/rails/issues/11595
-matrix:
-  allow_failures:
-    - rvm: jruby-19mode

data/Gemfile

@@ -8,7 +8,12 @@ gem 'simplecov-rcov', :platform => :mri
 
 group :test do
   gem 'devise'
+  gem 'devise-guests'
+  gem "bootstrap-sass"
+  gem 'turbolinks'
+  gem "unicode", :platforms => [:mri_18, :mri_19]
 end
+
 if File.exists?('spec/test_app_templates/Gemfile.extra')
   eval File.read('spec/test_app_templates/Gemfile.extra'), nil, 'spec/test_app_templates/Gemfile.extra'
 end

data/README.md

@@ -1,6 +1,6 @@
 # Blacklight
 
-[![Build Status](https://travis-ci.org/projectblacklight/blacklight.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight)
+[![Build Status](https://travis-ci.org/projectblacklight/blacklight.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight)
 
 Blacklight is an open source Solr user interface discovery platform.
 You can use Blacklight to enable searching and browsing of your collections.

data/Rakefile

@@ -6,7 +6,6 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rake'
 Bundler::GemHelper.install_tasks
 
 # load rake tasks defined in lib/tasks that are not loaded in lib/active_fedora.rb

data/VERSION

@@ -1 +1 @@
-4.3.0
+4.4.0

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

@@ -0,0 +1,16 @@
+//= require blacklight/core
+(function($) {
+  Blacklight.do_search_autofocus_fallback = function() {
+    if (typeof Modernizer != "undefined") {
+      if (Modernizr.autofocus) {
+        return;
+      }
+    }
+
+    $('input[autofocus]').focus();
+  }
+
+  Blacklight.onLoad(function() {
+    Blacklight.do_search_autofocus_fallback();
+  });
+})(jQuery);

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

@@ -5,6 +5,7 @@
 //
 // These javascript files are compiled in via the Rails asset pipeline:
 //= require blacklight/core
+//= require blacklight/autofocus
 //= require blacklight/bookmark_toggle
 //= require blacklight/facet_expand_contract
 //= require blacklight/lightbox_dialog

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

@@ -3,17 +3,14 @@
 (function($) {
 //change form submit toggle to checkbox
     Blacklight.do_bookmark_toggle_behavior = function() {
-      $(Blacklight.do_bookmark_toggle_behavior.selector).bl_checkbox_submit({          
-          checked_label: "In Bookmarks",
-          unchecked_label: "Bookmark",
-          progress_label: "Saving...",
+      $(Blacklight.do_bookmark_toggle_behavior.selector).bl_checkbox_submit({
           //css_class is added to elements added, plus used for id base
           css_class: "toggle_bookmark"    
       }); 
     };
     Blacklight.do_bookmark_toggle_behavior.selector = "form.bookmark_toggle"; 
 
-$(document).ready(function() {
+Blacklight.onLoad(function() {
   Blacklight.do_bookmark_toggle_behavior();  
 });
   

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

@@ -70,10 +70,10 @@
                //Set the Rails hidden field that fakes an HTTP verb
                //properly for current state action. 
                form.find("input[name=_method]").val("delete");
-               span.text(options.checked_label);
+               span.text(form.attr('data-present'));
             } else {
                form.find("input[name=_method]").val("put");
-               span.text(options.unchecked_label);
+               span.text(form.attr('data-absent'));
             }
           }
         
@@ -81,7 +81,7 @@
         update_state_for(checked);
         
         checkbox.click(function() {
-            span.text(options.progress_label);
+            span.text(form.attr('data-inprogress'));
             label.attr("disabled", "disabled");  
             checkbox.attr("disabled", "disabled");
                             
@@ -123,9 +123,6 @@
     };
 	
   $.fn.bl_checkbox_submit.defaults =  {
-            checked_label: "",
-            unchecked_label: "",
-            progress_label: "Saving...",
             //css_class is added to elements added, plus used for id base
             css_class: "bl_checkbox_submit",
             success: function() {} //callback

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

@@ -1 +1,24 @@
-Blacklight = {};
+Blacklight = function() {
+  var buffer = new Array;
+  return {
+    onLoad: function(func) {
+      buffer.push(func);
+    },
+
+    activate: function() {
+      for(var i = 0; i < buffer.length; i++) {
+        buffer[i].call();
+      }
+    }
+  }
+}();
+
+if (typeof Turbolinks !== "undefined") {
+  $(document).on('page:load', function() {
+    Blacklight.activate();  
+  });
+}
+$(document).ready(function() {
+  Blacklight.activate();  
+});
+

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

@@ -4,7 +4,7 @@
 			$(this).toggleClass("hovering");
 		});
 	};
-	$(document).ready(function() {
+  Blacklight.onLoad(function() {
 	  Blacklight.add_css_dropdown_click_support();
 	});
-})(jQuery);
+})(jQuery);

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

@@ -33,8 +33,9 @@ Blacklight.do_facet_expand_contract_behavior = function() {
            });
        });
    };
-$(document).ready(function() {
-  Blacklight.do_facet_expand_contract_behavior();  
-});
+
+  Blacklight.onLoad(function() {
+    Blacklight.do_facet_expand_contract_behavior();  
+  });
 })(jQuery);
 

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

@@ -1,5 +1,11 @@
 //= require blacklight/core
 Blacklight.setup_modal = function(link_selector, form_selector, launch_modal) {
+
+	// Event indicating blacklight is setting up a modal link
+	var e = $.Event('lightbox.setup_modal');
+	$(link_selector).trigger(e);
+	if (e.isDefaultPrevented()) return;
+
     $(link_selector).click(function(e) {
       link = $(this)
       
@@ -59,6 +65,6 @@ Blacklight.check_close_ajax_modal = function() {
 
 }
 
-$(document).ready( function() {
+Blacklight.onLoad(function() {
   Blacklight.setup_modal("a.lightboxLink,a.more_facets_link,.ajax_modal_launch", "#ajax-modal form.ajax_form", true);
 });

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

@@ -20,7 +20,7 @@
       });
 
     };  
-$(document).ready(function() {
+Blacklight.onLoad(function() {
   Blacklight.do_search_context_behavior();  
 });
 })(jQuery);

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

@@ -11,7 +11,7 @@
 
     }
 
-$(document).ready(function() {
+Blacklight.onLoad(function() {
   $('#sort-form').hide();
   $('#sort-dropdown').show();
   Blacklight.update_css_dropdown('#sort-dropdown', "Sort by ", "")

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

@@ -7,7 +7,7 @@
     Blacklight.do_zebra_stripe.selector = "table.zebra tr:even, ul.zebra li:even"; 
     
  
-$(document).ready(function() {
+Blacklight.onLoad(function() {
   Blacklight.do_zebra_stripe();  
 });
     })(jQuery);

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

@@ -17,6 +17,7 @@ $btnInfoBackground: #9ad0fe;
 @import "blacklight/header";
 @import "blacklight/footer";
 @import "blacklight/catalog";
+@import "blacklight/group";
 @import "blacklight/bookmark";
 @import "blacklight/facets";
 @import "blacklight/search_history";

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

@@ -248,3 +248,8 @@ span.page a,span.page.current
 #email_form {
   @extend .span6;
 }
+
+.document-thumbnail {
+  float: right;
+  padding-left: 20px;
+}

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

@@ -3,6 +3,12 @@
   div.facet_limit {
     clear: both;
   }
+
+  h5 a {
+    color: inherit;
+    text-decoration: none;
+  }
+
   ul {
     padding-top:0.5em;
     margin-left: 14px;

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

@@ -0,0 +1,14 @@
+.group-key {
+  border-bottom: 1px solid $dark_border_color;
+  clear: right;
+}
+
+.grouped-documents {
+  .document {
+    border-bottom: 0;
+  }
+}
+
+.more-in-group {
+  float: right;
+}

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

@@ -19,6 +19,7 @@ $main_container_bg_color: #FFFFFF !default;
 
 /* separates documents, facets */
 $dotted_border_color: #CCC !default;
+$dark_border_color: #333 !default;
 
 /* background color of page */
 $page_bg_color: #2E4F81 !default;

data/app/controllers/bookmarks_controller.rb

@@ -12,8 +12,8 @@ class BookmarksController < CatalogController
  
   # Blacklight uses #search_action_url to figure out the right URL for
   # the global search box
-  def search_action_url
-    catalog_index_url
+  def search_action_url *args
+    catalog_index_url *args
   end
   helper_method :search_action_url
 

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -74,8 +74,8 @@ module Blacklight::BlacklightHelperBehavior
     render :partial=>'catalog/search_form'
   end
 
-  def search_action_url
-    catalog_index_url
+  def search_action_url *args
+    catalog_index_url *args
   end
 
   def extra_body_classes
@@ -186,21 +186,9 @@ module Blacklight::BlacklightHelperBehavior
     document = args.shift || options[:document]
 
     field = args.shift || options[:field]
-    value = options[:value]
-
-
     field_config = index_fields(document)[field]
+    value = options[:value] || get_field_values(document, field, field_config, options)
 
-    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 } if document.has_highlight_field? field_config.field
-      else
-        document.get(field, :sep => nil) if field
-    end
 
     render_field_value value
   end
@@ -322,23 +310,39 @@ module Blacklight::BlacklightHelperBehavior
     document = args.shift || options[:document]
 
     field = args.shift || options[:field]
-    value = options[:value]
-
-
     field_config = document_show_fields(document)[field]
+    value = options[:value] || get_field_values(document, field, field_config, options)
+
+    render_field_value value
+  end
 
-    value ||= case 
-      when value
-        value
+  ##
+  # Get the value of a document's field after applying any value lookups, e.g.:
+  #   - helper_method
+  #   - link_to_search
+  #   - highlight
+  # TODO : maybe this should be merged with render_field_value, and the ugly signature 
+  # simplified by pushing some of this logic into the "model"
+  def get_field_values document, field, field_config, options = {}
+
+    case
       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.link_to_search)
+        link_field = if field_config.link_to_search === true
+          field_config.field
+        else
+          field_config.link_to_search
+        end
+
+        Array(document.get(field, :sep => nil)).map do |v|
+          link_to render_field_value(v), search_action_url(add_facet_params(link_field, v, {}))
+        end if field
       when (field_config and field_config.highlight)
         document.highlight_field(field_config.field).map { |x| x.html_safe } if document.has_highlight_field? field_config.field
       else
         document.get(field, :sep => nil) if field
     end
-
-    render_field_value value
   end
 
   def should_render_show_field? document, solr_field
@@ -533,9 +537,10 @@ module Blacklight::BlacklightHelperBehavior
 
     my_params.reject! { |k,v| v.nil? }
 
-    # removing action and controller from duplicate params so that we don't get hidden fields for them.
+    # 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)
@@ -603,5 +608,17 @@ module Blacklight::BlacklightHelperBehavior
     val
   end
 
+  ##
+  # Should we render a grouped response (because the response 
+  # contains a grouped response instead of the normal response) 
+  def render_grouped_response?
+    return @response.grouped?
+  end
+
+  ##
+  # Render the grouped response
+  def render_grouped_document_index grouped_key = nil
+    render :partial => 'catalog/group_default'
+  end
 
 end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -5,28 +5,7 @@ module Blacklight::CatalogHelperBehavior
   # it translates to a Kaminari-paginatable
   # object, with the keys Kaminari views expect.
   def paginate_params(response)
-
-    per_page = response.rows
-    per_page = 1 if per_page < 1
-
-    current_page = (response.start / per_page).ceil + 1
-    num_pages = (response.total / per_page.to_f).ceil
-
-    total_count = response.total
-
-    start_num = response.start + 1
-    end_num = start_num + response.docs.length - 1
-
-    OpenStruct.new(:start => start_num,
-                   :end => end_num,
-                   :per_page => per_page,
-                   :current_page => current_page,
-                   :num_pages => num_pages,
-                   :limit_value => per_page, # backwards compatibility
-                   :total_count => total_count,
-                   :first_page? => current_page > 1,
-                   :last_page? => current_page < num_pages
-      )
+    response
   end
 
   # Equivalent to kaminari "paginate", but takes an RSolr::Response as first argument.
@@ -35,8 +14,7 @@ module Blacklight::CatalogHelperBehavior
   # kaminari paginate, passed on through.
   # will output HTML pagination controls.
   def paginate_rsolr_response(response, options = {}, &block)
-    pagination_info = paginate_params(response)
-    paginate Kaminari.paginate_array(response.docs, :total_count => pagination_info.total_count).page(pagination_info.current_page).per(pagination_info.per_page), options, &block
+    paginate response, options, &block
   end
 
   #
@@ -47,21 +25,31 @@ module Blacklight::CatalogHelperBehavior
   #
   # Pass in an RSolr::Response. Displays the "showing X through Y of N" message.
   def render_pagination_info(response, options = {})
-      pagination_info = paginate_params(response)
-
    # TODO: i18n the entry_name
       entry_name = options[:entry_name]
       entry_name ||= response.docs.first.class.name.underscore.sub('_', ' ') unless response.docs.empty?
       entry_name ||= t('blacklight.entry_name.default')
 
 
-      case pagination_info.total_count
+      end_num = if render_grouped_response?
+        format_num(response.start + response.groups.length)
+      else
+        format_num(response.start + response.docs.length)
+      end
+      
+      case response.total_count
         when 0; t('blacklight.search.pagination_info.no_items_found', :entry_name => entry_name.pluralize ).html_safe
         when 1; t('blacklight.search.pagination_info.single_item_found', :entry_name => entry_name).html_safe
-        else; t('blacklight.search.pagination_info.pages', :entry_name => entry_name.pluralize, :current_page => pagination_info.current_page, :num_pages => pagination_info.num_pages, :start_num => format_num(pagination_info.start), :end_num => format_num(pagination_info.end), :total_num => pagination_info.total_count, :count => pagination_info.num_pages).html_safe
+        else; t('blacklight.search.pagination_info.pages', :entry_name => entry_name.pluralize, :current_page => response.current_page, :num_pages => response.total_pages, :start_num => format_num(response.start + 1) , :end_num => end_num, :total_num => response.total_count, :count => response.total_pages).html_safe
       end
   end
 
+  def document_counter_with_offset idx 
+    unless render_grouped_response? 
+      idx + 1 + @response.params[:start].to_i
+    end
+  end
+
   # Like  #render_pagination_info above, but for an individual
   # item show page. Displays "showing X of Y items" message. Actually takes
   # data from session though (not a great design).
@@ -107,4 +95,36 @@ module Blacklight::CatalogHelperBehavior
     response.total > 1
   end
 
+  def should_autofocus_on_search_box?
+    controller.is_a? Blacklight::Catalog and
+      action_name == "index" and
+      params[:q].to_s.empty? and
+      params[:f].to_s.empty?
+  end
+
+  def has_thumbnail? document
+    blacklight_config.index.thumbnail_method or
+      blacklight_config.index.thumbnail_field && document.has_field?(blacklight_config.index.thumbnail_field)
+  end
+
+  def render_thumbnail_tag document, image_options = {}, url_options = {}
+    value = if blacklight_config.index.thumbnail_method
+      send(blacklight_config.index.thumbnail_method, document, image_options)
+    elsif blacklight_config.index.thumbnail_field
+      image_tag thumbnail_url(document), image_options
+    end
+
+    if value
+      link_to_document document, url_options.merge(:label => value)
+    end
+  end
+
+  def thumbnail_url document
+    document.get(blacklight_config.index.thumbnail_field, :sep => nil).first if document.has_field?(blacklight_config.index.thumbnail_field)
+  end
+
+  def add_group_facet_params_and_redirect group
+    add_facet_params_and_redirect(group.field, group.key)
+  end
+
 end