Use "ExcludeArchivedRepositories"

More descriptive that "ExcludeArchived".

Author: Nick Griffiths

…_branch_source/ExcludeArchivedTrait.java …ce/ExcludeArchivedRepositoriesTrait.javasrc/main/java/org/jenkinsci/plugins/github_branch_source/ExcludeArchivedTrait.java renamed to src/main/java/org/jenkinsci/plugins/github_branch_source/ExcludeArchivedRepositoriesTrait.java src/main/java/org/jenkinsci/plugins/github_branch_source/ExcludeArchivedTrait.java renamed to src/main/java/org/jenkinsci/plugins/github_branch_source/ExcludeArchivedRepositoriesTrait.java

@@ -13,13 +13,13 @@
 /**
  * A {@link Selection} trait that will restrict the discovery of repositories that have been archived.
  */
-public class ExcludeArchivedTrait extends SCMNavigatorTrait {
+public class ExcludeArchivedRepositoriesTrait extends SCMNavigatorTrait {
 
     /**
      * Constructor for stapler.
      */
     @DataBoundConstructor
-    public ExcludeArchivedTrait() {
+    public ExcludeArchivedRepositoriesTrait() {
     }
 
     /**
@@ -29,13 +29,13 @@ public ExcludeArchivedTrait() {
     protected void decorateContext(SCMNavigatorContext<?, ?> context) {
         super.decorateContext(context);
         GitHubSCMNavigatorContext ctx = (GitHubSCMNavigatorContext) context;
-        ctx.setExcludeArchived(true);
+        ctx.setExcludeArchivedRepositories(true);
     }
 
     /**
-     * Excluded archived repositories filter
+     * Exclude archived repositories filter
      */
-    @Symbol("archivedRepositoriesFilter")
+    @Symbol("gitHubExcludeArchivedRepositories")
     @Extension
     @Selection
     public static class DescriptorImpl extends SCMNavigatorTraitDescriptor {
@@ -48,7 +48,7 @@ public Class<? extends SCMNavigatorContext> getContextClass() {
         @Nonnull
         @Override
         public String getDisplayName() {
-            return Messages.ExcludeArchivedTrait_displayName();
+            return Messages.ExcludeArchivedRepositoriesTrait_displayName();
         }
     }
 }

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMNavigator.java

@@ -952,7 +952,7 @@ public void visitSources(SCMSourceObserver observer) throws IOException, Interru
                                 continue; // ignore repos in other orgs when using GHMyself
                             }
 
-                            if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchived()) {
+                            if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchivedRepositories()) {
                                 witness.record(repo.getName(), false);
                                 listener.getLogger()
                                         .println(GitHubConsoleNote.create(System.currentTimeMillis(), String.format(
@@ -987,7 +987,7 @@ public void visitSources(SCMSourceObserver observer) throws IOException, Interru
                     for (GHRepository repo : repositories) {
                         Connector.checkApiRateLimit(listener, github);
 
-                        if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchived()) {
+                        if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchivedRepositories()) {
                             witness.record(repo.getName(), false);
                             listener.getLogger()
                                     .println(GitHubConsoleNote.create(System.currentTimeMillis(), String.format(
@@ -1018,7 +1018,7 @@ public void visitSources(SCMSourceObserver observer) throws IOException, Interru
                     for (GHRepository repo : user.listRepositories(100)) {
                         Connector.checkApiRateLimit(listener, github);
 
-                        if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchived()) {
+                        if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchivedRepositories()) {
                             witness.record(repo.getName(), false);
                             listener.getLogger()
                                     .println(GitHubConsoleNote.create(System.currentTimeMillis(), String.format(
@@ -1116,7 +1116,7 @@ public void visitSource(String sourceName, SCMSourceObserver observer)
                         GHRepository repo = myself.getRepository(sourceName);
                         if (repo != null && repo.getOwnerName().equals(repoOwner)) {
 
-                            if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchived()) {
+                            if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchivedRepositories()) {
                                 witness.record(repo.getName(), false);
                                 listener.getLogger()
                                         .println(GitHubConsoleNote.create(System.currentTimeMillis(), String.format(
@@ -1146,7 +1146,7 @@ public void visitSource(String sourceName, SCMSourceObserver observer)
                     GHRepository repo = org.getRepository(sourceName);
                     if (repo != null) {
 
-                        if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchived()) {
+                        if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchivedRepositories()) {
                             witness.record(repo.getName(), false);
                             listener.getLogger()
                                     .println(GitHubConsoleNote.create(System.currentTimeMillis(), String.format(
@@ -1178,7 +1178,7 @@ public void visitSource(String sourceName, SCMSourceObserver observer)
                     GHRepository repo = user.getRepository(sourceName);
                     if (repo != null) {
 
-                        if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchived()) {
+                        if (repo.isArchived() && gitHubSCMNavigatorContext.isExcludeArchivedRepositories()) {
                             witness.record(repo.getName(), false);
                             listener.getLogger()
                                     .println(GitHubConsoleNote.create(System.currentTimeMillis(), String.format(

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMNavigatorContext.java

@@ -43,7 +43,7 @@ public class GitHubSCMNavigatorContext extends SCMNavigatorContext<GitHubSCMNavi
     /**
      * If true, archived repositories will be ignored.
      */
-    private boolean excludeArchived;
+    private boolean excludeArchivedRepositories;
 
     /**
      * {@inheritDoc}
@@ -72,14 +72,14 @@ public String getTeamSlug() {
     /**
      * @return True if archived repositories should be ignored, false if they should be included.
      */
-    public boolean isExcludeArchived() {
-        return excludeArchived;
+    public boolean isExcludeArchivedRepositories() {
+        return excludeArchivedRepositories;
     }
 
     /**
-     * @param excludeArchived Set true to exclude archived repositories
+     * @param excludeArchivedRepositories Set true to exclude archived repositories
      */
-    public void setExcludeArchived(boolean excludeArchived) {
-        this.excludeArchived = excludeArchived;
+    public void setExcludeArchivedRepositories(boolean excludeArchivedRepositories) {
+        this.excludeArchivedRepositories = excludeArchivedRepositories;
     }
 }

src/main/resources/org/jenkinsci/plugins/github_branch_source/Messages.properties

@@ -62,7 +62,7 @@ SSHCheckoutTrait.missingCredentials=The currently configured credentials cannot
 SSHCheckoutTrait.useAgentKey=- use build agent''s key -
 TagDiscoveryTrait.authorityDisplayName=Trust origin tags
 TagDiscoveryTrait.displayName=Discover tags
-ExcludeArchivedTrait.displayName=Exclude archived repositories
+ExcludeArchivedRepositoriesTrait.displayName=Exclude archived repositories
 
 GitHubSCMNavigator.general=General
 GitHubSCMNavigator.withinRepository=Within repository

src/test/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMNavigatorTest.java

@@ -211,7 +211,7 @@ public void fetchOneRepo_BelongingToAuthenticatedUser() throws Exception {
     public void fetchOneRepo_BelongingToAuthenticatedUser_ExcludingArchived() throws Exception {
         setCredentials(Collections.singletonList(credentials));
         navigator = navigatorForRepoOwner("stephenc", credentials.getId());
-        navigator.setTraits(Collections.singletonList(new ExcludeArchivedTrait()));
+        navigator.setTraits(Collections.singletonList(new ExcludeArchivedRepositoriesTrait()));
         final Set<String> projectNames = new HashSet<>();
         final SCMSourceObserver observer = getObserver(projectNames);
 
@@ -232,7 +232,7 @@ public void fetchOneRepo_BelongingToOrg() throws Exception {
 
     @Test
     public void fetchOneRepo_BelongingToOrg_ExcludingArchived() throws Exception {
-        navigator.setTraits(Collections.singletonList(new ExcludeArchivedTrait()));
+        navigator.setTraits(Collections.singletonList(new ExcludeArchivedRepositoriesTrait()));
         final Set<String> projectNames = new HashSet<>();
         final SCMSourceObserver observer = getObserver(projectNames);
 
@@ -255,7 +255,7 @@ public void fetchOneRepo_BelongingToUser() throws Exception {
     @Test
     public void fetchOneRepo_BelongingToUser_ExcludingArchived() throws Exception {
         navigator = navigatorForRepoOwner("stephenc", null);
-        navigator.setTraits(Collections.singletonList(new ExcludeArchivedTrait()));
+        navigator.setTraits(Collections.singletonList(new ExcludeArchivedRepositoriesTrait()));
         final Set<String> projectNames = new HashSet<>();
         final SCMSourceObserver observer = getObserver(projectNames);
 
@@ -280,7 +280,7 @@ public void fetchRepos_BelongingToAuthenticatedUser() throws Exception {
     public void fetchRepos_BelongingToAuthenticatedUser_ExcludingArchived() throws Exception {
         setCredentials(Collections.singletonList(credentials));
         navigator = navigatorForRepoOwner("stephenc", credentials.getId());
-        navigator.setTraits(Collections.singletonList(new ExcludeArchivedTrait()));
+        navigator.setTraits(Collections.singletonList(new ExcludeArchivedRepositoriesTrait()));
         final Set<String> projectNames = new HashSet<>();
         final SCMSourceObserver observer = getObserver(projectNames);
 
@@ -302,7 +302,7 @@ public void fetchRepos_BelongingToOrg() throws Exception {
 
     @Test
     public void fetchRepos_BelongingToOrg_ExcludingArchived() throws Exception {
-        navigator.setTraits(Collections.singletonList(new ExcludeArchivedTrait()));
+        navigator.setTraits(Collections.singletonList(new ExcludeArchivedRepositoriesTrait()));
         final Set<String> projectNames = new HashSet<>();
         final SCMSourceObserver observer = getObserver(projectNames);
 
@@ -326,7 +326,7 @@ public void fetchRepos_BelongingToUser() throws Exception {
     @Test
     public void fetchRepos_BelongingToUser_ExcludingArchived() throws Exception {
         navigator = navigatorForRepoOwner("stephenc", null);
-        navigator.setTraits(Collections.singletonList(new ExcludeArchivedTrait()));
+        navigator.setTraits(Collections.singletonList(new ExcludeArchivedRepositoriesTrait()));
         final Set<String> projectNames = new HashSet<>();
         final SCMSourceObserver observer = getObserver(projectNames);