blacklight 5.9.4 → 5.10.0

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

@@ -1,13 +1,10 @@
 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/lib/generators/blacklight/templates/solr_document.rb

@@ -1,21 +1,21 @@
 # -*- encoding : utf-8 -*-
-class SolrDocument 
+class <%= model_name.classify %> 
 
   include Blacklight::Solr::Document
 
   # self.unique_key = 'id'
   
   # Email uses the semantic field mappings below to generate the body of an email.
-  SolrDocument.use_extension( Blacklight::Solr::Document::Email )
+  SolrDocument.use_extension( Blacklight::Document::Email )
   
   # SMS uses the semantic field mappings below to generate the body of an SMS email.
-  SolrDocument.use_extension( Blacklight::Solr::Document::Sms )
+  SolrDocument.use_extension( Blacklight::Document::Sms )
 
   # DublinCore uses the semantic field mappings below to assemble an OAI-compliant Dublin Core document
   # Semantic mappings of solr stored fields. Fields may be multi or
-  # single valued. See Blacklight::Solr::Document::ExtendableClassMethods#field_semantics
-  # and Blacklight::Solr::Document#to_semantic_values
+  # single valued. See Blacklight::Document::SemanticFields#field_semantics
+  # and Blacklight::Document::SemanticFields#to_semantic_values
   # Recommendation: Use field names from Dublin Core
-  use_extension( Blacklight::Solr::Document::DublinCore)    
+  use_extension( Blacklight::Document::DublinCore)    
 
 end

data/lib/generators/blacklight/test_support_generator.rb

@@ -10,12 +10,7 @@ module Blacklight
   class TestSupport < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
   desc """ 
-Installs a jetty container with a solr installed in it. A solr setup known 
-good with default blacklight setup, including solr conf files for out
-of the box blacklight. 
-
-Also adds jetty_path key to solr.yml for selected environment, to refer
-to this install. 
+Generate blacklight testing configurations for blacklight's own tests, or for blacklight plugins to use for testing 
 """
     def alternate_controller
       copy_file "alternate_controller.rb", "app/controllers/alternate_controller.rb"

data/lib/generators/blacklight/user_generator.rb

@@ -0,0 +1,59 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Blacklight
+  class UserGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument     :model_name, :type => :string , :default => "user"
+    class_option :devise    , :type => :boolean, :default => false, :aliases => "-d", :desc => "Use Devise as authentication logic (this is default)."
+
+    desc """
+This generator makes the following changes to your application:
+ 1. Creates a devise-based user model
+ 2. Injects blacklight-specific behavior into your user model
+"""
+    # Install Devise?
+    def generate_devise_assets
+      if options[:devise]
+        gem "devise"
+        gem "devise-guests", "~> 0.3"
+
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
+
+        generate "devise:install"
+        generate "devise", model_name.classify
+        generate "devise_guests", model_name.classify
+
+        # add the #to_s to the model.
+        insert_into_file("app/models/#{model_name}.rb", before: /end(\n| )*$/) do
+          "\n  # Method added by Blacklight; Blacklight uses #to_s on your\n" +
+          "  # user class to get a user-displayable login/identifier for\n" +
+          "  # the account.\n" +
+          "  def to_s\n" +
+          "    email\n" +
+          "  end\n"
+        end
+        gsub_file("config/initializers/devise.rb", "config.sign_out_via = :delete", "config.sign_out_via = :get")
+      end
+    end
+
+    # Add Blacklight to the user model
+    def inject_blacklight_user_behavior
+      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" +
+            "# Connects this user object to Blacklights Bookmarks. " +
+            "\n  include Blacklight::User\n"
+        end
+      else
+        say_status("warning", "Blacklight authenticated user functionality not installed, as a user model could not be found at /app/models/user.rb. If you used a different name, please re-run the migration and provide that name as an argument. Such as `rails -g blacklight:user client`", :yellow)
+      end
+    end
+  end
+end

data/lib/railties/blacklight.rake

@@ -10,12 +10,20 @@ namespace :blacklight do
     Search.delete_old_searches(args[:days_old].to_i)
   end
 
