Add interfaces for settings

Author: pascalberger

src/Cake.Issues.Testing/FakeConfigurableIssueProvider.cs

@@ -48,7 +48,7 @@ public FakeConfigurableIssueProvider(
         /// <summary>
         /// Gets the repository settings.
         /// </summary>
-        public RepositorySettings RepositorySettings => this.Settings;
+        public IRepositorySettings RepositorySettings => this.Settings;
 
         /// <summary>
         /// Gets the issue provider settings.

src/Cake.Issues.Testing/FakeIssueProvider.cs

@@ -42,7 +42,7 @@ public FakeIssueProvider(ICakeLog log, IEnumerable<IIssue> issues)
         /// <summary>
         /// Gets the settings.
         /// </summary>
-        public new RepositorySettings Settings => base.Settings;
+        public new IRepositorySettings Settings => base.Settings;
 
         /// <inheritdoc/>
         public override string ProviderName => "Fake Issue Provider";

src/Cake.Issues.Testing/FakeLogFileFormat.cs

@@ -42,7 +42,7 @@ public FakeLogFileFormat(ICakeLog log, IEnumerable<IIssue> issues)
         /// <inheritdoc/>
         public override IEnumerable<IIssue> ReadIssues(
             FakeMultiFormatIssueProvider issueProvider,
-            RepositorySettings repositorySettings,
+            IRepositorySettings repositorySettings,
             FakeMultiFormatIssueProviderSettings issueProviderSettings)
         {
             return this.issues;

src/Cake.Issues.Testing/FakeMultiFormatIssueProvider.cs

@@ -26,7 +26,7 @@ public FakeMultiFormatIssueProvider(ICakeLog log, FakeMultiFormatIssueProviderSe
         /// <summary>
         /// Gets the repository settings.
         /// </summary>
-        public RepositorySettings RepositorySettings => this.Settings;
+        public IRepositorySettings RepositorySettings => this.Settings;
 
         /// <summary>
         /// Gets the issue provider settings.

src/Cake.Issues/Aliases.ReadIssues.cs

@@ -121,7 +121,7 @@ public static IEnumerable<IIssue> ReadIssues(
         public static IEnumerable<IIssue> ReadIssues(
             this ICakeContext context,
             IIssueProvider issueProvider,
-            ReadIssuesSettings settings)
+            IReadIssuesSettings settings)
         {
             context.NotNull(nameof(context));
             issueProvider.NotNull(nameof(issueProvider));
@@ -170,7 +170,7 @@ public static IEnumerable<IIssue> ReadIssues(
         public static IEnumerable<IIssue> ReadIssues(
             this ICakeContext context,
             IEnumerable<IIssueProvider> issueProviders,
-            ReadIssuesSettings settings)
+            IReadIssuesSettings settings)
         {
             context.NotNull(nameof(context));
             settings.NotNull(nameof(settings));

src/Cake.Issues/BaseIssueComponent.cs

@@ -8,7 +8,7 @@
     /// </summary>
     /// <typeparam name="T">Type of settings.</typeparam>
     public abstract class BaseIssueComponent<T> : IBaseIssueComponent<T>
-        where T : RepositorySettings
+        where T : class, IRepositorySettings
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="BaseIssueComponent{T}"/> class.

src/Cake.Issues/BaseIssueProvider.cs

@@ -6,7 +6,7 @@
     /// <summary>
     /// Base class for all issue provider implementations.
     /// </summary>
-    public abstract class BaseIssueProvider : BaseIssueComponent<RepositorySettings>, IIssueProvider
+    public abstract class BaseIssueProvider : BaseIssueComponent<IRepositorySettings>, IIssueProvider
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="BaseIssueProvider"/> class.

src/Cake.Issues/BaseLogFileFormat.cs

@@ -31,7 +31,7 @@ protected BaseLogFileFormat(ICakeLog log)
         /// <inheritdoc/>
         public abstract IEnumerable<IIssue> ReadIssues(
             TIssueProvider issueProvider,
-            RepositorySettings repositorySettings,
+            IRepositorySettings repositorySettings,
             TSettings issueProviderSettings);
     }
 }

src/Cake.Issues/IBaseIssueComponent.cs

@@ -7,7 +7,7 @@
     /// </summary>
     /// <typeparam name="T">Type of settings.</typeparam>
     public interface IBaseIssueComponent<in T>
-        where T : RepositorySettings
+        where T : IRepositorySettings
     {
         /// <summary>
         /// Initializes the component.

src/Cake.Issues/IIssueProvider.cs

@@ -5,7 +5,7 @@
     /// <summary>
     /// Interface describing a provider for issues.
     /// </summary>
-    public interface IIssueProvider : IBaseIssueComponent<RepositorySettings>
+    public interface IIssueProvider : IBaseIssueComponent<IRepositorySettings>
     {
         /// <summary>
         /// Gets the human friendly name of the issue provider.

src/Cake.Issues/ILogFileFormat.cs

@@ -20,7 +20,7 @@ public interface ILogFileFormat<TIssueProvider, TSettings>
         /// <returns>List of issues.</returns>
         IEnumerable<IIssue> ReadIssues(
             TIssueProvider issueProvider,
-            RepositorySettings repositorySettings,
+            IRepositorySettings repositorySettings,
             TSettings issueProviderSettings);
     }
 }

src/Cake.Issues/IReadIssuesSettings.cs

@@ -0,0 +1,15 @@
+namespace Cake.Issues
+{
+    using Cake.Core.IO;
+
+    /// <summary>
+    /// Interface for settings for reading issues.
+    /// </summary>
+    public interface IReadIssuesSettings : IRepositorySettings
+    {
+        /// <summary>
+        /// Gets or sets the name of the run.
+        /// </summary>
+        string Run { get; set; }
+    }
+}

src/Cake.Issues/IRepositorySettings.cs

@@ -0,0 +1,15 @@
+namespace Cake.Issues
+{
+    using Cake.Core.IO;
+
+    /// <summary>
+    /// Interface for settings containing a path to a repository.
+    /// </summary>
+    public interface IRepositorySettings
+    {
+        /// <summary>
+        /// Gets the Root path of the repository.
+        /// </summary>
+        DirectoryPath RepositoryRoot { get; }
+    }
+}

src/Cake.Issues/IssuesReader.cs

@@ -11,7 +11,7 @@ public class IssuesReader
     {
         private readonly ICakeLog log;
         private readonly List<IIssueProvider> issueProviders = new List<IIssueProvider>();
-        private readonly ReadIssuesSettings settings;
+        private readonly IReadIssuesSettings settings;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="IssuesReader"/> class.
@@ -22,7 +22,7 @@ public class IssuesReader
         public IssuesReader(
             ICakeLog log,
             IEnumerable<IIssueProvider> issueProviders,
-            ReadIssuesSettings settings)
+            IReadIssuesSettings settings)
         {
             log.NotNull(nameof(log));
             settings.NotNull(nameof(settings));

src/Cake.Issues/ReadIssuesSettings.cs

@@ -5,7 +5,7 @@
     /// <summary>
     /// Settings for reading issues.
     /// </summary>
-    public class ReadIssuesSettings : RepositorySettings
+    public class ReadIssuesSettings : RepositorySettings, IReadIssuesSettings
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="ReadIssuesSettings"/> class.

src/Cake.Issues/RepositorySettings.cs

@@ -5,7 +5,7 @@
     /// <summary>
     /// Settings containing a path to a repository.
     /// </summary>
-    public class RepositorySettings
+    public class RepositorySettings : IRepositorySettings
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="RepositorySettings"/> class.