blacklight 5.9.3 → 5.9.4

data/doc/testing.md

@@ -0,0 +1,58 @@
+## Using Blacklight source checkout as gem for development
+
+The ordinary install instructions install the BL gem (which is not
+full source code) in wherever your system installs gems. 
+
+Sometimes, especially for development, it's useful to check out
+a complete copy of the blacklight source code, and link your app
+to that as a 'gem' instead. 
+
+Checkout the code:
+
+    $ git clone git@github.com:projectblacklight/blacklight.git  
+
+
+## Automatically generate a test application (and run the tests)
+
+To run the Blacklight test suite, Blacklight comes with a rake task that creates local dependencies like a Solr with indexed test data and a test Rails application, and then runs tests. 
+
+Requirements:
+
+  * Java (1.6 or above) (for Solr)
+  * phantomjs (used by integration tests, you may be able to install with your local package manager, for instance on OSX with `brew install phantomjs`)
+
+Then from the root directory of your blacklight git checkout:
+
+```
+bundle exec rake
+```
+
+This ensure a test Solr exists and is running, creates a test application, and loads the fixtures and then runs specs and cucumber tests.
+
+### Step by step, with more control
+
+`rake ci` will, every time you run it, re-index test data in solr, and re-build the test application. Re-building the test application in particular is kind of time-consuming. You may prefer to set up the environment and run tests as separate steps, to make development easier. 
+
+To create the dummy test app:
+
+    $ bundle exec rake engine_cart:generate
+
+(If you have an existing dummy app that is outdated, `rake engine_cart:clean` first, then `rake engine_cart:generate). 
+
+Then start up the test jetty, on the port that tests will look for it, with:
+
+    $ RAILS_ENV=test bundle exec rake jetty:start
+
+If you haven't yet indexed the test data in the test jetty. (??? Not sure how to do this. Run `rake ci` once to make sure test data has been indexed).  Run `rake jetty:stop` when you're done with it. 
+
+Then run all the specs with:
+
+    $ bundle exec rake spec
+
+Or just run one spec
+
+    $ bundle exec rake spec SPEC=just/one_spec.rb
+
+And stop your test solr when you're done with it:
+
+    $ bundle exec rake jetty:stop

data/lib/blacklight.rb

@@ -1,6 +1,9 @@
 # -*- encoding : utf-8 -*-
 require 'kaminari'
 require 'rsolr'
+require 'deprecation'
+require 'blacklight/utils'
+
 module Blacklight
 
   autoload :Configurable, 'blacklight/configurable'
@@ -25,8 +28,7 @@ module Blacklight
   autoload :DocumentPresenter, 'blacklight/document_presenter'
 
   autoload :Routes, 'blacklight/routes'
-
-  autoload :OpenStructWithHashAccess, 'blacklight/utils'
+  
   autoload :SolrResponse, 'blacklight/solr_response'
   autoload :Facet, 'blacklight/facet'
 
@@ -92,7 +94,13 @@ module Blacklight
   end
 
   def self.logger
-    ::Rails.logger
+    @logger ||= begin
+      ::Rails.logger if defined? Rails and Rails.respond_to? :logger
+    end
+  end
+
+  def self.logger= logger
+    @logger = logger
   end
 
   #############  

data/lib/blacklight/catalog.rb

@@ -33,7 +33,7 @@ module Blacklight::Catalog
       (@response, @document_list) = get_search_results
 
       respond_to do |format|
-        format.html { preferred_view }
+        format.html { store_preferred_view }
         format.rss  { render :layout => false }
         format.atom { render :layout => false }
         format.json do
@@ -45,7 +45,8 @@ module Blacklight::Catalog
       end
     end
 
-    # get single document from the solr index
+    # get a single document from the index
+    # to add responses for formats other than html or json see _Blacklight::Document::Export_
     def show
       @response, @document = get_solr_response_for_doc_id params[:id]
 
@@ -134,13 +135,23 @@ module Blacklight::Catalog
     # do not specifiy the view, set the view parameter to the value stored in the
     # session. This enables a user with a session to do subsequent searches and have
     # them default to the last used view.
-    def preferred_view
+    def store_preferred_view
       session[:preferred_view] = params[:view] if params[:view]
-      params[:view] ||= session[:preferred_view]
     end
 
+    alias_method :preferred_view, :store_preferred_view
+    deprecation_deprecate :preferred_view
+
     ##
-    # Render additional response formats, as provided by the blacklight configuration
+    # Render additional response formats for the index action, as provided by the
+    # blacklight configuration
+    #
+    # example:
+    #
+    #   config.index.respond_to.txt = Proc.new { render text: "A list of docs." }
+    #
+    # Make sure your format has a well known mime-type or is registered in
+    # config/initializers/mime_types.rb
     def additional_response_formats format
       blacklight_config.index.respond_to.each do |key, config|
         format.send key do

data/lib/blacklight/catalog/search_context.rb

@@ -101,6 +101,8 @@ module Blacklight::Catalog::SearchContext
       @previous_document = documents.first
       @next_document = documents.last
     end
+  rescue Blacklight::Exceptions::InvalidRequest => e
+    logger.warn "Unable to setup next and previous documents: #{e}"
   end
 
 end

data/lib/blacklight/configuration/facet_field.rb

@@ -10,7 +10,7 @@ module Blacklight
 
       self.collapse = true if self.collapse.nil?
       self.show = true if self.show.nil?
-      self.if ||= self.show
+      self.if = self.show if self.if.nil?
 
       super
     end

data/lib/blacklight/configuration/search_field.rb

@@ -7,7 +7,7 @@ module Blacklight
       self.field ||= self.key
       self.label ||= self.key.try(:titlecase)
       self.qt ||= blacklight_config.default_solr_params[:qt] if blacklight_config && blacklight_config.default_solr_params
-      self.if ||= self.include_in_simple_select
+      self.if = self.include_in_simple_select if self.if.nil?
       super
     end
 

data/lib/blacklight/routes.rb

@@ -19,7 +19,9 @@ module Blacklight
     #         klass.default_route_sets += [:widget_routing]
     #       end
     #       def widget_routing(primary_resource)
-    #         get "#{primary_resource}/widget", "#{primary_resource}#widget"
+    #         add_routes do |options|
+    #           get "#{primary_resource}/widget", "#{primary_resource}#widget"
+    #         end
     #       end
     #     end
     #     Blacklight::Routes.send(:include, MyWidget::Routes)

data/lib/blacklight/solr/document.rb

@@ -34,7 +34,7 @@ module Blacklight::Solr::Document
     include Blacklight::Solr::Document::Extensions
   end    
 
-  attr_reader :solr_response
+  attr_reader :solr_response, :_source
 
   def initialize(source_doc={}, solr_response=nil)
     @_source = source_doc.with_indifferent_access
@@ -54,11 +54,23 @@ module Blacklight::Solr::Document
   # If a method is missing, it gets sent to @_source
   # with all of the original params and block
   def method_missing(m, *args, &b)
-    @_source.send(m, *args, &b)
+    if _source_responds_to?(m)
+     _source.send(m, *args, &b)
+   else
+     super
+   end
+  end
+  
+  def respond_to_missing? *args
+    _source_responds_to?(*args) || super
   end
 
   def [] *args
-    @_source.send :[], *args
+    _source.send :[], *args
+  end
+
+  def _read_attribute(attr)
+    self[attr]
   end
 
   # Helper method to check if value/multi-values exist for a given key.
@@ -83,8 +95,9 @@ module Blacklight::Solr::Document
   end
 
   def key? k
-    @_source.key? k
+    _source.key? k
   end
+  alias_method :has_key?, :key?
 
   def has_highlight_field? k
     return false if @solr_response['highlighting'].blank? or @solr_response['highlighting'][self.id].blank?
@@ -126,7 +139,7 @@ module Blacklight::Solr::Document
   end
 
   def as_json(options = nil)
-    @_source.as_json(options)
+    _source.as_json(options)
   end
 
   def to_partial_path
@@ -203,7 +216,10 @@ module Blacklight::Solr::Document
       @field_semantics ||= {}
     end    
   end
-  
- 
-  
+  private
+    
+  def _source_responds_to? *args
+    _source && self != _source && _source.respond_to?(*args)
+  end
+
 end

data/lib/blacklight/solr_repository.rb

@@ -49,8 +49,8 @@ module Blacklight
 
         solr_response = blacklight_config.solr_response_model.new(res, solr_params, solr_document_model: blacklight_config.solr_document_model)
 
-        Rails.logger.debug("Solr query: #{solr_params.inspect}")
-        Rails.logger.debug("Solr response: #{solr_response.inspect}") if defined?(::BLACKLIGHT_VERBOSE_LOGGING) and ::BLACKLIGHT_VERBOSE_LOGGING
+        Blacklight.logger.debug("Solr query: #{solr_params.inspect}")
+        Blacklight.logger.debug("Solr response: #{solr_response.inspect}") if defined?(::BLACKLIGHT_VERBOSE_LOGGING) and ::BLACKLIGHT_VERBOSE_LOGGING
         solr_response
       end
     rescue Errno::ECONNREFUSED => e

data/lib/blacklight/utils.rb

@@ -1,5 +1,28 @@
 require 'ostruct'
 module Blacklight
+
+  module Utils
+    def self.needs_attr_accessible?
+      if rails_3?
+        !strong_parameters_enabled?
+      else
+        protected_attributes_enabled?
+      end
+    end
+
+    def self.rails_3?
+      Rails::VERSION::MAJOR == 3
+    end
+
+    def self.strong_parameters_enabled?
+      defined?(ActionController::StrongParameters)
+    end
+
+    def self.protected_attributes_enabled?
+      defined?(ActiveModel::MassAssignmentSecurity)
+    end
+  end
+
   ##
   # An OpenStruct that responds to common Hash methods
   class OpenStructWithHashAccess < OpenStruct

data/lib/generators/blacklight/install_generator.rb

@@ -72,7 +72,7 @@ module Blacklight
 
     def generate_blacklight_marc_demo
       if options[:marc]
-        gem "blacklight-marc", "~> 5.0"
+        gem "blacklight-marc", "5.5.0"
 
         Bundler.with_clean_env do
           run "bundle install"

data/lib/generators/blacklight/models_generator.rb

@@ -69,7 +69,9 @@ This generator makes the following changes to your application:
       file_path = "app/models/#{model_name.underscore}.rb"
       if File.exists?(file_path)
         inject_into_class file_path, model_name.classify do
-          "\n  attr_accessible :email, :password, :password_confirmation if Rails::VERSION::MAJOR < 4\n" +
+          "\n  if Blacklight::Utils.needs_attr_accessible?\n" +
+          "\n    attr_accessible :email, :password, :password_confirmation" +
+          "\n  end\n" +
             "# Connects this user object to Blacklights Bookmarks. " +
             "\n  include Blacklight::User\n"
         end

data/lib/generators/blacklight/templates/config/jetty.yml

@@ -1,10 +1,13 @@
 development:
   startup_wait: 15
   jetty_port: 8983
+  java_version: ">= 1.7"
 test:
   startup_wait: 60
   jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8888 %>
   <%= ENV['TEST_JETTY_PATH'] ? "jetty_home: " + ENV['TEST_JETTY_PATH'] : '' %>
+  java_version: ">= 1.7"
 production:
   startup_wait: 15
   jetty_port: 8983
+  java_version: ">= 1.7"

data/spec/controllers/catalog_controller_spec.rb

@@ -33,26 +33,6 @@ describe CatalogController do
           get :index, q: 'foo', view: 'gallery'
           expect(session[:preferred_view]).to eq 'gallery'
         end
-
-        context "when they have a preferred view" do
-          before do
-            session[:preferred_view] = 'gallery'
-          end
-
-          context "and no view is specified" do
-            it "should use the saved preference" do
-              get :index, q: 'foo'
-              expect(controller.params[:view]).to eq 'gallery'
-            end
-          end
-
-          context "and a view is specified" do
-            it "should use the saved preference" do
-              get :index, q: 'foo', view: 'list'
-              expect(controller.params[:view]).to eq 'list'
-            end
-          end
-        end
       end
 
       # check each user manipulated parameter
@@ -313,6 +293,15 @@ describe CatalogController do
       get :show, :id => doc_id
       expect(assigns[:next_document]).to_not be_nil
     end
+
+    it "should not break if solr returns an exception" do
+      allow(controller).to receive(:get_previous_and_next_documents_for_search) {
+        raise Blacklight::Exceptions::InvalidRequest.new "Error"
+      }
+      get :show, :id => doc_id
+      expect(assigns[:previous_document]).to be_nil
+      expect(assigns[:next_document]).to be_nil
+    end
     end
 
     # NOTE: status code is always 200 in isolation mode ...

data/spec/helpers/blacklight_helper_spec.rb

@@ -612,6 +612,50 @@ describe BlacklightHelper do
     end
   end
 
+  describe "#document_index_view_type" do
+    it "should default to the default view" do
+      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
+      allow(helper).to receive(:default_document_index_view_type).and_return(:xyz)
+      expect(helper.document_index_view_type).to eq :xyz
+    end
+
+    it "should use the query parameter" do
+      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
+      expect(helper.document_index_view_type(view: :a)).to eq :a
+    end
+
+    it "should use the default view if the requested view is not available" do
+      allow(helper).to receive(:default_document_index_view_type).and_return(:xyz)
+      allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2)
+      expect(helper.document_index_view_type(view: :c)).to eq :xyz
+    end
+    
+    context "when they have a preferred view" do
+      before do
+        session[:preferred_view] = :b
+      end
+
+      context "and no view is specified" do
+        it "should use the saved preference" do
+          allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2, c: 3)
+          expect(helper.document_index_view_type).to eq :b
+        end
+
+        it "should use the default view if the preference is not available" do
+          allow(helper).to receive(:document_index_views).and_return(a: 1)
+          expect(helper.document_index_view_type).to eq :a
+        end
+      end
+
+      context "and a view is specified" do
+        it "should use the query parameter" do
+          allow(helper).to receive(:document_index_views).and_return(a: 1, b: 2, c: 3)
+          expect(helper.document_index_view_type(view: :c)).to eq :c
+        end
+      end
+    end
+  end
+
   describe "#presenter_class" do
     before do
       allow(helper).to receive(:blacklight_config).and_return(blacklight_config)

data/spec/helpers/configuration_helper_spec.rb

@@ -150,6 +150,13 @@ describe BlacklightConfigurationHelper do
 
       label = helper.solr_field_label :key_a, :key_b, "default text"
     end
+
+    it "should compact nil keys (fixes rails/rails#19419)" do
+      allow(helper).to receive(:t).with(:key_a, default: [:key_b])
+
+      label = helper.solr_field_label :key_a, nil, :key_b
+
+    end
   end
   
   describe "#default_per_page" do

data/spec/lib/blacklight/configuration_spec.rb

@@ -213,11 +213,25 @@ describe "Blacklight::Configuration" do
         "another_field_facet" => {},
         "a_facet_field" => {},
         })
-      expect { |b| @config.add_index_field "*_facet", &b }.to yield_control.twice
-
-      expect(@config.index_fields.keys).to eq ["some_field_facet", "another_field_facet"]
+      expect { |b| @config.add_facet_field "*_facet", &b }.to yield_control.twice
+      expect(@config.facet_fields.keys).to eq ["some_field_facet", "another_field_facet"]
     end
 
+    describe "if/unless conditions with legacy show parameter" do
+      it "should be hidden if the if condition is false" do
+        expect(@config.add_facet_field("hidden", if: false).if).to eq false
+        expect(@config.add_facet_field("hidden_with_legacy", if: false, show: true).if).to eq false
+      end
+
+      it "should be true if the if condition is true" do
+        expect(@config.add_facet_field("hidden", if: true).if).to eq true
+        expect(@config.add_facet_field("hidden_with_legacy", if: true, show: false).if).to eq true
+      end
+
+      it "should be true if the if condition is missing" do
+        expect(@config.add_facet_field("hidden", show: true).if).to eq true
+      end
+    end
   end
   
   describe "add_index_field" do
@@ -261,7 +275,6 @@ describe "Blacklight::Configuration" do
 
       expect(@config.index_fields.keys).to eq ["some_field_display", "another_field_display"]
     end
-
   end
   
   describe "add_show_field" do
@@ -370,8 +383,22 @@ describe "Blacklight::Configuration" do
       
       expect(@config.search_fields["author_name"].label).to eq "Author Name"
     end
-                
-        
+
+    describe "if/unless conditions with legacy include_in_simple_search" do
+      it "should be hidden if the if condition is false" do
+        expect(@config.add_search_field("hidden", if: false).if).to eq false
+        expect(@config.add_search_field("hidden_with_legacy", if: false, include_in_simple_search: true).if).to eq false
+      end
+
+      it "should be true if the if condition is true" do
+        expect(@config.add_search_field("hidden", if: true).if).to eq true
+        expect(@config.add_search_field("hidden_with_legacy", if: true, include_in_simple_search: false).if).to eq true
+      end
+
+      it "should be true if the if condition is missing" do
+        expect(@config.add_search_field("hidden", include_in_simple_search: true).if).to eq true
+      end
+    end
   end
   
   describe "add_sort_field" do