blacklight 4.8.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59ca505fb4e5d581f138d8174d2caf775d7be43d
-  data.tar.gz: 7ac6cd3f2052f63bb6073f516f1fe11e8b6e686e
+  metadata.gz: 3ea490616aa86b3b39a0189cbc5a5367c443085d
+  data.tar.gz: 9997faba251e860106a7d5cd144298f6126d7653
 SHA512:
-  metadata.gz: 84be88f72ad3f58add443566068ed14e4a2806f7b27c88ec35e0c83c2df376930f374e468011dc6feae0381a97fef684a58928a080c86d6b97c8dec666250379
-  data.tar.gz: b6c6056b286a416c7a5f86a853717f7cc2b502f9e7c21d238e1aee94b354d95824dfb1119c9f042c25a3ad098b37bd2f54240fc098587131fe561294e28aaa52
+  metadata.gz: cbf5727a785c3e85e3fc29b9dae71f8ee244ccda246cca9d1ae25999fafc2de3ff94fc1e396cff6ce4181a46c53e5cc3940fa94c29b4b02521cae98da897e9b5
+  data.tar.gz: 83c06a38785804fb67995acbd2771a2bde1cfac55201b28f25d0ee86ca386b6e5ef1cc432c235c619e270a88d5ef73ac16c458b11b8296468e571f502065879f

data/VERSION

@@ -1 +1 @@
-4.8.0
+4.9.0

data/app/views/catalog/_facet_limit.html.erb

@@ -1,14 +1,14 @@
 <ul>
-  <% paginator =    
-      Blacklight::Solr::FacetPaginator.new(display_facet.items,        
+  <% paginator =
+      Blacklight::Solr::FacetPaginator.new(display_facet.items,
         :limit => facet_limit_for(solr_field))
   %>
   <% paginator.items.each do |item| -%>
     <li>
-    <% if facet_in_params?( solr_field, item.value ) %>              
-        <%= render_selected_facet_value(solr_field, item) %>              
-      <% else %>              
-        <%= render_facet_value(solr_field, item) %>              
+    <% if facet_in_params?( solr_field, item.value ) %>
+        <%= render_selected_facet_value(solr_field, item) %>
+      <% else %>
+        <%= render_facet_value(solr_field, item) %>
     <% end -%>
     </li>
   <% end %>

data/blacklight.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
   s.add_dependency "deprecation", "~> 0.1"
   s.add_development_dependency "jettywrapper", ">= 1.4.1"
   s.add_development_dependency "rspec-rails", "~> 3.0"
+  s.add_development_dependency "rspec-its"
   s.add_development_dependency 'engine_cart', "~> 2.0"
   s.add_development_dependency "equivalent-xml"
 end

data/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 @@ module Blacklight::Solr
     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,74 @@ module Blacklight::Solr
     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
+
+    alias_method :total, :total_count
+
+    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

data/spec/lib/facet_paginator_spec.rb

@@ -4,76 +4,68 @@
 require File.expand_path(File.dirname(__FILE__) + '/../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 be_has_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 be_has_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)
+  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
-  
-    it 'should have previous' do    
-      expect(@paginator).to be_has_previous
-    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 be_has_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.length).to eq(6)
-  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.length).to eq(6)
-  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 be_has_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 be_has_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
-  
+
 end

data/spec/spec_helper.rb

@@ -20,6 +20,7 @@ require 'engine_cart'
 EngineCart.load_application!
 
 require 'rspec/rails'
+require 'rspec/its'
 require 'capybara/rspec'
 require 'capybara/poltergeist'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -157,6 +157,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: engine_cart
   requirement: !ruby/object:Gem::Requirement
@@ -566,7 +580,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: blacklight
-rubygems_version: 2.5.2.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)