blacklight_advanced_search 2.2.0 → 5.0.0

data/Gemfile

@@ -2,6 +2,8 @@ source 'http://rubygems.org'
 
 gemspec
 
+gem 'rails', '~> 4.0'
+
 group :test do
   gem "bootstrap-sass"
   gem 'turbolinks'
@@ -9,7 +11,13 @@ end
 
 gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
 gem 'sqlite3', platform: :ruby
+
+# These need to be listed here explicitly for engine_cart testing to work,
+# not really sure why the existing gemspec and Gemfile of test app aren't enough. 
 gem 'jquery-rails'
+gem 'blacklight_marc'
+gem 'sass-rails'
+
 
 if File.exists?('spec/test_app_templates/Gemfile.extra')
   eval File.read('spec/test_app_templates/Gemfile.extra'), nil, 'spec/test_app_templates/Gemfile.extra'

data/{README.rdoc → README.md}

@@ -1,13 +1,20 @@
 This is an advanced search plugin for Blacklight ( http://www.projectblacklight.org ).  
 
-== Blacklight version compatibility
+## Blacklight version compatibility
 
-This is a plugin for Blacklight: http://github.com/projectblacklight/blacklight
+This is a plugin for [Blacklight](http://github.com/projectblacklight/blacklight)
 
 It has been hard to keep track of which versions of `blacklight_advanced_search`
 work with which versions of `blacklight`. Some notes:
 
 * versions 5.x of Advanced Search plugin should work with Blacklight >= 5.1 and < 6 -- we now synchronize the _major_ version number between `blacklight` and `blacklight_advanced_search`.
+  * `blacklight_advanced_search` 5.x changes the URL query param format for advanced 'inclusive'
+     facet selections, from the advanced form. If you'd like to keep old-style possibly
+     bookmarked URLs working, by redirecting to new format, add this to your
+     `CatalogController`:
+      
+            before_filter BlacklightAdvancedSearch::RedirectLegacyParamsFilter, :only => :index
+
 * version 2.2 of `blacklight_advanced_search` should work with `blacklight` 4.x. 
 * versions `1.2.*` of Advanced Search plugin can work with blacklight 3.2.2 through latest 3.2.x
 * 1.2.0 was an aborted version, don't use it, if you did, re-do your configuration according to current instructions and delete any local ./app/controllers/advanced_controller.rb file. 
@@ -15,46 +22,45 @@ work with which versions of `blacklight`. Some notes:
 * 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:
+## Installation
 
-=== Blacklight 3.x/Rails 3
+### Blacklight 3.x/Rails 3
 
 Add to your application's Gemfile:
 
-   gem "blacklight_advanced_search"
+    gem "blacklight_advanced_search"
 
 then run 'bundle install'.  Then run:
 
-   rails generate blacklight_advanced_search
+    rails generate blacklight_advanced_search
 
 * The 'generate' command will install 'require' statements for the plugin's assets into your application's application.js/application.css asset pipeline files
 * 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  `include BlacklightAdvancedSearch::ParseBasicQ` in your CatalogController to enable AND/OR/NOT parsing even in ordinary search, this is not on by default.  
 
-== Accessing
+## Accessing
  
 The advanced search form will be available in your app at /advanced, and in your app using
 routing helper `advanced_search_path`. 
 
-  advanced_search_path
+    advanced_search_path
   
 You can also send the advanced search form url parameters representing a search, to have the form add on additional 'advanced' criteria to the search.  For example:
 
-  advanced_search_path( params )
+    advanced_search_path( params )
    
 By default there won't be any links in your application to the search form. If you've heavily customized your app, you can put them wherever you want as above. 
 
 However, especially if your app isn't much customized, the optional installer can write a localized Blacklight search form into your application with a 'more options' link to advanced. You may need to adjust your styles to make room for the new link, depending on what you've done with your app. 
 
 
+## Configuration
 
-== Configuration:
-
-If your application uses a single Solr qt request handler for all its search fields, then this plugin may work well with no configuration.  Nonetheless, configuration is available to change or improve behavior, or to use a separate Solr request handler for the advanced search plugin. Most configuration takes place in your ./app/controllers/catalog_controller.rb `configure_blacklight` block.
+If your application uses a single Solr qt request handler for all its search fields, then this plugin may work well with no configuration.  Nonetheless, configuration is available to change or improve behavior, or to use a separate Solr request handler for the advanced search plugin. Most configuration takes place in your `./app/controllers/catalog_controller.rb` `configure_blacklight` block.
 
 
-=== Expression parsing in ordinary search
+### Expression parsing in ordinary search
 
 Turn this feature on by adding to your CatalogController definition:
 
@@ -76,7 +82,7 @@ Due to limitations of the logic, sometimes these generated Solr queries may not
 
 If there'a a parse error trying to parse as boolean expression, it'll give up and pass the query on through same as it would without ParseBasicQ. 
 
-=== Search fields
+### Search fields
 
 Your main blacklight search fields are generally defined in CatalogController blacklight_config using `add_search_field`. They are all by default used in advanced search. 
 
@@ -89,10 +95,10 @@ If there are particular search fields in your main blacklight config you want ex
 
 If you want search fields ONLY available in advanced search, you can suppress them from ordinary search:
 
-   config.add_search_field("publisher") do |field|
+    config.add_search_field("publisher") do |field|
       field.include_in_simple_select = false
       field.solr_parameters = { :qf => "publisher_t" }        
-   end
+    end
 
 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:
  
@@ -115,30 +121,30 @@ Additionally, to make your advanced search solr requests more concise, you are s
 
 Within your solrconfig.xml you may then provide the appropriate custom configuration.
 
-  <requestHandler name="advanced" class="solr.SearchHandler" >
-    <lst name="defaults">
-      <!-- ... -->
-      <str name="qf_author">
-        author_1xx_unstem_search^200
-        author_7xx_unstem_search^50
-        author_8xx_unstem_search^10
-        author_1xx_search^20       vern_author_1xx_search^20
-        author_7xx_search^5        vern_author_7xx_search^5
-        author_8xx_search          vern_author_8xx_search
-      </str>
-      <str name="pf_author">
-        author_1xx_unstem_search^5000
-        author_7xx_unstem_search^3000
-        author_1xx_search^500        vern_author_1xx_search^500
-        author_7xx_search^300        vern_author_7xx_search^300
-        author_8xx_unstem_search^250
-        author_8xx_search^200        vern_author_8xx_search^200
-      </str>
-    </lst>
-  </requestHandler>
-
-
-=== Facets
+    <requestHandler name="advanced" class="solr.SearchHandler" >
+      <lst name="defaults">
+        <!-- ... -->
+        <str name="qf_author">
+          author_1xx_unstem_search^200
+          author_7xx_unstem_search^50
+          author_8xx_unstem_search^10
+          author_1xx_search^20       vern_author_1xx_search^20
+          author_7xx_search^5        vern_author_7xx_search^5
+          author_8xx_search          vern_author_8xx_search
+        </str>
+        <str name="pf_author">
+          author_1xx_unstem_search^5000
+          author_7xx_unstem_search^3000
+          author_1xx_search^500        vern_author_1xx_search^500
+          author_7xx_search^300        vern_author_7xx_search^300
+          author_8xx_unstem_search^250
+          author_8xx_search^200        vern_author_8xx_search^200
+        </str>
+      </lst>
+    </requestHandler>
+
+
+### Facets on advanced search form
 
 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]. 
 
@@ -149,42 +155,64 @@ By default, the advanced search form will show as limits whatever facets are con
         "facet.sort" => "index" # sort by byte order of values
       }
     }
