square/auto-value-redacted

An extension for Google's AutoValue that omits redacted fields from toString().

AutoValue: Redacted Extension

An extension for Google's AutoValue that omits @Redacted field values from toString().

Usage

Include the extension in your project, define a @Redacted annotation, and apply it to any fields that you wish to redact.

@Retention(SOURCE)
@Target({METHOD, PARAMETER, FIELD})
public @interface Redacted {
}

@AutoValue
public abstract class User {
  public abstract String name();
  @Redacted public abstract String phoneNumber();
}

When you call toString() any @Redacted properties are hidden:

User{name=Bob, phoneNumber=██}

Download

Add a Gradle dependency:

annotationProcessor 'com.squareup.auto.value:auto-value-redacted:1.1.1'

or Maven:

<dependency>
  <groupId>com.squareup.auto.value</groupId>
  <artifactId>auto-value-redacted</artifactId>
  <version>1.1.1</version>
  <scope>provided</scope>
</dependency>

Snapshots of the development version are available in Sonatype's snapshots repository.

License

Copyright 2015 Square, 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.

auto-value-redacted's Issues

Add support for incremental annotation processing by implementing new AutoValueExtension API

Auto Value supports incremental annotation processing in 1.6.3-rc1. auto-value-redacted can implement new API to support incremental annotation processing.

Problem while using toBuilder()

I am having problem while creating AutoValue with @Redacted . The sample code is

`@AutoValue
abstract class Animal {
@redacted abstract String name();
abstract int numberOfLegs();

abstract Builder toBuilder();

static Builder builder() {
    return new AutoValue_Animal.Builder();
}

@AutoValue.Builder
abstract static class Builder {
    abstract Builder setName(String value);
    abstract Builder setNumberOfLegs(int value);
    abstract Animal build();
}

}`

Compilation Breaks if using bean-style getters

I have a class representing a person with a field I want redacted. It's a class being used for Android data binding, so it requires bean-style getters. The @Redacted extension generates a toString() implementation that assumes the more fluent style getters, which throws an error on compilation.

Support for Generic Class

When I am using a generic class, there was problem in generated class which causes compilation problem.
Say, my code is

@AutoValue
public abstract class TestUser<T> {
	@Redacted
	public abstract String name();
	public static <T> Builder<T> builder() {
		return new AutoValue_TestUser.Builder<>();
	}
	@AutoValue.Builder
	public abstract static class Builder<T> {
		public abstract Builder<T> name(String name);
		public abstract TestUser<T> build();
	}
}

But, the generated code will should have class looks like

final class AutoValue_TestUser extends $AutoValue_TestUser {
  AutoValue_TestUser(String name) {
    super(name);
  }
  @Override
  public final String toString() {
    return "TestUser{"
        + "name=██"
        + '}';
  }
}

But it should have been
final class AutoValue_TestUser<T> extends $AutoValue_TestUser<T>

auto-value - 1.6.5
auto-value-redacted - 1.1.0

Any help regarding this is much appreciated.

Field is still in toString

I made all what's in the readme:

1. added extension to project
2. defined the annotation
3. used the annotation
   rebuild project -> field is still in auto-value-generated toString()

using AutoValue 1.2-rc1
I'm also using the extension auto-value-parcel

No dependency on Guava

auto-value-redacted does not have a dependency on Guava, but is using ImmutableSet. At build time Guava is pulled in by auto-service. Most users probably won't notice this because it's pulled in by other extensions.