You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cayenne.apache.org by aa...@apache.org on 2010/11/10 16:38:14 UTC

svn commit: r1033526 - in /cayenne/sandbox/cayenne-mixin/trunk/src: main/java/org/apache/cayenne/mixin/ main/java/org/apache/cayenne/mixin/ref/ test/java/org/apache/cayenne/mixin/ test/java/org/apache/cayenne/mixin/ref/

Author: aadamchik
Date: Wed Nov 10 15:38:14 2010
New Revision: 1033526

URL: http://svn.apache.org/viewvc?rev=1033526&view=rev
Log:
refactoring MixinHandlerManager - providing more generic interface + unit tests

(cherry picked from commit 2a396913b22ddda31aa036397099e9171b3e244e)

Added:
    cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MixinHandlerManagerTest.java
    cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MockMixin.java
      - copied, changed from r1033525, cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java
    cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MockMixinDataObject.java
      - copied, changed from r1033525, cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java
Modified:
    cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java
    cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandlerManager.java
    cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/ref/ReferenceableHandler.java
    cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/ref/UuidCoderTest.java

Modified: cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java
URL: http://svn.apache.org/viewvc/cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java?rev=1033526&r1=1033525&r2=1033526&view=diff
==============================================================================
--- cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java (original)
+++ cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java Wed Nov 10 15:38:14 2010
@@ -21,7 +21,6 @@ package org.apache.cayenne.mixin;
 import java.lang.annotation.Annotation;
 
 import org.apache.cayenne.DataObject;
-import org.apache.cayenne.reflect.LifecycleCallbackRegistry;
 
 /**
  * A handler that can be defined by application to setup lifecycle listeners for
@@ -32,8 +31,15 @@ import org.apache.cayenne.reflect.Lifecy
  */
 public interface MixinHandler<T extends Annotation> {
 
+	/**
+	 * Returns an Annotation class for the mixins recognized by this handler.
+	 */
 	Class<T> getMixinType();
 
-	void setupListeners(LifecycleCallbackRegistry registry,
-			Class<? extends DataObject> entityType);
+	/**
+	 * A callback method that allows handler to register a mixin on a given
+	 * entity, that may include setting up lifecyle listeners, or any other
+	 * processing deemed necessary by the handler.
+	 */
+	void addMixin(Class<? extends DataObject> entityType);
 }

