Initial commit
review-strategy plugin, A plugin to control various ways to review
changes. Although I've only implemented one strategy, the purpose
of this plugin is to allow developers to implement many different
review strategies.
Done:
* Adds a per-user preference to select the review strategy
* BLIND strategy hides the following information on the change view:
author, commiter, reviewer(s), change history summaries.
Note - 'expand all' button will show reviewer's votes and comments.
I've left this as-is on purpose so that users can get a *sneek peek*
at the votes.
diff --git a/.buckconfig b/.buckconfig
new file mode 100644
index 0000000..6a19c9a
--- /dev/null
+++ b/.buckconfig
@@ -0,0 +1,14 @@
+[alias]
+ review-strategy = //:review-strategy
+ plugin = //:review-strategy
+
+[java]
+ src_roots = java, resources
+
+[project]
+ ignore = .git
+
+[cache]
+ mode = dir
+ dir = buck-out/cache
+
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..b4277e3
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,10 @@
+/.buckversion
+/.buckd
+/.watchmanconfig
+/buck-out
+/bucklets
+/target
+/.classpath
+/.project
+/.settings/org.maven.ide.eclipse.prefs
+/.settings/org.eclipse.m2e.core.prefs
diff --git a/BUCK b/BUCK
new file mode 100644
index 0000000..5fe7c32
--- /dev/null
+++ b/BUCK
@@ -0,0 +1,21 @@
+include_defs('//bucklets/gerrit_plugin.bucklet')
+
+gerrit_plugin(
+ name = 'review-strategy',
+ srcs = glob(['src/main/java/**/*.java']),
+ resources = glob(['src/main/**/*']),
+ gwt_module = 'com.googlesource.gerrit.plugins.reviewstrategy.ReviewStrategy',
+ manifest_entries = [
+ 'Gerrit-PluginName: review-strategy',
+ 'Gerrit-ApiType: plugin',
+ 'Gerrit-ApiVersion: 2.12-SNAPSHOT',
+ 'Gerrit-Module: com.googlesource.gerrit.plugins.reviewstrategy.Module',
+ 'Gerrit-HttpModule: com.googlesource.gerrit.plugins.reviewstrategy.HttpModule',
+ ],
+)
+
+# this is required for bucklets/tools/eclipse/project.py to work
+java_library(
+ name = 'classpath',
+ deps = [':review-strategy__plugin'],
+)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..11069ed
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.
diff --git a/VERSION b/VERSION
new file mode 100644
index 0000000..9df7bf7
--- /dev/null
+++ b/VERSION
@@ -0,0 +1,5 @@
+# Used by BUCK to include "Implementation-Version" in plugin Manifest.
+# If this file doesn't exist the output of 'git describe' is used
+# instead.
+PLUGIN_VERSION = '2.12-SNAPSHOT'
+
diff --git a/lib/gerrit/BUCK b/lib/gerrit/BUCK
new file mode 100644
index 0000000..ae59eba
--- /dev/null
+++ b/lib/gerrit/BUCK
@@ -0,0 +1,20 @@
+include_defs('//bucklets/maven_jar.bucklet')
+
+VER = '2.12-SNAPSHOT'
+REPO = MAVEN_LOCAL
+
+maven_jar(
+ name = 'plugin-api',
+ id = 'com.google.gerrit:gerrit-plugin-api:' + VER,
+ attach_source = False,
+ repository = REPO,
+ license = 'Apache2.0',
+)
+
+maven_jar(
+ name = 'gwtui-api',
+ id = 'com.google.gerrit:gerrit-plugin-gwtui:' + VER,
+ attach_source = False,
+ repository = REPO,
+ license = 'Apache2.0',
+)
diff --git a/lib/gwt/BUCK b/lib/gwt/BUCK
new file mode 100644
index 0000000..662e776
--- /dev/null
+++ b/lib/gwt/BUCK
@@ -0,0 +1,32 @@
+include_defs('//bucklets/maven_jar.bucklet')
+
+VERSION = '2.7.0'
+
+maven_jar(
+ name = 'user',
+ id = 'com.google.gwt:gwt-user:' + VERSION,
+ license = 'Apache2.0',
+ attach_source = False,
+)
+
+maven_jar(
+ name = 'dev',
+ id = 'com.google.gwt:gwt-dev:' + VERSION,
+ license = 'Apache2.0',
+ deps = [
+ ':javax-validation',
+ ':javax-validation_src',
+ ],
+ attach_source = False,
+ exclude = ['org/eclipse/jetty/*'],
+)
+
+maven_jar(
+ name = 'javax-validation',
+ id = 'javax.validation:validation-api:1.0.0.GA',
+ bin_sha1 = 'b6bd7f9d78f6fdaa3c37dae18a4bd298915f328e',
+ src_sha1 = '7a561191db2203550fbfa40d534d4997624cd369',
+ license = 'Apache2.0',
+ visibility = [],
+)
+
diff --git a/lib/ow2/BUCK b/lib/ow2/BUCK
new file mode 100644
index 0000000..db6c76c
--- /dev/null
+++ b/lib/ow2/BUCK
@@ -0,0 +1,32 @@
+include_defs('//bucklets/maven_jar.bucklet')
+
+VERSION = '5.0.3'
+
+maven_jar(
+ name = 'ow2-asm',
+ id = 'org.ow2.asm:asm:' + VERSION,
+ sha1 = 'dcc2193db20e19e1feca8b1240dbbc4e190824fa',
+ license = 'ow2',
+)
+
+maven_jar(
+ name = 'ow2-asm-analysis',
+ id = 'org.ow2.asm:asm-analysis:' + VERSION,
+ sha1 = 'c7126aded0e8e13fed5f913559a0dd7b770a10f3',
+ license = 'ow2',
+)
+
+maven_jar(
+ name = 'ow2-asm-tree',
+ id = 'org.ow2.asm:asm-tree:' + VERSION,
+ sha1 = '287749b48ba7162fb67c93a026d690b29f410bed',
+ license = 'ow2',
+)
+
+maven_jar(
+ name = 'ow2-asm-util',
+ id = 'org.ow2.asm:asm-util:' + VERSION,
+ sha1 = '1512e5571325854b05fb1efce1db75fcced54389',
+ license = 'ow2',
+)
+
diff --git a/pom.xml b/pom.xml
new file mode 100644
index 0000000..24a956d
--- /dev/null
+++ b/pom.xml
@@ -0,0 +1,121 @@
+<!--
+Copyright (C) 2016 The Android Open Source Project
+
+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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>com.googlesource.gerrit.plugins.reviewstrategy</groupId>
+ <artifactId>review-strategy</artifactId>
+ <packaging>jar</packaging>
+ <version>2.12-SNAPSHOT</version>
+ <name>review-strategy</name>
+
+ <properties>
+ <Gerrit-ApiType>plugin</Gerrit-ApiType>
+ <Gerrit-ApiVersion>${project.version}</Gerrit-ApiVersion>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jar-plugin</artifactId>
+ <version>2.4</version>
+ <configuration>
+ <includes>
+ <include>**/*.*</include>
+ </includes>
+ <archive>
+ <manifestEntries>
+ <Gerrit-PluginName>review-strategy</Gerrit-PluginName>
+ <Gerrit-Module>com.googlesource.gerrit.plugins.reviewstrategy.Module</Gerrit-Module>
+ <Gerrit-HttpModule>com.googlesource.gerrit.plugins.reviewstrategy.HttpModule</Gerrit-HttpModule>
+ <Implementation-Vendor>Gerrit Code Review</Implementation-Vendor>
+ <Implementation-URL>https://www.gerritcodereview.com/</Implementation-URL>
+
+ <Implementation-Title>${Gerrit-ApiType} ${project.artifactId}</Implementation-Title>
+ <Implementation-Version>${project.version}</Implementation-Version>
+
+ <Gerrit-ApiType>${Gerrit-ApiType}</Gerrit-ApiType>
+ <Gerrit-ApiVersion>${Gerrit-ApiVersion}</Gerrit-ApiVersion>
+ </manifestEntries>
+ </archive>
+ </configuration>
+ </plugin>
+
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <version>2.3.2</version>
+ <configuration>
+ <source>1.7</source>
+ <target>1.7</target>
+ <encoding>UTF-8</encoding>
+ </configuration>
+ </plugin>
+
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>gwt-maven-plugin</artifactId>
+ <version>2.7.0</version>
+ <configuration>
+ <module>com.googlesource.gerrit.plugins.reviewstrategy.ReviewStrategy</module>
+ <disableClassMetadata>true</disableClassMetadata>
+ <disableCastChecking>true</disableCastChecking>
+ <webappDirectory>${project.build.directory}/classes/static</webappDirectory>
+ </configuration>
+ <executions>
+ <execution>
+ <goals>
+ <goal>compile</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+
+ </plugins>
+ </build>
+
+ <dependencies>
+ <dependency>
+ <groupId>com.google.gerrit</groupId>
+ <artifactId>gerrit-${Gerrit-ApiType}-api</artifactId>
+ <version>${Gerrit-ApiVersion}</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>com.google.gerrit</groupId>
+ <artifactId>gerrit-plugin-gwtui</artifactId>
+ <version>${Gerrit-ApiVersion}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>com.google.gwt</groupId>
+ <artifactId>gwt-user</artifactId>
+ <version>2.7.0</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+
+ <repositories>
+ <repository>
+ <id>snapshot-repository</id>
+ <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
+ </repository>
+ </repositories>
+</project>
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/GetPreferences.java b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/GetPreferences.java
new file mode 100644
index 0000000..452f9ba
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/GetPreferences.java
@@ -0,0 +1,77 @@
+// Copyright (C) 2016 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.reviewstrategy;
+
+import com.google.gerrit.extensions.annotations.PluginName;
+import com.google.gerrit.extensions.restapi.AuthException;
+import com.google.gerrit.extensions.restapi.ResourceNotFoundException;
+import com.google.gerrit.extensions.restapi.RestReadView;
+import com.google.gerrit.server.CurrentUser;
+import com.google.gerrit.server.account.AccountResource;
+import com.google.gerrit.server.account.VersionedAccountPreferences;
+import com.google.gerrit.server.config.AllUsersName;
+import com.google.gerrit.server.git.GitRepositoryManager;
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import com.google.inject.Singleton;
+
+import org.eclipse.jgit.errors.ConfigInvalidException;
+import org.eclipse.jgit.lib.Repository;
+
+import java.io.IOException;
+
+@Singleton
+public class GetPreferences implements RestReadView<AccountResource> {
+ private final String pluginName;
+ private final Provider<CurrentUser> self;
+ private final AllUsersName allUsersName;
+ private final GitRepositoryManager gitMgr;
+
+ @Inject
+ public GetPreferences(@PluginName String pluginName,
+ Provider<CurrentUser> self,
+ AllUsersName allUsersName,
+ GitRepositoryManager gitMgr) {
+ this.pluginName = pluginName;
+ this.self = self;
+ this.allUsersName = allUsersName;
+ this.gitMgr = gitMgr;
+ }
+
+ @Override
+ public PreferencesInfo apply(AccountResource rsrc) throws AuthException,
+ ResourceNotFoundException, IOException, ConfigInvalidException {
+ if (self.get() != rsrc.getUser()
+ && !self.get().getCapabilities().canModifyAccount()) {
+ throw new AuthException("not allowed to get preferences");
+ }
+
+ try (Repository git = gitMgr.openRepository(allUsersName)) {
+ VersionedAccountPreferences p =
+ VersionedAccountPreferences.forUser(rsrc.getUser().getAccountId());
+ p.load(git);
+
+ PreferencesInfo info = new PreferencesInfo();
+ info.reviewStrategy =
+ p.getConfig().getEnum(
+ "plugin", pluginName, "strategy", ReviewStrategy.DEFAULT);
+ return info;
+ }
+ }
+
+ public static class PreferencesInfo {
+ ReviewStrategy reviewStrategy;
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/HttpModule.java b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/HttpModule.java
new file mode 100644
index 0000000..f84bda9
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/HttpModule.java
@@ -0,0 +1,29 @@
+// Copyright (C) 2016 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.reviewstrategy;
+
+import com.google.gerrit.extensions.registration.DynamicSet;
+import com.google.gerrit.extensions.webui.GwtPlugin;
+import com.google.gerrit.extensions.webui.WebUiPlugin;
+import com.google.gerrit.httpd.plugins.HttpPluginModule;
+
+public class HttpModule extends HttpPluginModule {
+
+ @Override
+ protected void configureServlets() {
+ DynamicSet.bind(binder(), WebUiPlugin.class)
+ .toInstance(new GwtPlugin("ReviewStrategy"));
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/Module.java b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/Module.java
new file mode 100644
index 0000000..58eb3d7
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/Module.java
@@ -0,0 +1,34 @@
+// Copyright (C) 2016 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.reviewstrategy;
+
+import static com.google.gerrit.server.account.AccountResource.ACCOUNT_KIND;
+
+import com.google.gerrit.extensions.restapi.RestApiModule;
+import com.google.inject.AbstractModule;
+
+public class Module extends AbstractModule {
+
+ @Override
+ protected void configure() {
+ install(new RestApiModule() {
+ @Override
+ protected void configure() {
+ get(ACCOUNT_KIND, "preferences").to(GetPreferences.class);
+ put(ACCOUNT_KIND, "preferences").to(SetPreferences.class);
+ }
+ });
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/ReviewStrategy.gwt.xml b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/ReviewStrategy.gwt.xml
new file mode 100644
index 0000000..c6fb5af
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/ReviewStrategy.gwt.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (C) 2016 The Android Open Source Project
+
+ 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.
+-->
+<module rename-to="ReviewStrategy">
+ <!-- Inherit the core Web Toolkit stuff. -->
+ <inherits name="com.google.gwt.user.User"/>
+ <!-- Other module inherits -->
+ <inherits name="com.google.gerrit.Plugin"/>
+ <inherits name="com.google.gwt.http.HTTP"/>
+ <!-- Using GWT built-in themes adds a number of static -->
+ <!-- resources to the plugin. No theme inherits lines were -->
+ <!-- added in order to make this plugin as simple as possible -->
+ <!-- Specify the app entry point class. -->
+ <entry-point class="com.googlesource.gerrit.plugins.reviewstrategy.client.ReviewStrategyPlugin"/>
+ <stylesheet src="review-strategy.css"/>
+</module>
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/ReviewStrategy.java b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/ReviewStrategy.java
new file mode 100644
index 0000000..1fe030b
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/ReviewStrategy.java
@@ -0,0 +1,19 @@
+// Copyright (C) 2016 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.reviewstrategy;
+
+public enum ReviewStrategy {
+ DEFAULT, BLIND
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/SetPreferences.java b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/SetPreferences.java
new file mode 100644
index 0000000..43bf708
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/SetPreferences.java
@@ -0,0 +1,94 @@
+// Copyright (C) 2016 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.reviewstrategy;
+
+import com.google.gerrit.extensions.annotations.PluginName;
+import com.google.gerrit.extensions.restapi.AuthException;
+import com.google.gerrit.extensions.restapi.RestModifyView;
+import com.google.gerrit.server.CurrentUser;
+import com.google.gerrit.server.account.AccountResource;
+import com.google.gerrit.server.account.VersionedAccountPreferences;
+import com.google.gerrit.server.config.AllUsersName;
+import com.google.gerrit.server.git.MetaDataUpdate;
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+
+import com.googlesource.gerrit.plugins.reviewstrategy.GetPreferences.PreferencesInfo;
+import com.googlesource.gerrit.plugins.reviewstrategy.SetPreferences.Input;
+
+import org.eclipse.jgit.errors.ConfigInvalidException;
+import org.eclipse.jgit.errors.RepositoryNotFoundException;
+
+import java.io.IOException;
+
+public class SetPreferences implements RestModifyView<AccountResource, Input> {
+ public static class Input {
+ ReviewStrategy reviewStrategy;
+ }
+
+ private final String pluginName;
+ private final Provider<CurrentUser> self;
+ private final AllUsersName allUsersName;
+ private final Provider<MetaDataUpdate.User> metaDataUpdateFactory;
+
+ @Inject
+ public SetPreferences(@PluginName String pluginName,
+ Provider<CurrentUser> self,
+ AllUsersName allUsersName,
+ Provider<MetaDataUpdate.User> metaDataUpdateFactory) {
+ this.pluginName = pluginName;
+ this.self = self;
+ this.allUsersName = allUsersName;
+ this.metaDataUpdateFactory = metaDataUpdateFactory;
+ }
+
+ @Override
+ public GetPreferences.PreferencesInfo apply(AccountResource rsrc, Input input)
+ throws AuthException, RepositoryNotFoundException, IOException,
+ ConfigInvalidException {
+ if (self.get() != rsrc.getUser()
+ && !self.get().getCapabilities().canModifyAccount()) {
+ throw new AuthException("not allowed to set preferences");
+ }
+
+ if (input == null) {
+ input = new Input();
+ }
+ if (input.reviewStrategy == null) {
+ input.reviewStrategy = ReviewStrategy.DEFAULT;
+ }
+
+ VersionedAccountPreferences p =
+ VersionedAccountPreferences.forUser(rsrc.getUser().getAccountId());
+ MetaDataUpdate md = metaDataUpdateFactory.get().create(allUsersName);
+ try {
+ p.load(md);
+
+ if (input.reviewStrategy != ReviewStrategy.DEFAULT) {
+ p.getConfig().setEnum("plugin", pluginName, "strategy", input.reviewStrategy);
+ } else {
+ p.getConfig().unset("plugin", pluginName, "strategy");
+ }
+
+ p.commit(md);
+ } finally {
+ md.close();
+ }
+
+ PreferencesInfo info = new PreferencesInfo();
+ info.reviewStrategy = input.reviewStrategy;
+ return info;
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/LabelPanel.java b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/LabelPanel.java
new file mode 100644
index 0000000..fbdd4e2
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/LabelPanel.java
@@ -0,0 +1,46 @@
+// Copyright (C) 2016 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.reviewstrategy.client;
+
+import com.google.gerrit.plugin.client.Plugin;
+import com.google.gerrit.plugin.client.extension.Panel;
+import com.google.gerrit.plugin.client.rpc.RestApi;
+import com.google.gwt.user.client.rpc.AsyncCallback;
+import com.google.gwt.user.client.ui.VerticalPanel;
+
+public class LabelPanel extends VerticalPanel {
+ static class Factory implements Panel.EntryPoint {
+ @Override
+ public void onLoad(Panel panel) {
+ panel.setWidget(new LabelPanel());
+ }
+ }
+
+ LabelPanel() {
+ new RestApi("accounts").id("self").view(
+ Plugin.get().getPluginName(), "preferences")
+ .get(new AsyncCallback<PreferencesInfo>() {
+ @Override
+ public void onSuccess(PreferencesInfo result) {
+ ReviewStrategyPlugin.refreshDefaultReviewStrategy(result.reviewStrategy());
+ }
+
+ @Override
+ public void onFailure(Throwable caught) {
+ // never invoked
+ }
+ });
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/PreferencesInfo.java b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/PreferencesInfo.java
new file mode 100644
index 0000000..1651571
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/PreferencesInfo.java
@@ -0,0 +1,37 @@
+// Copyright (C) 2016 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.reviewstrategy.client;
+
+import com.google.gwt.core.client.JavaScriptObject;
+
+public class PreferencesInfo extends JavaScriptObject {
+ public static enum ReviewStrategy {
+ DEFAULT, BLIND
+ }
+
+ public static PreferencesInfo create() {
+ return (PreferencesInfo) createObject();
+ }
+
+ public final ReviewStrategy reviewStrategy() {
+ return ReviewStrategy.valueOf(_reviewStrategy());
+ }
+
+ private final native String _reviewStrategy() /*-{ return this.review_strategy; }-*/;
+ public final native void reviewStrategy(String n) /*-{ if(n)this.review_strategy=n; }-*/;
+
+ protected PreferencesInfo() {
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/ReviewStrategyPlugin.java b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/ReviewStrategyPlugin.java
new file mode 100644
index 0000000..46d003d
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/ReviewStrategyPlugin.java
@@ -0,0 +1,110 @@
+// Copyright (C) 2016 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.reviewstrategy.client;
+
+import com.google.gerrit.client.GerritUiExtensionPoint;
+import com.google.gerrit.client.Resources;
+import com.google.gerrit.plugin.client.Plugin;
+import com.google.gerrit.plugin.client.PluginEntryPoint;
+import com.google.gwt.core.client.GWT;
+import com.google.gwt.dom.client.Element;
+import com.google.gwt.user.client.ui.RootPanel;
+
+import com.googlesource.gerrit.plugins.reviewstrategy.client.PreferencesInfo.ReviewStrategy;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class ReviewStrategyPlugin extends PluginEntryPoint {
+ public static final Resources RESOURCES = GWT.create(Resources.class);
+
+ private final static String REVIEWERS_CLASS = "com-google-gerrit-" +
+ "client-change-ChangeScreen_BinderImpl_GenCss_style-label_user";
+ private final static String AUTHOR_COMMITER_CLASS = "com-google-gerrit-" +
+ "client-change-CommitBox_BinderImpl_GenCss_style-userPanel";
+ private final static String OWNER_CLASS = "com-google-gerrit-" +
+ "client-change-ChangeScreen_BinderImpl_GenCss_style-ownerPanel";
+ private final static String REVIEW_HISTORY_SUMMARY_CLASS = "com-google-" +
+ "gerrit-client-change-Message_BinderImpl_GenCss_style-summary";
+
+ private final static String HIDE_REVIEWERS_CLASS = Plugin.get()
+ .getName() + "-hideReviewers";
+ private final static String HIDE_AUTHOR_COMMITER_CLASS = Plugin.get()
+ .getName() + "-hideAuthorCommiter";
+ private final static String HIDE_OWNER_CLASS = Plugin.get()
+ .getName() + "-hideOwner";
+ private final static String HIDE_REVIEW_HISTORY_SUMMARY_CLASS = Plugin.get()
+ .getName() + "-hideReviewHistorySummary";
+
+ private static Map<String, String> classes = null;
+ static {
+ classes = new HashMap<>();
+ classes.put(REVIEWERS_CLASS, HIDE_REVIEWERS_CLASS);
+ classes.put(AUTHOR_COMMITER_CLASS, HIDE_AUTHOR_COMMITER_CLASS);
+ classes.put(OWNER_CLASS, HIDE_OWNER_CLASS);
+ classes.put(
+ REVIEW_HISTORY_SUMMARY_CLASS, HIDE_REVIEW_HISTORY_SUMMARY_CLASS);
+ }
+
+ @Override
+ public void onPluginLoad() {
+ injectCssToHideDefaultClasses();
+
+ Plugin.get().panel(
+ GerritUiExtensionPoint.CHANGE_SCREEN_BELOW_CHANGE_INFO_BLOCK,
+ new LabelPanel.Factory());
+ Plugin.get().panel(
+ GerritUiExtensionPoint.PREFERENCES_SCREEN_BOTTOM,
+ new ReviewStrategyPreferencesPanel.Factory());
+ }
+
+ public static void refreshDefaultReviewStrategy(ReviewStrategy ui) {
+ if (ui == ReviewStrategy.BLIND) {
+ hideDefaultReviewStrategy();
+ } else {
+ showDefaultReviewStrategy();
+ }
+ }
+
+ private static void hideDefaultReviewStrategy() {
+ Element body = RootPanel.getBodyElement();
+ for (Map.Entry<String, String> entry : classes.entrySet()) {
+ if (!body.hasClassName(entry.getValue())) {
+ body.addClassName(entry.getValue());
+ }
+ }
+ }
+
+ private static void showDefaultReviewStrategy() {
+ for (Map.Entry<String, String> entry : classes.entrySet()) {
+ RootPanel.getBodyElement().removeClassName(entry.getValue());
+ }
+ }
+
+ private void injectCssToHideDefaultClasses() {
+ StringBuilder css = new StringBuilder();
+ for (Map.Entry<String, String> entry : classes.entrySet()) {
+ css.append(".");
+ css.append(entry.getValue());
+ css.append(" .");
+ css.append(entry.getKey());
+ css.append(" {display: none;}");
+ injectCss(css.toString());
+ }
+ }
+
+ private final native void injectCss(String css)
+ /*-{ return $wnd.Gerrit.injectCss(css) }-*/;
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/ReviewStrategyPreferencesPanel.java b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/ReviewStrategyPreferencesPanel.java
new file mode 100644
index 0000000..cbdf591
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/client/ReviewStrategyPreferencesPanel.java
@@ -0,0 +1,126 @@
+// Copyright (C) 2016 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.reviewstrategy.client;
+
+import com.google.gerrit.plugin.client.Plugin;
+import com.google.gerrit.plugin.client.extension.Panel;
+import com.google.gerrit.plugin.client.rpc.RestApi;
+import com.google.gwt.dom.client.Style.Unit;
+import com.google.gwt.event.dom.client.ChangeEvent;
+import com.google.gwt.event.dom.client.ChangeHandler;
+import com.google.gwt.user.client.Timer;
+import com.google.gwt.user.client.rpc.AsyncCallback;
+import com.google.gwt.user.client.ui.HorizontalPanel;
+import com.google.gwt.user.client.ui.Label;
+import com.google.gwt.user.client.ui.ListBox;
+import com.google.gwt.user.client.ui.VerticalPanel;
+
+public class ReviewStrategyPreferencesPanel extends VerticalPanel {
+ static class Factory implements Panel.EntryPoint {
+ @Override
+ public void onLoad(Panel panel) {
+ panel.setWidget(new ReviewStrategyPreferencesPanel());
+ }
+ }
+
+ private Label savedLabel;
+ private Timer hideTimer;
+
+ ReviewStrategyPreferencesPanel() {
+ new RestApi("accounts").id("self")
+ .view(Plugin.get().getPluginName(), "preferences")
+ .get(new AsyncCallback<PreferencesInfo>() {
+ @Override
+ public void onSuccess(PreferencesInfo result) {
+ display(result);
+ }
+
+ @Override
+ public void onFailure(Throwable caught) {
+ // never invoked
+ }
+ });
+ }
+
+ private void display(PreferencesInfo info) {
+ Label heading = new Label(Plugin.get().getName() + " plugin");
+ heading.setStyleName("smallHeading");
+ add(heading);
+ HorizontalPanel p = new HorizontalPanel();
+ add(p);
+
+ Label label = new Label("Review Strategy:");
+ p.add(label);
+ label.getElement().getStyle().setMarginRight(5, Unit.PX);
+ label.getElement().getStyle().setMarginTop(2, Unit.PX);
+ final ListBox ui = new ListBox();
+ p.add(ui);
+ savedLabel = new Label("Saved");
+ savedLabel.getElement().getStyle().setMarginLeft(5, Unit.PX);
+ savedLabel.getElement().getStyle().setMarginTop(2, Unit.PX);
+ savedLabel.setVisible(false);
+ p.add(savedLabel);
+
+ for (PreferencesInfo.ReviewStrategy v :
+ PreferencesInfo.ReviewStrategy.values()) {
+ ui.addItem(v.name(), v.name());
+ }
+
+ for (int i = 0; i < ui.getItemCount(); i++) {
+ if (info.reviewStrategy().name().equals(ui.getValue(i))) {
+ ui.setSelectedIndex(i);
+ break;
+ }
+ }
+
+ ui.addChangeHandler(new ChangeHandler() {
+ @Override
+ public void onChange(ChangeEvent event) {
+ savedLabel.setVisible(false);
+ PreferencesInfo info = PreferencesInfo.create();
+ info.reviewStrategy(ui.getSelectedValue());
+ new RestApi("accounts").id("self")
+ .view(Plugin.get().getPluginName(), "preferences")
+ .put(info, new AsyncCallback<PreferencesInfo>() {
+ @Override
+ public void onSuccess(PreferencesInfo result) {
+ showSavedStatus();
+ }
+
+ @Override
+ public void onFailure(Throwable caught) {
+ // never invoked
+ }
+ });
+ }
+ });
+ }
+
+ private void showSavedStatus() {
+ if (hideTimer != null) {
+ hideTimer.cancel();
+ hideTimer = null;
+ }
+ savedLabel.setVisible(true);
+ hideTimer = new Timer() {
+ @Override
+ public void run() {
+ savedLabel.setVisible(false);
+ hideTimer = null;
+ }
+ };
+ hideTimer.schedule(1000);
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/public/review-strategy.css b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/public/review-strategy.css
new file mode 100644
index 0000000..4bd49be
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewstrategy/public/review-strategy.css
@@ -0,0 +1,3 @@
+.reviewstrategy-panel {
+ border-spacing: 0px 5px;
+}
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md
new file mode 100644
index 0000000..b9421b6
--- /dev/null
+++ b/src/main/resources/Documentation/about.md
@@ -0,0 +1,18 @@
+The @PLUGIN@ plugin allows users to configure a different review strategies.
+
+User can configure the label UI under `Settings` > `Preferences` >
+`Review Strategy`:
+
+
+
+### `DEFAULT`
+
+This is the one that come out of the box with Gerrit. All of the information
+for a change is shown to the user for a review.
+
+### `BLIND`
+
+This strategy hides some information from the user to facilitate an un-biased
+review of changes. Many scientific paper reviews are done this way.
+
+
diff --git a/src/main/resources/Documentation/build.md b/src/main/resources/Documentation/build.md
new file mode 100644
index 0000000..c00a9d0
--- /dev/null
+++ b/src/main/resources/Documentation/build.md
@@ -0,0 +1,82 @@
+Build
+=====
+
+This plugin can be built with Buck or Maven.
+
+Buck
+----
+
+Two build modes are supported: Standalone and in Gerrit tree.
+The standalone build mode is recommended, as this mode doesn't require
+the Gerrit tree to exist locally.
+
+
+
+Clone bucklets library:
+
+```
+ git clone https://gerrit.googlesource.com/bucklets
+
+```
+and link it to @PLUGIN@ plugin directory:
+
+```
+ cd @PLUGIN@ && ln -s ../bucklets .
+```
+
+Add link to the .buckversion file:
+
+```
+ cd @PLUGIN@ && ln -s bucklets/buckversion .buckversion
+```
+
+Add link to the .watchmanconfig file:
+```
+ cd @PLUGIN@ && ln -s bucklets/watchmanconfig .watchmanconfig
+```
+
+To build the plugin, issue the following command:
+
+
+```
+ buck build plugin
+```
+
+The output is created in
+
+```
+ buck-out/gen/@PLUGIN@.jar
+```
+
+
+Clone or link this plugin to the plugins directory of Gerrit's source
+tree, and issue the command:
+
+```
+ buck build plugins/@PLUGIN@
+```
+
+The output is created in
+
+```
+ buck-out/gen/plugins/@PLUGIN@/@PLUGIN@.jar
+```
+
+This project can be imported into the Eclipse IDE:
+
+```
+ ./tools/eclipse/project.py
+```
+
+Maven
+-----
+
+Note that the Maven build is provided for compatibility reasons, but
+it is considered to be deprecated and will be removed in a future
+version of this plugin.
+
+To build with Maven, run
+
+```
+mvn clean package
+```
diff --git a/src/main/resources/Documentation/images/preferences.png b/src/main/resources/Documentation/images/preferences.png
new file mode 100644
index 0000000..571ace9
--- /dev/null
+++ b/src/main/resources/Documentation/images/preferences.png
Binary files differ
diff --git a/src/main/resources/Documentation/images/strategy_blind.png b/src/main/resources/Documentation/images/strategy_blind.png
new file mode 100644
index 0000000..874c8eb
--- /dev/null
+++ b/src/main/resources/Documentation/images/strategy_blind.png
Binary files differ
diff --git a/src/main/resources/Documentation/rest-api-accounts.md b/src/main/resources/Documentation/rest-api-accounts.md
new file mode 100644
index 0000000..f293137
--- /dev/null
+++ b/src/main/resources/Documentation/rest-api-accounts.md
@@ -0,0 +1,79 @@
+@PLUGIN@ - /accounts/ REST API
+==============================
+
+This page describes the '/accounts/' REST endpoints that are added by
+the @PLUGIN@ plugin.
+
+Please also take note of the general information on the
+[REST API](../../../Documentation/rest-api.html).
+
+<a id="project-endpoints"> @PLUGIN@ Endpoints
+--------------------------------------------
+
+### <a id="get-preferences"> Get Preferences
+_GET /accounts/[\{account-id\}](../../../Documentation/rest-api-accounts.html#account-id)/@PLUGIN@~preferences_
+
+Gets the preferences of a user for the @PLUGIN@ plugin.
+
+#### Request
+
+```
+ GET /accounts/self/@PLUGIN@~preferences HTTP/1.0
+```
+
+As response a [PreferencesInfo](#preferences-info) entity is returned
+that contains the preferences of a user for the @PLUGIN@ plugin.
+
+#### Response
+
+```
+ HTTP/1.1 200 OK
+ Content-Disposition: attachment
+ Content-Type: application/json;charset=UTF-8
+
+ )]}'
+ {
+ "review_strategy": "BLIND"
+ }
+```
+
+### <a id="put-preferences"> Put Preferences
+_PUT /accounts/[\{account-id\}](../../../Documentation/rest-api-accounts.html#account-id)/@PLUGIN@~preferences_
+
+Sets the user preferences for the @PLUGIN@ plugin.
+
+The new preferences must be specified as a [PreferenceInfo](#preference-info)
+entity in the request body. Not setting a parameter means that the
+parameters are set to the defaults.
+
+#### Request
+
+```
+ PUT /accounts/self/@PLUGIN@~preferences HTTP/1.0
+ Content-Type: application/json;charset=UTF-8
+
+ {
+ "review_strategy": "BLIND"
+ }
+```
+
+
+<a id="json-entities">JSON Entities
+-----------------------------------
+
+### <a id="preferences-info"></a>PreferencesInfo
+
+The `PreferencesInfo` entity contains the preferences of the @PLUGIN@
+plugin.
+
+* _review_strategy_: The control that should be displayed on preferences screen
+ to change the review strategy. Possible values are `DEFAULT` and `BLIND`.
+
+SEE ALSO
+--------
+
+* [Account related REST endpoints](../../../Documentation/rest-api-accounts.html)
+
+GERRIT
+------
+Part of [Gerrit Code Review](../../../Documentation/index.html)
