tapestry/tapestry-framework/src/test/org/apache/tapestry/valid/FieldLabelTest.java

// Copyright 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.valid;

import org.apache.hivemind.Location;
import org.apache.tapestry.BindingException;
import org.apache.tapestry.IForm;
import org.apache.tapestry.IMarkupWriter;
import org.apache.tapestry.IRequestCycle;
import org.apache.tapestry.form.BaseFormComponentTestCase;
import org.apache.tapestry.form.IFormComponent;
import static org.easymock.EasyMock.checkOrder;
import static org.easymock.EasyMock.expect;
import org.testng.annotations.Test;

/**
 * Tests for the {@link org.apache.tapestry.valid.FieldLabel} component.
 *
 * @author Howard M. Lewis Ship
 * @since 4.0
 */
@Test(sequential=true)
public class FieldLabelTest extends BaseFormComponentTestCase
{
    private IForm newForm(IValidationDelegate delegate)
    {
        IForm form = newMock(IForm.class);
        checkOrder(form, false);

        trainGetDelegate(delegate, form);

        return form;
    }

    private void trainGetDelegate(IValidationDelegate delegate, IForm form)
    {
        expect(form.getDelegate()).andReturn(delegate);
    }

    private IFormComponent newField(String displayName, String clientId)
    {
        IFormComponent field = newMock(IFormComponent.class);
        checkOrder(field, false);

        trainGetDisplayName(field, displayName);
        trainGetClientId(clientId, field);

        return field;
    }

    private void trainGetClientId(String clientId, IFormComponent field)
    {
        expect(field.getClientId()).andReturn(clientId).anyTimes();
    }

    private void trainGetDisplayName(IFormComponent field, String displayName)
    {
        expect(field.getDisplayName()).andReturn(displayName).anyTimes();
    }

    public void test_Rewinding()
    {
        Location l = newLocation();
        IMarkupWriter writer = newWriter();
        IRequestCycle cycle = newCycle();
        IForm form = newForm();
        IFormComponent field = newField();

        FieldLabel fl = newInstance(FieldLabel.class, "field", field,
                                    "location", l, "prerender", true);

        expect(cycle.renderStackPush(fl)).andReturn(fl);
        trainGetForm(cycle, form);
        form.prerenderField(writer, field, l);
        trainIsRewinding(cycle, true);

        expect(cycle.renderStackPop()).andReturn(fl);

        replay();

        fl.render(writer, cycle);

        verify();
    }

    public void test_Null_Field()
    {
        IValidationDelegate delegate = new MockDelegate();
        IForm form = newForm(delegate);
        IMarkupWriter writer = newBufferWriter();
        IRequestCycle cycle = newCycle();

        FieldLabel fl = newInstance(FieldLabel.class,
                                    new Object[] { "displayName", "FredFlintstone" });

        expect(cycle.renderStackPush(fl)).andReturn(fl);

        trainGetForm(cycle, form);

        trainIsRewinding(cycle, false);

        expect(cycle.renderStackPop()).andReturn(fl);

        replay();

        fl.render(writer, cycle);

        assertBuffer("<label>{BEFORE-TEXT}FredFlintstone{AFTER-TEXT}</label>");

        verify();
    }

    public void test_Null_Field_Raw()
    {
        IValidationDelegate delegate = new MockDelegate();
        IForm form = newForm(delegate);
        IMarkupWriter writer = newBufferWriter();
        IRequestCycle cycle = newCycle();

        FieldLabel fl = newInstance(FieldLabel.class, "displayName", "<b>FredFlintstone</b>",
                                    "raw", Boolean.TRUE);

        expect(cycle.renderStackPush(fl)).andReturn(fl);

        trainGetForm(cycle, form);
        trainIsRewinding(cycle, false);

        expect(cycle.renderStackPop()).andReturn(fl);

        replay();

        fl.render(writer, cycle);

        assertBuffer("<label>{BEFORE-TEXT}<b>FredFlintstone</b>{AFTER-TEXT}</label>");

        verify();
    }

