blacklight 3.0.0 → 3.1.0

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

@@ -16,6 +16,4 @@
       <% # main container for doc partial view -%>
       <%= render_document_partial document, :index %>
 
-      <%= render_document_unapi_microformat document %>
-
     </div>

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

@@ -25,7 +25,6 @@
     <div class="document">
       <%= render_document_partial @document, :show %>
     </div>
-      <%= render_document_unapi_microformat @document %>
   </div>
 </div>
 

data/app/views/kaminari/blacklight/_paginator.html.erb

@@ -11,7 +11,7 @@
     <%= prev_page_tag %>
     <%= next_page_tag  %>
     <div class="page_links">
-    <% each_page do |page| -%>
+    <% each_relevant_page do |page| -%>
       <% if page.left_outer? || page.right_outer? || page.inside_window? -%>
         <%= page_tag page %>
       <% elsif !page.was_truncated? -%>

data/lib/blacklight.rb

@@ -1,5 +1,6 @@
 # -*- encoding : utf-8 -*-
 require 'kaminari'
+require 'blacklight/kaminari_relevant_pages_patch'
 require 'marc'
 require 'rsolr'
 require 'rsolr-ext'

data/lib/blacklight/catalog.rb

@@ -30,7 +30,6 @@ module Blacklight::Catalog
       
       extra_head_content << view_context.auto_discovery_link_tag(:rss, url_for(params.merge(:format => 'rss')), :title => "RSS for results")
       extra_head_content << view_context.auto_discovery_link_tag(:atom, url_for(params.merge(:format => 'atom')), :title => "Atom for results")
-      extra_head_content << view_context.auto_discovery_link_tag(:unapi, unapi_url, {:type => 'application/xml',  :rel => 'unapi-server', :title => 'unAPI' })
       
       (@response, @document_list) = get_search_results
       @filters = params[:f] || []
@@ -45,7 +44,6 @@ module Blacklight::Catalog
     
     # get single document from the solr index
     def show
-      extra_head_content << view_context.auto_discovery_link_tag(:unapi, unapi_url, {:type => 'application/xml',  :rel => 'unapi-server', :title => 'unAPI' })
       @response, @document = get_solr_response_for_doc_id    
 
       respond_to do |format|
@@ -62,26 +60,6 @@ module Blacklight::Catalog
       end
     end
 
-    def unapi
-      @export_formats = Blacklight.config[:unapi] || {}
-      @format = params[:format]
-      if params[:id]
-        @response, @document = get_solr_response_for_doc_id
-        @export_formats = @document.export_formats
-      end
-  
-      unless @format
-        render 'unapi.xml.builder', :layout => false and return
-      end
-  
-      respond_to do |format|
-        format.all do
-          send_data @document.export_as(@format), :type => @document.export_formats[@format][:content_type], :disposition => 'inline' if @document.will_export_as @format
-        end
-      end
-    end
-  
-    
     # updates the search counter (allows the show view to paginate)
     def update
       adjust_for_results_view

data/lib/blacklight/kaminari_relevant_pages_patch.rb

@@ -0,0 +1,37 @@
+module Blacklight
+  module KaminariRelevantPagesPatch
+    module Windows
+      def relevant_pages options
+        [left_window(options), inside_window(options), right_window(options)].map(&:to_a).flatten.uniq.sort.reject { |x| x < 1 or x > options[:num_pages] }
+      end
+
+      def all_pages options
+        1.upto(options[:num_pages])
+      end
+
+      protected
+      def left_window options
+        1.upto(options[:left] + 1)
+      end
+
+      def right_window options
+        (options[:num_pages] - options[:right]).upto(options[:num_pages])
+      end
+
+      def inside_window options
+        (options[:current_page] - options[:window]).upto(options[:current_page] + options[:window])
+      end
+    end
+
+    include Windows
+    def each_relevant_page
+      return to_enum(:each_relevant_page) unless block_given?
+
+      relevant_pages(@window_options.merge(@options)).each do |i|
+        yield Kaminari::Helpers::Paginator::PageProxy.new(@window_options.merge(@options), i, @last)
+      end
+    end
+  end
+end
+
+Kaminari::Helpers::Paginator.send(:include, Blacklight::KaminariRelevantPagesPatch)

data/lib/blacklight/routes.rb

@@ -71,7 +71,6 @@ module Blacklight
           match 'catalog/endnote', :as => "endnote_catalog"
           match 'catalog/send_email_record', :as => "send_email_record_catalog"
           match "catalog/facet/:id", :to => 'catalog#facet', :as => 'catalog_facet'
