FORGE-1100: Introduced ConfigurationFactory and ConfigurationProducer

forge · Aug 10, 2013 · 27f2ada · 27f2ada
1 parent ba7b9a5
commit 27f2ada
Show file tree

Hide file tree

Showing 6 changed files with 104 additions and 51 deletions.
diff --git a/...ge/project/facets/ConfigurationFacet.java → ...g/jboss/forge/env/ConfigurationFacet.java b/...ge/project/facets/ConfigurationFacet.java → ...g/jboss/forge/env/ConfigurationFacet.java
@@ -1,9 +1,8 @@
-package org.jboss.forge.project.facets;
+package org.jboss.forge.env;
 
 import javax.inject.Inject;
 
-import org.jboss.forge.env.Configuration;
-import org.jboss.forge.env.ConfigurationScope;
+import org.jboss.forge.project.facets.BaseFacet;
 import org.jboss.forge.shell.plugins.Alias;
 
 /**
@@ -14,11 +13,16 @@
 @Alias("forge.configuration.facet")
 public class ConfigurationFacet extends BaseFacet
 {
-   @Inject
-   private Configuration configuration;
+   private ConfigurationFactory factory;
 
    private Configuration projectConfiguration;
 
+   @Inject
+   public ConfigurationFacet(ConfigurationFactory configurationFactory)
+   {
+      this.factory = configurationFactory;
+   }
+
    public Configuration getConfiguration()
    {
       return projectConfiguration;
@@ -27,7 +31,10 @@ public Configuration getConfiguration()
    @Override
    public boolean install()
    {
-      projectConfiguration = configuration.getScopedConfiguration(ConfigurationScope.PROJECT);
+      if (projectConfiguration == null)
+      {
+         projectConfiguration = factory.getProjectConfig(getProject());
+      }
       return true;
    }
 

diff --git a/shell-api/src/main/java/org/jboss/forge/env/ConfigurationFactory.java b/shell-api/src/main/java/org/jboss/forge/env/ConfigurationFactory.java
@@ -0,0 +1,15 @@
+package org.jboss.forge.env;
+
+import org.jboss.forge.project.Project;
+
+/**
+ * Creates {@link Configuration} objects for the requested scopes
+ * 
+ * @author <a href="ggastald@redhat.com">George Gastaldi</a>
+ */
+public interface ConfigurationFactory
+{
+   public Configuration getUserConfig();
+
+   public Configuration getProjectConfig(Project project);
+}
diff --git a/...ss/forge/shell/env/ConfigurationImpl.java → ...e/shell/env/ConfigurationFactoryImpl.java b/...ss/forge/shell/env/ConfigurationImpl.java → ...e/shell/env/ConfigurationFactoryImpl.java
@@ -15,80 +15,64 @@
 import org.jboss.forge.ForgeEnvironment;
 import org.jboss.forge.env.Configuration;
 import org.jboss.forge.env.ConfigurationException;
+import org.jboss.forge.env.ConfigurationFactory;
 import org.jboss.forge.env.ConfigurationScope;
 import org.jboss.forge.project.Project;
 import org.jboss.forge.resources.FileResource;
 import org.jboss.forge.shell.Shell;
 import org.jboss.forge.shell.squelch.ConfigAdapterQualifierLiteral;
 import org.jboss.forge.shell.util.BeanManagerUtils;
-import org.jboss.solder.unwraps.Unwraps;
 
 /**
  * @author <a href="mailto:lincolnbaxter@gmail.com">Lincoln Baxter, III</a>
  * 
  */
 @ApplicationScoped
