Allow configuring google-java-format on a per-module basis.

Regarding the enum changes: it turns out that IntelliJ serializes the
toString() version of the enum rather than the name(). So I had to
remove the toString and then create separate Ui* versions that have a
toString() for presenting in the UI.

MOE_MIGRATED_REVID=134579273

Author: plumpy

idea_plugin/src/com/google/googlejavaformat/intellij/BasicGoogleJavaFormatCodeStyleManager.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2015 Google Inc. All Rights Reserved.
+ *
+ * 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.google.googlejavaformat.intellij;
+
+import com.google.googlejavaformat.java.Formatter;
+import com.google.googlejavaformat.java.JavaFormatterOptions;
+import com.intellij.psi.PsiFile;
+import com.intellij.psi.codeStyle.CodeStyleManager;
+import java.util.Optional;
+import org.jetbrains.annotations.NotNull;
+
+final class BasicGoogleJavaFormatCodeStyleManager extends GoogleJavaFormatCodeStyleManager {
+
+  private final Formatter formatter;
+
+  public BasicGoogleJavaFormatCodeStyleManager(
+      @NotNull CodeStyleManager original, JavaFormatterOptions.Style style) {
+    super(original);
+    this.formatter = new Formatter(JavaFormatterOptions.builder().style(style).build());
+  }
+
+  @Override
+  protected Optional<Formatter> getFormatterForFile(@NotNull PsiFile file) {
+    return Optional.of(formatter);
+  }
+}

idea_plugin/src/com/google/googlejavaformat/intellij/GoogleJavaFormatCodeStyleManager.java

@@ -22,7 +22,6 @@
 import com.google.common.collect.Range;
 import com.google.googlejavaformat.java.Formatter;
 import com.google.googlejavaformat.java.FormatterException;
-import com.google.googlejavaformat.java.JavaFormatterOptions;
 import com.google.googlejavaformat.java.Replacement;
 import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.command.WriteCommandAction;
@@ -36,6 +35,7 @@
 import com.intellij.util.IncorrectOperationException;
 import java.util.Collection;
 import java.util.List;
+import java.util.Optional;
 import java.util.stream.Collectors;
 import org.jetbrains.annotations.NotNull;
 
@@ -45,21 +45,19 @@
  *
  * @author [email protected] (Brian Chang)
  */