    public void test_No_Field_Or_DisplayName()
    {
        IForm form = newForm();
        IMarkupWriter writer = newWriter();
        IRequestCycle cycle = newCycle();

        FieldLabel fl = newInstance(FieldLabel.class, new Object[] {"id", "label"});

        expect(cycle.renderStackPush(fl)).andReturn(fl);

        trainGetForm(cycle, form);
        trainIsRewinding(cycle, false);

        expect(cycle.renderStackPop()).andReturn(fl);

        replay();

        try
        {
            fl.render(writer, cycle);
            unreachable();
        }
        catch (BindingException ex)
        {
            assertEquals("Value for parameter 'field' in component "
                         + "null is null, and a non-null value is required.",
                         ex.getMessage());
        }

        verify();
    }

    public void test_Display_Name_From_Field()
    {
        IValidationDelegate delegate = new MockDelegate();

        IForm form = newForm();

        IMarkupWriter writer = newBufferWriter();
        IFormComponent field = newField("MyLabel", null);
        Location l = newLocation();

        IRequestCycle cycle = newCycle();

        FieldLabel fl = newInstance(FieldLabel.class, "location", l,
                                    "field", field, "prerender", true);

        expect(cycle.renderStackPush(fl)).andReturn(fl);

        trainGetForm(cycle, form);
        trainIsRewinding(cycle, false);

        form.prerenderField(writer, field, l);
        trainGetDelegate(form, delegate);

        expect(cycle.renderStackPop()).andReturn(fl);

        replay();

        fl.render(writer, cycle);

        assertBuffer("{LABEL-PREFIX}<label>{BEFORE-TEXT}MyLabel{AFTER-TEXT}</label>{LABEL-SUFFIX}");

        verify();
    }

    public void test_Prerender_Off()
    {
        IValidationDelegate delegate = new MockDelegate();

        IForm form = newForm();

        IMarkupWriter writer = newBufferWriter();
        IFormComponent field = newField("MyLabel", null);
        Location l = newLocation();

        IRequestCycle cycle = newCycle();

        FieldLabel fl = newInstance(FieldLabel.class, "location", l, "field", field);

        expect(cycle.renderStackPush(fl)).andReturn(fl);

        trainGetForm(cycle, form);
        trainIsRewinding(cycle, false);
        trainGetDelegate(form, delegate);

        expect(cycle.renderStackPop()).andReturn(fl);

        replay();

        fl.render(writer, cycle);

        assertBuffer("{LABEL-PREFIX}<label>{BEFORE-TEXT}MyLabel{AFTER-TEXT}</label>{LABEL-SUFFIX}");

        verify();
    }

    public void test_Field_With_Client_Id()
    {
        IValidationDelegate delegate = new MockDelegate();

        IForm form = newForm();

        IMarkupWriter writer = newBufferWriter();

        Location l = newLocation();

        IRequestCycle cycle = newCycle();

        IFormComponent field = newField("MyLabel", "clientId");
        
        FieldLabel fl = newInstance(FieldLabel.class, "location", l,
                                    "field", field, "prerender", true);

        expect(cycle.renderStackPush(fl)).andReturn(fl);

        trainGetForm(cycle, form);
        form.prerenderField(writer, field, l);
        trainIsRewinding(cycle, false);
        trainGetDelegate(form, delegate);

        expect(cycle.renderStackPop()).andReturn(fl);

        replay();

        fl.render(writer, cycle);

        assertBuffer("{LABEL-PREFIX}<label for=\"clientId\">{BEFORE-TEXT}MyLabel{AFTER-TEXT}</label>{LABEL-SUFFIX}");

        verify();
    }

    public void test_No_Display_Name_In_Field()
    {
        IForm form = newForm();
        IMarkupWriter writer = newBufferWriter();
        IFormComponent field = newField();
        Location l = newLocation();

        IRequestCycle cycle = newCycle();

        FieldLabel fl = newInstance(FieldLabel.class, "id", "label",
                                    "location", l,
                                    "field", field,
                                    "prerender", true);

        expect(cycle.renderStackPush(fl)).andReturn(fl);

        trainGetForm(cycle, form);
        form.prerenderField(writer, field, l);
        trainIsRewinding(cycle, false);
        trainGetDisplayName(field, null);
        trainGetExtendedId(field, "Fred/field");

        expect(cycle.renderStackPop()).andReturn(fl);

        replay();

        try
        {
            fl.render(writer, cycle);
            unreachable();
        }
        catch (BindingException ex)
        {
            assertEquals(
              "Display name for null was not specified and was not provided by field Fred/field.",
              ex.getMessage());
        }

        verify();
    }
}