Kit definition part 1 (#1904)

* Add initial models

* Use itemizable

* Add ability to create a kit

* Have Kit be a subclass of Item

* Go back to separate kit model

* Remove storage location from the Kit and add a Kits tab to the items views

* Add new inventory subtab for kits

* Get filtering of kits working and fix a couple index related bugs and inconsistencies

* Add a kit flipper flag

* Fix a couple rubocop violations

* Add a few kit specs

* Add new validation on kits for having at least one item present and update specs

* Fix unused variable and unneeded form fields

* Fix kits factory

* Add value to kits

Author: Matthew Russell Dodds

app/controllers/items_controller.rb

@@ -3,6 +3,7 @@
 class ItemsController < ApplicationController
   def index
     @items = current_organization.items.includes(:base_item).alphabetized.class_filter(filter_params)
+    @kits = current_organization.kits.includes(line_items: :item)
     @storages = current_organization.storage_locations.order(id: :asc)
 
     @include_inactive_items = params[:include_inactive_items]

app/controllers/kits_controller.rb

@@ -0,0 +1,51 @@
+class KitsController < ApplicationController
+  def index
+    @kits = current_organization.kits.class_filter(filter_params)
+    @selected_item = filter_params[:by_partner_key]
+    @include_inactive = params[:include_inactive]
+    unless params[:include_inactive]
+      @kits = @kits.active
+    end
+  end
+
+  def new
+    load_form_collections
+    @kit = current_organization.kits.new
+    @kit.line_items.build
+  end
+
+  def create
+    @kit = current_organization.kits.new(kit_params)
+    @kit.organization_id = current_organization.id
+    if @kit.save
+      flash[:notice] = "Kit created successfully"
+      redirect_to kits_path
+    else
+      flash[:error] = @kit.errors.full_messages.to_sentence
+      load_form_collections
+      @kit.line_items.build
+      render :new
+    end
+  end
+
+  private
+
+  def load_form_collections
+    @items = current_organization.items.active.alphabetized
+  end
+
+  def kit_params
+    params.require(:kit).permit(
+      :name,
+      :visible_to_partners,
+      :value_in_dollars,
+      line_items_attributes: [:item_id, :quantity, :_destroy]
+    )
+  end
+
+  def filter_params
+    return {} unless params.key?(:filters)
+
+    params.require(:filters).slice(:by_partner_key, :include_inactive_items)
+  end
+end

app/models/concerns/valuable.rb

@@ -0,0 +1,15 @@
+module Valuable
+  extend ActiveSupport::Concern
+
+  included do
+    validates :value_in_cents, numericality: { greater_than_or_equal_to: 0 }
+  end
+
+  def value_in_dollars
+    value_in_cents.to_d / 100
+  end
+
+  def value_in_dollars=(dollars)
+    self.value_in_cents = dollars.to_d * 100
+  end
+end

app/models/distribution.rb

@@ -29,22 +29,20 @@ class Distribution < ApplicationRecord
   # Distributions contain many different items
   include Itemizable
   include Exportable
+  include IssuedAt
+  include Filterable
 
   has_one :request, dependent: :nullify
   accepts_nested_attributes_for :request
 
   validates :storage_location, :partner, :organization, :delivery_method, presence: true
   validate :line_item_items_exist_in_inventory
 
-  include IssuedAt
-
   before_save :combine_distribution
 
   enum state: { started: 0, scheduled: 5, complete: 10 }
-
   enum delivery_method: { pick_up: 0, delivery: 1 }
 
-  include Filterable
   # add item_id scope to allow filtering distributions by item
   scope :by_item_id, ->(item_id) { joins(:items).where(items: { id: item_id }) }
   # partner scope to allow filtering by partner

app/models/item.rb

@@ -20,12 +20,16 @@
 #
 
 class Item < ApplicationRecord
+  include Filterable
+  include Exportable
+  include Valuable
+
   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
+
   validates :name, uniqueness: { scope: :organization }
   validates :name, presence: true
   validates :organization, presence: true
-  validates :value_in_cents, numericality: { greater_than_or_equal_to: 0 }
 
   has_many :line_items, dependent: :destroy
   has_many :inventory_items, dependent: :destroy
@@ -34,8 +38,6 @@ class Item < ApplicationRecord
   has_many :donations, through: :line_items, source: :itemizable, source_type: Donation
   has_many :distributions, through: :line_items, source: :itemizable, source_type: Distribution
 
-  include Filterable
-  include Exportable
   scope :active, -> { where(active: true) }
   scope :visible, -> { where(visible_to_partners: true) }
   scope :alphabetized, -> { order(:name) }
@@ -70,10 +72,6 @@ def other?
     partner_key == "other"
   end
 
-  def value_in_dollars
-    value_in_cents.to_d / 100
-  end
-
   # Override `destroy` to ensure Item isn't accidentally destroyed
   # without first being disassociated with its historical presence
   def destroy

app/models/kit.rb

@@ -0,0 +1,35 @@
+# == Schema Information
+#
+# Table name: kits
+#
+#  id                  :bigint           not null, primary key
+#  active              :boolean          default(TRUE)
+#  name                :string
+#  value_in_cents      :integer          default(0)
+#  visible_to_partners :boolean          default(TRUE), not null
+#  created_at          :datetime         not null
+#  updated_at          :datetime         not null
+#  organization_id     :integer
+#
+class Kit < ApplicationRecord
+  include Itemizable
+  include Filterable
+  include Valuable
+
+  belongs_to :organization
+
+  scope :active, -> { where(active: true) }
+  scope :alphabetized, -> { order(:name) }
+  scope :by_partner_key, ->(key) { joins(:items).where(items: { partner_key: key }) }
+
+  validates :organization, :name, presence: true
+  validate :at_least_one_item
+
+  private
+
+  def at_least_one_item
+    unless line_items.any?
+      errors.add(:base, 'At least one item is required')
+    end
+  end
+end

app/models/organization.rb

@@ -36,26 +36,25 @@ class Organization < ApplicationRecord
   validates :reminder_day, numericality: { only_integer: true, less_than_or_equal_to: 14, greater_than_or_equal_to: 1, allow_nil: true }
   validate :deadline_after_reminder
 
-  has_many :adjustments, dependent: :destroy
-  has_many :barcode_items, dependent: :destroy do
-    def all
-      unscope(where: :organization_id).where("barcode_items.organization_id = ? OR barcode_items.barcodeable_type = ?", proxy_association.owner.id, "BaseItem")
-    end
+  with_options dependent: :destroy do
+    has_many :adjustments
+    has_many :audits
+    has_many :diaper_drive_participants
+    has_many :diaper_drives
+    has_many :donation_sites
+    has_many :donations
+    has_many :manufacturers
+    has_many :partners
+    has_many :purchases
+    has_many :requests
+    has_many :storage_locations
+    has_many :inventory_items, through: :storage_locations
+    has_many :kits
+    has_many :transfers
+    has_many :users
+    has_many :vendors
   end
-  has_many :distributions, dependent: :destroy do
-    def upcoming
-      this_week.scheduled.where('issued_at >= ?', Time.zone.today)
-    end
-  end
-  has_many :donations, dependent: :destroy
-  has_many :purchases, dependent: :destroy
-  has_many :donation_sites, dependent: :destroy
-  has_many :diaper_drives, dependent: :destroy
-  has_many :diaper_drive_participants, dependent: :destroy
-  has_many :manufacturers, dependent: :destroy
-  has_many :vendors, dependent: :destroy
-  has_many :storage_locations, dependent: :destroy
-  has_many :inventory_items, through: :storage_locations
+
   has_many :items, dependent: :destroy do
     def other
       where(partner_key: "other")
@@ -78,11 +77,17 @@ def bottom(limit = 5)
         .limit(limit)
     end
   end
-  has_many :partners, dependent: :destroy
-  has_many :transfers, dependent: :destroy
-  has_many :users, dependent: :destroy
-  has_many :requests, dependent: :destroy
-  has_many :audits, dependent: :destroy
+  has_many :barcode_items, dependent: :destroy do
+    def all
+      unscope(where: :organization_id).where("barcode_items.organization_id = ? OR barcode_items.barcodeable_type = ?", proxy_association.owner.id, "BaseItem")
+    end
+  end
+  has_many :distributions, dependent: :destroy do
+    def upcoming
+      this_week.scheduled.where('issued_at >= ?', Time.zone.today)
+    end
+  end
+
   before_update :update_partner_sections, if: :partner_form_fields_changed?
 
   ALL_PARTIALS = [

app/views/items/_kits.html.erb

@@ -0,0 +1,3 @@
+<div class="tab-pane fade" id="custom-tabs-three-kits" role="tabpanel" aria-labelledby="custom-tabs-three-kits-tab">
+  <%= render partial: 'kits/table' %>
+</div>

app/views/items/index.html.erb

@@ -55,6 +55,9 @@
 
                   <%= download_button_to(csv_path(format: :csv, type: "Item"), {text: "Export Items"}) if @items.any? %>
                   <%= new_button_to new_item_path(organization_id: current_organization), {text: "New Item"} %>
+                  <% if Flipper.enabled?(:kits) %>
+                    <%= new_button_to new_kit_path(organization_id: current_organization), {text: "New Kit"} %>
+                  <% end %>
                   </span>
               </div>
             <% end # form %>
@@ -82,18 +85,24 @@
                 <a class="nav-link" id="custom-tabs-three-profile-tab" data-toggle="pill" href="#custom-tabs-three-profile" role="tab" aria-controls="custom-tabs-three-profile" aria-selected="false">Items,
                   Quantity, and Location</a>
               </li>
+              <% if Flipper.enabled?(:kits) %>
+                <li class="nav-item">
+                  <a class="nav-link" id="custom-tabs-three-kits-tab" data-toggle="pill" href="#custom-tabs-three-kits" role="tab" aria-controls="custom-tabs-three-kits" aria-selected="false">Kits</a>
+                </li>
+              <% end %>
             </ul>
           </div>
           <div class="card-body">
             <div class="tab-content" id="custom-tabs-three-tabContent">
-
               <%= render partial: 'item_list' %>
-
               <%= render partial: 'items_quantity_and_location' %>
+              <% if Flipper.enabled?(:kits) %>
+                <%= render partial: 'kits' %>
+              <% end %>
             </div>
           </div>
         </div>
       </div>
     </div>
   </div>
-</section>
+</section>

app/views/kits/_form.html.erb

@@ -0,0 +1,44 @@
+<%= simple_form_for @kit, remote: request.xhr?, html: { class: 'form-horizontal' } do |f| %>
+  <section class="content">
+    <div class="container-fluid">
+      <div class="row">
+        <div class="col-md-12">
+          <div class="card card-primary">
+            <div class="card-body">
+              <%= 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" %>
+              <% end %>
+
+              <%= f.input :visible, label: "Item is Visible to Partners?", wrapper: :input_group do %>
+                <%= f.check_box :visible_to_partners, {class: "input-group-text", id: "visible_to_partners"}, "true", "false" %>
+              <% end %>
+
+              <%= f.input :value_in_cents, label: "Value for kit", wrapper: :input_group do %>
+                <span class="input-group-text"><i class="fa fa-dollar"></i></span>
+                <%= f.input_field :value_in_dollars, class: "form-control", min: 0 %>
+              <% end %>
+
+              <fieldset style="margin-bottom: 2rem;" class="form-inline">
+                <legend>Items in this Kit</legend>
+                <%= f.simple_fields_for :line_items do |item| %>
+                  <div id="kit_line_items" class="line-item-fields" data-capture-barcode="true">
+                    <%= render 'line_items/line_item_fields', f: item %>
+                  </div>
+                <% end %>
+                <div class="row links">
+                  <div class="col-xs-12">
+                    <%= add_line_item_button f, "#kit_line_items" %>
+                  </div>
+                </div>
+              </fieldset>
+
+            </div>
+            <div class="card-footer">
+              <%= submit_button %>
+            </div>
+          </div>
+        </div>
+      </div>
+  </section>
+<% end %>