metadata_test.rb

# encoding: utf-8
# frozen_string_literal: true

require_relative '../../test_helper'
require 'pagy/extras/shared'       # include :sequels in VARS[:metadata]
require 'pagy/extras/metadata'
require 'pagy/countless'

describe Pagy::Backend do

  describe "#pagy_metadata" do

    before do
      @controller = MockController.new
      @collection = MockCollection.new
    end

    it 'defines all metadata' do
      Pagy::VARS[:metadata].must_equal [:scaffold_url, :first_url, :prev_url, :page_url, :next_url, :last_url, :count, :page, :items, :vars, :pages, :last, :from, :to, :prev, :next, :series, :sequels]
    end

    it 'returns the full pagy metadata' do
      pagy, _records = @controller.send(:pagy, @collection)
      @controller.send(:pagy_metadata, pagy).must_equal(
      {:scaffold_url=>"/foo?page=__pagy_page__", :first_url=>"/foo?page=1", :prev_url=>"/foo?page=2", :page_url=>"/foo?page=3", :next_url=>"/foo?page=4", :last_url=>"/foo?page=50", :count=>1000, :page=>3, :items=>20, :vars=>{:page=>3, :items=>20, :outset=>0, :size=>[1, 4, 4, 1], :page_param=>:page, :params=>{}, :anchor=>"", :link_extra=>"", :i18n_key=>"pagy.item_name", :cycle=>false, :steps=>false, :metadata=>[:scaffold_url, :first_url, :prev_url, :page_url, :next_url, :last_url, :count, :page, :items, :vars, :pages, :last, :from, :to, :prev, :next, :series, :sequels], :count=>1000}, :pages=>50, :last=>50, :from=>41, :to=>60, :prev=>2, :next=>4, :series=>[1, 2, "3", 4, 5, 6, 7, :gap, 50], :sequels=>{"0"=>[1, 2, "3", 4, 5, 6, 7, :gap, 50]}}
      )
    end

    it 'checks for unknown metadata' do
      pagy, _records = @controller.send(:pagy, @collection, metadata: [:page, :unknown_key])
      proc { @controller.send(:pagy_metadata, pagy)}.must_raise Pagy::VariableError
    end

    it 'returns only specific metadata' do
      pagy, _records = @controller.send(:pagy, @collection, metadata: [:scaffold_url, :page, :count, :prev, :next, :pages])
      @controller.send(:pagy_metadata, pagy).must_equal(
      {:scaffold_url=>"/foo?page=__pagy_page__", :page=>3, :count=>1000, :prev=>2, :next=>4, :pages=>50}
      )
    end

  end

end