Skip to content

Commit

Permalink
Propogate @GwtIncompatible annotations to generated factories
Browse files Browse the repository at this point in the history
Fixes #121 (finally)

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=156005530
  • Loading branch information
ronshapiro committed May 18, 2017
1 parent a66e681 commit b15108f
Show file tree
Hide file tree
Showing 8 changed files with 267 additions and 0 deletions.
3 changes: 3 additions & 0 deletions java/dagger/internal/codegen/FactoryGenerator.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import static dagger.internal.codegen.ContributionBinding.Kind.INJECTION;
import static dagger.internal.codegen.ContributionBinding.Kind.PROVISION;
import static dagger.internal.codegen.ErrorMessages.CANNOT_RETURN_NULL_FROM_NON_NULLABLE_PROVIDES_METHOD;
import static dagger.internal.codegen.GwtCompatibility.gwtIncompatibleAnnotation;
import static dagger.internal.codegen.Proxies.createProxy;
import static dagger.internal.codegen.Proxies.shouldGenerateProxy;
import static dagger.internal.codegen.SourceFiles.bindingTypeElementTypeVariableNames;
Expand Down Expand Up @@ -276,6 +277,8 @@ Optional<TypeSpec.Builder> write(ClassName generatedTypeName, ProvisionBinding b

proxyMethodFor(binding).ifPresent(factoryBuilder::addMethod);

gwtIncompatibleAnnotation(binding).ifPresent(factoryBuilder::addAnnotation);

return Optional.of(factoryBuilder);
}

Expand Down
56 changes: 56 additions & 0 deletions java/dagger/internal/codegen/GwtCompatibility.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* Copyright (C) 2017 The Dagger 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 dagger.internal.codegen;

import static com.google.common.base.Preconditions.checkArgument;

import com.squareup.javapoet.AnnotationSpec;
import java.util.Optional;
import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.Element;
import javax.lang.model.element.Name;

final class GwtCompatibility {

/**
* Returns a {@code @GwtIncompatible} annotation that is applied to {@code binding}'s {@link
* Binding#bindingElement()} or any enclosing type.
*/
static Optional<AnnotationSpec> gwtIncompatibleAnnotation(Binding binding) {
checkArgument(binding.bindingElement().isPresent());
Element element = binding.bindingElement().get();
while (element != null) {
Optional<AnnotationSpec> gwtIncompatible =
element
.getAnnotationMirrors()
.stream()
.filter(annotation -> isGwtIncompatible(annotation))
.map(AnnotationSpec::get)
.findFirst();
if (gwtIncompatible.isPresent()) {
return gwtIncompatible;
}
element = element.getEnclosingElement();
}
return Optional.empty();
}

private static boolean isGwtIncompatible(AnnotationMirror annotation) {
Name simpleName = annotation.getAnnotationType().asElement().getSimpleName();
return simpleName.contentEquals("GwtIncompatible");
}
}
3 changes: 3 additions & 0 deletions java/dagger/internal/codegen/MembersInjectorGenerator.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import static dagger.internal.codegen.AnnotationSpecs.suppressWarnings;
import static dagger.internal.codegen.CodeBlocks.makeParametersCodeBlock;
import static dagger.internal.codegen.CodeBlocks.toParametersCodeBlock;
import static dagger.internal.codegen.GwtCompatibility.gwtIncompatibleAnnotation;
import static dagger.internal.codegen.SourceFiles.bindingTypeElementTypeVariableNames;
import static dagger.internal.codegen.SourceFiles.frameworkTypeUsageStatement;
import static dagger.internal.codegen.SourceFiles.generateBindingFieldsForDependencies;
Expand Down Expand Up @@ -219,6 +220,8 @@ Optional<TypeSpec.Builder> write(ClassName generatedTypeName, MembersInjectionBi
injectorTypeBuilder.addMethod(injectMembersBuilder.build());
injectMethodsForSubclasses.forEach(injectorTypeBuilder::addMethod);

gwtIncompatibleAnnotation(binding).ifPresent(injectorTypeBuilder::addAnnotation);

return Optional.of(injectorTypeBuilder);
}

