CCM NG/ccm-cms: Body of ContentItemL10NManager and its test class.

git-svn-id: https://svn.libreccm.org/ccm/ccm_ng@4377 8810af33-2d31-482b-a856-94f89814c4df
pull/2/head
jensp 2016-10-13 17:56:14 +00:00
parent f26db01ce0
commit f2355d5b15
3 changed files with 498 additions and 1 deletions

View File

@ -0,0 +1,115 @@
/*
* Copyright (C) 2016 LibreCCM Foundation.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301 USA
*/
package org.librecms.contentsection;
import com.arsdigita.kernel.KernelConfig;
import org.libreccm.l10n.LocalizedString;
import org.libreccm.security.AuthorizationRequired;
import org.libreccm.security.RequiresPrivilege;
import org.librecms.CmsConstants;
import java.util.Locale;
import javax.enterprise.context.RequestScoped;
import javax.transaction.Transactional;
/**
* Manages the language versions of a content item.
*
* @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a>
*/
@RequestScoped
public class ContentItemL10NManager {
/**
* Checks if an content item has data for particular language.
*
* @param item The item to check.
* @param locale The locale to check for.
*
* @return {@link true} if the item has data for the language, {@code false}
* if not.
*/
@Transactional(Transactional.TxType.REQUIRED)
public boolean hasLanguage(final ContentItem item, final Locale locale) {
throw new UnsupportedOperationException();
}
/**
* Adds a language to a content item. The method will retrieve all fields of
* the type {@link LocalizedString} from the item and add a new entry for
* the provided locale by coping the value for the default language
* configured in {@link KernelConfig}. If a field does not have an entry for
* the default language the first value found is used.
*
* @param item The item to which the language variant is added.
* @param locale The locale of the language variant to add.
*/
@AuthorizationRequired
@Transactional(Transactional.TxType.REQUIRED)
public void addLanguage(
@RequiresPrivilege(CmsConstants.PRIVILEGE_ITEMS_EDIT)
final ContentItem item,
final Locale locale) {
throw new UnsupportedOperationException();
}
/**
* Removes a language variant from a content item. This method will retrieve
* all fields of the type {@link LocalizedString} from the item and remove
* the entry for the provided locale if the field has an entry for that
* locale.
*
* @param item The item from which the language variant is removed.
* @param locale The locale of the language variant to remove.
*/
@AuthorizationRequired
@Transactional(Transactional.TxType.REQUIRED)
public void removeLangauge(
@RequiresPrivilege(CmsConstants.PRIVILEGE_ITEMS_EDIT)
final ContentItem item,
final Locale locale) {
throw new UnsupportedOperationException();
}
/**
* This method normalises the values of the fields of type
* {@link LocalizedString} of an item. The method will first retrieve all
* fields of the type {@link LocalizedString} from the item and than build a
* set with all locales provided by any of the fields. After that the method
* will iterate over all {@link LocalizedString} fields and check if the
* {@link LocalizedString} has an entry for every language in the set. If
* not an entry for the language is added.
*
* @param item The item to normalise.
*/
@AuthorizationRequired
@Transactional(Transactional.TxType.REQUIRED)
public void normalizedLanguages(
@RequiresPrivilege(CmsConstants.PRIVILEGE_ITEMS_EDIT)
final ContentItem item) {
throw new UnsupportedOperationException();
}
}

View File

