Improve flex task setup (#84)

Updates include:
- Moving the majority of the TasksController logic to Flex so that it
can be extended in the parent application
- Moving the migration for creation of `flex_tasks` to the Flex engine
- Setting up the task views to use locals rather than variables set
directly in the controller
- Cleaning up the directory structures a little
- A few small bug fixes when they were discovered

Author: MichaelCrawfordNava

.rubocop.yml

@@ -22,22 +22,22 @@ AllCops:
 # YARD documentation configuration
 YARD:
   Enabled: true
-  
+
 YARD/CollectionStyle:
   Enabled: true
-  
+
 YARD/CollectionType:
   Enabled: true
-  
+
 YARD/MeaninglessTag:
   Enabled: true
-  
+
 YARD/MismatchName:
   Enabled: true
-  
+
 YARD/TagTypePosition:
   Enabled: true
-  
+
 YARD/TagTypeSyntax:
   Enabled: true
 
@@ -46,3 +46,4 @@ Style/Documentation:
   Exclude:
     - "spec/**/*"
     - "test/**/*"
+    - "db/migrate/**/*"

app/controllers/flex/tasks_controller.rb

@@ -0,0 +1,75 @@
+module Flex
+  # Controller for managing Flex::Task records. Handles listing, filtering, showing, and updating tasks.
+  # This controller helps a parent application manage tasks by not forcing the parent application to implement the same functionality.
+  class TasksController < ::ApplicationController
+    helper DateHelper
+
+    before_action :set_task, only: %i[ show update ]
+
+    def task_class
+      controller_path.classify.constantize
+    end
+
+    def index
+      @tasks = filter_tasks
+      @task_types = task_class.distinct.pluck(:type)
+    end
+
+    def show
+    end
+
+    def update
+      if params["task-action"].present?
+        @task.mark_completed
+        flash["task-message"] = I18n.t("tasks.messages.task_marked_completed")
+      end
+
+      redirect_to task_path(@task)
+    end
+
+    private
+
+    def set_task
+      @task = task_class.find(params[:id]) if params[:id].present?
+    end
+
+    def index_filter_params
+      params.permit(:filter_date, :filter_type, :filter_status)
+    end
+
+    def filter_tasks
+      tasks = filter_tasks_by_date(task_class.all, index_filter_params[:filter_date])
+      tasks = filter_tasks_by_type(tasks, index_filter_params[:filter_type])
+      tasks = filter_tasks_by_status(tasks, index_filter_params[:filter_status])
+
+      tasks
+    end
+
+    def filter_tasks_by_date(tasks, filter_by)
+      case filter_by
+      when "today"
+        tasks.due_today
+      when "overdue"
+        tasks.overdue
+      when "tomorrow"
+        tasks.due_tomorrow
+      when "this_week"
+        tasks.due_this_week
+      else
+        tasks
+      end
+    end
+
+    def filter_tasks_by_type(tasks, filter_by)
+      return tasks unless filter_by.present? && filter_by != "all"
+
+      tasks.with_type(filter_by)
+    end
+
+    def filter_tasks_by_status(tasks, status)
+      status == "completed" \
+        ? tasks.completed
+        : tasks.incomplete
+    end
+  end
+end

app/views/flex/tasks/_due_date_filter.html.erb

@@ -1,5 +1,5 @@
 <%= form_with method: 'get' do |form| %>
-  <%= hidden_field_tag(:filter_date, params[:filter_date]) if params[:filter_date].present? %>
+  <%= hidden_field_tag(:filter_type, params[:filter_type]) if params[:filter_type].present? %>
   <%= hidden_field_tag(:filter_status, params[:filter_status]) if params[:filter_status].present? %>
   <%= form.label :filter_date, t("flex.tasks.partials.due_date_filter.label"), class: 'usa-label' %>
   <%= form.select :filter_date, [

app/views/flex/tasks/_type_filter.html.erb

@@ -4,7 +4,7 @@
   <%= form.label :filter_type, t("flex.tasks.partials.type_filter.label"), class: 'usa-label' %>
   <%= form.select :filter_type, \
     [[t("flex.tasks.partials.type_filter.options.all"), ""]].append(
-      *@distinct_task_types.map { |type| [t("tasks.types.#{type.underscore}"), type] }
+      *task_types.map { |type| [t("tasks.types.#{type.underscore}"), type] }
     ),
     { include_blank: false, selected: params[:filter_type] },
     { class: 'usa-select', onchange: 'this.form.submit()' } %>

app/views/flex/tasks/index.html.erb

@@ -1,22 +1,25 @@
 <%# Index view for displaying a list of tasks
-    Required locals:
-    - model_class: Flex::Task or subclass - The model class for the tasks
-
-    Example usage:
-    render template: "flex/application_forms/index", locals: {
-      model_class: PassportTask
-    }
-%>
-<%= content_for :title, model_class.name.titleize %>
+  Required locals:
+  - tasks: Flex::Task[] - Array of tasks to display
+ %>
 <!-- Main content -->
 <main class="usa-section">
   <div class="grid-container">
     <h1 class="usa-heading-xl"><%= t("flex.tasks.index.title") %></h1>
     <nav class="display-flex border-bottom-1px border-base-light">
       <% 
+        filter_params = params.permit(:filter_date, :filter_type, :filter_status)
         [
-          { name: t("flex.tasks.index.tabs.assigned"), path: polymorphic_path(model_class, filter_status: nil, filter_date: params[:filter_date], filter_type: params[:filter_type]), active: params[:filter_status] != "completed" },
-          { name: t("flex.tasks.index.tabs.completed"), path: polymorphic_path(model_class, filter_status: "completed", filter_date: params[:filter_date], filter_type: params[:filter_type]), active: params[:filter_status] == "completed" }
+          { 
+            name: t("flex.tasks.index.tabs.assigned"), 
+            path: url_for(filter_params.merge(filter_status: nil)), 
+            active: params[:filter_status] != "completed" 
+          },
+          { 
+            name: t("flex.tasks.index.tabs.completed"), 
+            path: url_for(filter_params.merge(filter_status: "completed")), 
+            active: params[:filter_status] == "completed" 
+          }
         ].each do |tab| 
       %>
       <%= render partial: "flex/cases/nav_tab", locals: tab %>
@@ -25,13 +28,13 @@
   <!-- Filters -->
   <div class="grid-row grid-gap-4 margin-bottom-4">
     <div class="grid-col-12 tablet:grid-col-3">
-      <%= render partial: 'flex/tasks/type_filter' %>
+      <%= render partial: 'flex/tasks/type_filter', locals: { task_types: task_types } %>
     </div>
     <div class="grid-col-12 tablet:grid-col-3">
       <%= render partial: 'flex/tasks/due_date_filter' %>
     </div>
   </div>
-  <% if @tasks.any? %>
+  <% if tasks.any? %>
     <!-- Tasks -->
     <table class="usa-table usa-table--striped usa-table--sticky-header width-full">
       <thead>
@@ -52,14 +55,14 @@
       </thead>
       <tbody>
         <%
-          @tasks.each do |task|
+          tasks.each do |task|
           %>
         <tr>
           <td data-sort-value="<%= time_since_epoch task.due_on %>">
             <%= local_en_us task.due_on %>
           </td>
           <td data-sort-value="<%= task.type %>">
-            <%= link_to t("tasks.types.#{task.type.underscore}"), passport_task_path(task) %>
+            <%= link_to t("tasks.types.#{task.type.underscore}"), task_path(task) %>
           </td>
           <td data-sort-value="<%= task.case_id %>"><%= task.case_id %></td>
           <td data-sort-value="<%= time_since_epoch task.created_at %>">

app/views/flex/tasks/show.html.erb

@@ -1,4 +1,17 @@
-<% task_type_with_name = t("tasks.types.#{@task.type.underscore}") + " - " + @application_form.full_name || "TBD" %>
+<%# Show view for displaying a task
+    Required locals:
+    - assigned_user_display_text: String - The name of the user assigned to this task
+    - task: Flex::Task - The task object
+
+    Optional locals:
+    - task_details_partial: String - The HTML to render for the task details. If not provided, the view will look for a partial named after the task type within the `details` directory.
+    
+    Example usage:
+      render template: 'flex/tasks/default/show', locals: {
+        task: @task,
+        assigned_user_display_text: assigned_user&.full_name || "Not Assigned"
+      }
+%>
 <main class="usa-section">
   <div class="grid-container">
     <nav class="usa-breadcrumb" aria-label="Breadcrumbs">
@@ -7,25 +20,25 @@
           <%= link_to t("flex.tasks.breadcrumbs.home"), "/", class: "usa-breadcrumb__link" %>
         </li>
         <li class="usa-breadcrumb__list-item">
-          <%= link_to t("flex.tasks.breadcrumbs.tasks"), polymorphic_path(model_class), class: "usa-breadcrumb__link" %>
+          <%= link_to t("flex.tasks.breadcrumbs.tasks"), tasks_path, class: "usa-breadcrumb__link" %>
         </li>
         <li class="usa-breadcrumb__list-item usa-current" aria-current="page">
-          <span><%= task_type_with_name %></span>
+          <span><%= t("tasks.types.#{task.type.underscore}") %></span>
         </li>
       </ol>
     </nav>
-    <h1 class="section-heading-h1"><%= task_type_with_name %></h1>
+    <h1 class="section-heading-h1"><%= t("tasks.types.#{task.type.underscore}") %></h1>
     <div class="border-bottom-1px margin-bottom-1 padding-bottom-1">
       <div class="grid-container">
         <div class="grid-row grid-gap-2">
           <div class="grid-col-auto">
-            <strong><%= t("flex.tasks.show.details.status") %>:</strong> <%= t("tasks.statuses.#{@task.status}") %>
+            <strong><%= t("flex.tasks.show.details.status") %>:</strong> <%= t("tasks.statuses.#{task.status}") %>
           </div>
           <div class="grid-col-auto">
-            <strong><%= t("flex.tasks.show.details.due_on") %>:</strong> <%= local_en_us @task.due_on %>
+            <strong><%= t("flex.tasks.show.details.due_on") %>:</strong> <%= local_en_us task.due_on %>
           </div>
           <div class="grid-col-auto">
-            <strong><%= t("flex.tasks.show.details.assigned_to") %>:</strong> <%= @assigned_user&.full_name || "N/A" %>
+            <strong><%= t("flex.tasks.show.details.assigned_to") %>:</strong> <%= assigned_user_display_text %>
           </div>
         </div>
       </div>
@@ -41,6 +54,10 @@
         </div>
       <% end %>
       <h2 class="section-heading-h2"><%= t("flex.tasks.show.headers.task_details") %></h2>
-      <%= render html: task_details_partial %>
+      <% if content_for?(:task_details_partial) %>
+        <%= yield(:task_details_partial) %>
+      <% else %>
+        <%= render partial: "tasks/details/#{task.type.underscore}", locals: local_assigns.to_h %>
+      <% end %>
     </section>
   </main>

…rate/20250430160812_create_flex_tasks.rb …rate/20250430160812_create_flex_tasks.rbspec/dummy/db/migrate/20250430160812_create_flex_tasks.rb renamed to db/migrate/20250430160812_create_flex_tasks.rb spec/dummy/db/migrate/20250430160812_create_flex_tasks.rb renamed to db/migrate/20250430160812_create_flex_tasks.rb

@@ -6,6 +6,7 @@ def change
     t.integer :status, index: true, default: 0
     t.integer :assignee_id, index: true # not linked to anything yet but will be later
     t.integer :case_id, index: true
+    t.date :due_on
 
     t.timestamps
     end

spec/dummy/app/controllers/passport_tasks_controller.rb

@@ -0,0 +1,11 @@
+class TasksController < Flex::TasksController
+  def task_class
+    PassportTask
+  end
+
+  def show
+    super
+    kase = PassportCase.find(@task.case_id)
+    @application_form = PassportApplicationForm.find(kase.application_form_id)
+  end
+end

spec/dummy/app/controllers/tasks_controller.rb

@@ -1,3 +1,6 @@
+# User represents an individual who interacts with the dummy app.
+#
+# This model stores basic user information such as first and last name but may be extended to hold more.
 class User < ApplicationRecord
   attribute :first_name, :string
   attribute :last_name, :string