blacklight_advanced_search 2.2.0 → 5.0.0

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

@@ -1,3 +1,16 @@
-<div class="facets-collapse" id="facets">
-<%= render_facet_partials facet_field_names %>
+<%# used to render facets with checkboxes on advanced search form,
+    we pretty much just use the built-in blacklight render_facet_partials
+    helper. 
+
+    But we've provided a local override of the _facet_limit
+    partial in our own `views/advanced/_facet_limit.html.erb`,
+    that is written to include checkboxes for form selection.
+
+    This is the default display of facets, but you can
+    also choose to use _advanced_search_facets_as_select,
+    for a chosen.js-compatible multi-select. 
+%>
+
+<div class="advanced-facet-limits panel-group">
+    <%= render_facet_partials facet_field_names %>
 </div>

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

@@ -0,0 +1,30 @@
+<%# alternate version of facets on form that renders using multi-select.
+    Has to copy and paste more code from blacklight than default, making
+    it somewhat more fragile. 
+
+    Logic taken from facets_helper_behavior.rb, #render_facet_partials and
+    #render_facet_limit. 
+%>
+
+<% facets_from_request(facet_field_names).each do |display_facet| %>
+    <% if should_render_facet?(display_facet) %>
+        <div class="form-group advanced-search-facet">
+            <%= label_tag display_facet.name.parameterize, :class => "col-sm-3 control-label" do %>
+                <%= facet_field_label(display_facet.name) %>
+            <% end %>            
+
+            <div class="col-sm-9">
+                <%= content_tag(:select, :multiple => true,                     
+                    :name   => "f_inclusive[#{display_facet.name}][]",
+                    :id     => display_facet.name.parameterize,
+                    :class  => "form-control advanced-search-facet-select") do %>
+                    <% display_facet.items.each do |facet_item| %>
+                        <%= content_tag :option, :value => facet_item.value, :selected => facet_value_checked?(display_facet.name, facet_item.value) do %>
+                            <%= facet_item.label %>&nbsp;&nbsp;(<%= number_with_delimiter facet_item.hits %>)
+                        <% end %>
+                    <% end %>
+                <% end %>
+            </div>
+        </div>        
+    <% end %>
+<% end %>

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

@@ -1,6 +1,8 @@
 <%- search_fields_for_advanced_search.each do |key, field_def| -%>
-  <div class="advanced_search_field">
-      <%= label_tag key, "#{field_def.label }:" %>
-      <%= text_field_tag key, label_tag_default_for(key), :class => 'input-block-level' %>
+  <div class="form-group advanced-search-field">
+      <%= label_tag key, "#{field_def.label }", :class => "col-sm-3 control-label" %>
+      <div class="col-sm-9">
+        <%= text_field_tag key, label_tag_default_for(key), :class => 'form-control' %>
+      </div>
   </div>
 <%- end -%>

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

@@ -1,42 +1,43 @@
-<%= form_tag catalog_index_path, :class => 'advanced', :method => :get do  %>
+  <% unless (search_context_str = render_search_to_s( advanced_search_context)).blank? %>
+    <div class="constraints well search_history">
+      <h4><%= t 'blacklight_advanced_search.form.search_context' %></h4>
+      <%= search_context_str %>
+    </div>
+  <% end %>
+
+<%= form_tag catalog_index_path, :class => 'advanced form-horizontal', :method => :get do  %>
 
-  <%= search_as_hidden_fields(:params => advanced_search_context ) %>
+  <%= render_hash_as_hidden_fields(params_for_search(advanced_search_context, {})) %>
 
-  <div class="input_columns row">
+  <div class="input-criteria">
 
-      <div class="query_column span6">
-        <h4>Find items that match <%= select_tag(:op, options_for_select({'all'=>'AND','any'=>'OR'}.sort,'all'), :class => 'input-small') %> of the fields below:</h4>
+      <div class="query-criteria">
+        <h3 class="query-criteria-heading">
+          <%= t('blacklight_advanced_search.form.query_criteria_heading_html', :select_menu =>  select_menu_for_field_operator ) %> 
+        </h3>
 
         <div id="advanced_search">
           <%= render 'advanced/advanced_search_fields' %>
         </div>
       </div>
-           <div class="limit_column offset1 span4">
-        <h4><strong>AND</strong> have these attributes:</h4>
+      
+      <div class="limit-criteria">
+        <h3 class="limit-criteria-heading"><%= t('blacklight_advanced_search.form.limit_criteria_heading_html')%></h3>
 
         <div id="advanced_search_facets" class="limit_input">
-          <%= render 'advanced_search_facets' %>
+          <% if blacklight_config.try(:advanced_search).try {|h| h[:form_facet_partial] } %>
+            <%= render blacklight_config.advanced_search[:form_facet_partial] %>
+          <% else %>
+            <%= render 'advanced_search_facets' %>
+          <% end %>
         </div>
       </div>
   </div>
 
