update

Refactor factories

Author: saadshams

LICENSE

@@ -1,5 +1,5 @@
-* PureMVC Standard Framework for C# - Copyright © 2017 [Saad Shams](http://saad.io)
-* PureMVC - Copyright © 2017 [Futurescale, Inc](http://futurescale.com).
+* PureMVC Standard Framework for C# - Copyright © 2020 [Saad Shams](http://saad.io)
+* PureMVC - Copyright © 2020 [Futurescale, Inc](http://futurescale.com).
 * All rights reserved.
 
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

PureMVC/Core/Controller.cs

@@ -1,7 +1,7 @@
 //
 //  PureMVC C# Standard
 //
-//  Copyright(c) 2017 Saad Shams <saad.shams@puremvc.org>
+//  Copyright(c) 2020 Saad Shams <saad.shams@puremvc.org>
 //  Your reuse is governed by the Creative Commons Attribution 3.0 License
 //
 
@@ -58,7 +58,7 @@ public class Controller: IController
         /// <exception cref="System.Exception">Thrown if Singleton instance has already been constructed</exception>
         public Controller()
         {
-            if (instance != null) throw new Exception(Singleton_MSG);
+            if (instance != null) throw new Exception(SingletonMsg);
             instance = this;
             commandMap = new ConcurrentDictionary<string, Func<ICommand>>();
             InitializeController();
@@ -92,13 +92,13 @@ protected virtual void InitializeController()
         /// <summary>
         /// <c>Controller</c> Singleton Factory method.
         /// </summary>
-        /// <param name="controllerFunc">the <c>FuncDelegate</c> of the <c>IController</c></param>
+        /// <param name="factory">the <c>FuncDelegate</c> of the <c>IController</c></param>
         /// <returns>the Singleton instance of <c>Controller</c></returns>
-        public static IController GetInstance(Func<IController> controllerFunc)
+        public static IController GetInstance(Func<IController> factory)
         {
             if (instance == null)
             {
-                instance = controllerFunc();
+                instance = factory();
             }
             return instance;
         }
@@ -110,9 +110,9 @@ public static IController GetInstance(Func<IController> controllerFunc)
         /// <param name="notification">note an <c>INotification</c></param>
         public virtual void ExecuteCommand(INotification notification)
         {
-            if (commandMap.TryGetValue(notification.Name, out Func<ICommand> commandFunc))
+            if (commandMap.TryGetValue(notification.Name, out var factory))
             {
-                ICommand commandInstance = commandFunc();
+                var commandInstance = factory();
                 commandInstance.Execute(notification);
             }
         }
@@ -129,18 +129,18 @@ public virtual void ExecuteCommand(INotification notification)
         ///     </para>
         ///     <para>
         ///         The Observer for the new ICommand is only created if this the
-        ///         first time an ICommand has been regisered for this Notification name.
+        ///         first time an ICommand has been registered for this Notification name.
         ///     </para>
         /// </remarks>
         /// <param name="notificationName">the name of the <c>INotification</c></param>
-        /// <param name="commandFunc">the <c>Func Delegate</c> of the <c>ICommand</c></param>
-        public virtual void RegisterCommand(string notificationName, Func<ICommand> commandFunc)
+        /// <param name="factory">the <c>Func Delegate</c> of the <c>ICommand</c></param>
+        public virtual void RegisterCommand(string notificationName, Func<ICommand> factory)
         {
-            if (commandMap.TryGetValue(notificationName, out Func<ICommand> _) == false)
+            if (commandMap.TryGetValue(notificationName, out _) == false)
             {
                 view.RegisterObserver(notificationName, new Observer(ExecuteCommand, this));
             }
-            commandMap[notificationName] = commandFunc;
+            commandMap[notificationName] = factory;
         }
 
         /// <summary>
@@ -149,7 +149,7 @@ public virtual void RegisterCommand(string notificationName, Func<ICommand> comm
         /// <param name="notificationName">the name of the <c>INotification</c> to remove the <c>ICommand</c> mapping for</param>
         public virtual void RemoveCommand(string notificationName)
         {
-            if (commandMap.TryRemove(notificationName, out Func<ICommand> _))
+            if (commandMap.TryRemove(notificationName, out _))
             {
                 view.RemoveObserver(notificationName, this);
             }
@@ -175,6 +175,6 @@ public virtual bool HasCommand(string notificationName)
         protected static IController instance;
 
         /// <summary>Message Constants</summary>
-        protected const string Singleton_MSG = "Controller Singleton already constructed!";
+        protected const string SingletonMsg = "Controller Singleton already constructed!";
     }
 }

PureMVC/Core/Model.cs

@@ -1,7 +1,7 @@
 //
 //  PureMVC C# Standard
 //
-//  Copyright(c) 2017 Saad Shams <saad.shams@puremvc.org>
+//  Copyright(c) 2020 Saad Shams <saad.shams@puremvc.org>
 //  Your reuse is governed by the Creative Commons Attribution 3.0 License
 //
 
@@ -46,7 +46,7 @@ public class Model: IModel
         /// <exception cref="System.Exception">Thrown if instance for this Singleton key has already been constructed</exception>
         public Model()
         {
-            if (instance != null) throw new Exception(Singleton_MSG);
+            if (instance != null) throw new Exception(SingletonMsg);
             instance = this;
             proxyMap = new ConcurrentDictionary<string, IProxy>();
             InitializeModel();
@@ -70,13 +70,13 @@ protected virtual void InitializeModel()
         /// <summary>
         /// <c>Model</c> Singleton Factory method. 
         /// </summary>
-        /// <param name="modelFunc">the <c>FuncDelegate</c> of the <c>IModel</c></param>
+        /// <param name="factory">the <c>FuncDelegate</c> of the <c>IModel</c></param>
         /// <returns>the instance for this Singleton key </returns>
-        public static IModel GetInstance(Func<IModel> modelFunc)
+        public static IModel GetInstance(Func<IModel> factory)
         {
             if (instance == null)
             {
-                instance = modelFunc();
+                instance = factory();
             }
             return instance;
         }
@@ -98,7 +98,7 @@ public virtual void RegisterProxy(IProxy proxy)
         /// <returns>the <c>IProxy</c> instance previously registered with the given <c>proxyName</c>.</returns>
         public virtual IProxy RetrieveProxy(string proxyName)
         {
-            return proxyMap.TryGetValue(proxyName, out IProxy proxy) ? proxy : null;
+            return proxyMap.TryGetValue(proxyName, out var proxy) ? proxy : null;
         }
 
         /// <summary>
@@ -108,7 +108,7 @@ public virtual IProxy RetrieveProxy(string proxyName)
         /// <returns>the <c>IProxy</c> that was removed from the <c>Model</c></returns>
         public virtual IProxy RemoveProxy(string proxyName)
         {
-            if (proxyMap.TryRemove(proxyName, out IProxy proxy))
+            if (proxyMap.TryRemove(proxyName, out var proxy))
             {
                 proxy.OnRemove();
             }
@@ -132,6 +132,6 @@ public virtual bool HasProxy(string proxyName)
         protected static IModel instance;
 
         /// <summary>Message Constants</summary>
-        protected const string Singleton_MSG = "Model Singleton already constructed!";
+        protected const string SingletonMsg = "Model Singleton already constructed!";
     }
 }

PureMVC/Core/View.cs

@@ -1,7 +1,7 @@
 //
 //  PureMVC C# Standard
 //
-//  Copyright(c) 2017 Saad Shams <saad.shams@puremvc.org>
+//  Copyright(c) 2020 Saad Shams <saad.shams@puremvc.org>
 //  Your reuse is governed by the Creative Commons Attribution 3.0 License
 //
 
@@ -46,7 +46,7 @@ public class View: IView
         /// <exception cref="System.Exception">Thrown if Singleton instance has already been constructed</exception>
         public View()
         {
-            if (instance != null) throw new Exception(Singleton_MSG);
+            if (instance != null) throw new Exception(SingletonMsg);
             instance = this;
             mediatorMap = new ConcurrentDictionary<string, IMediator>();
             observerMap = new ConcurrentDictionary<string, IList<IObserver>>();
@@ -71,13 +71,13 @@ protected virtual void InitializeView()
         /// <summary>
         /// <c>View</c> Singleton Factory method. 
         /// </summary>
-        /// <param name="viewFunc">the <c>FuncDelegate</c> of the <c>IView</c></param>
+        /// <param name="factory">the <c>FuncDelegate</c> of the <c>IView</c></param>
         /// <returns>the instance for this Singleton key </returns>
-        public static IView GetInstance(Func<IView> viewFunc)
+        public static IView GetInstance(Func<IView> factory)
         {
             if (instance == null)
             {
-                instance = viewFunc();
+                instance = factory();
             }
             return instance;
         }
@@ -90,7 +90,7 @@ public static IView GetInstance(Func<IView> viewFunc)
         /// <param name="observer">the <c>IObserver</c> to register</param>
         public virtual void RegisterObserver(string notificationName, IObserver observer)
         {
-            if (observerMap.TryGetValue(notificationName, out IList<IObserver> observers))
+            if (observerMap.TryGetValue(notificationName, out var observers))
             {
                 observers.Add(observer);
             }
@@ -114,14 +114,14 @@ public virtual void RegisterObserver(string notificationName, IObserver observer
         public virtual void NotifyObservers(INotification notification)
         {
             // Get a reference to the observers list for this notification name
-            if (observerMap.TryGetValue(notification.Name, out IList<IObserver> observers_ref))
+            if (observerMap.TryGetValue(notification.Name, out var observersRef))
             {
                 // Copy observers from reference array to working array, 
                 // since the reference array may change during the notification loop
-                var observers = new List<IObserver>(observers_ref);
+                var observers = new List<IObserver>(observersRef);
 
                 // Notify Observers from the working array
-                foreach (IObserver observer in observers)
+                foreach (var observer in observers)
                 {
                     observer.NotifyObserver(notification);
                 }
@@ -136,10 +136,10 @@ public virtual void NotifyObservers(INotification notification)
         public virtual void RemoveObserver(string notificationName, object notifyContext)
         {
             // the observer list for the notification under inspection
-            if (observerMap.TryGetValue(notificationName, out IList<IObserver> observers))
+            if (observerMap.TryGetValue(notificationName, out var observers))
             {
                 // find the observer for the notifyContext
-                for (int i = 0; i < observers.Count; i++)
+                for (var i = 0; i < observers.Count; i++)
                 {
                     if (observers[i].CompareNotifyContext(notifyContext))
                     {
@@ -153,7 +153,7 @@ public virtual void RemoveObserver(string notificationName, object notifyContext
                 // Also, when a Notification's Observer list length falls to
                 // zero, delete the notification key from the observer map
                 if (observers.Count == 0)
-                    observerMap.TryRemove(notificationName, out IList<IObserver> _);
+                    observerMap.TryRemove(notificationName, out _);
             }
         }
 
@@ -182,18 +182,18 @@ public virtual void RegisterMediator(IMediator mediator)
             if(mediatorMap.TryAdd(mediator.MediatorName, mediator))
             {
                 // Get Notification interests, if any.
-                string[] interests = mediator.ListNotificationInterests();
+                var interests = mediator.ListNotificationInterests();
 
                 // Register Mediator as an observer for each notification of interests
                 if (interests.Length > 0)
                 {
-                    // Create Observer referencing this mediator's handlNotification method
+                    // Create Observer referencing this mediator's handleNotification method
                     IObserver observer = new Observer(mediator.HandleNotification, mediator);
 
                     // Register Mediator as Observer for its list of Notification interests
-                    for (int i = 0; i < interests.Length; i++)
+                    foreach (var interest in interests)
                     {
-                        RegisterObserver(interests[i], observer);
+                        RegisterObserver(interest, observer);
                     }
                 }
                 // alert the mediator that it has been registered
@@ -208,7 +208,7 @@ public virtual void RegisterMediator(IMediator mediator)
         /// <returns>the <c>IMediator</c> instance previously registered with the given <c>mediatorName</c>.</returns>
         public virtual IMediator RetrieveMediator(string mediatorName)
         {
-            return mediatorMap.TryGetValue(mediatorName, out IMediator mediator) ? mediator : null;
+            return mediatorMap.TryGetValue(mediatorName, out var mediator) ? mediator : null;
         }
 
         /// <summary>
@@ -219,15 +219,15 @@ public virtual IMediator RetrieveMediator(string mediatorName)
         public virtual IMediator RemoveMediator(string mediatorName)
         {
             // Retrieve the named mediator
-            if (mediatorMap.TryRemove(mediatorName, out IMediator mediator))
+            if (mediatorMap.TryRemove(mediatorName, out var mediator))
             {
                 // for every notification this mediator is interested in...
-                string[] interests = mediator.ListNotificationInterests();
-                for (int i = 0; i < interests.Length; i++)
+                var interests = mediator.ListNotificationInterests();
+                foreach (var interest in interests)
                 {
                     // remove the observer linking the mediator 
-					// to the notification interest
-                    RemoveObserver(interests[i], mediator);
+                    // to the notification interest
+                    RemoveObserver(interest, mediator);
                 }
 
                 // remove the mediator from the map
@@ -256,6 +256,6 @@ public virtual bool HasMediator(string mediatorName)
         protected static IView instance;
 
         /// <summary>Message Constants</summary>
-        protected const string Singleton_MSG = "View Singleton already constructed!";
+        protected const string SingletonMsg = "View Singleton already constructed!";
     }
 }

PureMVC/Interfaces/ICommand.cs

@@ -1,7 +1,7 @@
 //
 //  PureMVC C# Standard
 //
-//  Copyright(c) 2017 Saad Shams <saad.shams@puremvc.org>
+//  Copyright(c) 2020 Saad Shams <saad.shams@puremvc.org>
 //  Your reuse is governed by the Creative Commons Attribution 3.0 License
 //
 
@@ -16,7 +16,7 @@ public interface ICommand: INotifier
         /// <summary>
         /// Execute the <c>ICommand</c>'s logic to handle a given <c>INotification</c>.
         /// </summary>
-        /// <param name="Notification">an <c>INotification</c> to handle.</param>
-        void Execute(INotification Notification);
+        /// <param name="notification">an <c>INotification</c> to handle.</param>
+        void Execute(INotification notification);
     }
 }

PureMVC/Interfaces/IController.cs

@@ -1,7 +1,7 @@
 //
 //  PureMVC C# Standard
 //
-//  Copyright(c) 2017 Saad Shams <saad.shams@puremvc.org>
+//  Copyright(c) 2020 Saad Shams <saad.shams@puremvc.org>
 //  Your reuse is governed by the Creative Commons Attribution 3.0 License
 //
 
@@ -43,8 +43,8 @@ public interface IController
         ///  for a particular <c>INotification</c>.
         /// </summary>
         /// <param name="notificationName">the name of the <c>INotification</c></param>
-        /// <param name="commandFunc">the FuncDelegate of the <c>ICommand</c></param>
-        void RegisterCommand(string notificationName, Func<ICommand> commandFunc);
+        /// <param name="factory">the FuncDelegate of the <c>ICommand</c></param>
+        void RegisterCommand(string notificationName, Func<ICommand> factory);
 
         /// <summary>
         /// Execute the <c>ICommand</c> previously registered as the

PureMVC/Interfaces/IFacade.cs

@@ -1,7 +1,7 @@
 //
 //  PureMVC C# Standard
 //
-//  Copyright(c) 2017 Saad Shams <saad.shams@puremvc.org>
+//  Copyright(c) 2020 Saad Shams <saad.shams@puremvc.org>
 //  Your reuse is governed by the Creative Commons Attribution 3.0 License
 //
 
@@ -41,7 +41,7 @@ public interface IFacade: INotifier
         /// Retrieve a <c>IProxy</c> from the <c>Model</c> by name.
         /// </summary>
         /// <param name="proxyName">the name of the <c>IProxy</c> instance to be retrieved.</param>
-        /// <returns>the <c>IProxy</c> previously regisetered by <c>proxyName</c> with the <c>Model</c>.</returns>
+        /// <returns>the <c>IProxy</c> previously registered by <c>proxyName</c> with the <c>Model</c>.</returns>
         IProxy RetrieveProxy(string proxyName);
 
         /// <summary>
@@ -62,8 +62,8 @@ public interface IFacade: INotifier
         /// Register an <c>ICommand</c> with the <c>Controller</c>.
         /// </summary>
         /// <param name="notificationName">the name of the <c>INotification</c> to associate the <c>ICommand</c> with.</param>
-        /// <param name="commandFunc">a reference to the <c>FuncDelegate</c> of the <c>ICommand</c></param>
-        void RegisterCommand(string notificationName, Func<ICommand> commandFunc);
+        /// <param name="factory">a reference to the <c>FuncDelegate</c> of the <c>ICommand</c></param>
+        void RegisterCommand(string notificationName, Func<ICommand> factory);
 
         /// <summary>
         /// Remove a previously registered <c>ICommand</c> to <c>INotification</c> mapping from the Controller.

PureMVC/Interfaces/IMediator.cs

@@ -1,7 +1,7 @@
 //
 //  PureMVC C# Standard
 //
-//  Copyright(c) 2017 Saad Shams <saad.shams@puremvc.org>
+//  Copyright(c) 2020 Saad Shams <saad.shams@puremvc.org>
 //  Your reuse is governed by the Creative Commons Attribution 3.0 License
 //
 

PureMVC/Interfaces/IModel.cs

@@ -1,7 +1,7 @@
 //
 //  PureMVC C# Standard
 //
-//  Copyright(c) 2017 Saad Shams <saad.shams@puremvc.org>
+//  Copyright(c) 2020 Saad Shams <saad.shams@puremvc.org>
 //  Your reuse is governed by the Creative Commons Attribution 3.0 License
 //
 

PureMVC/Interfaces/INotification.cs

@@ -1,7 +1,7 @@
 //
 //  PureMVC C# Standard
 //
-//  Copyright(c) 2017 Saad Shams <saad.shams@puremvc.org>
+//  Copyright(c) 2020 Saad Shams <saad.shams@puremvc.org>
 //  Your reuse is governed by the Creative Commons Attribution 3.0 License
 //