Adds related features for working with the packages.config file (#30)

* Draft of IPackagesConfig & IPackageInfo

* Updated license header

* Implemented IPackageInfo + IPackagesConfig. PR #30

Not yet fully tested

* +IPackageInfo.MetaTFM/MetaOutput aliases and completed tests

MvsSln/Projects/IPackageInfo.cs

@@ -0,0 +1,76 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2013-2021  Denis Kuzmin <x-3F@outlook.com> github/3F
+ * Copyright (c) MvsSln contributors https://github.com/3F/MvsSln/graphs/contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+*/
+
+using System;
+using System.Collections.Generic;
+
+namespace net.r_eg.MvsSln.Projects
+{
+    public interface IPackageInfo
+    {
+        /// <summary>
+        /// Package id.
+        /// </summary>
+        string Id { get; }
+
+        /// <summary>
+        /// Package version.
+        /// </summary>
+        string Version { get; }
+
+        /// <summary>
+        /// One-time parsed <see cref="Version"/> on the first access.
+        /// </summary>
+        Version VersionParsed { get; }
+
+        /// <summary>
+        /// Some related package meta information.
+        /// Eg.:
+        /// * targetFramework="net472"
+        /// * output="vsSolutionBuildEvent"
+        /// ...
+        /// </summary>
+        IDictionary<string, string> Meta { get; }
+
+        /// <summary>
+        /// Try get "targetFramework" value from <see cref="Meta"/> information.
+        /// It must return <see langword="null"/> if attribute is not defined.
+        /// </summary>
+        /// <remarks>Alias to <see cref="Meta"/> accessing.</remarks>
+        string MetaTFM { get; }
+
+        /// <summary>
+        /// Try get "output" value from <see cref="Meta"/> information.
+        /// It must return <see langword="null"/> if attribute is not defined.
+        /// </summary>
+        /// <remarks>Alias to <see cref="Meta"/> accessing.</remarks>
+        string MetaOutput { get; }
+
+        /// <summary>
+        /// Remove current package from storage.
+        /// </summary>
+        IPackagesConfig Remove();
+    }
+}

MvsSln/Projects/IPackagesConfig.cs

@@ -0,0 +1,145 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2013-2021  Denis Kuzmin <x-3F@outlook.com> github/3F
+ * Copyright (c) MvsSln contributors https://github.com/3F/MvsSln/graphs/contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+*/
+
+using System.Collections.Generic;
+
+namespace net.r_eg.MvsSln.Projects
+{
+    public interface IPackagesConfig
+    {
+        /// <summary>
+        /// Use auto-commit for each adding/updating/removing.
+        /// </summary>
+        bool AutoCommit { get; set; }
+
+        /// <summary>
+        /// Flag of the new created storage.
+        /// </summary>
+        bool IsNew { get; }
+
+        /// <summary>
+        /// Get all packages from storage.
+        /// </summary>
+        IEnumerable<IPackageInfo> GetPackages();
+
+        /// <summary>
+        /// Get specific package by its id.
+        /// </summary>
+        /// <param name="id">Package id. Eg. "Conari"; "7z.Libs"; "regXwild"; "MvsSln"; "vsSolutionBuildEvent"; ...</param>
+        /// <param name="icase">Ignore case for id if true.</param>
+        /// <returns>null if not found.</returns>
+        IPackageInfo GetPackage(string id, bool icase = false);
+
+        /// <summary>
+        /// Commit changes made by adding/updating/removing.
+        /// </summary>
+        void Commit();
+
+        /// <summary>
+        /// Roll back changes made by adding/updating/removing if not yet committed.
+        /// </summary>
+        void Rollback();
+
+        /// <summary>
+        /// Add package by using <see cref="IPackageInfo"/> instance.
+        /// Package cannot be added if the same <see cref="IPackageInfo.Id"/> is already exists in active storage.
+        /// </summary>
+        /// <returns>True, if the package has been successfully added.</returns>
+        bool AddPackage(IPackageInfo package);
+
+        /// <summary>
+        /// Add package or Update an existing by using <see cref="IPackageInfo"/> instance.
+        /// </summary>
+        /// <returns>True, if the package has been added. False, if the package has been updated.</returns>
+        bool AddOrUpdatePackage(IPackageInfo package);
+
+        /// <summary>
+        /// Update an existing package by using <see cref="IPackageInfo"/> instance.
+        /// </summary>
+        /// <returns>True, if the package has been successfully updated. False, if the package does not exist.</returns>
+        bool UpdatePackage(IPackageInfo package);
+
+        /// <summary>
+        /// Add package.
+        /// Package cannot be added if the same <see cref="IPackageInfo.Id"/> is already exists in active storage.
+        /// </summary>
+        /// <param name="id"><see cref="IPackageInfo.Id"/></param>
+        /// <param name="version"><see cref="IPackageInfo.Version"/></param>
+        /// <param name="targetFramework"><see cref="IPackageInfo.Meta"/> information for `targetFramework`. Use null to set the default value.</param>
+        /// <returns>True, if the package has been successfully added.</returns>
+        bool AddPackage(string id, string version, string targetFramework = null);
+
+        /// <summary>
+        /// Add package or Update an existing.
+        /// </summary>
+        /// <returns>True, if the package has been added. False, if the package has been updated.</returns>
+        /// <inheritdoc cref="AddPackage(string, string, string)"/>
+        bool AddOrUpdatePackage(string id, string version, string targetFramework = null);
+
+        /// <summary>
+        /// Update an existing package.
+        /// </summary>
+        /// <returns>True, if the package has been successfully updated. False, if the package does not exist.</returns>
+        /// <inheritdoc cref="AddPackage(string, string, string)"/>
+        bool UpdatePackage(string id, string version, string targetFramework = null);
+
+        /// <summary>
+        /// Add GetNuTool compatible package.
+        /// </summary>
+        /// <param name="id"><see cref="IPackageInfo.Id"/></param>
+        /// <param name="version"><see cref="IPackageInfo.Version"/></param>
+        /// <param name="output"><see cref="IPackageInfo.Meta"/> information for `output` https://github.com/3F/GetNuTool#format-of-packages-list </param>
+        /// <returns>True, if the package has been successfully added.</returns>
+        /// <remarks>https://github.com/3F/GetNuTool</remarks>
+        bool AddGntPackage(string id, string version, string output = null);
+
+        /// <summary>
+        /// Add GetNuTool compatible package or Update an existing.
+        /// </summary>
+        /// <returns>True, if the package has been added. False, if the package has been updated.</returns>
+        /// <inheritdoc cref="AddGntPackage(string, string, string)"/>
+        bool AddOrUpdateGntPackage(string id, string version, string output = null);
+
+        /// <summary>
+        /// Update an existing GetNuTool compatible package.
+        /// </summary>
+        /// <returns>True, if the package has been successfully updated. False, if the package does not exist.</returns>
+        /// <inheritdoc cref="AddGntPackage(string, string, string)"/>
+        bool UpdateGntPackage(string id, string version, string output = null);
+
+        /// <summary>
+        /// Remove package by using <see cref="IPackageInfo"/> instance.
+        /// </summary>
+        /// <returns>True, if it was successfully deleted. False, if it does not exist.</returns>
+        bool RemovePackage(IPackageInfo package);
+
+        /// <summary>
+        /// Remove package.
+        /// </summary>
+        /// <param name="id"><see cref="IPackageInfo.Id"/></param>
+        /// <returns>True, if it was successfully deleted. False, if it does not exist.</returns>
+        bool RemovePackage(string id);
+    }
+}

MvsSln/Projects/PackageInfo.cs

@@ -0,0 +1,100 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2013-2021  Denis Kuzmin <x-3F@outlook.com> github/3F
+ * Copyright (c) MvsSln contributors https://github.com/3F/MvsSln/graphs/contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+*/
+
+using System;
+using System.Collections.Generic;
+using System.Xml.Linq;
+using net.r_eg.MvsSln.Extensions;
+
+namespace net.r_eg.MvsSln.Projects
+{
+    public sealed class PackageInfo: IPackageInfo
+    {
+        internal const string ATTR_ID    = "id";
+        internal const string ATTR_VER   = "version";
+        internal const string ATTR_TFM   = "targetFramework";
+        internal const string ATTR_OUT   = "output";
+
+        private readonly IPackagesConfig packagesConfig;
+        private readonly Lazy<Version> _lversion;
+
+        public string Id { get; }
+
+        public string Version { get; }
+
+        public Version VersionParsed => _lversion.Value;
+
+        public IDictionary<string, string> Meta { get; }
+
+        public string MetaTFM => Meta.GetOrDefault(ATTR_TFM);
+
+        public string MetaOutput => Meta.GetOrDefault(ATTR_OUT);
+
+        public IPackagesConfig Remove()
+        {
+            if(packagesConfig == null) throw new InvalidOperationException(nameof(PackageInfo) + "is not fully initialized.");
+
+            packagesConfig.RemovePackage(this);
+            return packagesConfig;
+        }
+
+        public PackageInfo(string id, string version, IDictionary<string, string> meta = null)
+        {
+            Id          = id ?? throw new ArgumentNullException(nameof(id));
+            Version     = version ?? throw new ArgumentNullException(nameof(version));
+            _lversion   = new Lazy<Version>(() => new(version));
+
+            Meta = meta;
+        }
+
+        public PackageInfo(XElement x)
+            : this(x?.Attribute(ATTR_ID).Value, x?.Attribute(ATTR_VER).Value)
+        {
+            Meta = new Dictionary<string, string>();
+            DefineAllMeta(x);
+        }
+
+        public PackageInfo(IPackagesConfig link, XElement x)
+            : this(x)
+        {
+            packagesConfig = link ?? throw new ArgumentNullException(nameof(link));
+        }
+
+        private void DefineAllMeta(XElement x)
+        {
+            SetMeta(ATTR_TFM, x);
+            SetMeta(ATTR_OUT, x);
+        }
+
+        private bool SetMeta(string name, XElement x)
+        {
+            XAttribute a = x.Attribute(name);
+            if(a == null) return false;
+
+            Meta[name] = a.Value;
+            return true;
+        }
+    }
+}