package jmri.util.swing;

import java.util.Enumeration;

import javax.swing.table.TableColumn;

import jmri.util.JUnitUtil;

import org.junit.jupiter.api.*;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;

/**
 *
 * @author Paul Bender Copyright (C) 2017
 * @author Randall Wood Copyright 2018
 */
public class XTableColumnModelTest {

    private static final String COLUMN1 = "column1";
    private static final String COLUMN2 = "column2";
    private static final String COLUMN3 = "column3";

    /**
     * Test of setColumnVisible method, of class XTableColumnModel.
     */
    @Test
    public void testSetColumnVisible() {
        XTableColumnModel instance = getTestModel();
        TableColumn column = instance.getColumn(0);
        assertTrue(instance.isColumnVisible(column));
        instance.setColumnVisible(column, false);
        assertFalse(instance.isColumnVisible(column));
        instance.setColumnVisible(column, true);
        assertTrue(instance.isColumnVisible(column));
    }

    /**
     * Test of setAllColumnsVisible method, of class XTableColumnModel.
     */
    @Test
    public void testSetAllColumnsVisible() {
        XTableColumnModel instance = getTestModel();
        TableColumn column1 = instance.getColumn(0);
        TableColumn column2 = instance.getColumn(1);
        TableColumn column3 = instance.getColumn(2);
        instance.setColumnVisible(column1, false);
        instance.setColumnVisible(column2, false);
        assertFalse(instance.isColumnVisible(column1));
        assertFalse(instance.isColumnVisible(column2));
        assertTrue(instance.isColumnVisible(column3));
        instance.setAllColumnsVisible();
        assertTrue(instance.isColumnVisible(column1));
        assertTrue(instance.isColumnVisible(column2));
        assertTrue(instance.isColumnVisible(column3));
    }

    /**
     * Test of getColumnByModelIndex method, of class XTableColumnModel.
     */
    @Test
    public void testGetColumnByModelIndex() {
        // all columns have modelIndex 0 until associated with columns from a
        // data model or explicitly set (as in this test)
        XTableColumnModel instance = getTestModel();
        TableColumn column1 = instance.getColumn(0);
        TableColumn column2 = instance.getColumn(1);
        TableColumn column3 = instance.getColumn(2);
        assertEquals(0, column1.getModelIndex());
        assertEquals(0, column2.getModelIndex());
        assertEquals(0, column3.getModelIndex());
        assertEquals(column1, instance.getColumnByModelIndex(0));
        assertNull(instance.getColumnByModelIndex(1));
        assertNull(instance.getColumnByModelIndex(2));
        assertNull(instance.getColumnByModelIndex(3));
        column1.setModelIndex(3);
        assertEquals(column1, instance.getColumnByModelIndex(3));
        assertEquals(column2, instance.getColumnByModelIndex(0));
        assertNull(instance.getColumnByModelIndex(1));
        assertNull(instance.getColumnByModelIndex(2));
        column2.setModelIndex(1);
        assertEquals(column1, instance.getColumnByModelIndex(3));
        assertEquals(column2, instance.getColumnByModelIndex(1));
        assertEquals(column3, instance.getColumnByModelIndex(0));
        assertNull(instance.getColumnByModelIndex(2));
        column1.setModelIndex(0);
        column2.setModelIndex(1);
        column3.setModelIndex(2);
        assertEquals(column1, instance.getColumnByModelIndex(0));
        assertEquals(column2, instance.getColumnByModelIndex(1));
        assertEquals(column3, instance.getColumnByModelIndex(2));
        assertNull(instance.getColumnByModelIndex(3));
    }

    /**
     * Test of isColumnVisible method, of class XTableColumnModel.
     */
    @Test
    public void testIsColumnVisible() {
        TableColumn column = new TableColumn();
        XTableColumnModel instance = new XTableColumnModel();
        instance.addColumn(column);
        assertTrue(instance.isColumnVisible(column));
        instance.setColumnVisible(column, false);
        assertFalse(instance.isColumnVisible(column));
        instance.setColumnVisible(column, true);
        assertTrue(instance.isColumnVisible(column));
    }

    /**
     * Test of addColumn method, of class XTableColumnModel.
     */
    @Test
    public void testAddColumn() {
        TableColumn column = new TableColumn();
        column.setIdentifier(COLUMN1);
        XTableColumnModel instance = new XTableColumnModel();
        assertEquals(0, instance.getColumnCount());
        assertEquals(0, instance.getColumnCount(false));
        Exception ex = Assertions.assertThrows(IllegalArgumentException.class, () -> {
            instance.getColumnIndex(COLUMN1);
            fail("Should have thrown IllegalArgumentException");
        });
        Assertions.assertNotNull(ex);

        instance.addColumn(column);
        assertEquals(1, instance.getColumnCount());
        assertEquals(1, instance.getColumnCount(false));
        assertEquals(0, instance.getColumnIndex(COLUMN1));
    }

