Merge pull request #42 from cake-contrib/feature/alias-split

Split aliases into partial classes

src/Cake.Issues/Aliases.NewIssue.cs

@@ -0,0 +1,50 @@
+namespace Cake.Issues
+{
+    using Core;
+    using Core.Annotations;
+
+    /// <content>
+    /// Contains functionality related to creating issues.
+    /// </content>
+    public static partial class Aliases
+    {
+        /// <summary>
+        /// Initiates the creation of a new <see cref="IIssue"/>.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="message">The message of the issue.</param>
+        /// <param name="providerType">The unique identifier of the issue provider.</param>
+        /// <param name="providerName">The human friendly name of the issue provider.</param>
+        /// <returns>Builder class for creating a new <see cref="IIssue"/>.</returns>
+        /// <example>
+        /// <para>Create a new warning for the myfile.txt file on line 42:</para>
+        /// <code>
+        /// <![CDATA[
+        ///     var issue =
+        ///         NewIssue(
+        ///             "Something went wrong",
+        ///             "MyCakeScript",
+        ///             "My Cake Script")
+        ///             .InFile("myfile.txt", 42)
+        ///             .WithPriority(IssuePriority.Warning)
+        ///             .Create();
+        /// ]]>
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        [CakeAliasCategory(IssuesAliasConstants.CreateCakeAliasCategory)]
+        public static IssueBuilder NewIssue(
+            this ICakeContext context,
+            string message,
+            string providerType,
+            string providerName)
+        {
+            context.NotNull(nameof(context));
+            message.NotNullOrWhiteSpace(nameof(message));
+            providerType.NotNullOrWhiteSpace(nameof(providerType));
+            providerName.NotNullOrWhiteSpace(nameof(providerName));
+
+            return IssueBuilder.NewIssue(message, providerType, providerName);
+        }
+    }
+}

src/Cake.Issues/Aliases.ReadIssues.cs

