ConfigItem.Format() marked as obsolete,

Use `ToString()` and `Formatted` instead.

+IConfPlatform.Formatted

Author: 3F

MvsSln/Core/ConfigItem.cs

@@ -24,83 +24,40 @@
 */
 
 using System;
-using System.Diagnostics;
 using net.r_eg.MvsSln.Extensions;
 
 namespace net.r_eg.MvsSln.Core
 {
     /// <summary>
-    /// Basic item of configuration and platform.
+    /// Basic item of the configuration and its platform.
     /// </summary>
-    [DebuggerDisplay("{DbgDisplay}")]
     public class ConfigItem: IConfPlatform
     {
-        /// <summary>
-        /// The custom rule of the Configuration and Platform names.
-        /// </summary>
-        public IRuleOfConfig Rule
-        {
-            get;
-            set;
-        } = new RuleOfConfig();
+        protected const char DELIM = '|';
 
-        /// <summary>
-        /// To use an `Sensitivity` logic when comparing {IConfPlatform}
-        /// together with `==` , `!=`.
-        /// </summary>
-        public bool SensitivityComparing
-        {
-            get;
-            set;
-        } = true;
+        private string _fmt;
 
-        public string Configuration
-        {
-            get;
-            protected set;
-        }
+        public IRuleOfConfig Rule { get; protected set; }
+
+        public bool SensitivityComparing { get; set; } = true;
+
+        public string Configuration { get; protected set; }
 
         public string ConfigurationByRule
         {
-            get => Rule?.Configuration(Configuration);
+            get => Rule?.Configuration(Configuration) ?? Configuration;
         }
 
-        /// <summary>
-        /// {ConfigurationByRule} with optional case insensitive logic.
-        /// Uses {SensitivityComparing} flag.
-        /// </summary>
-        public string ConfigurationByRuleICase
-        {
-            get => Sensitivity(ConfigurationByRule);
-        }
+        public string ConfigurationByRuleICase => Sensitivity(ConfigurationByRule);
 
-        public string Platform
-        {
-            get;
-            protected set;
-        }
+        public string Platform { get; protected set; }
 
-        public string PlatformByRule
-        {
-            get => Rule?.Platform(Platform);
-        }
+        public string PlatformByRule => Rule?.Platform(Platform) ?? Platform;
 
-        /// <summary>
-        /// {PlatformByRule} with optional case insensitive logic.
-        /// Uses {SensitivityComparing} flag.
-        /// </summary>
-        public string PlatformByRuleICase
-        {
-            get => Sensitivity(PlatformByRule);
-        }
+        public string PlatformByRuleICase => Sensitivity(PlatformByRule);
+
+        public string Formatted => _fmt ??= Format(ConfigurationByRule, PlatformByRule);
 
-        /// <summary>
-        /// Checking an config/platform by using {Rule} instance.
-        /// </summary>
-        /// <param name="config">Configuration name.</param>
-        /// <param name="platform">Platform name.</param>
-        /// <param name="icase">Case insensitive flag.</param>
-        /// <returns></returns>
         public bool IsEqualByRule(string config, string platform, bool icase = false)
         {
             var cmp = icase ? StringComparison.InvariantCultureIgnoreCase 
@@ -136,64 +93,103 @@ public override int GetHashCode()
             return 0.CalculateHashCode
             (
                 Configuration,
-                Platform
+                Platform,
+                Rule,
+                SensitivityComparing
             );
         }
 
-        public override string ToString()
-        {
-            return Format();
-        }
+        public override string ToString() => Format(Configuration, Platform);
 
         /// <summary>
         /// Compatible format: 'configname'|'platformname'
         /// http://msdn.microsoft.com/en-us/library/microsoft.visualstudio.shell.interop.ivscfg.get_displayname.aspx
         /// </summary>
         public static string Format(string configuration, string platform)
         {
-            return $"{configuration}|{platform}";
+            return $"{configuration}{DELIM}{platform}";
         }
 
-        public string Format()
+        [Obsolete("Use `ToString()` and `Formatted` instead.")]
+        public string Format() => ToString();
+
+        /// <summary>
+        /// Initialize using custom rule.
+        /// </summary>
+        /// <param name="rule">Custom rule. Use null to disable it.</param>
+        /// <param name="configuration">Configuration name.</param>
+        /// <param name="platform">Platform name.</param>
+        public ConfigItem(IRuleOfConfig rule, string configuration, string platform)
         {
-            return Format(Configuration, Platform);
+            Rule            = rule;
+            Configuration   = configuration;
+            Platform        = platform;
         }
 
+        /// <summary>
+        /// Initialize using rule <see cref="RuleOfConfig"/> by default.
+        /// </summary>
+        /// <inheritdoc cref="ConfigItem(IRuleOfConfig, string, string)"/>
         public ConfigItem(string configuration, string platform)
+            : this(new RuleOfConfig(), configuration, platform)
         {
-            Configuration   = configuration;
-            Platform        = platform;
+
         }
 
+        /// <summary>
+        /// Initialize using rule <see cref="RuleOfConfig"/> by default.
+        /// </summary>
+        /// <inheritdoc cref="ConfigItem(IRuleOfConfig, string)"/>
         public ConfigItem(string formatted)
+            : this(new RuleOfConfig(), formatted)
         {
-            if(formatted == null) {
-                return;
-            }
 
-            string[] cfg = formatted.Split('|');
+        }
 
-            Configuration = cfg[0];
+        /// <summary>
+        /// Initialize using custom rule.
+        /// </summary>
+        /// <param name="rule">Custom rule. Use null to disable it.</param>
+        /// <param name="formatted">Raw formatted string.</param>
+        public ConfigItem(IRuleOfConfig rule, string formatted)
+            : this
+            (
+                rule, 
+                ExtractName(formatted, out int delimiter), 
+                ExtractPlatform(formatted, delimiter)
+            )
+        {
 
-            // < 2 https://github.com/3F/MvsSln/issues/19
-            Platform = cfg.Length < 2 ? string.Empty : cfg[1];
         }
 
         protected virtual string Sensitivity(string name)
         {
             if(!SensitivityComparing) {
                 return name;
             }
-            return name.ToLowerInvariant();
+            return name?.ToLowerInvariant();
         }
 
-        #region DebuggerDisplay
-
-        private string DbgDisplay
+        private static string ExtractName(string raw, out int delimiter)
         {
-            get => Format();
+            if(raw == null)
+            {
+                delimiter = -1;
+                return null;
+            }
+
+            delimiter = raw.IndexOf(DELIM);
+            if(delimiter == -1) return raw;
+
+            return raw.Substring(0, delimiter);
         }
 
-        #endregion
+        private static string ExtractPlatform(string raw, int delimiter)
+        {
+            if(raw == null) return null;
+            if(delimiter == -1) return string.Empty;
+
+            return raw.Substring(delimiter + 1);
+        }
     }
 }