    /**
     * Test of removeColumn method, of class XTableColumnModel.
     */
    @Test
    public void testRemoveColumn() {
        TableColumn column = new TableColumn();
        XTableColumnModel instance = new XTableColumnModel();
        instance.addColumn(column);
        assertEquals(1, instance.getColumnCount());
        assertEquals(1, instance.getColumnCount(false));
        instance.removeColumn(column);
        assertEquals(0, instance.getColumnCount());
        assertEquals(0, instance.getColumnCount(false));
    }

    /**
     * Test of moveColumn method, of class XTableColumnModel.
     */
    @Test
    public void testMoveColumn_int_int() {
        XTableColumnModel instance = getTestModel();
        TableColumn column1 = instance.getColumn(0);
        TableColumn column2 = instance.getColumn(1);
        TableColumn column3 = instance.getColumn(2);
        instance.moveColumn(0, 0);
        assertEquals(column1, instance.getColumn(0));
        assertEquals(column2, instance.getColumn(1));
        assertEquals(column3, instance.getColumn(2));
        instance.moveColumn(0, 2);
        assertEquals(column2, instance.getColumn(0));
        assertEquals(column3, instance.getColumn(1));
        assertEquals(column1, instance.getColumn(2));
        instance.setColumnVisible(column1, false);
        
        Exception ex = assertThrows(IllegalArgumentException.class, () -> {
            instance.moveColumn(2, 0);
        }, "Expected IllegalArgumentException not thrown");
        assertNotNull(ex);

        assertEquals(column2, instance.getColumn(0));
        assertEquals(column3, instance.getColumn(1));
        ex = assertThrows(ArrayIndexOutOfBoundsException.class, () -> {
            instance.getColumn(2);
        }, "Expected ArrayIndexOutOfBoundsException not thrown");
        Assertions.assertNotNull(ex);
        instance.setColumnVisible(column1, true);
        instance.moveColumn(2, 0);
        assertEquals(column1, instance.getColumn(0));
        assertEquals(column2, instance.getColumn(1));
        assertEquals(column3, instance.getColumn(2));
    }

    /**
     * Test of moveColumn method, of class XTableColumnModel.
     */
    @Test
    public void testMoveColumn_3args() {
        final XTableColumnModel instance = getTestModel();
        TableColumn column1 = instance.getColumn(0);
        TableColumn column2 = instance.getColumn(1);
        TableColumn column3 = instance.getColumn(2);
        boolean onlyVisibleTrue = true;
        //
        // move only visible columns (third arg is true)
        //
        instance.moveColumn(0, 0, onlyVisibleTrue);
        assertEquals(column1, instance.getColumn(0));
        assertEquals(column2, instance.getColumn(1));
        assertEquals(column3, instance.getColumn(2));
        instance.moveColumn(0, 2, onlyVisibleTrue);
        assertEquals(column2, instance.getColumn(0));
        assertEquals(column3, instance.getColumn(1));
        assertEquals(column1, instance.getColumn(2));
        instance.setColumnVisible(column1, false);
        Exception ex = assertThrows(IllegalArgumentException.class, () -> {
            instance.moveColumn(2, 0, onlyVisibleTrue);
        }, "Expected IllegalArgumentException not thrown");
        assertNotNull(ex);
        assertEquals(column2, instance.getColumn(0));
        assertEquals(column3, instance.getColumn(1));

        ex = assertThrows(ArrayIndexOutOfBoundsException.class, () -> {
            instance.getColumn(2);
        }, "Expected ArrayIndexOutOfBoundsException not thrown");
        assertNotNull(ex);
        instance.setColumnVisible(column1, true);
        instance.moveColumn(2, 0, onlyVisibleTrue);
        assertEquals(column1, instance.getColumn(0));
        assertEquals(column2, instance.getColumn(1));
        assertEquals(column3, instance.getColumn(2));
        //
        // move hidden or visible columns (third arg is false)
        //
        boolean onlyVisibleFalse = false;
        instance.moveColumn(0, 0, onlyVisibleFalse);
        assertEquals(column1, instance.getColumn(0));
        assertEquals(column2, instance.getColumn(1));
        assertEquals(column3, instance.getColumn(2));
        instance.moveColumn(0, 2, onlyVisibleFalse);
        assertEquals(column2, instance.getColumn(0));
        assertEquals(column3, instance.getColumn(1));
        assertEquals(column1, instance.getColumn(2));
        instance.setColumnVisible(column1, false);
        instance.moveColumn(2, 0, onlyVisibleFalse);
        assertEquals(column2, instance.getColumn(0));
        assertEquals(column3, instance.getColumn(1));
        assertEquals(column1, instance.getColumn(0, onlyVisibleFalse));
        assertEquals(column2, instance.getColumn(1, onlyVisibleFalse));
        assertEquals(column3, instance.getColumn(2, onlyVisibleFalse));

        ex = assertThrows(ArrayIndexOutOfBoundsException.class, () -> {
            TableColumn foundColumn = instance.getColumn(2, !onlyVisibleFalse);
            assertNotNull(foundColumn);
        }, "Expected ArrayIndexOutOfBoundsException not thrown ");
        assertNotNull(ex);

        instance.setColumnVisible(column1, true);
        assertEquals(column1, instance.getColumn(0));
        assertEquals(column2, instance.getColumn(1));
        assertEquals(column3, instance.getColumn(2));
        instance.moveColumn(2, 0, onlyVisibleFalse);
        assertEquals(column3, instance.getColumn(0));
        assertEquals(column1, instance.getColumn(1));
        assertEquals(column2, instance.getColumn(2));
    }

