blacklight_advanced_search 6.0.2 → 6.1.0

data/lib/blacklight_advanced_search/catalog_helper_override.rb

@@ -1,53 +1,30 @@
 module BlacklightAdvancedSearch::CatalogHelperOverride
-
-  
-  
-  def remove_advanced_keyword_query(field, my_params = params)
-    my_params = my_params.dup
-    my_params.delete(field)
-    return my_params
-  end
-
-  def remove_advanced_filter_group(field, my_params = params)
-    if (my_params[:f_inclusive])
-      my_params = my_params.dup
-      my_params[:f_inclusive] = my_params[:f_inclusive].dup
-      my_params[:f_inclusive].delete(field)
-
-      if my_params[:f_inclusive].empty?
-        my_params.delete :f_inclusive
-      end
-    end
-    my_params
-  end
-
   # Special display for facet limits that include adv search inclusive
   # or limits.
   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 
+    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)
-    my_params = my_params.dup
-    if (my_params[:f_inclusive] && 
+    my_params = Blacklight::SearchState.new(my_params, blacklight_config).to_h
+    if (my_params[:f_inclusive] &&
         my_params[:f_inclusive][field] &&
         my_params[:f_inclusive][field].include?(value))
-        
+
       my_params[:f_inclusive] = my_params[:f_inclusive].dup
       my_params[:f_inclusive][field] = my_params[:f_inclusive][field].dup
       my_params[:f_inclusive][field].delete(value)
-      
-      my_params[:f_inclusive].delete(field) if my_params[:f_inclusive][field].length == 0
-      
-      my_params.delete(:f_inclusive) if my_params[:f_inclusive].length == 0      
+
+      my_params[:f_inclusive].delete(field) if my_params[:f_inclusive][field].empty?
+
+      my_params.delete(:f_inclusive) if my_params[:f_inclusive].empty?
     end
 
-    my_params.delete_if do |key, value| 
+    my_params.delete_if do |key, _value|
       [:page, :id, :counter, :commit].include?(key)
     end
-    
+
     my_params
   end
-  
 end

data/lib/blacklight_advanced_search/controller.rb

@@ -12,7 +12,7 @@ module BlacklightAdvancedSearch::Controller
     helper_method :is_advanced_search?, :advanced_query
   end
 
-  def is_advanced_search? req_params = params
+  def is_advanced_search?(req_params = params)
     (req_params[:search_field] == blacklight_config.advanced_search[:url_key]) ||
     req_params[:f_inclusive]
   end

data/lib/blacklight_advanced_search/filter_parser.rb

@@ -1,13 +1,11 @@
 module BlacklightAdvancedSearch::FilterParser
   # Returns an array of solr :fq params. taking advanced search inclusive
-  # facet value lists out of params. 
+  # facet value lists out of params.
   def generate_solr_fq
-      filter_queries = []
-      filters.each do |solr_field, value_list|
-        filter_queries << "#{solr_field}:(" +
-          value_list.collect {|v| '"' + v.gsub('"', '\"') +'"' }.join(" OR  ") +
-          ")"
-      end
-      return filter_queries
+    filters.map do |solr_field, value_list|
+      "#{solr_field}:(" +
+        Array(value_list).collect { |v| '"' + v.gsub('"', '\"') + '"' }.join(" OR  ") +
+        ")"
+    end
   end
-end
+end

data/lib/blacklight_advanced_search/parsing_nesting_parser.rb

@@ -1,18 +1,15 @@
 require 'parsing_nesting/tree'
 module BlacklightAdvancedSearch::ParsingNestingParser
-  
-  def process_query(params,config)
-    queries = []
-    keyword_queries.each do |field,query| 
-      queries << ParsingNesting::Tree.parse(query, config.advanced_search[:query_parser]).to_query( local_param_hash(field, config) )
+  def process_query(_params, config)
+    queries = keyword_queries.map do |field, query|
+      ParsingNesting::Tree.parse(query, config.advanced_search[:query_parser]).to_query(local_param_hash(field, config))
     end
-    queries.join( ' ' + keyword_op + ' ')
+    queries.join(" #{keyword_op} ")
   end
-  
+
   def local_param_hash(key, config)
     field_def = config.search_fields[key]
 
     (field_def[:solr_parameters] || {}).merge(field_def[:solr_local_parameters] || {})
   end
-  
 end

data/lib/blacklight_advanced_search/redirect_legacy_params_filter.rb

@@ -1,32 +1,30 @@
 # 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
+# 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)
 
-      def self.before(controller)
-        params = controller.send(:params)
+      if params[:f_inclusive] && params[:f_inclusive].respond_to?(:each_pair)
+        legacy_converted = false
 
-        if params[:f_inclusive] && params[:f_inclusive].respond_to?(:each_pair)
-          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
+        params[:f_inclusive].each_pair do |field, value|
+          next unless value.is_a? Hash
+          # old style! convert!
+          legacy_converted = true
+          params[:f_inclusive][field] = value.keys
+        end
 
-          if legacy_converted
-            controller.send(:redirect_to, params, :status => :moved_permanently) 
-          end
+        if legacy_converted
+          controller.send(:redirect_to, params, :status => :moved_permanently)
         end
       end
     end
-  end
+  end
+  end

data/lib/blacklight_advanced_search/render_constraints_override.rb

@@ -2,19 +2,18 @@
 # certain methods from RenderConstraintsHelper (newish in BL),
 # to effect constraints rendering and search history rendering,
 module BlacklightAdvancedSearch::RenderConstraintsOverride
-
   def query_has_constraints?(localized_params = params)
     if is_advanced_search? localized_params
       true
     else
-      !(localized_params[:q].blank? and localized_params[:f].blank? and localized_params[:f_inclusive].blank?)
+      !(localized_params[:q].blank? && localized_params[:f].blank? && localized_params[:f_inclusive].blank?)
     end
   end
 
-  #Over-ride of Blacklight method, provide advanced constraints if needed,
+  # Over-ride of Blacklight method, provide advanced constraints if needed,
   # otherwise call super.
   def render_constraints_query(my_params = params)
-    if (advanced_query.nil? || advanced_query.keyword_queries.empty? )
+    if (advanced_query.nil? || advanced_query.keyword_queries.empty?)
       return super(my_params)
     else
       content = []
@@ -28,58 +27,56 @@ module BlacklightAdvancedSearch::RenderConstraintsOverride
       end
       if (advanced_query.keyword_op == "OR" &&
           advanced_query.keyword_queries.length > 1)
-        content.unshift content_tag(:span, "Any of:", class:'operator')
+        content.unshift content_tag(:span, "Any of:", class: 'operator')
         content_tag :span, class: "inclusive_or appliedFilter well" do
           safe_join(content.flatten, "\n")
         end
       else
-        safe_join(content.flatten, "\n")    
+        safe_join(content.flatten, "\n")
       end
     end
   end
 
-  #Over-ride of Blacklight method, provide advanced constraints if needed,
+  # Over-ride of Blacklight method, provide advanced constraints if needed,
   # otherwise call super.
   def render_constraints_filters(my_params = params)
     content = super(my_params)
 
-    if (advanced_query)
+    if advanced_query
       advanced_query.filters.each_pair do |field, value_list|
         label = facet_field_label(field)
         content << render_constraint_element(label,
-          safe_join(value_list, " <strong class='text-muted constraint-connector'>OR</strong> ".html_safe),
-          :remove => search_action_path( remove_advanced_filter_group(field, my_params).except(:controller, :action) )
-          )
+          safe_join(Array(value_list), " <strong class='text-muted constraint-connector'>OR</strong> ".html_safe),
+          :remove => search_action_path(remove_advanced_filter_group(field, my_params).except(:controller, :action))
+                                            )
       end
     end
 
