blacklight 4.4.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1463e41c998a83ef595ee4dafe4a390d5cd90be
-  data.tar.gz: a9b62fea9a0454a432ac5ecd95e8f8952438da5d
+  metadata.gz: e233726683e123e23d25e7f85920aff1fc6174ae
+  data.tar.gz: 747930b852dfb6a093710a6ba264562063926348
 SHA512:
-  metadata.gz: 57b6f5e61c7ed3faf05c151ff3915fe48fedac1be2edb2b9f0deae5879265118e8d1f7b961541915a54b41ac2098cea36fb1d4c5d77eaf125360c60a17721b5b
-  data.tar.gz: 54d4dc8f7f4fe286dd0ec6faae2c73e95e1e7fb644f6418d3cf6b52de96cd7cacc84c5baa5e6ce65472f507c4548d83f38a3d884134bf5e0047fda2f69be42dd
+  metadata.gz: b7c98286303cdc3c45e41bb2991615aa9a082ca5d770fef9e9b5eb538ee8e59a7c754ef4bb10b27597c779590d5d4ed9214135e315997753aae76da4cb7e7fa3
+  data.tar.gz: 07af82e4ba9cf21b51bff27c3219d701db867a02c59aaba3a4920a746be4ec555c5d2910a5f59505a976afd2aa629ef78567fc577c569b14741a96234157abdd

data/VERSION

@@ -1 +1 @@
-4.4.0
+4.4.1

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -92,7 +92,7 @@ module Blacklight::BlacklightHelperBehavior
     wrapping_class = options.delete(:wrapping_class) || "documentFunctions"
 
     content = []
-    content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if has_user_authentication_provider? and current_or_guest_user
+    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)
   end
@@ -100,11 +100,14 @@ module Blacklight::BlacklightHelperBehavior
   # Save function area for item detail 'show' view, normally
   # renders next to title. By default includes 'Bookmarks'
   def render_show_doc_actions(document=@document, options={})
-    wrapping_class = options.delete(:documentFunctions) || "documentFunctions"
+    # 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
+    wrapping_class = options.delete(:documentFunctions) || options.delete(:wrapping_class) || "documentFunctions"
+
     content = []
-    content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if has_user_authentication_provider? and current_or_guest_user
+    content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if render_bookmarks_control?
 
-    content_tag("div", content.join("\n").html_safe, :class=>"documentFunctions")
+    content_tag("div", content.join("\n").html_safe, :class=> wrapping_class)
   end
 
   ##
@@ -621,4 +624,8 @@ module Blacklight::BlacklightHelperBehavior
     render :partial => 'catalog/group_default'
   end
 
+  def render_bookmarks_control?
+    has_user_authentication_provider? and current_or_guest_user.present?
+  end
+
 end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -104,7 +104,7 @@ module Blacklight::CatalogHelperBehavior
 
   def has_thumbnail? document
     blacklight_config.index.thumbnail_method or
-      blacklight_config.index.thumbnail_field && document.has_field?(blacklight_config.index.thumbnail_field)
+      blacklight_config.index.thumbnail_field && document.has?(blacklight_config.index.thumbnail_field)
   end
 
   def render_thumbnail_tag document, image_options = {}, url_options = {}
@@ -120,7 +120,9 @@ module Blacklight::CatalogHelperBehavior
   end
 
   def thumbnail_url document
-    document.get(blacklight_config.index.thumbnail_field, :sep => nil).first if document.has_field?(blacklight_config.index.thumbnail_field)
+    if document.has? blacklight_config.index.thumbnail_field
+      document.first(blacklight_config.index.thumbnail_field)
+    end
   end
 
   def add_group_facet_params_and_redirect group

data/app/views/_user_util_links.html.erb

@@ -10,7 +10,7 @@
   <% end %>
 
   <div class="util-links-other">
-    <% if current_or_guest_user %>
+    <% if render_bookmarks_control? %>
       <%= link_to t('blacklight.header_links.bookmarks'), bookmarks_path %>
     <% end %>
     <% if has_user_authentication_provider? and current_user %>

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

@@ -5,6 +5,6 @@
       <%= render_document_partial document, :thumbnail, :document_counter => document_counter %>
 
       <% # main container for doc partial view -%>
-      <%= render_document_partial document, :index %>
+      <%= render_document_partial document, :index, :document_counter => document_counter %>
 
     </div>

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

@@ -1,4 +1,4 @@
-<%- if has_thumbnail?(document) && tn = render_thumbnail_tag(document, nil, :counter => document_counter + 1 + @response.params[:start].to_i) %>
+<%- if has_thumbnail?(document) && tn = render_thumbnail_tag(document, {}, :counter => document_counter_with_offset(document_counter)) %>
 <div class="document-thumbnail">
   <%= tn %>
 </div>  

