Add Inventory Flow tab with quantity tracking and date filtering

Author: Olexii Kasianenko

.rubocop_todo.yml

@@ -86,10 +86,6 @@ Layout/ExtraSpacing:
     - 'Guardfile'
     - 'app/models/barcode_item.rb'
     - 'app/queries/items_by_storage_collection_query.rb'
-    - 'app/queries/items_in_query.rb'
-    - 'app/queries/items_in_total_query.rb'
-    - 'app/queries/items_out_query.rb'
-    - 'app/queries/items_out_total_query.rb'
     - 'config/environments/development.rb'
     - 'config/environments/test.rb'
     - 'config/puma.rb'
@@ -169,10 +165,6 @@ Layout/MultilineMethodCallIndentation:
     - 'app/models/partner_distribution.rb'
     - 'app/models/storage_location.rb'
     - 'app/queries/items_by_storage_collection_query.rb'
-    - 'app/queries/items_in_query.rb'
-    - 'app/queries/items_in_total_query.rb'
-    - 'app/queries/items_out_query.rb'
-    - 'app/queries/items_out_total_query.rb'
     - 'app/services/reports/acquisition_report_service.rb'
     - 'app/services/reports/adult_incontinence_report_service.rb'
     - 'app/services/reports/children_served_report_service.rb'

app/controllers/storage_locations_controller.rb

@@ -54,15 +54,15 @@ def edit
     @storage_location = current_organization.storage_locations.find(params[:id])
   end
 
-  # TODO: Move these queries to Query Object
   def show
+    setup_date_range_picker
     @storage_location = current_organization.storage_locations.find(params[:id])
     version_date = params[:version_date].presence&.to_date
-    # TODO: Find a way to do these with less hard SQL. These queries have to be manually updated because they're not in-sync with the Model
-    @items_out = ItemsOutQuery.new(organization: current_organization, storage_location: @storage_location).call
-    @items_out_total = ItemsOutTotalQuery.new(organization: current_organization, storage_location: @storage_location).call
-    @items_in = ItemsInQuery.new(organization: current_organization, storage_location: @storage_location).call
-    @items_in_total = ItemsInTotalQuery.new(organization: current_organization, storage_location: @storage_location).call
+    @items = current_organization.items.order(:name)
+    @items = @items.created_between(*date_range) if filter_params[:date_range].present?
+    @total_quantity_in = @items.sum { |item| item.quantity_in_storage(@storage_location.id) }
+    @total_quantity_out = @items.sum { |item| item.quantity_out_storage(@storage_location.id) }
+    @total_quantity_change = @total_quantity_in - @total_quantity_out
     if View::Inventory.within_snapshot?(current_organization.id, version_date)
       @inventory = View::Inventory.new(current_organization.id, event_time: version_date)
     else
@@ -157,9 +157,16 @@ def include_omitted_items(existing_item_ids = [])
   end
 
   helper_method \
-    def filter_params
+  def filter_params
     return {} unless params.key?(:filters)
 
-    params.require(:filters).permit(:containing)
+    params.require(:filters).permit(:containing, :date_range, :date_range_label)
+  end
+
+  def date_range
+    date_range = filter_params[:date_range].split(" - ")
+    start_date = Date.parse(date_range[0])
+    end_date = Date.parse(date_range[1])
+    [start_date, end_date]
   end
 end

app/models/item.rb

@@ -70,7 +70,7 @@ class Item < ApplicationRecord
   scope :period_supplies, -> {
     where(reporting_category: [:pads, :tampons, :period_liners, :period_underwear, :period_other])
   }
