blacklight_advanced_search 5.1.3 → 5.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bff9b8e310bf1d4bc8712103ef0d4c3887662ebc
-  data.tar.gz: dde5a134cceff1ff2c419f28fdf5c17760b55186
+  metadata.gz: ff76b283a42b92cb447e1a22d9c1db3e06f9663e
+  data.tar.gz: b53695523cade9db3640aa233ef422ea90c1428b
 SHA512:
-  metadata.gz: c60a43939cf1b6f6acd6491b578d4d60dd4c2896261cd268284822e5b89eaec1f298d94aac23d32a87773f9430a2a98f20ac499277a38b62a1349446c54356da
-  data.tar.gz: 6a63d2ef79e82bd6184cac02a67008f2bf3fdf8301b952f66f6e1141422de6e1fae13e3736eafc87eb4deb6a768447b658e6a08f4ce03b27a46a94d972489462
+  metadata.gz: 29dd20956b18315dac983e2757cec1f9571c53e91c9530fad07a66e40c02d3f02fdff9036124fb33c9995c38cef82f67ac1bb6dfcb55c82c3b36e87c98ce63db
+  data.tar.gz: 0114f011d414f3900857f052530880a41faa2e592a313a4ba430743a24cd922fcad9b9a84010e2ecb43fc2c9247d18fb881ad807bd06044de4ac9c779d601c0c

data/VERSION

@@ -1 +1 @@
-5.1.3
+5.1.4

data/lib/blacklight_advanced_search/advanced_search_builder.rb

@@ -1,5 +1,10 @@
+require 'parslet'
+require 'parsing_nesting/tree'
 module BlacklightAdvancedSearch
   module AdvancedSearchBuilder
+
+    include Blacklight::SearchFields
+
     def is_advanced_search?
       (blacklight_params[:search_field] == self.blacklight_config.advanced_search[:url_key]) || blacklight_params[:f_inclusive]
     end
@@ -27,5 +32,49 @@ module BlacklightAdvancedSearch
         
       end
     end
+
+    # Different versions of Parslet raise different exception classes,
+    # need to figure out which one exists to rescue
+    @@parslet_failed_exceptions = if defined? Parslet::UnconsumedInput
+      [Parslet::UnconsumedInput]
+    else
+      [Parslet::ParseFailed]
+    end
+    
+    
+    # This method can be included in search_params_logic to have us
+    # parse an ordinary entered :q for AND/OR/NOT and produce appropriate
+    # Solr query.
+    #
+    # Note: For syntactically invalid input, we'll just skip the adv
+    # parse and send it straight to solr same as if advanced_parse_q
+    # were not being used. 
+    def add_advanced_parse_q_to_solr(solr_parameters)
+      unless scope.params[:q].blank?
+        field_def = search_field_def_for_key( scope.params[:search_field]) ||
+          default_search_field
+          
+                
+        # If the individual field has advanced_parse_q suppressed, punt
+        return if field_def[:advanced_parse] == false  
+          
+        solr_direct_params = field_def[:solr_parameters] || {}
+        solr_local_params = field_def[:solr_local_parameters] || {}
+        
+        # See if we can parse it, if we can't, we're going to give up
+        # and just allow basic search, perhaps with a warning.
+        begin
+          adv_search_params = ParsingNesting::Tree.parse(scope.params[:q], blacklight_config.advanced_search[:query_parser]).to_single_query_params( solr_local_params )
+
+          BlacklightAdvancedSearch.deep_merge!(solr_parameters, solr_direct_params)
+          BlacklightAdvancedSearch.deep_merge!(solr_parameters, adv_search_params)        
+        rescue *@@parslet_failed_exceptions => e
+          # do nothing, don't merge our input in, keep basic search
+          # optional TODO, display error message in flash here, but hard to 
+          # display a good one. 
+          return
+        end
+      end
+    end
   end
 end

data/lib/blacklight_advanced_search/parse_basic_q.rb

@@ -11,6 +11,9 @@ require 'parsing_nesting/tree'
 # in your CatalogController
 module BlacklightAdvancedSearch::ParseBasicQ
   extend ActiveSupport::Concern
+  extend Deprecation
+
+  self.deprecation_horizon = 'blacklight_advanced_search 6.0'
 
   include Blacklight::SearchFields
   
@@ -65,5 +68,6 @@ module BlacklightAdvancedSearch::ParseBasicQ
       end
     end
   end
+  deprecation_deprecate add_advanced_parse_q_to_solr: "use AdvancedSearchBuilder.add_advanced_parse_q_to_solr"
 
 end