-public class GoogleJavaFormatCodeStyleManager extends CodeStyleManagerDecorator {
+public abstract class GoogleJavaFormatCodeStyleManager extends CodeStyleManagerDecorator {
 
-  private final Formatter formatter;
-
-  public GoogleJavaFormatCodeStyleManager(
-      @NotNull CodeStyleManager original, @NotNull JavaFormatterOptions formatterOptions) {
+  public GoogleJavaFormatCodeStyleManager(@NotNull CodeStyleManager original) {
     super(original);
-    formatter = new Formatter(formatterOptions);
   }
 
   @Override
   public void reformatText(@NotNull PsiFile file, int startOffset, int endOffset)
       throws IncorrectOperationException {
-    if (StdFileTypes.JAVA.equals(file.getFileType()) && useGoogleFormatterForFile(file)) {
-      formatInternal(file, ImmutableList.of(Range.closedOpen(startOffset, endOffset)));
+    Optional<Formatter> formatter = getFormatterForFile(file);
+    if (formatter.isPresent() && StdFileTypes.JAVA.equals(file.getFileType())) {
+      formatInternal(
+          formatter.get(), file, ImmutableList.of(Range.closedOpen(startOffset, endOffset)));
     } else {
       super.reformatText(file, startOffset, endOffset);
     }
@@ -68,8 +66,9 @@ public void reformatText(@NotNull PsiFile file, int startOffset, int endOffset)
   @Override
   public void reformatText(@NotNull PsiFile file, @NotNull Collection<TextRange> ranges)
       throws IncorrectOperationException {
-    if (StdFileTypes.JAVA.equals(file.getFileType()) && useGoogleFormatterForFile(file)) {
-      formatInternal(file, convertToRanges(ranges));
+    Optional<Formatter> formatter = getFormatterForFile(file);
+    if (formatter.isPresent() && StdFileTypes.JAVA.equals(file.getFileType())) {
+      formatInternal(formatter.get(), file, convertToRanges(ranges));
     } else {
       super.reformatText(file, ranges);
     }
@@ -78,18 +77,21 @@ public void reformatText(@NotNull PsiFile file, @NotNull Collection<TextRange> r
   @Override
   public void reformatTextWithContext(@NotNull PsiFile file, @NotNull Collection<TextRange> ranges)
       throws IncorrectOperationException {
-    if (StdFileTypes.JAVA.equals(file.getFileType()) && useGoogleFormatterForFile(file)) {
-      formatInternal(file, convertToRanges(ranges));
+    Optional<Formatter> formatter = getFormatterForFile(file);
+    if (formatter.isPresent() && StdFileTypes.JAVA.equals(file.getFileType())) {
+      formatInternal(formatter.get(), file, convertToRanges(ranges));
     } else {
       super.reformatTextWithContext(file, ranges);
     }
   }
 
-  protected boolean useGoogleFormatterForFile(@NotNull PsiFile file) {
-    return true;
-  }
+  /**
+   * Get the {@link Formatter} to be used with the given file, or absent to use the built-in
+   * IntelliJ formatter.
+   */
+  protected abstract Optional<Formatter> getFormatterForFile(PsiFile file);
 
-  private void formatInternal(PsiFile file, List<Range<Integer>> ranges)
+  private void formatInternal(Formatter formatter, PsiFile file, List<Range<Integer>> ranges)
       throws IncorrectOperationException {
     ApplicationManager.getApplication().assertWriteAccessAllowed();
     PsiDocumentManager.getInstance(getProject()).commitAllDocuments();

idea_plugin/src/com/google/googlejavaformat/intellij/GoogleJavaFormatConfigurable.java

@@ -79,32 +79,30 @@ public JComponent createComponent() {
   public void apply() throws ConfigurationException {
     GoogleJavaFormatSettings settings = GoogleJavaFormatSettings.getInstance(project);
     settings.setEnabled(enable.isSelected());
-    settings.setStyle((FormatterStyle) styleComboBox.getSelectedItem());
+    settings.setStyle(((UiFormatterStyle) styleComboBox.getSelectedItem()).convert());
   }
 
   @Override
   public void reset() {
     GoogleJavaFormatSettings settings = GoogleJavaFormatSettings.getInstance(project);
     enable.setSelected(settings.isEnabled());
-    styleComboBox.setSelectedItem(settings.getStyle());
+    styleComboBox.setSelectedItem(UiFormatterStyle.convert(settings.getStyle()));
   }
 
   @Override
   public boolean isModified() {
     GoogleJavaFormatSettings settings = GoogleJavaFormatSettings.getInstance(project);
     return enable.isSelected() != settings.isEnabled()
-        || !styleComboBox.getSelectedItem().equals(settings.getStyle());
+        || !styleComboBox.getSelectedItem().equals(UiFormatterStyle.convert(settings.getStyle()));
   }
 
   @Override
   public void disposeUIResources() {}
 
   private void createUIComponents() {
-    styleComboBox = new ComboBox<>(FormatterStyle.values());
+    styleComboBox = new ComboBox<>(UiFormatterStyle.values());
   }
 
-  // IntelliJ's UI designer generated this ugly code and then google-java-format made it even
-  // uglier. C'est la vie.
   {
     // GUI initializer generated by IntelliJ IDEA GUI Designer
     // >>> IMPORTANT!! <<<

idea_plugin/src/com/google/googlejavaformat/intellij/GoogleJavaFormatSettings.java

@@ -16,6 +16,7 @@
 
 package com.google.googlejavaformat.intellij;
 
+import com.google.googlejavaformat.java.JavaFormatterOptions;
 import com.intellij.lifecycle.PeriodicalTasksCloser;
 import com.intellij.openapi.components.AbstractProjectComponent;
 import com.intellij.openapi.components.PersistentStateComponent;
@@ -31,8 +32,7 @@
 class GoogleJavaFormatSettings extends AbstractProjectComponent
     implements PersistentStateComponent<GoogleJavaFormatSettings.State> {
 
-  private boolean enabled = false;
-  private FormatterStyle formatterStyle = FormatterStyle.GOOGLE;
+  private State state = new State();
 
   protected GoogleJavaFormatSettings(Project project) {
     super(project);
@@ -46,72 +46,43 @@ static GoogleJavaFormatSettings getInstance(Project project) {
   @Nullable
   @Override
   public State getState() {
-    State state = new State();
-    state.setEnabled(enabled);
-    state.setStyle(formatterStyle);
     return state;
   }
 
   @Override
   public void loadState(State state) {
-    setEnabled(state.isEnabled());
-    setStyle(state.getStyle());
+    this.state = state;
   }
 
   boolean isEnabled() {
-    return enabled;
+    return state.enabled;
   }
 
   void setEnabled(boolean enabled) {
-    this.enabled = enabled;
-    updateFormatterState();
+    state.enabled = enabled;
   }
 
-  FormatterStyle getStyle() {
-    return formatterStyle;
+  JavaFormatterOptions.Style getStyle() {
+    return state.style;
   }
 
-  void setStyle(FormatterStyle formatterStyle) {
-    // formatterStyle can be null when users upgrade to the first version of the plugin with style
-    // support (since it was never saved before). If so, keep the default value.
-    if (formatterStyle == null) {
-      this.formatterStyle = FormatterStyle.GOOGLE;
-    } else {
-      this.formatterStyle = formatterStyle;
-    }
+  void setStyle(JavaFormatterOptions.Style style) {
+    state.style = style;
     updateFormatterState();
   }
 
   private void updateFormatterState() {
-    if (enabled) {
+    if (state.enabled) {
       GoogleJavaFormatInstaller.installFormatter(
           myProject,
-          (delegate) ->
-              new GoogleJavaFormatCodeStyleManager(
-                  delegate, formatterStyle.getJavaFormatterOptions()));
+          (delegate) -> new BasicGoogleJavaFormatCodeStyleManager(delegate, state.style));
     } else {
       GoogleJavaFormatInstaller.removeFormatter(myProject);
     }
   }
 
   static class State {
-    private boolean enabled = false;
-    private FormatterStyle formatterStyle = FormatterStyle.GOOGLE;
-
-    boolean isEnabled() {
-      return enabled;
-    }
-
-    void setEnabled(boolean enabled) {
-      this.enabled = enabled;
-    }
-
-    FormatterStyle getStyle() {
-      return formatterStyle;
-    }
-
-    void setStyle(FormatterStyle formatterStyle) {
-      this.formatterStyle = formatterStyle;
-    }
+    public boolean enabled = false;
+    public JavaFormatterOptions.Style style = JavaFormatterOptions.Style.GOOGLE;
   }
 }

idea_plugin/src/com/google/googlejavaformat/intellij/FormatterStyle.java renamed to idea_plugin/src/com/google/googlejavaformat/intellij/UiFormatterStyle.java

@@ -18,28 +18,35 @@
 
 import com.google.googlejavaformat.java.JavaFormatterOptions;
 import com.google.googlejavaformat.java.JavaFormatterOptions.Style;
+import java.util.Arrays;
+import java.util.Objects;
 
-/**
- * Configuration options for the formatting style.
- */
-public enum FormatterStyle {
+/** Configuration options for the formatting style. */
+public enum UiFormatterStyle {
   GOOGLE("Default Google Java style", Style.GOOGLE),
   AOSP("Android Open Source Project (AOSP) style", Style.AOSP);
 
   private final String description;
-  private final JavaFormatterOptions javaFormatterOptions;
+  private final JavaFormatterOptions.Style style;
 
-  FormatterStyle(String description, JavaFormatterOptions.Style style) {
+  UiFormatterStyle(String description, JavaFormatterOptions.Style style) {
     this.description = description;
-    this.javaFormatterOptions = JavaFormatterOptions.builder().style(style).build();
+    this.style = style;
   }
 
   @Override
   public String toString() {
     return description;
   }
 
-  public JavaFormatterOptions getJavaFormatterOptions() {
-    return javaFormatterOptions;
+  public JavaFormatterOptions.Style convert() {
+    return style;
+  }
+
+  static UiFormatterStyle convert(JavaFormatterOptions.Style style) {
+    return Arrays.stream(UiFormatterStyle.values())
+        .filter(value -> Objects.equals(value.style, style))
+        .findFirst()
+        .get();
   }
 }

idea_plugin/test/com/google/googlejavaformat/intellij/GoogleJavaFormatCodeStyleManagerTest.java

@@ -24,7 +24,6 @@
 import com.intellij.openapi.util.TextRange;
 import com.intellij.psi.codeStyle.CodeStyleManager;
 import com.intellij.testFramework.fixtures.LightCodeInsightFixtureTestCase;
-
 import java.net.URL;
 import java.net.URLClassLoader;
 
@@ -56,8 +55,8 @@ protected void setUp() throws Exception {
   public void testFormatFile() {
     CodeStyleManager codeStyleManager = CodeStyleManager.getInstance(getProject());
     final GoogleJavaFormatCodeStyleManager googleJavaFormat =
-        new GoogleJavaFormatCodeStyleManager(
-            codeStyleManager, JavaFormatterOptions.defaultOptions());
+        new BasicGoogleJavaFormatCodeStyleManager(
+            codeStyleManager, JavaFormatterOptions.Style.GOOGLE);
     myFixture.configureByText(
         StdFileTypes.JAVA,
         "public class Test {public static void main(String[]args){System.out.println();}}");
@@ -79,8 +78,8 @@ public void testFormatFile() {
   public void testDontFormatNonJavaFile() {
     CodeStyleManager codeStyleManager = CodeStyleManager.getInstance(getProject());
     final GoogleJavaFormatCodeStyleManager googleJavaFormat =
-        new GoogleJavaFormatCodeStyleManager(
-            codeStyleManager, JavaFormatterOptions.defaultOptions());
+        new BasicGoogleJavaFormatCodeStyleManager(
+            codeStyleManager, JavaFormatterOptions.Style.GOOGLE);
     myFixture.configureByText(
         StdFileTypes.PLAIN_TEXT,
         "public class Test {public static void main(String[]args){System.out.println();}}");
@@ -96,8 +95,8 @@ public void testDontFormatNonJavaFile() {
   public void testFormatRanges() {
     CodeStyleManager codeStyleManager = CodeStyleManager.getInstance(getProject());
     final GoogleJavaFormatCodeStyleManager googleJavaFormat =
-        new GoogleJavaFormatCodeStyleManager(
-            codeStyleManager, JavaFormatterOptions.defaultOptions());
+        new BasicGoogleJavaFormatCodeStyleManager(
+            codeStyleManager, JavaFormatterOptions.Style.GOOGLE);
     String content =
         join(
             "public class Test {", //