Add viewing/editing/filtering of item reporting category (#5209)

* Add viewing/editing/filtering of item reporting category

* Put other reporting_category at end of dropdown

* Remove no longer needed system spec

* Rename to NDBN Reporting Category

* Add NDBN reporting category filtering to user guide

* Add field description for NDBN Reporting Category

* Fix NoMethodError for items without a reporting_category

* Disable NDBN reporting category for items housing a kit

* Remove connection to base_item from item

* Remove partner_key validation on request items

* Fix failing specs

* Fix failing spec

* Remove base item from items csv export

* Fix failing spec

* Removing "menstrual" from ndbn reporting categories (it is a super-category that should not be selectable)

* Adding informational text to reporting category if the item represents a kit

* rubocop happiness

---------

Co-authored-by: CL Fisher <[email protected]>

Author: coalest

app/controllers/items_controller.rb

@@ -4,7 +4,7 @@ class ItemsController < ApplicationController
   def index
     @items = current_organization
       .items
-      .includes(:base_item, :kit, :line_items, :request_units, :item_category)
+      .includes(:kit, :line_items, :request_units, :item_category)
       .alphabetized
       .class_filter(filter_params)
       .group('items.id')
@@ -15,7 +15,7 @@ def index
     @storages = current_organization.storage_locations.active.order(id: :asc)
 
     @include_inactive_items = params[:include_inactive_items]
-    @selected_base_item = filter_params[:by_base_item]
+    @selected_reporting_category = filter_params[:by_reporting_category]
 
     @paginated_items = @items.page(params[:page])
 
@@ -41,7 +41,6 @@ def create
     if result.success?
       redirect_to items_path, notice: "#{result.value.name} added!"
     else
-      @base_items = BaseItem.without_kit.alphabetized
       # Define a @item to be used in the `new` action to be rendered with
       # the provided parameters. This is required to render the page again
       # with the error + the invalid parameters.
@@ -53,15 +52,14 @@ def create
   end
 
   def new
-    @base_items = BaseItem.without_kit.alphabetized
     @item_categories = current_organization.item_categories
     @item = current_organization.items.new
   end
 
   def edit
-    @base_items = BaseItem.without_kit.alphabetized
     @item_categories = current_organization.item_categories
     @item = current_organization.items.find(params[:id])
+    @reporting_category_hint = reporting_category_hint
   end
 
   def show
@@ -70,14 +68,14 @@ def show
     storage_location_ids = @inventory.storage_locations_for_item(@item.id)
     @storage_locations_containing = StorageLocation.find(storage_location_ids)
     @barcodes_for = BarcodeItem.where(barcodeable_id: @item.id)
+    @reporting_category_hint = reporting_category_hint
   end
 
   def update
     @item = current_organization.items.find(params[:id])
     @item.attributes = item_params
     deactivated = @item.active_changed? && !@item.active
     if deactivated && !@item.can_deactivate?
-      @base_items = BaseItem.without_kit.alphabetized
       flash.now[:error] = "Can't deactivate this item - it is currently assigned to either an active kit or a storage location!"
       render action: :edit
       return
@@ -86,7 +84,6 @@ def update
     if update_item
       redirect_to items_path, notice: "#{@item.name} updated!"
     else
-      @base_items = BaseItem.without_kit.alphabetized
       flash.now[:error] = "Something didn't work quite right -- try again? #{@item.errors.map { |error| "#{error.attribute}: #{error.message}" }}"
       render action: :edit
     end
@@ -140,6 +137,13 @@ def remove_category
 
   private
 
+  def reporting_category_hint
+    item = current_organization.items.find(params[:id])
+    if item.kit_id
+      "Kits are reported based on their contents."
+    end
+  end
+
   def clean_item_value_in_cents
     return unless params[:item][:value_in_cents]
 
@@ -164,6 +168,7 @@ def item_params
     @item_params = params.require(:item).permit(
       :name,
       :item_category_id,
+      :reporting_category,
       :partner_key,
       :value_in_cents,
       :package_size,
@@ -205,6 +210,6 @@ def update_item_and_request_units
     def filter_params(_parameters = nil)
     return {} unless params.key?(:filters)
 
-    params.require(:filters).permit(:by_base_item, :include_inactive_items)
+    params.require(:filters).permit(:by_reporting_category, :include_inactive_items)
   end
 end

app/models/base_item.rb

@@ -80,7 +80,7 @@ class BaseItem < ApplicationRecord
   }.freeze
 
   def to_h
-    { partner_key: partner_key, name: name }
+    { partner_key: partner_key, name: name, reporting_category: reporting_category }
   end
 
   private

app/models/item.rb

@@ -30,11 +30,10 @@ class Item < ApplicationRecord
 
   after_initialize :set_default_distribution_quantity, if: :new_record?
   after_update :update_associated_kit_name, if: -> { kit.present? }
-  before_create :set_reporting_category
   before_destroy :validate_destroy, prepend: true
 
   belongs_to :organization # If these are universal this isn't necessary
-  belongs_to :base_item, counter_cache: :item_count, primary_key: :partner_key, foreign_key: :partner_key, inverse_of: :items
+  belongs_to :base_item, counter_cache: :item_count, primary_key: :partner_key, foreign_key: :partner_key, inverse_of: :items, optional: true
   belongs_to :kit, optional: true
   belongs_to :item_category, optional: true
 
@@ -45,6 +44,7 @@ class Item < ApplicationRecord
   validates :on_hand_recommended_quantity, numericality: { greater_than_or_equal_to: 0 }, allow_blank: true
   validates :on_hand_minimum_quantity, numericality: { greater_than_or_equal_to: 0 }
   validates :package_size, numericality: { greater_than_or_equal_to: 0 }, allow_blank: true
+  validates :reporting_category, presence: true, unless: proc { |i| i.kit }
 
   has_many :line_items, dependent: :destroy
   has_many :inventory_items, dependent: :destroy
@@ -63,10 +63,9 @@ class Item < ApplicationRecord
   scope :visible, -> { where(visible_to_partners: true) }
   scope :alphabetized, -> { order(:name) }
   scope :by_base_item, ->(base_item) { where(base_item: base_item) }
+  scope :by_reporting_category, ->(reporting_category) { where(reporting_category: reporting_category) }
   scope :by_partner_key, ->(partner_key) { where(partner_key: partner_key) }
 
-  scope :by_size, ->(size) { joins(:base_item).where(base_items: { size: size }) }
-
   scope :period_supplies, -> {
     where(reporting_category: [:pads, :tampons, :period_liners, :period_underwear, :period_other])
   }
@@ -75,14 +74,19 @@ class Item < ApplicationRecord
     adult_incontinence: "adult_incontinence",
     cloth_diapers: "cloth_diapers",
     disposable_diapers: "disposable_diapers",
-    menstrual: "menstrual",
-    other_categories: "other",
     pads: "pads",
     period_liners: "period_liners",
     period_other: "period_other",
     period_underwear: "period_underwear",
-    tampons: "tampons"
-  }, instance_methods: false
+    tampons: "tampons",
+    other_categories: "other"
+  }, instance_methods: false, validate: { allow_nil: true }
+
+  def self.reporting_categories_for_select
+    reporting_categories.map do |key, value|
+      Option.new(id: key, name: value.titleize)
+    end
+  end
 
   def self.reactivate(item_ids)
     item_ids = Array.wrap(item_ids)
