FORGE-1366: Moved UIPrompt to UIExecutionContext

forge · Jan 9, 2014 · 69be472 · 69be472
1 parent 7926ca1
commit 69be472
Show file tree

Hide file tree

Showing 13 changed files with 89 additions and 39 deletions.
diff --git a/shell/impl/src/main/java/org/jboss/forge/addon/shell/ShellImpl.java b/shell/impl/src/main/java/org/jboss/forge/addon/shell/ShellImpl.java
@@ -32,13 +32,10 @@
 import org.jboss.forge.addon.shell.ui.ShellContextImpl;
 import org.jboss.forge.addon.shell.ui.ShellUIOutputImpl;
 import org.jboss.forge.addon.shell.ui.ShellUIPromptImpl;
-import org.jboss.forge.addon.ui.AbstractCommandExecutionListener;
 import org.jboss.forge.addon.ui.DefaultUIProgressMonitor;
-import org.jboss.forge.addon.ui.UICommand;
 import org.jboss.forge.addon.ui.UIProgressMonitor;
 import org.jboss.forge.addon.ui.context.UIContext;
 import org.jboss.forge.addon.ui.context.UIContextListener;
-import org.jboss.forge.addon.ui.context.UIExecutionContext;
 import org.jboss.forge.addon.ui.controller.CommandControllerFactory;
 import org.jboss.forge.addon.ui.controller.CommandExecutionListener;
 import org.jboss.forge.addon.ui.input.UIPrompt;
@@ -59,7 +56,6 @@
 public class ShellImpl implements Shell, UIRuntime
 {
    private Resource<?> currentResource;
-   private UIPrompt prompt;
 
    private final AddonRegistry addonRegistry;
    private final AeshConsole console;
@@ -170,7 +166,6 @@ public ShellContextImpl createUIContext()
    {
       Imported<UIContextListener> listeners = addonRegistry.getServices(UIContextListener.class);
       ShellContextImpl shellContextImpl = new ShellContextImpl(this, currentResource, listeners);
-      shellContextImpl.addCommandExecutionListener(new InitializePromptListener());
       for (CommandExecutionListener listener : executionListeners)
       {
          shellContextImpl.addCommandExecutionListener(listener);
@@ -194,26 +189,17 @@ public CommandExecutionListener removeListener()
       };
    }
 
-   @Override
-   public UIPrompt getPrompt()
-   {
-      return prompt;
-   }
-
    @Override
    public UIProgressMonitor createProgressMonitor(UIContext context)
    {
       return new DefaultUIProgressMonitor();
    }
 
-   private class InitializePromptListener extends AbstractCommandExecutionListener
+   @Override
+   public UIPrompt createPrompt(UIContext context)
    {
-      @Override
-      public void preCommandExecuted(UICommand command, UIExecutionContext context)
-      {
-         CommandInvocation commandInvocation = (CommandInvocation) context.getUIContext().getAttributeMap()
-                  .get(CommandInvocation.class);
-         ShellImpl.this.prompt = new ShellUIPromptImpl(console, commandInvocation);
-      }
+      CommandInvocation commandInvocation = (CommandInvocation) context.getAttributeMap()
+               .get(CommandInvocation.class);
+      return new ShellUIPromptImpl(console, commandInvocation);
    }
 }
diff --git a/shell/impl/src/main/java/org/jboss/forge/addon/shell/commands/CommandListCommand.java b/shell/impl/src/main/java/org/jboss/forge/addon/shell/commands/CommandListCommand.java
@@ -31,6 +31,7 @@
 import org.jboss.forge.addon.ui.context.UIExecutionContext;
 import org.jboss.forge.addon.ui.controller.CommandController;
 import org.jboss.forge.addon.ui.controller.CommandControllerFactory;
+import org.jboss.forge.addon.ui.input.UIPrompt;
 import org.jboss.forge.addon.ui.metadata.UICommandMetadata;
 import org.jboss.forge.addon.ui.output.UIOutput;
 import org.jboss.forge.addon.ui.result.Result;
