Merge pull request #929 from projectblacklight/rspec-2.99

Rspec 2.99

app/views/catalog/_facet_limit.html.erb

@@ -11,7 +11,7 @@
     </li>
   <% end %>
 
-  <% if paginator.has_next? and params[:action] != "facet" %>
+  <% unless paginator.last_page? || params[:action] == "facet" %>
     <li class="more_facets_link"><%= link_to(t('blacklight.search.facets.more'), params.merge(:id => solr_field, :action=>"facet", :page => nil), :class => "more_facets_link") %></li>
   <% end %>
 

blacklight.gemspec

@@ -26,7 +26,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "jettywrapper", ">= 1.7.0"
   s.add_development_dependency "blacklight-marc", "~> 5.0"
-  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "rspec-rails", "~> 2.99"
+  s.add_development_dependency "rspec-its"
   s.add_development_dependency "capybara"
   s.add_development_dependency "poltergeist"
   s.add_development_dependency 'engine_cart', ">= 0.1.0"

lib/blacklight/solr/facet_paginator.rb

@@ -12,6 +12,10 @@ module Blacklight::Solr
   # so we cannot know how many "pages" there are.
   #
   class FacetPaginator    
+    extend Deprecation
+
+    self.deprecation_horizon = 'blacklight version 6.0.0'
+
     # What request keys will we use for the parameters need. Need to
     # make sure they do NOT conflict with catalog/index request params,
     # and need to make them accessible in a list so we can easily
@@ -21,7 +25,7 @@ class FacetPaginator
     class << self; attr_accessor :request_keys end # create a class method
     def request_keys ; self.class.request_keys ; end # shortcut
 
-    attr_reader :total, :items, :offset, :limit, :sort
+    attr_reader :total_count, :items, :offset, :limit, :sort
 
     # all_facet_values is a list of facet value objects returned by solr,
     # asking solr for n+1 facet values.
@@ -33,54 +37,72 @@ def request_keys ; self.class.request_keys ; end # shortcut
     def initialize(all_facet_values, arguments)
       # to_s.to_i will conveniently default to 0 if nil
       @offset = arguments[:offset].to_s.to_i 
-      @limit =  arguments[:limit].to_s.to_i if arguments[:limit]           
+      @limit =  arguments[:limit].to_s.to_i
       # count is solr's default
       @sort = arguments[:sort] || "count" 
-
-      total = all_facet_values.size
-      if (@limit)
-        @items = all_facet_values.slice(0, @limit)
-        @has_next = total > @limit
-        @has_previous = @offset > 0
-      else # nil limit
-        @items = all_facet_values
-        @has_next = false
-        @has_previous = false
-      end
+      @total_count = all_facet_values.size
+      @items = items_for_limit(all_facet_values)
+    end
+
+    def prev_page
+      current_page - 1 unless first_page?
     end
 
     def current_page
-      1 + @offset/@limit
+      if limit == 0 #check for divide by zero
+        1
+      else
+        @offset / limit + 1
+      end
+    end
+
+    def next_page
+      current_page + 1 unless last_page?
     end
 
+    #@deprecated
     def has_next?
-      @has_next
+      !last_page?
     end
+    deprecation_deprecate :has_next?
 
+    #@deprecated
     def has_previous?
-      @has_previous
+      !first_page?
     end
+    deprecation_deprecate :has_next?
 
     def last_page?
-      !has_next?
+      current_page >= total_pages
     end
 
     def first_page?
-      !has_previous?
+      current_page == 1
     end
 
+    def total_pages
+      if limit == 0 #check for divide by zero
+        1
+      else
+        (total_count.to_f / limit).ceil
+      end
+    end      
 
-   # Pass in a desired solr facet solr key ('count' or 'index', see
-   # http://wiki.apache.org/solr/SimpleFacetParameters#facet.limit
-   # under facet.sort ), and your current request params.
-   # Get back params suitable to passing to an ActionHelper method for
-   # creating a url, to resort by that method.
-   def params_for_resort_url(sort_method, params)
-     # When resorting, we've got to reset the offset to start at beginning,
-     # no way to make it make sense otherwise.
-     return params.merge(request_keys[:sort] => sort_method, request_keys[:page] => nil)
-   end
-
+    # Pass in a desired solr facet solr key ('count' or 'index', see
+    # http://wiki.apache.org/solr/SimpleFacetParameters#facet.limit
+    # under facet.sort ), and your current request params.
+    # Get back params suitable to passing to an ActionHelper method for
+    # creating a url, to resort by that method.
+    def params_for_resort_url(sort_method, params)
+      # When resorting, we've got to reset the offset to start at beginning,
+      # no way to make it make sense otherwise.
+      params.merge(request_keys[:sort] => sort_method, request_keys[:page] => nil)
+    end
+
+    private
+      # setting limit to 0 implies no limit
+      def items_for_limit(values)
+        limit != 0 ? values.slice(offset, limit) : values
+      end
   end
-
 end

spec/lib/blacklight/facet_paginator_spec.rb

@@ -1,75 +1,67 @@
 require 'spec_helper'
 
 describe 'Blacklight::Solr::FacetPaginator' do
-  before(:all) do
-    require 'yaml'
-    @seven_facet_values = YAML::load("--- \n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 792\n  value: Book\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 65\n  value: Musical Score\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 58\n  value: Serial\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 48\n  value: Musical Recording\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 37\n  value: Microform\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 27\n  value: Thesis\n- !ruby/object:Blacklight::SolrResponse::Facets::FacetItem \n  hits: 0\n  value: \n")
-    @six_facet_values = @seven_facet_values.slice(1,6)
-    @limit = 6
 
