/*
    * Copyright 2006 Stephen Duncan Jr
    * 
    * 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 com.stephenduncanjr.easymock;
  
  import static org.easymock.EasyMock.reportMatcher;
  
  import java.beans.PropertyDescriptor;
  import java.lang.reflect.InvocationTargetException;
  import java.lang.reflect.Method;
  import java.util.Arrays;
  import java.util.HashMap;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Map;
  
  import org.apache.commons.beanutils.PropertyUtils;
  
  import com.stephenduncanjr.easymock.matcher.BeanProperty;
  
  /***
   * Utilities for using EasyMock.
   * 
   * @author stephen.duncan (Stephen C. Duncan Jr.
   *         <stephen.duncan@gmail.com>)
   * @since 1.0
   */
  public class EasyMockPropertyUtils
  {
  	/*** Empty List. */
  	private static final List<String> EMPTY = new LinkedList<String>();
  
  	/***
  	 * Disables object creation.
  	 */
  	private EasyMockPropertyUtils()
  	{
  		// Hide constructor
  	}
  
  	/***
  	 * EasyMock matcher for the properties on the object to be matched being
  	 * equal to the mapped value.
  	 * 
  	 * @param <T>
  	 *        The type of object to match.
  	 * @param inClass
  	 *        The type of the object to match.
  	 * @param properties
  	 *        The map of property names to property values.
  	 * @return fake return value for EasyMock use.
  	 * @since 1.1
  	 */
  	public static <T> T propEq(@SuppressWarnings("unused")
  	final Class<T> inClass, final Map<String, ?> properties)
  	{
  		reportMatcher(new BeanProperty(properties));
  		return null;
  	}
  
  	/***
  	 * EasyMock matcher for the properties on the argument to match the
  	 * properties on the given object.
  	 * 
  	 * @param <T>
  	 *        The type of object to match.
  	 * @param inClass
  	 *        The type of the object to match.
  	 * @param valuesObject
  	 *        the object to match values against.
  	 * @return fake return value for EasyMock use.
  	 * @since 1.1
  	 */
  	public static <T> T propEq(@SuppressWarnings("unused")
  	final Class<T> inClass, final Object valuesObject)
  	{
  		reportMatcher(new BeanProperty(retrieveAndFilterProperties(valuesObject, EMPTY)));
  		return null;
  	}
  
  	/***
  	 * EasyMock matcher for the properties on the argument to match the
  	 * properties on the given object, ignoring the properties named in the
  	 * given list.
  	 * 
  	 * @param <T>
  	 *        The type of object to match.
  	 * @param inClass
  	 *        The type of the object to match.
 	 * @param valuesObject
 	 *        the object to match values against.
 	 * @param ignored
 	 *        the list of property names to ignore.
 	 * @return fake return value for EasyMock use.
 	 * @since 1.1
 	 */
 	public static <T> T propEq(@SuppressWarnings("unused")
 	final Class<T> inClass, final Object valuesObject, final List<String> ignored)
 	{
 		reportMatcher(new BeanProperty(retrieveAndFilterProperties(valuesObject, ignored)));
 		return null;
 	}
 
 	/***
 	 * EasyMock matcher for the properties on the argument to match the
 	 * properties on the given object, ignoring the properties named in the
 	 * given array.
 	 * 
 	 * @param <T>
 	 *        The type of object to match.
 	 * @param inClass
 	 *        The type of the object to match.
 	 * @param valuesObject
 	 *        the object to match values against.
 	 * @param ignored
 	 *        the list of property names to ignore.
 	 * @return fake return value for EasyMock use.
 	 * @since 1.1
 	 */
 	public static <T> T propEq(@SuppressWarnings("unused")
 	final Class<T> inClass, final Object valuesObject, final String[] ignored)
 	{
 		reportMatcher(new BeanProperty(retrieveAndFilterProperties(valuesObject, Arrays.asList(ignored))));
 		return null;
 	}
 
 	/***
 	 * EasyMock matcher for the property on the object to be matched being equal
 	 * to the given value.
 	 * 
 	 * @param <T>
 	 *        The type of object to match.
 	 * @param inClass
 	 *        The type of the object to match.
 	 * @param property
 	 *        the name of the property.
 	 * @param value
 	 *        The value of the property to ccompare against.
 	 * @return fake return value for EasyMock use.
 	 * @since 1.1
 	 */
 	public static <T> T propEq(@SuppressWarnings("unused")
 	final Class<T> inClass, final String property, final Object value)
 	{
 		reportMatcher(new BeanProperty(property, value));
 		return null;
 	}
 
 	/***
 	 * EasyMock matcher for the properties on the argument to match the
 	 * properties on the given object.
 	 * 
 	 * @param <T>
 	 *        The type of object to match.
 	 * @param valuesObject
 	 *        the object to match values against.
 	 * @return fake return value for EasyMock use.
 	 * @since 1.1
 	 */
 	public static <T> T propEq(final T valuesObject)
 	{
 		reportMatcher(new BeanProperty(retrieveAndFilterProperties(valuesObject, EMPTY)));
 		return null;
 	}
 
 	/***
 	 * EasyMock matcher for the properties on the argument to match the
 	 * properties on the given object, ignoring the properties named in the
 	 * given list.
 	 * 
 	 * @param <T>
 	 *        The type of object to match.
 	 * @param valuesObject
 	 *        the object to match values against.
 	 * @param ignored
 	 *        the list of property names to ignore.
 	 * @return fake return value for EasyMock use.
 	 * @since 1.1
 	 */
 	public static <T> T propEq(final T valuesObject, final List<String> ignored)
 	{
 		reportMatcher(new BeanProperty(retrieveAndFilterProperties(valuesObject, ignored)));
 		return null;
 	}
 
 	/***
 	 * EasyMock matcher for the properties on the argument to match the
 	 * properties on the given object, ignoring the properties named in the
 	 * given array.
 	 * 
 	 * @param <T>
 	 *        The type of object to match.
 	 * @param valuesObject
 	 *        the object to match values against.
 	 * @param ignored
 	 *        the list of property names to ignore.
 	 * @return fake return value for EasyMock use.
 	 * @since 1.1
 	 */
 	public static <T> T propEq(final T valuesObject, final String[] ignored)
 	{
 		reportMatcher(new BeanProperty(retrieveAndFilterProperties(valuesObject, Arrays.asList(ignored))));
 		return null;
 	}
 
 	/***
 	 * EasyMock matcher for the properties on the object to be matched being
 	 * equal to the mapped value.
 	 * 
 	 * @param <T>
 	 *        The type of object to match.
 	 * @param inClass
 	 *        The type of the object to match.
 	 * @param properties
 	 *        The map of property names to property values.
 	 * @return fake return value for EasyMock use.
 	 * @deprecated As of 1.1, replaced by {@link #propEq(Class, Map)}
 	 */
 	@Deprecated
 	public static <T> T propertiesEq(@SuppressWarnings("unused")
 	final Class<T> inClass, final Map<String, ?> properties)
 	{
 		return EasyMockPropertyUtils.propertiesEq(inClass, properties);
 	}
 
 	/***
 	 * EasyMock matcher for the property on the object to be matched being equal
 	 * to the given value.
 	 * 
 	 * @param <T>
 	 *        The type of object to match.
 	 * @param inClass
 	 *        The type of the object to match.
 	 * @param property
 	 *        the name of the property.
 	 * @param value
 	 *        The value of the property to ccompare against.
 	 * @return fake return value for EasyMock use. *
 	 * @deprecated As of 1.1, replaced by {@link #propEq(Class, String, Object)}
 	 */
 	@Deprecated
 	public static <T> T propertyEq(@SuppressWarnings("unused")
 	final Class<T> inClass, final String property, final Object value)
 	{
 		return EasyMockPropertyUtils.propEq(inClass, property, value);
 	}
 
 	/***
 	 * Gets the properties and values from the object as a map, ignoring the
 	 * properties specified.
 	 * 
 	 * @param bean
 	 * @param ignoredProperties
 	 * @return map of properties names to values.
 	 */
 	private static Map<String, Object> retrieveAndFilterProperties(final Object bean, final List<String> ignoredProperties)
 	{
 		final Map<String, Object> map = new HashMap<String, Object>();
 
 		try
 		{
 			for(final PropertyDescriptor p : PropertyUtils.getPropertyDescriptors(bean))
 			{
 				if(!ignoredProperties.contains(p.getName()) && !"class".equals(p.getName()))
 				{
 					final Method readMethod = p.getReadMethod();
 					
 					if (readMethod != null) {
 						map.put(p.getName(), readMethod.invoke(bean));
 					}
 				}
 			}
 		}
 		catch(final IllegalAccessException e)
 		{
 			throw new IllegalArgumentException(e);
 		}
 		catch(final InvocationTargetException e)
 		{
 			throw new IllegalArgumentException(e);
 		}
 
 		return map;
 	}
 }