tapestry/tapestry-framework/src/test/org/apache/tapestry/form/translator/TestDateTranslator.java

// Copyright 2004, 2005 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package org.apache.tapestry.form.translator;

import static org.easymock.EasyMock.expect;

import java.util.Calendar;
import java.util.Date;
import java.util.Locale;

import org.apache.tapestry.IMarkupWriter;
import org.apache.tapestry.IRequestCycle;
import org.apache.tapestry.form.FormComponentContributorContext;
import org.apache.tapestry.form.FormComponentContributorTestCase;
import org.apache.tapestry.form.IFormComponent;
import org.apache.tapestry.form.ValidationMessages;
import org.apache.tapestry.json.JSONObject;
import org.apache.tapestry.valid.ValidationConstraint;
import org.apache.tapestry.valid.ValidationStrings;
import org.apache.tapestry.valid.ValidatorException;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.Test;

/**
 * Test case for {@link DateTranslator}.
 * 
 * @author Paul Ferraro
 * @since 4.0
 */
@Test(sequential=true)
public class TestDateTranslator extends FormComponentContributorTestCase
{
    private Calendar _calendar = Calendar.getInstance();
    
    @AfterMethod
    protected void cleanup()
    {
        _calendar.clear();
    }
    
    private Date buildDate(int year, int month, int day)
    {
        _calendar.set(Calendar.YEAR, year);
        _calendar.set(Calendar.MONTH, month);
        _calendar.set(Calendar.DATE, day);

        return _calendar.getTime();
    }

    public void testDefaultFormat()
    {
        DateTranslator translator = new DateTranslator();
        trainFormat(translator, buildDate(1976, Calendar.OCTOBER, 29), "10/29/1976");
    }

    public void testCustomFormat()
    {
        DateTranslator translator = new DateTranslator();

        translator.setPattern("yyyy-MM-dd");

        trainFormat(translator, buildDate(1976, Calendar.OCTOBER, 29), "1976-10-29");
    }

    public void testInitializerFormat()
    {
        DateTranslator translator = new DateTranslator("pattern=yyyy-MM-dd");

        trainFormat(translator, buildDate(1976, Calendar.OCTOBER, 29), "1976-10-29");
    }

    private void trainFormat(DateTranslator translator, Date date, String expected)
    {
        IFormComponent field = newField();

        replay();

        String result = translator.format(field, Locale.ENGLISH, date);

        assertEquals(expected, result);

        verify();
    }

    public void testNullFormat()
    {
        DateTranslator translator = new DateTranslator();

        replay();

        String result = translator.format(_component, null, null);

        assertEquals("", result);

        verify();
    }

    public void testDefaultParse() throws Exception
    {
        DateTranslator translator = new DateTranslator();

        testParse(translator, "10/29/1976", buildDate(1976, Calendar.OCTOBER, 29));
    }
    
    public void test_Time_Parse() throws Exception
    {
        DateTranslator translator = new DateTranslator();
        
        String input = "6:50 pm";
        
        translator.setPattern("hh:mm a");
        
        IFormComponent field = newField();
        
        ValidationMessages messages = newValidationMessages(Locale.ENGLISH);
        
        replay();
        
        Date result = (Date) translator.parse(field, messages, input);
        
        assertEquals(18, result.getHours());
        assertEquals(50, result.getMinutes());
        
        verify();
    }
    
    public void testCustomParse() throws Exception
    {
        DateTranslator translator = new DateTranslator();

        translator.setPattern("yyyy-MM-dd");

        testParse(translator, "1976-10-29", buildDate(1976, Calendar.OCTOBER, 29));
    }

    public void testTrimmedParse() throws Exception
    {
        DateTranslator translator = new DateTranslator();

        translator.setTrim(true);

        testParse(translator, " 10/29/1976 ", buildDate(1976, Calendar.OCTOBER, 29));
    }

    public void testEmptyParse()
    {
        DateTranslator translator = new DateTranslator();

        replay();

        try
        {
            Date result = (Date) translator.parse(_component, null, "");

            assertEquals(null, result);
        }
        catch (ValidatorException e)
        {
            unreachable();
        }
        finally
        {
            verify();
        }
    }