-  <% unless (search_context_str = render_search_to_s( advanced_search_context)).blank? %>
-    <div class="constraints">
-      <h4>Within search:</h4>
-      <%= search_context_str %>
-    </div>
-  <% end %>
+  <hr>
 
-
-  <div class="sort_submit_buttons well clearfix">
-    <div class="pull-left">
-	<%= label_tag(:sort, "Sort results by") %>
-    <%= select_tag(:sort, options_for_select(sort_fields, h(params[:sort]))) %>
-	<%= hidden_field_tag(:search_field, blacklight_config.advanced_search[:url_key]) %>
-</div>
-<div class="pull-right">
-    <%= submit_tag 'Search', :class=>'btn btn-primary', :id=>'advanced_search' %>
-	<%= link_to "Start over", {:controller => "advanced", :action => "index"}, :class =>"reset btn" %>
-</div>
+  <div class="sort-submit-buttons clearfix">
+    <%= render 'advanced_search_submit_btns' %>
   </div>
+
 <% end %>

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

@@ -1,22 +1,24 @@
-<div>
-  <h2>Search tips</h2>
-  <ul class="advanced_help">
-   <li>Select "match all" to require all fields.
-   </li>
+<div class='panel panel-default'>
+  <div class="panel-heading">Search tips</div>
+  <div class="panel-body">
+    <ul class="advanced-help">
+     <li>Select "match all" to require all fields.
+     </li>
 
-   <li>Select "match any" to find at least one field.
-   </li>
+     <li>Select "match any" to find at least one field.
+     </li>
 
-   <li>Combine keywords and attributes to find specific items.
-   </li>
+     <li>Combine keywords and attributes to find specific items.
+     </li>
 
-   <li>Use quotation marks to search as a phrase. 
-   
-   <li>Use "+" before a term to make it required. (Otherwise results matching only some of your terms may be included).</li>
-   
-   <li>Use "-" before a word or phrase to exclude. 
+     <li>Use quotation marks to search as a phrase. 
+     
+     <li>Use "+" before a term to make it required. (Otherwise results matching only some of your terms may be included).</li>
+     
+     <li>Use "-" before a word or phrase to exclude. 
 
-   <li>Use "OR", "AND", and "NOT" to create complex boolean logic. You can use parentheses in your complex expressions. </li>
-   <li>Truncation and wildcards are not supported - word-stemming is done automatically.</li>
- </ul>
+     <li>Use "OR", "AND", and "NOT" to create complex boolean logic. You can use parentheses in your complex expressions. </li>
+     <li>Truncation and wildcards are not supported - word-stemming is done automatically.</li>
+   </ul>
+  </div>
 </div>

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

@@ -0,0 +1,12 @@
+      <div class="sort-buttons pull-left">    
+        <%= label_tag(:sort, t('blacklight_advanced_search.form.sort_label'), :class => "control-label") %>
+      
+        <%= select_tag(:sort, options_for_select(sort_fields, h(params[:sort])), :class => "form-control sort-select") %>
+        <%= hidden_field_tag(:search_field, blacklight_config.advanced_search[:url_key]) %>
+      </div>
+
+      <div class="submit-buttons pull-right">
+        <%= link_to t('blacklight_advanced_search.form.start_over'), advanced_search_path, :class =>"btn btn-default" %>
+
+        <%= submit_tag t('blacklight_advanced_search.form.search_btn'), :class=>'btn btn-primary advanced-search-submit', :id => "advanced-search-submit" %>
+      </div>

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

@@ -1,7 +1,15 @@
-<ul>
+<ul class="facet-values list-unstyled blacklight-advanced-facet-select">
   <% display_facet.items.each do |item| -%>
   <li>
-    <%= label_tag "f_inclusive_#{solr_field}[#{item.value.to_sym}]", (check_box_tag "f_inclusive[#{solr_field}][#{item.value.to_sym}]", 1, facet_value_checked?(solr_field, item.value)) + content_tag(:span, item.value, :class => 'facet-value') + " (#{number_with_delimiter item.hits})".html_safe, :class => 'checkbox' %>
+        <span class="facet-checkbox">
+            <%= check_box_tag "f_inclusive[#{solr_field}][]", item.value.to_sym, facet_value_checked?(solr_field, item.value), :id =>  "f_inclusive_#{solr_field}_#{item.value.parameterize}"%>
+        </span>
+
+        <span class="label-and-count">
+            <%= label_tag "f_inclusive_#{solr_field}_#{item.value.parameterize}"  do %>
+                <%= render_facet_value(solr_field, item, :suppress_link => true) %>  
+            <% end %>
+        <span>
   </li>
   <% end -%>