MvsSln/Core/ConfigPrj.cs

@@ -105,9 +105,10 @@ private void Set(string pGuid, bool build, bool deploy, ConfigSln sln)
 
         #region DebuggerDisplay
 
+        [DebuggerBrowsable(DebuggerBrowsableState.Never)]
         private string DbgDisplay
         {
-            get => $"{Format()} -> {Sln} : [{PGuid}]";
+            get => $"{ToString()} -> {Sln} : [{PGuid}]";
         }
 
         #endregion

MvsSln/Core/ConfigSln.cs

@@ -23,14 +23,11 @@
  * THE SOFTWARE.
 */
 
-using System.Diagnostics;
-
 namespace net.r_eg.MvsSln.Core
 {
     /// <summary>
     /// Solution Configuration
     /// </summary>
-    [DebuggerDisplay("{DbgDisplay}")]
     public class ConfigSln: ConfigItem, IConfPlatform
     {
         public ConfigSln(string configuration, string platform)
@@ -44,14 +41,5 @@ public ConfigSln(string formatted)
         {
 
         }
-
-        #region DebuggerDisplay
-
-        private string DbgDisplay
-        {
-            get => Format();
-        }
-
-        #endregion
     }
 }

MvsSln/Core/IConfPlatform.cs

@@ -28,38 +28,56 @@ namespace net.r_eg.MvsSln.Core
     public interface IConfPlatform
     {
         /// <summary>
-        /// The custom rule of the Configuration and Platform names.
+        /// Configured rule of the <see cref="Configuration"/> and <see cref="Platform"/> representations.
         /// </summary>
         IRuleOfConfig Rule { get; }
 
         /// <summary>
-        /// To use an `Sensitivity` logic when comparing {IConfPlatform}
+        /// Use "sensitivity" logic when comparing <see cref="IConfPlatform"/>
         /// together with `==` , `!=`.
         /// </summary>
         bool SensitivityComparing { get; set; }
 
+        /// <summary>
+        /// Configuration name.
+        /// </summary>
         string Configuration { get; }
 
+        /// <summary>
+        /// Configuration name using <see cref="Rule"/>.
+        /// </summary>
         string ConfigurationByRule { get; }
 
         /// <summary>
-        /// {ConfigurationByRule} with optional case insensitive logic.
-        /// Uses {SensitivityComparing} flag.
+        /// <see cref="ConfigurationByRule"/> with optional case insensitive logic.
         /// </summary>
+        /// <remarks>Uses <see cref="SensitivityComparing"/> flag.</remarks>
         string ConfigurationByRuleICase { get; }
 
+        /// <summary>
+        /// Platform name.
+        /// </summary>
         string Platform { get; }
 
+        /// <summary>
+        /// Platform name using <see cref="Rule"/>.
+        /// </summary>
         string PlatformByRule { get; }
 
         /// <summary>
-        /// {PlatformByRule} with optional case insensitive logic.
-        /// Uses {SensitivityComparing} flag.
+        /// <see cref="PlatformByRule"/> with optional case insensitive logic.
+        /// Uses <see cref="SensitivityComparing"/> flag.
         /// </summary>
         string PlatformByRuleICase { get; }
 
         /// <summary>
-        /// Checking an config/platform by using {Rule} instance.
+        /// Formatted final configuration.
+        /// </summary>
+        /// <remarks>Using <see cref="Rule"/>.</remarks>
+        string Formatted { get; }
+
+        /// <summary>
+        /// Checking an config/platform by using <see cref="Rule"/> instance.
         /// </summary>
         /// <param name="config">Configuration name.</param>
         /// <param name="platform">Platform name.</param>

MvsSlnTest/Core/ConfigItemTest.cs

@@ -40,7 +40,10 @@ public void EqTest2()
 
             var target3 = new ConfigItem("Config1", "Platform1");
             Assert.Equal("Config1|Platform1", target3.ToString());
+
+#pragma warning disable CS0618 // Type or member is obsolete
             Assert.Equal("Config1|Platform1", target3.Format());
+#pragma warning restore CS0618 // Type or member is obsolete
         }
 
         [Fact]