-          match 'catalog/unapi', :to => "catalog#unapi", :as => 'unapi'
           resources :catalog, :only => [:index, :show, :update]
           match 'catalog/:id/librarian_view', :to => "catalog#librarian_view", :as => "librarian_view_catalog"
         end

data/lib/blacklight/solr/document.rb

@@ -49,7 +49,7 @@ require 'rsolr-ext'
 # If an extension advertises what export formats it can provide, than those
 # formats will automatically be delivered by the Blacklight catalog/show
 # controller, and potentially automatically advertised in various places
-# that advertise available formats. (UnAPI; HTML link rel=alternate; Atom 
+# that advertise available formats. (HTML link rel=alternate; Atom 
 # link rel=alterate; etc).
 #
 # Export formats are 'registered' by calling the #will_export_as method
@@ -129,10 +129,10 @@ module Blacklight::Solr::Document
       # some 'api' to Mime::Type that may or may not be entirely
       # public, the fact that a Mime::CONST is registered for every
       # type. But that's the only way to do the kind of check we need, sorry.
-      begin      
+      if defined?(Mime) && Mime.const_defined?(short_name.to_s.upcase)      
         mime_type = "Mime::#{short_name.to_s.upcase}".constantize
         content_type = mime_type.to_s unless content_type      
-      rescue NameError,LoadError
+      else
         # not registered, we need to register. Use register_alias to be least
         # likely to interfere with host app. 
         Mime::Type.register_alias(content_type, short_name)

data/lib/blacklight/solr_helper.rb

@@ -60,13 +60,13 @@ module Blacklight::SolrHelper
     # similar design. Since we're a module, we have to add it in here.
     # There are too many different semantic choices in ruby 'class variables',
     # we choose this one for now, supplied by Rails. 
-    class_inheritable_accessor :solr_search_params_logic
+    class_attribute :solr_search_params_logic
 
     # Set defaults. Each symbol identifies a _method_ that must be in
     # this class, taking two parameters (solr_parameters, user_parameters)
     # Can be changed in local apps or by plugins, eg:
     # CatalogController.include ModuleDefiningNewMethod
-    # CatalogController.solr_search_params_logic << :new_method
+    # CatalogController.solr_search_params_logic += [:new_method]
     # CatalogController.solr_search_params_logic.delete(:we_dont_want)
     self.solr_search_params_logic = [:default_solr_parameters , :add_query_to_solr, :add_facet_fq_to_solr, :add_facetting_to_solr, :add_sorting_paging_to_solr ]
   end

data/lib/generators/blacklight/assets_generator.rb

@@ -18,7 +18,7 @@ module Blacklight
   
     def assets
       if use_asset_pipeline?
-        insert_into_file "app/assets/stylesheets/application.css", :after => " *= require_self" do
+        insert_into_file "app/assets/stylesheets/application.css", :after => "/*" do
 %q{
  *
  * Required by Blacklight

data/lib/generators/blacklight/templates/config/blacklight_config.rb

@@ -24,18 +24,19 @@ Blacklight.configure(:shared) do |config|
     :per_page => 10 
   }
  
-  # solr field values given special treatment in the show (single result) view
+  # solr field configuration for search results/index views
+  config[:index] = {
+    :show_link => "title_display",
+    :record_display_type => "format"
+  }
+  
+  # solr field configuration for document/show views
   config[:show] = {
     :html_title => "title_display",
     :heading => "title_display",
     :display_type => "format"
   }
 
-  # solr fld values given special treatment in the index (search results) view
-  config[:index] = {
-    :show_link => "title_display",
-    :record_display_type => "format"
-  }
 
   # solr fields that will be treated as facets by the blacklight application
   #   The ordering of the field names is the order of the display
@@ -235,12 +236,5 @@ Blacklight.configure(:shared) do |config|
   # mean") suggestion is offered.
   config[:spell_max] = 5
 
-  # Add documents to the list of object formats that are supported for all objects.
-  # This parameter is a hash, identical to the Blacklight::Solr::Document#export_formats 
-  # output; keys are format short-names that can be exported. Hash includes:
-  #    :content-type => mime-content-type
-  config[:unapi] = {
-    'oai_dc_xml' => { :content_type => 'text/xml' } 
-  }
 end
 

data/lib/railties/blacklight_rspec.rake

@@ -10,7 +10,9 @@
 begin
   require 'rspec/core'
   require 'rspec/core/rake_task'
