DefaultDocumentSplitterTest.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.refactoring.internal.splitter;

import static org.junit.Assert.*;
import static org.mockito.ArgumentMatchers.*;
import static org.mockito.Mockito.*;

import java.util.Arrays;
import java.util.List;

import org.junit.Rule;
import org.junit.Test;
import org.xwiki.refactoring.WikiDocument;
import org.xwiki.refactoring.splitter.DocumentSplitter;
import org.xwiki.refactoring.splitter.criterion.SplittingCriterion;
import org.xwiki.refactoring.splitter.criterion.naming.NamingCriterion;
import org.xwiki.rendering.block.Block;
import org.xwiki.rendering.block.Block.Axes;
import org.xwiki.rendering.block.HeaderBlock;
import org.xwiki.rendering.block.IdBlock;
import org.xwiki.rendering.block.LinkBlock;
import org.xwiki.rendering.block.ParagraphBlock;
import org.xwiki.rendering.block.SectionBlock;
import org.xwiki.rendering.block.WordBlock;
import org.xwiki.rendering.block.XDOM;
import org.xwiki.rendering.block.match.ClassBlockMatcher;
import org.xwiki.rendering.listener.HeaderLevel;
import org.xwiki.rendering.listener.reference.ResourceReference;
import org.xwiki.rendering.listener.reference.ResourceType;
import org.xwiki.test.mockito.MockitoComponentMockingRule;

/**
 * Test case for {@link DefaultDocumentSplitter}.
 * 
 * @version $Id: 079aa7f253ae12d4e7965983a1758c47499f89eb $
 * @since 1.9M1
 */
public class DefaultDocumentSplitterTest
{
    /**
     * A component manager that automatically mocks all dependencies of the component under test.
     */
    @Rule
    public MockitoComponentMockingRule<DocumentSplitter> mocker = new MockitoComponentMockingRule<DocumentSplitter>(
        DefaultDocumentSplitter.class);

    @Test
    public void split() throws Exception
    {
        SplittingCriterion splittingCriterion = mock(SplittingCriterion.class);
        when(splittingCriterion.shouldSplit(any(Block.class), anyInt())).thenReturn(true, false, false, true);
        when(splittingCriterion.shouldIterate(any(SectionBlock.class), anyInt())).thenReturn(true, false, false, false);

        NamingCriterion namingCriterion = mock(NamingCriterion.class);
        when(namingCriterion.getDocumentName(any(XDOM.class))).thenReturn("Child1", "Child2");

        // = Chapter 1 =
        // Once upon a time..
        // == Section 1.1 ==
        // In a kingdom far away..

        HeaderBlock header = new HeaderBlock(Arrays.<Block> asList(new WordBlock("Section 1.1")), HeaderLevel.LEVEL2);
        ParagraphBlock paragraph = new ParagraphBlock(Arrays.<Block> asList(new WordBlock("In a kingdom far away..")));
        SectionBlock subSection = new SectionBlock(Arrays.<Block> asList(header, paragraph));

        header = new HeaderBlock(Arrays.<Block> asList(new WordBlock("Chapter 1")), HeaderLevel.LEVEL1);
        paragraph = new ParagraphBlock(Arrays.<Block> asList(new WordBlock("Once upon a time..")));
        SectionBlock section = new SectionBlock(Arrays.<Block> asList(header, paragraph, subSection));

        XDOM xdom = new XDOM(Arrays.<Block> asList(section));
        WikiDocument document = new WikiDocument("Space.Page", xdom, null);

        List<WikiDocument> result = mocker.getComponentUnderTest().split(document, splittingCriterion, namingCriterion);

        assertEquals(3, result.size());
        assertSame(document, result.get(0));
        assertEquals("Child1", result.get(1).getFullName());
        assertSame(document, result.get(1).getParent());
        assertEquals("Child2", result.get(2).getFullName());
        assertSame(result.get(1), result.get(2).getParent());

        ClassBlockMatcher headerMatcher = new ClassBlockMatcher(HeaderBlock.class);
        assertTrue(document.getXdom().<LinkBlock> getBlocks(headerMatcher, Axes.DESCENDANT).isEmpty());
        assertEquals(1, result.get(1).getXdom().<LinkBlock> getBlocks(headerMatcher, Axes.DESCENDANT).size());
        assertEquals(1, result.get(2).getXdom().<LinkBlock> getBlocks(headerMatcher, Axes.DESCENDANT).size());
    }

    @Test
    public void updateAnchors() throws Exception
    {
        SplittingCriterion splittingCriterion = mock(SplittingCriterion.class);
        when(splittingCriterion.shouldSplit(any(Block.class), anyInt())).thenReturn(false, true, true);
        when(splittingCriterion.shouldIterate(any(SectionBlock.class), anyInt())).thenReturn(false, false, false);

        NamingCriterion namingCriterion = mock(NamingCriterion.class);
        when(namingCriterion.getDocumentName(any(XDOM.class))).thenReturn("Child1", "Child2");

        // [[link>>||anchor="chapter1"]]
        // = {{id name="chapter1"}}Chapter 1 =
        // = Chapter 2 ==
        // [[link>>path:#chapter1]]

        ResourceReference reference = new ResourceReference("", ResourceType.DOCUMENT);
        reference.setParameter("anchor", "chapter1");
        LinkBlock link = new LinkBlock(Arrays.<Block> asList(new WordBlock("link")), reference, false);
        ParagraphBlock paragraph = new ParagraphBlock(Arrays.<Block> asList(link));

        HeaderBlock header =
            new HeaderBlock(Arrays.<Block> asList(new IdBlock("chapter1"), new WordBlock("Chapter 1")),
                HeaderLevel.LEVEL1);
        SectionBlock section1 = new SectionBlock(Arrays.<Block> asList(header));

        header = new HeaderBlock(Arrays.<Block> asList(new WordBlock("Chapter 2")), HeaderLevel.LEVEL1);
        reference = new ResourceReference("#chapter1", ResourceType.PATH);
        link = new LinkBlock(Arrays.<Block> asList(new WordBlock("link")), reference, false);
        SectionBlock section2 =
            new SectionBlock(Arrays.<Block> asList(header, new ParagraphBlock(Arrays.<Block> asList(link))));

        XDOM xdom = new XDOM(Arrays.<Block> asList(paragraph, section1, section2));
        WikiDocument document = new WikiDocument("Space.Page", xdom, null);

        List<WikiDocument> result = mocker.getComponentUnderTest().split(document, splittingCriterion, namingCriterion);

        ClassBlockMatcher linkMatcher = new ClassBlockMatcher(LinkBlock.class);

        ResourceReference updatedReference =
            document.getXdom().<LinkBlock> getFirstBlock(linkMatcher, Axes.DESCENDANT).getReference();
        assertEquals("chapter1", updatedReference.getParameter("anchor"));
        assertEquals(result.get(1).getFullName(), updatedReference.getReference());

        updatedReference =
            result.get(2).getXdom().<LinkBlock> getFirstBlock(linkMatcher, Axes.DESCENDANT).getReference();
        assertEquals(ResourceType.DOCUMENT, updatedReference.getType());
        assertEquals("chapter1", updatedReference.getParameter("anchor"));
        assertEquals(result.get(1).getFullName(), updatedReference.getReference());
    }
}