-
+  scope :created_between, ->(start_date, end_date) { where(created_at: start_date..end_date) }
   enum :reporting_category, {
     adult_incontinence: "adult_incontinence",
     cloth_diapers: "cloth_diapers",
@@ -184,6 +184,18 @@ def sync_request_units!(unit_ids)
     end
   end
 
+  def quantity_in_storage(storage_location_id)
+    line_items.inventory_in_storage(storage_location_id).sum(:quantity)
+  end
+
+  def quantity_out_storage(storage_location_id)
+    line_items.inventory_out_storage(storage_location_id).sum(:quantity)
+  end
+
+  def quantity_change(storage_location_id)
+    quantity_in_storage(storage_location_id) - quantity_out_storage(storage_location_id)
+  end
+
   private
 
   # Sets reporting_category according to reporting_category of base item.

app/models/line_item.rb

@@ -25,6 +25,28 @@ class LineItem < ApplicationRecord
 
   scope :active, -> { joins(:item).where(items: { active: true }) }
 
+  scope :inventory_in_storage, ->(storage_location_id) do
+    joins("
+      LEFT OUTER JOIN donations ON donations.id = line_items.itemizable_id AND line_items.itemizable_type = 'Donation'
+      LEFT OUTER JOIN purchases ON purchases.id = line_items.itemizable_id AND line_items.itemizable_type = 'Purchase'
+      LEFT OUTER JOIN adjustments ON adjustments.id = line_items.itemizable_id AND line_items.itemizable_type = 'Adjustment'
+      LEFT OUTER JOIN transfers ON transfers.id = line_items.itemizable_id AND line_items.itemizable_type = 'Transfer'")
+      .where("donations.storage_location_id = :storage_location_id OR
+              purchases.storage_location_id = :storage_location_id OR
+              (adjustments.storage_location_id = :storage_location_id and line_items.quantity < 0) OR
+              transfers.to_id = :storage_location_id", storage_location_id: storage_location_id)
+  end
+
+  scope :inventory_out_storage, ->(storage_location_id) do
+    joins("
+      LEFT OUTER JOIN distributions ON distributions.id = line_items.itemizable_id AND line_items.itemizable_type = 'Distribution'
+      LEFT OUTER JOIN adjustments ON adjustments.id = line_items.itemizable_id AND line_items.itemizable_type = 'Adjustment'
+      LEFT OUTER JOIN transfers ON transfers.id = line_items.itemizable_id AND line_items.itemizable_type = 'Transfer'")
+      .where("distributions.storage_location_id = :storage_location_id OR
+              (adjustments.storage_location_id = :storage_location_id and line_items.quantity > 0) OR
+              transfers.from_id = :storage_location_id", storage_location_id: storage_location_id)
+  end
+
   delegate :name, to: :item
 
   # Used in a distribution that was initialized from a request. The `item_request` will be

app/queries/items_in_query.rb

@@ -0,0 +1,7 @@
+<% css_class = item_row.quantity_change(@storage_location.id).negative? ? 'modal-body-warning-text' : '' %>
+<tr id="<%= item_row.id %>">
+  <td><%= link_to item_row.name, item_path(item_row.id) %></td>
+  <td><%= item_row.quantity_in_storage(@storage_location.id) %></td>
+  <td><%= item_row.quantity_out_storage(@storage_location.id) %></td>
+  <td class="<%= css_class %>"><%= item_row.quantity_change(@storage_location.id) %></td>
+</tr>

app/queries/items_in_total_query.rb

@@ -66,14 +66,11 @@
         <div class="card card-primary card-outline card-outline-tabs">
           <div class="card-header p-0 border-bottom-0">
             <ul class="nav nav-tabs" id="custom-tabs-three-tab" role="tablist">
-              <li class="nav-item" class="active">
+              <li class="nav-item active">
                 <a class="nav-link active" id="custom-tabs-inventory-tab" data-bs-toggle="pill" href="#custom-tabs-inventory" role="tab" aria-controls="custom-tabs-one-home-tab" aria-selected="true">Inventory</a>
               </li>
               <li class="nav-item">
-                <a class="nav-link" id="custom-tabs-inventory-in-tab" data-bs-toggle="pill" href="#custom-tabs-inventory-in" role="tab" aria-controls="custom-tabs-two-home-tab" aria-selected="false">Inventory Coming In</a>
-              </li>
-              <li class="nav-item">
-                <a class="nav-link" id="custom-tabs-inventory-out-tab" data-bs-toggle="pill" href="#custom-tabs-inventory-out" role="tab" aria-controls="custom-tabs-three-home-tab" aria-selected="false">Inventory Going Out</a>
+                <a class="nav-link" id="custom-tabs-inventory-flow-tab" data-bs-toggle="pill" href="#custom-tabs-inventory-flow" role="tab" aria-controls="custom-tabs-two-home-tab" aria-selected="false">Inventory Flow</a>
               </li>
             </ul>
           </div>
@@ -129,41 +126,39 @@
                 </table>
               </div><!-- /.box-body.table-responsive -->
 
-              <div class="tab-pane fade show" id="custom-tabs-inventory-in" role="tabpanel" aria-labelledby="custom-two-home-tab">
-                <table class="table">
-                  <thead>
-                  <tr>
-                    <th>Item</th>
-                    <th>Quantity</th>
-                  </tr>
-                  </thead>
-                  <tbody>
-                  <%= render partial: "line_item_row", collection: @items_in %>
-                  </tbody>
-                  <tfoot>
-                  <tr>
-                    <td>Total</td>
-                    <td><%= @items_in_total %></td>
-                  </tr>
-                  </tfoot>
-                </table>
-              </div><!-- /.box-body.table-responsive -->
-
-              <div class="tab-pane fade show" id="custom-tabs-inventory-out" role="tabpanel" aria-labelledby="custom-tabs-three-home-tab">
+              <div class="tab-pane fade show" id="custom-tabs-inventory-flow" role="tabpanel" aria-labelledby="custom-two-home-tab">
+                <%= form_for @storage_location, method: :get do %>
+                    <%= label_tag "Date Range" %>
+                  <div class="row">
+                    <div class="col-lg-3 col-md-4 col-sm-6 col-xs-12">
+                      <%= render partial: "shared/date_range_picker", locals: {css_class: "form-control"} %>
+                    </div>
+                    <div class="col-lg-3 col-md-4 col-sm-6 col-xs-12">
+                      <%= filter_button %>
+                      <%= clear_filter_button %>
+                    </div>
+                  </div>
+                <% end %>
+                <br><br>
                 <table class="table">
                   <thead>
                   <tr>
                     <th>Item</th>
-                    <th>Quantity</th>
+                    <th>Quantity In</th>
+                    <th>Quantity Out</th>
+                    <th>Change</th>
                   </tr>
                   </thead>
                   <tbody>
-                  <%= render partial: "line_item_row", collection: @items_out %>
+                  <%= render partial: "item_row", collection: @items %>
                   </tbody>
                   <tfoot>
                   <tr>
                     <td>Total</td>
-                    <td><%= @items_out_total %></td>
+                    <td><%= @total_quantity_in %></td>
+                    <td><%= @total_quantity_out %></td>
+                    <% css_class = @total_quantity_change.negative? ? 'modal-body-warning-text' : '' %>
+                    <td class="<%= css_class %>"><%= @total_quantity_change %></td>
                   </tr>
                   </tfoot>
                 </table>