@@ -104,6 +105,12 @@ public UIProgressMonitor createProgressMonitor(UIContext context)
          {
             return new DefaultUIProgressMonitor();
          }
+
+         @Override
+         public UIPrompt createPrompt(UIContext context)
+         {
+            return null;
+         }
       });
    }
 }
diff --git a/ui/api/src/main/java/org/jboss/forge/addon/ui/UIProvider.java b/ui/api/src/main/java/org/jboss/forge/addon/ui/UIProvider.java
@@ -1,7 +1,6 @@
 package org.jboss.forge.addon.ui;
 
 import org.jboss.forge.addon.ui.controller.CommandExecutionListener;
-import org.jboss.forge.addon.ui.input.UIPrompt;
 import org.jboss.forge.addon.ui.output.UIOutput;
 
 /**
@@ -21,9 +20,4 @@ public interface UIProvider
     * Returns the output object used to display messages during a UI interation
     */
    UIOutput getOutput();
-
-   /**
-    * Returns the object used to prompt for messages during a UI interaction
-    */
-   UIPrompt getPrompt();
 }
diff --git a/ui/api/src/main/java/org/jboss/forge/addon/ui/context/UIExecutionContext.java b/ui/api/src/main/java/org/jboss/forge/addon/ui/context/UIExecutionContext.java
@@ -8,6 +8,7 @@
 package org.jboss.forge.addon.ui.context;
 
 import org.jboss.forge.addon.ui.UIProgressMonitor;
+import org.jboss.forge.addon.ui.input.UIPrompt;
 
 /**
  * A {@link UIExecutionContext} is created when the execution phase is requested
@@ -21,4 +22,9 @@ public interface UIExecutionContext extends UIContextProvider
     */
    UIProgressMonitor getProgressMonitor();
 
+   /**
+    * Returns the object used to prompt for messages during a UI interaction
+    */
+   UIPrompt getPrompt();
+
 }
diff --git a/ui/api/src/main/java/org/jboss/forge/addon/ui/spi/UIRuntime.java b/ui/api/src/main/java/org/jboss/forge/addon/ui/spi/UIRuntime.java
@@ -9,6 +9,7 @@
 
 import org.jboss.forge.addon.ui.UIProgressMonitor;
 import org.jboss.forge.addon.ui.context.UIContext;
+import org.jboss.forge.addon.ui.input.UIPrompt;
 
 /**
  * Creates UI objects. Should be implemented by UI Providers
@@ -21,4 +22,9 @@ public interface UIRuntime
     * Creates a new {@link UIProgressMonitor}
     */
    UIProgressMonitor createProgressMonitor(UIContext context);
+
+   /**
+    * Create a new {@link UIPrompt}
+    */
+   UIPrompt createPrompt(UIContext context);
 }
