Add support for Master.RefTableId convention for 1:1 table references

Author: mythz

src/ServiceStack.OrmLite/OrmLiteReadExtensions.cs

@@ -773,13 +773,28 @@ public static void SaveAllReferences<T>(this IDbCommand dbCmd, T instance)
                 {
                     var refType = fieldDef.FieldType;
                     var refModelDef = refType.GetModelDefinition();
-                    var refField = GetRefFieldDef(modelDef, refModelDef, fieldDef.FieldType);
+
+                    var refSelf = GetSelfRefFieldDefIfExists(modelDef, refModelDef);
 
                     var result = fieldDef.GetValue(instance);
+                    var refField = refSelf == null
+                        ? GetRefFieldDef(modelDef, refModelDef, refType)
+                        : GetRefFieldDefIfExists(modelDef, refModelDef);
+
                     if (result != null)
                     {
-                        refField.SetValueFn(result, pkValue);
+                        if (refField != null)
+                            refField.SetValueFn(result, pkValue);
+    
                         dbCmd.CreateTypedApi(refType).Save(result);
+
+                        //Save Self Table.RefTableId PK
+                        if (refSelf != null)
+                        {
+                            var refPkValue = refModelDef.PrimaryKey.GetValue(result);
+                            refSelf.SetValueFn(instance, refPkValue);
+                            dbCmd.Update(instance);
+                        }
                     }
                 }
             }
@@ -793,14 +808,30 @@ public static void SaveReferences<T, TRef>(this IDbCommand dbCmd, T instance, pa
             var refType = typeof(TRef);
             var refModelDef = ModelDefinition<TRef>.Definition;
 
+            var refSelf = GetSelfRefFieldDefIfExists(modelDef, refModelDef);
+
             foreach (var oRef in refs)
             {
-                var refField = GetRefFieldDef(modelDef, refModelDef, refType);
+                var refField = refSelf == null 
+                    ? GetRefFieldDef(modelDef, refModelDef, refType)
+                    : GetRefFieldDefIfExists(modelDef, refModelDef);
 
-                refField.SetValueFn(oRef, pkValue);
+                if (refField != null)
+                    refField.SetValueFn(oRef, pkValue);
             }
 
             dbCmd.SaveAll(refs);
+
+            foreach (var oRef in refs)
+            {
+                //Save Self Table.RefTableId PK
+                if (refSelf != null)
+                {
+                    var refPkValue = refModelDef.PrimaryKey.GetValue(oRef);
+                    refSelf.SetValueFn(instance, refPkValue);
+                    dbCmd.Update(instance);
+                }
+            }
         }
 
         public static void LoadReferences<T>(this IDbCommand dbCmd, T instance)
@@ -831,13 +862,28 @@ public static void LoadReferences<T>(this IDbCommand dbCmd, T instance)
                 {
                     var refType = fieldDef.FieldType;
                     var refModelDef = refType.GetModelDefinition();
-                    var refField = GetRefFieldDef(modelDef, refModelDef, fieldDef.FieldType);
 
-                    var sqlFilter = ormLiteDialectProvider.GetQuotedColumnName(refField.FieldName) + "={0}";
-                    var sql = ormLiteDialectProvider.ToSelectStatement(refType, sqlFilter, pkValue);
+                    var refSelf = GetSelfRefFieldDefIfExists(modelDef, refModelDef);
+                    var refField = refSelf == null 
+                        ? GetRefFieldDef(modelDef, refModelDef, refType)
+                        : GetRefFieldDefIfExists(modelDef, refModelDef);
 
-                    var result = dbCmd.ConvertTo(refType, sql);
-                    fieldDef.SetValueFn(instance, result);
+                    if (refField != null)
+                    {
+                        var sqlFilter = ormLiteDialectProvider.GetQuotedColumnName(refField.FieldName) + "={0}";
+                        var sql = ormLiteDialectProvider.ToSelectStatement(refType, sqlFilter, pkValue);
+                        var result = dbCmd.ConvertTo(refType, sql);
+                        fieldDef.SetValueFn(instance, result);
+                    }
+                    else if (refSelf != null)
+                    {
+                        //Load Self Table.RefTableId PK
+                        var refPkValue = refSelf.GetValue(instance);
+                        var sqlFilter = ormLiteDialectProvider.GetQuotedColumnName(refModelDef.PrimaryKey.FieldName) + "={0}";
+                        var sql = ormLiteDialectProvider.ToSelectStatement(refType, sqlFilter, refPkValue);
+                        var result = dbCmd.ConvertTo(refType, sql);
+                        fieldDef.SetValueFn(instance, result);
+                    }
                 }
             }
         }