data/spec/lib/advanced_search_builder_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe BlacklightAdvancedSearch::AdvancedSearchBuilder do
+
+  describe "#add_advanced_parse_q_to_solr" do
+
+    let(:blacklight_config) do
+      Blacklight::Configuration.new do |config|
+        config.advanced_search = { }
+        config.add_search_field "all_fields"
+        config.add_search_field "special_field" do |field|
+          field.advanced_parse = false
+        end
+      end
+    end
+
+    let!(:obj) do
+      class BACTestClass
+        cattr_accessor :blacklight_config
+        include Blacklight::SearchHelper
+        include BlacklightAdvancedSearch::AdvancedSearchBuilder
+        def initialize blacklight_config
+          self.blacklight_config = blacklight_config
+        end
+      end
+      BACTestClass.new blacklight_config
+    end
+
+    context "with basic functionality" do
+      let(:solr_params) { {} }
+
+      describe "a simple example" do
+        let(:params) { double("params", params: {:q => "one two AND three OR four"} ) }
+        before { allow(obj).to receive(:scope).and_return(params) }
+        it "catches the query" do
+          obj.add_advanced_parse_q_to_solr(solr_params) 
+          expect(solr_params[:defType]).to eq("lucene")
+          # We're not testing succesful parsing here, just that it's doing
+          # something that looks like we expect with subqueries. 
+          expect(solr_params[:q]).to start_with("_query_:")
+        end
+      end
+
+      describe "an unparseable example" do
+        let(:unparseable_q) { "foo bar\'s AND" }
+        let(:params) { double("params", params: {:q => unparseable_q} ) }
+        before { allow(obj).to receive(:scope).and_return(params) }
+        it "passes through" do
+          obj.add_advanced_parse_q_to_solr(solr_params)
+          expect(solr_params[:q]).to eq(unparseable_q)
+        end
+      end
+
+      context "when advanced_parse is false" do
+        let(:params) { double("params", params: { :search_field => "special_field", :q => "one two AND three OR four" } ) }
+        before { allow(obj).to receive(:scope).and_return(params) }
+        it "ignores fields" do
+          obj.add_advanced_parse_q_to_solr(solr_params)
+          expect(solr_params).not_to have_key(:q)
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/parsing_nesting/parse_basic_q_spec.rb

@@ -32,7 +32,7 @@ describe "NestingParser" do
   end
 
   describe "basic functionality" do
-    before do 
+    before do
       @blacklight_config = Blacklight::Configuration.new do |config|
         config.advanced_search = {
 
@@ -50,6 +50,7 @@ describe "NestingParser" do
     end
 
     it "catches a simple example" do
+      expect(Deprecation).to receive(:warn)
       solr_params = {}
       @obj.add_advanced_parse_q_to_solr(solr_params, :q => "one two AND three OR four") 
 
@@ -60,6 +61,7 @@ describe "NestingParser" do
     end
 
     it "passes through an unparseable example" do
+      expect(Deprecation).to receive(:warn)
       solr_params = {}
       unparseable_q = "foo bar\'s AND"
       @obj.add_advanced_parse_q_to_solr(solr_params, :q => unparseable_q)
@@ -68,6 +70,7 @@ describe "NestingParser" do
     end
 
     it "ignores field with advanced_parse=false" do
+      expect(Deprecation).to receive(:warn)
       solr_params = {}
       original_q = "one two AND three OR four"
       @obj.add_advanced_parse_q_to_solr(solr_params, 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_advanced_search
 version: !ruby/object:Gem::Version
-  version: 5.1.3
+  version: 5.1.4
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -165,6 +165,7 @@ files:
 - spec/features/blacklight_advanced_search_form_spec.rb
 - spec/helpers/advanced_helper_spec.rb
 - spec/integration/blacklight_stub_spec.rb
+- spec/lib/advanced_search_builder_spec.rb
 - spec/lib/deep_merge_spec.rb
 - spec/lib/filter_parser_spec.rb
 - spec/parsing_nesting/build_tree_spec.rb
@@ -203,6 +204,7 @@ test_files:
 - spec/features/blacklight_advanced_search_form_spec.rb
 - spec/helpers/advanced_helper_spec.rb
 - spec/integration/blacklight_stub_spec.rb
+- spec/lib/advanced_search_builder_spec.rb
 - spec/lib/deep_merge_spec.rb
 - spec/lib/filter_parser_spec.rb
 - spec/parsing_nesting/build_tree_spec.rb