Add a simple ObjectColor

PiperOrigin-RevId: 322172708

Author: lauraharker

src/com/google/javascript/jscomp/colors/Color.java

@@ -25,5 +25,7 @@ public interface Color {
 
   boolean isUnion();
 
+  boolean isObject();
+
   ImmutableCollection<Color> getAlternates();
 }

src/com/google/javascript/jscomp/colors/ObjectColor.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2020 The Closure Compiler Authors.
+ *
+ * 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.javascript.jscomp.colors;
+
+import com.google.auto.value.AutoValue;
+import com.google.common.collect.ImmutableCollection;
+
+/**
+ * A user-defined object type. For now each type is defined by a unique class name and file source.
+ */
+@AutoValue
+public abstract class ObjectColor implements Color {
+
+  public static ObjectColor create(String className, String fileName) {
+    return new AutoValue_ObjectColor(className, fileName);
+  }
+
+  @Override
+  public boolean isPrimitive() {
+    return false;
+  }
+
+  @Override
+  public boolean isUnion() {
+    return false;
+  }
+
+  @Override
+  public boolean isObject() {
+    return true;
+  }
+
+  @Override
+  public ImmutableCollection<Color> getAlternates() {
+    throw new UnsupportedOperationException();
+  }
+
+  public abstract String getClassName();
+
+  public abstract String getFilename();
+}

src/com/google/javascript/jscomp/colors/PrimitiveColor.java

@@ -40,6 +40,11 @@ public boolean isUnion() {
     return false;
   }
 
+  @Override
+  public boolean isObject() {
+    return false;
+  }
+
   @Override
   public ImmutableCollection<Color> getAlternates() {
     // In theory we could consider a primitive a union of a single value. It's not clear whether

src/com/google/javascript/jscomp/colors/UnionColor.java

@@ -53,6 +53,11 @@ public boolean isUnion() {
     return true;
   }
 
+  @Override
+  public boolean isObject() {
+    return false;
+  }
+
   @Override
   public abstract ImmutableCollection<Color> getAlternates();
 }

src/com/google/javascript/jscomp/testing/ColorSubject.java

@@ -56,6 +56,10 @@ public void isUnion() {
     check("isUnion").that(actualNonNull().isUnion()).isTrue();
   }
 
+  public void isObject() {
+    check("isObject").that(actualNonNull().isObject()).isTrue();
+  }
+
   public void hasAlternates(Color... alternates) {
     isUnion();
     check("getAlternates().containsExactly()")

test/com/google/javascript/jscomp/colors/ObjectColorTest.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2020 The Closure Compiler Authors.
+ *
+ * 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.javascript.jscomp.colors;
+
+import static com.google.common.truth.Truth.assertThat;
+import static com.google.javascript.jscomp.testing.ColorSubject.assertThat;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+public class ObjectColorTest {
+  @Test
+  public void isPrimitiveReturnsFalse() {
+    ObjectColor foo = ObjectColor.create("Foo", "test.js");
+
+    assertThat(foo.isPrimitive()).isFalse();
+  }
+
+  @Test
+  public void isObjectReturnsTrue() {
+    ObjectColor foo = ObjectColor.create("Foo", "test.js");
+
+    assertThat(foo).isObject();
+  }
+
+  @Test
+  public void isUnionHandlesReturnsFalse() {
+    ObjectColor foo = ObjectColor.create("Foo", "test.js");
+
+    assertThat(foo.isUnion()).isFalse();
+  }
+
+  @Test
+  public void objectEqualityBasedOnClassAndFileName() {
+    assertThat(ObjectColor.create("Foo", "test.js"))
+        .isEqualTo(ObjectColor.create("Foo", "test.js"));
+  }
+}

test/com/google/javascript/jscomp/colors/PrimitiveColorTest.java

@@ -32,6 +32,11 @@ public void isPrimitiveReturnsTrue() {
     assertThat((Color) PrimitiveColor.UNKNOWN).isPrimitive();
   }
 
+  @Test
+  public void isObjectReturnsFalse() {
+    assertThat(PrimitiveColor.UNKNOWN.isObject()).isFalse();
+  }
+
   @Test
   public void isUnionReturnsFalse() {
     assertThat(PrimitiveColor.NUMBER.isUnion()).isFalse();

test/com/google/javascript/jscomp/colors/UnionColorTest.java

@@ -35,6 +35,14 @@ public void isPrimitiveReturnsFalse() {
     assertThat(numberOrString.isPrimitive()).isFalse();
   }
 
+  @Test
+  public void isObjectReturnsFalse() {
+    UnionColor numberOrString =
+        UnionColor.create(ImmutableSet.of(PrimitiveColor.STRING, PrimitiveColor.NUMBER));
+
+    assertThat(numberOrString.isObject()).isFalse();
+  }
+
   @Test
   public void isUnionHandlesReturnsTrue() {
     UnionColor union =
@@ -91,4 +99,14 @@ public void unknownTypeIsNotSpecialCased() {
     assertThat(union).isUnion();
     assertThat(union.getAlternates()).hasSize(2);
   }
+
+  @Test
+  public void unionOfEquivalentObjectsNotAllowed() {
+    assertThrows(
+        IllegalArgumentException.class,
+        () ->
+            UnionColor.create(
+                ImmutableSet.of(
+                    ObjectColor.create("Foo", "test.js"), ObjectColor.create("Foo", "test.js"))));
+  }
 }