Merge pull request #3768 from projectblacklight/revert-append

Revert "Remove unused methods"

Author: jrochkind

app/services/blacklight/search_service.rb

@@ -22,8 +22,10 @@ def search_state_class
       @search_state.class
     end
 
-    # a solr query method
-    # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used.
+    # Fetch query results from solr
+    # @yield [search_builder] optional block yields configured SearchBuilder,  caller can modify or create new
+    #                         SearchBuilder to be used. Block should return SearchBuilder to be used.
+    #                         This is used in blacklight_range_limit
     # @return [Blacklight::Solr::Response] the solr response object
     def search_results
       builder = search_builder.with(search_state)

lib/blacklight/search_builder.rb

@@ -19,6 +19,43 @@ def where(conditions)
       self
     end
 
+    ##
+    # Append additional processor chain directives
+    # This is used in blacklight_range_limit
+    def append(*addl_processor_chain)
+      params_will_change!
+      builder = self.class.new(processor_chain + addl_processor_chain, scope)
+                    .with(search_state)
+                    .merge(@merged_params)
+                    .reverse_merge(@reverse_merged_params)
+
+      builder.start = @start if @start
+      builder.rows  = @rows if @rows
+      builder.page  = @page if @page
+      builder.facet = @facet if @facet
+      builder
+    end
+
+    ##
+    # Converse to append, remove processor chain directives,
+    # returning a new builder that's a copy of receiver with
+    # specified change.
+    #
+    # Methods in argument that aren't currently in processor
+    # chain are ignored as no-ops, rather than raising.
+    def except(*except_processor_chain)
+      builder = self.class.new(processor_chain - except_processor_chain, scope)
+                    .with(search_state)
+                    .merge(@merged_params)
+                    .reverse_merge(@reverse_merged_params)
+
+      builder.start = @start if @start
+      builder.rows  = @rows if @rows
+      builder.page  = @page if @page
+      builder.facet = @facet if @facet
+      builder
+    end
+
     def start=(value)
       params_will_change!
       @start = value.to_i

spec/models/blacklight/search_builder_spec.rb

@@ -49,6 +49,29 @@
     end
   end
 
+  describe "#append" do
+    let(:processor_chain) { [:a, :b, :c] }
+
+    it "provides a new search builder with the processor chain" do
+      builder = subject.append(:d, :e)
+      expect(subject.processor_chain).to eq processor_chain
+      expect(builder.processor_chain).not_to eq subject.processor_chain
+      expect(builder.processor_chain).to contain_exactly(:a, :b, :c, :d, :e)
+    end
+  end
+
+  describe "#except" do
+    let(:processor_chain) { [:a, :b, :c, :d, :e] }
+
+    it "provide a new search builder excepting arguments" do
+      builder = subject.except(:b, :d, :does_not_exist)
+      expect(builder).not_to equal(subject)
+      expect(subject.processor_chain).to eq processor_chain
+      expect(builder.processor_chain).not_to eq subject.processor_chain
+      expect(builder.processor_chain).to contain_exactly(:a, :c, :e)
+    end
+  end
+
   describe "#to_hash" do
     it "updates if data is changed" do
       subject.merge(q: 'xyz')
@@ -224,6 +247,11 @@
       expect(subject.send(:params_changed?)).to be true
     end
 
+    it "is marked as changed when the processor chain changes" do
+      subject.append(:a)
+      expect(subject.send(:params_changed?)).to be true
+    end
+
     it "is marked as changed when merged parameters are added" do
       subject.merge(a: 1)
       expect(subject.send(:params_changed?)).to be true