-</ul>
+</ul>

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

@@ -1,8 +1,21 @@
 <% @page_title = "More Search Options - #{application_name}" %>
-<script type="text/javascript">
-  $(document).ready(function(){$("form.advanced input:first").focus();});
-</script>
 
-<h1 class="advanced">More Search Options</h1>
-<%= render 'advanced_search_form' %>
-<%= render "advanced_search_help" %>
+<div class="advanced-search-form col-sm-12">
+
+    <h1 class="advanced page-header">
+        <%= t('blacklight_advanced_search.form.title') %>
+        <%= link_to t('blacklight_advanced_search.form.start_over'), advanced_search_path, :class =>"btn btn-default pull-right" %>
+    </h1>
+
+    <div class="row">
+
+        <div class="col-md-8">
+            <%= render 'advanced_search_form' %>
+        </div>
+        <div class="col-md-4">
+            <%= render "advanced_search_help" %>
+        </div>
+
+    </div>
+
+</div>

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

@@ -1,9 +1,14 @@
 <div class="advanced_facet_limit">
-  <div class="inclusive_or">
+  <div class="inclusive_or well">
     <h4>Any of:</h4>
-    <ul>
+    <ul class="list-unstyled facet-values">
     <% @advanced_query.filters[solr_field].each do |value| %>
-        <li><span class="selected"><%= h(value) %></span> <%= link_to(content_tag(:i, '', :class => "icon-remove") + content_tag(:span, '[remove]', :class => 'hide-text'), remove_advanced_facet_param(solr_field, value, params), :class=>"remove") %></li>
+        <li>
+            <span class="selected"><%= h(value) %></span> 
+            <%= link_to(remove_advanced_facet_param(solr_field, value, params), :class => "remove") do %>
+                <span class="glyphicon glyphicon-remove"></span><span class="sr-only">[remove]</span>
+            <% end %>
+        </li>
     <% end %>
     </ul>
   </div>

data/blacklight_advanced_search.gemspec

@@ -17,12 +17,16 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-
-  s.add_dependency "blacklight", "~> 4.0"
+  s.add_dependency "blacklight", ">= 5.1", "< 6.0"
   s.add_dependency "parslet"
 
+  s.add_development_dependency "blacklight_marc"
   s.add_development_dependency "rails"
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency 'jettywrapper', ">= 1.4.2"
-  s.add_development_dependency 'engine_cart'
+
+  # engine_cart 0.3 is out, but can't run tests if we're using it,
+  # not sure what we need to change to work with 0.3, possibly cbeer
+  # might know, in the meantime locking to 0.2.x. 
+  s.add_development_dependency 'engine_cart', "~> 0.2.2"
 end

data/config/locales/blacklight_advanced_search.en.yml

@@ -0,0 +1,12 @@
+en:
+  blacklight_advanced_search:
+    all: all
+    any: any
+    form:
+      title: More Search Options
+      search_context: Within search
+      limit_criteria_heading_html: "<strong>AND</strong> have these attributes"
+      query_criteria_heading_html: "Find items that match %{select_menu} of"
+      sort_label: "Sort results by"
+      start_over: "Start over"
+      search_btn: 'Search'

data/lib/blacklight_advanced_search.rb

@@ -6,10 +6,10 @@ module BlacklightAdvancedSearch
   autoload :ParsingNestingParser, 'blacklight_advanced_search/parsing_nesting_parser'
   autoload :FilterParser, 'blacklight_advanced_search/filter_parser'
   autoload :ParseBasicQ, 'blacklight_advanced_search/parse_basic_q'
+  autoload :RedirectLegacyParamsFilter, 'blacklight_advanced_search/redirect_legacy_params_filter'
 
   require 'blacklight_advanced_search/version'
   require 'blacklight_advanced_search/engine'
-
   
   # Utility method used in our solr search logic. 
   # Merges new_hash into source_hash, but will recursively
@@ -17,22 +17,33 @@ module BlacklightAdvancedSearch
   # or blank values from new_hash into source_hash, nil or blank values
   # in new_hash will not overwrite values in source_hash. 
   def self.deep_merge!(source_hash, new_hash)
