Merge pull request #381 from DataObjects-NET/master-upgradehints-imps

Improves upgrade hints, mostly user experience

Author: alex-kulakov

ChangeLog/7.2.0-Beta-2-dev.txt

@@ -0,0 +1 @@
+[main] Upgrade hints change names of constructors' string parameters for better understanding of what suppose to be in them.

Orm/Xtensive.Orm/Orm/Upgrade/Hints/ChangeFieldTypeHint.cs

@@ -1,6 +1,6 @@
-// Copyright (C) 2003-2010 Xtensive LLC.
-// All rights reserved.
-// For conditions of distribution and use, see license.
+// Copyright (C) 2009-2024 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
 // Created by: Ivan Galkin
 // Created:    2009.06.05
 
@@ -19,8 +19,6 @@ namespace Xtensive.Orm.Upgrade
   public sealed class ChangeFieldTypeHint : UpgradeHint,
     IEquatable<ChangeFieldTypeHint>
   {
-    private const string ToStringFormat = "Change type of field: {0}.{1}";
-
     /// <summary>
     /// Gets the target type.
     /// </summary>
@@ -45,45 +43,39 @@ public bool Equals(ChangeFieldTypeHint other)
         return true;
       var comparer = StringComparer.OrdinalIgnoreCase;
       return base.Equals(other)
-        && other.Type==Type
+        && other.Type == Type
         && comparer.Equals(other.FieldName, FieldName);
     }
 
     /// <inheritdoc/>
-    public override bool Equals(UpgradeHint other)
-    {
-      return Equals(other as ChangeFieldTypeHint);
-    }
+    public override bool Equals(UpgradeHint other) => Equals(other as ChangeFieldTypeHint);
 
     /// <inheritdoc/>
     public override int GetHashCode()
     {
       unchecked {
         int result = base.GetHashCode();
-        result = (result * 397) ^ (Type!=null ? Type.GetHashCode() : 0);
-        result = (result * 397) ^ (FieldName!=null ? FieldName.GetHashCode() : 0);
+        result = (result * 397) ^ (Type != null ? Type.GetHashCode() : 0);
+        result = (result * 397) ^ (FieldName != null ? FieldName.GetHashCode() : 0);
         return result;
       }
     }
 
     /// <inheritdoc/>
-    public override string ToString()
-    {
-      return string.Format(ToStringFormat, Type, FieldName);
-    }
+    public override string ToString() => $"Change type of field: {Type}.{FieldName}";
 
 
     // Constructors
 
     /// <summary>
     /// Initializes a new instance of this class.
     /// </summary>
