DefaultI18NProcessorTest.java

/*
 *
 *  * Copyright (c) 2016. David Sowerby
 *  *
 *  * 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 uk.q3c.krail.core.i18n;

import com.google.inject.AbstractModule;
import com.google.inject.Inject;
import com.mycila.testing.junit.MycilaJunitRunner;
import com.mycila.testing.plugin.guice.GuiceContext;
import com.mycila.testing.plugin.guice.ModuleProvider;
import com.vaadin.ui.Button;
import com.vaadin.ui.Label;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import uk.q3c.krail.core.eventbus.EventBusModule;
import uk.q3c.krail.core.guice.uiscope.UIScopeModule;
import uk.q3c.krail.core.guice.vsscope.VaadinSessionScopeModule;
import uk.q3c.krail.core.persist.inmemory.option.DefaultInMemoryOptionStore;
import uk.q3c.krail.core.persist.inmemory.option.InMemoryOptionStore;
import uk.q3c.krail.testutil.i18n.TestI18NModule;
import uk.q3c.krail.testutil.option.MockOption;
import uk.q3c.krail.testutil.option.TestOptionModule;
import uk.q3c.krail.testutil.persist.TestPersistenceModule;

import java.util.Locale;

import static org.assertj.core.api.Assertions.assertThat;

@RunWith(MycilaJunitRunner.class)
@GuiceContext({TestI18NModule.class, TestOptionModule.class, TestPersistenceModule.class, EventBusModule.class, UIScopeModule.class, VaadinSessionScopeModule.class, })
public class DefaultI18NProcessorTest {

    I18NTestClass testObject;
    I18NTestClass2 testObject2;
    I18NTestClass3 testObject3;

    @Inject
    CurrentLocale currentLocale;

    @Inject
    MockOption option;

    @Inject
    DefaultI18NProcessor processor;

    @Before
    public void setup() {
        Locale.setDefault(Locale.UK);
        testObject = new I18NTestClass();
        testObject2 = new I18NTestClass2();
        testObject3 = new I18NTestClass3();
        currentLocale.setLocale(Locale.UK);

    }

    @Test
    public void interpret() {

        // given
        // when
        processor.translate(testObject);
        // then
        assertThat(testObject.getNewButton()
                             .getCaption()).isEqualTo("Authentication");

        // no guarantee is made to which is returned when there are multiple overlapping annotations
        assertThat(testObject.getNewButton()
                             .getDescription()).isIn("Please log in", "This account is already in use.  You must log out of that session before you can log " +
                "in again.");
        assertThat(testObject.getNewButton()
                             .getLocale()).isEqualTo(Locale.UK);


        assertThat(testObject.getButtonWithAnnotation()
                             .getCaption()).isEqualTo("Ok");
        assertThat(testObject.getButtonWithAnnotation()
                             .getDescription()).isEqualTo("Confirm this Value is Ok");
        assertThat(testObject.getButtonWithAnnotation()
                             .getLocale()).isEqualTo(Locale.UK);

        assertThat(testObject.getLabel()
                             .getCaption()).isEqualTo("Ok");
        assertThat(testObject.getLabel()
                             .getDescription()).isEqualTo("Confirm this Value is Ok");
        // assertThat(testObject.getLabel().getValue()).isEqualTo("Ok");
        assertThat(testObject.getLabel()
                             .getLocale()).isEqualTo(Locale.UK);

        assertThat(testObject.getTable()
                             .getCaption()).isEqualTo("Ok");
        assertThat(testObject.getTable()
                             .getDescription()).isEqualTo("Confirm this Value is Ok");
        assertThat(testObject.getTable()
                             .getLocale()).isEqualTo(Locale.UK);

        Object[] columns = testObject.getTable()
                                     .getVisibleColumns();
        assertThat(columns.length).isEqualTo(3);

        String[] headers = testObject.getTable()
                                     .getColumnHeaders();
        assertThat(headers).isEqualTo(new String[]{"Small", "Cancel", "not i18N"});

        // class annotation overruled by field annotation
        TestCompositeComponent ccs = testObject.getCcs();
        assertThat(ccs.getCaption()).isEqualTo("Field");
        assertThat(ccs.getLabelInsideTcc()).isNotNull();
        Label label = ccs.getLabelInsideTcc();
        // assertThat(label.getValue()).isEqualTo("Ok");
        assertThat(label.getDescription()).isEqualTo("Confirm this Value is Ok"); //drill down needed

        // class annotation
        TestCompositeComponent ccc = testObject.getCcc();
        assertThat(ccc.getCaption()).isEqualTo("Class");
        assertThat(ccc.getLabelInsideTcc()).isNotNull();
        label = ccc.getLabelInsideTcc();
        // assertThat(label.getValue()).isEqualTo("Ok");
        assertThat(label.getDescription()).isEqualTo("Confirm this Value is Ok");

        // composite but not a component
        TestCompositeNonComponent cnc = testObject.getCnc();
        // assertThat(cnc.getLabel().getValue()).isEqualTo("Cancel");

        // nested component
        TestCompositeComponentNested ccn = testObject.getCcn();
        assertThat(ccn.getCaption()).isEqualTo("Field");
        TestCompositeComponent ccs2 = ccn.getCcs();
        assertThat(ccs2.getCaption()).isEqualTo("Nested");

        // specific locale
        Button specificLocale = testObject.getSpecificLocale();
        assertThat(specificLocale.getCaption()).isEqualTo("Ja");


        // value
        Label value = testObject.getValue();
        assertThat(value.getValue()).isEqualTo("Guest");

        // valueLocale
        Label valueLocale = testObject.getValueLocale();
        assertThat(valueLocale.getValue()).isEqualTo("Ja");

    }



    @Test
    public void interpret_de() {

        String confirmValueOk = "Bestätigen Sie, dass dieser Wert in Ordnung ist";

        // given
        currentLocale.setLocale(Locale.GERMANY);
        // when
        processor.translate(testObject);
        // then
        assertThat(testObject.getButtonWithAnnotation()
                             .getCaption()).isEqualTo("OK");
        assertThat(testObject.getButtonWithAnnotation()
                             .getDescription()).isEqualTo(confirmValueOk);
        assertThat(testObject.getButtonWithAnnotation()
                             .getLocale()).isEqualTo(Locale.GERMANY);

        assertThat(testObject.getLabel()
                             .getCaption()).isEqualTo("OK");
        assertThat(testObject.getLabel()
                             .getDescription()).isEqualTo(confirmValueOk);
        // assertThat(testObject.getLabel().getValue()).isEqualTo("Ok");
        assertThat(testObject.getButtonWithAnnotation()
                             .getLocale()).isEqualTo(Locale.GERMANY);

        assertThat(testObject.getTable()
                             .getCaption()).isEqualTo("OK");
        assertThat(testObject.getTable()
                             .getDescription()).isEqualTo(confirmValueOk);
        assertThat(testObject.getButtonWithAnnotation()
                             .getLocale()).isEqualTo(Locale.GERMANY);

        Object[] columns = testObject.getTable()
                                     .getVisibleColumns();
        assertThat(columns.length).isEqualTo(3);

        String[] headers = testObject.getTable()
                                     .getColumnHeaders();
        assertThat(headers).isEqualTo(new String[]{"Klein", "Stornieren", "not i18N"});

    }


    @ModuleProvider
    protected AbstractModule moduleProvider() {
        return new AbstractModule() {

            @Override
            protected void configure() {
                bind(InMemoryOptionStore.class).to(DefaultInMemoryOptionStore.class);
            }

        };
    }
}