@@ -0,0 +1,188 @@
+namespace Cake.Issues
+{
+    using System.Collections.Generic;
+    using Core;
+    using Core.Annotations;
+    using Core.IO;
+
+    /// <content>
+    /// Contains functionality related to reading issues.
+    /// </content>
+    public static partial class Aliases
+    {
+        /// <summary>
+        /// Reads issues from a single issue provider.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="issueProvider">The provider for issues.</param>
+        /// <param name="repositoryRoot">Root path of the repository.</param>
+        /// <returns>Issues reported by issue provider.</returns>
+        /// <example>
+        /// <para>Read issues reported by JetBrains inspect code:</para>
+        /// <code>
+        /// <![CDATA[
+        ///     var issues =
+        ///         ReadIssues(
+        ///             InspectCodeIssuesFromFilePath(
+        ///                 @"C:\build\inspectcode.log"),
+        ///             @"c:\repo"));
+        /// ]]>
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        [CakeAliasCategory(IssuesAliasConstants.ReadCakeAliasCategory)]
+        public static IEnumerable<IIssue> ReadIssues(
+            this ICakeContext context,
+            IIssueProvider issueProvider,
+            DirectoryPath repositoryRoot)
+        {
+            context.NotNull(nameof(context));
+            issueProvider.NotNull(nameof(issueProvider));
+            repositoryRoot.NotNull(nameof(repositoryRoot));
+
+            return
+                context.ReadIssues(
+                    issueProvider,
+                    new ReadIssuesSettings(repositoryRoot));
+        }
+
+        /// <summary>
+        /// Reads issues from issue providers.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="issueProviders">The list of provider for issues.</param>
+        /// <param name="repositoryRoot">Root path of the repository.</param>
+        /// <returns>Issues reported by all issue providers.</returns>
+        /// <example>
+        /// <para>Read issues reported as MsBuild warnings and issues reported by JetBrains inspect code:</para>
+        /// <code>
+        /// <![CDATA[
+        ///     var issues =
+        ///         ReadIssues(
+        ///             new List<IIssueProvider>
+        ///             {
+        ///                 MsBuildIssuesFromFilePath(
+        ///                     @"C:\build\msbuild.log",
+        ///                     MsBuildXmlFileLoggerFormat),
+        ///                 InspectCodeIssuesFromFilePath(
+        ///                     @"C:\build\inspectcode.log")
+        ///             },
+        ///             @"c:\repo"));
+        /// ]]>
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        [CakeAliasCategory(IssuesAliasConstants.ReadCakeAliasCategory)]
+        public static IEnumerable<IIssue> ReadIssues(
+            this ICakeContext context,
+            IEnumerable<IIssueProvider> issueProviders,
+            DirectoryPath repositoryRoot)
+        {
+            context.NotNull(nameof(context));
+            repositoryRoot.NotNull(nameof(repositoryRoot));
+
+            // ReSharper disable once PossibleMultipleEnumeration
+            issueProviders.NotNullOrEmptyOrEmptyElement(nameof(issueProviders));
+
+            // ReSharper disable once PossibleMultipleEnumeration
+            return
+                context.ReadIssues(
+                    issueProviders,
+                    new ReadIssuesSettings(repositoryRoot));
+        }
+
+        /// <summary>
+        /// Reads issues from a single issue provider using the specified settings.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="issueProvider">The provider for issues.</param>
+        /// <param name="settings">The settings.</param>
+        /// <returns>Issues reported by issue provider.</returns>
+        /// <example>
+        /// <para>Read issues reported by JetBrains inspect code and format comments in Markdown:</para>
+        /// <code>
+        /// <![CDATA[
+        ///     var settings =
+        ///         new ReadIssuesSettings(@"c:\repo")
+        ///         {
+        ///             Format = IssueCommentFormat.Markdown
+        ///         };
+        ///
+        ///     var issues =
+        ///         ReadIssues(
+        ///             InspectCodeIssuesFromFilePath(
+        ///                 @"C:\build\inspectcode.log"),
+        ///             settings));
+        /// ]]>
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        [CakeAliasCategory(IssuesAliasConstants.ReadCakeAliasCategory)]
+        public static IEnumerable<IIssue> ReadIssues(
+            this ICakeContext context,
+            IIssueProvider issueProvider,
+            ReadIssuesSettings settings)
+        {
+            context.NotNull(nameof(context));
+            issueProvider.NotNull(nameof(issueProvider));
+            settings.NotNull(nameof(settings));
+
+            return
+                context.ReadIssues(
+                    new List<IIssueProvider> { issueProvider },
+                    settings);
+        }
+
+        /// <summary>
+        /// Reads issues from issue providers using the specified settings.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="issueProviders">The list of provider for issues.</param>
+        /// <param name="settings">The settings.</param>
+        /// <returns>Issues reported by all issue providers.</returns>
+        /// <example>
+        /// <para>Read issues reported as MsBuild warnings and issues reported by JetBrains inspect code
+        /// with comments formatted as Markdown:</para>
+        /// <code>
+        /// <![CDATA[
+        ///     var settings =
+        ///         new ReadIssuesSettings(@"c:\repo")
+        ///         {
+        ///             Format = IssueCommentFormat.Markdown
+        ///         };
+        ///
+        ///     var issues =
+        ///         ReadIssues(
+        ///             new List<IIssueProvider>
+        ///             {
+        ///                 MsBuildIssuesFromFilePath(
+        ///                     @"C:\build\msbuild.log",
+        ///                     MsBuildXmlFileLoggerFormat),
+        ///                 InspectCodeIssuesFromFilePath(
+        ///                     @"C:\build\inspectcode.log")
+        ///             },
+        ///             settings));
+        /// ]]>
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        [CakeAliasCategory(IssuesAliasConstants.ReadCakeAliasCategory)]
+        public static IEnumerable<IIssue> ReadIssues(
+            this ICakeContext context,
+            IEnumerable<IIssueProvider> issueProviders,
+            ReadIssuesSettings settings)
+        {
+            context.NotNull(nameof(context));
+            settings.NotNull(nameof(settings));
+
+            // ReSharper disable once PossibleMultipleEnumeration
+            issueProviders.NotNullOrEmptyOrEmptyElement(nameof(issueProviders));
+
+            // ReSharper disable once PossibleMultipleEnumeration
+            var issuesReader =
+                new IssuesReader(context.Log, issueProviders, settings);
+
+            return issuesReader.ReadIssues(settings.Format);
+        }
+    }
+}