Modified: cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandlerManager.java
URL: http://svn.apache.org/viewvc/cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandlerManager.java?rev=1033526&r1=1033525&r2=1033526&view=diff
==============================================================================
--- cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandlerManager.java (original)
+++ cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandlerManager.java Wed Nov 10 15:38:14 2010
@@ -63,9 +63,7 @@ public class MixinHandlerManager {
 			Class<?> entityTypeOrSupertype = entityType;
 			do {
 				if (entityTypeOrSupertype.isAnnotationPresent(type)) {
-					handler.setupListeners(
-							entityResolver.getCallbackRegistry(),
-							(Class<? extends DataObject>) entityType);
+					handler.addMixin((Class<? extends DataObject>) entityType);
 				}
 
 				entityTypeOrSupertype = entityTypeOrSupertype.getSuperclass();

Modified: cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/ref/ReferenceableHandler.java
URL: http://svn.apache.org/viewvc/cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/ref/ReferenceableHandler.java?rev=1033526&r1=1033525&r2=1033526&view=diff
==============================================================================
--- cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/ref/ReferenceableHandler.java (original)
+++ cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/ref/ReferenceableHandler.java Wed Nov 10 15:38:14 2010
@@ -100,12 +100,13 @@ public class ReferenceableHandler implem
 	}
 
 	@Override
-	public void setupListeners(LifecycleCallbackRegistry registry,
-			Class<? extends DataObject> entityType) {
+	public void addMixin(Class<? extends DataObject> entityType) {
 
 		ObjEntity entity = entityResolver.lookupObjEntity(entityType);
 		coders.put(entity.getName(), new UuidCoder(entity));
 
+		LifecycleCallbackRegistry registry = entityResolver
+				.getCallbackRegistry();
 		registry.addListener(LifecycleEvent.POST_PERSIST, entityType, this,
 				"initProperties");
 		registry.addListener(LifecycleEvent.POST_LOAD, entityType, this,

Added: cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MixinHandlerManagerTest.java
URL: http://svn.apache.org/viewvc/cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MixinHandlerManagerTest.java?rev=1033526&view=auto
==============================================================================
--- cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MixinHandlerManagerTest.java (added)
+++ cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MixinHandlerManagerTest.java Wed Nov 10 15:38:14 2010
@@ -0,0 +1,75 @@
+/*****************************************************************
+ *   Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you 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.cayenne.mixin;
+
+import junit.framework.TestCase;
+
+import org.apache.cayenne.CayenneDataObject;
+import org.apache.cayenne.map.DataMap;
+import org.apache.cayenne.map.EntityResolver;
+import org.apache.cayenne.map.ObjEntity;
+import org.mockito.invocation.InvocationOnMock;
+import org.mockito.stubbing.Answer;
+
+import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+public class MixinHandlerManagerTest extends TestCase {
+
+	public void testAddMixinHandler() {
+		EntityResolver resolver = new EntityResolver();
+		
+		DataMap map = new DataMap("m");
+		ObjEntity e1 = new ObjEntity("x");
+		e1.setClassName(MockMixinDataObject.class.getName());
+		map.addObjEntity(e1);
+		
+		ObjEntity e2 = new ObjEntity("y");
+		e2.setClassName(CayenneDataObject.class.getName());
+		map.addObjEntity(e2);
+		
+		resolver.addDataMap(map);
+		
+		MixinHandlerManager mixinHandlerManager = new MixinHandlerManager(
+				resolver);
+
+		MixinHandler<MockMixin> handler = mock(MixinHandler.class);
+		when(handler.getMixinType()).thenReturn(MockMixin.class);
+
+		// TODO: mockito replacement needed
+		final int[] counter = new int[1];
+
+		doAnswer(new Answer<Object>() {
+			@Override
+			public Object answer(InvocationOnMock invocation) throws Throwable {
+				Object[] args = invocation.getArguments();
+
+				assertEquals(1, args.length);
+				assertEquals(MockMixinDataObject.class, args[0]);
+				counter[0]++;
+				return null;
+			}
+		}).when(handler).addMixin(MockMixinDataObject.class);
+
+		assertEquals(0, counter[0]);
+		mixinHandlerManager.addMixinHandler(handler);
+		assertEquals(1, counter[0]);
+	}
+}

Copied: cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MockMixin.java (from r1033525, cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java)
URL: http://svn.apache.org/viewvc/cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MockMixin.java?p2=cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MockMixin.java&p1=cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java&r1=1033525&r2=1033526&rev=1033526&view=diff
==============================================================================
--- cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java (original)
+++ cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MockMixin.java Wed Nov 10 15:38:14 2010
@@ -18,22 +18,17 @@
  ****************************************************************/
 package org.apache.cayenne.mixin;
 
-import java.lang.annotation.Annotation;
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
 
-import org.apache.cayenne.DataObject;
-import org.apache.cayenne.reflect.LifecycleCallbackRegistry;
+@Target( { ElementType.TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Inherited
+public @interface MockMixin {
 
-/**
- * A handler that can be defined by application to setup lifecycle listeners for
- * a given mixin type.
- * 
- * @param <T>
- *            Custom mixin annotation type
- */
-public interface MixinHandler<T extends Annotation> {
-
-	Class<T> getMixinType();
-
-	void setupListeners(LifecycleCallbackRegistry registry,
-			Class<? extends DataObject> entityType);
 }

Copied: cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MockMixinDataObject.java (from r1033525, cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java)
URL: http://svn.apache.org/viewvc/cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MockMixinDataObject.java?p2=cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MockMixinDataObject.java&p1=cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java&r1=1033525&r2=1033526&rev=1033526&view=diff
==============================================================================
--- cayenne/sandbox/cayenne-mixin/trunk/src/main/java/org/apache/cayenne/mixin/MixinHandler.java (original)
+++ cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/MockMixinDataObject.java Wed Nov 10 15:38:14 2010
@@ -18,22 +18,9 @@
  ****************************************************************/
 package org.apache.cayenne.mixin;
 
-import java.lang.annotation.Annotation;
+import org.apache.cayenne.CayenneDataObject;
 
-import org.apache.cayenne.DataObject;
-import org.apache.cayenne.reflect.LifecycleCallbackRegistry;
+@MockMixin
+public class MockMixinDataObject extends CayenneDataObject {
 
-/**
- * A handler that can be defined by application to setup lifecycle listeners for
- * a given mixin type.
- * 
- * @param <T>
- *            Custom mixin annotation type
- */
-public interface MixinHandler<T extends Annotation> {
-
-	Class<T> getMixinType();
-
-	void setupListeners(LifecycleCallbackRegistry registry,
-			Class<? extends DataObject> entityType);
 }

Modified: cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/ref/UuidCoderTest.java
URL: http://svn.apache.org/viewvc/cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/ref/UuidCoderTest.java?rev=1033526&r1=1033525&r2=1033526&view=diff
==============================================================================
--- cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/ref/UuidCoderTest.java (original)
+++ cayenne/sandbox/cayenne-mixin/trunk/src/test/java/org/apache/cayenne/mixin/ref/UuidCoderTest.java Wed Nov 10 15:38:14 2010
@@ -1,3 +1,21 @@
+/*****************************************************************
+ *   Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you 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.cayenne.mixin.ref;
 
 import java.sql.Types;