@@ -141,6 +145,11 @@ def deactivate!
     end
   end
 
+  # @return [String]
+  def reporting_category_humanized
+    Item.reporting_categories[reporting_category].to_s.titleize
+  end
+
   def other?
     partner_key == "other"
   end
@@ -156,7 +165,7 @@ def to_h
   end
 
   def self.csv_export_headers
-    ["Name", "Barcodes", "Base Item", "Quantity"]
+    ["Name", "Barcodes", "Quantity"]
   end
 
   # @param items [Array<Item>]
@@ -166,7 +175,7 @@ def self.generate_csv_from_inventory(items, inventory)
     item_quantities = items.to_h { |i| [i.id, inventory.quantity_for(item_id: i.id)] }
     CSV.generate(headers: true) do |csv|
       csv_data = items.map do |item|
-        attributes = [item.name, item.barcode_count, item.base_item.name, item_quantities[item.id]]
+        attributes = [item.name, item.barcode_count, item_quantities[item.id]]
         attributes.map { |attr| normalize_csv_attribute(attr) }
       end
       ([csv_export_headers] + csv_data).each { |row| csv << row }
@@ -186,14 +195,6 @@ def sync_request_units!(unit_ids)
 
   private
 
-  # Sets reporting_category according to reporting_category of base item.
-  # TODO: Remove once items can be created with a reporting category.
-  def set_reporting_category
-    return unless reporting_category.blank?
-
-    self.reporting_category = base_item.reporting_category if base_item.reporting_category
-  end
-
   def set_default_distribution_quantity
     self.distribution_quantity ||= kit_id.present? ? 1 : 50
   end

