blacklight 6.0.0.pre1 → 6.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c84e27929bc5c308f60b44bf8308bd12fff0f611
-  data.tar.gz: 9fc7f3e715f61d045128e0eade0ee748f933779c
+  metadata.gz: 2d61d1d33a708476cbac51eba384b3ec074e06e0
+  data.tar.gz: 9d359464738928145735fb316c3a1dbb8b37fe19
 SHA512:
-  metadata.gz: 59a8e9e76e5bf91d854c742d98d357bd22040e9910661f164ea56ca41494dc28d18878533e71acaa0d29b0a272544f9a27af619b3f0b8cf8ca6da46f8c597f87
-  data.tar.gz: f68961e3673557464a4c67359812097453d707828d020a8cfbd7611a00912cb7c51aa53e80850c04f96bbf0745a3bbac537d7e09f97975dc2d53a803787d6f11
+  metadata.gz: 4409c43abb35028561d936081809525f8038f34ac8706a8838281e12396df98e4508a141224ea5db103b2a7b6f3f6206c9a5370c89ff987473426ae3ffda90d1
+  data.tar.gz: 6598923fcb1214614d65716faceb7b9da4fb2a540ab2ae91e22389df0fab211978b8e2e6cd11ffd9786afae93f0b3c6a68ae195640388ef00daf8ca80fbebeea

data/VERSION

@@ -1 +1 @@
-6.0.0.pre1
+6.0.0.pre2

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

@@ -0,0 +1,32 @@
+/*global Bloodhound */
+
+Blacklight.onLoad(function() {
+  'use strict';
+
+  $('[data-autocomplete-enabled="true"]').each(function() {
+    var $el = $(this);
+    var suggestUrl = $el.data().autocompletePath;
+    
+    var terms = new Bloodhound({
+      datumTokenizer: Bloodhound.tokenizers.obj.whitespace('value'),
+      queryTokenizer: Bloodhound.tokenizers.whitespace,
+      remote: {
+        url: suggestUrl + '?q=%QUERY',
+        wildcard: '%QUERY'
+      }
+    });
+    
+    terms.initialize();
+
+    $el.typeahead({
+      hint: true,
+      highlight: true,
+      minLength: 2
+    },
+    {
+      name: 'terms',
+      displayKey: 'term',
+      source: terms.ttAdapter()
+    });
+  });
+});

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

@@ -11,6 +11,7 @@
 //= require blacklight/search_context
 //= require blacklight/collapsable
 //= require blacklight/facet_load
+//= require blacklight/autocomplete
 //
 //Bootstrap JS for providing collapsable tablet/mobile menu/alert boxes
 //= require bootstrap/transition
@@ -19,6 +20,9 @@
 //= require bootstrap/alert
 //= require bootstrap/modal
 
