feat: Dr. Rai Titration Indicator (#5643)

**Story card:**
[sc-15931](https://app.shortcut.com/simpledotorg/story/15931/dr-rai-titration-indicator)

## Because

Titration Indicator is the second indicator we have chosen to implement
for Dr. Rai Reports. This indicator has SQL as its datasource — as
opposed to the data in the Dashboard.

## This addresses

- Creating the mechanism to use SQL as a data source
- Creating the Titration Indicator (alongside its query)
- Adding the Titration Indicator to the Dr. Rai component
- Smoothening out component decisions made when there was just one
indicator

## Test instructions

suite tests

Author: igbanam

app/components/dashboard/dr_rai_report.html.erb

@@ -32,7 +32,7 @@
             <% end %>
           </div>
           <div class="action-progress">
-            <p class="statement"><%= action_plan.numerator %> of <%= action_plan.denominator %> overdue patients</p>
+          <p class="statement"><%= action_plan.numerator %> of <%= action_plan.denominator %> <%= action_plan.unit %></p>
             <div class="bar">
               <div class="bar-fill" style="width: <%= action_plan.progress %>%">
                 <span class="bar-number over-88-percent"><%= action_plan.progress %>%</span>
@@ -67,7 +67,7 @@
           <%# <button class="link-button edit">Edit</button> %>
           <ul>
             <% indicators.each do |indicator| %>
-              <li><button class="link-button advancer" data-target-type="<%= indicator.target_type %>" data-target-ui="<%= indicator.target_type_frontend %>" data-indicator-id=<%= indicator.id %> data-indicator-denominator="<%= indicator_denominator(indicator) %>" data-indicator-previous-numerator="<%= indicator_previous_numerator(indicator) %>" data-indicator-action="<%= indicator.action %>">Contact overdue patients</button></li>
+              <li><button class="link-button advancer" data-target-type="<%= indicator.target_type %>" data-target-ui="<%= indicator.target_type_frontend %>" data-indicator-id=<%= indicator.id %> data-indicator-denominator="<%= indicator_denominator(indicator) %>" data-indicator-previous-numerator="<%= indicator_previous_numerator(indicator) %>" data-indicator-action="<%= indicator.action %>" data-indicator-action-active="<%= indicator.action_active %>" data-indicator-action-passive="<%= indicator.action_passive %>" data-indicator-unit="<%= indicator.unit %>"><%= indicator.display_name %></button></li>
             <% end %>
           </ul>
         </div>
@@ -87,7 +87,7 @@
             </label>
             <p class="missing-input-warning d-none">Enter a goal value</p>
           </div>
-          <p class="activity-promise d-none">Contact <span class="highlight target-number">500</span> overdue patients by <%= end_of(selected_period) %></p>
+          <p class="activity-promise d-none"><span class="active-action"></span> <span class="highlight target-number">500</span> <span class="indicator-unit"></span> by <%= end_of(selected_period) %></p>
           <p class="activity-statement"><span class="highlight"><span class="previous-percentage">6</span>%</span> <span class='indicator-action'></span> (<span class='indicator-previous-numerator'></span> of <span class='indicator-denominator'></span>) in <%= human_readable(selected_period.previous) %></p>
           <button class="next-button">Next</button>
         </div>
@@ -108,9 +108,8 @@
             </label>
             <p class="missing-input-warning d-none">Enter a goal value</p>
           </div>
-          <p class="activity-promise d-none">Contact <span class="highlight target-number">500</span> overdue patients by <%= end_of(selected_period) %></p>
+          <p class="activity-promise d-none"><span class="active-action"></span> <span class="highlight target-number">500</span> <span class="indicator-unit"></span> by <%= end_of(selected_period) %></p>
           <p class="activity-statement"><span class="highlight"><span class="indicator-previous-numerator">6</span></span> <span class='indicator-action'></span> (<span class='indicator-previous-numerator'></span> of <span class='indicator-denominator'></span>) in <%= human_readable(selected_period.previous) %></p>
-          <p class="activity-statement"><span class="highlight">6%</span> overdue patients called (600 of 10,000) in <%= human_readable(selected_period.previous) %></p>
           <button class="next-button">Next</button>
         </div>
         <div class="inactive d-none">
@@ -225,6 +224,9 @@
       $('.indicator-action').text(indicator.action)
       $('.indicator-denominator').text(indicator.denominator)
       $('.indicator-previous-numerator').text(indicator.previous_numerator)
+      $('.active-action').text(indicator.active_action)
+      $('.passive-passion').text(indicator.passive_passion)
+      $('.indicator-unit').text(indicator.unit)
       if (nextStep === 3) {
         $(e.currentTarget).find('.step-statement').text($(e.currentTarget).find('.activity-promise').text())
         $('#dr-rai--sidebar').data('statement', $(e.currentTarget).find('.step-statement').text())
@@ -322,6 +324,9 @@
             'denominator': $(e.currentTarget).data('indicator-denominator'),
             'previous_numerator': $(e.currentTarget).data('indicator-previous-numerator'),
             'action': $(e.currentTarget).data('indicator-action'),
+            'passive_action': $(e.currentTarget).data('indicator-action-passive'),
+            'active_action': $(e.currentTarget).data('indicator-action-active'),
+            'unit': $(e.currentTarget).data('indicator-unit'),
           }
         ])
     })

app/components/dashboard/dr_rai_report.rb

@@ -17,7 +17,14 @@ def initialize(quarterlies, region_slug, selected_quarter = nil)
         region: @region,
         dr_rai_target: {period: @selected_period.value.to_s}
       )