@ -0,0 +1,381 @@
/*
* Copyright (C) 2016 LibreCCM Foundation.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301 USA
*/
package org.librecms.contentsection;
import static org.libreccm.testutils.DependenciesHelpers.*;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.container.test.api.ShouldThrowException;
import org.jboss.arquillian.junit.Arquillian;
import org.jboss.arquillian.junit.InSequence;
import org.jboss.arquillian.persistence.CreateSchema;
import org.jboss.arquillian.persistence.PersistenceTest;
import org.jboss.arquillian.persistence.ShouldMatchDataSet;
import org.jboss.arquillian.persistence.UsingDataSet;
import org.jboss.arquillian.transaction.api.annotation.TransactionMode;
import org.jboss.arquillian.transaction.api.annotation.Transactional;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.asset.EmptyAsset;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.libreccm.tests.categories.IntegrationTest;
import java.util.Locale;
import javax.inject.Inject;
import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
/**
* Verifies the methods of the {@link ContentItemL10NManager}.
*
* @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a>
*/
@org.junit.experimental.categories.Category(IntegrationTest.class)
@RunWith(Arquillian.class)
@PersistenceTest
@Transactional(TransactionMode.COMMIT)
@CreateSchema({"create_ccm_cms_schema.sql"})
public class ContentItemL10NManagerTest {
@Inject
private ContentItemRepository itemRepo;
@Inject
private ContentItemManager itemManager;
@Inject
private ContentItemL10NManager l10nManager;
public ContentItemL10NManagerTest() {
}
@BeforeClass
public static void setUpClass() {
}
@AfterClass
public static void tearDownClass() {
}
@Before
public void setUp() {
}
@After
public void tearDown() {
}
@Deployment
public static WebArchive createDeployment() {
return ShrinkWrap
.create(WebArchive.class,
"LibreCCM-org.librecms.contentsection.ContentItemManagerTest.war")
.addPackage(org.libreccm.auditing.CcmRevision.class.getPackage())
.addPackage(org.libreccm.categorization.Categorization.class
.getPackage())
.addPackage(org.libreccm.cdi.utils.CdiUtil.class.getPackage())
.addPackage(org.libreccm.configuration.Configuration.class
.getPackage())
.addPackage(org.libreccm.core.CcmCore.class.getPackage())
.addPackage(org.libreccm.jpa.EntityManagerProducer.class
.getPackage())
.addPackage(org.libreccm.jpa.utils.MimeTypeConverter.class
.getPackage())
.addPackage(org.libreccm.l10n.LocalizedString.class
.getPackage())
.addPackage(org.libreccm.security.Permission.class.getPackage())
.addPackage(org.libreccm.web.CcmApplication.class.getPackage())
.addPackage(org.libreccm.workflow.Workflow.class.getPackage())
.addPackage(com.arsdigita.bebop.Component.class.getPackage())
.addPackage(com.arsdigita.bebop.util.BebopConstants.class
.getPackage())
.addClass(com.arsdigita.kernel.KernelConfig.class)
.addClass(com.arsdigita.runtime.CCMResourceManager.class)
.addClass(
com.arsdigita.ui.admin.applications.AbstractAppInstanceForm.class)
.addClass(
com.arsdigita.ui.admin.applications.AbstractAppSettingsPane.class)
.addClass(
com.arsdigita.ui.admin.applications.DefaultApplicationInstanceForm.class)
.addClass(
com.arsdigita.ui.admin.applications.DefaultApplicationSettingsPane.class)
.addClass(com.arsdigita.cms.dispatcher.ItemResolver.class)
.addPackage(com.arsdigita.util.Lockable.class.getPackage())
.addPackage(com.arsdigita.web.BaseServlet.class.getPackage())
.addPackage(org.librecms.Cms.class.getPackage())
.addPackage(org.librecms.assets.Asset.class.getPackage())
.addPackage(org.librecms.attachments.AttachmentList.class
.getPackage())
.addPackage(org.librecms.lifecycle.Lifecycle.class.getPackage())
.addPackage(org.librecms.contentsection.ContentSection.class
.getPackage())
.addPackage(org.librecms.contenttypes.Article.class.getPackage()).
addClass(com.arsdigita.kernel.security.SecurityConfig.class)
.addPackage(org.libreccm.tests.categories.IntegrationTest.class
.getPackage())
// .addAsLibraries(getModuleDependencies())
.addAsLibraries(getCcmCoreDependencies())
.addAsResource("configs/shiro.ini", "shiro.ini")
.addAsResource(
"configs/org/librecms/contentsection/ContentItemManagerTest/log4j2.xml",
"log4j2.xml")
.addAsResource("test-persistence.xml",
"META-INF/persistence.xml")
.addAsWebInfResource("test-web.xml", "web.xml")
.addAsWebInfResource(EmptyAsset.INSTANCE, "WEB-INF/beans.xml");
}
@Test
@InSequence(1)
public void checkInjections() {
assertThat(itemRepo, is(not(nullValue())));
assertThat(itemManager, is(not(nullValue())));
assertThat(l10nManager, is(not(nullValue())));
}
/**
* Verifies
* {@link ContentItemL10NManager#hasLanguage(org.librecms.contentsection.ContentItem, java.util.Locale)}
* with several content items.
*/
@Test
@InSequence(10)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
public void verifyHasLanguage() {
fail();
}
/**
* Verifies that
* {@link ContentItemL10NManager#hasLanguage(org.librecms.contentsection.ContentItem, java.util.Locale)}
* throws an {@link IllegalArgumentException} if called with {@code null}
* for the item.
*/
@Test(expected = IllegalArgumentException.class)
@InSequence(10)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldThrowException(IllegalArgumentException.class)
public void hasLanguageItemIsNull() {
fail();
}
/**
* Verifies that
* {@link ContentItemL10NManager#hasLanguage(org.librecms.contentsection.ContentItem, java.util.Locale)}
* throws an {@link IllegalArgumentException} if called with {@code null}
* for the language.
*/
@Test(expected = IllegalArgumentException.class)
@InSequence(10)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldThrowException(IllegalArgumentException.class)
public void hasLanguageLanguageIsNull() {
fail();
}
/**
* Tries to add language to a content item by using
* {@link ContentItemL10NManager#addLanguage(org.librecms.contentsection.ContentItem, java.util.Locale)}.
*/
@Test
@InSequence(20)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldMatchDataSet(
value = "datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/after-add-language.xml")
public void addLanguage() {
fail();
}
/**
* Verifies that calling
* {@link ContentItemL10NManager#addLanguage(org.librecms.contentsection.ContentItem, java.util.Locale)}
* with an existing language has not effect.
*/
@Test
@InSequence(20)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldMatchDataSet(
value = "datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
public void addLanguageAlreadyPresent() {
fail();
}
/**
* Verifies that {@link ContentItemL10NManager#addLanguage(org.librecms.contentsection.ContentItem, java.util.Locale)
* throws an {@link IllegalArgumentException} is called with
* {@code null} for the item.
*/
@Test(expected = IllegalArgumentException.class)
@InSequence(20)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldMatchDataSet(
value = "datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldThrowException(IllegalArgumentException.class)
public void addLanguageItemIsNull() {
fail();
}
/**
* Verifies that {@link ContentItemL10NManager#addLanguage(org.librecms.contentsection.ContentItem, java.util.Locale)
* throws an {@link IllegalArgumentException} is called with
* {@code null} for the language.
*/
@Test(expected = IllegalArgumentException.class)
@InSequence(20)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldMatchDataSet(
value = "datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldThrowException(IllegalArgumentException.class)
public void addLanguageLanguageIsNull() {
fail();
}
/**
* Tries to remove language from a content item by using null {@link ContentItemL10NManager#removeLangauge(org.librecms.contentsection.ContentItem, java.util.Locale)
*/
@Test
@InSequence(20)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldMatchDataSet(
value = "datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/after-remove-language.xml")
public void removeLanguage() {
fail();
}
/**
* Verifies that
* {@link ContentItemL10NManager#removeLangauge(org.librecms.contentsection.ContentItem, java.util.Locale)}
* has not effect if called for not present language.
*/
@Test
@InSequence(20)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldMatchDataSet(
value = "datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
public void removeNotPresentLanguage() {
fail();
}
/**
* Verifies that
* {@link ContentItemL10NManager#removeLangauge(org.librecms.contentsection.ContentItem, java.util.Locale)}
* throws an {@link IllegalArgumentException} if called with {@code null}
* for the item.
*/
@Test(expected = IllegalArgumentException.class)
@InSequence(20)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldMatchDataSet(
value = "datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldThrowException(IllegalArgumentException.class)
public void removeLanguageItemIsNull() {
fail();
}
/**
* Verifies that
* {@link ContentItemL10NManager#removeLangauge(org.librecms.contentsection.ContentItem, java.util.Locale)}
* throws an {@link IllegalArgumentException} if called with {@code null}
* for the language.
*/
@Test(expected = IllegalArgumentException.class)
@InSequence(20)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldMatchDataSet(
value = "datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldThrowException(IllegalArgumentException.class)
public void removeLanguageLanguageIsNull() {
fail();
}
/**
* Tries to normalise the languages of a content item by using null {@link ContentItemL10NManager#normalizedLanguages(org.librecms.contentsection.ContentItem)
*/
@Test
@InSequence(20)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldMatchDataSet(
value = "datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/after-normalize.xml")
public void normalizeItem() {
fail();
}
/**
* Verifies that calling
* {@link ContentItemL10NManager#normalizedLanguages(org.librecms.contentsection.ContentItem)}
* for already normalised item has not effect.
*/
@Test
@InSequence(20)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldMatchDataSet(
value = "datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
public void normalizeItemAlreadyNormalized() {
fail();
}
/**
* Verifies that
* {@link ContentItemL10NManager#normalizedLanguages(org.librecms.contentsection.ContentItem)}
* throws an {@link IllegalArgumentException} if called with {@code null}
* for the item.
*/
@Test(expected = IllegalArgumentException.class)
@InSequence(20)
@UsingDataSet("datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldMatchDataSet(
value = "datasets/org/librecms/contentsection/"
+ "ContentItemL10NManager/data.xml")
@ShouldThrowException(IllegalArgumentException.class)
public void normalizeItemNull() {
fail();
}
}

View File

@ -59,7 +59,8 @@ import static org.junit.Assert.*;
import static org.libreccm.testutils.DependenciesHelpers.*; import static org.libreccm.testutils.DependenciesHelpers.*;
/** /**
* * Tests for the {@link ContentItemManager}.
*
* @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a> * @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a>
*/ */
@org.junit.experimental.categories.Category(IntegrationTest.class) @org.junit.experimental.categories.Category(IntegrationTest.class)