Naming convention: count ‘protected’ and ‘protected internal’ members as public, since they are part of the public surface

Author: Timwi

.editorconfig

@@ -226,11 +226,11 @@ dotnet_naming_symbols.types.applicable_accessibilities = public, internal, priva
 dotnet_naming_symbols.types.required_modifiers =
 
 dotnet_naming_symbols.public_non_field_members.applicable_kinds = property, event, method
-dotnet_naming_symbols.public_non_field_members.applicable_accessibilities = public, internal
+dotnet_naming_symbols.public_non_field_members.applicable_accessibilities = public, internal, protected, protected_internal
 dotnet_naming_symbols.public_non_field_members.required_modifiers =
 
 dotnet_naming_symbols.private_non_field_members.applicable_kinds = property, event, method
-dotnet_naming_symbols.private_non_field_members.applicable_accessibilities = private, protected, protected_internal, private_protected
+dotnet_naming_symbols.private_non_field_members.applicable_accessibilities = private, private_protected
 dotnet_naming_symbols.private_non_field_members.required_modifiers =
 
 dotnet_naming_symbols.private_or_internal_field.applicable_kinds = field

Src/Authenticator.cs

@@ -53,7 +53,7 @@ public void CreateUser(string username, string password, bool canCreateUsers = f
         if (password == null)
             throw new ArgumentNullException("password");
 
-        if (!createUser(username, createHash(password), canCreateUsers))
+        if (!TryCreateUser(username, createHash(password), canCreateUsers))
             throw new InvalidOperationException("The specified user already exists.");
     }
 