-  namespace :solr do
+  namespace :index do
     desc "Put sample data into solr"
     task :seed do
       docs = YAML::load(File.open(File.join(Blacklight.root, 'solr', 'sample_solr_documents.yml')))
-      Blacklight.solr.add docs
-      Blacklight.solr.commit
+      conn = Blacklight.default_index.connection
+      conn.add docs
+      conn.commit
+    end
+  end
+
+  namespace :solr do
+    task :seed do
+      Deprecation.warn Blacklight, "blacklight:solr:seed is deprecated; use blacklight:index:seed instead"
+      Rake::Task['blacklight:index:seed'].invoke
     end
   end
 
@@ -25,11 +33,12 @@ namespace :blacklight do
       errors = 0
       verbose = ENV.fetch('VERBOSE', false).present?
 
-      puts "[#{Blacklight.solr.uri}]"
+      conn = Blacklight.default_index.connection
+      puts "[#{conn.uri}]"
 
       print " - admin/ping: "
       begin
-        response = Blacklight.solr.send_and_receive 'admin/ping', {}
+        response = conn.send_and_receive 'admin/ping', {}
         puts response['status']
         errors += 1 unless response['status'] == "OK"
       rescue Exception => e
@@ -91,11 +100,11 @@ namespace :blacklight do
         puts e.to_s
       end
 
-      print " - get_solr_response_for_doc_id: "
+      print " - fetch: "
 
       begin
         doc_id = response.docs.first[SolrDocument.unique_key]
-        response, doc = controller.get_solr_response_for_doc_id doc_id
+        response, doc = controller.fetch doc_id
 
         if response.header['status'] == 0 and doc
           puts "OK"

data/spec/controllers/catalog_controller_spec.rb

@@ -264,7 +264,7 @@ describe CatalogController do
         @mock_response = double()
         @mock_document = double()
         allow(@mock_document).to receive_messages(:export_formats => {})