-    /// <param name="type">Value for <see cref="Type"/>.</param>
-    /// <param name="fieldName">Value for <see cref="FieldName"/>.</param>
+    /// <param name="type">The type field belongs to.</param>
+    /// <param name="fieldName">Name of field that changes type.</param>
     public ChangeFieldTypeHint(Type type, string fieldName)
     {
-      ArgumentValidator.EnsureArgumentNotNull(type, "type");
-      ArgumentValidator.EnsureArgumentNotNullOrEmpty(fieldName, "sourceField");
+      ArgumentValidator.EnsureArgumentNotNull(type, nameof(type));
+      ArgumentValidator.EnsureArgumentNotNullOrEmpty(fieldName, nameof(fieldName));
 
       Type = type;
       FieldName = fieldName;

Orm/Xtensive.Orm/Orm/Upgrade/Hints/CopyFieldHint.cs

@@ -1,6 +1,6 @@
-// Copyright (C) 2003-2010 Xtensive LLC.
-// All rights reserved.
-// For conditions of distribution and use, see license.
+// Copyright (C) 2009-2024 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
 // Created by: Denis Kryuchkov
 // Created:    2009.05.29
 
@@ -19,8 +19,6 @@ namespace Xtensive.Orm.Upgrade
   public class CopyFieldHint : UpgradeHint,
     IEquatable<CopyFieldHint>
   {
-    private const string ToStringFormat = "Copy field: {0}.{1} -> {2}.{3}";
-
     /// <summary>
     /// Gets the source type.
     /// </summary>
@@ -48,100 +46,94 @@ public bool Equals(CopyFieldHint other)
         return false;
       if (ReferenceEquals(this, other))
         return true;
-      return base.Equals(other) 
-        && other.SourceType==SourceType
-        && other.SourceField==SourceField
-        && other.TargetType==TargetType
-        && other.TargetField==TargetField;
+      return base.Equals(other)
+        && other.SourceType == SourceType
+        && other.SourceField == SourceField
+        && other.TargetType == TargetType
+        && other.TargetField == TargetField;
     }
 
     /// <inheritdoc/>
-    public override bool Equals(UpgradeHint other)
-    {
-      return Equals(other as CopyFieldHint);
-    }
+    public override bool Equals(UpgradeHint other) => Equals(other as CopyFieldHint);
 
     /// <inheritdoc/>
     public override int GetHashCode()
     {
       unchecked {
         int result = base.GetHashCode();
-        result = (result * 397) ^ (SourceType!=null ? SourceType.GetHashCode() : 0);
-        result = (result * 397) ^ (SourceField!=null ? SourceField.GetHashCode() : 0);
-        result = (result * 397) ^ (TargetType!=null ? TargetType.GetHashCode() : 0);
-        result = (result * 397) ^ (TargetField!=null ? TargetField.GetHashCode() : 0);
+        result = (result * 397) ^ (SourceType != null ? SourceType.GetHashCode() : 0);
+        result = (result * 397) ^ (SourceField != null ? SourceField.GetHashCode() : 0);
+        result = (result * 397) ^ (TargetType != null ? TargetType.GetHashCode() : 0);
+        result = (result * 397) ^ (TargetField != null ? TargetField.GetHashCode() : 0);
         return result;
       }
     }
 
     /// <inheritdoc/>
-    public override string ToString()
-    {
-      return string.Format(ToStringFormat,
-        SourceType, SourceField, TargetType.GetFullName(), TargetField);
-    }
+    public override string ToString() =>
+      $"Copy field: {SourceType}.{SourceField} -> {TargetType.GetFullName()}.{TargetField}";
 
 
     // Constructors
 
     /// <summary>
     /// Initializes a new instance of this class.
     /// </summary>
-    /// <param name="sourceType">Value for <see cref="SourceType"/>.</param>
-    /// <param name="sourceField">Value for <see cref="SourceField"/>.</param>
-    /// <param name="targetType">Value for <see cref="TargetType"/>.</param>
-    /// <param name="targetField">Value for <see cref="TargetField"/>.</param>
-    public CopyFieldHint(string sourceType, string sourceField, Type targetType, string targetField)
+    /// <param name="sourceTypeName">The source type full name.</param>
+    /// <param name="sourceFieldName">Name of source field.</param>
+    /// <param name="targetType">The target type.</param>
+    /// <param name="targetFieldName">Name of target field.</param>
+    public CopyFieldHint(string sourceTypeName, string sourceFieldName, Type targetType, string targetFieldName)
     {
-      ArgumentValidator.EnsureArgumentNotNullOrEmpty(sourceType, "sourceType");
-      ArgumentValidator.EnsureArgumentNotNullOrEmpty(sourceField, "sourceField");
-      ArgumentValidator.EnsureArgumentNotNull(targetType, "targetType");
-      ArgumentValidator.EnsureArgumentNotNullOrEmpty(targetField, "targetField");
-      SourceType = sourceType;
-      SourceField = sourceField;
+      ArgumentValidator.EnsureArgumentNotNullOrEmpty(sourceTypeName, nameof(sourceTypeName));
+      ArgumentValidator.EnsureArgumentNotNullOrEmpty(sourceFieldName, nameof(sourceFieldName));
+      ArgumentValidator.EnsureArgumentNotNull(targetType, nameof(targetType));
+      ArgumentValidator.EnsureArgumentNotNullOrEmpty(targetFieldName, nameof(targetFieldName));
+      SourceType = sourceTypeName;
+      SourceField = sourceFieldName;
       TargetType = targetType;
-      TargetField = targetField;
+      TargetField = targetFieldName;
     }
 
     /// <summary>
     /// Initializes a new instance of this class.
     /// </summary>
-    /// <param name="sourceType">Value for <see cref="SourceType"/>.</param>
-    /// <param name="field">Value for <see cref="SourceField"/> and <see cref="TargetField"/>.</param>
-    /// <param name="targetType">Value for <see cref="TargetType"/>.</param>
-    public CopyFieldHint(Type sourceType, string field, Type targetType)
-      : this(sourceType, field, targetType, field)
+    /// <param name="sourceType">The source type.</param>
+    /// <param name="fieldName">Name of field in both source and target types.</param>
+    /// <param name="targetType">The target type.</param>
+    public CopyFieldHint(Type sourceType, string fieldName, Type targetType)
+      : this(sourceType, fieldName, targetType, fieldName)
     {
     }
 
     /// <summary>
     /// Initializes a new instance of this class.
     /// </summary>
-    /// <param name="sourceType">Value for <see cref="SourceType"/>.</param>
-    /// <param name="sourceField">Value for <see cref="SourceField"/>.</param>
-    /// <param name="targetType">Value for <see cref="TargetType"/>.</param>
-    /// <param name="targetField">Value for <see cref="TargetField"/>.</param>
-    public CopyFieldHint(Type sourceType, string sourceField, Type targetType, string targetField)
+    /// <param name="sourceType">The source type.</param>
+    /// <param name="sourceFieldName">The source field name.</param>
+    /// <param name="targetType">The target type name.</param>
+    /// <param name="targetFieldName">The target field name.</param>
+    public CopyFieldHint(Type sourceType, string sourceFieldName, Type targetType, string targetFieldName)
     {
-      ArgumentValidator.EnsureArgumentNotNull(sourceType, "sourceType");
-      ArgumentValidator.EnsureArgumentNotNullOrEmpty(sourceField, "sourceField");
-      ArgumentValidator.EnsureArgumentNotNull(targetType, "targetType");
-      ArgumentValidator.EnsureArgumentNotNullOrEmpty(targetField, "targetField");
+      ArgumentValidator.EnsureArgumentNotNull(sourceType, nameof(sourceType));
+      ArgumentValidator.EnsureArgumentNotNullOrEmpty(sourceFieldName, nameof(sourceFieldName));
+      ArgumentValidator.EnsureArgumentNotNull(targetType, nameof(targetType));
+      ArgumentValidator.EnsureArgumentNotNullOrEmpty(targetFieldName, nameof(targetFieldName));
 
       SourceType = sourceType.FullName;
-      SourceField = sourceField;
+      SourceField = sourceFieldName;
       TargetType = targetType;
-      TargetField = targetField;
+      TargetField = targetFieldName;
     }
 
     /// <summary>
     /// Initializes a new instance of this class.
     /// </summary>
-    /// <param name="sourceType">Value for <see cref="SourceType"/>.</param>
-    /// <param name="field">Value for <see cref="SourceField"/> and <see cref="TargetField"/>.</param>
-    /// <param name="targetType">Value for <see cref="TargetType"/>.</param>
-    public CopyFieldHint(string sourceType, string field, Type targetType)
-      : this(sourceType, field, targetType, field)
+    /// <param name="sourceTypeName">The source type full name.</param>
+    /// <param name="fieldName">Field name in both source and target types.</param>
+    /// <param name="targetType">The target type.</param>
+    public CopyFieldHint(string sourceTypeName, string fieldName, Type targetType)
+      : this(sourceTypeName, fieldName, targetType, fieldName)
     {
     }
 
@@ -168,35 +160,35 @@ public static CopyFieldHint Create<TSource, TTarget>(
     /// Creates the instance of this hint.
     /// </summary>
     /// <typeparam name="TTarget">The target type.</typeparam>
-    /// <param name="sourceType">The source type.</param>
-    /// <param name="sourceField">The source field.</param>
+    /// <param name="sourceTypeName">Full name of source type.</param>
+    /// <param name="sourceFieldName">The source field name.</param>
     /// <param name="targetPropertyAccessExpression">The target field access expression.</param>
     /// <returns>The newly created instance of this hint.</returns>
     public static CopyFieldHint Create<TTarget>(
-      string sourceType, string sourceField,
+      string sourceTypeName, string sourceFieldName,
       Expression<Func<TTarget, object>> targetPropertyAccessExpression)
       where TTarget: Entity
     {
       return new CopyFieldHint(
-        sourceType, sourceField, 
+        sourceTypeName, sourceFieldName, 
         typeof(TTarget), targetPropertyAccessExpression.GetProperty().Name);
     }
 
     /// <summary>
     /// Creates the instance of this hint.
     /// </summary>
     /// <typeparam name="TTarget">The target type.</typeparam>
-    /// <param name="sourceType">The source type.</param>
+    /// <param name="sourceTypeName">Full name of source type.</param>
     /// <param name="targetPropertyAccessExpression">The target field access expression.</param>
     /// <returns>The newly created instance of this hint.</returns>
     public static CopyFieldHint Create<TTarget>(
-      string sourceType,
+      string sourceTypeName,
       Expression<Func<TTarget, object>> targetPropertyAccessExpression)
       where TTarget: Entity
     {
       var targetField = targetPropertyAccessExpression.GetProperty().Name;
       return new CopyFieldHint(
-        sourceType, targetField, 
+        sourceTypeName, targetField, 
         typeof(TTarget), targetField);
     }
   }

Orm/Xtensive.Orm/Orm/Upgrade/Hints/MergeTypeHint.cs

@@ -1,6 +1,6 @@
-// Copyright (C) 2003-2010 Xtensive LLC.
-// All rights reserved.
-// For conditions of distribution and use, see license.
+// Copyright (C) 2009-2024 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
 // Created by: Alex Kofman
 // Created:    2009.04.29
 
@@ -20,8 +20,6 @@ namespace Xtensive.Orm.Upgrade
   public sealed class MergeTypeHint : UpgradeHint,
     IEquatable<MergeTypeHint>
   {
-    private const string ToStringFormat = "Merge type: {0} -> {1}";
-
     /// <summary>
     /// Gets the new type.
     /// </summary>
@@ -39,33 +37,28 @@ public bool Equals(MergeTypeHint other)
         return false;
       if (ReferenceEquals(this, other))
         return true;
-      return base.Equals(other) 
-        && other.NewType==NewType
-        && other.OldType==OldType;
+      return base.Equals(other)
+        && other.NewType == NewType
+        && other.OldType == OldType;
     }
 
     /// <inheritdoc/>
-    public override bool Equals(UpgradeHint other)
-    {
-      return Equals(other as MergeTypeHint);
-    }
+    public override bool Equals(UpgradeHint other) => Equals(other as MergeTypeHint);
 
     /// <inheritdoc/>
     public override int GetHashCode()
     {
       unchecked {
         int result = base.GetHashCode();
-        result = (result * 397) ^ (NewType!=null ? NewType.GetHashCode() : 0);
-        result = (result * 397) ^ (OldType!=null ? OldType.GetHashCode() : 0);
+        result = (result * 397) ^ (NewType != null ? NewType.GetHashCode() : 0);
+        result = (result * 397) ^ (OldType != null ? OldType.GetHashCode() : 0);
         return result;
       }
     }
 
     /// <inheritdoc/>
-    public override string ToString()
-    {
-      return string.Format(ToStringFormat, OldType.GetFullName(), NewType.GetFullName());
-    }
+    public override string ToString() =>
+      $"Merge type: {OldType.GetFullName()} -> {NewType.GetFullName()}";
 
 
     // Constructors
@@ -77,8 +70,8 @@ public override string ToString()
     /// <param name="newType">The new type.</param>
     public MergeTypeHint(Type oldType, Type newType)
     {
-      ArgumentValidator.EnsureArgumentNotNull(newType, "newType");
-      ArgumentValidator.EnsureArgumentNotNull(oldType, "oldType");
+      ArgumentValidator.EnsureArgumentNotNull(newType, nameof(newType));
+      ArgumentValidator.EnsureArgumentNotNull(oldType, nameof(oldType));
 
       OldType = oldType;
       NewType = newType;