data/lib/blacklight/solr/document.rb

@@ -62,9 +62,9 @@ module Blacklight::Solr::Document
   # doc.has?(:location_facet, 'Clemons')
   # doc.has?(:id, 'h009', /^u/i)
   def has?(k, *values)
-    return if @_source[k].nil?
-    return true if @_source.key?(k) and values.empty?
-    target = @_source[k]
+    return true if key?(k) and values.empty?
+    return false if self[k].nil?
+    target = self[k]
     if target.is_a?(Array)
       values.each do |val|
         return target.any?{|tv| val.is_a?(Regexp) ? (tv =~ val) : (tv==val)}
@@ -74,6 +74,10 @@ module Blacklight::Solr::Document
     end
   end
 
+  def key? k
+    @_source.key? k
+  end
+
   def has_highlight_field? k
     return false if @solr_response['highlighting'].blank? or @solr_response['highlighting'][self.id].blank?
     
@@ -93,14 +97,18 @@ module Blacklight::Solr::Document
   #  - :default - a value to return when the key doesn't exist
   # if :sep is nil and the field is a multivalued field, the array is returned
   def get(key, opts={:sep=>', ', :default=>nil})
-    if @_source.key? key
-      val = @_source[key]
+    if key? key
+      val = self[key]
       (val.is_a?(Array) and opts[:sep]) ? val.join(opts[:sep]) : val
     else
       opts[:default]
     end
   end
 
+  def first key
+    Array(self[key]).first
+  end
+
   def id
     self[self.class.unique_key]
   end

data/lib/blacklight/solr_helper.rb

@@ -311,6 +311,7 @@ module Blacklight::SolrHelper
 
 
       if blacklight_config.add_facet_fields_to_solr_request
+        solr_parameters[:facet] = true
         solr_parameters[:'facet.field'] ||= []
         solr_parameters[:'facet.field'] += blacklight_config.facet_fields_to_add_to_solr
         

data/spec/helpers/catalog_helper_spec.rb

@@ -131,13 +131,13 @@ describe CatalogHelper do
 
     it "should have a thumbnail if a thumbnail_field is configured and it exists in the document" do
       helper.stub(:blacklight_config => OpenStruct.new(:index => OpenStruct.new(:thumbnail_field => :xyz) ))
-      document = double(:has_field? => true)
+      document = double(:has? => true)
       expect(helper.has_thumbnail? document).to be_true
     end
     
     it "should not have a thumbnail if the thumbnail_field is missing from the document" do
       helper.stub(:blacklight_config => OpenStruct.new(:index => OpenStruct.new(:thumbnail_field => :xyz) ))
-      document = double(:has_field? => false)
+      document = double(:has? => false)
       expect(helper.has_thumbnail? document).to be_false
     end
 
@@ -161,8 +161,8 @@ describe CatalogHelper do
       helper.stub(:blacklight_config => double(:index => OpenStruct.new(:thumbnail_field => :xyz)))
       document = double()
 
-      document.stub(:has_field?).with(:xyz).and_return(true)
-      document.stub(:get).with(:xyz, :sep => nil).and_return(["http://example.com/some.jpg"])
+      document.stub(:has?).with(:xyz).and_return(true)
+      document.stub(:first).with(:xyz).and_return("http://example.com/some.jpg")
 
       helper.should_receive(:link_to_document).with(document, :label => image_tag("http://example.com/some.jpg"))
       helper.render_thumbnail_tag document
@@ -188,15 +188,15 @@ describe CatalogHelper do
     it "should pull the configured thumbnail field out of the document" do
       helper.stub(:blacklight_config => double(:index => double(:thumbnail_field => "xyz")))
       document = double()
-      document.stub(:has_field?).with("xyz").and_return(true)
-      document.stub(:get).with("xyz", :sep => nil).and_return(["asdf"])
+      document.stub(:has?).with("xyz").and_return(true)
+      document.stub(:first).with("xyz").and_return("asdf")
       expect(helper.thumbnail_url document).to eq("asdf")
     end
 
     it "should return nil if the thumbnail field doesn't exist" do
       helper.stub(:blacklight_config => double(:index => double(:thumbnail_field => "xyz")))
       document = double()
-      document.stub(:has_field?).with("xyz").and_return(false)
+      document.stub(:has?).with("xyz").and_return(false)
       expect(helper.thumbnail_url document).to be_nil
     end
   end

data/spec/lib/blacklight_solr_document_spec.rb

