opendev/gerrit
Code Issues Proposed changes

DashboardsCollection: Split DashboardInfo out to extension API

Browse Source 
Split the DashboardInfo static class out to its own file in the
extension API. Also split out the Section static class, but rename
it to DashboardSectionInfo.

Splitting these classes out is a preparatory step towards adding
a new dashboard API in the extension API.

Change-Id: Id819555521274b4b4bc4b8566915fb50217d508e
This commit is contained in:
David Pursehouse
2017-09-14 21:55:08 +09:00
parent 8edc19969a
commit 017781e534
8 changed files with 70 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
gerrit-extension-api/src/main/java/com/google/gerrit/extensions/api/projects/DashboardInfo.java Normal file
View File

@@ -0,0 +1,42 @@
// Copyright (C) 2017 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.google.gerrit.extensions.api.projects;
import com.google.common.base.Joiner;
import com.google.gerrit.extensions.restapi.Url;
import java.util.ArrayList;
import java.util.List;
public class DashboardInfo {
public String id;
public String project;
public String definingProject;
public String ref;
public String path;
public String description;
public String foreach;
public String url;
public Boolean isDefault;
public String title;
public List<DashboardSectionInfo> sections = new ArrayList<>();
public DashboardInfo(String ref, String name) {
this.ref = ref;
this.path = name;
this.id = Joiner.on(':').join(Url.encode(ref), Url.encode(path));
}
}

20
gerrit-extension-api/src/main/java/com/google/gerrit/extensions/api/projects/DashboardSectionInfo.java Normal file
View File

@@ -0,0 +1,20 @@
// Copyright (C) 2017 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.google.gerrit.extensions.api.projects;
public class DashboardSectionInfo {
public String name;
public String query;
}

34
gerrit-server/src/main/java/com/google/gerrit/server/project/DashboardsCollection.java
View File

@@ -16,12 +16,13 @@ package com.google.gerrit.server.project;
import static com.google.gerrit.reviewdb.client.RefNames.REFS_DASHBOARDS;
import com.google.common.base.Joiner;
import com.google.common.base.MoreObjects;
import com.google.common.base.Splitter;
import com.google.common.base.Strings;
import com.google.common.collect.Lists;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.extensions.api.projects.DashboardInfo;
import com.google.gerrit.extensions.api.projects.DashboardSectionInfo;
import com.google.gerrit.extensions.registration.DynamicMap;
import com.google.gerrit.extensions.restapi.AcceptsCreate;
import com.google.gerrit.extensions.restapi.AuthException;
@@ -31,7 +32,6 @@ import com.google.gerrit.extensions.restapi.ResourceNotFoundException;
import com.google.gerrit.extensions.restapi.RestApiException;
import com.google.gerrit.extensions.restapi.RestModifyView;
import com.google.gerrit.extensions.restapi.RestView;
import com.google.gerrit.extensions.restapi.Url;
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.UrlEncoded;
@@ -43,7 +43,6 @@ import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.jgit.errors.AmbiguousObjectException;
import org.eclipse.jgit.errors.ConfigInvalidException;
@@ -194,7 +193,7 @@ class DashboardsCollection
u.put("foreach", replace(project, info.foreach));
}
for (String name : config.getSubsections("section")) {
Section s = new Section();
DashboardSectionInfo s = new DashboardSectionInfo();
s.name = name;
s.query = config.getString("section", name, "query");
u.put(s.name, replace(project, s.query));
@@ -218,31 +217,4 @@ class DashboardsCollection
}
return defaultId;
}
static class DashboardInfo {
String id;
String project;
String definingProject;
String ref;
String path;
String description;
String foreach;
String url;
Boolean isDefault;
String title;
List<Section> sections = new ArrayList<>();
DashboardInfo(String ref, String name) {
this.ref = ref;
this.path = name;
this.id = Joiner.on(':').join(Url.encode(ref), Url.encode(path));
}
}
static class Section {
String name;
String query;
}
}