-public class ConfigurationImpl
+public class ConfigurationFactoryImpl implements ConfigurationFactory
 {
-   private Shell shell;
    private ForgeEnvironment environment;
-   private ScopedConfigurationAdapter userConfig;
-   private ScopedConfigurationAdapter projectConfig;
-   private Project currentProject;
+   private Configuration userConfig;
    private BeanManager bm;
 
-   public ConfigurationImpl()
+   public ConfigurationFactoryImpl()
    {
    }
 
    @Inject
-   public ConfigurationImpl(final Shell shell, BeanManager bm)
+   public ConfigurationFactoryImpl(final Shell shell, BeanManager bm)
    {
       this.bm = bm;
-      this.shell = shell;
       this.environment = shell.getEnvironment();
    }
 
-   @Unwraps
-   public Configuration getConfiguration() throws ConfigurationException
+   @Override
+   public Configuration getProjectConfig(Project project)
    {
-
-      Project project = shell.getCurrentProject();
-      if ((project != null) && !project.equals(this.currentProject))
+      ScopedConfigurationAdapter projectConfig = new ScopedConfigurationAdapter();
+      XMLConfiguration projectLocalConfig;
+      try
       {
-         currentProject = project;
-         ScopedConfigurationAdapter projectConfig = new ScopedConfigurationAdapter();
-         XMLConfiguration projectLocalConfig;
-         try
-         {
-            projectLocalConfig = new XMLConfiguration(getProjectSettings(project).getUnderlyingResourceObject());
-            projectLocalConfig.setEncoding("UTF-8");
-         }
-         catch (org.apache.commons.configuration.ConfigurationException e)
-         {
-            throw new ConfigurationException(e);
-         }
-         projectLocalConfig.setReloadingStrategy(new FileChangedReloadingStrategy());
-         projectLocalConfig.setAutoSave(true);
-
-         ConfigurationAdapter adapter = BeanManagerUtils.getContextualInstance(bm, ConfigurationAdapter.class,
-                  new ConfigAdapterQualifierLiteral());
-         adapter.setParent(projectConfig);
-         adapter.setDelegate(projectLocalConfig);
-         adapter.setBeanManager(bm);
-         projectConfig.setScopedConfiguration(ConfigurationScope.PROJECT, adapter);
-         projectConfig.setScopedConfiguration(ConfigurationScope.USER, getUserConfig());
-
-         this.projectConfig = projectConfig;
-         return projectConfig;
+         projectLocalConfig = new XMLConfiguration(getProjectSettings(project).getUnderlyingResourceObject());
+         projectLocalConfig.setEncoding("UTF-8");
       }
-      else if ((project != null) && project.equals(this.currentProject))
+      catch (org.apache.commons.configuration.ConfigurationException e)
       {
-         return projectConfig;
+         throw new ConfigurationException(e);
       }
-      return getUserConfig();
+      projectLocalConfig.setReloadingStrategy(new FileChangedReloadingStrategy());
+      projectLocalConfig.setAutoSave(true);
+
+      ConfigurationAdapter adapter = BeanManagerUtils.getContextualInstance(bm, ConfigurationAdapter.class,
+               new ConfigAdapterQualifierLiteral());
+      adapter.setParent(projectConfig);
+      adapter.setDelegate(projectLocalConfig);
+      adapter.setBeanManager(bm);
+      projectConfig.setScopedConfiguration(ConfigurationScope.PROJECT, adapter);
+      projectConfig.setScopedConfiguration(ConfigurationScope.USER, getUserConfig());
+      return projectConfig;
    }
 
+   @Override
    public Configuration getUserConfig() throws ConfigurationException
    {
       // FIXME NPE caused when no project exists because config param is null
@@ -116,7 +100,7 @@ public Configuration getUserConfig() throws ConfigurationException
       return userConfig;
    }
 
-   public FileResource<?> getProjectSettings(final Project project)
+   private FileResource<?> getProjectSettings(final Project project)
    {
       FileResource<?> settingsFile = project.getProjectRoot().getChild(".forge_settings").reify(FileResource.class);
       return settingsFile;

diff --git a/shell/src/main/java/org/jboss/forge/shell/env/ConfigurationProducer.java b/shell/src/main/java/org/jboss/forge/shell/env/ConfigurationProducer.java
@@ -0,0 +1,49 @@
+package org.jboss.forge.shell.env;
+
+import javax.enterprise.event.Event;
+import javax.enterprise.inject.Produces;
+import javax.inject.Inject;
+
+import org.jboss.forge.env.Configuration;
+import org.jboss.forge.env.ConfigurationException;
+import org.jboss.forge.env.ConfigurationFacet;
+import org.jboss.forge.env.ConfigurationFactory;
+import org.jboss.forge.project.Project;
+import org.jboss.forge.project.facets.events.InstallFacets;
+import org.jboss.forge.shell.Shell;
+
+public class ConfigurationProducer
+{
+
+   @Inject
+   private ConfigurationFactory factory;
+
+   @Inject
+   private Event<InstallFacets> installFacets;
+
+   /**
+    * Returns a project-scoped configuration (if a project is in scope). Falls back to the user scope configuration if
+    * no project is set in the shell
+    * 
+    * @return
+    * @throws ConfigurationException
+    */
+   @Produces
+   public Configuration getConfiguration(Shell shell) throws ConfigurationException
+   {
+      Project project = shell.getCurrentProject();
+      if (project == null)
+      {
+         return factory.getUserConfig();
+      }
+      if (!project.hasFacet(ConfigurationFacet.class))
+      {
+         installFacets.fire(new InstallFacets(ConfigurationFacet.class));
+         // // Installing manually
+         // ConfigurationFacet facet = new ConfigurationFacet(factory);
+         // facet.setProject(project);
+         // project.installFacet(facet);
+      }
+      return project.getFacet(ConfigurationFacet.class).getConfiguration();
+   }
+}
diff --git a/shell/src/test/java/org/jboss/forge/env/ConfigDependentFacet.java b/shell/src/test/java/org/jboss/forge/env/ConfigDependentFacet.java
@@ -7,7 +7,6 @@
 package org.jboss.forge.env;
 
 import org.jboss.forge.project.facets.BaseFacet;
-import org.jboss.forge.project.facets.ConfigurationFacet;
 import org.jboss.forge.shell.plugins.Alias;
 import org.jboss.forge.shell.plugins.RequiresFacet;
 

diff --git a/shell/src/test/java/org/jboss/forge/env/ConfigurationFacetTest.java b/shell/src/test/java/org/jboss/forge/env/ConfigurationFacetTest.java
@@ -1,7 +1,6 @@
 package org.jboss.forge.env;
 
 import org.jboss.forge.project.Project;
-import org.jboss.forge.project.facets.ConfigurationFacet;
 import org.jboss.forge.test.AbstractShellTest;
 import org.junit.Assert;
 import org.junit.Test;