Replace method filtering by object (so it's easier to extend in the future)

Author: GeertvanHorrik

src/GitTools.IssueTrackers/GitTools.IssueTrackers.csproj

@@ -86,6 +86,7 @@
     <Compile Include="IssueTrackers\Interfaces\IIssueNumberExtractor.cs" />
     <Compile Include="IssueTrackers\Interfaces\IIssueTracker.cs" />
     <Compile Include="IssueTrackers\Interfaces\IIssueTrackerFactory.cs" />
+    <Compile Include="Models\IssueTrackerFilter.cs" />
     <Compile Include="Models\Version.cs" />
     <Compile Include="ModuleInitializer.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />

src/GitTools.IssueTrackers/IssueTrackers/GitHub/GitHubIssueTracker.cs

@@ -19,7 +19,7 @@ public GitHubIssueTracker(IIssueTrackerContext issueTrackerContext)
 
         }
 
-        public override IEnumerable<Issue> GetIssues(string filter = null, bool includeOpen = true, bool includeClosed = true, DateTimeOffset? since = null)
+        public override IEnumerable<Issue> GetIssues(IssueTrackerFilter filter)
         {
             var gitHubClient = new GitHubClient(new ProductHeaderValue("GitReleaseNotes"));
 
@@ -41,10 +41,10 @@ public override IEnumerable<Issue> GetIssues(string filter = null, bool includeO
             string repository;
             GetRepository(out organisation, out repository);
 
-            var repositoryIssueRequest = PrepareFilter(filter, includeOpen, includeClosed, since);
+            var repositoryIssueRequest = PrepareFilter(filter);
             var forRepository = gitHubClient.Issue.GetAllForRepository(organisation, repository, repositoryIssueRequest);
 
-            var readOnlyList = forRepository.Result.Where(i => i.ClosedAt > since);
+            var readOnlyList = forRepository.Result.Where(i => i.ClosedAt > filter.Since);
 
             //var userCache = new Dictionary<string, User>();
             //Func<User, string> getUserName = u =>
@@ -78,23 +78,23 @@ public override IEnumerable<Issue> GetIssues(string filter = null, bool includeO
             });
         }
 
-        private RepositoryIssueRequest PrepareFilter(string filter, bool includeOpen = true, bool includeClosed = true, DateTimeOffset? since = null)
+        private RepositoryIssueRequest PrepareFilter(IssueTrackerFilter filter)
         {
             var repositoryIssueRequest = new RepositoryIssueRequest
             {
                 Filter = IssueFilter.All,
-                Since = since,
+                Since = filter.Since,
             };
 
-            if (includeOpen && includeClosed)
+            if (filter.IncludeOpen && filter.IncludeClosed)
             {
                 repositoryIssueRequest.State = ItemState.All;
             }
-            else if (includeOpen)
+            else if (filter.IncludeOpen)
             {
                 repositoryIssueRequest.State = ItemState.Open;
             }
-            else if (includeClosed)
+            else if (filter.IncludeClosed)
             {
                 repositoryIssueRequest.State = ItemState.Closed;
             }

src/GitTools.IssueTrackers/IssueTrackers/Interfaces/IIssueTracker.cs

@@ -2,9 +2,10 @@
 {
     using System;
     using System.Collections.Generic;
+    using Octokit;
 
     public interface IIssueTracker
     {
-        IEnumerable<Issue> GetIssues(string filter = null, bool includeOpen = true, bool includeClosed = true, DateTimeOffset? since = null);
+        IEnumerable<Issue> GetIssues(IssueTrackerFilter filter);
     }
 }

src/GitTools.IssueTrackers/IssueTrackers/IssueTrackerBase.cs

@@ -12,6 +12,6 @@ public IssueTrackerBase(IIssueTrackerContext issueTrackerContext)
 
         protected IIssueTrackerContext IssueTrackerContext { get; private set; }
 
-        public abstract IEnumerable<Issue> GetIssues(string filter = null, bool includeOpen = true, bool includeClosed = true, DateTimeOffset? since = null);
+        public abstract IEnumerable<Issue> GetIssues(IssueTrackerFilter filter);
     }
 }

