StatListTest.java

/*
 * StatListTest.java
 * Copyright 2007 (C) James Dempsey
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * Created on 08/12/2007
 *
 * $Id$
 */

package pcgen.core;

import org.junit.Test;

import pcgen.AbstractCharacterTestCase;
import pcgen.cdom.base.FormulaFactory;
import pcgen.cdom.enumeration.ListKey;
import pcgen.cdom.helper.StatLock;
import pcgen.cdom.reference.CDOMDirectSingleRef;
import pcgen.core.bonus.Bonus;
import pcgen.core.bonus.BonusObj;
import pcgen.rules.context.LoadContext;
import pcgen.util.TestHelper;

/**
 * <code>StatListTest</code> checks the function of the 
 * StatList class. 
 *
 *
 * @author James Dempsey <jdempsey@users.sourceforge.net>
 */
public class StatListTest extends AbstractCharacterTestCase
{
	PCTemplate locker;
	PCTemplate unlocker;
	Ability bonus;
	Ability lockedBonus;

	/* (non-Javadoc)
	 * @see pcgen.AbstractCharacterTestCase#setUp()
	 */
	@Override
	protected void setUp() throws Exception
	{
		super.setUp();
		PlayerCharacter pc = getCharacter();
		LoadContext context = Globals.getContext();

		locker = new PCTemplate();
		locker.setName("locker");
		CDOMDirectSingleRef<PCStat> strRef = CDOMDirectSingleRef.getRef(str);
		locker.addToListFor(ListKey.STAT_LOCKS, new StatLock(strRef, FormulaFactory.getFormulaFor(12)));
		unlocker = new PCTemplate();
		unlocker.setName("unlocker");
		unlocker.addToListFor(ListKey.UNLOCKED_STATS, strRef);
		bonus = TestHelper.makeAbility("Bonus", AbilityCategory.FEAT, "General.Fighter");
		BonusObj aBonus = Bonus.newBonus(context, "STAT|STR|7|TYPE=Enhancement");
		if (aBonus != null)
		{
			bonus.addToListFor(ListKey.BONUS, aBonus);
		}
		lockedBonus = TestHelper.makeAbility("LockedBonus", AbilityCategory.FEAT, "General.Fighter");
		aBonus = Bonus.newBonus(context, "LOCKEDSTAT|STR|3|TYPE=Morale");
		if (aBonus != null)
		{
			lockedBonus.addToListFor(ListKey.BONUS, aBonus);
		}

		setPCStat(pc, str, 6);
	}

	/**
	 * Test method for {@link pcgen.core.StatList#getBaseStatFor(java.lang.String)}.
	 */
	@Test
	public void testGetBaseStatFor()
	{
		PlayerCharacter pc = getCharacter();
		assertEquals("Starting STR should be 6", 6, pc.getBaseStatFor(str));

		// Bonus should not affect base stat
		addAbility(AbilityCategory.FEAT, bonus);
		pc.calcActiveBonuses();
		assertEquals("Stat should still be base", 6, pc.getBaseStatFor(str));
		
		pc.addTemplate(locker);
		assertEquals("Stat should now be locked", 12, pc.getBaseStatFor(str));

		addAbility(AbilityCategory.FEAT, lockedBonus);
		pc.calcActiveBonuses();
		assertEquals("Stat should still be locked", 12, pc.getBaseStatFor(str));
		
		pc.addTemplate(unlocker);
		assertEquals("Stat should now be unlocked", 6, pc.getBaseStatFor(str));
	}

	/**
	 * Test method for {@link pcgen.core.StatList#getTotalStatFor(java.lang.String)}.
	 */
	@Test
	public void testGetTotalStatFor()
	{
		PlayerCharacter pc = getCharacter();
		assertEquals("Starting STR should be 6", 6, pc.getTotalStatFor(str));

		// Bonus should affect total stat
		addAbility(AbilityCategory.FEAT, bonus);
		pc.calcActiveBonuses();
		assertEquals("Stat should have bonus", 13, pc.getTotalStatFor(str));
		
		pc.addTemplate(locker);
		assertEquals("Stat should now be locked", 12, pc.getTotalStatFor(str));

		addAbility(AbilityCategory.FEAT, lockedBonus);
		pc.calcActiveBonuses();
		assertEquals("Stat should be locked but bonused", 15, pc.getTotalStatFor(str));

		pc.addTemplate(unlocker);
		assertEquals("Stat should now be unlocked", 13, pc.getTotalStatFor(str));
	}
	
	/**
	 * Test out the output of stats where a min value is in place. 
	 */
	public void testMinValueStat()
	{
		PlayerCharacter pc = getCharacter();
		assertEquals("Starting STR should be 6", 6, pc.getTotalStatFor(str));
		assertEquals("Starting STR mod", -2, pc.getStatModFor(str));

		// With template lock
		PCTemplate statMinValTemplate = new PCTemplate();
		statMinValTemplate.setName("minval");
		statMinValTemplate.addToListFor(ListKey.STAT_MINVALUE, new StatLock(
			CDOMDirectSingleRef.getRef(str), FormulaFactory.getFormulaFor(8)));
		pc.addTemplate(statMinValTemplate);
		assertEquals("STR now has minimum value", 8, pc.getTotalStatFor(str));
		assertEquals("Starting STR mod", -1, pc.getStatModFor(str));
		pc.removeTemplate(statMinValTemplate);
		assertEquals("STR no longer has minimum value", 6, pc.getTotalStatFor(str));
		assertEquals("Starting STR mod", -2, pc.getStatModFor(str));
	}

}