-    @sort_key = Blacklight::Solr::FacetPaginator.request_keys[:sort]
-    @page_key = Blacklight::Solr::FacetPaginator.request_keys[:page]
-  end
-  context 'when there are limit+1 results' do
-    before(:each) do
-      @paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :limit => 6)
-    end
-    it 'should have next' do
-      expect(@paginator).to have_next
-    end
+  let(:f1) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '792', value: 'Book') }
+  let(:f2) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '65', value: 'Musical Score') }
+  let(:f3) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '58', value: 'Serial') }
+  let(:f4) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '48', value: 'Musical Recording') }
+  let(:f5) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '37', value: 'Microform') }
+  let(:f6) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '27', value: 'Thesis') }
+  let(:f7) { Blacklight::SolrResponse::Facets::FacetItem.new(hits: '0') }
+  let(:seven_facet_values) { [f1, f2, f3, f4, f5, f6, f7] }
+  let(:six_facet_values) { [f1, f2, f3, f4, f5, f6] }
+  let(:limit) { 6 }
 
+  context 'on the first page of two pages' do
+    subject { Blacklight::Solr::FacetPaginator.new(seven_facet_values, limit: limit) }
+    it { should be_first_page }
+    it { should_not be_last_page }
+    its(:current_page) { should eq 1 }
+    its(:prev_page) { should be_nil }
+    its(:next_page) { should eq 2 }
+    it 'should limit items to limit, if limit is smaller than items.length' do
+      expect(subject.items.size).to eq 6
+    end
   end
-  it 'should not have next when there are fewer results' do
-    paginator = Blacklight::Solr::FacetPaginator.new(@six_facet_values, :offset => 0, :limit => @limit)
 
-    expect(paginator).not_to have_next
-  end
-  context 'when offset is greater than 0' do
-    before(:each) do
-      @offset = 100
-      @paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :offset => @offset, :limit => @limit)
-    end
-
-    it 'should have previous' do    
-      expect(@paginator).to have_previous
+  context 'on the last page of two pages' do
+    subject { Blacklight::Solr::FacetPaginator.new(seven_facet_values, offset: 6, limit: limit) }
+    it { should_not be_first_page }
+    it { should be_last_page }
+    its(:current_page) { should eq 2 }
+    its(:prev_page) { should eq 1 }
+    its(:next_page) { should be_nil }
+    it 'should return all items when limit is greater than items.length' do
+      expect(subject.items.size).to eq 1
     end
-
   end
-  it 'should not have previous when offset is 0' do
-    paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :offset => 0, :limit => @limit)
 
-    expect(paginator).not_to have_previous
+  context 'on the first page of one page' do
+    subject { Blacklight::Solr::FacetPaginator.new(six_facet_values, offset: 0, limit: limit) }
+    it { should be_first_page }
+    it { should be_last_page }
   end
-  it 'should know a manually set sort, and produce proper sort url' do
-      paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :offset => 100, :limit => @limit, :sort => 'index')
 
-      expect(paginator.sort).to eq 'index'
-
-      click_params = paginator.params_for_resort_url('count', {})
+  describe "params_for_resort_url" do
+    let(:sort_key) { Blacklight::Solr::FacetPaginator.request_keys[:sort] }
+    let(:page_key) { Blacklight::Solr::FacetPaginator.request_keys[:page] }
+    let(:paginator) { Blacklight::Solr::FacetPaginator.new(seven_facet_values, offset: 100, limit: limit, sort: 'index') }
 
-      expect(click_params[ @sort_key ]).to eq 'count'
-      expect(click_params[ @page_key ]).to be_nil
-  end
-  it 'should limit items to limit, if limit is smaller than items.length' do
-    paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :offset => 100, :limit => 6, :sort => 'index')
-    expect(paginator.items).to have(6).items
-  end
-  it 'should return all items when limit is greater than items.length' do
-    paginator = Blacklight::Solr::FacetPaginator.new(@six_facet_values, :offset => 100, :limit => 6, :sort => 'index')
-    expect(paginator.items).to have(6).items
-  end
-  describe "for a nil :limit" do
-    before(:all) do
-      @paginator = Blacklight::Solr::FacetPaginator.new(@seven_facet_values, :offset => 100, :limit => nil, :sort => 'index')
-    end
-    it 'should return all items' do
-      expect(@paginator.items).to eq @seven_facet_values      
-    end
-    it 'should not has_next?' do
-      expect(@paginator).not_to have_next
+    it 'should know a manually set sort, and produce proper sort url' do
+        expect(paginator.sort).to eq 'index'
+
+        click_params = paginator.params_for_resort_url('count', {})
+
+        expect(click_params[ sort_key ]).to eq 'count'
+        expect(click_params[ page_key ]).to be_nil
     end
-    it 'should not has_previous?' do
-      expect(@paginator).not_to have_previous
+  end
+
+  context "for a nil :limit" do
+    subject { Blacklight::Solr::FacetPaginator.new(seven_facet_values, offset: 0, limit: nil) }
+    it "should return all the items" do
+      expect(subject.items).to eq seven_facet_values
     end
   end
 

spec/spec_helper.rb

@@ -22,6 +22,7 @@
 EngineCart.load_application!
 
 require 'rspec/rails'
+require 'rspec/its'
 require 'capybara/rspec'
 require 'capybara/poltergeist'
 
@@ -43,15 +44,6 @@
 Dir[Pathname.new(File.expand_path("../support/**/*.rb", __FILE__))].each {|f| require f}
 
 RSpec.configure do |config|
-  # == Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
-  config.mock_with :rspec
-
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
   config.fixture_path = "#{::Rails.root}/spec/fixtures"
 
@@ -61,4 +53,5 @@
   config.use_transactional_fixtures = true
 
   config.include Devise::TestHelpers, type: :controller
+  config.infer_spec_type_from_file_location!
 end