app/models/partners/item_request.rb

@@ -24,7 +24,6 @@ class ItemRequest < Base
     validates :quantity, presence: true
     validates :quantity, numericality: { only_integer: true, greater_than_or_equal_to: 1 }
     validates :name, presence: true
-    validates :partner_key, presence: true
     validate :request_unit_is_supported
 
     def request_unit_is_supported

app/views/base_items/_dropdown.html.erb

@@ -9,9 +9,6 @@
             <!-- /.card-header -->
             <!-- form start -->
             <div class="card-body">
-              <% if @item.kit.blank? %>
-                <%= render partial: "base_items/dropdown", object: f %>
-              <% end %>
               <%= f.input :name, label: "Name", wrapper: :input_group do %>
                 <span class="input-group-text"><i class="fa fa-tag"></i></span>
                 <%= f.input_field :name, class: "form-control" %>
@@ -20,6 +17,10 @@
               <div class='w-1/4'>
                 <%= f.input :item_category_id, label: 'Category', collection: @item_categories, hint: 'Categories can help organize and identify items' %>
               </div>
+              <div class='w-1/4'>
+
+                <%= f.input :reporting_category, label: 'NDBN Reporting Category', collection: Item.reporting_categories_for_select, disabled: !!@item.kit_id, required: !@item.kit_id, hint: @reporting_category_hint %>
+              </div>
 
               <%= f.input :name, label: "Value per item", wrapper: :input_group do %>
                 <span class="input-group-text"><i class="fa fa-money"></i></span>

app/views/items/_form.html.erb

@@ -8,6 +8,7 @@
     <tr>
       <th>Category</th>
       <th>Name</th>
+      <th>NDBN Reporting Category</th>
       <th>Add. Info</th>
       <th class="text-right">Quantity Per Individual</th>
       <th class="text-right">Fair Market Value (per item)</th>

app/views/items/_item_list.html.erb

@@ -1,11 +1,12 @@
 <tr data-item-id="<%= item_row.id %>">
   <td><%= item_row.item_category && link_to(item_row.item_category&.name, item_category_path(item_row.item_category), class: 'text-blue-500') %></td>
   <td><%= item_row.name %></td>
+  <td><%= item_row.reporting_category_humanized %></td>
   <td><%= truncate item_row.additional_info, length: 25 %></td>
   <td class="text-right"> <%= item_row.distribution_quantity %></td>
   <td class="numeric"><%= dollar_value(item_row.value_in_cents) %></td>
   <% if Flipper.enabled?(:enable_packs) %>
-    <% unless current_organization.request_units.empty? %>
+    <% unless current_organization.request_units.blank? %>
      <td><%= item_row.request_units.pluck(:name).join(', ') %></td>
     <% end %>
   <% end %>

app/views/items/_item_row.html.erb

@@ -37,7 +37,7 @@
             <%= form_tag(items_path, method: :get) do |f| %>
               <div class="row">
                 <div class="form-group col-lg-3 col-md-4 col-sm-6 col-xs-12">
-                  <%= filter_select(scope: :by_base_item, collection: BaseItem.alphabetized, key: :partner_key, selected: @selected_base_item) %>
+                  <%= filter_select(scope: :by_reporting_category, label: "Filter by NDBN Reporting Category", collection: Item.reporting_categories_for_select, selected: @selected_reporting_category) %>
                 </div>
               </div>
               <div class="row">

app/views/items/index.html.erb

@@ -31,10 +31,6 @@
           <div class="card-body p-0">
             <table class="table">
             <tbody>
-              <tr>
-                <th>Base Item</th>
-                <td><%= @item.base_item.name %></td>
-              </tr>
               <tr>
                 <th>Name</th>
                 <td><%= @item.name %></td>
@@ -43,6 +39,10 @@
                 <th>Category</th>
                 <td><%= @item&.item_category&.name %></td>
               </tr>
+              <tr>
+                <th>NDBN Reporting Category</th>
+                <td><%= @item.reporting_category_humanized %><%= @reporting_category_hint %></td>
+              </tr>
               <tr>
                 <th>Value Per Item</th>
                 <td>$<%= @item.value_in_dollars || 0 %></td>