Add T Create(Guid) to ILcmFactory<T> (#313)

* expose data reader via Cache.InternalServices.DataReader

* declare new method ILcmFactory<T>.Create(Guid guid)
 implement via code generation
 remove ICmPicture Create method

* change behavior when guid is empty

* add a test ensuring LexEntryTypes can be created with a guid

---------

Co-authored-by: Jake Oliver <jeoliver97@gmail.com>

src/SIL.LCModel/DomainImpl/FactoryAdditions.cs

@@ -2137,20 +2137,6 @@ private static void ParsePictureLoc(string s, ref PictureLocationRangeType locTy
 					return;
 			}
 		}
-
-		/// <summary>
-		/// Create a new entry with the given guid.
-		/// </summary>
-		public ICmPicture Create(Guid guid)
-		{
-			if (guid == Guid.Empty)
-				return Create();
-
-			int hvo = ((IDataReader) m_cache.ServiceLocator.GetInstance<IDataSetup>())
-				.GetNextRealHvo();
-			return new CmPicture(m_cache, hvo, guid);
-		}
-
 	}
 	#endregion
 

src/SIL.LCModel/FactoryInterfaceAdditions.cs

@@ -845,11 +845,6 @@ ICmPicture Create(string sFolder, int anchorLoc, IPictureLocationBridge location
 		ICmPicture Create(string sFolder, int anchorLoc, IPictureLocationBridge locationParser,
 			string sDescription, string srcFilename, string sLayoutPos, string sLocationRange,
 			string sCopyright, string sCaption,	PictureLocationRangeType locRangeType, string sScaleFactor);
-
-		/// <summary>
-		/// Create a new entry with the given guid.
-		/// </summary>
-		ICmPicture Create(Guid guid);
 	}
 
 	/// <summary>

src/SIL.LCModel/ILcmServiceLocator.cs

@@ -96,6 +96,7 @@ internal interface IServiceLocatorInternal
 		IdentityMap IdentityMap { get; }
 		LoadingServices LoadingServices { get; }
 		IUnitOfWorkService UnitOfWorkService { get; }
+		IDataReader DataReader { get; }
 	}
 
 	/// <summary>

src/SIL.LCModel/IOC/LcmServiceLocatorFactory.cs

@@ -430,6 +430,14 @@ public IDataSetup DataSetup
 			}
 		}
 
+		public IDataReader DataReader
+		{
+			get
+			{
+				return GetInstance<IDataReader>();
+			}
+		}
+
 		/// <summary>
 		/// Get the specified object instance; short for getting ICmObjectRepository and asking it to GetObject.
 		/// </summary>

src/SIL.LCModel/InterfaceDeclarations.cs

@@ -638,6 +638,12 @@ public interface ILcmFactory<T> where T : ICmObject
 		/// </summary>
 		/// <returns>A new, unowned, ICmObject with a Guid, but no Hvo.</returns>
 		T Create();
+
+		/// <summary>
+		/// Basic creation method for an ICmObject with the given guid.
+		/// </summary>
+		/// <returns>A new, unowned, ICmObject with the given guid.</returns>
+		T Create(Guid guid);
 	}
 	#endregion
 

src/SIL.LCModel/LcmCache.cs

@@ -1085,6 +1085,11 @@ public ILcmServiceLocator ServiceLocator
 			get { return m_serviceLocator; }
 		}
 
+		internal IServiceLocatorInternal InternalServices
+		{
+			get { return (IServiceLocatorInternal) m_serviceLocator; }
+		}
+
 		/// <summary>
 		/// Add to the list a ClassAndPropInfo for each concrete class of object that may be added to
 		/// property flid.

src/SIL.LCModel/LcmGenerate/factory.vm.cs

@@ -10,6 +10,7 @@
 ## --------------------------------------------------------------------------------------------
 #set( $className = $class.Name )
 #set( $baseClassName = $class.BaseClass.Name )
+#set( $ownerStatus = $class.OwnerStatus )
 #if ($class.Name == "LgWritingSystem")
 #set( $classSfx = "FactoryLcm" )
 #else
@@ -52,6 +53,25 @@ internal partial class ${className}$classSfx : I${className}$classSfx, ILcmFacto
 				((ICmObjectInternal)newby).InitializeNewOwnerlessCmObject(m_cache);
 			return newby;
 		}
+
+		/// <summary>
+		/// Basic creation method for an $className.
+		/// </summary>
+		/// <returns>A new, unowned, $className with the given guid.</returns>
+		public I$className Create(Guid guid)
+		{
+#if ($class.IsSingleton)
+			if (m_cache.ServiceLocator.GetInstance<I${className}Repository>().Singleton != null)
+				throw new InvalidOperationException("Can not create more than one ${className}");
+#end
+			if (guid == Guid.Empty) guid = Guid.NewGuid();
+			int hvo = m_cache.InternalServices.DataReader.GetNextRealHvo();
+			var newby = new $className(m_cache, hvo, guid);
+#if ( $ownerStatus != "required")
+			((ICmObjectInternal) newby).InitializeNewOwnerlessCmObjectWithPresetGuid();
+#end
+			return newby;
+		}
 #end
 
 		/// <summary>

tests/SIL.LCModel.Tests/Infrastructure/Impl/LexEntryTypeTests.cs

@@ -0,0 +1,20 @@
+using System;
+using System.Linq;
+using NUnit.Framework;
+
+namespace SIL.LCModel.Infrastructure.Impl
+{
+	public class LexEntryTypeTests: MemoryOnlyBackendProviderRestoredForEachTestTestBase
+	{
+		[Test]
+		public void CreateTypeWithGuid_CanAddToList()
+		{
+			var guid = Guid.NewGuid();
+			var lexEntryType = Cache.ServiceLocator.GetInstance<ILexEntryTypeFactory>().Create(guid);
+
+			Cache.LangProject.LexDbOA.ComplexEntryTypesOA.PossibilitiesOS.Add(lexEntryType);
+
+			Assert.That(Cache.ServiceLocator.ObjectRepository.GetObject(guid), Is.EqualTo(lexEntryType));
+		}
+	}
+}