    private void testParse(DateTranslator translator, String date, Date expected) throws Exception
    {
        IFormComponent field = newField();

        ValidationMessages messages = newValidationMessages(Locale.ENGLISH);

        replay();

        Date result = (Date) translator.parse(field, messages, date);

        assertEquals(expected, result);

        verify();
    }

    public void testFailedParseDefaultMessage() throws Exception
    {
        DateTranslator translator = new DateTranslator();

        failedParse(translator, null);
    }

    public void testFailedParseCustomMessage() throws Exception
    {
        DateTranslator translator = new DateTranslator();
        String message = "Field Name is an invalid date.";

        translator.setMessage(message);

        failedParse(translator, message);
    }

    private void failedParse(DateTranslator translator, String overrideMessage)
            throws Exception
    {   
        IFormComponent field = newField("My Field");
        
        ValidationMessages messages = newValidationMessages(Locale.ENGLISH);
        
        trainBuildMessage(
                messages,
                overrideMessage,
                ValidationStrings.INVALID_DATE,
                new Object[]
                { "My Field", "MM/DD/YYYY" },
                "final message");
        
        replay();

        try
        {
            System.out.println(translator.parse(field, messages, "Bad-Date"));

            unreachable();
        }
        catch (ValidatorException e)
        {
            assertEquals("final message", e.getMessage());
            assertEquals(ValidationConstraint.DATE_FORMAT, e.getConstraint());
        }

        verify();
    }

    public void test_Render_Contribution()
    {
        DateTranslator translator = new DateTranslator();
        IFormComponent field = newField("Date Field", "dateField", 1);
        
        JSONObject json = new JSONObject();
        
        IMarkupWriter writer = newWriter();
        IRequestCycle cycle = newCycle();
        
        FormComponentContributorContext context = newMock(FormComponentContributorContext.class);
        
        expect(context.getProfile()).andReturn(json);
        
        trainGetLocale(context, Locale.ENGLISH);
        
        trainBuildMessage(context, null, ValidationStrings.INVALID_DATE, 
                new Object[] { "Date Field", 
                translator.getDateFormat(Locale.ENGLISH)
                .toLocalizedPattern().toUpperCase(Locale.ENGLISH)}, "invalid date");
        
        context.addInitializationScript(field, "dojo.require(\"tapestry.form.datetime\");");
        
        replay();
        
        translator.renderContribution(writer, cycle, context, field);
        
        verify();
        
        assertEquals(json.toString(),
                "{\"constraints\":{\"dateField\":" +
                "[[tapestry.form.datetime.isValidDate," +
                "{datePattern:\"MM/dd/yyyy\"}]]},\"dateField\":" +
                "{\"constraints\":[\"invalid date\"]}}");
    }

    public void test_Trim_Render_Contribution()
    {
        DateTranslator dt = new DateTranslator("!lenient,trim");
        assertFalse(dt.isLenient());
        assertTrue(dt.isTrim());
        
        IMarkupWriter writer = newWriter();
        IRequestCycle cycle = newCycle();
        IFormComponent field = newField("Date Field", "dateField", 1);
        
        JSONObject json = new JSONObject();
        
        FormComponentContributorContext context = newMock(FormComponentContributorContext.class);
        
        expect(context.getProfile()).andReturn(json).anyTimes();
        
        trainGetLocale(context, Locale.ENGLISH);
        
        trainBuildMessage(context, null, ValidationStrings.INVALID_DATE, 
                new Object[] { "Date Field", 
                dt.getDateFormat(Locale.ENGLISH)
                .toLocalizedPattern().toUpperCase(Locale.ENGLISH)}, "invalid date");
        
        context.addInitializationScript(field, "dojo.require(\"tapestry.form.datetime\");");
        
        replay();

        dt.renderContribution(writer, cycle, context, field);

        verify();
        
        assertEquals(json.toString(),
                "{\"trim\":[\"dateField\"],\"constraints\":{\"dateField\":" +
                "[[tapestry.form.datetime.isValidDate,{datePattern:\"MM/dd/yyyy\",strict:true}]]}," +
                "\"dateField\":{\"constraints\":[\"invalid date\"]}}");
    }
}