src/com/facebook/buck/cli/Command.java

/*
 * Copyright 2012-present Facebook, Inc.
 *
 * Licensed 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 com.facebook.buck.cli;

import com.facebook.buck.util.MoreStrings;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Optional;
import com.google.common.base.Throwables;

import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.util.List;

public enum Command {

  AUDIT(
      "lists the inputs for the specified target",
      AuditCommandRunner.class,
      true),
  BUILD(
      "builds the specified target",
      BuildCommand.class,
      false),
  CACHE(
      "makes calls to the artifact cache",
      CacheCommand.class,
      false),
  CLEAN(
      "deletes any generated files",
      CleanCommand.class,
      false),
  FETCH(
      "downloads remote resources to your local machine",
      FetchCommand.class,
      false),
  INSTALL(
      "builds and installs an APK",
      InstallCommand.class,
      false),
  PROJECT(
      "generates project configuration files for an IDE",
      ProjectCommand.class,
      false),
  QUICKSTART(
      "generates a default project directory",
      QuickstartCommand.class,
      false),
  RUN(
      "runs a target as a command",
      RunCommand.class,
      false),
  TARGETS(
      "prints the list of buildable targets",
      TargetsCommand.class,
      true),
  TEST(
      "builds and runs the tests for the specified target",
      TestCommand.class,
      false),
  UNINSTALL(
      "uninstalls an APK",
      UninstallCommand.class,
      false),
  ;

  /**
   * Defines the maximum possible fuzziness of a input command. If the
   * levenshtein distance between the fuzzy input and the closest command is
   * larger than MAX_ERROR_RATIO * length_of_closest_command, rejects the input.
   * The value is chosen empirically so that minor typos can be corrected.
   */
  public static final double MAX_ERROR_RATIO = 0.5;

  private final String shortDescription;
  private final Class<? extends CommandRunner> commandRunnerClass;

  private final boolean readOnly; // True if command does not write output files.

  private Command(
      String shortDescription,
      Class<? extends CommandRunner> commandRunnerClass,
      boolean readOnly) {
    this.shortDescription = shortDescription;
    this.commandRunnerClass = commandRunnerClass;
    this.readOnly = readOnly;
  }

  public String getShortDescription() {
    return shortDescription;
  }

  public boolean isReadOnly() {
    return readOnly;
  }

  public int execute(List<String> args,
      BuckConfig buckConfig,
      CommandRunnerParams params) throws IOException, InterruptedException {
      CommandRunner commandRunner;
      try {
        commandRunner = commandRunnerClass
            .getDeclaredConstructor(CommandRunnerParams.class)
            .newInstance(params);
      } catch (InstantiationException
          | IllegalAccessException
          | IllegalArgumentException
          | InvocationTargetException
          | NoSuchMethodException
          | SecurityException e) {
        throw Throwables.propagate(e);
      }
      return commandRunner.runCommand(buckConfig, args);
  }

  public static class ParseResult {
    private final Optional<Command> command;
    private final Optional<String> errorText;

    public Optional<String> getErrorText() {
      return errorText;
    }

    public Optional<Command> getCommand() {

      return command;
    }

    public ParseResult(Optional<Command> command, Optional<String> errorText) {
      this.command = command;
      this.errorText = errorText;
    }
  }

  /**
   * @return a non-empty {@link Optional} if {@code name} corresponds to a
   *     command or its levenshtein distance to the closest command isn't larger
   *     than {@link #MAX_ERROR_RATIO} * length_of_closest_command; otherwise, an
   *     empty {@link Optional}. This will return the latter if the user tries
   *     to run something like {@code buck --help}.
   */
  public static ParseResult parseCommandName(String name) {

    Command command = null;
    String errorText = null;
    try {
      command = valueOf(name.toUpperCase());
    } catch (IllegalArgumentException e) {
      Optional<Command> fuzzyCommand = fuzzyMatch(name.toUpperCase());

      if (fuzzyCommand.isPresent()) {
        errorText = String.format("(Cannot find command '%s', assuming command '%s'.)\n",
            name,
            fuzzyCommand.get().name().toLowerCase());
        command = fuzzyCommand.get();
      }
    }

    return new ParseResult(Optional.fromNullable(command), Optional.fromNullable(errorText));
  }

  private static Optional<Command> fuzzyMatch(String name) {
    name = name.toUpperCase();

    int minDist = Integer.MAX_VALUE;
    Command closestCommand = null;

    for (Command command : values()) {
      int levenshteinDist = MoreStrings.getLevenshteinDistance(name, command.name());
      if (levenshteinDist < minDist) {
        minDist = levenshteinDist;
        closestCommand = command;
      }
    }

    if (closestCommand != null &&
        ((double) minDist) / closestCommand.name().length() <= MAX_ERROR_RATIO) {
      return Optional.of(closestCommand);
    }

    return Optional.absent();
  }

  @VisibleForTesting
  protected Class<? extends CommandRunner> getCommandRunnerClass() {
    return commandRunnerClass;
  }

}