Merge pull request #15 from CoderGamester/develop

0.9.0 DataService changes

Author: CoderGamester

CHANGELOG.md

@@ -4,6 +4,52 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.9.0] - 2024-08-10
+
+- Updated interfaces and classes related to data services, enhancing modularity and improving version handling.
+- Added classes for Git commands, version management, and random number generation.
+
+**Changed**:
+- Restructured the data service interfaces, consolidating functionality into a single IDataService interface and removing unnecessary interfaces.
+- Changed AddData to AddOrReplaceData in the DataService implementation.
+- Removed the isLocal state from data handling.
+
+## [0.8.1] - 2023-08-27
+
+- Added GitEditorProcess class to run Git commands as processes, enabling checks for valid Git repositories, retrieving current branch names, commit hashes, and diffs from given commits.
+- Introduced VersionEditorUtils class for managing application versioning. This includes setting and saving the internal version before building, loading version data from disk, and generating an internal version suffix based on Git information and build settings.
+
+**Changed**:
+- Enhanced IInstaller interface with new methods for binding multiple type interfaces to a single instance, improving modularity and code organization.
+
+## [0.8.0] - 2023-08-05
+
+- Introduced MainInstaller, a singleton class for managing instances in the project.
+- Added RngService for generating and managing random numbers.
+- Implemented VersionServices to manage application version, including asynchronous loading of version data and comparison of version strings.
+
+## [0.7.1] - 2023-07-28
+
+**Fixed**:
+- Compilation errors in various test files and the PoolService class have been fixed.
+
+**Changed**:
+- Tests have been moved to proper folders, and the package number has been updated.
+- An unused namespace import has been removed from the InstallerTest class.
+
+## [0.7.0] - 2023-07-28
+
+- Introduced a code review process using GitHub Actions workflow.
+- Added IInstaller interface and Installer implementation for binding and resolving instances.
+- Updated namespaces, removed unused code, and modified method calls in test classes.
+
+**Changed**:
+- Removed dependency on ICommandNetworkService and SendCommand method in CommandService.
+- Updated IDataService interface and DataService class to handle local and online data saving.
+- Improved readability of MessageBrokerService class by using var for type inference.
+- Removed unused network service related interfaces, classes, and methods.
+- Modified calculation of overFlow in TickService to check for zero DeltaTime.
+
 ## [0.6.2] - 2020-09-10
 
 - Made *NetworkService* abstract and removed *INetworkService* to make easier to work with

Runtime/DataService.cs

@@ -16,85 +16,74 @@ public interface IDataProvider
 		/// Requests the player's data of <typeparamref name="T"/> type
 		/// </summary>
 		T GetData<T>() where T : class;
+
+		/// <summary>
+		/// Requests if the service has the given player's data of <typeparamref name="T"/> type
+		/// </summary>
+		bool HasData<T>() where T : class;
 	}
-	
+
 	/// <summary>
-	/// This interface provides the possibility to the current memory data to disk
+	/// This service allows to manage all the persistent data in the game.
+	/// Data are strictly reference types to guarantee that there is no boxing/unboxing and lost of referencing when changing it's data. 
 	/// </summary>
-	public interface IDataSaver
+	public interface IDataService : IDataProvider
 	{
 		/// <summary>
 		/// Saves the game's given <typeparamref name="T"/> data to disk
 		/// </summary>
 		void SaveData<T>() where T : class;
-		
+
 		/// <summary>
 		/// Saves all game's data to disk
 		/// </summary>
 		void SaveAllData();
-	}
 
-	/// <summary>
-	/// This interface provides the possibility to load data from disk
-	/// </summary>
-	public interface IDataLoader
-	{
 		/// <summary>
 		/// Loads the game's given <typeparamref name="T"/> data from disk and returns it
 		/// </summary>
 		T LoadData<T>() where T : class;
-	}
 