-        allow(controller).to receive_messages(:get_solr_response_for_doc_id => [@mock_response, @mock_document], 
+        allow(controller).to receive_messages(fetch: [@mock_response, @mock_document],
                         :get_previous_and_next_documents_for_search => [double(:total => 5), [double("a"), @mock_document, double("b")]])
 
         current_search = Search.create(:query_params => { :q => ""})
@@ -313,7 +313,7 @@ describe CatalogController do
       @mock_response = double()
       @mock_document = double()
       allow(@mock_document).to receive_messages(:export_formats => {})
-      allow(controller).to receive_messages(:get_solr_response_for_doc_id => [@mock_response, @mock_document])
+      allow(controller).to receive_messages(fetch: [@mock_response, @mock_document])
       get :show, :id => doc_id
       expect(response).to render_template(:show)
     end
@@ -416,8 +416,8 @@ describe CatalogController do
     before do
       allow(controller).to receive_messages(find: mock_response)
       request.env["HTTP_REFERER"] = "/catalog/#{doc_id}"
-      SolrDocument.use_extension( Blacklight::Solr::Document::Email )
-      SolrDocument.use_extension( Blacklight::Solr::Document::Sms )
+      SolrDocument.use_extension( Blacklight::Document::Email )
+      SolrDocument.use_extension( Blacklight::Document::Sms )
     end
     describe "email" do
       it "should give error if no TO parameter" do
@@ -507,11 +507,9 @@ describe CatalogController do
     end
 
     it "should redirect the user to the root url for a bad search" do
-      req = {}
-      res = {}
-      fake_error = RSolr::Error::Http.new(req, res) 
+      fake_error = Blacklight::Exceptions::InvalidRequest.new
       allow(Rails.env).to receive_messages(:test? => false)
-      allow(controller).to receive(:get_search_results) { |*args| raise fake_error }
+      allow(controller).to receive(:search_results) { |*args| raise fake_error }
       expect(controller.logger).to receive(:error).with(fake_error)
       get :index, :q=>"+"
 
@@ -520,17 +518,13 @@ describe CatalogController do
       expect(response).to_not be_success
       expect(response.status).to eq 302
     end
-    it "should return status 500 if the catalog path is raising an exception" do
 
-      req = {}
-      res = {}
-      fake_error = RSolr::Error::Http.new(req, res) 
+    it "should return status 500 if the catalog path is raising an exception" do
+      fake_error = Blacklight::Exceptions::InvalidRequest.new
       allow(controller).to receive(:get_search_results) { |*args| raise fake_error }
       allow(controller.flash).to receive(:sweep)
       allow(controller).to receive(:flash).and_return(:notice => I18n.t('blacklight.search.errors.request_error'))
-      expect {
-      get :index, :q=>"+"
-      }.to raise_error 
+      expect { get :index, q: "+" }.to raise_error
     end
 
   end

data/spec/features/facets_spec.rb

@@ -32,4 +32,12 @@ describe "Facets" do
     
     
   end
+  describe '"More" links' do
+    it 'has default more link with sr-only text' do
+      visit root_path
+      within '#facet-language_facet' do
+        expect(page).to have_css 'li.more_facets_link', text: 'more Language'
+      end
+    end
+  end
 end

data/spec/helpers/configuration_helper_spec.rb

@@ -114,7 +114,7 @@ describe BlacklightConfigurationHelper do
     let(:document) { double }
     it "should look up the label to display for the given document and field" do
       allow(helper).to receive(:index_fields).and_return({ "my_field" => double(label: "some label") })
-      allow(helper).to receive(:solr_field_label).with(:"blacklight.search.fields.index.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
+      allow(helper).to receive(:field_label).with(:"blacklight.search.fields.index.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
       helper.index_field_label document, "my_field"
     end
   end
@@ -123,7 +123,7 @@ describe BlacklightConfigurationHelper do
     let(:document) { double }
     it "should look up the label to display for the given document and field" do
       allow(helper).to receive(:document_show_fields).and_return({ "my_field" => double(label: "some label") })
-      allow(helper).to receive(:solr_field_label).with(:"blacklight.search.fields.show.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
+      allow(helper).to receive(:field_label).with(:"blacklight.search.fields.show.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
       helper.document_show_field_label document, "my_field"
     end
   end
@@ -132,15 +132,15 @@ describe BlacklightConfigurationHelper do
     let(:document) { double }
     it "should look up the label to display for the given document and field" do
       allow(blacklight_config).to receive(:facet_fields).and_return({ "my_field" => double(label: "some label") })
-      allow(helper).to receive(:solr_field_label).with(:"blacklight.search.fields.facet.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
+      allow(helper).to receive(:field_label).with(:"blacklight.search.fields.facet.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
       helper.facet_field_label "my_field"
     end
   end
 
-  describe "#solr_field_label" do
+  describe "#field_label" do
     it "should look up the label as an i18n string" do
       allow(helper).to receive(:t).with(:some_key, default: []).and_return "my label"
-      label = helper.solr_field_label :some_key
+      label = helper.field_label :some_key
 
       expect(label).to eq "my label"
     end
@@ -148,14 +148,7 @@ describe BlacklightConfigurationHelper do
     it "should pass the provided i18n keys to I18n.t" do
       allow(helper).to receive(:t).with(:key_a, default: [:key_b, "default text"])
 
-      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
-
+      label = helper.field_label :key_a, :key_b, "default text"
     end
   end
   

data/spec/helpers/facets_helper_spec.rb

@@ -120,7 +120,7 @@ describe FacetsHelper do
     it "should also work for facet query fields" do
       facet_config = double(:query => {})
       allow(helper).to receive(:facet_configuration_for_field).with('a_query_facet_field').and_return(facet_config)
-      allow(helper).to receive(:create_rsolr_facet_field_response_for_query_facet_field).with('a_query_facet_field', facet_config)
+      allow(helper).to receive(:create_facet_field_response_for_query_facet_field).with('a_query_facet_field', facet_config)
 
       helper.facet_by_field_name 'a_query_facet_field'
     end
@@ -238,6 +238,7 @@ describe FacetsHelper do
       allow(helper).to receive(:render).with(hash_including(:partial => 'facet_limit', 
                                                          :locals => { 
                                                             :solr_field => 'basic_field',
+                                                            :field_name => 'basic_field',
                                                             :facet_field => helper.blacklight_config.facet_fields['basic_field'],
                                                             :display_facet => @mock_facet  }
                                                         ))
@@ -382,7 +383,7 @@ describe FacetsHelper do
 
   describe "#facet_field_id" do
     it "should be the parameterized version of the facet field" do
-      expect(helper.facet_field_id double(field: 'some field')).to eq "facet-some-field"
+      expect(helper.facet_field_id double(key: 'some field')).to eq "facet-some-field"
     end
   end
 end

data/spec/lib/blacklight/configuration_spec.rb

@@ -84,14 +84,14 @@ describe "Blacklight::Configuration" do
       expect(@config.facet_fields).to_not include(@mock_facet)
     end
 
-    it "should not dup solr_response_model or solr_document_model" do
-      @config.solr_response_model = Blacklight::SolrResponse
-      @config.solr_document_model = SolrDocument
+    it "should not dup response_model or document_model" do
+      @config.response_model = Blacklight::SolrResponse
+      @config.document_model = SolrDocument
 
       config_copy = @config.inheritable_copy
 
-      expect(config_copy.solr_response_model).to eq Blacklight::SolrResponse
-      expect(config_copy.solr_document_model).to eq SolrDocument
+      expect(config_copy.response_model).to eq Blacklight::SolrResponse
+      expect(config_copy.document_model).to eq SolrDocument
     end
 
     it "should provide cloned copies of mutable data structures" do
@@ -213,25 +213,11 @@ describe "Blacklight::Configuration" do
         "another_field_facet" => {},
         "a_facet_field" => {},
         })
-      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
+      expect { |b| @config.add_index_field "*_facet", &b }.to yield_control.twice
 
-      it "should be true if the if condition is missing" do
-        expect(@config.add_facet_field("hidden", show: true).if).to eq true
-      end
+      expect(@config.index_fields.keys).to eq ["some_field_facet", "another_field_facet"]
     end
+
   end
   
   describe "add_index_field" do
@@ -275,6 +261,7 @@ describe "Blacklight::Configuration" do
 
       expect(@config.index_fields.keys).to eq ["some_field_display", "another_field_display"]
     end
+
   end
   
   describe "add_show_field" do
@@ -383,22 +370,8 @@ 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

data/spec/lib/blacklight/{solr/document → document}/dublin_core_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-describe "Blacklight::Solr::Document::DublinCore" do
+describe "Blacklight::Document::DublinCore" do
   before(:all) do
     @mock_class = Class.new do
-      include Blacklight::Solr::Document
+      include Blacklight::Document
     end
-    @mock_class.use_extension( Blacklight::Solr::Document::DublinCore )
+    @mock_class.use_extension( Blacklight::Document::DublinCore )
     @mock_class.field_semantics.merge!(
       :title => :title_display,
       :non_dc_title => :title_display
@@ -15,7 +15,7 @@ describe "Blacklight::Solr::Document::DublinCore" do
 
   it "should register all its export formats" do
     document = @mock_class.new
-    expect(Set.new(document.export_formats.keys)).to be_superset(Set.new([:oai_dc_xml,:dc_xml, :xml]))    
+    expect(document.export_formats.keys).to include :oai_dc_xml, :dc_xml, :xml   
   end
 
   it "should export oai_dc with the proper namespaces" do

data/spec/lib/blacklight/{solr/document → document}/email_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe "Blacklight::Solr::Document::Email" do
+describe "Blacklight::Document::Email" do
   before(:all) do
-    SolrDocument.use_extension( Blacklight::Solr::Document::Email )
+    SolrDocument.use_extension( Blacklight::Document::Email )
   end
   it "should only return values that are available in the field semantics" do
     doc = SolrDocument.new({:id=>"1234", :title_display=>"My Title"})

data/spec/lib/blacklight/{solr/document → document}/sms_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe "Blacklight::Solr::Document::Email" do
+describe "Blacklight::Document::Email" do
   before(:all) do
-    SolrDocument.use_extension( Blacklight::Solr::Document::Sms )
+    SolrDocument.use_extension( Blacklight::Document::Sms )
   end
   it "should only return values that are available in the field semantics" do
     doc = SolrDocument.new({:id=>"1234", :title_display=>"My Title", :author_display=>"Joe Schmoe"})