@@ -104,7 +107,7 @@ public void NoPlatformTest1()
         [Fact]
         public void CtorTest1()
         {
-            var target = new ConfigItem("");
+            var target = new ConfigItem(string.Empty);
 
             Assert.Equal(string.Empty, target.Configuration);
             Assert.Equal(string.Empty, target.Platform);
@@ -119,5 +122,44 @@ public void CtorTest1()
             Assert.Null(target.Configuration);
             Assert.Null(target.Platform);
         }
+
+        [Fact]
+        public void FormatTest1()
+        {
+            string input   = "Debug|Any CPU";
+            string rulemod = "Debug|AnyCPU";
+
+            Assert.Equal(input, new ConfigItem(input).ToString());
+            Assert.Equal(input, new ConfigItem((IRuleOfConfig)null, input).ToString());
+
+#pragma warning disable CS0618 // Type or member is obsolete
+            Assert.Equal(input, new ConfigItem(input).Format());
+            Assert.Equal(input, new ConfigItem((IRuleOfConfig)null, input).Format());
+#pragma warning restore CS0618 // Type or member is obsolete
+
+            Assert.Equal(rulemod, new ConfigItem(input).Formatted);
+            Assert.Equal(input, new ConfigItem((IRuleOfConfig)null, input).Formatted);
+        }
+
+        [Fact]
+        public void FormatTest2()
+        {
+            string name     = "Debug";
+            string platform = "Any CPU";
+
+            string res1 = "Debug|Any CPU";
+            string res2 = "Debug|AnyCPU";
+
+            Assert.Equal(res1, new ConfigItem(name, platform).ToString());
+            Assert.Equal(res1, new ConfigItem(null, name, platform).ToString());
+
+#pragma warning disable CS0618 // Type or member is obsolete
+            Assert.Equal(res1, new ConfigItem(name, platform).Format());
+            Assert.Equal(res1, new ConfigItem(null, name, platform).Format());
+#pragma warning restore CS0618 // Type or member is obsolete
+
+            Assert.Equal(res2, new ConfigItem(name, platform).Formatted);
+            Assert.Equal(res1, new ConfigItem(null, name, platform).Formatted);
+        }
     }
 }