-    return content
+    content
   end
 
   # override of BL method, so our inclusive facet selections
   # are still recgonized for eg highlighting facet with selected
-  # values. 
+  # values.
   def facet_field_in_params?(field)
     return true if super
 
     # otherwise use our own logic.
-    query = BlacklightAdvancedSearch::QueryParser.new(params, self.blacklight_config )
-    if query.filters.keys.include?( field )
-      return true
-    end
+    query = BlacklightAdvancedSearch::QueryParser.new(params, self.blacklight_config)
+    return true if query.filters.keys.include?(field)
 
-    return false
+    false
   end
 
   def render_search_to_s_filters(my_params)
     content = super(my_params)
 
-    advanced_query = BlacklightAdvancedSearch::QueryParser.new(my_params, blacklight_config )
+    advanced_query = BlacklightAdvancedSearch::QueryParser.new(my_params, blacklight_config)
 
-    if (advanced_query.filters.length > 0)
+    unless advanced_query.filters.empty?
       advanced_query.filters.each_pair do |field, values|
         # old-style, may still be in history
-        values = values.keys if values.kind_of? Hash
+        values = values.keys if values.is_a? Hash
 
         label = facet_field_label(field)
 
@@ -89,27 +86,27 @@ module BlacklightAdvancedSearch::RenderConstraintsOverride
         )
       end
     end