+// Twitter Typeahead for autocomplete
+//= require twitter/typeahead
+
 /* Blacklight has a Javascript setup meant to support local disabling, 
   modification, and use of Blacklight behaviors. 
   

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

@@ -20,3 +20,4 @@
 @import "blacklight/facets";
 @import "blacklight/search_history";
 @import "blacklight/modal";
+@import "blacklight/twitter_typeahead";

data/app/assets/stylesheets/blacklight/_twitter_typeahead.scss

@@ -0,0 +1,30 @@
+.twitter-typeahead {
+  float: left;
+  width: 100%;
+  z-index: 10000;
+  
+  .tt-input.form-control {
+    width: 100%;
+  }
+  
+  .tt-hint.form-control {
+    width: 100%;
+  }
+
+  .tt-menu {
+    @extend .dropdown-menu;
+    font-family: $font-family-base;
+    width: 100%;
+  }
+
+  .tt-cursor {
+    background-color: $dropdown-link-hover-bg;
+    color: $dropdown-link-hover-color;
+    text-decoration: none;
+  }
+
+  .tt-suggestion {
+    font-size: 14px;
+    padding: 5px 5px 5px 10px;
+  }
+}

data/app/controllers/concerns/blacklight/catalog.rb

@@ -100,7 +100,7 @@ module Blacklight::Catalog
     end
 
     def action_success_redirect_path
-      blacklight_path.url_for_document(blacklight_config.document_model.new(id: params[:id]))
+      search_state.url_for_document(blacklight_config.document_model.new(id: params[:id]))
     end
 
     ##

data/app/controllers/concerns/blacklight/controller.rb

@@ -24,7 +24,7 @@ module Blacklight::Controller
     helper_method :has_user_authentication_provider?
     helper_method :blacklight_config, :blacklight_configuration_context
     helper_method :search_action_url, :search_action_path, :search_facet_url
-    helper_method :blacklight_path
+    helper_method :search_state
 
 
     # This callback runs when a user first logs in
@@ -64,9 +64,9 @@ module Blacklight::Controller
       has_user_authentication_provider? and current_user
     end
 
-    # @return [Blacklight::Path] a memoized instance of the parameter state.
-    def blacklight_path
-      @blacklight_path ||= Blacklight::Path.new(params, blacklight_config)
+    # @return [Blacklight::SearchState] a memoized instance of the parameter state.
+    def search_state
+      @search_state ||= Blacklight::SearchState.new(params, blacklight_config)
     end
 
     # Default route to the search action (used e.g. in global partials). Override this method

data/app/controllers/concerns/blacklight/suggest.rb

@@ -0,0 +1,24 @@
+module Blacklight
+  module Suggest
+    extend ActiveSupport::Concern
+
+    included do
+      include Blacklight::Configurable
+      include Blacklight::SearchHelper
+
+      copy_blacklight_config_from(CatalogController)
+    end
+
+    def index
+      respond_to do |format|
+        format.json do
+          render json: suggestions_service.suggestions
+        end
+      end
+    end
+
+    def suggestions_service
+      Blacklight::SuggestSearch.new(params, repository).suggestions
+    end
+  end
+end

data/app/controllers/concerns/blacklight/suggest_search.rb

@@ -0,0 +1,33 @@
+module Blacklight
+  class SuggestSearch
+    attr_reader :request_params, :repository
+    
+    ##
+    # @param [Hash] params
+    def initialize(params, repository)
+      @request_params = { q: params[:q] }
+      @repository = repository
+    end
+
+    ##
+    # For now, only use the q parameter to create a
+    # Blacklight::Suggest::Response
+    # @return [Blacklight::Suggest::Response]
+    def suggestions
+      Blacklight::Suggest::Response.new suggest_results, request_params, suggest_handler_path
+    end
+
+    ##
+    # Query the suggest handler using RSolr::Client::send_and_receive
+    # @return [RSolr::HashWithResponse]
+    def suggest_results
+      repository.connection.send_and_receive(suggest_handler_path, params: request_params)
+    end
+
+    ##
+    # @return [String]
+    def suggest_handler_path
+      repository.blacklight_config.autocomplete_path
+    end
+  end
+end

data/app/controllers/suggest_controller.rb

@@ -0,0 +1,3 @@
+class SuggestController < ApplicationController
+  include Blacklight::Suggest
+end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -138,7 +138,7 @@ module Blacklight::FacetsHelperBehavior
     if facet_config.url_method
       send(facet_config.url_method, facet_field, item)
     else
-      search_action_path(blacklight_path.add_facet_params_and_redirect(facet_field, item))
+      search_action_path(search_state.add_facet_params_and_redirect(facet_field, item))
     end
   end
 
@@ -146,7 +146,7 @@ module Blacklight::FacetsHelperBehavior
   # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
   # @params (see #render_facet_value)
   def render_selected_facet_value(facet_field, item)
-    remove_href = search_action_path(blacklight_path.remove_facet_params(facet_field, item))
+    remove_href = search_action_path(search_state.remove_facet_params(facet_field, item))
     content_tag(:span, class: "facet-label") do
       content_tag(:span, facet_display_value(facet_field, item), class: "selected") +
       # remove link

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -48,7 +48,7 @@ module Blacklight::RenderConstraintsHelperBehavior
   # @return [String]
   def render_constraints_filters(localized_params = params)
      return "".html_safe unless localized_params[:f]
-     path = Blacklight::Path.new(localized_params, blacklight_config)
+     path = Blacklight::SearchState.new(localized_params, blacklight_config)
      content = []
      localized_params[:f].each_pair do |facet,values|
        content << render_filter_element(facet, values, path)
@@ -61,7 +61,7 @@ module Blacklight::RenderConstraintsHelperBehavior
   # Render a single facet's constraint
   # @param [String] facet field
   # @param [Array<String>] values selected facet values
-  # @param [Blacklight::Path] path query parameters
+  # @param [Blacklight::SearchState] path query parameters
   # @return [String]
   def render_filter_element(facet, values, path)
     facet_config = facet_configuration_for_field(facet)

data/app/helpers/blacklight/suggest_helper_behavior.rb

@@ -0,0 +1,10 @@
+module Blacklight
+  module SuggestHelperBehavior
+    ##
+    # @return [Boolean] should autocomplete be enabled in the UI
+    def autocomplete_enabled?
+      blacklight_config.autocomplete_enabled.present? &&
+        blacklight_config.autocomplete_path.present?
+    end
+  end
+end

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -6,7 +6,7 @@ module Blacklight::UrlHelperBehavior
   # to provide more interesting routing to
   # documents
   def url_for_document(doc, options = {})
-    blacklight_path.url_for_document(doc, options)
+    search_state.url_for_document(doc, options)
   end
 
   # link_to_document(doc, 'VIEW', :counter => 3)
@@ -146,7 +146,7 @@ module Blacklight::UrlHelperBehavior
   # @param [Blacklight::SolrResponse::Group]
   # @return [Hash]
   def add_group_facet_params_and_redirect group
-    blacklight_path.add_facet_params_and_redirect(group.field, group.key, params)
+    search_state.add_facet_params_and_redirect(group.field, group.key, params)
   end
 
   # A URL to refworks export, with an embedded callback URL to this app. 

data/app/helpers/suggest_helper.rb

@@ -0,0 +1,3 @@
+module SuggestHelper
+  include Blacklight::SuggestHelperBehavior
+end

data/app/models/concerns/blacklight/suggest/response.rb

@@ -0,0 +1,26 @@
+module Blacklight
+  module Suggest
+    class Response
+      attr_reader :response, :request_params, :suggest_path
+
+      ##
+      # Creates a suggest response
+      # @param [RSolr::HashWithResponse] response
+      # @param [Hash] request_params
+      # @param [String] suggest_path
+      def initialize(response, request_params, suggest_path)
+        @response = response
+        @request_params = request_params
+        @suggest_path = suggest_path
+      end
+
+      ##
+      # Trys the suggestor response to return suggestions if they are
+      # present
+      # @return [Array]
+      def suggestions
+        response.try(:[], suggest_path).try(:[], 'mySuggester').try(:[], request_params[:q]).try(:[], 'suggestions') || []
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@
   </button>
   <ul class="dropdown-menu" role="menu">
     <%- per_page_options_for_select.each do |(label, count)| %>
-      <li><%= link_to(label, url_for(blacklight_path.params_for_search(per_page: count))) %></li>
+      <li><%= link_to(label, url_for(search_state.params_for_search(per_page: count))) %></li>
     <%- end -%>
   </ul>
 </div>

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

@@ -1,5 +1,5 @@
 <%= form_tag search_action_url, method: :get, class: 'search-query-form clearfix navbar-form', role: 'search' do %>
-  <%= render_hash_as_hidden_fields(blacklight_path.params_for_search.except(:q, :search_field, :qt, :page, :utf8)) %>
+  <%= render_hash_as_hidden_fields(search_state.params_for_search.except(:q, :search_field, :qt, :page, :utf8)) %>
   <div class="input-group">
     <% if search_fields.length > 1 %>
       <span class="input-group-addon for-search-field">
@@ -11,7 +11,7 @@
     <% end %>
 
     <label for="q" class="sr-only"><%= t('blacklight.search.form.search.label') %></label>
-    <%= text_field_tag :q, params[:q], placeholder: t('blacklight.search.form.search.placeholder'), class: "search_q q form-control", id: "q", autofocus: should_autofocus_on_search_box?  %>
+    <%= text_field_tag :q, params[:q], placeholder: t('blacklight.search.form.search.placeholder'), class: "search_q q form-control", id: "q", autofocus: should_autofocus_on_search_box?, data: { autocomplete_enabled: autocomplete_enabled?, autocomplete_path: blacklight.suggest_index_path }  %>
 
     <span class="input-group-btn">
       <button type="submit" class="btn btn-primary search-btn" id="search">

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

@@ -6,7 +6,7 @@
 
   <ul class="dropdown-menu" role="menu">
       <%- active_sort_fields.each do |sort_key, field_config| %>
-        <li><%= link_to(field_config.label, url_for(blacklight_path.params_for_search(sort: sort_key))) %></li>
+        <li><%= link_to(field_config.label, url_for(search_state.params_for_search(sort: sort_key))) %></li>
       <%- end -%>
   </ul>
 </div>

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

@@ -6,7 +6,7 @@
 
     <%- if params[:q] and params[:search_field] and params[:search_field] != blacklight_config.default_search_field.try(:key) -%>
       <li><%= t 'blacklight.search.zero_results.search_fields', :search_fields => search_field_label(params) %> - 
-      <%= link_to t('blacklight.search.zero_results.search_everything', field: blacklight_config.default_search_field.label), url_for(blacklight_path.params_for_search(search_field: blacklight_config.default_search_field.key)) %>
+      <%= link_to t('blacklight.search.zero_results.search_everything', field: blacklight_config.default_search_field.label), url_for(search_state.params_for_search(search_field: blacklight_config.default_search_field.key)) %>
       </li>
     <%- end %>
 

data/blacklight.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency "rsolr",     "~> 1.0.11"  # Library for interacting with rSolr.
   s.add_dependency "bootstrap-sass", "~> 3.2"
   s.add_dependency "deprecation"
+  s.add_dependency "twitter-typeahead-rails", '~> 0.11'
 
   s.add_development_dependency "solr_wrapper"
   s.add_development_dependency "rspec-rails", "~> 3.0"

data/config/routes.rb

@@ -6,4 +6,5 @@ Blacklight::Engine.routes.draw do
   put "saved_searches/save/:id",    :to => "saved_searches#save",    :as => "save_search"
   delete "saved_searches/forget/:id",  :to => "saved_searches#forget",  :as => "forget_search"
   post "saved_searches/forget/:id",  :to => "saved_searches#forget"
+  resources :suggest, only: :index, defaults: { format: 'json' }
 end

data/lib/blacklight.rb

@@ -4,10 +4,14 @@ require 'deprecation'
 require 'blacklight/utils'
 
 module Blacklight
-  autoload :Exceptions, 'blacklight/exceptions'
-  autoload :Path,       'blacklight/path'
-  autoload :Parameters, 'blacklight/parameters'
-  autoload :Routes, 'blacklight/routes'
+  autoload :AbstractRepository, 'blacklight/abstract_repository'
+  autoload :Configuration, 'blacklight/configuration'
+  autoload :Exceptions,  'blacklight/exceptions'
+  autoload :Parameters,  'blacklight/parameters'
+  autoload :Routes,      'blacklight/routes'
+  autoload :SearchBuilder, 'blacklight/search_builder'
+  autoload :SearchState, 'blacklight/search_state'
+  autoload :Solr, 'blacklight/solr'
 
   extend Deprecation
 

data/{app/models → lib}/blacklight/configuration.rb

@@ -3,18 +3,22 @@ module Blacklight
   # Blacklight::Configuration holds the configuration for a Blacklight::Controller, including
   # fields to display, facets to show, sort options, and search fields.
   class Configuration < OpenStructWithHashAccess
-    extend ActiveSupport::Autoload
-
-    eager_autoload do
-      autoload :ViewConfig
-      autoload :ToolConfig
-      autoload :Fields
-      autoload :Field
-      autoload :SolrField
-      autoload :SearchField
-      autoload :FacetField
-      autoload :SortField
-    end
+
+    
+    # Using required_dependency to work around Rails autoloading
+    # problems when developing blacklight. Without this, any change
+    # to this class breaks other classes in this namespace
+    
+    require_dependency 'blacklight/configuration/context'
+    require_dependency 'blacklight/configuration/view_config'
+    require_dependency 'blacklight/configuration/tool_config'
+    # XXX this isn't very pretty, but it works.
+    require_dependency 'blacklight/configuration/fields'
+    require_dependency 'blacklight/configuration/field'
+    require_dependency 'blacklight/configuration/solr_field'
+    require_dependency 'blacklight/configuration/search_field'
+    require_dependency 'blacklight/configuration/facet_field'
+    require_dependency 'blacklight/configuration/sort_field'
     include Fields
 
     # Set up Blacklight::Configuration.default_values to contain
@@ -208,14 +212,6 @@ module Blacklight
 
     def locate_search_builder_class
       ::SearchBuilder
-    rescue NameError => e
-      # If the NameError is a result of the SearchBuilder having a
-      # NameError (e.g. NoMethodError) within it then raise the error.
-      raise e if Object.const_defined? "::SearchBuilder"
-
-      # Otherwise the NameError was a result of not being able to find SearchBuilder
-      Deprecation.warn(Configuration, "Your application is missing the SearchBuilder. Have you run `rails generate blacklight:search_builder`? Falling back to Blacklight::Solr::SearchBuilder")
-      Blacklight::Solr::SearchBuilder
     end
 
     def facet_paginator_class

data/lib/blacklight/engine.rb

@@ -3,6 +3,7 @@ module Blacklight
     engine_name "blacklight"
 
     require 'bootstrap-sass'
+    require 'twitter-typeahead-rails'
 
     # BlacklightHelper is needed by all helpers, so we inject it
     # into action view base here. 

data/lib/blacklight/{path.rb → search_state.rb}

@@ -1,7 +1,7 @@
 module Blacklight
   # This class encapsulates the search state as represented by the query
   # parameters namely: :f, :q, :page, :per_page and, :sort
-  class Path
+  class SearchState
     include Blacklight::Facet
     attr_reader :blacklight_config # Must be called blacklight_config, because Blacklight::Facet calls blacklight_config.
     attr_reader :params

data/lib/blacklight/solr.rb

@@ -1,4 +1,8 @@
 module Blacklight
   module Solr
+    autoload :Repository, 'blacklight/solr/repository'
+    autoload :Request, 'blacklight/solr/request'
+    autoload :Response, 'blacklight/solr/response'
+    autoload :SearchBuilderBehavior, 'blacklight/solr/search_builder_behavior'
   end
-end
+end

data/{app/models → lib}/blacklight/solr/response.rb

@@ -1,15 +1,16 @@
 class Blacklight::Solr::Response < HashWithIndifferentAccess
   extend Deprecation
-  extend ActiveSupport::Autoload
 
-  eager_autoload do
-    autoload :PaginationMethods
-    autoload :Spelling
-    autoload :Facets
-    autoload :MoreLikeThis
-  end
-  autoload :GroupResponse
-  autoload :Group
+  # Using required_dependency to work around Rails autoloading
+  # problems when developing blacklight. Without this, any change
+  # to this class breaks other classes in this namespace
+  require_dependency 'blacklight/solr/response/pagination_methods'
+  require_dependency 'blacklight/solr/response/response'
+  require_dependency 'blacklight/solr/response/spelling'
+  require_dependency 'blacklight/solr/response/facets'
+  require_dependency 'blacklight/solr/response/more_like_this'
+  require_dependency 'blacklight/solr/response/group_response'
+  require_dependency 'blacklight/solr/response/group'
 
   include PaginationMethods
   include Spelling

data/lib/generators/blacklight/controller_generator.rb

@@ -29,7 +29,7 @@ module Blacklight
     end
 
     def inject_blacklight_routes
-      route <<-EOF
+      route <<-EOF.strip_heredoc
         concern :searchable, Blacklight::Routes::Searchable.new
 
         resource :catalog, only: [:index], as: 'catalog', path: '/catalog', controller: 'catalog' do

data/lib/generators/blacklight/models_generator.rb

@@ -24,7 +24,7 @@ This generator makes the following changes to your application:
     end
 
     def add_routes
-      route <<-EOF
+      route <<-EOF.strip_heredoc
         concern :exportable, Blacklight::Routes::Exportable.new
 
         resources :solr_documents, only: [:show], path: '/catalog', controller: 'catalog' do

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -180,5 +180,9 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # If there are more than this many search results, no spelling ("did you
     # mean") suggestion is offered.
     config.spell_max = 5
+
+    # Configuration for autocomplete suggestor
+    config.autocomplete_enabled = true
+    config.autocomplete_path = 'suggest'
   end
 end

data/lib/generators/blacklight/test_support_generator.rb

@@ -15,7 +15,7 @@ Generate blacklight testing configurations for blacklight's own tests, or for bl
     def alternate_controller
       copy_file "alternate_controller.rb", "app/controllers/alternate_controller.rb"
 
-      routing_code = <<-EOF
+      routing_code = <<-EOF.strip_heredoc
         resource :alternate, controller: 'alternate', only: [:index] do
           concerns :searchable
         end

data/solr/conf/schema.xml

@@ -314,6 +314,15 @@
       </analyzer>
     </fieldType>
 
+    <fieldType class="solr.TextField" name="textSuggest" positionIncrementGap="100">
+       <analyzer>
+          <tokenizer class="solr.KeywordTokenizerFactory"/>
+          <filter class="solr.StandardFilterFactory"/>
+          <filter class="solr.LowerCaseFilterFactory"/>
+          <filter class="solr.RemoveDuplicatesTokenFilterFactory"/>
+       </analyzer>
+    </fieldType>
+
     <!-- charFilter + WhitespaceTokenizer  -->
     <!--
     <fieldType name="text_char_norm" class="solr.TextField" positionIncrementGap="100" >
@@ -519,6 +528,7 @@
    <dynamicField name="*_sort" type="alphaOnlySort" indexed="true" stored="false" multiValued="false" />
    <dynamicField name="*_unstem_search" type="text_general" indexed="true" stored="false" multiValued="true" />
    <dynamicField name="*spell" type="textSpell" indexed="true" stored="false" multiValued="true" />
+   <dynamicField name="*suggest" type="textSuggest" indexed="true" stored="false" multiValued="true" />
 
    <!-- uncomment the following to ignore any fields that don't already match an existing 
         field name or dynamic field, rather than reporting them as an error. 
@@ -591,7 +601,10 @@
    <copyField source="subject_t" dest="opensearch_display"/>
    <copyField source="subject_addl_t" dest="opensearch_display"/>  
 
-
+   <!-- for suggestions -->
+   <copyField source="*_t" dest="suggest"/>
+   <copyField source="*_facet" dest="suggest"/>
+   
    <!-- Above, multiple source fields are copied to the [text] field. 
 	  Another way to map multiple source fields to the same 
 	  destination field is to use the dynamic field syntax. 

data/solr/conf/solrconfig.xml

@@ -387,5 +387,26 @@
       -->
   </searchComponent>
 
+  <searchComponent name="suggest" class="solr.SuggestComponent">
+    <lst name="suggester">
+      <str name="name">mySuggester</str>
+      <str name="lookupImpl">FuzzyLookupFactory</str>
+      <str name="suggestAnalyzerFieldType">textSuggest</str>
+      <str name="buildOnCommit">true</str>
+      <str name="field">suggest</str>
+    </lst>
+  </searchComponent>
+
+  <requestHandler name="/suggest" class="solr.SearchHandler" startup="lazy">
+    <lst name="defaults">
+      <str name="suggest">true</str>
+      <str name="suggest.count">5</str>
+      <str name="suggest.dictionary">mySuggester</str>
+    </lst>
+    <arr name="components">
+      <str>suggest</str>
+    </arr>
+  </requestHandler>
+
 </config>
 

data/spec/controllers/blacklight/base_spec.rb

@@ -4,13 +4,13 @@ describe Blacklight::Base do
   let(:controller) { (Class.new(ApplicationController) { include Blacklight::Base }).new }
   subject { controller}
 
-  describe "#blacklight_path" do
+  describe "#search_state" do
     let(:params) { double }
     before { allow(controller).to receive_messages(params: params) }
-    subject { controller.send(:blacklight_path) }
+    subject { controller.send(:search_state) }
 
     it "creates a path object" do
-      expect(subject).to be_kind_of Blacklight::Path
+      expect(subject).to be_kind_of Blacklight::SearchState
       expect(subject.params).to be params
     end
   end

data/spec/controllers/blacklight/suggest_search_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Blacklight::SuggestSearch do
+  let(:params) { {q: 'test'} }
+  let(:suggest_path) { 'suggest' }
+  let(:connection) { double('connection', send_and_receive: 'sent')}
+  let(:repository) { double('repository', connection: connection) }
+  let(:suggest_search) { described_class.new(params, repository)}
+  describe '#suggestions' do
+    it 'returns a Blacklight::Suggest::Response' do
+      expect(suggest_search).to receive(:suggest_results).and_return([])
+      expect(suggest_search).to receive(:suggest_handler_path).and_return(suggest_path)
+      expect(suggest_search.suggestions).to be_an Blacklight::Suggest::Response
+    end
+  end
+  describe '#suggest_results' do
+    it 'should call send_and_recieve from a repository connection' do
+      expect(suggest_search).to receive(:suggest_handler_path).and_return(suggest_path)
+      expect(suggest_search.suggest_results).to eq 'sent'
+    end
+  end
+end

data/spec/controllers/suggest_controller_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe SuggestController do
+  routes { Blacklight::Engine.routes }
+  describe 'GET index' do
+    it 'returns JSON' do
+      get :index, format: 'json'
+      expect(response.body).to eq [].to_json
+    end
+    it 'returns suggestions' do
+      get :index, format: 'json', q: 'new'
+      json = JSON.parse(response.body)
+      expect(json.count).to eq 3
+      expect(json.first['term']).to eq 'new jersey'
+    end
+  end
+end

data/spec/helpers/facets_helper_spec.rb

@@ -301,11 +301,11 @@ describe FacetsHelper do
 
   describe "render_facet_value" do
     let(:item) { double(:value => 'A', :hits => 10) }
-    let(:blacklight_path) { double(add_facet_params_and_redirect: { controller: 'catalog' }) }
+    let(:search_state) { double(add_facet_params_and_redirect: { controller: 'catalog' }) }
     before do
       allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(double(:query => nil, :date => nil, :helper_method => nil, :single => false, :url_method => nil))
       allow(helper).to receive(:facet_display_value).and_return('Z')
-      allow(helper).to receive(:blacklight_path).and_return(blacklight_path)
+      allow(helper).to receive(:search_state).and_return(search_state)
       allow(helper).to receive(:search_action_path) do |*args|
         search_catalog_path *args
       end

data/spec/helpers/render_constraints_helper_spec.rb

@@ -34,7 +34,7 @@ describe RenderConstraintsHelper do
     end
     subject { helper.render_filter_element('type', ['journal'], path) }
 
-    let(:path) { Blacklight::Path.new({:q=>'biz'}, config) }
+    let(:path) { Blacklight::SearchState.new({:q=>'biz'}, config) }
 
     it "should have a link relative to the current url" do
       expect(subject).to have_link "Remove constraint Item Type: journal", href: "/catalog?q=biz"

data/spec/helpers/suggest_helper_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe SuggestHelper do
+  before do
+    allow(helper).to receive(:blacklight_config).and_return(blacklight_config)
+  end
+  describe '#autocomplete_enabled?' do
+    describe 'with autocomplete config' do
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.configure do |config|
+          config.autocomplete_enabled = true
+          config.autocomplete_path = 'suggest'
+        end
+      end
+      it 'is enabled' do
+        expect(helper.autocomplete_enabled?).to be true
+      end
+    end
+    describe 'without disabled config' do
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.configure do |config|
+          config.autocomplete_enabled = false
+          config.autocomplete_path = 'suggest'
+        end
+      end
+      it 'is disabled' do
+        expect(helper.autocomplete_enabled?).to be false
+      end
+    end
+    describe 'without path config' do
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.configure do |config|
+          config.autocomplete_enabled = true
+        end
+      end
+      it 'is disabled' do
+        expect(helper.autocomplete_enabled?).to be false
+      end
+    end
+  end
+end

data/spec/lib/blacklight/{path_spec.rb → search_state_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Blacklight::Path do
+describe Blacklight::SearchState do
   let(:blacklight_config) do
     Blacklight::Configuration.new.configure do |config|
       config.index.title_field = 'title_display'

data/spec/models/blacklight/solr/search_builder_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Blacklight::Solr::SearchBuilder do
+describe Blacklight::Solr::SearchBuilderBehavior do
   let(:single_facet) { { format: 'Book' } }
   let(:multi_facets) { { format: 'Book', language_facet: 'Tibetan' } }
   let(:mult_word_query) { 'tibetan history' }
@@ -12,7 +12,12 @@ describe Blacklight::Solr::SearchBuilder do
 
   before { allow(context).to receive(:blacklight_config).and_return(blacklight_config) }
 
-  let(:search_builder) { described_class.new(context) }
+  let(:search_builder_class) do
+    Class.new(Blacklight::SearchBuilder) do
+      include Blacklight::Solr::SearchBuilderBehavior
+    end
+  end
+  let(:search_builder) { search_builder_class.new(context) }
 
   subject { search_builder.with(user_params) }
 
@@ -20,18 +25,18 @@ describe Blacklight::Solr::SearchBuilder do
     context "with two arguments" do
       subject do
         Deprecation.silence Blacklight::SearchBuilder do
-          described_class.new true, context
+          search_builder_class.new true, context
         end
       end
       it "uses the class-level default_processor_chain" do
-        expect(subject.processor_chain).to eq described_class.default_processor_chain
+        expect(subject.processor_chain).to eq search_builder_class.default_processor_chain
       end
     end
 
     context "with one arguments" do
-      subject { described_class.new context }
+      subject { search_builder }
       it "uses the class-level default_processor_chain" do
-        expect(subject.processor_chain).to eq described_class.default_processor_chain
+        expect(subject.processor_chain).to eq search_builder_class.default_processor_chain
       end
     end
   end
@@ -90,7 +95,7 @@ describe Blacklight::Solr::SearchBuilder do
     end
 
     context "when search_params_logic is customized" do
-      let(:search_builder) { described_class.new(method_chain, context) }
+      let(:search_builder) { search_builder_class.new(method_chain, context) }
       let(:method_chain) { [:add_foo_to_solr_params] }
 
       it "allows customization of search_params_logic" do

data/spec/models/blacklight/suggest/response_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Blacklight::Suggest::Response do
+  let(:empty_response) { described_class.new({}, { q: 'hello' }, 'suggest') }
+  let(:full_response) do
+    described_class.new(
+      {
+        'responseHeader' => {
+          'status' => 200
+        },
+        'suggest' => {
+          'mySuggester' => {
+            'new' => {
+              'numFound' => 3,
+              'suggestions' => [
+                {
+                  'term' => 'new jersey',
+                  'weight' => 3,
+                  'payload' => ''
+                },
+                {
+                  'term' => 'new jersey bridgeton biography',
+                  'weight' => 3,
+                  'payload' => ''
+                },
+                {
+                  'term' => 'new jersey bridgeton history',
+                  'weight' => 3,
+                  'payload' => ''
+                }
+              ]
+            }
+          }
+        }
+      },
+      {
+        q: 'new'
+      },
+      'suggest'
+    )
+  end
+
+  describe '#initialize' do
+    it 'creates a Blacklight::Suggest::Response' do
+      expect(empty_response).to be_an Blacklight::Suggest::Response
+    end
+  end
+  describe '#suggestions' do
+    it 'returns an array of suggestions' do
+      expect(full_response.suggestions).to be_an Array
+      expect(full_response.suggestions.count).to eq 3
+      expect(full_response.suggestions.first['term']).to eq 'new jersey'
+    end
+  end
+end

data/spec/support/controller_level_helpers.rb

@@ -2,8 +2,8 @@ module ControllerLevelHelpers
   module ControllerViewHelpers
     include Blacklight::Facet
 
-    def blacklight_path
-      @blacklight_path ||= Blacklight::Path.new(params, blacklight_config)
+    def search_state
+      @search_state ||= Blacklight::SearchState.new(params, blacklight_config)
     end
 
     def blacklight_configuration_context

data/tasks/blacklight.rake

@@ -42,7 +42,7 @@ namespace :blacklight do
   end
 
   desc 'Run Solr and Blacklight for interactive development'
-  task :server do
+  task :server, [:rails_server_args] do |t, args|
     if File.exists? EngineCart.destination
       within_test_app do
         system "bundle update"
@@ -56,7 +56,7 @@ namespace :blacklight do
         Rake::Task['blacklight:internal:seed'].invoke
 
         within_test_app do
-          system "bundle exec rails s"
+          system "bundle exec rails s #{args[:rails_server_args]}"
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 6.0.0.pre1
+  version: 6.0.0.pre2
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -123,6 +123,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: twitter-typeahead-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: solr_wrapper
   requirement: !ruby/object:Gem::Requirement
@@ -261,6 +275,7 @@ files:
 - app/assets/images/blacklight/logo.png
 - app/assets/images/favicon.ico
 - app/assets/javascripts/blacklight/ajax_modal.js
+- app/assets/javascripts/blacklight/autocomplete.js
 - app/assets/javascripts/blacklight/autofocus.js
 - app/assets/javascripts/blacklight/blacklight.js
 - app/assets/javascripts/blacklight/bookmark_toggle.js
@@ -282,6 +297,7 @@ files:
 - app/assets/stylesheets/blacklight/_pagination.scss
 - app/assets/stylesheets/blacklight/_search_history.scss
 - app/assets/stylesheets/blacklight/_search_results.scss
+- app/assets/stylesheets/blacklight/_twitter_typeahead.scss
 - app/assets/stylesheets/blacklight/blacklight.scss
 - app/assets/stylesheets/blacklight/blacklight_defaults.scss
 - app/controllers/bookmarks_controller.rb
@@ -296,8 +312,11 @@ files:
 - app/controllers/concerns/blacklight/search_context.rb
 - app/controllers/concerns/blacklight/search_fields.rb
 - app/controllers/concerns/blacklight/search_helper.rb
+- app/controllers/concerns/blacklight/suggest.rb
+- app/controllers/concerns/blacklight/suggest_search.rb
 - app/controllers/saved_searches_controller.rb
 - app/controllers/search_history_controller.rb
+- app/controllers/suggest_controller.rb
 - app/helpers/blacklight/blacklight_helper_behavior.rb
 - app/helpers/blacklight/catalog_helper_behavior.rb
 - app/helpers/blacklight/component_helper_behavior.rb
@@ -308,6 +327,7 @@ files:
 - app/helpers/blacklight/render_constraints_helper_behavior.rb
 - app/helpers/blacklight/render_partials_helper.rb
 - app/helpers/blacklight/search_history_constraints_helper_behavior.rb
+- app/helpers/blacklight/suggest_helper_behavior.rb
 - app/helpers/blacklight/url_helper_behavior.rb
 - app/helpers/blacklight_configuration_helper.rb
 - app/helpers/blacklight_helper.rb
@@ -319,31 +339,9 @@ files:
 - app/helpers/layout_helper.rb
 - app/helpers/render_constraints_helper.rb
 - app/helpers/search_history_constraints_helper.rb
-- app/models/blacklight/abstract_repository.rb
-- app/models/blacklight/configuration.rb
-- app/models/blacklight/configuration/context.rb
-- app/models/blacklight/configuration/facet_field.rb
-- app/models/blacklight/configuration/field.rb
-- app/models/blacklight/configuration/fields.rb
-- app/models/blacklight/configuration/search_field.rb
-- app/models/blacklight/configuration/solr_field.rb
-- app/models/blacklight/configuration/sort_field.rb
-- app/models/blacklight/configuration/tool_config.rb
-- app/models/blacklight/configuration/view_config.rb
+- app/helpers/suggest_helper.rb
 - app/models/blacklight/facet_paginator.rb
-- app/models/blacklight/search_builder.rb
 - app/models/blacklight/solr/facet_paginator.rb
-- app/models/blacklight/solr/repository.rb
-- app/models/blacklight/solr/request.rb
-- app/models/blacklight/solr/response.rb
-- app/models/blacklight/solr/response/facets.rb
-- app/models/blacklight/solr/response/group.rb
-- app/models/blacklight/solr/response/group_response.rb
-- app/models/blacklight/solr/response/more_like_this.rb
-- app/models/blacklight/solr/response/pagination_methods.rb
-- app/models/blacklight/solr/response/response.rb
-- app/models/blacklight/solr/response/spelling.rb
-- app/models/blacklight/solr/search_builder.rb
 - app/models/bookmark.rb
 - app/models/concerns/blacklight/configurable.rb
 - app/models/concerns/blacklight/document.rb
@@ -364,7 +362,7 @@ files:
 - app/models/concerns/blacklight/solr/document/more_like_this.rb
 - app/models/concerns/blacklight/solr/document/schema_org.rb
 - app/models/concerns/blacklight/solr/document/sms.rb
-- app/models/concerns/blacklight/solr/search_builder_behavior.rb
+- app/models/concerns/blacklight/suggest/response.rb
 - app/models/concerns/blacklight/token_based_user.rb
 - app/models/concerns/blacklight/user.rb
 - app/models/record_mailer.rb
@@ -472,14 +470,37 @@ files:
 - db/migrate/20140202020202_create_bookmarks.rb
 - db/migrate/20140320000000_add_polymorphic_type_to_bookmarks.rb
 - lib/blacklight.rb
+- lib/blacklight/abstract_repository.rb
+- lib/blacklight/configuration.rb
+- lib/blacklight/configuration/context.rb
+- lib/blacklight/configuration/facet_field.rb
+- lib/blacklight/configuration/field.rb
+- lib/blacklight/configuration/fields.rb
+- lib/blacklight/configuration/search_field.rb
+- lib/blacklight/configuration/solr_field.rb
+- lib/blacklight/configuration/sort_field.rb
+- lib/blacklight/configuration/tool_config.rb
+- lib/blacklight/configuration/view_config.rb
 - lib/blacklight/engine.rb
 - lib/blacklight/exceptions.rb
 - lib/blacklight/parameters.rb
-- lib/blacklight/path.rb
 - lib/blacklight/routes.rb
 - lib/blacklight/routes/exportable.rb
 - lib/blacklight/routes/searchable.rb
+- lib/blacklight/search_builder.rb
+- lib/blacklight/search_state.rb
 - lib/blacklight/solr.rb
+- lib/blacklight/solr/repository.rb
+- lib/blacklight/solr/request.rb
+- lib/blacklight/solr/response.rb
+- lib/blacklight/solr/response/facets.rb
+- lib/blacklight/solr/response/group.rb
+- lib/blacklight/solr/response/group_response.rb
+- lib/blacklight/solr/response/more_like_this.rb
+- lib/blacklight/solr/response/pagination_methods.rb
+- lib/blacklight/solr/response/response.rb
+- lib/blacklight/solr/response/spelling.rb
+- lib/blacklight/solr/search_builder_behavior.rb
 - lib/blacklight/utils.rb
 - lib/blacklight/version.rb
 - lib/generators/blacklight/assets_generator.rb
@@ -523,10 +544,12 @@ files:
 - spec/controllers/blacklight/facet_spec.rb
 - spec/controllers/blacklight/search_fields_spec.rb
 - spec/controllers/blacklight/search_helper_spec.rb
+- spec/controllers/blacklight/suggest_search_spec.rb
 - spec/controllers/bookmarks_controller_spec.rb
 - spec/controllers/catalog_controller_spec.rb
 - spec/controllers/saved_searches_controller_spec.rb
 - spec/controllers/search_history_controller_spec.rb
+- spec/controllers/suggest_controller_spec.rb
 - spec/features/alternate_controller_spec.rb
 - spec/features/bookmarks_spec.rb
 - spec/features/did_you_mean_spec.rb
@@ -550,9 +573,10 @@ files:
 - spec/helpers/layout_helper_spec.rb
 - spec/helpers/render_constraints_helper_spec.rb
 - spec/helpers/search_history_constraints_helper_spec.rb
+- spec/helpers/suggest_helper_spec.rb
 - spec/helpers/url_helper_spec.rb
 - spec/lib/blacklight/parameters_spec.rb
-- spec/lib/blacklight/path_spec.rb
+- spec/lib/blacklight/search_state_spec.rb
 - spec/lib/blacklight/utils_spec.rb
 - spec/lib/blacklight_spec.rb
 - spec/lib/tasks/blacklight_task_spec.rb
@@ -577,6 +601,7 @@ files:
 - spec/models/blacklight/solr/response/group_spec.rb
 - spec/models/blacklight/solr/response_spec.rb
 - spec/models/blacklight/solr/search_builder_spec.rb
+- spec/models/blacklight/suggest/response_spec.rb
 - spec/models/blacklight/user_spec.rb
 - spec/models/bookmark_spec.rb
 - spec/models/record_mailer_spec.rb
@@ -648,10 +673,12 @@ test_files:
 - spec/controllers/blacklight/facet_spec.rb
 - spec/controllers/blacklight/search_fields_spec.rb
 - spec/controllers/blacklight/search_helper_spec.rb
+- spec/controllers/blacklight/suggest_search_spec.rb
 - spec/controllers/bookmarks_controller_spec.rb
 - spec/controllers/catalog_controller_spec.rb
 - spec/controllers/saved_searches_controller_spec.rb
 - spec/controllers/search_history_controller_spec.rb
+- spec/controllers/suggest_controller_spec.rb
 - spec/features/alternate_controller_spec.rb
 - spec/features/bookmarks_spec.rb
 - spec/features/did_you_mean_spec.rb
@@ -675,9 +702,10 @@ test_files:
 - spec/helpers/layout_helper_spec.rb
 - spec/helpers/render_constraints_helper_spec.rb
 - spec/helpers/search_history_constraints_helper_spec.rb
+- spec/helpers/suggest_helper_spec.rb
 - spec/helpers/url_helper_spec.rb
 - spec/lib/blacklight/parameters_spec.rb
-- spec/lib/blacklight/path_spec.rb
+- spec/lib/blacklight/search_state_spec.rb
 - spec/lib/blacklight/utils_spec.rb
 - spec/lib/blacklight_spec.rb
 - spec/lib/tasks/blacklight_task_spec.rb
@@ -702,6 +730,7 @@ test_files:
 - spec/models/blacklight/solr/response/group_spec.rb
 - spec/models/blacklight/solr/response_spec.rb
 - spec/models/blacklight/solr/search_builder_spec.rb
+- spec/models/blacklight/suggest/response_spec.rb
 - spec/models/blacklight/user_spec.rb
 - spec/models/bookmark_spec.rb
 - spec/models/record_mailer_spec.rb

data/app/models/blacklight/solr/search_builder.rb

@@ -1,7 +0,0 @@
-module Blacklight::Solr
-  # @deprecated In 6.0 you should have this class generated into your application and Blacklight will
-  #             no longer need to provide it.
-  class SearchBuilder < Blacklight::SearchBuilder
-    include Blacklight::Solr::SearchBuilderBehavior
-  end
-end