From 005a2a83fc7510f36dd1c4b7868c3332770d69cb Mon Sep 17 00:00:00 2001 From: Devesh Khandelwal Date: Thu, 17 Mar 2016 17:39:29 +0530 Subject: [PATCH] Refactor: Change method names to follow Octokit's conventions. --- .../IObservableEnterpriseMigrationsClient.cs | 6 ++++-- .../ObservableEnterpriseMigrationsClient.cs | 8 ++++---- .../Enterprise/EnterpriseMigrationClientTests.cs | 12 ++++++------ .../ObservableEnterpriseMigrationsClientTests.cs | 8 ++++---- .../Clients/Enterprise/EnterpriseMigrationsClient.cs | 4 ++-- .../Enterprise/IEnterpriseMigrationsClient.cs | 6 ++++-- 6 files changed, 24 insertions(+), 20 deletions(-) diff --git a/Octokit.Reactive/Clients/Enterprise/IObservableEnterpriseMigrationsClient.cs b/Octokit.Reactive/Clients/Enterprise/IObservableEnterpriseMigrationsClient.cs index d23c1c46..5037c312 100644 --- a/Octokit.Reactive/Clients/Enterprise/IObservableEnterpriseMigrationsClient.cs +++ b/Octokit.Reactive/Clients/Enterprise/IObservableEnterpriseMigrationsClient.cs @@ -1,5 +1,6 @@ using System; using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; using System.Reactive; namespace Octokit.Reactive @@ -35,7 +36,7 @@ namespace Octokit.Reactive /// /// The organization of which to list migrations. /// List of most recent s. - IObservable> GetMigrations( + IObservable> GetAll( string org); /// @@ -47,7 +48,8 @@ namespace Octokit.Reactive /// The organization which is migrating. /// Migration ID of the organization. /// A object representing the state of migration. - IObservable GetStatus( + [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")] + IObservable Get( string org, int id); diff --git a/Octokit.Reactive/Clients/Enterprise/ObservableEnterpriseMigrationsClient.cs b/Octokit.Reactive/Clients/Enterprise/ObservableEnterpriseMigrationsClient.cs index 927ab4f4..8c49932a 100644 --- a/Octokit.Reactive/Clients/Enterprise/ObservableEnterpriseMigrationsClient.cs +++ b/Octokit.Reactive/Clients/Enterprise/ObservableEnterpriseMigrationsClient.cs @@ -50,9 +50,9 @@ namespace Octokit.Reactive /// /// The organization of which to list migrations. /// List of most recent s. - public IObservable> GetMigrations(string org) + public IObservable> GetAll(string org) { - return _client.GetMigrations(org).ToObservable(); + return _client.GetAll(org).ToObservable(); } /// @@ -64,9 +64,9 @@ namespace Octokit.Reactive /// The organization which is migrating. /// Migration ID of the organization. /// A object representing the state of migration. - public IObservable GetStatus(string org, int id) + public IObservable Get(string org, int id) { - return _client.GetStatus(org, id).ToObservable(); + return _client.Get(org, id).ToObservable(); } /// diff --git a/Octokit.Tests/Clients/Enterprise/EnterpriseMigrationClientTests.cs b/Octokit.Tests/Clients/Enterprise/EnterpriseMigrationClientTests.cs index 31916320..ca262c99 100644 --- a/Octokit.Tests/Clients/Enterprise/EnterpriseMigrationClientTests.cs +++ b/Octokit.Tests/Clients/Enterprise/EnterpriseMigrationClientTests.cs @@ -16,7 +16,7 @@ namespace Octokit.Tests.Clients var connection = Substitute.For(); var client = new EnterpriseMigrationsClient(connection); - client.GetStatus("fake", 69); + client.Get("fake", 69); connection.Received().Get( Arg.Is(u => u.ToString() == "orgs/fake/migrations/69")); @@ -28,8 +28,8 @@ namespace Octokit.Tests.Clients var connection = Substitute.For(); var client = new EnterpriseMigrationsClient(connection); - await Assert.ThrowsAsync(() => client.GetStatus(null, 69)); - await Assert.ThrowsAsync(() => client.GetStatus("", 69)); + await Assert.ThrowsAsync(() => client.Get(null, 69)); + await Assert.ThrowsAsync(() => client.Get("", 69)); } } @@ -41,7 +41,7 @@ namespace Octokit.Tests.Clients var connection = Substitute.For(); var client = new EnterpriseMigrationsClient(connection); - client.GetMigrations("fake"); + client.GetAll("fake"); connection.Received().Get>( Arg.Is(u => u.ToString() == "orgs/fake/migrations")); @@ -53,8 +53,8 @@ namespace Octokit.Tests.Clients var connection = Substitute.For(); var client = new EnterpriseMigrationsClient(connection); - await Assert.ThrowsAsync(() => client.GetMigrations(null)); - await Assert.ThrowsAsync(() => client.GetMigrations("")); + await Assert.ThrowsAsync(() => client.GetAll(null)); + await Assert.ThrowsAsync(() => client.GetAll("")); } } diff --git a/Octokit.Tests/Reactive/Enterprise/ObservableEnterpriseMigrationsClientTests.cs b/Octokit.Tests/Reactive/Enterprise/ObservableEnterpriseMigrationsClientTests.cs index c81d9e0d..b3ece2a8 100644 --- a/Octokit.Tests/Reactive/Enterprise/ObservableEnterpriseMigrationsClientTests.cs +++ b/Octokit.Tests/Reactive/Enterprise/ObservableEnterpriseMigrationsClientTests.cs @@ -33,8 +33,8 @@ namespace Octokit.Tests var github = Substitute.For(); var client = new ObservableEnterpriseMigrationsClient(github); - client.GetMigrations("fake"); - github.Enterprise.Migration.Received(1).GetMigrations("fake"); + client.GetAll("fake"); + github.Enterprise.Migration.Received(1).GetAll("fake"); } } @@ -46,8 +46,8 @@ namespace Octokit.Tests var github = Substitute.For(); var client = new ObservableEnterpriseMigrationsClient(github); - client.GetStatus("fake", 69); - github.Enterprise.Migration.Received(1).GetStatus("fake", 69); + client.Get("fake", 69); + github.Enterprise.Migration.Received(1).Get("fake", 69); } } diff --git a/Octokit/Clients/Enterprise/EnterpriseMigrationsClient.cs b/Octokit/Clients/Enterprise/EnterpriseMigrationsClient.cs index 946c65a3..df66a23a 100644 --- a/Octokit/Clients/Enterprise/EnterpriseMigrationsClient.cs +++ b/Octokit/Clients/Enterprise/EnterpriseMigrationsClient.cs @@ -47,7 +47,7 @@ namespace Octokit /// /// The organization of which to list migrations. /// List of most recent s. - public async Task> GetMigrations(string org) + public async Task> GetAll(string org) { Ensure.ArgumentNotNullOrEmptyString(org, "org"); @@ -65,7 +65,7 @@ namespace Octokit /// The organization which is migrating. /// Migration ID of the organization. /// A object representing the state of migration. - public async Task GetStatus(string org, int id) + public async Task Get(string org, int id) { Ensure.ArgumentNotNullOrEmptyString(org, "org"); diff --git a/Octokit/Clients/Enterprise/IEnterpriseMigrationsClient.cs b/Octokit/Clients/Enterprise/IEnterpriseMigrationsClient.cs index 1169a002..640f2876 100644 --- a/Octokit/Clients/Enterprise/IEnterpriseMigrationsClient.cs +++ b/Octokit/Clients/Enterprise/IEnterpriseMigrationsClient.cs @@ -1,4 +1,5 @@ using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; using System.Threading.Tasks; namespace Octokit @@ -34,7 +35,7 @@ namespace Octokit /// /// The organization of which to list migrations. /// List of most recent s. - Task> GetMigrations( + Task> GetAll( string org); /// @@ -46,7 +47,8 @@ namespace Octokit /// The organization which is migrating. /// Migration ID of the organization. /// A object representing the state of migration. - Task GetStatus( + [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")] + Task Get( string org, int id);