diff --git a/ui/example/src/main/java/org/jboss/forge/addon/ui/example/commands/PromptCommand.java b/ui/example/src/main/java/org/jboss/forge/addon/ui/example/commands/PromptCommand.java
@@ -42,7 +42,7 @@ public Result execute(UIExecutionContext context) throws Exception
    {
       UIProvider provider = context.getUIContext().getProvider();
       UIOutput output = provider.getOutput();
-      UIPrompt prompt = provider.getPrompt();
+      UIPrompt prompt = context.getPrompt();
       boolean answer = prompt.promptBoolean("Do you love Forge 2?");
       output.out().println("You answered: " + answer);
       return null;

diff --git a/ui/impl/src/main/java/org/jboss/forge/addon/ui/impl/context/UIExecutionContextImpl.java b/ui/impl/src/main/java/org/jboss/forge/addon/ui/impl/context/UIExecutionContextImpl.java
@@ -10,6 +10,7 @@
 import org.jboss.forge.addon.ui.UIProgressMonitor;
 import org.jboss.forge.addon.ui.context.UIContext;
 import org.jboss.forge.addon.ui.context.UIExecutionContext;
+import org.jboss.forge.addon.ui.input.UIPrompt;
 
 /**
  * Implementation of the {@link UIExecutionContext} interface
@@ -21,11 +22,13 @@ public class UIExecutionContextImpl implements UIExecutionContext
 
    private final UIContext context;
    private final UIProgressMonitor progressMonitor;
+   private final UIPrompt prompt;
 
-   public UIExecutionContextImpl(UIContext context, UIProgressMonitor progressMonitor)
+   public UIExecutionContextImpl(UIContext context, UIProgressMonitor progressMonitor, UIPrompt prompt)
    {
       this.context = context;
       this.progressMonitor = progressMonitor;
+      this.prompt = prompt;
    }
 
    @Override
@@ -40,4 +43,10 @@ public UIProgressMonitor getProgressMonitor()
       return progressMonitor;
    }
 
+   @Override
+   public UIPrompt getPrompt()
+   {
+      return prompt;
+   }
+
 }
diff --git a/...l/src/main/java/org/jboss/forge/addon/ui/impl/controller/SingleCommandControllerImpl.java b/...l/src/main/java/org/jboss/forge/addon/ui/impl/controller/SingleCommandControllerImpl.java
@@ -23,6 +23,7 @@
 import org.jboss.forge.addon.ui.impl.context.UIExecutionContextImpl;
 import org.jboss.forge.addon.ui.impl.context.UIValidationContextImpl;
 import org.jboss.forge.addon.ui.input.InputComponent;
+import org.jboss.forge.addon.ui.input.UIPrompt;
 import org.jboss.forge.addon.ui.metadata.UICommandMetadata;
 import org.jboss.forge.addon.ui.output.UIMessage;
 import org.jboss.forge.addon.ui.output.UIMessage.Severity;
@@ -67,7 +68,8 @@ public Result execute() throws Exception
       assertInitialized();
       assertValid();
       UIProgressMonitor progressMonitor = runtime.createProgressMonitor(context);
-      UIExecutionContextImpl executionContext = new UIExecutionContextImpl(context, progressMonitor);
+      UIPrompt prompt = runtime.createPrompt(context);
+      UIExecutionContextImpl executionContext = new UIExecutionContextImpl(context, progressMonitor, prompt);
       if (progressMonitor.isCancelled())
       {
          return null;

diff --git a/...l/src/main/java/org/jboss/forge/addon/ui/impl/controller/WizardCommandControllerImpl.java b/...l/src/main/java/org/jboss/forge/addon/ui/impl/controller/WizardCommandControllerImpl.java
@@ -28,6 +28,7 @@
 import org.jboss.forge.addon.ui.impl.context.UIExecutionContextImpl;
 import org.jboss.forge.addon.ui.impl.context.UINavigationContextImpl;
 import org.jboss.forge.addon.ui.input.InputComponent;
+import org.jboss.forge.addon.ui.input.UIPrompt;
 import org.jboss.forge.addon.ui.metadata.UICommandMetadata;
 import org.jboss.forge.addon.ui.output.UIMessage;
 import org.jboss.forge.addon.ui.result.NavigationResult;
@@ -90,7 +91,8 @@ public Result execute() throws Exception
 
       assertInitialized();
       UIProgressMonitor progressMonitor = runtime.createProgressMonitor(context);
-      UIExecutionContextImpl executionContext = new UIExecutionContextImpl(context, progressMonitor);
+      UIPrompt prompt = runtime.createPrompt(context);
+      UIExecutionContextImpl executionContext = new UIExecutionContextImpl(context, progressMonitor, prompt);
       Set<CommandExecutionListener> listeners = new LinkedHashSet<>();
       listeners.addAll(context.getListeners());
       for (CommandExecutionListener listener : addonRegistry

diff --git a/ui/tests/src/test/java/org/jboss/forge/addon/ui/impl/mock/MockUIPrompt.java b/ui/tests/src/test/java/org/jboss/forge/addon/ui/impl/mock/MockUIPrompt.java
@@ -0,0 +1,33 @@
+/**
+ * Copyright 2014 Red Hat, Inc. and/or its affiliates.
+ *
+ * Licensed under the Eclipse Public License version 1.0, available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.jboss.forge.addon.ui.impl.mock;
+
+import org.jboss.forge.addon.ui.input.UIPrompt;
+
+/**
+ * 
+ * @author <a href="ggastald@redhat.com">George Gastaldi</a>
+ */
+public class MockUIPrompt implements UIPrompt
+{
+
+   @Override
+   public String prompt()
+   {
+      // TODO Auto-generated method stub
+      return null;
+   }
+
+   @Override
+   public boolean promptBoolean(String message)
+   {
+      // TODO Auto-generated method stub
+      return false;
+   }
+
+}
diff --git a/ui/tests/src/test/java/org/jboss/forge/addon/ui/impl/mock/MockUIRuntime.java b/ui/tests/src/test/java/org/jboss/forge/addon/ui/impl/mock/MockUIRuntime.java
@@ -10,6 +10,7 @@
 import org.jboss.forge.addon.ui.DefaultUIProgressMonitor;
 import org.jboss.forge.addon.ui.UIProgressMonitor;
 import org.jboss.forge.addon.ui.context.UIContext;
+import org.jboss.forge.addon.ui.input.UIPrompt;
 import org.jboss.forge.addon.ui.spi.UIRuntime;
 
 /**
@@ -23,4 +24,11 @@ public UIProgressMonitor createProgressMonitor(UIContext context)
    {
       return new DefaultUIProgressMonitor();
    }
+
+   @Override
+   public UIPrompt createPrompt(UIContext context)
+   {
+      return new MockUIPrompt();
+   }
+
 }
diff --git a/ui/ui-test-harness/src/main/java/org/jboss/forge/ui/test/impl/UIProviderImpl.java b/ui/ui-test-harness/src/main/java/org/jboss/forge/ui/test/impl/UIProviderImpl.java
@@ -8,7 +8,6 @@
 package org.jboss.forge.ui.test.impl;
 
 import org.jboss.forge.addon.ui.UIProvider;
-import org.jboss.forge.addon.ui.input.UIPrompt;
 import org.jboss.forge.addon.ui.output.UIOutput;
 
 /**
@@ -19,13 +18,11 @@ public class UIProviderImpl implements UIProvider
 {
    private final boolean graphical;
    private final UIOutput output;
-   private final UIPrompt prompt;
 
    public UIProviderImpl(boolean graphical)
    {
       this.graphical = graphical;
       this.output = new UIOutputImpl(System.out, System.err);
-      this.prompt = new UIPromptImpl();
    }
 
    @Override
@@ -39,11 +36,4 @@ public UIOutput getOutput()
    {
       return output;
    }
-
-   @Override
-   public UIPrompt getPrompt()
-   {
-      return prompt;
-   }
-
 }
diff --git a/ui/ui-test-harness/src/main/java/org/jboss/forge/ui/test/impl/UIRuntimeImpl.java b/ui/ui-test-harness/src/main/java/org/jboss/forge/ui/test/impl/UIRuntimeImpl.java
@@ -9,6 +9,7 @@
 import org.jboss.forge.addon.ui.DefaultUIProgressMonitor;
 import org.jboss.forge.addon.ui.UIProgressMonitor;
 import org.jboss.forge.addon.ui.context.UIContext;
+import org.jboss.forge.addon.ui.input.UIPrompt;
 import org.jboss.forge.addon.ui.spi.UIRuntime;
 
 /**
@@ -18,6 +19,7 @@
 public class UIRuntimeImpl implements UIRuntime
 {
    private final UIProgressMonitor progressMonitor = new DefaultUIProgressMonitor();
+   private final UIPrompt prompt = new UIPromptImpl();
 
    public UIRuntimeImpl()
    {
@@ -29,4 +31,9 @@ public UIProgressMonitor createProgressMonitor(UIContext context)
       return progressMonitor;
    }
 
+   @Override
+   public UIPrompt createPrompt(UIContext context)
+   {
+      return prompt;
+   }
 }