Sunspot::NullResult

Interface taken from Sunspot::Rails::StubSessionProxy::PaginatesCollection of sunspot-rails.

It adds the option to inject records to mimic actual search results (and yes, thus making fun of the "Null" gem name).

Installation

Add this line to your application's Gemfile:

gem 'sunspot-null_result'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sunspot-null_result

Usage

RSpec examples:

RSpec.describe 'stubbed Solr result' do
  let(:search) { Sunspot::NullResult.new(records) }
  before { allow(MyModel).to receive(:search).and_return(search) }

  context 'with no records' do
    let(:records) { [] }
    # …

    it 'supports grouping' do
      # …
      expect(search.group(:my_attribute)).to eql []
    end
  end

  context 'with some records' do
    let(:records) { [MyModel.new, MyModel.new] }
    # …

    it 'supports grouping' do
      # …
      expect(search.group(:my_attribute)).not_to be_empty
    end
  end
end

Rescue case for unavailable Solr server, e.g. Websolr having issues.

class ApplicationController < ActionController::Base

  rescue_from RSolr::Error::Http do |exception|
    # Handle exception so that a complete server shutdown
    # doesn't go unnoticed. Your app may still work using:

    failover_records = MyModel.last(10)
    Sunspot::NullResult.new(failover_records)
  end

  # …
end

Changelog

HEAD (not yet released)

v0.6.0

• Support kaminari-paginated enumerables

v0.5.0

• Build on newer MRI version
• Add Sunspot::NullResult#total and #facet
• Use frozen_string_literal magic comment for MRI 2.3.x

v0.4.1

• Minor fix for accessing previous result page

v0.4.0

• Extend sunspot groups by useful details, e.g. pagination information

v0.3.0

• Support Sunspot grouping

v0.2.0

• Allow setting of pagination options and calculate dependent values accordingly

v0.1.0

• Initial working release

License

The gem is available as free and open source software under the terms of the MIT License.