-    @indicators = DrRai::Indicator.all
+    @indicators = custom_indicators
+  end
+
+  def custom_indicators
+    return [] unless region.source_type == "Facility"
+    DrRai::Indicator.all.filter do |indicator|
+      indicator.is_supported?(region)
+    end
   end
 
   def indicator_previous_numerator(indicator)

app/models/dr_rai/action_plan.rb

@@ -24,9 +24,20 @@ def denominator
   end
 
   def progress
-    return 0 unless denominator.positive?
+    return 0 if unprocessible?
     return 100 unless numerator < denominator
 
     (numerator.to_f / denominator * 100).round
   end
+
+  def unit
+    indicator.unit
+  end
+
+  private
+
+  def unprocessible?
+    denominator.negative? ||
+      numerator.nil?
+  end
 end

app/models/dr_rai/contact_overdue_patients_indicator.rb

@@ -1,31 +1,11 @@
 module DrRai
   class ContactOverduePatientsIndicator < Indicator
-    def display_name
-      "Contact overdue patients"
-    end
-
-    def numerator(region, the_period = period)
-      numerators(region)[the_period]
-    end
-
-    def denominator(region, the_period = period)
-      denominators(region)[the_period]
-    end
-
-    def numerators(region)
-      quarterlies(region).map do |t, data|
-        [t, data[numerator_key]]
-      end.to_h
-    end
-
-    def denominators(region)
-      quarterlies(region).map do |t, data|
-        [t, data[denominator_key]]
-      end.to_h
+    def datasource(region)
+      quarterlies(region)
     end
 
-    def target_type
-      "DrRai::PercentageTarget"
+    def display_name
+      "Contact overdue patients"
     end
 
     def target_type_frontend
@@ -40,8 +20,20 @@ def denominator_key
       "overdue_patients"
     end
 
-    def action
-      "overdue patients called"
+    def unit
+      "overdue patients"
+    end
+
+    def action_passive
+      "called"
+    end
+
+    def action_active
+      "Contact"
+    end
+
+    def is_supported?(region)
+      true
     end
   end
 end

app/models/dr_rai/indicator.rb

@@ -28,4 +28,32 @@ def quarterlies(region)
   def period
     Period.new(type: :quarter, value: target.period)
   end
+
+  def target_type
+    DrRai::Target::TYPES[target_type_frontend]
+  end
+
+  def numerator(region, the_period = period)
+    numerators(region)[the_period]
+  end
+
+  def denominator(region, the_period = period)
+    denominators(region)[the_period]
+  end
+
+  def numerators(region)
+    datasource(region).map do |t, data|
+      [t, data[numerator_key]]
+    end.to_h
+  end
+
+  def denominators(region)
+    datasource(region).map do |t, data|
+      [t, data[denominator_key]]
+    end.to_h
+  end
+
+  def action
+    [unit, action_passive].join(" ")
+  end
 end

app/models/dr_rai/target.rb

@@ -1,4 +1,10 @@
 class DrRai::Target < ApplicationRecord
+  TYPES = {
+    "percent" => "DrRai::PercentageTarget",
+    "numeric" => "DrRai::NumericTarget",
+    "boolean" => "DrRai::BooleanTarget"
+  }
+
   belongs_to :indicator, class_name: "DrRai::Indicator", foreign_key: "dr_rai_indicators_id"
 
   validates :period, presence: true, format: {with: /\AQ\d-\d{4}\Z/}

app/models/dr_rai/titration_indicator.rb

@@ -0,0 +1,52 @@
+module DrRai
+  class TitrationIndicator < Indicator
+    attr_reader :region
+
+    def datasource(region)
+      @region = region
+      @query ||= TitrationQuery.new(region).call
+      @query[region.name]
+    end
+
+    def display_name
+      "Titration"
+    end
+
+    def target_type_frontend
+      "percent"
+    end
+
+    def numerator_key
+      "titrated"
+    end
+
+    def denominator_key
+      "patients"
+    end
+
+    def action_passive
+      "titrated"
+    end
+
+    def action_active
+      "Titrate"
+    end
+
+    def unit
+      "patients"
+    end
+
+    def is_supported?(region)
+      case CountryConfig.current[:name]
+      when "Bangladesh"
+        region.path.split(".").include?("nhf")
+      when "Ethiopia"
+        region.path.split(".").none? { |level| level.include?("non_rtsl") }
+      when "Sri Lanka"
+        region.path.split(".").include?("sri_lanka_organization")
+      else
+        false
+      end
+    end
+  end
+end

app/queries/dr_rai/indicator_function.rb

@@ -0,0 +1,28 @@
+# Base Query for a DrRai indicator
+#
+# This is our harness to force the queries created in Metabase to follow the
+# format of the data in the Simple Dashboard. Thus, all queries we would want
+# to use with the Dr Rai component should include this module.
+module DrRai
+  module IndicatorFunction
+    def valid?
+      raise "The result of the query must be present beforehand." if @result.nil?
+
+      raise "Invalid structure" unless valid_structure?
+    end
+
+    # This method is what the indicator uses to verify that it gets what should
+    # come back from the DB. Ideally, it would be validating a 2D array for the
+    # columns. If indicators want to get ambitious, they can validate the
+    # column types. But this is not necessary.
+    def valid_structure?
+      raise "Unimplemented"
+    end
+
+    # This is the method all Dr. Rai indicator functions should implement to
+    # transform their resultant query to the dashboard format
+    def transform!
+      raise "Unimplemented"
+    end
+  end
+end