PaginationTest

/**
 * This file Copyright (c) 2011-2018 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.templating.models.util;

import static org.hamcrest.CoreMatchers.*;
import static org.hamcrest.collection.IsCollectionWithSize.hasSize;
import static org.junit.Assert.*;
import static org.mockito.Mockito.*;

import info.magnolia.context.MgnlContext;
import info.magnolia.context.WebContext;
import info.magnolia.jcr.util.NodeUtil;

import java.util.ArrayList;
import java.util.List;

import javax.jcr.Node;
import javax.jcr.Property;
import javax.jcr.RepositoryException;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;

/**
 * Tests for {@link Pagination}.
 *
 * Offset count test cases.
 */
public class PaginationTest {

    private WebContext context;

    @Before
    public void setUp() {
        context = mock(WebContext.class);
        MgnlContext.setInstance(context);
    }

    @After
    public void tearDown() {
        MgnlContext.setInstance(null);
    }

    @Test
    public void testPageOffset() {
        // GIVEN
        final Pagination pager = new Pagination();

        // WHEN
        pager.setCount(3);
        pager.setResults(10000);

        // THEN
        assertEquals(0, pager.getOffset());

        // WHEN
        pager.setCount(55);
        pager.setResults(30);

        // THEN
        assertEquals(0, pager.getOffset());
    }

    @Test
    public void testPageOffsetWithCurrentPage() {
        // GIVEN
        final TestPagination pager = new TestPagination();

        // WHEN
        pager.setCount(20);
        pager.setResults(30);
        pager.setCurrentPage(2);

        // THEN
        assertEquals(0, pager.getOffset());

        // WHEN
        pager.setCount(55);
        pager.setResults(10);
        pager.setCurrentPage(8);

        // THEN
        assertEquals(50, pager.getOffset());
    }

    @Test
    public void getPageLinkWithLinkAndWithoutQueryString() throws RepositoryException {
        // GIVEN
        final int page = 1;
        final String currentLink = "http://www.demo-link/to-a-page/and-a-subpage.html";
        final Pagination pagination = new Pagination(currentLink, getMockContentItems(0), mock(Node.class));

        // WHEN
        final String link = pagination.getPageLink(page);

        // THEN
        assertThat(link, is(String.format("%s?%s=%d", currentLink, Pagination.PARAMETER_CURRENT_PAGE, page)));
    }

    @Test
    public void getPageLinkWithLinkAndWithQueryStringToSelf() throws RepositoryException {
        // GIVEN
        final int page = 1;
        final String currentLink = String.format("http://www.demo-link/to-a-page/and-a-subpage.html?%s=%d", Pagination.PARAMETER_CURRENT_PAGE, page);
        final Pagination pagination = new Pagination(currentLink, getMockContentItems(0), mock(Node.class));

        // WHEN
        final String link = pagination.getPageLink(page);

        // THEN
        assertThat(link, is(currentLink));
    }

    @Test
    public void getPageLinkWithLinkAndWithQueryStringAndOtherParam() throws RepositoryException {
        // GIVEN
        final String currentLink = String.format("http://www.demo-link/to-a-page/and-a-subpage.html?%s=1&otherParam=otherValue", Pagination.PARAMETER_CURRENT_PAGE);
        final Pagination pagination = new Pagination(currentLink, getMockContentItems(0), mock(Node.class));

        // WHEN
        final String link = pagination.getPageLink(2);

        // THEN
        assertThat(link, containsString("otherParam=otherValue"));
    }

    @Test
    public void getPageLinkWithoutCurrentPage() throws RepositoryException {
        // GIVEN
        final int page = 3;
        final String currentLink = "http://www.demo-link/to-a-page/and-a-subpage.html?otherParam=otherValue";
        final Pagination pagination = new Pagination(currentLink, getMockContentItems(0), mock(Node.class));

        // WHEN
        final String link = pagination.getPageLink(page);

        // THEN
        assertThat(link, containsString("otherParam=otherValue"));
        assertThat(link, containsString(String.format("%s=%d", Pagination.PARAMETER_CURRENT_PAGE, page)));
    }

    @Test
    public void getNumPagesWithEmptyList() throws RepositoryException {
        // GIVEN
        final Pagination pagination = new Pagination("", getMockContentItems(0), mock(Node.class));

        // WHEN
        final int numPages = pagination.getNumPages();

        // THEN
        assertThat(numPages, is(0));
    }

    @Test
    public void getNumPagesSmallerThanMax() throws RepositoryException {
        // GIVEN
        final Pagination pagination = new Pagination("", getMockContentItems(Pagination.DEFAULT_MAX_RESULTS), mock(Node.class));

        // WHEN
        final int numPages = pagination.getNumPages();

        // THEN
        assertThat(numPages, is(1));
    }

    @Test
    public void getNumPagesBiggerThanMax() throws RepositoryException {
        // GIVEN
        final Pagination pagination = new Pagination("", getMockContentItems(Pagination.DEFAULT_MAX_RESULTS + 1), mock(Node.class));

        // WHEN
        final int numPages = pagination.getNumPages();

        // THEN
        assertThat(numPages, is(2));
    }

    @Test
    public void getNumPagesWithMaxResultsSet() throws RepositoryException {
        // GIVEN
        final Node content = mock(Node.class);
        final Property property = mock(Property.class);
        when(property.getLong()).thenReturn(10L);
        when(content.hasProperty(Pagination.PROPERTY_MAX_RESULTS)).thenReturn(true);
        when(content.getProperty(Pagination.PROPERTY_MAX_RESULTS)).thenReturn(property);

        final Pagination pagination = new Pagination("", getMockContentItems(100), content);

        // WHEN
        final int numPages = pagination.getNumPages();

        // THEN
        assertThat(numPages, is(10));
    }