-	/// <summary>
-	/// This service allows to manage all the persistent data in the game.
-	/// Data are strictly reference types to guarantee that there is no boxing/unboxing and lost of referencing when changing it's data. 
-	/// </summary>
-	public interface IDataService : IDataProvider, IDataSaver, IDataLoader
-	{
 		/// <summary>
-		/// Adds the given <paramref name="data"/> to this logic state to be maintained in memory.
-		/// If <paramref name="isLocal"/> then the given <paramref name="data"/> will be saved on the device HD.
+		/// Adds or replaces the given <paramref name="data"/> to be maintained in memory.
 		/// </summary>
-		void AddData<T>(T data, bool isLocal = false) where T : class;
+		void AddOrReplaceData<T>(T data) where T : class;
 	}
 
 	/// <inheritdoc />
 	public class DataService : IDataService
 	{
-		private readonly IDictionary<Type, DataInfo> _data = new Dictionary<Type, DataInfo>();
-		
+		private readonly IDictionary<Type, object> _data = new Dictionary<Type, object>();
+
+		/// <inheritdoc />
+		public bool HasData<T>() where T : class
+		{
+			return _data.ContainsKey(typeof(T));
+		}
+
 		/// <inheritdoc />
 		public T GetData<T>() where T : class
 		{
-			return _data[typeof(T)].Data as T;
+			return _data[typeof(T)] as T;
 		}
 
 		/// <inheritdoc />
 		public void SaveData<T>() where T : class
 		{
 			var type = typeof(T);
 
-			if (_data[type].IsLocal)
-			{
-				PlayerPrefs.SetString(type.Name, JsonConvert.SerializeObject(_data[type].Data));
-				PlayerPrefs.Save();
-				return;
-			}
-			
-			SaveOnline(_data[type].Data, type);
+			PlayerPrefs.SetString(type.Name, JsonConvert.SerializeObject(_data[type]));
+			PlayerPrefs.Save();
+			OnDataSaved(type.Name, _data[type], type);
 		}
 
 		/// <inheritdoc />
 		public void SaveAllData()
 		{
 			foreach (var data in _data)
 			{
-				if (data.Value.IsLocal)
-				{
-					PlayerPrefs.SetString(data.Key.Name, JsonConvert.SerializeObject(data.Value.Data));
-					continue;
-				}
-				SaveOnline(data.Value.Data, data.Key);
+				PlayerPrefs.SetString(data.Key.Name, JsonConvert.SerializeObject(data.Value));
+				OnDataSaved(data.Key.Name, data.Value, data.Key);
 			}
 
 			PlayerPrefs.Save();
@@ -105,26 +94,27 @@ public T LoadData<T>() where T : class
 		{
 			var json = PlayerPrefs.GetString(typeof(T).Name, "");
 			var instance = string.IsNullOrEmpty(json) ? Activator.CreateInstance<T>() : JsonConvert.DeserializeObject<T>(json);
-			
-			AddData(instance, true);
+
+			AddOrReplaceData(instance);
 
 			return instance;
 		}
 
 		/// <inheritdoc />
-		public void AddData<T>(T data, bool isLocal = false) where T : class
-		{
-			_data.Add(typeof(T), new DataInfo { Data = data, IsLocal = isLocal });
-		}
-
-		protected virtual void SaveOnline(object data, Type type)
+		public void AddOrReplaceData<T>(T data) where T : class
 		{
+			if(HasData<T>())
+			{
+				_data[typeof(T)] = data;
+			}
+			else
+			{
+				_data.Add(typeof(T), data);
+			}
 		}
 
-		private struct DataInfo
+		protected virtual void OnDataSaved(string key, object data, Type type)
 		{
-			public object Data;
-			public bool IsLocal;
 		}
 	}
 }

Tests/Editor/EditMode/DataServiceTest.cs

@@ -26,11 +26,24 @@ public void AddData_Successfully()
 		{
 			var data = Substitute.For<IDataMockup>();
 
-			_dataService.AddData(data, false);
+			_dataService.AddOrReplaceData(data);
 
 			Assert.AreSame(data, _dataService.GetData<IDataMockup>());
 		}
 
+		[Test]
+		public void ReplaceData_Successfully()
+		{
+			var data = Substitute.For<IDataMockup>();
+			var data1 = new object();
+
+			_dataService.AddOrReplaceData(data1);
+			_dataService.AddOrReplaceData(data);
+
+			Assert.AreNotSame(data1, _dataService.GetData<IDataMockup>());
+			Assert.AreSame(data, _dataService.GetData<IDataMockup>());
+		}
+
 		[Test]
 		public void GetData_NotFound_ThrowsException()
 		{

package.json

@@ -2,8 +2,8 @@
   "name": "com.gamelovers.services",
   "displayName": "Services",
   "author": "Miguel Tomas",
-  "version": "0.8.1",
-  "unity": "2021.4",
+  "version": "0.9.0",
+  "unity": "2022.4",
   "license": "MIT",
   "description": "The purpose of this package is to provide a set of services to ease the development of a basic game architecture",
   "type": "library",