2
gerrit-server/src/main/java/com/google/gerrit/server/project/DeleteDashboard.java
View File

@@ -14,6 +14,7 @@
package com.google.gerrit.server.project;
import com.google.gerrit.extensions.api.projects.DashboardInfo;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.BadRequestException;
import com.google.gerrit.extensions.restapi.MethodNotAllowedException;
@@ -22,7 +23,6 @@ import com.google.gerrit.extensions.restapi.ResourceNotFoundException;
import com.google.gerrit.extensions.restapi.Response;
import com.google.gerrit.extensions.restapi.RestModifyView;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.project.DashboardsCollection.DashboardInfo;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;

2
gerrit-server/src/main/java/com/google/gerrit/server/project/GetDashboard.java
View File

@@ -20,13 +20,13 @@ import static com.google.gerrit.server.project.DashboardsCollection.isDefaultDas
import com.google.common.base.Splitter;
import com.google.common.base.Strings;
import com.google.common.collect.Lists;
import com.google.gerrit.extensions.api.projects.DashboardInfo;
import com.google.gerrit.extensions.restapi.IdString;
import com.google.gerrit.extensions.restapi.ResourceConflictException;
import com.google.gerrit.extensions.restapi.ResourceNotFoundException;
import com.google.gerrit.extensions.restapi.RestReadView;
import com.google.gerrit.extensions.restapi.Url;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.project.DashboardsCollection.DashboardInfo;
import com.google.inject.Inject;
import java.io.IOException;
import java.util.List;

2
gerrit-server/src/main/java/com/google/gerrit/server/project/ListDashboards.java
View File

@@ -16,6 +16,7 @@ package com.google.gerrit.server.project;
import static com.google.gerrit.reviewdb.client.RefNames.REFS_DASHBOARDS;
import com.google.gerrit.extensions.api.projects.DashboardInfo;
import com.google.gerrit.extensions.restapi.ResourceNotFoundException;
import com.google.gerrit.extensions.restapi.RestReadView;
import com.google.gerrit.reviewdb.client.Project;
@@ -25,7 +26,6 @@ import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.permissions.ProjectPermission;
import com.google.gerrit.server.permissions.RefPermission;
import com.google.gerrit.server.project.DashboardsCollection.DashboardInfo;
import com.google.inject.Inject;
import com.google.inject.Provider;
import java.io.IOException;

2
gerrit-server/src/main/java/com/google/gerrit/server/project/SetDashboard.java
View File

@@ -14,6 +14,7 @@
package com.google.gerrit.server.project;
import com.google.gerrit.extensions.api.projects.DashboardInfo;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.BadRequestException;
import com.google.gerrit.extensions.restapi.DefaultInput;
@@ -23,7 +24,6 @@ import com.google.gerrit.extensions.restapi.ResourceNotFoundException;
import com.google.gerrit.extensions.restapi.Response;
import com.google.gerrit.extensions.restapi.RestModifyView;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.project.DashboardsCollection.DashboardInfo;
import com.google.gerrit.server.project.SetDashboard.Input;
import com.google.inject.Inject;
import com.google.inject.Provider;

2
gerrit-server/src/main/java/com/google/gerrit/server/project/SetDefaultDashboard.java
View File

@@ -16,6 +16,7 @@ package com.google.gerrit.server.project;
import com.google.common.base.MoreObjects;
import com.google.common.base.Strings;
import com.google.gerrit.extensions.api.projects.DashboardInfo;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.BadRequestException;
import com.google.gerrit.extensions.restapi.IdString;
@@ -27,7 +28,6 @@ import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.server.git.MetaDataUpdate;
import com.google.gerrit.server.git.ProjectConfig;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.project.DashboardsCollection.DashboardInfo;
import com.google.gerrit.server.project.SetDashboard.Input;
import com.google.inject.Inject;
import com.google.inject.Provider;