-    return content
+    content
   end
 
   def render_search_to_s_q(my_params)
     content = super(my_params)
 
-    advanced_query = BlacklightAdvancedSearch::QueryParser.new(my_params, blacklight_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
+      # Need to do something to make the inclusive-or search clear
 
-        display_as = advanced_query.keyword_queries.collect do |field, query|
-          h( search_field_def_for_key(field)[:label] + ": " + query )
-        end.join(" ; ")
+      display_as = advanced_query.keyword_queries.collect do |field, query|
+        h(search_field_def_for_key(field)[:label] + ": " + query)
+      end.join(" ; ")
 
-        content << render_search_to_s_element("Any of",
-          display_as,
-          :escape_value => false
-        )
-    elsif (advanced_query.keyword_queries.length > 0)
+      content << render_search_to_s_element("Any of",
+        display_as,
+        :escape_value => false
+                                           )
+    elsif !advanced_query.keyword_queries.empty?
       advanced_query.keyword_queries.each_pair do |field, query|
         label = search_field_def_for_key(field)[:label]
 
@@ -117,7 +114,23 @@ module BlacklightAdvancedSearch::RenderConstraintsOverride
       end
     end
 
-    return content
+    content
+  end
+
+  def remove_advanced_keyword_query(field, my_params = params)
+    my_params = Blacklight::SearchState.new(my_params, blacklight_config).to_h
+    my_params.delete(field)
+    my_params
   end
 
+  def remove_advanced_filter_group(field, my_params = params)
+    if (my_params[:f_inclusive])
+      my_params = Blacklight::SearchState.new(my_params, blacklight_config).to_h
+      my_params[:f_inclusive] = my_params[:f_inclusive].dup
+      my_params[:f_inclusive].delete(field)
+
+      my_params.delete :f_inclusive if my_params[:f_inclusive].empty?
+    end
+    my_params
+  end
 end

data/lib/blacklight_advanced_search/version.rb

@@ -7,4 +7,3 @@ module BlacklightAdvancedSearch
     VERSION = self.version
   end
 end
-

data/lib/generators/blacklight_advanced_search/assets_generator.rb

@@ -1,4 +1,4 @@
-# Copy BlacklightAdvancedSearch assets to public folder in current app. 
+# 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
@@ -6,9 +6,8 @@
 #       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. 
+# as suggested above.
 require 'rails/generators'
 require 'rails/generators/base'
 module BlacklightAdvancedSearch
@@ -26,12 +25,11 @@ module BlacklightAdvancedSearch
       original_css = File.binread(application_css_location)
       if original_css.include?("require 'blacklight_advanced_search'")
         say_status("skipped", "insert into app/assets/stylesheets/application.css", :yellow)
-      else        
+      else
         insert_into_file application_css_location, :before => "*/" do
           "\n *= require 'blacklight_advanced_search'\n\n"
         end
       end
-
     end
 
     def js_asset
@@ -41,7 +39,7 @@ module BlacklightAdvancedSearch
         say_status "skipped", "Can not find an application.js, did not insert our require", :red
         return
       end
-      
+
       original_js = File.binread(application_js_location)
       if original_js.include?("require 'blacklight_advanced_search'")
         say_status("skipped", "insert into app/assets/javascripts/application.js", :yellow)
@@ -51,7 +49,5 @@ module BlacklightAdvancedSearch
         end
       end
     end
-
   end
 end
-

data/lib/generators/blacklight_advanced_search/blacklight_advanced_search_generator.rb

@@ -1,10 +1,8 @@
 require 'rails/generators'
 
 class BlacklightAdvancedSearchGenerator < Rails::Generators::Base
-
   def inject_asset_requires
     say "`rails g blacklight_advanced_search` is deprecated; use blacklight_advanced_search:install instead", :red
     generate "blacklight_advanced_search:install"
   end
-  
 end

data/lib/generators/blacklight_advanced_search/install_generator.rb

@@ -47,16 +47,20 @@ module BlacklightAdvancedSearch
     end
 
     def install_localized_search_form
-      if options[:force] or yes?("Install local search form with advanced link? (y/N)", :green)
+      if options[:force] || yes?("Install local search form with advanced link? (y/N)", :green)
         # We're going to copy the search from from actual currently loaded
-        # Blacklight into local app as custom local override -- but add our link at the end too. 
+        # Blacklight into local app as custom local override -- but add our link at the end too.
         source_file = File.read(File.join(Blacklight.root, "app/views/catalog/_search_form.html.erb"))
 
-        new_file_contents = source_file + "\n\n<%= link_to 'More options', blacklight_advanced_search_engine.advanced_search_path(params.except(:controller, :action)), class: 'advanced_search'%>"
+        new_file_contents = source_file + <<-EOF.strip_heredoc
+        \n\n
+        <div class="navbar-form">
+          <%= link_to 'More options', blacklight_advanced_search_engine.advanced_search_path(search_state.to_h), class: 'advanced_search btn btn-default'%>
+        </div>
+        EOF
 
-        create_file("app/views/catalog/_search_form.html.erb", new_file_contents)      
+        create_file("app/views/catalog/_search_form.html.erb", new_file_contents)
       end
     end
   end
-
 end

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

@@ -1,5 +1,4 @@
 class AdvancedController < BlacklightAdvancedSearch::AdvancedController
-
   blacklight_config.configure do |config|
     # name of Solr request handler, leave unset to use the same one your Blacklight
     # is ordinarily using (recommended if possible)
@@ -54,5 +53,4 @@ class AdvancedController < BlacklightAdvancedSearch::AdvancedController
       }
     end
   end