@@ -71,7 +71,7 @@ public void CreateUser(string username, string password, bool canCreateUsers = f
     /// <remarks>
     ///     If the user does not exist, the overridden method must return <c>false</c> and not modify <paramref
     ///     name="username"/>.</remarks>
-    protected abstract bool getUser(ref string username, out string passwordHash, out bool canCreateUsers);
+    protected abstract bool GetUser(ref string username, out string passwordHash, out bool canCreateUsers);
 
     /// <summary>
     ///     When overridden in a derived class, attempts to change a user’s password.</summary>
@@ -85,7 +85,7 @@ public void CreateUser(string username, string password, bool canCreateUsers = f
     ///     <c>true</c> if the password was successfully changed; <c>false</c> if the specified user does not exist or
     ///     <paramref name="verifyOldPasswordHash"/> returned <c>false</c> indicating that the old password hash turned
     ///     out to be invalid.</returns>
-    protected abstract bool changePassword(string username, string newPasswordHash, Func<string, bool> verifyOldPasswordHash);
+    protected abstract bool ChangePassword(string username, string newPasswordHash, Func<string, bool> verifyOldPasswordHash);
 
     /// <summary>
     ///     When overridden in a derived class, creates a new user.</summary>
@@ -97,7 +97,7 @@ public void CreateUser(string username, string password, bool canCreateUsers = f
     ///     Specifies whether the new user has the right to create new users.</param>
     /// <returns>
     ///     <c>true</c> if a new user was created; <c>false</c> if <paramref name="username"/> is already taken.</returns>
-    protected abstract bool createUser(string username, string passwordHash, bool canCreateUsers);
+    protected abstract bool TryCreateUser(string username, string passwordHash, bool canCreateUsers);
 
     private HttpResponse logoutHandler(HttpRequest req, Action<string> setUsername)
     {
@@ -117,7 +117,7 @@ private HttpResponse loginHandler(HttpRequest req, Action<string> setUsername)
         if (username == null || password == null)
             return HttpResponse.Redirect(req.Url.WithQuery("returnto", returnTo));
 
-        if (getUser(ref username, out var passwordHash, out var canCreateUsers) && verifyHash(password, passwordHash))
+        if (GetUser(ref username, out var passwordHash, out var canCreateUsers) && verifyHash(password, passwordHash))
         {
             // Login successful!
             setUsername(username);
@@ -147,7 +147,7 @@ private HttpResponse changePasswordHandler(HttpRequest req, string loggedInUser)
         if (newpassword2 != newpassword)
             return changePasswordForm(loggedInUser, returnTo, false, true, oldpassword, newpassword, newpassword2, req.Url.WithoutQuery("returnto"));
 
-        if (!changePassword(loggedInUser, createHash(newpassword), h => verifyHash(oldpassword, h)))
+        if (!ChangePassword(loggedInUser, createHash(newpassword), h => verifyHash(oldpassword, h)))
             return changePasswordForm(loggedInUser, req.Url["returnto"], true, false, oldpassword, newpassword, newpassword2, req.Url.WithoutQuery("returnto"));
 
         return HttpResponse.Redirect(returnTo ?? _defaultReturnTo(req.Url));
@@ -167,14 +167,14 @@ private HttpResponse createUserHandler(HttpRequest req, string loggedInUserName)
             // if returnTo is null, this removes the query parameter
             return HttpResponse.Redirect(req.Url.WithQuery("returnto", returnTo));
 
-        if (!getUser(ref loggedInUserName, out var passwordHash, out var canCreateUsers) || !canCreateUsers)
+        if (!GetUser(ref loggedInUserName, out var passwordHash, out var canCreateUsers) || !canCreateUsers)
             throw new HttpException(HttpStatusCode._401_Unauthorized);
 
         if (newpassword2 != newpassword)
             // Passwords don’t match.
             return createUserForm(returnTo, false, true, username, newpassword, newpassword2, req.Url.WithoutQuery("returnto"));
 
-        if (!createUser(username, createHash(newpassword), false))
+        if (!TryCreateUser(username, createHash(newpassword), false))
             // The user already exists.
             return createUserForm(returnTo, true, false, username, newpassword, newpassword2, req.Url.WithoutQuery("returnto"));
 

Src/FileAuthenticator.cs

@@ -25,7 +25,7 @@ public sealed class FileAuthenticator(string usersFilePath, Func<IHttpUrl, strin
     private static object _lock = new();
 
     /// <summary>See base.</summary>
-    protected override bool getUser(ref string username, out string passwordHash, out bool canCreateUsers)
+    protected override bool GetUser(ref string username, out string passwordHash, out bool canCreateUsers)
     {
         passwordHash = null;
         canCreateUsers = false;
@@ -50,7 +50,7 @@ protected override bool getUser(ref string username, out string passwordHash, ou
     }
 
     /// <summary>See base.</summary>
-    protected override bool changePassword(string username, string newPasswordHash, Func<string, bool> verifyOldPasswordHash)
+    protected override bool ChangePassword(string username, string newPasswordHash, Func<string, bool> verifyOldPasswordHash)
     {
         lock (_lock)
         {
@@ -70,7 +70,7 @@ protected override bool changePassword(string username, string newPasswordHash,
     }
 
     /// <summary>See base.</summary>
-    protected override bool createUser(string username, string passwordHash, bool canCreateUsers)
+    protected override bool TryCreateUser(string username, string passwordHash, bool canCreateUsers)
     {
         lock (_lock)
         {

Src/HttpUrl.cs

@@ -662,10 +662,10 @@ public override void AppendQueryString(StringBuilder sb, bool first) { }
 internal abstract class UrlWithQueryRemovals(IHttpUrl source) : UrlWithNoChanges(source)
 {
     private string _queryString = null;
-    protected abstract string getValue(string name);
-    protected abstract IEnumerable<KeyValuePair<string, string>> getQuery();
-    public override IEnumerable<KeyValuePair<string, string>> Query => _source.HasQuery ? getQuery() : [];
-    public override string this[string name] => _source.HasQuery ? getValue(name) : null;
+    protected abstract string GetValue(string name);
+    protected abstract IEnumerable<KeyValuePair<string, string>> GetQuery();
+    public override IEnumerable<KeyValuePair<string, string>> Query => _source.HasQuery ? GetQuery() : [];
+    public override string this[string name] => _source.HasQuery ? GetValue(name) : null;
     public override string QueryString => _source.HasQuery ? (_queryString ??= HttpHelper.MakeQueryString(null, Query)) : "";
     public override bool HasQuery => _source.HasQuery && QueryString.Length > 0;
     public override void AppendQueryString(StringBuilder sb, bool first)
@@ -685,16 +685,16 @@ internal class UrlWithoutQueryMultiple(IHttpUrl source, HashSet<string> names) :
 
     public UrlWithoutQueryMultiple(IHttpUrl source, IEnumerable<string> names) : this(source, [.. names]) { }
 
-    protected override string getValue(string name) => _names.Contains(name) ? null : _source[name];
-    protected override IEnumerable<KeyValuePair<string, string>> getQuery() => _source.Query.Where(kvp => !_names.Contains(kvp.Key));
+    protected override string GetValue(string name) => _names.Contains(name) ? null : _source[name];
+    protected override IEnumerable<KeyValuePair<string, string>> GetQuery() => _source.Query.Where(kvp => !_names.Contains(kvp.Key));
     public override IEnumerable<string> QueryValues(string name) => _names.Contains(name) ? [] : _source.QueryValues(name);
 }
 
 internal class UrlWithQueryWhere(IHttpUrl source, Func<string, bool> nameFilter) : UrlWithQueryRemovals(source)
 {
     private readonly Func<string, bool> _nameFilter = nameFilter ?? throw new ArgumentException();
-    protected override string getValue(string name) => _nameFilter(name) ? _source[name] : null;
-    protected override IEnumerable<KeyValuePair<string, string>> getQuery() => _source.Query.Where(kvp => _nameFilter(kvp.Key));
+    protected override string GetValue(string name) => _nameFilter(name) ? _source[name] : null;
+    protected override IEnumerable<KeyValuePair<string, string>> GetQuery() => _source.Query.Where(kvp => _nameFilter(kvp.Key));
 
     public override IEnumerable<string> QueryValues(string name)
     {
@@ -709,15 +709,15 @@ internal class UrlWithQueryWhereValues(IHttpUrl source, Func<string, string, boo
 {
     private readonly Func<string, string, bool> _nameValueFilter = nameValueFilter ?? throw new ArgumentException();
 
-    protected override string getValue(string name)
+    protected override string GetValue(string name)
     {
-        foreach (var kvp in getQuery())
+        foreach (var kvp in GetQuery())
             if (kvp.Key == name && _nameValueFilter(kvp.Key, kvp.Value))
                 return kvp.Value;
         return null;
     }
 
-    protected override IEnumerable<KeyValuePair<string, string>> getQuery()
+    protected override IEnumerable<KeyValuePair<string, string>> GetQuery()
     {
         return _source.Query.Where(kvp => _nameValueFilter(kvp.Key, kvp.Value));
     }