@@ -231,5 +231,18 @@ describe "Blacklight::Solr::Document" do
         end
       end
     end
+
+  describe "#first" do
+    it "should get the first value from a multi-valued field" do
+      doc = SolrDocument.new :multi => ['a', 'b']
+      expect(doc.first :multi).to eq("a")
+    end
+
+    it "should get the value from a single-valued field" do
+      doc = SolrDocument.new :single => 'a'
+      expect(doc.first :single).to eq("a")
+
+    end
+  end
     
 end

data/spec/lib/solr_helper_spec.rb

@@ -290,6 +290,8 @@ describe 'Blacklight::SolrHelper' do
         
         add_facetting_to_solr(solr_parameters, {})
 
+        expect(solr_parameters[:facet]).to be_true
+
         solr_parameters[:'facet.field'].should include('test_field')
         solr_parameters[:'f.test_field.facet.sort'].should == 'count'
       end

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

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe "catalog/_document" do
+  let :document do
+    SolrDocument.new :id => 'xyz', :format => 'a'
+  end
+
+  let :blacklight_config do
+    Blacklight::Configuration.new
+  end
+
+  it "should render the header, thumbnail and index" do
+    view.stub(:blacklight_config).and_return(blacklight_config)
+    stub_template "catalog/_document_header.html.erb" => "document_header"
+    stub_template "catalog/_thumbnail_default.html.erb" => "thumbnail_default"
+    stub_template "catalog/_index_default.html.erb" => "index_default"
+    render :partial => "catalog/document", :locals => {:document => document, :document_counter => 1}
+    expect(rendered).to match /document_header/
+    expect(rendered).to match /thumbnail_default/
+    expect(rendered).to match /index_default/
+  end
+end

data/spec/views/catalog/_thumbnail_default.erb_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe "catalog/_thumbnail_default" do
+
+  let :document_without_thumbnail_field do
+    SolrDocument.new :id => 'xyz', :format => 'a'
+  end
+
+  let :document_with_thumbnail_field do
+    SolrDocument.new :id => 'xyz', :format => 'a', :thumbnail_url => 'http://localhost/logo.png'
+  end
+
+  let :blacklight_config do
+    Blacklight::Configuration.new do |config|
+      config.index.thumbnail_field = :thumbnail_url
+    end
+  end
+
+  before do
+    assign :response, mock(:params => {})
+    view.stub(:render_grouped_response?).and_return false
+    view.stub(:blacklight_config).and_return(blacklight_config)
+  end
+
+  it "should render the thumbnail if the document has one" do
+    render :partial => "catalog/thumbnail_default", :locals => {:document => document_with_thumbnail_field, :document_counter => 1}
+    expect(rendered).to match /document-thumbnail/
+    expect(rendered).to match /src="http:\/\/localhost\/logo.png"/
+  end
+
+  it "should not render a thumbnail if the document does not have one" do
+    render :partial => "catalog/thumbnail_default", :locals => {:document => document_without_thumbnail_field, :document_counter => 1}
+    expect(rendered).to eq ""
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.4.1
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2013-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -464,11 +464,13 @@ files:
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/test_app_templates/lib/tasks/blacklight_test_app.rake
 - spec/views/catalog/_constraints_element.html.erb_spec.rb
+- spec/views/catalog/_document.html.erb_spec.rb
 - spec/views/catalog/_document_list.html.erb_spec.rb
 - spec/views/catalog/_facets.html.erb_spec.rb
 - spec/views/catalog/_index_default.erb_spec.rb
 - spec/views/catalog/_show_default.erb_spec.rb
 - spec/views/catalog/_show_sidebar.erb_spec.rb
+- spec/views/catalog/_thumbnail_default.erb_spec.rb
 - spec/views/catalog/index.atom.builder_spec.rb
 - tasks/blacklight.rake
 - test_support/data/test_data.utf8.mrc
@@ -559,9 +561,11 @@ test_files:
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/test_app_templates/lib/tasks/blacklight_test_app.rake
 - spec/views/catalog/_constraints_element.html.erb_spec.rb
+- spec/views/catalog/_document.html.erb_spec.rb
 - spec/views/catalog/_document_list.html.erb_spec.rb
 - spec/views/catalog/_facets.html.erb_spec.rb
 - spec/views/catalog/_index_default.erb_spec.rb
 - spec/views/catalog/_show_default.erb_spec.rb
 - spec/views/catalog/_show_sidebar.erb_spec.rb
+- spec/views/catalog/_thumbnail_default.erb_spec.rb
 - spec/views/catalog/index.atom.builder_spec.rb