CAY-2510 Create builder to load custom modules into plugins and modeler

RELEASE-NOTES.txt

@@ -16,6 +16,7 @@ Changes/New Features:
 CAY-2467 New type-aware Property API
 CAY-2507 Property API to use path aliases
 CAY-2508 Create api to add aliases in expressions
+CAY-2510 Create builder to load custom modules into plugins and modeler
 
 Bug Fixes:
 

cayenne-ant/src/main/java/org/apache/cayenne/tools/CayenneGeneratorTask.java

@@ -18,25 +18,24 @@
  ****************************************************************/
 package org.apache.cayenne.tools;
 
+import java.io.File;
+
 import foundrylogic.vpp.VPPConfig;
 import org.apache.cayenne.configuration.xml.DataChannelMetaData;
 import org.apache.cayenne.dbsync.filter.NamePatternMatcher;
 import org.apache.cayenne.dbsync.reverse.configuration.ToolsModule;
-import org.apache.cayenne.di.DIBootstrap;
 import org.apache.cayenne.di.Injector;
 import org.apache.cayenne.gen.ArtifactsGenerationMode;
 import org.apache.cayenne.gen.CgenConfiguration;
-import org.apache.cayenne.gen.CgenModule;
 import org.apache.cayenne.gen.ClassGenerationAction;
+import org.apache.cayenne.gen.ClassGenerationActionFactory;
 import org.apache.cayenne.gen.ClientClassGenerationAction;
 import org.apache.cayenne.map.DataMap;
 import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.types.Path;
 import org.apache.velocity.VelocityContext;
 import org.slf4j.LoggerFactory;
 
-import java.io.File;
-
 /**
  * An Ant task to perform class generation based on CayenneDataMap.
  * 
@@ -104,7 +103,9 @@ protected VelocityContext getVppContext() {
     public void execute() throws BuildException {
         validateAttributes();
 
-        injector = DIBootstrap.createInjector(new CgenModule(), new ToolsModule(LoggerFactory.getLogger(CayenneGeneratorTask.class)));
+        injector = new ToolsInjectorBuilder()
+                .addModule(new ToolsModule(LoggerFactory.getLogger(CayenneGeneratorTask.class)))
+                .create();
 
         logger = new AntLogger(this);
         CayenneGeneratorMapLoaderAction loadAction = new CayenneGeneratorMapLoaderAction(injector);
@@ -144,11 +145,7 @@ public void execute() throws BuildException {
 
     private ClassGenerationAction createGenerator(DataMap dataMap) {
         CgenConfiguration cgenConfiguration = buildConfiguration(dataMap);
-        ClassGenerationAction classGenerationAction = cgenConfiguration.isClient() ? new ClientClassGenerationAction(cgenConfiguration) :
-                new ClassGenerationAction(cgenConfiguration);
-        injector.injectMembers(classGenerationAction);
-
-        return classGenerationAction;
+        return injector.getInstance(ClassGenerationActionFactory.class).createAction(cgenConfiguration);
     }
 
     private boolean hasConfig() {

cayenne-cgen/pom.xml

@@ -54,6 +54,14 @@
             <scope>compile</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.apache.cayenne</groupId>
+            <artifactId>cayenne-server</artifactId>
+            <version>${project.version}</version>
+            <type>test-jar</type>
+            <scope>test</scope>
+        </dependency>
+
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

cayenne-cgen/src/main/java/org/apache/cayenne/gen/CgenModule.java

@@ -29,6 +29,7 @@
 public class CgenModule implements Module{
     @Override
     public void configure(Binder binder) {
+        binder.bind(ClassGenerationActionFactory.class).to(DefaultClassGenerationActionFactory.class);
         ProjectModule.contributeExtensions(binder).add(CgenExtension.class);
     }
 }

cayenne-cgen/src/main/java/org/apache/cayenne/gen/CgenToolsModuleProvider.java

@@ -0,0 +1,46 @@
+/*****************************************************************
+ *   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.gen;
+
+import java.util.Collection;
+import java.util.Collections;
+
+import org.apache.cayenne.di.Module;
+import org.apache.cayenne.tools.CayenneToolsModuleProvider;
+
+/**
+ * @since 4.2
+ */
+public class CgenToolsModuleProvider implements CayenneToolsModuleProvider {
+    @Override
+    public Module module() {
+        return new CgenModule();
+    }
+
+    @Override
+    public Class<? extends Module> moduleType() {
+        return CgenModule.class;
+    }
+
+    @Override
+    public Collection<Class<? extends Module>> overrides() {
+        return Collections.emptyList();
+    }
+}

cayenne-cgen/src/main/java/org/apache/cayenne/gen/ClassGenerationAction.java

@@ -19,15 +19,6 @@
 
 package org.apache.cayenne.gen;
 
-import org.apache.cayenne.CayenneRuntimeException;
-import org.apache.cayenne.map.Embeddable;
-import org.apache.cayenne.map.ObjEntity;
-import org.apache.cayenne.map.QueryDescriptor;
-import org.apache.velocity.Template;
-import org.apache.velocity.VelocityContext;
-import org.apache.velocity.app.VelocityEngine;
-import org.slf4j.Logger;
-
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
@@ -42,6 +33,15 @@
 import java.util.Properties;
 import java.util.stream.Collectors;
 
