ExtractLocalRefactoringTest.java

/*
 * Copyright (c) 2013, the Dart project authors.
 * 
 * Licensed under the Eclipse Public License v1.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.eclipse.org/legal/epl-v10.html
 * 
 * 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 editor.refactoring;

import com.google.dart.tools.ui.actions.DartActionConstants;
import com.google.dart.ui.test.driver.Operation;
import com.google.dart.ui.test.driver.ShellOperation;
import com.google.dart.ui.test.helpers.WizardDialogHelper;
import com.google.dart.ui.test.util.UiContext;

import editor.AbstractDartEditorTabTest;

import org.eclipse.jface.action.IAction;

import java.util.concurrent.TimeUnit;

/**
 * Test for the "Extract Local" refactoring.
 */
public final class ExtractLocalRefactoringTest extends AbstractDartEditorTabTest {
  private static class WizardHelper extends WizardDialogHelper {
    public WizardHelper(UiContext context) {
      super(context);
    }

    public boolean getReplaceAll() {
      return context.findButton("Replace all.*").getSelection();
    }

    public void setName(String name) {
      context.findTextByLabel("Variable name:").setText(name);
    }

    public void setReplaceAll(boolean replaceAll) {
      context.setButtonSelection("Replace all.*", replaceAll);
    }
  }

  public void test_replaceAll_extractOnlyOne() throws Exception {
    openTestEditor(
        "// filler filler filler filler filler filler filler filler filler filler",
        "main() {",
        "  print(123);",
        "  print(123);",
        "}");
    // run action
    selectAndExtract("123");
    // animate wizard dialog
    addOperation(new ShellOperation("Extract Local Variable") {
      @Override
      public void run(UiContext context) throws Exception {
        WizardHelper helper = new WizardHelper(context);
        // don't extract all
        helper.setReplaceAll(false);
        // done
        helper.setName("res");
        helper.closeOK();
      }
    });
    // validate result
    runUiOperations(60, TimeUnit.SECONDS);
    assertTestUnitContent(
        "// filler filler filler filler filler filler filler filler filler filler",
        "main() {",
        "  var res = 123;",
        "  print(res);",
        "  print(123);",
        "}");
  }

  public void test_replaceAll_trueByDefault() throws Exception {
    openTestEditor(
        "// filler filler filler filler filler filler filler filler filler filler",
        "main() {",
        "  print(123);",
        "  print(123);",
        "}");
    // run action
    selectAndExtract("123");
    // animate wizard dialog
    addOperation(new ShellOperation("Extract Local Variable") {
      @Override
      public void run(UiContext context) throws Exception {
        WizardHelper helper = new WizardHelper(context);
        // "Replace all..." should checked by default
        assertTrue(helper.getReplaceAll());
        // done
        helper.setName("res");
        helper.closeOK();
      }
    });
    // validate result
    runUiOperations(60, TimeUnit.SECONDS);
    assertTestUnitContent(
        "// filler filler filler filler filler filler filler filler filler filler",
        "main() {",
        "  var res = 123;",
        "  print(res);",
        "  print(res);",
        "}");
  }

  public void test_singleExpression() throws Exception {
    openTestEditor(
        "// filler filler filler filler filler filler filler filler filler filler",
        "main() {",
        "  print(123);",
        "}");
    // run action
    selectAndExtract("123");
    // animate wizard dialog
    addOperation(new ShellOperation("Extract Local Variable") {
      @Override
      public void run(UiContext context) throws Exception {
        WizardHelper helper = new WizardHelper(context);
        // invalid name
        helper.setName("-name");
        helper.assertMessage("Variable name must not start with '-'.");
        // set new name
        helper.setName("res");
        helper.assertNoMessage();
        // done
        helper.closeOK();
      }
    });
    // validate result
    runUiOperations(60, TimeUnit.SECONDS);
    assertTestUnitContent(
        "// filler filler filler filler filler filler filler filler filler filler",
        "main() {",
        "  var res = 123;",
        "  print(res);",
        "}");
  }

  private void selectAndExtract(String pattern) throws Exception {
    selectRange(pattern);
    // run "Extract Local" action
    final IAction action = getEditorAction(DartActionConstants.EXTRACT_LOCAL);
    addOperation(new Operation() {
      @Override
      public boolean isReady(UiContext context) throws Exception {
        return action.isEnabled();
      }

      @Override
      public void run(UiContext context) throws Exception {
        action.run();
      }
    });
  }
}