-  Rake.application.instance_variable_get('@tasks')['default'].prerequisites.delete('test')
+  if default = Rake.application.instance_variable_get('@tasks')['default']
+    default.prerequisites.delete('test')
+  end
   
   spec_prereq = Rails.configuration.generators.options[:rails][:orm] == :active_record ?  "db:test:prepare" : :noop
   task :noop do; end

data/test_support/bin/run-tests.sh

@@ -0,0 +1,64 @@
+#!/bin/bash
+# test.sh
+# Create a default rails appliaction, install blacklight, and run all the tests.
+
+before="$(date +%s)"
+benchmark() 
+{
+    after="$(date +%s)"
+    elapsed_seconds="$(expr $after - $before)"
+    echo "Total Time: ${elapsed_seconds} sec"
+    # as a bonus, make our script exit with the right error code.
+}
+
+check_errs()
+{
+  # Function. Parameter 1 is the return code
+  # Para. 2 is text to display on failure.
+  if [ "${1}" -ne "0" ]; then
+    echo "ERROR # ${1} : ${2}"
+
+    # Attempt to shut down jetty, if set.
+    if [ $jetty_pid ] 
+    then
+	kill $jetty_pid
+    fi
+     benchmark
+     exit 1
+  fi
+}
+
+# Make sure we are in the blacklight directory
+if [ ! -f "blacklight.gemspec" ]
+then
+  echo "You must execute test.sh from the root of your blacklight checkout."
+  exit 1
+fi
+
+# Make certain rvn will work correctly.
+# Load RVM into a shell session *as a function*
+if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
+  # First try to load from a user install
+  source "$HOME/.rvm/scripts/rvm"
+elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
+  # Then try to load from a root install
+  source "/usr/local/rvm/scripts/rvm"
+else
+  printf "ERROR: An RVM installation was not found.\n"
+  exit 1
+fi
+
+
+rvm use "$@" --create
+check_errs $? "rvm failed.  please run 'rvm install $@', and then re-run these tests." 
+
+cd tmp/test_app
+cd test_jetty
+java -Djetty.port=8888 -Dsolr.solr.home=./solr -jar start.jar &> /dev/null &
+jetty_pid=$!
+cd ..
+bundle exec rake blacklight:spec
+check_errs $? "Rpec Tests failed." 
+bundle exec rake blacklight:cucumber
+check_errs $? "Cucumber Tests failed." 
+benchmark

data/test_support/bin/test.sh

@@ -56,9 +56,15 @@ fi
 
 rvm use "$@" --create
 check_errs $? "rvm failed.  please run 'rvm install $@', and then re-run these tests." 
-gem install --no-rdoc --no-ri 'rails'
-gem install --no-rdoc --no-ri 'bundler'
-gem install --no-rdoc --no-ri 'devise'
+
+if ! gem query -n rails -v "~>3.0" --installed > /dev/null; then
+  gem install --no-rdoc --no-ri 'rails'
+fi
+
+if ! gem query -n bundler -v ">=1.0" --installed > /dev/null; then
+  gem install --no-rdoc --no-ri 'bundler'
+fi
+
 rails new test_app
 cd test_app
 echo "
@@ -87,6 +93,8 @@ group :development, :test do
        gem 'webrat'
        gem 'aruba'
 end
+
+gem 'devise'
 " > Gemfile
 
 bundle install --local &> /dev/null 
@@ -119,4 +127,4 @@ bundle exec rake blacklight:spec
 check_errs $? "Rpec Tests failed." 
 bundle exec rake blacklight:cucumber
 check_errs $? "Cucumber Tests failed." 
-benchmark
+benchmark

data/test_support/features/step_definitions/search_steps.rb

@@ -83,10 +83,6 @@ Then /^I should see an atom discovery link/ do
   page.should have_selector("link[rel=alternate][type='application/atom+xml']")
 end
 
-Then /^I should see an unAPI discovery link/ do
-  page.should have_selector("link[rel=unapi-server][type='application/xml']")
-end
-
 Then /^I should see opensearch response metadata tags/ do
   page.should have_selector("meta[name=totalResults]")
   page.should have_selector("meta[name=startIndex]")

data/test_support/features/support/paths.rb

@@ -25,15 +25,6 @@ module NavigationHelpers
     when /the facet page for "([^\"]*)"/
       catalog_facet_path($1)
 
-    when /the unAPI endpoint for "([^\"]+)" with format "([^\"]+)"/
-      unapi_path(:id => $1, :format => $2)
-
-    when /the unAPI endpoint for "([^\"]+)"/
-      unapi_path(:id => $1)
-
-    when /the unAPI endpoint/
-      unapi_path
-
     # Add more mappings here.
     # Here is an example that pulls values out of the Regexp:
     #