+import org.apache.cayenne.CayenneRuntimeException;
+import org.apache.cayenne.map.Embeddable;
+import org.apache.cayenne.map.ObjEntity;
+import org.apache.cayenne.map.QueryDescriptor;
+import org.apache.velocity.Template;
+import org.apache.velocity.VelocityContext;
+import org.apache.velocity.app.VelocityEngine;
+import org.slf4j.Logger;
+
 public class ClassGenerationAction {
 
 	private static final String TEMPLATES_DIR_NAME = "templates/v4_1/";
@@ -71,10 +71,9 @@ public class ClassGenerationAction {
     protected VelocityContext context;
     protected Map<String, Template> templateCache;
 
-	public ClassGenerationAction(CgenConfiguration cgenConfiguration) {
+	public ClassGenerationAction() {
 		this.context = new VelocityContext();
 		this.templateCache = new HashMap<>(5);
-		this.cgenConfiguration = cgenConfiguration;
 	}
 
 	public String defaultTemplateName(TemplateType type) {

cayenne-cgen/src/main/java/org/apache/cayenne/gen/ClassGenerationActionFactory.java

@@ -0,0 +1,27 @@
+/*****************************************************************
+ *   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.gen;
+
+/**
+ * @since 4.2
+ */
+public interface ClassGenerationActionFactory {
+
+    ClassGenerationAction createAction(CgenConfiguration cgenConfiguration);
+}

cayenne-cgen/src/main/java/org/apache/cayenne/gen/ClientClassGenerationAction.java

@@ -19,12 +19,12 @@
 
 package org.apache.cayenne.gen;
 
+import java.util.Collection;
+
 import org.apache.cayenne.CayenneRuntimeException;
 import org.apache.cayenne.map.ObjEntity;
 import org.apache.cayenne.map.QueryDescriptor;
 
-import java.util.Collection;
-
 /**
  * @since 3.0
  */
@@ -41,12 +41,8 @@ public class ClientClassGenerationAction extends ClassGenerationAction {
 
     public static final String CLIENT_SUPERCLASS_PREFIX = "_Client";
 
-    public ClientClassGenerationAction(CgenConfiguration cgenConfiguration) {
-        super(cgenConfiguration);
-        cgenConfiguration.setTemplate(SUBCLASS_TEMPLATE);
-        cgenConfiguration.setSuperTemplate(SUPERCLASS_TEMPLATE);
-        cgenConfiguration.setQueryTemplate(DMAP_SUBCLASS_TEMPLATE);
-        cgenConfiguration.setQuerySuperTemplate(DMAP_SUPERCLASS_TEMPLATE);
+    public ClientClassGenerationAction() {
+        super();
     }
 
     @Override
@@ -103,4 +99,12 @@ public void addQueries(Collection<QueryDescriptor> queries) {
             }
         }
     }
+
+    public void setCgenConfiguration(CgenConfiguration cgenConfiguration) {
+        super.setCgenConfiguration(cgenConfiguration);
+        cgenConfiguration.setTemplate(SUBCLASS_TEMPLATE);
+        cgenConfiguration.setSuperTemplate(SUPERCLASS_TEMPLATE);
+        cgenConfiguration.setQueryTemplate(DMAP_SUBCLASS_TEMPLATE);
+        cgenConfiguration.setQuerySuperTemplate(DMAP_SUPERCLASS_TEMPLATE);
+    }
 }

cayenne-cgen/src/main/java/org/apache/cayenne/gen/DefaultClassGenerationActionFactory.java

@@ -0,0 +1,36 @@
+/*****************************************************************
+ *   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.gen;
+
+/**
+ * @since 4.2
+ */
+public class DefaultClassGenerationActionFactory implements ClassGenerationActionFactory {
+
+    @Override
+    public ClassGenerationAction createAction(CgenConfiguration cgenConfiguration) {
+        ClassGenerationAction classGenerationAction = cgenConfiguration.isClient() ?
+                new ClientClassGenerationAction() :
+                new ClassGenerationAction();
+        classGenerationAction.setCgenConfiguration(cgenConfiguration);
+        return classGenerationAction;
+    }
+
+}

cayenne-cgen/src/main/java/org/apache/cayenne/tools/CayenneToolsModuleProvider.java

@@ -0,0 +1,28 @@
+/*****************************************************************
+ *   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.tools;
+
+import org.apache.cayenne.di.spi.ModuleProvider;
+
+/**
+ * @since 4.2
+ */
+public interface CayenneToolsModuleProvider extends ModuleProvider {
+}

cayenne-cgen/src/main/java/org/apache/cayenne/tools/ToolsInjectorBuilder.java

@@ -0,0 +1,59 @@
+/*****************************************************************
+ *   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.tools;
+
+import java.util.ArrayList;
+import java.util.Collection;
+
+import org.apache.cayenne.di.DIBootstrap;
+import org.apache.cayenne.di.Injector;
+import org.apache.cayenne.di.Module;
+import org.apache.cayenne.di.spi.ModuleLoader;
+
+/**
+ * @since 4.2
+ */
+public class ToolsInjectorBuilder {
+
+    private Collection<Module> modules;
+
+    public ToolsInjectorBuilder() {
+        this.modules = new ArrayList<>();
+    }
+
+    public ToolsInjectorBuilder addModule(Module module) {
+        modules.add(module);
+        return this;
+    }
+
+    public ToolsInjectorBuilder addModules(Collection<Module> modules) {
+        this.modules.addAll(modules);
+        return this;
+    }
+
+    private Collection<? extends Module> autoLoadedModules() {
+        return new ModuleLoader().load(CayenneToolsModuleProvider.class);
+    }
+
+    public Injector create() {
+        Collection<Module> allModules = new ArrayList<>(autoLoadedModules());
+        allModules.addAll(modules);
+        return DIBootstrap.createInjector(allModules);
+    }
+}

cayenne-cgen/src/main/resources/META-INF/services/org.apache.cayenne.tools.CayenneToolsModuleProvider

@@ -0,0 +1,20 @@
+##################################################################
+#   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.
+##################################################################
+
+org.apache.cayenne.gen.CgenToolsModuleProvider