FORGE-1685 Moved utility classes to scaffold-spi

forge · Mar 23, 2014 · f39b3e2 · gastaldi · Mar 24, 2014 · VineetReynolds
1 parent a851adf
commit f39b3e2
Show file tree

Hide file tree

Showing 11 changed files with 52 additions and 49 deletions.
diff --git a/scaffold/api/pom.xml b/scaffold/api/pom.xml
@@ -20,25 +20,5 @@
          <classifier>forge-addon</classifier>
          <scope>provided</scope>
       </dependency>
-      <dependency>
-         <groupId>org.jboss.forge.addon</groupId>
-         <artifactId>projects</artifactId>
-         <classifier>forge-addon</classifier>
-      </dependency>
-      <dependency>
-         <groupId>org.jboss.forge.addon</groupId>
-         <artifactId>parser-java</artifactId>
-         <classifier>forge-addon</classifier>
-         <scope>provided</scope>
-      </dependency>
-      <dependency>
-         <groupId>org.jboss.forge.addon</groupId>
-         <artifactId>javaee-api</artifactId>
-         <scope>provided</scope>
-      </dependency>
-      <dependency>
-         <groupId>org.metawidget.modules</groupId>
-         <artifactId>metawidget-all</artifactId>
-      </dependency>
    </dependencies>
 </project>
diff --git a/scaffold/pom.xml b/scaffold/pom.xml
@@ -38,6 +38,11 @@
             <artifactId>scaffold-impl</artifactId>
             <version>${project.version}</version>
          </dependency>
+         <dependency>
+            <groupId>org.jboss.forge.addon</groupId>
+            <artifactId>scaffold-services</artifactId>
+            <version>${project.version}</version>
+         </dependency>
          <dependency>
             <groupId>org.jboss.forge.addon</groupId>
             <artifactId>scaffold-spi</artifactId>

diff --git a/scaffold/spi/pom.xml b/scaffold/spi/pom.xml
@@ -14,16 +14,29 @@
 			<artifactId>projects</artifactId>
 			<classifier>forge-addon</classifier>
 		</dependency>
+        <dependency>
+            <groupId>org.jboss.forge.addon</groupId>
+            <artifactId>parser-java</artifactId>
+            <classifier>forge-addon</classifier>
+        </dependency>
 		<dependency>
 			<groupId>org.jboss.forge.addon</groupId>
 			<artifactId>ui</artifactId>
 			<classifier>forge-addon</classifier>
-		</dependency>		
+		</dependency>
+        <dependency>
+            <groupId>org.jboss.forge.addon</groupId>
+            <artifactId>javaee-api</artifactId>
+        </dependency>
 		<dependency>
 			<groupId>org.jboss.forge.furnace</groupId>
 			<artifactId>furnace-api</artifactId>
 			<scope>provided</scope>
 		</dependency>
+        <dependency>
+            <groupId>org.metawidget.modules</groupId>
+            <artifactId>metawidget-all</artifactId>
+        </dependency>
 	</dependencies>
 	<build>
 		<plugins>

diff --git a/...metawidget/MetawidgetInspectorFacade.java → ...metawidget/MetawidgetInspectorFacade.java b/...metawidget/MetawidgetInspectorFacade.java → ...metawidget/MetawidgetInspectorFacade.java
@@ -10,15 +10,12 @@
 import java.util.List;
 import java.util.Map;
 
-import javax.inject.Inject;
-
-import org.jboss.forge.addon.scaffold.spi.ScaffoldProvider;
 import org.jboss.forge.addon.projects.Project;
-import org.jboss.forge.parser.java.JavaClass;
 import org.jboss.forge.addon.scaffold.metawidget.inspector.ForgeInspector;
 import org.jboss.forge.addon.scaffold.metawidget.inspector.ForgeInspectorConfig;
 import org.jboss.forge.addon.scaffold.metawidget.inspector.propertystyle.ForgePropertyStyle;
 import org.jboss.forge.addon.scaffold.metawidget.inspector.propertystyle.ForgePropertyStyleConfig;
+import org.jboss.forge.parser.java.JavaClass;
 import org.metawidget.inspector.beanvalidation.BeanValidationInspector;
 import org.metawidget.inspector.composite.CompositeInspector;
 import org.metawidget.inspector.composite.CompositeInspectorConfig;