    @Test
    public void getBeginAndEndIndex() throws RepositoryException {
        // GIVEN
        final Node content = mock(Node.class);
        final Property property = mock(Property.class);
        when(property.getLong()).thenReturn(10L);
        when(content.hasProperty(Pagination.PROPERTY_MAX_RESULTS)).thenReturn(true);
        when(content.getProperty(Pagination.PROPERTY_MAX_RESULTS)).thenReturn(property);
        final Pagination pagination = new Pagination("", getMockContentItems(100), content);

        assertThat(pagination.getCount(), is(100));

        // WHEN
        when(context.getParameter(Pagination.PARAMETER_CURRENT_PAGE)).thenReturn("2");

        // THEN
        assertThat(pagination.getNumPages(), is(10));
        assertThat(pagination.getCurrentPage(), is(2));
        assertThat("With 100 items we expect to start with item 10 on page 2", pagination.getOffset(), is(10));
        assertThat(pagination.getBeginIndex(), is(1));
        assertThat(pagination.getEndIndex(), is(4));

        // WHEN
        when(context.getParameter(Pagination.PARAMETER_CURRENT_PAGE)).thenReturn("4");

        // THEN
        assertThat(pagination.getNumPages(), is(10));
        assertThat(pagination.getCurrentPage(), is(4));
        assertThat("With 100 items we expect to start with item 30 on page 4", pagination.getOffset(), is(30));
        assertThat(pagination.getBeginIndex(), is(2));
        assertThat(pagination.getEndIndex(), is(6));

        // WHEN
        when(context.getParameter(Pagination.PARAMETER_CURRENT_PAGE)).thenReturn("9");

        // THEN
        assertThat(pagination.getNumPages(), is(10));
        assertThat(pagination.getCurrentPage(), is(9));
        assertThat("With 100 items we expect to start with item 80 on page 9", pagination.getOffset(), is(80));
        assertThat(pagination.getBeginIndex(), is(7));
        assertThat(pagination.getEndIndex(), is(10));

        // WHEN
        when(context.getParameter(Pagination.PARAMETER_CURRENT_PAGE)).thenReturn("12");

        // THEN
        assertThat(pagination.getNumPages(), is(10));
        assertThat(pagination.getCurrentPage(), is(12));
        assertThat("With 100 items we expect to start with item 100 on page 12", pagination.getOffset(), is(100));
        assertThat(pagination.getBeginIndex(), is(10));
        assertThat(pagination.getEndIndex(), is(10));
    }

    @Test
    public void getPageItems() throws RepositoryException {
        // GIVEN
        final Node content = mock(Node.class);
        final Property property = mock(Property.class);
        when(property.getLong()).thenReturn(10L);
        when(content.hasProperty(Pagination.PROPERTY_MAX_RESULTS)).thenReturn(true);
        when(content.getProperty(Pagination.PROPERTY_MAX_RESULTS)).thenReturn(property);
        final Pagination pagination = new Pagination("", getMockContentItems(100), content);

        assertThat(pagination.getCount(), is(100));

        // WHEN
        when(context.getParameter(Pagination.PARAMETER_CURRENT_PAGE)).thenReturn("2");
        List<Node> nodes = NodeUtil.asList(pagination.getPageItems());

        // THEN
        assertThat(nodes, hasSize(10));
        assertThat(nodes.get(0).getIdentifier(), is("10"));
        assertThat(nodes.get(9).getIdentifier(), is("19"));

        // WHEN
        when(context.getParameter(Pagination.PARAMETER_CURRENT_PAGE)).thenReturn("7");
        nodes = NodeUtil.asList(pagination.getPageItems());

        // THEN
        assertThat(nodes, hasSize(10));
        assertThat(nodes.get(0).getIdentifier(), is("60"));
        assertThat(nodes.get(9).getIdentifier(), is("69"));

        // WHEN
        when(context.getParameter(Pagination.PARAMETER_CURRENT_PAGE)).thenReturn("10");
        nodes = NodeUtil.asList(pagination.getPageItems());

        // THEN
        assertThat(nodes, hasSize(10));
        assertThat(nodes.get(0).getIdentifier(), is("90"));
        assertThat(nodes.get(9).getIdentifier(), is("99"));
    }

    /**
     * Returns a {@link java.util.List} of {@link javax.jcr.Node}s.
     */
    private List<Node> getMockContentItems(int num) throws RepositoryException {
        final List<Node> items = new ArrayList<Node>();
        for (int i = 0; i < num; i++) {
            final Node node = mock(Node.class);
            when(node.getName()).thenReturn(String.valueOf(i));
            when(node.getPath()).thenReturn(String.format("/%d", i));
            when(node.getIdentifier()).thenReturn(String.valueOf(i));
            items.add(i, node);
        }
        return items;
    }

    /**
     * Test class of {@link Pagination}.
     */
    public class TestPagination extends Pagination {

        private int currentPage;
        private int maxResultsPerPage;
        private int count;

        @Override
        protected int getOffset() {
            int offset = ((currentPage - 1) * maxResultsPerPage);
            if (offset > count) {
                int pages = count / maxResultsPerPage;
                offset = pages * maxResultsPerPage;
            }
            return offset;
        }

        public void setCurrentPage(int currentPage) {
            this.currentPage = currentPage;
        }

        @Override
        public void setResults(int maxResultsPerPage) {
            this.maxResultsPerPage = maxResultsPerPage;
        }

        @Override
        public void setCount(int count) {
            this.count = count;
        }
    }

}