blacklight_advanced_search 1.1.2 → 1.2.0

data/README.rdoc

@@ -2,11 +2,11 @@ This is an advanced search plugin for Blacklight ( http://www.projectblacklight.
 
 == Pre-requisites:
 * The Blacklight plugin ( http://github.com/projectblacklight/blacklight )
-  * NOTE: Blacklight 3.x is required for current version of Advanced Search plugin
+  * NOTE: Blacklight 3.2 is required for current version of Advanced Search plugin
+  * 1.1.x versions will work with older version of Blacklight 3.x
   * advanced search plugin latest 0.X.X version will work with Blacklight 2.9/Rails2. 
   * Older tagged versions of Advanced Search may work with even older BL. 
 
-
 == Installation:
 
 === Blacklight 3.x/Rails 3
@@ -17,34 +17,12 @@ Add to your application's Gemfile:
 then run 'bundle install'.  Then run:
    rails generate blacklight_advanced_search
 
-* The 'generate' command will copy some stylesheet/javascript assets to your local app (this architecture will likely change for Rails 3.1)
-* It will also OPTIONALLY install a config/initializers/blacklight_advanced_search.rb . Configuration in the initializer is optional, for many setups no configuration will be neccesary. See 'Configuration' section below.
+* The 'generate' command will install the plugin's assets into your application's application.js/application.css asset pipeline files
+* It will also generate AdvancedController into app/controllers/advanced_controller.rb, which you should configure for your local needs.
 * And it can optionally install a localized search form with a link to advanced search. If you've already localized your search form you'll want to do this manually instead. 
 
-You may want to set BlacklightAdvancedSearch.config[:advanced_parse_q] = true to enable AND/OR/NOT parsing even in ordinary search, this is not on by default.  
-
-=== Blacklight 2.x/Rails2
-
-Clone the advanced search plugin from github into your application's vendor/plugins directory , and switch
-to a version that works with BL 2.x/Rails2. 
-* cd into your application's vendor/plugins directory and run the following command:
- git clone http://github.com/projectblacklight/blacklight_advanced_search.git
- git checkout v0.12.0
+You may want to set `blacklight_config.advanced_search.advanced_parse_q = true` to enable AND/OR/NOT parsing even in ordinary search, this is not on by default.  
 
-You can later use standard git commands to update the plugin to a new version.   
-  
-You will now need to add a parslet gem dependency to your app, since blacklight_advanced_search is not currently a gem itself, you have to do this manually. Add "config.gem 'parslet'" to your config/environment.rb, and then run:
-
-  sudo rake gems:install
- 
-You can also now *optionally* run the installer script to install some optional example configuration files. In many cases, no configuration is needed for advanced search plugin to work. 
-* cd back to your application's root directory
- cd ../../
-* And then run the the following command:
- rake rails:template LOCATION=vendor/plugins/blacklight_advanced_search/template.rb
-
-You may want to set BlacklightAdvancedSearch.config[:advanced_parse_q] = true to enable AND/OR/NOT parsing even in ordinary search, this is not on by default.  
- 
 == Accessing
  
  
@@ -76,7 +54,7 @@ The optional installer script can install a sample blacklight_advanced_search.rb
 
 === Expression parsing in ordinary search
 
-If you turn on this feature with `BlacklightAdvancedSearch.config[:advanced_parse_q] = true`, then the plugin will intercept queries entered in ordinary Blacklight search interface, and parse them for AND/OR/NOT (and parens), producing appropriate Solr query. This allows single-field boolean expressions to be entered in ordinary search, providing a consistent experience with advanced search. 
+If you turn on this feature with `blacklight_config.advanced_search.advanced_parse_q = true`, then the plugin will intercept queries entered in ordinary Blacklight search interface, and parse them for AND/OR/NOT (and parens), producing appropriate Solr query. This allows single-field boolean expressions to be entered in ordinary search, providing a consistent experience with advanced search. 
 
 When this feature is turned on, queries that don't have any special operators (eg: AND, OR, NOT, parens) will still be passed to Solr much the same as they were before. But queries with special operators will have appropriate Solr queries generated for them, usually including nested "_query_" elements, to have the same meaning they would in advanced search. If a user enters something that is a syntax error for parsed search (for instance an unclosed phrase quote or paren), the logic will rescue from the parse erorr by running the exact user entered query direct to solr without advanced parsing. 
 
@@ -87,29 +65,28 @@ Due to limitations of the logic, sometimes these generated Solr queries may not
 Your main blacklight search fields are generally defined in config/blacklight_config.rb, under "config[:search_fields]" ( https://github.com/projectblacklight/blacklight/blob/master/config/initializers/blacklight_config.rb#L194 ). If there are particular search fields in your main blacklight config you want excluded from the advanced search form, you can set ":include_in_advanced_search => false"
 
 All advanced search fields must share the same Solr request handler (":qt"). As such, search fields that use a custom ":qt" parameter may not be re-used by the advanced search plugin. However, you may use a separate Solr request handler than the Blacklight default. If you would like the advanced search to use a different Solr request handler than your app's default, set:
-  BlacklightAdvancedSearch.config[:qt]
+  blacklight_config.advanced_search.qt
 to the name of the Solr request handler. 
 
 If you use a separate Solr request handler for advanced search, you must supply a completely separate list of search fields for the advanced search form. Each field is defined by a hash whose format is specified in Blacklight::SearchFields ( https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/search_fields.rb#L7 ). 
 
-  BlacklightAdvancedSearch.config[:search_fields] = []
-  BlacklightAdvancedSearch.config[:search_fields] << {
-    :key => 'title',
-    :solr_local_parameters => {
+  blacklight_config.search_fields.empty
+
+  blacklight_config.add_search_field('title') do |field|
+    field.solr_local_parameters => {
       :qf => "title_t subtitle_t addl_titles_t title_unstem_search^1000" # see ( http://wiki.apache.org/solr/DisMaxQParserPlugin#qf_.28Query_Fields.29 )
       :pf => "title_t subtitle_t addl_titles_t title_unstem_search^1000" # see ( http://wiki.apache.org/solr/DisMaxQParserPlugin#pf_.28Phrase_Fields.29 )
     }
-  }
+  end
 
 Additionally, to make your advanced search solr requests more concise, you are strongly encouraged to take advantage of the :local_solr_parameters option in your search field definition to use a solr parameter substitution with $variables. 
 
-  BlacklightAdvancedSearch.config[:search_fields] << {
-    :key => 'author'
-    :solr_local_parameters => {
+  blacklight_config.add_search_field('authot') do |field|
+    field.solr_local_parameters => {
       :qf=>"$qf_author",
       :pf=>"$pf_author"
     }
-  }
+  end
 
 Within your solrconfig.xml you may then provide the appropriate custom configuration.
 
@@ -140,24 +117,22 @@ Within your solrconfig.xml you may then provide the appropriate custom configura
 
 By default, the advanced search form will show as limits whatever facets are configured as default in your Solr request handler.  To have the advanced search form request specific facets and/or specific facet parameters, you can set config[:form_solr_parameters]. 
 
-  BlacklightAdvancedSearch.config[:form_solr_parameters] = {
+  blacklight_config.advanced_search.form_solr_parameters = {
     "facet.field" => ["format", "language_facet"],
     "facet.limit" => -1, # return all facet values
     "facet.sort" => "index" # sort by byte order of values
   }
  
 
-=== All Config Options
+=== Advanced Search Config Options
 
-[config[:qt]] 
+[:qt] 
    Solr request handler to use for any search that includes advanced search criteria. Defaults to what the application has set as Blacklight.config[:default_qt]
-[config[:url_key]]
+[:url_key]
    Key to use in application URLs to indicate advanced search is included in a query, defaults to "advanced". URLs will have "&search_field=[url key]".
-[config[:search_fields]]
-  Array of search field definitions to be used for advanced search. Each element in the array is a hash of the form required by Blacklight::SearchFields. If left blank, the plugin will use definitions from your main app Blacklight.config[:search_fields] -- only those which have no :qt set, and do not have :include_in_advanced_search => false. 
-[config[:form_solr_paramters]]
+[:form_solr_paramters]
   A hash of solr parameters which will be included in Solr request sent before display of advanced search form. Can be used to set facet parameters for advanced search form display.  
-[config[:advanced_parse_q]]
+[:advanced_parse_q]
   Set to 'true' to have AND/OR/NOT parsed even in ordinary 'simple' blacklight search, and converted to appropriate Solr query for that single field. 
 
 == Translation to Solr Query, technical details

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.2.0

data/app/assets/stylesheets/blacklight_advanced_search/{blacklight_advanced_search_styles.css → blacklight_advanced_search_styles.css.scss}

@@ -1,28 +1,4 @@
 
-/* Kind of wacky stuff to make scrolling on limit column work right. */
-
-.input_columns {
-  position: relative;
-}
-
-.limit_column {
-  position: absolute;
-  top: 0;
-  bottom: 0;
-  right: 0;
-  width: 49.1%;
-  overflow-y: hidden; 
-}
-
-.limit_input {
-  position: absolute;
-  top: 6em;
-  bottom: 0;
-  right: 0;
-  left: 0;
-  overflow-y: auto;
-}
-
 /* Random styles */
 
 .advanced_search_field label {

data/app/controllers/advanced_controller.rb

@@ -1,63 +1,8 @@
-# Need to sub-class CatalogController so we get all other plugins behavior
-# for our own "inside a search context" lookup of facets. 
-class AdvancedController < CatalogController
-  include AdvancedHelper # so we get the #advanced_search_context method
-  
-  before_filter :setup_advanced_search_assets, :only => :index
-  
-  def index
-    unless request.method==:post
-      @response = get_advanced_search_facets
-    end
-  end
-
-  protected
-  def get_advanced_search_facets
-    
-    search_context_params = {}
-    if (advanced_search_context.length > 0 )
-      # We have a search context, need to fetch facets from within
-      # that context -- but we dont' want to search within any
-      # existing :q or ADVANCED facets, so we remove those params.
-      adv_keys = BlacklightAdvancedSearch.config[:search_fields].collect {|d| d[:key].to_sym}
-      trimmed_params = params.reject do |k,v|        
-        adv_keys.include?(k.to_sym) # the individual q params
-      end
-      trimmed_params.delete(:f_inclusive) # adv facets
-      
-      search_context_params = solr_search_params(trimmed_params)
-      # Don't want to include the 'q' from basic search in our search
-      # context. Kind of hacky becuase solr_search_params insists on
-      # using controller.params, not letting us over-ride. 
-      search_context_params.delete(:q)
-      search_context_params.delete("q")
-      
-      # Also delete any facet-related params, or anything else
-      # we want to set ourselves or inherit from Solr request handler
-      # defaults. 
-      search_context_params.delete_if do |k, v|
-        k = k.to_s
-        (["facet.limit", "facet.sort", "f", "facets", "facet.fields", "qt", "per_page"].include?(k) ||                
-          k =~ /f\..+\.facet\.limit/ ||
-          k =~ /f\..+\.facet\.sort/
-        )        
-      end
-    end
-
-    input = HashWithIndifferentAccess.new
-    input.merge!( search_context_params )
-    input.merge!( :qt => BlacklightAdvancedSearch.config[:qt] , :per_page => 0)
-    input.merge!( BlacklightAdvancedSearch.config[:form_solr_parameters] )
-    input[:q] ||= '{!lucene}*:*'
-    
-    
-    find(input.to_hash)
-  end
-  def setup_advanced_search_assets
-    unless BlacklightAdvancedSearch.use_asset_pipeline?
-      stylesheet_links << ["blacklight_advanced_search_styles", {:plugin=>:blacklight_advanced_search}]
-      javascript_includes << ["blacklight_advanced_search_javascript", {:plugin=>:blacklight_advanced_search}]
-    end
-  end
-  
-end
+class AdvancedController < BlacklightAdvancedSearch::AdvancedController
+
+  blacklight_config.configure do |config|
+    config.advanced_search.form_solr_parameters ||= {}
+    config.advanced_search.url_key ||= 'advanced'
+  end
+
+end

data/app/controllers/blacklight_advanced_search/advanced_controller.rb

@@ -0,0 +1,58 @@
+# Need to sub-class CatalogController so we get all other plugins behavior
+# for our own "inside a search context" lookup of facets. 
+class BlacklightAdvancedSearch::AdvancedController < CatalogController
+  include AdvancedHelper # so we get the #advanced_search_context method
+
+  blacklight_config.configure do |config|
+    config.advanced_search ||= Blacklight::OpenStructWithHashAccess.new
+  end
+  
+  def index
+    unless request.method==:post
+      @response = get_advanced_search_facets
+    end
+  end
+
+  protected
+  def get_advanced_search_facets
+    
+    search_context_params = {}
+    if (advanced_search_context.length > 0 )
+      # We have a search context, need to fetch facets from within
+      # that context -- but we dont' want to search within any
+      # existing :q or ADVANCED facets, so we remove those params.
+      adv_keys = blacklight_config.search_fields.keys.map {|k| k.to_sym}
+      trimmed_params = params.reject do |k,v|        
+        adv_keys.include?(k.to_sym) # the individual q params
+      end
+      trimmed_params.delete(:f_inclusive) # adv facets
+      
+      search_context_params = solr_search_params(trimmed_params)
+      # Don't want to include the 'q' from basic search in our search
+      # context. Kind of hacky becuase solr_search_params insists on
+      # using controller.params, not letting us over-ride. 
+      search_context_params.delete(:q)
+      search_context_params.delete("q")
+      
+      # Also delete any facet-related params, or anything else
+      # we want to set ourselves or inherit from Solr request handler
+      # defaults. 
+      search_context_params.delete_if do |k, v|
+        k = k.to_s
+        (["facet.limit", "facet.sort", "f", "facets", "facet.fields", "qt", "per_page"].include?(k) ||                
+          k =~ /f\..+\.facet\.limit/ ||
+          k =~ /f\..+\.facet\.sort/
+        )        
+      end
+    end
+
+    input = HashWithIndifferentAccess.new
+    input.merge!( search_context_params )
+    input.merge!( :qt => blacklight_config.advanced_search[:qt] , :per_page => 0)
+    input.merge!( blacklight_config.advanced_search[:form_solr_parameters] )
+    input[:q] ||= '{!lucene}*:*'
+    
+    
+    find(input.to_hash)
+  end
+end

data/app/helpers/advanced_helper.rb

@@ -27,14 +27,14 @@ module AdvancedHelper
     [:page, :commit, :f_inclusive, :q, :search_field, :op, :action, :index, :sort, :controller].each do |bad_key|
       my_params.delete(bad_key)
     end
-    search_fields_for_advanced_search.each do |field_def|
+    search_fields_for_advanced_search.each do |key, field_def|
       my_params.delete( field_def[:key] )
     end
     my_params
   end
 
   def search_fields_for_advanced_search
-    BlacklightAdvancedSearch.config[:search_fields] || []
+    blacklight_config.search_fields
   end
   
 end

data/app/views/advanced/_advanced_search_facets.html.erb

@@ -1,16 +1 @@
-<% facet_field_names.each do |solr_fname| %>
-<div class="facet_item">
-  <% display_facet = @response.facets.detect {|f| f.name == solr_fname} -%>
-  <% # if it's NOT a refinement facet -- they are handled in get_refine_facet -%>
-  <% if display_facet && display_facet.items.length > 0 %>
-    <h3><%= facet_field_labels[solr_fname] -%> <span class="adv_facet_selections" style="display:none;"></span></h3>
-	<ul>
-      <% display_facet.items.each do |item| -%>
-        <li>
-          <%= check_box_tag "f_inclusive[#{solr_fname}][#{item.value.to_sym}]", 1, facet_value_checked?(solr_fname, item.value)%> <%= label_tag "f_inclusive_#{solr_fname}[#{item.value.to_sym}]", h(item.value) %> (<%= format_num item.hits %>)
-        </li>
-      <% end -%>
-    </ul>
-  <% end %>
-</div>
-<% end %>
+<%= render_facet_partials facet_field_names, :partial => 'facet_limit' %>

data/app/views/advanced/_advanced_search_fields.html.erb

@@ -1,6 +1,6 @@
-<%- BlacklightAdvancedSearch.search_field_list.each do |field_def| -%>
+<%- blacklight_config.search_fields.each do |key, field_def| -%>
   <div class="advanced_search_field">
-      <%= label_tag field_def[:key], "#{field_def[:display_label] }:" %>
-      <%= text_field_tag field_def[:key], label_tag_default_for(field_def[:key]) %>
+      <%= label_tag key, "#{field_def.label }:" %>
+      <%= text_field_tag key, label_tag_default_for(key) %>
   </div>
 <%- end -%>

data/app/views/advanced/_advanced_search_form.html.erb

@@ -4,8 +4,6 @@
 
   <div class="input_columns yui-g">
 	      
-    <div class="yui-u first">
-      
       <div class="query_column column">
         <h2>Find items that match <%= select_tag(:op, options_for_select({'all'=>'AND','any'=>'OR'}.sort,'all')) %> of the fields below:</h2>
         
@@ -13,21 +11,13 @@
           <%= render 'advanced/advanced_search_fields' %>
         </div>        
       </div>
-      
-    </div>
-  
-    <div class="yui-u">
-    
-      <div class="limit_column column">      
+           <div class="limit_column column">      
         <h2><strong>AND</strong> have these attributes:</h2>
       
         <div id="advanced_search_facets" class="limit_input">
           <%= render 'advanced_search_facets' %>
         </div>
       </div>
-    
-    </div>
-    
   </div>
   
   <% unless (search_context_str = render_search_to_s( advanced_search_context)).blank? %>
@@ -40,8 +30,8 @@
   
   <div class="sort_submit_buttons">
 	<%= label_tag(:sort, "Sort results by") %> 
-    <%= select_tag(:sort, options_for_select(Blacklight.config[:sort_fields],'')) %>
-	<%= hidden_field_tag(:search_field, BlacklightAdvancedSearch.config[:url_key]) %>
+    <%= select_tag(:sort, options_for_select(sort_fields, h(params[:sort]))) %>
+	<%= hidden_field_tag(:search_field, blacklight_config.advanced_search[:url_key]) %>
     <%= submit_tag 'Search', :class=>'advanced_button', :id=>'advanced_search' %>
 	<%= link_to "Start over", {:controller => "advanced", :action => "index"}, :class =>"reset advanced_button" %>
   </div>

data/app/views/advanced/_facet_layout.html.erb

@@ -0,0 +1,5 @@
+<div class="facet_item blacklight-<%= facet_field.field.parameterize %>">
+  <h3><%= facet_field.label -%> <span class="adv_facet_selections" style="display:none;"></span></h3>
+
+  <%= yield %>
+</div>

data/app/views/advanced/_facet_limit.html.erb

@@ -0,0 +1,7 @@
+<ul>
+  <% display_facet.items.each do |item| -%>
+  <li>
+     <%= check_box_tag "f_inclusive[#{solr_field}][#{item.value.to_sym}]", 1, facet_value_checked?(solr_field, item.value)%> <%= label_tag "f_inclusive_#{solr_field}[#{item.value.to_sym}]", h(item.value) %> (<%= format_num item.hits %>)
+  </li>
+  <% end -%>
+</ul>

data/app/views/blacklight_advanced_search/_facet_limit.html.erb

@@ -1,15 +1,3 @@
-<%-
-# Custom facet_limit partial that displays inclusive 'or' advanced facet
-# limits at the top, then lets you drill down into ordinary facets. 
-#
-# pass in :solr_field local. 
-#
-# Assumes an @advanced_query exists, and probably has #filters for this
-# solr_field. 
--%>
-
-<h3><%= facet_field_labels[solr_field] -%></h3>
-
 <div class="advanced_facet_limit">
   <div class="inclusive_or">
     <h4>Any of:</h4>
@@ -20,6 +8,4 @@
     </ul>
   </div>
   
-<%= render(:partial => "catalog/facet_limit", :locals => {:solr_field => solr_field, :display_heading => false}) %>
-
-</div>
+  <%= render_facet_limit display_facet, :layout => nil, :partial => 'catalog/facet_limit' %>

data/blacklight_advanced_search.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
 
 
   s.add_dependency "rails", "~> 3.0"
-  s.add_dependency "blacklight"
+  s.add_dependency "blacklight", "~> 3.2.1"
   s.add_dependency "parslet"
 end

data/lib/blacklight_advanced_search.rb

@@ -9,70 +9,4 @@ module BlacklightAdvancedSearch
   require 'blacklight_advanced_search/version'
   require 'blacklight_advanced_search/engine'
 
-  extend Blacklight::SearchFields # for search field config, so we can use same format as BL, or use ones already set in BL even. 
-    
-  # Has to be called in an after_initialize block, to have access
-  # to Blacklight.config already configured, to look at it for defaults. 
-  def self.init
-    # apply defaults to anything not set. 
-    BlacklightAdvancedSearch.config.reverse_merge!( BlacklightAdvancedSearch.config_defaults )
-    
-    logger.info("BlacklightAdvancedSearch.config: initialized with: #{ config.inspect }")
-    Blacklight.config[:search_fields] << {:display_label => 'Advanced', :key => BlacklightAdvancedSearch.config[:url_key], :include_in_simple_select => false, :include_in_advanced_search => false} unless Blacklight.config[:search_fields].map { |x| x[:key] }.include?  BlacklightAdvancedSearch.config[:url_key]
-  end
-
-  def self.logger
-    Rails.logger
-  end
-
-  # Hash of our config. The :search_fields key in hash is used by
-  # Blacklight::SearchFields module, must be an array of search field
-  # definitions compatible with that module, or if missing will
-  # inherit Blacklight.config[:search_fields]
-  def self.config
-    @config ||= {}
-  end  
-
-  # Has to be called in an after_initialize, to make sure Blacklight.config
-  # is already defined. 
-  def self.config_defaults
-   config = {}
-   config[:url_key] ||= "advanced"
-   config[:qt] ||= Blacklight.config[:default_qt] ||  
-      (Blacklight.config[:default_solr_params] && Blacklight.config[:default_solr_params][:qt])
-   config[:form_solr_parameters] ||= {}
-
-   
-   config[:search_fields] ||= Blacklight.config[:search_fields].find_all do |field_def|
-     (field_def[:qt].nil? || field_def[:qt] == config[:qt]) &&
-     field_def[:include_in_advanced_search] != false
-   end
-   
-   config
-  end
-  
-
-  def self.solr_local_params_for_search_field(key)
-  
-    field_def = search_field_def_for_key(key)
-
-    solr_params = (field_def[:solr_parameters] || {}).merge(field_def[:solr_local_parameters] || {})
-
-    solr_params.collect do |key, val|
-      key.to_s + "=" + solr_param_quote(val)
-    end.join(" ")
-    
-    end
-
-    def self.solr_param_quote(val)
-      unless val =~ /^[a-zA-Z$_\-\^]+$/
-        val = "'" + val.gsub("'", "\\\'").gsub('"', "\\\"") + "'"
-      end
-      return val
-    end
-    
-    def self.use_asset_pipeline?
-      (Rails::VERSION::MAJOR >= 3 and Rails::VERSION::MINOR >= 1) and Rails.application.config.assets.enabled
-    end
-
 end

data/lib/blacklight_advanced_search/advanced_query_parser.rb

@@ -27,10 +27,9 @@ module BlacklightAdvancedSearch
       unless(@keyword_queries)
         @keyword_queries = {}
 
-        return @keyword_queries unless @params[:search_field] == BlacklightAdvancedSearch.config[:url_key]
+        return @keyword_queries unless @params[:search_field] == ::AdvancedController.blacklight_config.advanced_search[:url_key]
         
-        @config[:search_fields].each do | field_def |
-          key = field_def[:key]
+        config.search_fields.each do | key, field_def |
           if ! @params[ key.to_sym ].blank?
             @keyword_queries[ key ] = @params[ key.to_sym ]
           end

data/lib/blacklight_advanced_search/catalog_helper_override.rb

@@ -19,13 +19,9 @@ module BlacklightAdvancedSearch::CatalogHelperOverride
 
   # Special display for facet limits that include adv search inclusive
   # or limits.
-  def render_facet_limit(solr_field)
-    unless (@advanced_query && @advanced_query.filters.keys.include?( solr_field))
-      super(solr_field)
-    else
-      # our own display
-      render(:partial => "blacklight_advanced_search/facet_limit", :locals=> {:solr_field => solr_field})
-    end
+  def facet_partial_name(display_facet = nil)
+    return "blacklight_advanced_search/facet_limit" if @advanced_query && @advanced_query.filters.keys.include?( display_facet.name )
+    super 
   end
 
   def remove_advanced_facet_param(field, value, my_params = params)
@@ -50,4 +46,4 @@ module BlacklightAdvancedSearch::CatalogHelperOverride
     my_params
   end
   
-end
+end

data/lib/blacklight_advanced_search/controller.rb

@@ -6,7 +6,7 @@ module BlacklightAdvancedSearch::Controller
   extend ActiveSupport::Concern
 
   included do
-    if BlacklightAdvancedSearch.config[:advanced_parse_q]
+    if blacklight_config[:advanced_parse_q]
       # Only to parse AND/OR in ordinary 'q'
       solr_search_params_logic << :add_advanced_parse_q_to_solr
     end
@@ -29,15 +29,15 @@ module BlacklightAdvancedSearch::Controller
     # map that to solr #q, over-riding whatever some other logic may have set, yeah.
     # the hint right now is :search_field request param is set to a magic
     # key.     
-    if (req_params[:search_field] == BlacklightAdvancedSearch.config[:url_key] ||
+    if (req_params[:search_field] == ::AdvancedController.blacklight_config.advanced_search[:url_key] ||
       req_params[:f_inclusive])
       # Set this as a controller instance variable, not sure if some views/helpers depend on it. Better to leave it as a local variable
       # if not, more investigation later.       
-      @advanced_query = BlacklightAdvancedSearch::QueryParser.new(req_params, BlacklightAdvancedSearch.config )
+      @advanced_query = BlacklightAdvancedSearch::QueryParser.new(req_params, ::AdvancedController.blacklight_config )
       deep_merge!(solr_parameters, @advanced_query.to_solr )
       if @advanced_query.keyword_queries.length > 0
         # force :qt if set
-        solr_parameters[:qt] = BlacklightAdvancedSearch.config[:qt] if BlacklightAdvancedSearch.config[:qt]
+        solr_parameters[:qt] = ::AdvancedController.blacklight_config.advanced_search[:qt]
         solr_parameters[:defType] = "lucene"        
       end
       
@@ -57,8 +57,8 @@ module BlacklightAdvancedSearch::Controller
   # were not being used. 
   def add_advanced_parse_q_to_solr(solr_parameters, req_params = params)
     unless req_params[:q].blank?
-      field_def = Blacklight.search_field_def_for_key( req_params[:search_field]) ||
-        Blacklight.default_search_field
+      field_def = search_field_def_for_key( req_params[:search_field]) ||
+        default_search_field
         
               
       # If the individual field has advanced_parse_q suppressed, punt

data/lib/blacklight_advanced_search/engine.rb

@@ -5,13 +5,6 @@ require 'rails'
 module BlacklightAdvancedSearch
   class Engine < Rails::Engine
   
-    config.after_initialize do
-      # After local app initializers that may set some config, we
-      # finish it off with defaults and normalization. 
-      BlacklightAdvancedSearch.init
-    end
-
-    
     # Do these things in a to_prepare block, to try and make them work
     # in development mode with class-reloading. The trick is we can't
     # be sure if the controllers we're modifying are being reloaded in

data/lib/blacklight_advanced_search/parsing_nesting_parser.rb

@@ -4,13 +4,13 @@ module BlacklightAdvancedSearch::ParsingNestingParser
   def process_query(params,config)
     queries = []
     keyword_queries.each do |field,query| 
-      queries << ParsingNesting::Tree.parse(query).to_query( local_param_hash(field)  )            
+      queries << ParsingNesting::Tree.parse(query).to_query( local_param_hash(field, config)  )            
     end
     queries.join( ' ' + keyword_op + ' ')
   end
   
-  def local_param_hash(key)
-    field_def = BlacklightAdvancedSearch.search_field_def_for_key(key)
+  def local_param_hash(key, config)
+    field_def = config.search_fields[key]
 
     (field_def[:solr_parameters] || {}).merge(field_def[:solr_local_parameters] || {})
   end

data/lib/blacklight_advanced_search/render_constraints_override.rb

@@ -12,7 +12,7 @@ module BlacklightAdvancedSearch::RenderConstraintsOverride
     else
       content = ""
       @advanced_query.keyword_queries.each_pair do |field, query|
-        label = BlacklightAdvancedSearch.search_field_def_for_key(field)[:display_label]
+        label = search_field_def_for_key(field)[:display_label]
         content << render_constraint_element(
           label, query,
           :remove =>
@@ -36,7 +36,7 @@ module BlacklightAdvancedSearch::RenderConstraintsOverride
 
     if (@advanced_query)
       @advanced_query.filters.each_pair do |field, value_list|
-        label = Blacklight.config[:facet][:labels][field] or field.to_s.capitalize
+        label = facet_field_labels[field]
         content << render_constraint_element(label, 
           value_list.join(" OR "),
           :remove => catalog_index_path( remove_advanced_filter_group(field, my_params) )
@@ -50,11 +50,11 @@ module BlacklightAdvancedSearch::RenderConstraintsOverride
   def render_search_to_s_filters(my_params)
     content = super(my_params)
     
-    advanced_query = BlacklightAdvancedSearch::QueryParser.new(my_params, BlacklightAdvancedSearch.config )
+    advanced_query = BlacklightAdvancedSearch::QueryParser.new(my_params, blacklight_config )
     
     if (advanced_query.filters.length > 0)
       advanced_query.filters.each_pair do |field, values|
-        label = Blacklight.config[:facet][:labels][field] or field.to_s.capitalize
+        label = facet_field_labels[field]
       
         content << render_search_to_s_element( 
           label,
@@ -68,14 +68,14 @@ module BlacklightAdvancedSearch::RenderConstraintsOverride
   def render_search_to_s_q(my_params)    
     content = super(my_params)
 
-    advanced_query = BlacklightAdvancedSearch::QueryParser.new(my_params, BlacklightAdvancedSearch.config )
+    advanced_query = BlacklightAdvancedSearch::QueryParser.new(my_params, blacklight_config )
 
     if (advanced_query.keyword_queries.length > 1 &&
         advanced_query.keyword_op == "OR")
         # Need to do something to make the inclusive-or search clear
 
         display_as = advanced_query.keyword_queries.collect do |field, query|
-          h( BlacklightAdvancedSearch.search_field_def_for_key(field)[:display_label] + ": " + query )
+          h( search_field_def_for_key(field)[:display_label] + ": " + query )
         end.join(" ; ")
         
         content << render_search_to_s_element("Any of",
@@ -84,7 +84,7 @@ module BlacklightAdvancedSearch::RenderConstraintsOverride
         )
     elsif (advanced_query.keyword_queries.length > 0) 
       advanced_query.keyword_queries.each_pair do |field, query|
-        label = BlacklightAdvancedSearch.search_field_def_for_key(field)[:display_label]
+        label = search_field_def_for_key(field)[:display_label]
 
         content << render_search_to_s_element(label, query)
       end    

data/lib/generators/blacklight_advanced_search/assets_generator.rb

@@ -1,45 +1,40 @@
-# Copy BlacklightAdvancedSearch assets to public folder in current app. 
-# If you want to do this on application startup, you can
-# add this next line to your one of your environment files --
-# generally you'd only want to do this in 'development', and can
-# add it to environments/development.rb:
-#       require File.join(BlacklightAdvancedSearch.root, "lib", "generators", "blacklight", "assets_generator.rb")
-#       BlacklightAdvancedSearch::AssetsGenerator.start(["--force", "--quiet"])
-
-
-# Need the requires here so we can call the generator from environment.rb
-# as suggested above. 
-require 'rails/generators'
-require 'rails/generators/base'
-module BlacklightAdvancedSearch
-  class AssetsGenerator < Rails::Generators::Base
-    source_root File.join(BlacklightAdvancedSearch::Engine.root, 'app', 'assets')
-
-    def assets
-      if BlacklightAdvancedSearch.use_asset_pipeline?
-        original_css = File.binread("app/assets/stylesheets/application.css")
-        if original_css.include?("require 'blacklight_advanced_search'")
-          say_status("skipped", "insert into app/assets/stylesheets/application.css", :yellow)
-        else        
-          insert_into_file "app/assets/stylesheets/application.css", :before => "*/" do
-            "\n *= require 'blacklight_advanced_search'\n\n"
-          end
-        end
-        
-        original_js = File.binread("app/assets/javascripts/application.js")
-        if original_js.include?("require 'blacklight_advanced_search'")
-          say_status("skipped", "insert into app/assets/javascripts/application.js", :yellow)
-        else
-          insert_into_file "app/assets/javascripts/application.js", :after => %r{//= require ['"]?jquery['"]?} do
-            "\n//= require 'blacklight_advanced_search'\n\n"
-          end
-        end
-      else
-        directory("stylesheets/blacklight_advanced_search", "public/stylesheets")
-        directory("javascripts/blacklight_advanced_search", "public/javascripts")        
-      end
-    end
-
-  end
-end
-
+# Copy BlacklightAdvancedSearch assets to public folder in current app. 
+# If you want to do this on application startup, you can
+# add this next line to your one of your environment files --
+# generally you'd only want to do this in 'development', and can
+# add it to environments/development.rb:
+#       require File.join(BlacklightAdvancedSearch.root, "lib", "generators", "blacklight", "assets_generator.rb")
+#       BlacklightAdvancedSearch::AssetsGenerator.start(["--force", "--quiet"])
+
+
+# Need the requires here so we can call the generator from environment.rb
+# as suggested above. 
+require 'rails/generators'
+require 'rails/generators/base'
+module BlacklightAdvancedSearch
+  class AssetsGenerator < Rails::Generators::Base
+    source_root File.join(BlacklightAdvancedSearch::Engine.root, 'app', 'assets')
+
+    def assets
+      original_css = File.binread("app/assets/stylesheets/application.css")
+      if original_css.include?("require 'blacklight_advanced_search'")
+        say_status("skipped", "insert into app/assets/stylesheets/application.css", :yellow)
+      else        
+        insert_into_file "app/assets/stylesheets/application.css", :before => "*/" do
+          "\n *= require 'blacklight_advanced_search'\n\n"
+        end
+      end
+      
+      original_js = File.binread("app/assets/javascripts/application.js")
+      if original_js.include?("require 'blacklight_advanced_search'")
+        say_status("skipped", "insert into app/assets/javascripts/application.js", :yellow)
+      else
+        insert_into_file "app/assets/javascripts/application.js", :after => %r{//= require ['"]?jquery['"]?$} do
+          "\n//= require 'blacklight_advanced_search'\n\n"
+        end
+      end
+    end
+
+  end
+end
+

data/lib/generators/blacklight_advanced_search/blacklight_advanced_search_generator.rb

@@ -8,10 +8,8 @@ class BlacklightAdvancedSearchGenerator < Rails::Generators::Base
     BlacklightAdvancedSearch::AssetsGenerator.start
   end
   
-  def install_config_file
-    if options[:force] or yes?("Install optional example Blacklight Advanced Search config file?")
-      copy_file("blacklight_advanced_search_config.rb", "config/initializers/blacklight_advanced_search.rb")
-    end
+  def install_local_controller
+    copy_file("advanced_controller.rb", "app/controllers/advanced_controller.rb")
   end
   
   def install_localized_search_form

data/lib/generators/blacklight_advanced_search/templates/advanced_controller.rb

@@ -0,0 +1,57 @@
+class AdvancedController < BlacklightAdvancedSearch::AdvancedController
+
+  blacklight_config.configure do |config|
+    # name of Solr request handler, leave unset to use the same one as your Blacklight.config[:default_qt]
+    config.advanced_search.qt = 'advanced'
+
+    ##
+    # The advanced search form displays facets as a limit option.
+    # By default it will use whatever facets, if any, are returned
+    # by the Solr qt request handler in use. However, you can use
+    # this config option to have it request other facet params than
+    # default in the Solr request handler, in desired.
+    config.advanced_search.form_solr_parameters = {}
+
+    # name of key in Blacklight URL, no reason to change usually.
+    config.advanced_search.url_key = 'advanced'
+
+    # We are going to completely override the inherited search fields
+    config.search_fields.clear
+
+    config.add_search_field 'author' do |field|
+      field.solr_local_parameters = {
+        :pf => "$pf_author",
+        :qf => "$qf_author"
+      }
+    end
+
+    config.add_search_field 'title' do |field|
+      field.solr_local_parameters = {
+        :pf => "$pf_title",
+        :qf => "$qf_title"
+      }
+    end
+
+    config.add_search_field 'subject' do |field|
+      field.solr_local_parameters = {
+        :pf => "$pf_subject",
+        :qf => "$qf_subject"
+      }
+    end
+
+    config.add_search_field 'keyword' do |field|
+      field.solr_local_parameters = {
+        :pf => "$pf_keyword",
+        :qf => "$qf_keyword"
+      }
+    end
+
+    config.add_search_field 'number' do |field|
+      field.solr_local_parameters = {
+        :pf => "$pf_number",
+        :qf => "$qf_number"
+      }
+    end
+  end
+
+end

metadata

@@ -1,76 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: blacklight_advanced_search
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  segments: 
-  - 1
-  - 1
-  - 2
-  version: 1.1.2
 platform: ruby
-authors: 
+authors:
 - Jonathan Rochkind
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-02 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152619380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: blacklight
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152619380
+- !ruby/object:Gem::Dependency
+  name: blacklight
+  requirement: &2152618720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: parslet
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152618720
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: &2152618160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *2152618160
 description: 
-email: 
+email:
 - blacklight-development@googlegroups.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - LICENSE
 - README.rdoc
@@ -80,13 +61,16 @@ files:
 - app/assets/javascripts/blacklight_advanced_search/blacklight_advanced_search_javascript.js
 - app/assets/stylesheets/blacklight_advanced_search.css
 - app/assets/stylesheets/blacklight_advanced_search/advanced_results.css
-- app/assets/stylesheets/blacklight_advanced_search/blacklight_advanced_search_styles.css
+- app/assets/stylesheets/blacklight_advanced_search/blacklight_advanced_search_styles.css.scss
 - app/controllers/advanced_controller.rb
+- app/controllers/blacklight_advanced_search/advanced_controller.rb
 - app/helpers/advanced_helper.rb
 - app/views/advanced/_advanced_search_facets.html.erb
 - app/views/advanced/_advanced_search_fields.html.erb
 - app/views/advanced/_advanced_search_form.html.erb
 - app/views/advanced/_advanced_search_help.html.erb
+- app/views/advanced/_facet_layout.html.erb
+- app/views/advanced/_facet_limit.html.erb
 - app/views/advanced/index.html.erb
 - app/views/blacklight_advanced_search/_facet_limit.html.erb
 - blacklight_advanced_search.gemspec
@@ -104,7 +88,7 @@ files:
 - lib/generators/blacklight_advanced_search/assets_generator.rb
 - lib/generators/blacklight_advanced_search/blacklight_advanced_search_generator.rb
 - lib/generators/blacklight_advanced_search/templates/_search_form.html.erb
-- lib/generators/blacklight_advanced_search/templates/blacklight_advanced_search_config.rb
+- lib/generators/blacklight_advanced_search/templates/advanced_controller.rb
 - lib/parsing_nesting/Readme.rdoc
 - lib/parsing_nesting/grammar.rb
 - lib/parsing_nesting/tree.rb
@@ -119,38 +103,29 @@ files:
 - uninstall.rb
 homepage: http://projectblacklight.org/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: blacklight
-rubygems_version: 1.7.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Blacklight Advanced Search plugin
-test_files: 
+test_files:
 - spec/lib/filter_parser_spec.rb
 - spec/parsing_nesting/build_tree_spec.rb
 - spec/parsing_nesting/consuming_spec.rb

data/lib/generators/blacklight_advanced_search/templates/blacklight_advanced_search_config.rb

@@ -1,86 +0,0 @@
-## 
-# This example config file is set up to work using the Solr request handler
-# called "advanced" in the example Blacklight solrconfig.xml:
-# http://github.com/projectblacklight/blacklight-jetty/blob/master/solr/conf/solrconfig.xml
-#
-# NOTE WELL: Using a seperate request handler is just one option, in most cases
-# it's simpler to use your default solr request handler set in Blacklight itself,
-# in which case you can delete/comment out this entire file!
-# See README. 
-
-BlacklightAdvancedSearch.config.merge!(
-  # :search_field => "advanced", # name of key in Blacklight URL, no reason to change usually.
-  
-  # Set advanced_parse_q to true to allow AND/OR/NOT in your basic/simple
-  # Blacklight search, parsed by Advanced Search Plugin. 
-  #:advanced_parse_q => true, 
-  
-  :qt => "advanced" # name of Solr request handler, leave unset to use the same one as your Blacklight.config[:default_qt]
-  
-)
-
-
-  # You don't need to specify search_fields, if you leave :qt unspecified
-  # above, and have search field config in Blacklight already using that
-  # same qt, the plugin will simply use them. But if you'd like to use a
-  # different solr qt request handler, or have another reason for wanting
-  # to manually specify search fields, you can. Uses the hash format
-  # specified in Blacklight::SearchFields
-
-  BlacklightAdvancedSearch.config[:search_fields] = search_fields = []
-  search_fields << {
-    :key =>  'author',
-    :solr_local_parameters => {
-      :pf => "$pf_author",
-      :qf => "$qf_author"
-    }
-  }
-  
-  search_fields << {
-    :key =>  'title',
-    :solr_local_parameters => {
-      :pf => "$pf_title",
-      :qf => "$qf_title"
-    }
-  }
-  
-  search_fields << {
-    :key =>  'subject',
-    :solr_local_parameters => {
-      :pf => "$pf_subject",
-      :qf => "$qf_subject"
-    }
-  }
-
-  search_fields << {
-    :key =>  'keyword',
-    :solr_local_parameters => {
-      :pf => "$pf_keyword",
-      :qf => "$qf_keyword"
-    }
-  }
-
-  search_fields << {
-    :key =>  'numbers',
-    :solr_local_parameters => {
-      :pf => "$pf_number",
-      :qf => "$qf_number"
-    }
-  }
-
-##
-# The advanced search form displays facets as a limit option.
-# By default it will use whatever facets, if any, are returned
-# by the Solr qt request handler in use. However, you can use
-# this config option to have it request other facet params than
-# default in the Solr request handler, in desired.
-
-# BlacklightAdvancedSearch.config[:form_solr_parameters] = {
-  # "facet.field" => [
-    # "format",
-    # "lc_1letter_facet",
-    # "language_facet"    
-  # ],
-  # "facet.limit" => -1,  # all facet values
-  # "facet.sort" => "index"  # sort by index value (alphabetically, more or less)
-# }