@@ -29,7 +26,7 @@
 import org.w3c.dom.Element;
 
 /**
- * A facade for Metawidget inspectors. This class wraps Metawidget API invocations for {@link ScaffoldProvider}
+ * A facade for Metawidget inspectors. This class provides an abstraction over Metawidget API invocations ScaffoldProvider
  * instances to invoke.
  * 
  * @author Vineet Reynolds
@@ -41,7 +38,6 @@ public class MetawidgetInspectorFacade
    private Project project;
    private CompositeInspector compositeInspector;
 
-   @Inject
    public MetawidgetInspectorFacade(Project project)
    {
       this.project = project;

diff --git a/...ector/ForgeInspectionResultConstants.java → ...ector/ForgeInspectionResultConstants.java b/...ector/ForgeInspectionResultConstants.java → ...ector/ForgeInspectionResultConstants.java
diff --git a/.../metawidget/inspector/ForgeInspector.java → .../metawidget/inspector/ForgeInspector.java b/.../metawidget/inspector/ForgeInspector.java → .../metawidget/inspector/ForgeInspector.java
@@ -16,19 +16,21 @@
 
 import javax.persistence.*;
 
+import org.jboss.forge.addon.parser.java.facets.JavaSourceFacet;
+import org.jboss.forge.addon.parser.java.resources.JavaResource;
+import org.jboss.forge.addon.projects.Project;
+import org.jboss.forge.addon.scaffold.metawidget.inspector.propertystyle.ForgePropertyStyle.ForgeProperty;
 import org.jboss.forge.parser.java.EnumConstant;
 import org.jboss.forge.parser.java.JavaClass;
 import org.jboss.forge.parser.java.JavaEnum;
 import org.jboss.forge.parser.java.JavaSource;
-import org.jboss.forge.addon.projects.Project;
-import org.jboss.forge.addon.parser.java.facets.JavaSourceFacet;
-import org.jboss.forge.addon.parser.java.resources.JavaResource;
-import org.jboss.forge.addon.scaffold.metawidget.inspector.propertystyle.ForgePropertyStyle.ForgeProperty;
+import org.metawidget.inspector.InspectionResultConstants;
 import org.metawidget.inspector.impl.BaseObjectInspector;
 import org.metawidget.inspector.impl.propertystyle.Property;
 import org.metawidget.util.CollectionUtils;
 import org.w3c.dom.Element;
 
+
 /**
  * Inspects Forge-specific metadata.
  *
@@ -93,7 +95,7 @@ protected Map<String, String> inspectProperty(Property property)
 
       if (property.isAnnotationPresent(OneToOne.class))
       {
-         attributes.put(ONE_TO_ONE, TRUE);
+         attributes.put(ONE_TO_ONE, InspectionResultConstants.TRUE);
          attributes.put(JPA_REL_TYPE, JPA_ONE_TO_ONE);
          getReversePrimaryKey(property, attributes);
          if (property.isAnnotationPresent(OneToOne.class))
@@ -104,15 +106,15 @@ protected Map<String, String> inspectProperty(Property property)
 
       if(property.isAnnotationPresent(Embedded.class) || isPropertyTypeEmbeddedable(property.getType()))
       {
-         attributes.put(EMBEDDABLE, TRUE);
+         attributes.put(EMBEDDABLE, InspectionResultConstants.TRUE);
       }
 
       // ManyToOne
 
       if (property.isAnnotationPresent(ManyToOne.class))
       {
          attributes.put(JPA_REL_TYPE, JPA_MANY_TO_ONE);
-         attributes.put(MANY_TO_ONE, TRUE);
+         attributes.put(MANY_TO_ONE, InspectionResultConstants.TRUE);
          getReversePrimaryKey(property, attributes);
          getManyToOneBidirectionalProperties(property, attributes);
       }
@@ -121,7 +123,7 @@ protected Map<String, String> inspectProperty(Property property)
 
       if (property.isAnnotationPresent(OneToMany.class) || property.isAnnotationPresent(ManyToMany.class))
       {
-         attributes.put(N_TO_MANY, TRUE);
+         attributes.put(N_TO_MANY, InspectionResultConstants.TRUE);
          getCollectionReversePrimaryKey(property, attributes);
          if (property.isAnnotationPresent(OneToMany.class))
          {
@@ -150,19 +152,19 @@ protected Map<String, String> inspectProperty(Property property)
                lookup.add(anEnum.getName());
             }
 
-            attributes.put(LOOKUP, CollectionUtils.toString(lookup));
+            attributes.put(InspectionResultConstants.LOOKUP, CollectionUtils.toString(lookup));
          }
       }
 
       // Id
 
       if (property.isAnnotationPresent(Id.class))
       {
-         attributes.put(PRIMARY_KEY, TRUE);
+         attributes.put(PRIMARY_KEY, InspectionResultConstants.TRUE);
       }
       if (property.isAnnotationPresent(GeneratedValue.class))
       {
-         attributes.put(GENERATED_VALUE, TRUE);
+         attributes.put(GENERATED_VALUE, InspectionResultConstants.TRUE);
       }
 
       return attributes;

diff --git a/...idget/inspector/ForgeInspectorConfig.java → ...idget/inspector/ForgeInspectorConfig.java b/...idget/inspector/ForgeInspectorConfig.java → ...idget/inspector/ForgeInspectorConfig.java
diff --git a/...tor/propertystyle/ForgePropertyStyle.java → ...tor/propertystyle/ForgePropertyStyle.java b/...tor/propertystyle/ForgePropertyStyle.java → ...tor/propertystyle/ForgePropertyStyle.java
@@ -14,10 +14,10 @@
 import java.util.List;
 import java.util.Map;
 
+import org.jboss.forge.addon.parser.java.facets.JavaSourceFacet;
+import org.jboss.forge.addon.projects.Project;
 import org.jboss.forge.parser.JavaParser;
 import org.jboss.forge.parser.java.*;
-import org.jboss.forge.addon.projects.Project;
-import org.jboss.forge.addon.parser.java.facets.JavaSourceFacet;
 import org.metawidget.inspector.iface.InspectorException;
 import org.metawidget.inspector.impl.propertystyle.BaseProperty;
 import org.metawidget.inspector.impl.propertystyle.BasePropertyStyle;
@@ -29,7 +29,7 @@
 
 /**
  * Inspects Forge-specific <tt>JavaSource</tt> objects for properties.
- *
+ * 
  * @author Richard Kennard
  */
 