data/test_support/spec/controllers/catalog_controller_spec.rb

@@ -302,51 +302,6 @@ describe CatalogController do
 
   end # describe show action
 
-  describe "unapi" do
-      doc_id = '2007020969'
-        module FakeExtension
-          def self.extended(document)
-            document.will_export_as(:mock, "application/mock")
-            document.will_export_as(:mockxml, "text/xml")
-          end
-
-          def export_as_mock
-            "mock_export"
-          end
-
-          def export_as_mockxml
-            "<a><mock xml='document' /></a>"
-          end
-        end
-      before(:each) do
-        SolrDocument.registered_extensions = nil
-        SolrDocument.use_extension(FakeExtension)
-      end
-
-    it "should return an unapi formats list from config[:unapi]" do
-      Blacklight.config[:unapi] = { :mock => { :content_type => "application/mock" } }
-      get :unapi
-      response.should be_success
-      assigns[:export_formats][:mock][:content_type].should == "application/mock"
-    end
-
-
-    it "should return an unapi formats list for document" do
-      get :unapi, :id => doc_id
-      response.should be_success
-      assigns[:document].should be_kind_of(SolrDocument)
-      assigns[:export_formats].should_not be_nil
-      assigns[:export_formats].should be_kind_of(Hash) 
-      assigns[:export_formats][:mock] == { :content_type => "application/mock" }
-      assigns[:export_formats][:mockxml] = { :content_type => 'text/xml' }
-    end
-
-    it "should return an unapi format export for document" do
-      get :unapi, :id => doc_id, :format => 'mock'
-      response.should be_success
-      response.should contain("mock_export")
-    end
-  end
 
   describe "opensearch" do
     it "should return an opensearch description" do

data/test_support/spec/helpers/blacklight_helper_spec.rb

@@ -1,4 +1,4 @@
-# -*- encoding : utf-8 -*-
+#ste -*- encoding : utf-8 -*-
 # -*- coding: UTF-8 -*-
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 require 'marc'
@@ -24,7 +24,7 @@ def exportable_record
 
   <datafield tag=\"700\" ind1=\"1\" ind2=\" \">
     <subfield code=\"a\">Greer, Lowell.</subfield>
-  </datafield>
+  </datafield>                                                
 
   <datafield tag=\"700\" ind1=\"1\" ind2=\" \">
     <subfield code=\"a\">Lubin, Steven.</subfield>
@@ -147,91 +147,8 @@ describe BlacklightHelper do
         end
       end
     end
-    
  end
 
-  describe "render_stylesheet_links" do
-    def stylesheet_links
-      [ 
-        ["my_stylesheet", {:plugin => :blacklight}],
-        ["other_stylesheet"]
-      ]
-    end
-    it "should render stylesheets specified in controller #stylesheet_links" do
-      html = render_stylesheet_includes      
-      html.should have_selector("link[href='/stylesheets/my_stylesheet.css'][rel='stylesheet'][type='text/css']")
-      html.should have_selector("link[href='/stylesheets/other_stylesheet.css'][rel='stylesheet'][type='text/css']")
-      html.html_safe?.should == true
-    end
-  end
-  
-  describe "render_js_includes" do
-    def javascript_includes
-      [ 
-        ["some_js.js", {:plugin => :blacklight}],
-        ["other_js"]
-      ]
-    end
-    it "should include script tags specified in controller#javascript_includes" do
-      html = render_js_includes
-      html.should have_selector("script[src='/javascripts/some_js.js'][type='text/javascript']")
-      html.should have_selector("script[src='/javascripts/other_js.js'][type='text/javascript']")      
-
-      html.html_safe?.should == true
-    end
-   end
-
-  describe "render_extra_head_content" do
-    def extra_head_content
-      ['<link rel="a">', '<link rel="b">']
-    end
-
-    it "should include content specified in controller#extra_head_content" do
-      html = render_extra_head_content
-
-      html.should have_selector("link[rel=a]")
-      html.should have_selector("link[rel=b]")
-
-      html.html_safe?.should == true
-    end
-  end
-
-   describe "render_head_content" do
-    describe "with no methods defined" do
-      it "should return empty string without complaint" do
-      lambda {render_head_content}.should_not raise_error
-      render_head_content.should be_blank
-      render_head_content.html_safe?.should == true
-      end
-    end
-    describe "with methods defined" do
-      def javascript_includes
-        [["my_js"]]
-      end
-      def stylesheet_links
-        [["my_css"]]
-      end
-      def extra_head_content
-        [
-          "<madeup_tag></madeup_tag>",
-          '<link rel="rel" type="type" href="href">' 
-        ]
-      end
-      before(:each) do
-        @output = render_head_content
-      end
-      it "should include extra_head_content" do
-        @output.should have_selector("madeup_tag")
-        @output.should have_selector("link[rel=rel][type=type][href=href]")
-      end
-      it "should include render_javascript_includes" do
-        @output.index( render_js_includes ).should_not be_nil
-      end
-      it "should include render_stylesheet_links" do
-        @output.index( render_stylesheet_includes ).should_not be_nil
-      end
-    end
-   end
 
    describe "render body class" do
       it "should include a serialization of the current controller name" do