    /**
     * Test of getColumnCount method, of class XTableColumnModel.
     */
    @Test
    public void testGetColumnCount() {
        XTableColumnModel instance = getTestModel();
        assertEquals(3, instance.getColumnCount(true));
        assertEquals(3, instance.getColumnCount(false));
        instance.setColumnVisible(instance.getColumn(0), false);
        assertEquals(2, instance.getColumnCount(true));
        assertEquals(3, instance.getColumnCount(false));
    }

    /**
     * Test of getColumns method, of class XTableColumnModel.
     */
    @Test
    public void testGetColumns() {
        XTableColumnModel instance = getTestModel();
        // all columns visible
        int count = 0;
        Enumeration<TableColumn> e = instance.getColumns(true);
        while (e.hasMoreElements()) {
            e.nextElement();
            count++;
        }
        assertEquals(3, count);
        // hide one column
        count = 0;
        instance.setColumnVisible(instance.getColumn(0), false);
        e = instance.getColumns(true);
        while (e.hasMoreElements()) {
            e.nextElement();
            count++;
        }
        assertEquals(2, count);
        count = 0;
        e = instance.getColumns(false);
        while (e.hasMoreElements()) {
            e.nextElement();
            count++;
        }
        assertEquals(3, count);
    }

    /**
     * Test of getColumnIndex method, of class XTableColumnModel.
     */
    @Test
    public void testGetColumnIndex() {
        XTableColumnModel instance = getTestModel();
        TableColumn column1 = instance.getColumn(0);
        assertEquals(0, instance.getColumnIndex(COLUMN1, true));
        assertEquals(0, instance.getColumnIndex(COLUMN1, false));
        instance.setColumnVisible(column1, false);

        Exception ex = assertThrows(IllegalArgumentException.class, () -> {
            // throws exception if requiring visible column
            instance.getColumnIndex(COLUMN1, true);
        }, "Expected IllegalArgumentException not thrown");
        assertNotNull(ex);

        // returns index if allowing hidden column
        assertEquals(0, instance.getColumnIndex(COLUMN1, false));
    }

    /**
     * Test of getColumn method, of class XTableColumnModel.
     */
    @Test
    public void testGetColumn() {
        XTableColumnModel instance = getTestModel();
        TableColumn column1 = instance.getColumn(0);
        TableColumn column2 = instance.getColumn(0);
        instance.setColumnVisible(column1, false);
        // because column1 is hidden, requesting the first visible column should
        // return column2 when onlyVisible is true
        assertNotEquals(column2, instance.getColumn(0, true));
        assertEquals(instance.getColumn(0), instance.getColumn(0, true));
        // when onlyVisible is false column1 is still first column
        assertEquals(column1, instance.getColumn(0, false));
        assertNotEquals(instance.getColumn(0), instance.getColumn(0, false));
    }

    /**
     * Create model with three columns, all visible.
     *
     * @return the new model
     */
    private XTableColumnModel getTestModel() {
        XTableColumnModel instance = new XTableColumnModel();
        TableColumn column1 = new TableColumn();
        column1.setIdentifier(COLUMN1);
        TableColumn column2 = new TableColumn();
        column2.setIdentifier(COLUMN2);
        TableColumn column3 = new TableColumn();
        column3.setIdentifier(COLUMN3);
        instance.addColumn(column1);
        instance.addColumn(column2);
        instance.addColumn(column3);
        return instance;
    }

    @BeforeEach
    public void setUp() {
        JUnitUtil.setUp();
    }

    @AfterEach
    public void tearDown() {
        JUnitUtil.tearDown();
    }

}