src/GitTools.IssueTrackers/IssueTrackers/Jira/JiraIssueTracker.cs

@@ -20,7 +20,7 @@ public JiraIssueTracker(IIssueTrackerContext issueTrackerContext)
         {
         }
 
-        public override IEnumerable<Issue> GetIssues(string filter = null, bool includeOpen = true, bool includeClosed = true, DateTimeOffset? since = null)
+        public override IEnumerable<Issue> GetIssues(IssueTrackerFilter filter)
         {
             Log.DebugFormat("Connecting to Jira server '{0}'", IssueTrackerContext.Server);
 
@@ -32,13 +32,13 @@ public override IEnumerable<Issue> GetIssues(string filter = null, bool includeO
             var openedStatuses = GetOpenedStatuses(jira);
             var closedStatuses = GetClosedStatuses(jira);
 
-            filter = PrepareFilter(filter, openedStatuses, closedStatuses, includeOpen, includeClosed, since);
+            var finalFilter = PrepareFilter(filter, openedStatuses, closedStatuses);
 
             var issues = new List<Issue>();
 
             Log.DebugFormat("Searching for issues using filter '{0}'", filter);
 
-            foreach (var issue in jira.GetIssuesFromJql(filter))
+            foreach (var issue in jira.GetIssuesFromJql(finalFilter))
             {
                 var gitIssue = new Issue(issue.Key.Value)
                 {
@@ -71,39 +71,35 @@ public override IEnumerable<Issue> GetIssues(string filter = null, bool includeO
             return issues;
         }
 
-        private string PrepareFilter(string filter, IEnumerable<IssueStatus> openedStatuses, IEnumerable<IssueStatus> closedStatuses, 
-            bool includeOpen = true, bool includeClosed = true, DateTimeOffset? since = null)
+        private string PrepareFilter(IssueTrackerFilter filter, IEnumerable<IssueStatus> openedStatuses, IEnumerable<IssueStatus> closedStatuses)
         {
-            if (string.IsNullOrWhiteSpace(filter))
+            var finalFilter = string.Empty;
+            if (!string.IsNullOrWhiteSpace(filter.Filter))
             {
-                filter = "";
-            }
-            else
-            {
-                filter += " AND ";
+                finalFilter = filter.Filter + " AND ";
             }
 
-            if (includeOpen && includeClosed)
+            if (filter.IncludeOpen && filter.IncludeClosed)
             {
                 // no need to filter anything
             }
 
-            if (!includeOpen && !includeClosed)
+            if (!filter.IncludeOpen && !filter.IncludeClosed)
             {
                 throw new GitToolsException("Cannot exclude both open and closed issues, nothing will be returned");
             }
 
-            if (includeOpen)
+            if (filter.IncludeOpen)
             {
-                filter += string.Format("status in ({0})", string.Join(", ", openedStatuses.Select(x => string.Format("\"{0}\"", x))));
+                finalFilter += string.Format("status in ({0})", string.Join(", ", openedStatuses.Select(x => string.Format("\"{0}\"", x))));
             }
 
-            if (includeClosed)
+            if (filter.IncludeClosed)
             {
-                filter += string.Format("status in ({0})", string.Join(", ", closedStatuses.Select(x => string.Format("\"{0}\"", x))));
+                finalFilter += string.Format("status in ({0})", string.Join(", ", closedStatuses.Select(x => string.Format("\"{0}\"", x))));
             }
 
-            return filter;
+            return finalFilter;
         }
 
         private List<IssueStatus> GetOpenedStatuses(Jira jira)

src/GitTools.IssueTrackers/Models/IssueTrackerFilter.cs

@@ -0,0 +1,21 @@
+namespace GitTools.IssueTrackers
+{
+    using System;
+
+    public class IssueTrackerFilter
+    {
+        public IssueTrackerFilter()
+        {
+            IncludeOpen = true;
+            IncludeClosed = true;
+        }
+
+        public string Filter { get; set; }
+
+        public bool IncludeOpen { get; set; }
+
+        public bool IncludeClosed { get; set; }
+
+        public DateTimeOffset? Since { get; set; }
+    }
+}