/*
* [The "BSD licence"]
* Copyright (c) 2012 Dandelion
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of Dandelion nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.github.dandelion.datatables.core.generator;
import static org.fest.assertions.Assertions.assertThat;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.junit.Before;
import org.junit.Test;
import org.springframework.mock.web.MockFilterConfig;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import com.github.dandelion.core.Context;
import com.github.dandelion.core.web.WebConstants;
import com.github.dandelion.datatables.core.asset.JavascriptSnippet;
import com.github.dandelion.datatables.core.configuration.ColumnConfig;
import com.github.dandelion.datatables.core.configuration.TableConfig;
import com.github.dandelion.datatables.core.constants.DTConstants;
import com.github.dandelion.datatables.core.export.ReservedFormat;
import com.github.dandelion.datatables.core.extension.feature.FilterPlaceholder;
import com.github.dandelion.datatables.core.extension.feature.FilterType;
import com.github.dandelion.datatables.core.generator.configuration.ColumnFilteringGenerator;
import com.github.dandelion.datatables.core.html.HtmlColumn;
import com.github.dandelion.datatables.core.html.HtmlRow;
import com.github.dandelion.datatables.core.html.HtmlTable;
/**
* Unit test for the Column Filtering generator.
*
* @author Thibault Duchateau
*/
public class ColumnFilteringGeneratorTest {
private HttpServletRequest request;
private HttpServletResponse response;
private ColumnFilteringGenerator generator;
private HtmlTable table;
private HtmlRow headerRow;
private HtmlColumn firstColumn;
@Before
public void createMainGenerator() {
request = new MockHttpServletRequest();
request.setAttribute(WebConstants.DANDELION_CONTEXT_ATTRIBUTE, new Context(new MockFilterConfig()));
response = new MockHttpServletResponse();
generator = new ColumnFilteringGenerator();
}
@Before
public void createTable() {
table = new HtmlTable("aTable", request, response);
table.getTableConfiguration().getConfigurations().clear();
headerRow = table.addHeaderRow();
firstColumn = headerRow.addHeaderColumn("firstColumn");
}
@Test
public void should_not_generate_filter_conf_when_using_pdf_displaytype() {
Set<String> displayTypes = new HashSet<String>();
displayTypes.add(ReservedFormat.PDF);
firstColumn.setEnabledDisplayTypes(displayTypes);
Map<String, Object> mainConf = generator.generateConfig(table);
assertThat(mainConf).hasSize(1);
assertThat(mainConf.get(DTConstants.DT_AOCOLUMNS)).isEqualTo(new ArrayList<Object>());
}
@Test
public void should_generate_filter_conf_when_using_html_displaytype() {
Set<String> displayTypes = new HashSet<String>();
displayTypes.add(ReservedFormat.HTML);
firstColumn.setEnabledDisplayTypes(displayTypes);
Map<String, Object> mainConf = generator.generateConfig(table);
List<Map<String, Object>> aoColumnsContent = new ArrayList<Map<String, Object>>();
Map<String, Object> conf = new HashMap<String, Object>();
conf.put(DTConstants.DT_FILTER_TYPE, "null");
aoColumnsContent.add(conf);
assertThat(mainConf).hasSize(1);
assertThat(mainConf.get(DTConstants.DT_AOCOLUMNS)).isEqualTo(aoColumnsContent);
}
@Test
public void should_generate_filter_placeholder() {
table.getTableConfiguration().set(TableConfig.FEATURE_FILTER_PLACEHOLDER, FilterPlaceholder.FOOT);
Map<String, Object> mainConf = generator.generateConfig(table);
assertThat(mainConf).hasSize(2);
assertThat(mainConf.get(DTConstants.DT_S_PLACEHOLDER)).isEqualTo("foot");
}
@Test
public void should_generate_filtertype_number() {
firstColumn.getColumnConfiguration().set(ColumnConfig.FILTERABLE, true);
firstColumn.getColumnConfiguration().set(ColumnConfig.FILTERTYPE, FilterType.NUMBER);
Map<String, Object> mainConf = generator.generateConfig(table);
List<Map<String, Object>> aoColumnsContent = new ArrayList<Map<String, Object>>();
Map<String, Object> conf = new HashMap<String, Object>();
conf.put(DTConstants.DT_FILTER_TYPE, "number");
aoColumnsContent.add(conf);
assertThat(mainConf).hasSize(1);
assertThat(mainConf.get(DTConstants.DT_AOCOLUMNS)).isEqualTo(aoColumnsContent);
}
@Test
public void should_generate_filtertype_select() {
firstColumn.getColumnConfiguration().set(ColumnConfig.FILTERABLE, true);
firstColumn.getColumnConfiguration().set(ColumnConfig.FILTERTYPE, FilterType.SELECT);
Map<String, Object> mainConf = generator.generateConfig(table);
List<Map<String, Object>> aoColumnsContent = new ArrayList<Map<String, Object>>();
Map<String, Object> conf = new HashMap<String, Object>();
conf.put(DTConstants.DT_FILTER_TYPE, "select");
aoColumnsContent.add(conf);
assertThat(mainConf).hasSize(1);
assertThat(mainConf.get(DTConstants.DT_AOCOLUMNS)).isEqualTo(aoColumnsContent);
}
@Test
public void should_generate_filtertype_number_range() {
firstColumn.getColumnConfiguration().set(ColumnConfig.FILTERABLE, true);
firstColumn.getColumnConfiguration().set(ColumnConfig.FILTERTYPE, FilterType.NUMBER_RANGE);
Map<String, Object> mainConf = generator.generateConfig(table);
List<Map<String, Object>> aoColumnsContent = new ArrayList<Map<String, Object>>();
Map<String, Object> conf = new HashMap<String, Object>();
conf.put(DTConstants.DT_FILTER_TYPE, "number-range");
aoColumnsContent.add(conf);
assertThat(mainConf).hasSize(1);
assertThat(mainConf.get(DTConstants.DT_AOCOLUMNS)).isEqualTo(aoColumnsContent);
}
@Test
public void should_generate_filtertype_text() {
firstColumn.getColumnConfiguration().set(ColumnConfig.FILTERABLE, true);
firstColumn.getColumnConfiguration().set(ColumnConfig.FILTERTYPE, FilterType.INPUT);
Map<String, Object> mainConf = generator.generateConfig(table);
List<Map<String, Object>> aoColumnsContent = new ArrayList<Map<String, Object>>();
Map<String, Object> conf = new HashMap<String, Object>();
conf.put(DTConstants.DT_FILTER_TYPE, "text");
aoColumnsContent.add(conf);
assertThat(mainConf).hasSize(1);
assertThat(mainConf.get(DTConstants.DT_AOCOLUMNS)).isEqualTo(aoColumnsContent);
}
@Test
public void should_generate_filter_selector() {
firstColumn.getColumnConfiguration().set(ColumnConfig.SELECTOR, "mySelector");
Map<String, Object> mainConf = generator.generateConfig(table);
List<Map<String, Object>> aoColumnsContent = new ArrayList<Map<String, Object>>();
Map<String, Object> conf = new HashMap<String, Object>();
conf.put(DTConstants.DT_S_SELECTOR, "mySelector");
conf.put(DTConstants.DT_FILTER_TYPE, "null");
aoColumnsContent.add(conf);
assertThat(mainConf).hasSize(1);
assertThat(mainConf.get(DTConstants.DT_AOCOLUMNS)).isEqualTo(aoColumnsContent);
}
@Test
public void should_generate_filter_values() {
firstColumn.getColumnConfiguration().set(ColumnConfig.FILTERVALUES, "myValues");
Map<String, Object> mainConf = generator.generateConfig(table);
List<Map<String, Object>> aoColumnsContent = new ArrayList<Map<String, Object>>();
Map<String, Object> conf = new HashMap<String, Object>();
conf.put(DTConstants.DT_FILTER_VALUES, new JavascriptSnippet("myValues"));
conf.put(DTConstants.DT_FILTER_TYPE, "null");
aoColumnsContent.add(conf);
assertThat(mainConf).hasSize(1);
assertThat(mainConf.get(DTConstants.DT_AOCOLUMNS)).isEqualTo(aoColumnsContent);
}
}