refactor: Remove obsolete APIs

BREAKING CHANGE: Remove obsolete APIs Signed-off-by: Sagilio <[email protected]>
casbin · Jun 16, 2021 · 4049675 · 4049675
1 parent a4ab7a3
commit 4049675
Show file tree

Hide file tree

Showing 13 changed files with 44 additions and 183 deletions.
diff --git a/NetCasbin.UnitTest/Mock/MockRoleManager.cs b/NetCasbin.UnitTest/Mock/MockRoleManager.cs
@@ -12,14 +12,14 @@ public class MockCustomRoleManager : IRoleManager
         public bool HasPattern => false;
         public bool HasDomainPattern => false;
 
-        public List<string> GetRoles(string name, params string[] domain) => null;
-        public List<string> GetUsers(string name, params string[] domain) => null;
+        public IEnumerable<string> GetRoles(string name, string domain = null) => null;
+        public IEnumerable<string> GetUsers(string name, string domain = null) => null;
         public IEnumerable<string> GetDomains(string name)
         {
             return Enumerable.Empty<string>();
         }
 
-        public bool HasLink(string name1, string name2, params string[] domain)
+        public bool HasLink(string name1, string name2, string domain = null)
         {
             if (name1.Equals("alice") && name2.Equals("alice"))
             {
@@ -39,11 +39,11 @@ public bool HasLink(string name1, string name2, params string[] domain)
             return false;
         }
 
-        public void AddLink(string name1, string name2, params string[] domain)
+        public void AddLink(string name1, string name2, string domain = null)
         {
         }
 
-        public void DeleteLink(string name1, string name2, params string[] domain)
+        public void DeleteLink(string name1, string name2, string domain = null)
         {
         }
 

diff --git a/NetCasbin.UnitTest/Util/TestUtil.cs b/NetCasbin.UnitTest/Util/TestUtil.cs
@@ -116,14 +116,14 @@ internal static void TestHasGroupingPolicy(IEnforcer e, List<string> policy, boo
 
         internal static void TestGetRoles(IEnforcer e, string name, List<string> res, string domain = null)
         {
-            List<string> myRes = e.GetRolesForUser(name, domain);
+            List<string> myRes = e.GetRolesForUser(name, domain).ToList();
             string message = "Roles for " + name + ": " + myRes + ", supposed to be " + res;
             Assert.True(Utility.SetEquals(res, myRes), message);
         }
 
         internal static void TestGetUsers(IEnforcer e, string name, List<string> res, string domain = null)
         {
-            List<string> myRes = e.GetUsersForRole(name, domain);
+            List<string> myRes = e.GetUsersForRole(name, domain).ToList();
             string message = "Users for " + name + ": " + myRes + ", supposed to be " + res;
             Assert.True(Utility.SetEquals(res, myRes), message);
         }
@@ -156,7 +156,7 @@ internal static void TestHasPermission(IEnforcer e, string name, List<string> pe
 
         internal static void TestGetRolesInDomain(IEnforcer e, string name, string domain, List<string> res)
         {
-            List<string> myRes = e.GetRolesForUserInDomain(name, domain);
+            List<string> myRes = e.GetRolesForUserInDomain(name, domain).ToList();
             string message = "Roles for " + name + " under " + domain + ": " + myRes + ", supposed to be " + res;
             Assert.True(Utility.SetEquals(res, myRes), message);
         }
@@ -197,14 +197,14 @@ internal static void TestDomainRole(IRoleManager roleManager, string name1, stri
 
         internal static void TestGetRoles(IRoleManager roleManager, string name, List<string> expectResult)
         {
-            List<string> result = roleManager.GetRoles(name);
+            List<string> result = roleManager.GetRoles(name).ToList();
             string message = $"{name}: {result}, supposed to be {expectResult}";
             Assert.True(Utility.SetEquals(expectResult, result), message);
         }
 
         internal static void TestGetRolesWithDomain(IRoleManager roleManager, string name, string domain, List<string> expectResult)
         {
-            List<string> result = roleManager.GetRoles(name, domain);
+            List<string> result = roleManager.GetRoles(name, domain).ToList();
             string message = $"{name}: {result}, supposed to be {expectResult}";
             Assert.True(Utility.SetEquals(expectResult, result), message);
         }

diff --git a/NetCasbin/Abstractions/IPolicy.cs b/NetCasbin/Abstractions/IPolicy.cs
@@ -1,6 +1,5 @@
 using System.Collections.Generic;
 using Casbin.Model;
-using Casbin.Rbac;
 
 namespace Casbin
 {
@@ -11,30 +10,27 @@ public interface IPolicy
         /// <summary>
         /// Provides incremental build the role inheritance relation.
         /// </summary>
-        /// <param name="roleManager"></param>
         /// <param name="policyOperation"></param>
         /// <param name="section"></param>
         /// <param name="policyType"></param>
         /// <param name="rule"></param>
-        public void BuildIncrementalRoleLink(IRoleManager roleManager, PolicyOperation policyOperation,
+        public void BuildIncrementalRoleLink(PolicyOperation policyOperation,
             string section, string policyType, IEnumerable<string> rule);
 
         /// <summary>
         /// Provides incremental build the role inheritance relations.
         /// </summary>
-        /// <param name="roleManager"></param>
         /// <param name="policyOperation"></param>
         /// <param name="section"></param>
         /// <param name="policyType"></param>
         /// <param name="rules"></param>
-        public void BuildIncrementalRoleLinks(IRoleManager roleManager, PolicyOperation policyOperation,
+        public void BuildIncrementalRoleLinks(PolicyOperation policyOperation,
             string section, string policyType, IEnumerable<IEnumerable<string>> rules);
 
         /// <summary>
         /// Initializes the roles in RBAC.
         /// </summary>
-        /// <param name="roleManager"></param>
-        public void BuildRoleLinks(IRoleManager roleManager);
+        public void BuildRoleLinks();
 
         public void RefreshPolicyStringSet();
 

diff --git a/NetCasbin/Extensions/Enforcer/EnforcerExtension.cs b/NetCasbin/Extensions/Enforcer/EnforcerExtension.cs
@@ -358,7 +358,7 @@ public static void LoadModel(this IEnforcer enforcer)
         public static void BuildRoleLinks(this IEnforcer enforcer)
         {
             enforcer.RoleManager.Clear();
-            enforcer.Model.BuildRoleLinks(enforcer.RoleManager);
+            enforcer.Model.BuildRoleLinks();
         }
 
         public static Enforcer AddMatchingFunc(this Enforcer enforcer, Func<string, string, bool> func)

diff --git a/NetCasbin/Extensions/Enforcer/InternalEnforcerExtension.cs b/NetCasbin/Extensions/Enforcer/InternalEnforcerExtension.cs
@@ -309,7 +309,7 @@ private static void OnPolicyChanged(IEnforcer enforcer, PolicyOperation policyOp
         {
             if (section.Equals(PermConstants.Section.RoleSection))
             {
-                enforcer.PolicyManager.Policy.BuildIncrementalRoleLink(enforcer.RoleManager, policyOperation,
+                enforcer.PolicyManager.Policy.BuildIncrementalRoleLink(policyOperation,
                     section, policyType, rule);
                 enforcer.ExpressionHandler.SetGFunctions();
             }
@@ -322,7 +322,7 @@ private static async Task OnPolicyAsyncChanged(IEnforcer enforcer, PolicyOperati
         {
             if (section.Equals(PermConstants.Section.RoleSection))
             {
-                enforcer.PolicyManager.Policy.BuildIncrementalRoleLink(enforcer.RoleManager, policyOperation,
+                enforcer.PolicyManager.Policy.BuildIncrementalRoleLink(policyOperation,
                     section, policyType, rule);
                 enforcer.ExpressionHandler.SetGFunctions();
             }
@@ -334,7 +334,7 @@ private static void OnPoliciesChanged(IEnforcer enforcer, PolicyOperation policy
         {
             if (section.Equals(PermConstants.Section.RoleSection))
             {
-                enforcer.PolicyManager.Policy.BuildIncrementalRoleLinks(enforcer.RoleManager, policyOperation,
+                enforcer.PolicyManager.Policy.BuildIncrementalRoleLinks(policyOperation,
                     section, policyType, rules);
                 enforcer.ExpressionHandler.SetGFunctions();
             }
@@ -346,7 +346,7 @@ private static async Task OnPoliciesAsyncChanged(IEnforcer enforcer, PolicyOpera
         {
             if (section.Equals(PermConstants.Section.RoleSection))
             {
-                enforcer.PolicyManager.Policy.BuildIncrementalRoleLinks(enforcer.RoleManager, policyOperation,
+                enforcer.PolicyManager.Policy.BuildIncrementalRoleLinks(policyOperation,
                     section, policyType, rules);
                 enforcer.ExpressionHandler.SetGFunctions();
             }

diff --git a/NetCasbin/Extensions/Enforcer/RbacEnforcerExtension.cs b/NetCasbin/Extensions/Enforcer/RbacEnforcerExtension.cs
@@ -16,7 +16,7 @@ public static class RbacEnforcerExtension
         /// <param name="name"></param>
         /// <param name="domain"></param>
         /// <returns></returns>
-        public static List<string> GetRolesForUser(this IEnforcer enforcer, string name,  string domain = null)
+        public static IEnumerable<string> GetRolesForUser(this IEnforcer enforcer, string name,  string domain = null)
         {
             return domain is null
                 ? enforcer.Model.Sections[PermConstants.Section.RoleSection][PermConstants.DefaultRoleType]
@@ -32,7 +32,7 @@ public static List<string> GetRolesForUser(this IEnforcer enforcer, string name,
         /// <param name="name"></param>
         /// <param name="domain"></param>
         /// <returns></returns>
-        public static List<string> GetUsersForRole(this IEnforcer enforcer, string name, string domain = null)
+        public static IEnumerable<string> GetUsersForRole(this IEnforcer enforcer, string name, string domain = null)
         {
             return domain is null
                 ? enforcer.Model.Sections[PermConstants.Section.RoleSection][PermConstants.DefaultRoleType]
@@ -581,7 +581,7 @@ public static IEnumerable<string> GetDomainsForUser(this IEnforcer enforcer, str
         /// <param name="name"></param>
         /// <param name="domain"></param>
         /// <returns></returns>
-        public static List<string> GetRolesForUserInDomain(this IEnforcer enforcer, string name, string domain)
+        public static IEnumerable<string> GetRolesForUserInDomain(this IEnforcer enforcer, string name, string domain)
         {
             return enforcer.Model.Sections[PermConstants.Section.RoleSection][PermConstants.DefaultRoleType].RoleManager.GetRoles(name, domain);
         }

diff --git a/NetCasbin/Model/Assertion.cs b/NetCasbin/Model/Assertion.cs
@@ -108,14 +108,8 @@ private void BuildRoleLink(int groupPolicyCount,
                         case 3:
                             roleManager.AddLink(ruleEnum[0], ruleEnum[1], ruleEnum[2]);
                             break;
-                        case 4:
-                            roleManager.AddLink(ruleEnum[0], ruleEnum[1],
-                                ruleEnum[2], ruleEnum[3]);
-                            break;
                         default:
-                            roleManager.AddLink(ruleEnum[0], ruleEnum[1],
-                                ruleEnum.GetRange(2, groupPolicyCount - 2).ToArray());
-                            break;
+                            throw new ArgumentOutOfRangeException(nameof(groupPolicyCount), groupPolicyCount, null);
                     }
                     break;
                 case PolicyOperation.PolicyRemove:
@@ -127,14 +121,8 @@ private void BuildRoleLink(int groupPolicyCount,
                         case 3:
                             roleManager.DeleteLink(ruleEnum[0], ruleEnum[1], ruleEnum[2]);
                             break;
-                        case 4:
-                            roleManager.DeleteLink(ruleEnum[0], ruleEnum[1],
-                                ruleEnum[2], ruleEnum[3]);
-                            break;
                         default:
-                            roleManager.DeleteLink(ruleEnum[0], ruleEnum[1],
-                                ruleEnum.GetRange(2, groupPolicyCount - 2).ToArray());
-                            break;
+                            throw new ArgumentOutOfRangeException(nameof(groupPolicyCount), groupPolicyCount, null);
                     }
                     break;
                 default:

diff --git a/NetCasbin/Model/DefaultModel.cs b/NetCasbin/Model/DefaultModel.cs
@@ -177,16 +177,16 @@ private static string GetKeySuffix(int i)
 
         #region IPolicy
 
-        public void BuildIncrementalRoleLink(IRoleManager roleManager, PolicyOperation policyOperation, string section,
+        public void BuildIncrementalRoleLink(PolicyOperation policyOperation, string section,
             string policyType, IEnumerable<string> rule)
-            => PolicyManager.Policy.BuildIncrementalRoleLink(roleManager, policyOperation, section, policyType, rule);
+            => PolicyManager.Policy.BuildIncrementalRoleLink(policyOperation, section, policyType, rule);
 
-        public void BuildIncrementalRoleLinks(IRoleManager roleManager, PolicyOperation policyOperation, string section,
+        public void BuildIncrementalRoleLinks(PolicyOperation policyOperation, string section,
             string policyType, IEnumerable<IEnumerable<string>> rules)
-            => PolicyManager.Policy.BuildIncrementalRoleLinks(roleManager, policyOperation, section, policyType, rules);
+            => PolicyManager.Policy.BuildIncrementalRoleLinks(policyOperation, section, policyType, rules);
 
-        public void BuildRoleLinks(IRoleManager roleManager)
-            => PolicyManager.Policy.BuildRoleLinks(roleManager);
+        public void BuildRoleLinks()
+            => PolicyManager.Policy.BuildRoleLinks();
 
         public void RefreshPolicyStringSet()
             => PolicyManager.Policy.RefreshPolicyStringSet();

diff --git a/NetCasbin/Model/DefaultPolicy.cs b/NetCasbin/Model/DefaultPolicy.cs
@@ -4,7 +4,6 @@
 #if !NET45
 using Microsoft.Extensions.Logging;
 #endif
-using Casbin.Rbac;
 using Casbin.Util;
 
 namespace Casbin.Model
@@ -86,47 +85,6 @@ public void BuildRoleLinks()
             }
         }
 
-        /// <summary>
-        /// Provides incremental build the role inheritance relation.
-        /// </summary>
-        /// <param name="roleManager"></param>
-        /// <param name="policyOperation"></param>
-        /// <param name="section"></param>
-        /// <param name="policyType"></param>
-        /// <param name="rule"></param>
-        [Obsolete("Use overload instead.")]
-        public void BuildIncrementalRoleLink(IRoleManager roleManager, PolicyOperation policyOperation,
-            string section, string policyType, IEnumerable<string> rule)
-        {
-            BuildIncrementalRoleLink(policyOperation, section, policyType, rule);
-        }
-
-        /// <summary>
-        /// Provides incremental build the role inheritance relations.
-        /// </summary>
-        /// <param name="roleManager"></param>
-        /// <param name="policyOperation"></param>
-        /// <param name="section"></param>
-        /// <param name="policyType"></param>
-        /// <param name="rules"></param>
-        [Obsolete("Use overload instead.")]
-        public void BuildIncrementalRoleLinks(IRoleManager roleManager, PolicyOperation policyOperation,
-            string section, string policyType, IEnumerable<IEnumerable<string>> rules)
-        {
-            BuildIncrementalRoleLinks(policyOperation, section, policyType, rules);
-        }
-
-
-        /// <summary>
-        /// Initializes the roles in RBAC.
-        /// </summary>
-        /// <param name="roleManager"></param>
-        [Obsolete("Use overload instead.")]
-        public void BuildRoleLinks(IRoleManager roleManager)
-        {
-            BuildRoleLinks();
-        }
-
         public void RefreshPolicyStringSet()
         {
             foreach (Assertion assertion in Sections.Values

diff --git a/NetCasbin/Model/SyncedModelExtension.cs b/NetCasbin/Model/SyncedModelExtension.cs
@@ -1,5 +1,4 @@
 using System;
-using System.Dynamic;
 using System.IO;
 
 namespace Casbin.Model