@@ -331,95 +248,6 @@ describe BlacklightHelper do
      end
    end
 
-  describe "add_facet_params" do
-    before do
-      @params_no_existing_facet = {:q => "query", :search_field => "search_field", :per_page => "50"}
-      @params_existing_facets = {:q => "query", :search_field => "search_field", :per_page => "50", :f => {"facet_field_1" => ["value1"], "facet_field_2" => ["value2", "value2a"]}}
-    end
-
-    it "should add facet value for no pre-existing facets" do
-      helper.stub!(:params).and_return(@params_no_existing_facet)
-
-      result_params = helper.add_facet_params("facet_field", "facet_value")
-      result_params[:f].should be_a_kind_of(Hash)
-      result_params[:f]["facet_field"].should be_a_kind_of(Array)
-      result_params[:f]["facet_field"].should == ["facet_value"]
-    end
-
-    it "should add a facet param to existing facet constraints" do
-      helper.stub!(:params).and_return(@params_existing_facets)
-      
-      result_params = helper.add_facet_params("facet_field_2", "new_facet_value")
-
-      result_params[:f].should be_a_kind_of(Hash)
-
-      @params_existing_facets[:f].each_pair do |facet_field, value_list|
-        result_params[:f][facet_field].should be_a_kind_of(Array)
-        
-        if facet_field == 'facet_field_2'
-          result_params[:f][facet_field].should == (@params_existing_facets[:f][facet_field] | ["new_facet_value"])
-        else
-          result_params[:f][facet_field].should ==  @params_existing_facets[:f][facet_field]
-        end        
-      end
-    end
-    it "should leave non-facet params alone" do
-      [@params_existing_facets, @params_no_existing_facet].each do |params|
-        helper.stub!(:params).and_return(params)
-
-        result_params = helper.add_facet_params("facet_field_2", "new_facet_value")
-
-        params.each_pair do |key, value|
-          next if key == :f
-          result_params[key].should == params[key]
-        end        
-      end
-    end    
-  end
-
-  describe "add_facet_params_and_redirect" do
-    before do
-      catalog_facet_params = {:q => "query", 
-                :search_field => "search_field", 
-                :per_page => "50",
-                :page => "5",
-                :f => {"facet_field_1" => ["value1"], "facet_field_2" => ["value2", "value2a"]},
-                Blacklight::Solr::FacetPaginator.request_keys[:offset] => "100",
-                Blacklight::Solr::FacetPaginator.request_keys[:sort] => "index",
-                :id => 'facet_field_name'
-      }
-      helper.stub!(:params).and_return(catalog_facet_params)
-    end
-    it "should redirect to 'index' action" do
-      params = helper.add_facet_params_and_redirect("facet_field_2", "facet_value")
-
-      params[:action].should == "index"
-    end
-    it "should not include request parameters used by the facet paginator" do
-      params = helper.add_facet_params_and_redirect("facet_field_2", "facet_value")
-
-      bad_keys = Blacklight::Solr::FacetPaginator.request_keys.values + [:id]
-      bad_keys.each do |paginator_key|
-        params.keys.should_not include(paginator_key)        
-      end
-    end
-    it 'should remove :page request key' do
-      params = helper.add_facet_params_and_redirect("facet_field_2", "facet_value")
-
-      params.keys.should_not include(:page)
-    end
-    it "should otherwise do the same thing as add_facet_params" do
-      added_facet_params = helper.add_facet_params("facet_field_2", "facet_value")
-      added_facet_params_from_facet_action = helper.add_facet_params_and_redirect("facet_field_2", "facet_value")
-
-      added_facet_params_from_facet_action.each_pair do |key, value|
-        next if key == :action
-        value.should == added_facet_params[key]
-      end      
-    end
-
-    
-  end
 
   describe "render_link_rel_alternates" do
       class MockDocumentAppHelper