-    source_hash.merge!(new_hash) do |key, old, new|
-      if new.respond_to?(:blank) && new.blank?
-        old        
-      elsif (old.kind_of?(Hash) and new.kind_of?(Hash))
-        deep_merge!(old, new)
-      elsif (old.kind_of?(Array) and new.kind_of?(Array))
-        old.concat(new).uniq
-      elsif new.nil?
-        # Allowing nil values to over-write on merge messes things up.
-        # don't set a nil value if you really want to force blank, set
-        # empty string. 
-        old
-      else
-        new
-      end
+    # We used to use built-in source_hash.merge() with a block arg
+    # to customize merge behavior, but that was breaking in some
+    # versions of BL/Rails where source_hash was a kind of HashWithIndifferentAccess,
+    # and hwia is unreliable in some versions of Rails. Oh well. 
+    # https://github.com/projectblacklight/blacklight/issues/827
+
+    new_hash.each_pair do |key, new_value|
+      old = source_hash.fetch(key, nil)
+
+      source_hash[key] =     
+        if new_value.respond_to?(:blank) && new.blank?
+          old        
+        elsif (old.kind_of?(Hash) and new_value.kind_of?(Hash))          
+          deep_merge!(old, new_value)
+          old
+        elsif (old.kind_of?(Array) and new_value.kind_of?(Array))
+          old.concat(new_value).uniq
+        elsif new_value.nil?
+          # Allowing nil values to over-write on merge messes things up.
+          # don't set a nil value if you really want to force blank, set
+          # empty string. 
+          old
+        else
+          new_value
+        end
     end
-  end
+    source_hash
+  end  
   
 end

data/lib/blacklight_advanced_search/advanced_query_parser.rb

@@ -1,34 +1,42 @@
 module BlacklightAdvancedSearch
+  # Can extract query elements from rails #params query params, and then parse
+  # them and convert them into a solr query with #to_solr
+  #
+  # #keyword_queries and #filters, which just return extracted elements of query
+  # params, may also be useful in display etc.
   class QueryParser
     include ParsingNestingParser # only one strategy currently supported. if BlacklightAdvancedSearch.config[:solr_type] == "parsing_nesting"
     include FilterParser
     attr_reader :config, :params
-    
+
     def initialize(params,config)
       @params = HashWithIndifferentAccess.new(params)
-      @config = config    
+      @config = config
     end
 
     def to_solr
       @to_solr ||= begin
         {
-          :q => process_query(params,config), 
-          :fq => generate_solr_fq() 
+          :q => process_query(params,config),
+          :fq => generate_solr_fq()
         }
       end
     end
-    
+
     # Returns "AND" or "OR", how #keyword_queries will be combined
     def keyword_op
       @params["op"] || "AND"
     end
-    # returns advanced-type keyword queries, see also keyword_op
+
+    # extracts advanced-type keyword query elements from query params,
+    # returns as a kash of field => query.
+    # see also keyword_op
     def keyword_queries
       unless(@keyword_queries)
         @keyword_queries = {}
 
         return @keyword_queries unless @params[:search_field] == ::AdvancedController.blacklight_config.advanced_search[:url_key]
-        
+
         config.search_fields.each do | key, field_def |
           if ! @params[ key.to_sym ].blank?
             @keyword_queries[ key ] = @params[ key.to_sym ]
@@ -37,24 +45,27 @@ module BlacklightAdvancedSearch
       end
       return @keyword_queries
     end
-    # returns just advanced-type filters
+
+    # extracts advanced-type filters from query params,
+    # returned as a hash of field => [array of values]
     def filters
       unless (@filters)
         @filters = {}
         return @filters unless @params[:f_inclusive]
-        @params[:f_inclusive].each_pair do |field, value_hash|
-          value_hash.each_pair do |value, type|
-            @filters[field] ||= []
-            @filters[field] << value
-          end
-        end        
+        @params[:f_inclusive].each_pair do |field, value_array|
+          @filters[field] ||= value_array.dup
+        end
       end
       return @filters
     end
 
+    def filters_include_value?(field, value)
+      filters[field.to_s].try {|array| array.include? value}
+    end
+
     def empty?
       filters.empty? && keyword_queries.empty?
     end
-    
+
   end
 end

data/lib/blacklight_advanced_search/redirect_legacy_params_filter.rb

@@ -0,0 +1,32 @@
+# Returns a lambda that you can use with a before_filter in your
+  # CatalogController to catch and redirect query params using the old
+  # style, used prior to blacklight_advanced_search 5.0.
+  #
+  # This can be used to keep any old bookmarked URLs still working. 
+  #
+  #     before_filter BlacklightAdvancedSearch::RedirectLegacyParamsFilter, :only => :index
+  #
+  module BlacklightAdvancedSearch
+    class RedirectLegacyParamsFilter
+
+      def self.before(controller)
+        params = controller.send(:params)
+
+        if params[:f_inclusive]
+          legacy_converted = false
+
+          params[:f_inclusive].each_pair do |field, value|
+            if value.kind_of? Hash
+              # old style! convert!
+              legacy_converted = true
+              params[:f_inclusive][field] = value.keys
+            end
+          end
+
+          if legacy_converted
+            controller.send(:redirect_to, params, :status => :moved_permanently) 
+          end
+        end
+      end
+    end
+  end