@@ -62,7 +62,7 @@ public ForgePropertyStyle(final ForgePropertyStyleConfig config)
 
    /**
     * Traverses the given Class heirarchy using properties of the given names.
-    *
+    * 
     * @return the declared type (not actual type). May be null
     */
 
@@ -215,7 +215,7 @@ protected void lookupGetters(final Map<String, Property> properties, final Metho
 
    /**
     * Returns whether the given method is a 'getter' method.
-    *
+    * 
     * @param method a parameterless method that returns a non-void
     * @return the property name
     */
@@ -330,7 +330,7 @@ protected <O extends JavaSource<O>> void lookupSetters(final Map<String, Propert
 
    /**
     * Returns whether the given method is a 'setter' method.
-    *
+    * 
     * @param method a single-parametered method. May return non-void (ie. for Fluent interfaces)
     * @return the property name
     */
@@ -351,7 +351,7 @@ protected String isSetter(final Method<?> method)
 
    /**
     * Gets the private field representing the given <code>propertyName</code> within the given class.
-    *
+    * 
     * @return the private Field for this propertyName, or null if no such field (should not throw NoSuchFieldException)
     */
 
@@ -379,7 +379,7 @@ protected Field<?> getPrivateField(final FieldHolder<?> fieldHolder, final Strin
 
       // FORGE-402: support fields starting with capital letter
 
-      if (field == null && !Character.isUpperCase(propertyName.charAt( 0 )))
+      if (field == null && !Character.isUpperCase(propertyName.charAt(0)))
       {
          field = fieldHolder.getField(StringUtils.capitalize(propertyName));
       }
@@ -391,7 +391,7 @@ protected Field<?> getPrivateField(final FieldHolder<?> fieldHolder, final Strin
    // Private methods
    //
 
-   /*package private*/
+   /* package private */
 
    static JavaSource<?> sourceForName(final Project project, final String type)
    {
@@ -508,9 +508,10 @@ public <T extends Annotation> T getAnnotation(final Class<T> annotationClass)
 
       public List<EnumConstant<JavaEnum>> getEnumConstants()
       {
-         JavaSource<?> source = sourceForName( this.project, getType() );
+         JavaSource<?> source = sourceForName(this.project, getType());
 
-         if ( source instanceof JavaEnum ) {
+         if (source instanceof JavaEnum)
+         {
             return ((JavaEnum) source).getEnumConstants();
          }
 

diff --git a/...opertystyle/ForgePropertyStyleConfig.java → ...opertystyle/ForgePropertyStyleConfig.java b/...opertystyle/ForgePropertyStyleConfig.java → ...opertystyle/ForgePropertyStyleConfig.java
diff --git a/...rge/addon/scaffold/util/ScaffoldUtil.java → ...rge/addon/scaffold/util/ScaffoldUtil.java b/...rge/addon/scaffold/util/ScaffoldUtil.java → ...rge/addon/scaffold/util/ScaffoldUtil.java
diff --git a/...t/java/org/jboss/forge/addon/scaffold/metawidget/inspector/propertystyle/StubProject.java b/...t/java/org/jboss/forge/addon/scaffold/metawidget/inspector/propertystyle/StubProject.java
@@ -10,6 +10,7 @@
 import org.jboss.forge.addon.projects.Project;
 import org.jboss.forge.addon.projects.ProjectFacet;
 import org.jboss.forge.addon.resource.DirectoryResource;
+import org.jboss.forge.addon.resource.Resource;
 
 /**
  * A stubbed out implementation of a Project
@@ -36,6 +37,11 @@ public DirectoryResource getRootDirectory() {
         return null;
     }
 
+    @Override
+    public Resource<?> getRoot() {
+        return null;
+    }
+
     @Override
     public boolean hasFacet(Class<? extends ProjectFacet> type) {
         return false;