@@ -852,10 +898,17 @@ public static FieldDefinition GetRefFieldDef(ModelDefinition modelDef, ModelDefi
 
         public static FieldDefinition GetRefFieldDefIfExists(ModelDefinition modelDef, ModelDefinition refModelDef)
         {
-            var refNameConvention = modelDef.ModelName + "Id";
-            var refField = refModelDef.FieldDefinitions.FirstOrDefault(x => x.FieldName == refNameConvention)
+            var refField = refModelDef.FieldDefinitions.FirstOrDefault(x => x.FieldName == modelDef.ModelName + "Id")
                            ?? refModelDef.FieldDefinitions.FirstOrDefault(x => x.Name == modelDef.Name + "Id");
             return refField;
         }
+
+        public static FieldDefinition GetSelfRefFieldDefIfExists(ModelDefinition modelDef, ModelDefinition refModelDef)
+        {
+            var refField = modelDef.FieldDefinitions.FirstOrDefault(x => x.FieldName == refModelDef.ModelName + "Id")
+                        ?? modelDef.FieldDefinitions.FirstOrDefault(x => x.Name == refModelDef.Name + "Id");
+
+            return refField;
+        }
     }
 }

tests/ServiceStack.OrmLite.Tests/LoadReferencesTests.cs

@@ -138,6 +138,29 @@ public class MismatchAliasAddress
         public string Country { get; set; }
     }
 
+    public class SelfCustomer
+    {
+        [AutoIncrement]
+        public int Id { get; set; }
+        public string Name { get; set; }
+
+        public int SelfCustomerAddressId { get; set; }
+
+        [Reference]
+        public SelfCustomerAddress PrimaryAddress { get; set; }
+    }
+
+    public class SelfCustomerAddress
+    {
+        [AutoIncrement]
+        public int Id { get; set; }
+        public string AddressLine1 { get; set; }
+        public string AddressLine2 { get; set; }
+        public string City { get; set; }
+        public string State { get; set; }
+        public string Country { get; set; }
+    }
+
     public class LoadReferencesTests
         : OrmLiteTestBase
     {
@@ -159,6 +182,8 @@ public class LoadReferencesTests
             db.DropAndCreateTable<OldAliasedCustomerAddress>();
             db.DropAndCreateTable<MismatchAliasCustomer>();
             db.DropAndCreateTable<MismatchAliasAddress>();
+            db.DropAndCreateTable<SelfCustomer>();
+            db.DropAndCreateTable<SelfCustomerAddress>();
         }
 
         [SetUp]
@@ -394,6 +419,50 @@ public void Can_FirstMatchingField_in_JOIN_tables_with_Aliases()
             Assert.That(q.FirstMatchingField("Unknown"), Is.Null);
         }
 
+        [Test]
+        public void Can_Save_and_Load_Self_References()
+        {
+            var customer = new SelfCustomer
+            {
+                Name = "Customer 1",
+                PrimaryAddress = new SelfCustomerAddress
+                {
+                    AddressLine1 = "1 Humpty Street",
+                    City = "Humpty Doo",
+                    State = "Northern Territory",
+                    Country = "Australia"
+                },
+            };
+
+            db.Save(customer);
+
+            Assert.That(customer.Id, Is.GreaterThan(0));
+            Assert.That(customer.SelfCustomerAddressId, Is.EqualTo(0));
+
+            db.SaveReferences(customer, customer.PrimaryAddress);
+            Assert.That(customer.SelfCustomerAddressId, Is.EqualTo(customer.Id));
+
+            var dbCustomer = db.LoadSingleById<SelfCustomer>(customer.Id);
+            Assert.That(dbCustomer.PrimaryAddress, Is.Not.Null);
+
+            customer = new SelfCustomer
+            {
+                Name = "Customer 2",
+                PrimaryAddress = new SelfCustomerAddress
+                {
+                    AddressLine1 = "2 Humpty Street",
+                    City = "Humpty Doo",
+                    State = "Northern Territory",
+                    Country = "Australia"
+                },
+            };
+
+            db.Save(customer, references:true);
+            Assert.That(customer.SelfCustomerAddressId, Is.EqualTo(customer.Id));
+
+            dbCustomer = db.LoadSingleById<SelfCustomer>(customer.Id);
+            Assert.That(dbCustomer.PrimaryAddress, Is.Not.Null);
+        }
 
     }