Draft of IPackagesConfig & IPackageInfo

MvsSln/Projects/IPackageInfo.cs

@@ -0,0 +1,51 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2013-2020  Denis Kuzmin < [email protected] > 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 IPackageInfo
+    {
+        /// <summary>
+        /// Package id.
+        /// </summary>
+        string Id { get; }
+
+        /// <summary>
+        /// Package version.
+        /// </summary>
+        string Version { get; }
+
+        /// <summary>
+        /// Some related package meta information.
+        /// Eg.:
+        /// * targetFramework="net472"
+        /// * output="vsSolutionBuildEvent"
+        /// ...
+        /// </summary>
+        IDictionary<string, string> Meta { get; }
+    }
+}

MvsSln/Projects/IPackagesConfig.cs

@@ -0,0 +1,179 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2013-2020  Denis Kuzmin < [email protected] > 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.IO;
+using System.Security;
+
+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>
+        /// <returns></returns>
+        IPackageInfo GetPackage(string id);
+
+        /// <summary>
+        /// Commit changes made by adding/updating/removing.
+        /// </summary>
+        void Commit();
+
+        /// <summary>
+        /// Roll back changes made by adding/updating/removing.
+        /// </summary>
+        void Rollback();
+
+        /// <summary>
+        /// Load existing storage or create a new one for any failure.
+        /// Use <see cref="Load"/> for other behavior.
+        /// Use <see cref="IsNew"/> to check the actual state.
+        /// </summary>
+        /// <param name="path">Path to storage.</param>
+        /// <returns>Chain on itself.</returns>
+        IPackagesConfig LoadOrNew(string path);
+
+        /// <summary>
+        /// Load existing storage. Will throw related exceptions for any failure.
+        /// Use <see cref="LoadOrNew"/> for other behavior.
+        /// </summary>
+        /// <param name="path">Path to storage.</param>
+        /// <returns>Chain on itself.</returns>
+        /// <exception cref="SecurityException"/>
+        /// <exception cref="ArgumentException"/>
+        /// <exception cref="FileNotFoundException"/>
+        /// <exception cref="ArgumentNullException"/>
+        /// <exception cref="UriFormatException"/>
+        IPackagesConfig Load(string path);
+
+        /// <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`</param>
+        /// <returns>True, if the package has been successfully added.</returns>
+        bool AddPackage(string id, string version, string targetFramework);
+
+        /// <summary>
+        /// Add package or Update an existing.
+        /// </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`</param>
+        /// <returns>True, if the package has been added. False, if the package has been updated.</returns>
+        bool AddOrUpdatePackage(string id, string version, string targetFramework);
+
+        /// <summary>
+        /// Update an existing package.
+        /// </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`</param>
+        /// <returns>True, if the package has been successfully updated. False, if the package does not exist.</returns>
+        bool UpdatePackage(string id, string version, string targetFramework);
+
+        /// <summary>
+        /// Add GetNuTool compatible package.
+        /// https://github.com/3F/GetNuTool
+        /// </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>
+        bool AddGetNuToolPackage(string id, string version, string output = null);
+
+        /// <summary>
+        /// Add GetNuTool compatible package or Update an existing.
+        /// https://github.com/3F/GetNuTool
+        /// </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 added. False, if the package has been updated.</returns>
+        bool AddOrUpdateGetNuToolPackage(string id, string version, string output = null);
+
+        /// <summary>
+        /// Update an existing GetNuTool compatible package.
+        /// https://github.com/3F/GetNuTool
+        /// </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 updated. False, if the package does not exist.</returns>
+        bool UpdateGetNuToolPackage(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 pkg);
+
+        /// <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);
+    }
+}