-
 end

data/lib/parsing_nesting/grammar.rb

@@ -1,78 +1,75 @@
 require 'rubygems'
 require 'parslet'
 
-# Parslet uses Object#tap, which is in ruby 1.8.7+, but not 1.8.6. 
+# Parslet uses Object#tap, which is in ruby 1.8.7+, but not 1.8.6.
 # But it's easy enough to implement in pure ruby, let's monkey patch
 # it in if it's not there, so we'll still work with 1.8.6
 unless Object.method_defined?(:tap)
   class Object
     def tap
       yield(self)
-      return self
+      self
     end
   end
 end
 module ParsingNesting
   class Grammar < Parslet::Parser
     root :query
-    
-    # query is actually a list of expressions. 
+
+    # query is actually a list of expressions.
     rule :query do
-      (spacing? >>  (expression | paren_unit ) >> spacing?).repeat
+      (spacing? >> (expression | paren_unit) >> spacing?).repeat
     end
-    
+
     rule :paren_list do
       (str('(') >> query >> str(')')).as(:list)
     end
-    
+
     rule :paren_unit do
-      (str('(') >> spacing? >> (expression ) >> spacing? >> str(')')) |
+      (str('(') >> spacing? >> expression >> spacing? >> str(')')) |
         paren_list
     end
-    
+
     # Note well: It was tricky to parse the thing we want where you can
     # have a flat list with boolean operators, but where 'OR' takes precedence.
     # eg "A AND B OR C AND C" or "A OR B AND C OR D". Tricky to parse at all,
     # tricky to make precedence work. Important things that seem to make it work:
     # and_list comes BEFORE or_list in :expression.
     # and_list's operand can be an or_list, but NOT vice versa
-    # There are others, it was an iterative process with testing. 
+    # There are others, it was an iterative process with testing.
     rule :expression do
-      (and_list | or_list | unary_expression )
+      (and_list | or_list | unary_expression)
     end
-      
+
     rule :and_list do
-      ((or_list | unary_expression | paren_unit) >> 
-        (spacing >> str("AND") >> spacing >> (or_list | unary_expression | paren_unit)).repeat(1)).as(:and_list) 
+      ((or_list | unary_expression | paren_unit) >>
+        (spacing >> str("AND") >> spacing >> (or_list | unary_expression | paren_unit)).repeat(1)).as(:and_list)
     end
-    
+
     rule :or_list do
-      ((unary_expression | paren_unit) >> 
-      (spacing >> str("OR") >> spacing >> (unary_expression | paren_unit)).repeat(1)).as(:or_list) 
+      ((unary_expression | paren_unit) >>
+      (spacing >> str("OR") >> spacing >> (unary_expression | paren_unit)).repeat(1)).as(:or_list)
     end
-      
+
     rule :unary_expression do
       (str('+') >> (phrase | token)).as(:mandatory) |
       (str('-') >> (phrase | token)).as(:excluded) |
       (str('NOT') >> spacing? >> (unary_expression | paren_unit)).as(:not_expression) |
       (phrase | token)
     end
-    
+
     rule :token do
       match['^ ")('].repeat(1).as(:token)
     end
     rule :phrase do
-      match('"') >> match['^"'].repeat(1).as(:phrase)  >> match('"')  
+      match('"') >> match['^"'].repeat(1).as(:phrase) >> match('"')
     end
-    
-    
+
     rule :spacing do
-      match[' '].repeat(1)    
+      match[' '].repeat(1)
     end
     rule :spacing? do
       spacing.maybe
     end
   end
-
-  
 end