- 
 
-=== Advanced Search Config Options
+Multiply selected advanced search form facets are combined with `or` (ie `any` or `union`). 
+
+The default advanced search form facet display is very much like Blacklight's
+sidebar facets (and uses some code straight from BL to render), but with checkboxes
+next to each value. 
+
+(IN PROGRESS) An alternate view using a multi-element HTML `select` is available, and can also
+be combined with [chosen.js](http://harvesthq.github.io/chosen/) for a fancy type-ahead style of UI.
+This can be especially useful if you want to offer many facet values at once on
+the form (beware, they are all still loaded in HTML, so this is probably good for
+at most hundreds, not thousands.)
+
+    config.advanced_search = {
+      # ...
+      :form_facet_partial => "advanced_search_facets_as_select"
+    }
+
+### Advanced Search Config Options
 
 Complete list of keys that can be supplied inside your configure_blacklight `advanced_search` block:
 
-[: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_solr_params[:qt]
-[: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]".
-[: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.  
-[:query_parser]
-  advanced searches are translated to solr nested queries, where the inner queries are of a dismax-type. 
+* :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_solr_params[:qt]
+* :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]".
+* :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.  
+* :query_parser
+  * advanced searches are translated to solr nested queries, where the inner queries are of a dismax-type. 
   By default, they are actually specifically 'dismax', but you can set :query_parser to 'edismax' instead. 
   This may make additional features available like * wildcards in advanced searches; but it may also
   cause some user query elements to be interpreted as operators for edismax when they
   were intended as literals. Somewhat experimental. See Github issues #11 and #14. 
 
+## Customizing the advanced search form
+
+Most of the labels on the advanced search form are [provided via Rails i18n](./config/locales), and can
+be customized in a local app i18n file. 
+
+Additionally, you can override the templates from this gem used to display the form. 
+We've tried to break it up into partials at the right granularity for over-riding
+in likely ways.  For one example, see the wiki page on [Adding a range limit to the advanced search form](https://github.com/projectblacklight/blacklight_advanced_search/wiki/Adding-a-range-limit-to-the-advanced-search-form).
+
 
-== Translation to Solr Query, technical details
+## Translation to Solr Query, technical details
 
 The code for mapping a user-entered query to a Solr query is called "nesting_parsing", and maps to a 'lucene' query parser query, with nested 'dismax' query parser queries. 
 
 Some technical details can be found in the nesting_parsing README: [https://github.com/projectblacklight/blacklight_advanced_search/tree/master/lib/parsing_nesting]
 
 You may also find the rspecs for parsing a user-entered query and converting it to Solr illumnating:
+
 1. Converting user-entered query to Solr: [https://github.com/projectblacklight/blacklight_advanced_search/blob/master/spec/parsing_nesting/to_solr_spec.rb]
 2. Parsing user-entered query to internal syntax tree: [https://github.com/projectblacklight/blacklight_advanced_search/blob/master/spec/parsing_nesting/build_tree_spec.rb]
  
-== Running tests
+## Running tests
 
-The Blacklight Advanced Search acceptance tests require a copy of the blacklight-jetty demo index. You can get a copy by running:
-  
-  git submodule init
-  git submodule update
 
 (Limited) test coverage is provided with rspec, run all tests (and start the jetty instance) by running:
    rake ci 
@@ -192,9 +220,7 @@ The Blacklight Advanced Search acceptance tests require a copy of the blacklight
 from the blacklight_advanced_search directory. Note: you may need to `bundle install` first. 
 
   
-== To Do
+## To Do
 
 * Alphabetical sorting of facet values returned by solr in count order (perhaps with limit). 
 * Parse for fielded search too like << title:"some title" >>.  'field:' that doesn't match an actual known field should be passed through same as now, while recognized fields should generate nested queries tied to those blacklight search types. 
-
-

data/Rakefile

@@ -13,7 +13,6 @@ require 'engine_cart/rake_task'
 
 require 'jettywrapper'
 require 'blacklight'
-import File.join(Blacklight.root, 'lib', 'railties', 'solr_marc.rake')
 
 task :default => :ci
 
@@ -25,7 +24,8 @@ end
   desc "Load fixtures"
   task :fixtures => ['engine_cart:generate'] do
     within_test_app do
-      system "rake solr:marc:index_test_data RAILS_ENV=test"
+      ENV['RAILS_ENV'] ||= 'test'
+      system "rake blacklight:solr:seed"
       abort "Error running fixtures" unless $?.success?
     end
   end

data/VERSION

@@ -1 +1 @@
-2.2.0
+5.0.0

data/app/assets/javascripts/blacklight_advanced_search.js

@@ -1,5 +1,5 @@
-// Master manifest file for engine, so local app can require
-// this one file, but get all our files -- and local app
-// require does not need to change if we change file list.
+// Yeah, this is empty right now. It used to have stuff. 
+// We're leaving it here, so if in future versions of advanced_search it has
+// stuff, existing apps will already be linked in. 
 
-//= require_tree './blacklight_advanced_search'
+//Is this a bad idea, it should just be removed? Not sure. 

data/app/assets/stylesheets/blacklight_advanced_search/advanced_results.css

@@ -2,40 +2,20 @@
 
 /* constraints */
 
+.inclusive_or.appliedFilter {
+  /* kinda lame, but we have to group the 'any' criteria somehow, as they are still
+   'and'd with facet and other criteria. It's got a bootstrap 'well' class
+   on it already. */
+  display: inline-block;
+  padding: 4px 8px;
+  margin: 0;
+}
+
 .inclusive_or .operator {
   margin-right: 1em;
 }
 
-.inclusive_or .appliedFilter {
-  background-color: #F0F0F0; 
-}
 
-/* making it match an h3 */
 #appliedParams .inclusive_or .operator {
-  font-weight: bold;  
-  color: #555555;
-  font-size: 108%;
-}
-
-/*  Facet limit */
-
-  /* over-ride BL */
-#facets .advanced_facet_limit ul {
-  border-bottom: none;
-  padding-bottom: 0;
-}
-
-
-.facet_limit .inclusive_or h4 {
-  margin-bottom: 0.5em;
-}
-
-.facet_limit .inclusive_or li {
-  margin-left: 1em;
-}
-
-/* optional link to search form */
-.search .advanced_search {
-  font-size: 83.33%; 
-}
-
+  font-weight: 500;  
+}

data/app/assets/stylesheets/blacklight_advanced_search/blacklight_advanced_search_styles.css.scss

@@ -1,10 +1,6 @@
 
 /* Random styles */
 
-form.advanced h4 select {
-  height: auto;
-  margin: 0;
-}
 
 
 form.advanced .adv_facet_selections {
@@ -14,10 +10,49 @@ form.advanced .adv_facet_selections {
   margin-top: 0.25em;
 }
 
+.advanced-search-form {
+  .query-criteria-heading {
+    // seems neccesary to get select menu to align okay, not sure why. 
+    vertical-align: bottom; 
+    margin-top: 0;
+  }
+
+
+  select.form-control.sort-select {
+    width: auto; // why does Bootstrap try to insist on explicit width? dunno. 
+    display: inline-block;
+  }
+
+  .query-criteria, .limit-criteria, .sort-submit-buttons {
+    margin-bottom: 4em;
+  }
 
-.advanced_help li {
-  margin-top: 0.5em;
-  margin-bottom: 0.5em;
 }
 
+.blacklight-advanced-facet-select {
+  // have to do some terribly complicated things with display:table and NESTED
+  // tables to add our checkbox and <label> element and still use display-table 
+  // to align everything. sorry!
+  .facet-checkbox, .label-and-count {
+    display: table-cell;
+  }
+
+  .label-and-count {
+    width: 100%;
+    padding-left: 1em;
+  }
+
+
+  label {
+    // a nested table, with existing from BL text and count as display:table-cell
+    // already. the "display:table-row" element is implicit and will be added
+    // by browser as a psuedo-element inside this label. 
+    display:table; 
+    width: 100%;
+    font-weight: normal;
+
+    margin: 0;
+    padding: 0;
+  }
+}
 

data/app/controllers/blacklight_advanced_search/advanced_controller.rb

@@ -19,9 +19,7 @@ class BlacklightAdvancedSearch::AdvancedController < CatalogController
       # 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 = params.except *adv_keys
       trimmed_params.delete(:f_inclusive) # adv facets
       
       search_context_params = solr_search_params(trimmed_params)

data/app/helpers/advanced_helper.rb

@@ -17,20 +17,24 @@ module AdvancedHelper
 
   # Is facet value in adv facet search results?
   def facet_value_checked?(field, value)
-    params[:f_inclusive] && params[:f_inclusive][field] && params[:f_inclusive][field][value]
+    BlacklightAdvancedSearch::QueryParser.new(params, blacklight_config).filters_include_value?(field, value)
+  end
+
+  def select_menu_for_field_operator
+    options = {
+      t('blacklight_advanced_search.all') => 'AND',
+      t('blacklight_advanced_search.any') => 'OR'
+    }.sort
+
+    return select_tag(:op, options_for_select(options,params[:op]), :class => 'input-small')
   end
 
   # Current params without fields that will be over-written by adv. search,
   # or other fields we don't want.
   def advanced_search_context
-    my_params = params.dup
-    [: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 |key, field_def|
-      my_params.delete( field_def[:key] )
-    end
-    my_params
+    my_params = params.except :page, :commit, :f_inclusive, :q, :search_field, :op, :action, :index, :sort, :controller, :utf8
+
+    my_params.except! *search_fields_for_advanced_search.map { |key, field_def| field_def[:key] }
   end
 
   def search_fields_for_advanced_search