Expand Down
3 changes: 3 additions & 0 deletions java/dagger/internal/codegen/ProducerFactoryGenerator.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import static com.squareup.javapoet.TypeSpec.classBuilder;
import static dagger.internal.codegen.AnnotationSpecs.Suppression.UNCHECKED;
import static dagger.internal.codegen.CodeBlocks.makeParametersCodeBlock;
import static dagger.internal.codegen.GwtCompatibility.gwtIncompatibleAnnotation;
import static dagger.internal.codegen.SourceFiles.frameworkTypeUsageStatement;
import static dagger.internal.codegen.SourceFiles.generateBindingFieldsForDependencies;
import static dagger.internal.codegen.SourceFiles.generatedClassNameForBinding;
Expand Down Expand Up @@ -214,6 +215,8 @@ Optional<TypeSpec.Builder> write(ClassName generatedTypeName, ProductionBinding
factoryBuilder.addMethod(applyMethodBuilder.build());
factoryBuilder.addMethod(executeMethodBuilder.build());

gwtIncompatibleAnnotation(binding).ifPresent(factoryBuilder::addAnnotation);

// TODO(gak): write a sensible toString
return Optional.of(factoryBuilder);
}
Expand Down
72 changes: 72 additions & 0 deletions javatests/dagger/functional/gwt/GwtIncompatibles.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
/*
* Copyright (C) 2017 The Dagger 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 dagger.functional.gwt;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

import dagger.Module;
import dagger.Provides;
import java.lang.annotation.Retention;
import javax.inject.Inject;

interface GwtIncompatibles {
@Retention(RUNTIME)
@interface GwtIncompatible {}

@GwtIncompatible
class OnClass {
@Inject
OnClass() {}
}

class OnConstructor {
@Inject
@GwtIncompatible
OnConstructor() {}
}

@GwtIncompatible
class OuterClass {
static class OnOuterClass {
@Inject
OnOuterClass() {}
}
}

@GwtIncompatible
class MembersInjectedType {
@Inject String string;
}

@GwtIncompatible
@Module
class OnModule {
@Provides
static String onModule() {
return "on module";
}
}

@Module
class OnMethod {
@GwtIncompatible
@Provides
static String onMethod() {
return "on method";
}
}
}
45 changes: 45 additions & 0 deletions javatests/dagger/functional/gwt/GwtIncompatiblesTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/*
* Copyright (C) 2017 The Dagger 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 dagger.functional.gwt;

import dagger.functional.gwt.GwtIncompatibles.GwtIncompatible;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Tests for {@code @GwtIncompatible} bindings. */
@RunWith(JUnit4.class)
public class GwtIncompatiblesTest {
@Test
public void testIncompatible() {
assertGwtIncompatible(GwtIncompatibles_OnClass_Factory.class);
assertGwtIncompatible(GwtIncompatibles_OnConstructor_Factory.class);
assertGwtIncompatible(GwtIncompatibles_OuterClass_OnOuterClass_Factory.class);

assertGwtIncompatible(GwtIncompatibles_MembersInjectedType_MembersInjector.class);

assertGwtIncompatible(GwtIncompatibles_OnModule_OnModuleFactory.class);
assertGwtIncompatible(GwtIncompatibles_OnMethod_OnMethodFactory.class);
}

private void assertGwtIncompatible(Class<?> clazz) {
boolean gwtIncompatible = clazz.getAnnotation(GwtIncompatible.class) != null;
if (!gwtIncompatible) {
throw new AssertionError(clazz.getCanonicalName() + " is not @GwtIncompatible");
}
}
}
46 changes: 46 additions & 0 deletions javatests/dagger/functional/producers/gwt/GwtIncompatibles.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/*
* Copyright (C) 2017 The Dagger 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 dagger.functional.producers.gwt;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

import dagger.producers.ProducerModule;
import dagger.producers.Produces;
import java.lang.annotation.Retention;

interface GwtIncompatibles {
@Retention(RUNTIME)
@interface GwtIncompatible {}

@GwtIncompatible
@ProducerModule
class OnModule {
@Produces
static String onModule() {
return "on module";
}
}

@ProducerModule
class OnMethod {
@GwtIncompatible
@Produces
static String onMethod() {
return "on method";
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/*
* Copyright (C) 2017 The Dagger 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 dagger.functional.producers.gwt;

import dagger.functional.producers.gwt.GwtIncompatibles.GwtIncompatible;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Tests for {@code @GwtIncompatible} bindings. */
@RunWith(JUnit4.class)
public class GwtIncompatiblesTest {
@Test
public void testIncompatible() {
assertGwtIncompatible(GwtIncompatibles_OnModule_OnModuleFactory.class);
assertGwtIncompatible(GwtIncompatibles_OnMethod_OnMethodFactory.class);
}

private void assertGwtIncompatible(Class<?> clazz) {
boolean gwtIncompatible = clazz.getAnnotation(GwtIncompatible.class) != null;
if (!gwtIncompatible) {
throw new AssertionError(clazz.getCanonicalName() + " is not @GwtIncompatible");
}
}
}

0 comments on commit b15108f

Please sign in to comment.