Added filter to Tasks using Archived field (#1029)

Author: vishaldeepak

lib/code_corps/task/query.ex

@@ -19,34 +19,44 @@ defmodule CodeCorps.Task.Query do
   @spec list(map) :: list(Project.t)
   def list(%{} = params) do
     Task
-    |> do_list(params)
+    |> apply_archived_status(params)
+    |> apply_optional_filters(params)
     |> order_by([asc: :order])
     |> Repo.all
   end
 
-  @spec do_list(Queryable.t, map) :: Queryable.t
-  defp do_list(queryable, %{"filter" => %{} = params}) do
-    queryable |> do_list(params)
+  @spec apply_optional_filters(Queryable.t, map) :: Queryable.t
+  defp apply_optional_filters(queryable, %{"filter" => %{} = params}) do
+    queryable |> apply_optional_filters(params)
   end
-  defp do_list(queryable, %{"project_id" => project_id} = params) do
+  defp apply_optional_filters(queryable, %{"project_id" => project_id} = params) do
     queryable
     |> where(project_id: ^project_id)
-    |> do_list(params |> Map.delete("project_id"))
+    |> apply_optional_filters(params |> Map.delete("project_id"))
   end
-  defp do_list(queryable, %{"task_list_ids" => task_list_ids} = params) do
+  defp apply_optional_filters(queryable, %{"task_list_ids" => task_list_ids} = params) do
     task_list_ids = task_list_ids |> Helpers.String.coalesce_id_string
 
     queryable
     |> where([r], r.task_list_id in ^task_list_ids)
-    |> do_list(params |> Map.delete("task_list_ids"))
+    |> apply_optional_filters(params |> Map.delete("task_list_ids"))
   end
-  defp do_list(queryable, %{"status" => status} = params) do
+  defp apply_optional_filters(queryable, %{"status" => status} = params) do
     queryable
     |> where(status: ^status)
-    |> do_list(params |> Map.delete("status"))
+    |> apply_optional_filters(params |> Map.delete("status"))
   end
-  defp do_list(queryable, %{}), do: queryable
+  defp apply_optional_filters(queryable, %{}), do: queryable
 
+  @spec apply_archived_status(Queryable.t, map) :: Queryable.t
+  defp apply_archived_status(queryable, %{"archived" => archived}) do
+    queryable
+    |> where(archived: ^archived)
+  end
+  defp apply_archived_status(queryable, %{}) do
+    queryable
+    |> where(archived: false)
+  end
   @doc ~S"""
   Returns a `Task` record retrived using a set of parameters.
 

test/lib/code_corps/task/query_test.exs

@@ -80,6 +80,23 @@ defmodule CodeCorps.Task.QueryTest do
         list_sorted_ids(%{"status" => "closed"})
     end
 
+    test "filter by archived" do
+      tasks = insert_list(3, :task)
+      task_ids = tasks |> get_sorted_ids()
+
+      archived_tasks = insert_list(3, :task, archived: true)
+      archived_task_ids = archived_tasks |> get_sorted_ids()
+
+      assert task_ids ==
+        list_sorted_ids(%{})
+
+      assert task_ids ==
+        list_sorted_ids(%{"archived" => false})
+
+      assert archived_task_ids ==
+        list_sorted_ids(%{"archived" => true})
+    end
+
     test "works with multiple filters" do
       project_1 = insert(:project)
       project_2 = insert(:project)
@@ -97,6 +114,10 @@ defmodule CodeCorps.Task.QueryTest do
       task_7 = insert(:task, status: "open", project: project_2, task_list: list_2)
       task_8 = insert(:task, status: "closed", project: project_2, task_list: list_2)
 
+      task_9 = insert(:task, status: "open", project: project_1, task_list: list_2, archived: true)
+      task_10 = insert(:task, status: "closed", project: project_1, task_list: list_1, archived: true)
+      task_11 = insert(:task, status: "open", project: project_2, task_list: list_1, archived: true)
+
       assert [task_1.id] ==
         list_sorted_ids(%{"status" => "open", "project_id" => project_1.id, "task_list_ids" => "#{list_1.id}"})
 
@@ -117,6 +138,21 @@ defmodule CodeCorps.Task.QueryTest do
 
       assert [task_1, task_3] |> get_sorted_ids() ==
         list_sorted_ids(%{"status" => "open", "project_id" => project_1.id})
+
+      assert [task_9, task_10] |> get_sorted_ids() ==
+        list_sorted_ids(%{"archived" => true, "project_id" => project_1.id})
+
+      assert [task_10, task_11] |> get_sorted_ids() ==
+        list_sorted_ids(%{"archived" => true, "task_list_ids" => "#{list_1.id}"})
+
+      assert [task_9, task_11] |> get_sorted_ids() ==
+        list_sorted_ids(%{"archived" => true, "status" => "open"})
+
+      assert [task_11] |> get_sorted_ids() ==
+        list_sorted_ids(%{"archived" => true,
+          "project_id" => project_2.id,
+          "status" => "open",
+          "task_list_ids" => "#{list_1.id}"})
     end
   end