Nested Categories (#1561)

* Prepare entry search for nested categories

* Subcategory implementation

* Remove caching for test stability

app/controllers/categories_controller.rb

@@ -10,6 +10,7 @@ class CategoriesController < ApplicationController
 
   def new
     @category = Current.family.categories.new color: Category::COLORS.sample
+    @categories = Current.family.categories.alphabetically.where(parent_id: nil).where.not(id: @category.id)
   end
 
   def create
@@ -17,19 +18,21 @@ class CategoriesController < ApplicationController
 
     if @category.save
       @transaction.update(category_id: @category.id) if @transaction
-      redirect_back_or_to transactions_path, notice: t(".success")
+
+      redirect_back_or_to categories_path, notice: t(".success")
     else
-      redirect_back_or_to transactions_path, alert: t(".failure", error: @category.errors.full_messages.to_sentence)
+      render :new, status: :unprocessable_entity
     end
   end
 
   def edit
+    @categories = Current.family.categories.alphabetically.where(parent_id: nil).where.not(id: @category.id)
   end
 
   def update
     @category.update! category_params
 
-    redirect_back_or_to transactions_path, notice: t(".success")
+    redirect_back_or_to categories_path, notice: t(".success")
   end
 
   def destroy
@@ -38,6 +41,12 @@ class CategoriesController < ApplicationController
     redirect_back_or_to categories_path, notice: t(".success")
   end
 
+  def bootstrap
+    Current.family.categories.bootstrap_defaults
+
+    redirect_back_or_to categories_path, notice: t(".success")
+  end
+
   private
     def set_category
       @category = Current.family.categories.find(params[:id])
@@ -50,6 +59,6 @@ class CategoriesController < ApplicationController
     end
 
     def category_params
-      params.require(:category).permit(:name, :color)
+      params.require(:category).permit(:name, :color, :parent_id)
     end
 end

app/controllers/registrations_controller.rb

@@ -24,7 +24,6 @@ class RegistrationsController < ApplicationController
 
     if @user.save
       @invitation&.update!(accepted_at: Time.current)
-      Category.create_default_categories(@user.family) unless @invitation
       @session = create_session_for(@user)
       redirect_to root_path, notice: t(".success")
     else

app/controllers/transactions_controller.rb

@@ -3,13 +3,13 @@ class TransactionsController < ApplicationController
 
   def index
     @q = search_params
-    result = Current.family.entries.account_transactions.search(@q).reverse_chronological
-    @pagy, @transaction_entries = pagy(result, limit: params[:per_page] || "50")
+    search_query = Current.family.transactions.search(@q).includes(:entryable).reverse_chronological
+    @pagy, @transaction_entries = pagy(search_query, limit: params[:per_page] || "50")
 
     @totals = {
-      count: result.select { |t| t.currency == Current.family.currency }.count,
-      income: result.income_total(Current.family.currency).abs,
-      expense: result.expense_total(Current.family.currency)
+      count: search_query.select { |t| t.currency == Current.family.currency }.count,
+      income: search_query.income_total(Current.family.currency).abs,
+      expense: search_query.expense_total(Current.family.currency)
     }
   end
 

app/models/account/entry.rb

@@ -60,6 +60,10 @@ class Account::Entry < ApplicationRecord
   end
 
   class << self
+    def search(params)
+      Account::EntrySearch.new(params).build_query(all)
+    end
+
     # arbitrary cutoff date to avoid expensive sync operations
     def min_supported_date
       30.years.ago.to_date
@@ -141,49 +145,7 @@ class Account::Entry < ApplicationRecord
       Money.new(total, currency)
     end
 
-    def search(params)
-      query = all
-      query = query.where("account_entries.name ILIKE ?", "%#{sanitize_sql_like(params[:search])}%") if params[:search].present?
-      query = query.where("account_entries.date >= ?", params[:start_date]) if params[:start_date].present?
-      query = query.where("account_entries.date <= ?", params[:end_date]) if params[:end_date].present?
-
-      if params[:types].present?
-        query = query.where(marked_as_transfer: false) unless params[:types].include?("transfer")
-
-        if params[:types].include?("income") && !params[:types].include?("expense")
-          query = query.where("account_entries.amount < 0")
-        elsif params[:types].include?("expense") && !params[:types].include?("income")
-          query = query.where("account_entries.amount >= 0")
-        end
-      end
-
-      if params[:amount].present? && params[:amount_operator].present?
-        case params[:amount_operator]
-        when "equal"
-          query = query.where("ABS(ABS(account_entries.amount) - ?) <= 0.01", params[:amount].to_f.abs)
-        when "less"
-          query = query.where("ABS(account_entries.amount) < ?", params[:amount].to_f.abs)
-        when "greater"
-          query = query.where("ABS(account_entries.amount) > ?", params[:amount].to_f.abs)
-        end
-      end
-
-      if params[:accounts].present? || params[:account_ids].present?
-        query = query.joins(:account)
-      end
-
-      query = query.where(accounts: { name: params[:accounts] }) if params[:accounts].present?
-      query = query.where(accounts: { id: params[:account_ids] }) if params[:account_ids].present?
-
-      # Search attributes on each entryable to further refine results
-      entryable_ids = entryable_search(params)
-      query = query.where(entryable_id: entryable_ids) unless entryable_ids.nil?
-
-      query
-    end
-
     private
-
       def entryable_search(params)
         entryable_ids = []
         entryable_search_performed = false

app/models/account/entry_search.rb

@@ -0,0 +1,59 @@
+class Account::EntrySearch
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+
+  attribute :search, :string
+  attribute :amount, :string
+  attribute :amount_operator, :string
+  attribute :types, :string
+  attribute :accounts, :string
+  attribute :account_ids, :string
+  attribute :start_date, :string
+  attribute :end_date, :string
+
+  class << self
+    def from_entryable_search(entryable_search)
+      new(entryable_search.attributes.slice(*attribute_names))
+    end
+  end
+
+  def build_query(scope)
+    query = scope
+
+    query = query.where("account_entries.name ILIKE :search OR account_entries.enriched_name ILIKE :search",
+      search: "%#{ActiveRecord::Base.sanitize_sql_like(search)}%"
+    ) if search.present?
+    query = query.where("account_entries.date >= ?", start_date) if start_date.present?
+    query = query.where("account_entries.date <= ?", end_date) if end_date.present?
+
+    if types.present?
+      query = query.where(marked_as_transfer: false) unless types.include?("transfer")
+
+      if types.include?("income") && !types.include?("expense")
+        query = query.where("account_entries.amount < 0")
+      elsif types.include?("expense") && !types.include?("income")
+        query = query.where("account_entries.amount >= 0")
+      end
+    end
+
+    if amount.present? && amount_operator.present?
+      case amount_operator
+      when "equal"
+        query = query.where("ABS(ABS(account_entries.amount) - ?) <= 0.01", amount.to_f.abs)
+      when "less"
+        query = query.where("ABS(account_entries.amount) < ?", amount.to_f.abs)
+      when "greater"
+        query = query.where("ABS(account_entries.amount) > ?", amount.to_f.abs)
+      end
+    end
+
+    if accounts.present? || account_ids.present?
+      query = query.joins(:account)
+    end
+
+    query = query.where(accounts: { name: accounts }) if accounts.present?
+    query = query.where(accounts: { id: account_ids }) if account_ids.present?
+
+    query
+  end
+end

app/models/account/trade.rb

@@ -8,26 +8,8 @@ class Account::Trade < ApplicationRecord
   validates :qty, presence: true
   validates :price, :currency, presence: true
 
-  class << self
-    def search(_params)
-      all
-    end
-
-    def requires_search?(_params)
-      false
-    end
-  end
-
-  def sell?
-    qty < 0
-  end
-
-  def buy?
-    qty > 0
-  end
-
   def unrealized_gain_loss
-    return nil if sell?
+    return nil if qty.negative?
     current_price = security.current_price
     return nil if current_price.nil?
 

app/models/account/transaction.rb

@@ -12,52 +12,7 @@ class Account::Transaction < ApplicationRecord
 
   class << self
     def search(params)
-      query = all
-      if params[:categories].present?
-        if params[:categories].exclude?("Uncategorized")
-          query = query
-                    .joins(:category)
-                    .where(categories: { name: params[:categories] })
-        else
-          query = query
-                    .left_joins(:category)
-                    .where(categories: { name: params[:categories] })
-                    .or(query.where(category_id: nil))
-        end
-      end
-
-      query = query.joins(:merchant).where(merchants: { name: params[:merchants] }) if params[:merchants].present?
-
-      if params[:tags].present?
-        query = query.joins(:tags)
-                     .where(tags: { name: params[:tags] })
-                     .distinct
-      end
-
-      query
+      Account::TransactionSearch.new(params).build_query(all)
     end
-
-    def requires_search?(params)
-      searchable_keys.any? { |key| params.key?(key) }
-    end
-
-    private
-
-      def searchable_keys
-        %i[categories merchants tags]
-      end
   end
-
-  def eod_balance
-    entry.amount_money
-  end
-
-  private
-    def account
-      entry.account
-    end
-
-    def daily_transactions
-      account.entries.account_transactions
-    end
 end

app/models/account/transaction_search.rb

@@ -0,0 +1,42 @@
+class Account::TransactionSearch
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+
+  attribute :search, :string
+  attribute :amount, :string
+  attribute :amount_operator, :string
+  attribute :types, array: true
+  attribute :accounts, array: true
+  attribute :account_ids, array: true
+  attribute :start_date, :string
+  attribute :end_date, :string
+  attribute :categories, array: true
+  attribute :merchants, array: true
+  attribute :tags, array: true
+
+  # Returns array of Account::Entry objects to stay consistent with partials, which only deal with Account::Entry
+  def build_query(scope)
+    query = scope
+
+    if categories.present?
+      if categories.exclude?("Uncategorized")
+        query = query
+                  .joins(:category)
+                  .where(categories: { name: categories })
+      else
+        query = query
+                  .left_joins(:category)
+                  .where(categories: { name: categories })
+                  .or(query.where(category_id: nil))
+      end
+    end
+
+    query = query.joins(:merchant).where(merchants: { name: merchants }) if merchants.present?
+
+    query = query.joins(:tags).where(tags: { name: tags }) if tags.present?
+
+    entries_scope = Account::Entry.account_transactions.where(entryable_id: query.select(:id))
+
+    Account::EntrySearch.from_entryable_search(self).build_query(entries_scope)
+  end
+end

app/models/account/valuation.rb

@@ -1,13 +1,3 @@
 class Account::Valuation < ApplicationRecord
   include Account::Entryable
-
-  class << self
-    def search(_params)
-      all
-    end
-
-    def requires_search?(_params)
-      false
-    end
-  end
 end

app/models/category.rb

@@ -1,12 +1,16 @@
 class Category < ApplicationRecord
   has_many :transactions, dependent: :nullify, class_name: "Account::Transaction"
   has_many :import_mappings, as: :mappable, dependent: :destroy, class_name: "Import::Mapping"
+
   belongs_to :family
 
+  has_many :subcategories, class_name: "Category", foreign_key: :parent_id
+  belongs_to :parent, class_name: "Category", optional: true
+
   validates :name, :color, :family, presence: true
   validates :name, uniqueness: { scope: :family_id }
 
-  before_update :clear_internal_category, if: :name_changed?
+  validate :category_level_limit
 
   scope :alphabetically, -> { order(:name) }
 
@@ -14,30 +18,55 @@ class Category < ApplicationRecord
 
   UNCATEGORIZED_COLOR = "#737373"
 
-  DEFAULT_CATEGORIES = [
-    { internal_category: "income", color: COLORS[0] },
-    { internal_category: "food_and_drink", color: COLORS[1] },
-    { internal_category: "entertainment", color: COLORS[2] },
-    { internal_category: "personal_care", color: COLORS[3] },
-    { internal_category: "general_services", color: COLORS[4] },
-    { internal_category: "auto_and_transport", color: COLORS[5] },
-    { internal_category: "rent_and_utilities", color: COLORS[6] },
-    { internal_category: "home_improvement", color: COLORS[7] }
-  ]
+  class Group
+    attr_reader :category, :subcategories
 
-  def self.create_default_categories(family)
-    if family.categories.size > 0
-      raise ArgumentError, "Family already has some categories"
+    delegate :name, :color, to: :category
+
+    def self.for(categories)
+      categories.select { |category| category.parent_id.nil? }.map do |category|
+        new(category, category.subcategories)
+      end
     end
 
-    family_id = family.id
-    categories = self::DEFAULT_CATEGORIES.map { |c| {
-      name: I18n.t("transaction.default_category.#{c[:internal_category]}"),
-      internal_category: c[:internal_category],
-      color: c[:color],
-      family_id:
-    } }
-    self.insert_all(categories)
+    def initialize(category, subcategories = nil)
+      @category = category
+      @subcategories = subcategories || []
+    end
+  end
+
+  class << self
+    def bootstrap_defaults
+      default_categories.each do |name, color|
+        find_or_create_by!(name: name) do |category|
+          category.color = color
+        end
+      end
+    end
+
+    private
+      def default_categories
+        [
+          [ "Income", "#e99537" ],
+          [ "Loan Payments", "#6471eb" ],
+          [ "Bank Fees", "#db5a54" ],
+          [ "Entertainment", "#df4e92" ],
+          [ "Food & Drink", "#c44fe9" ],
+          [ "Groceries", "#eb5429" ],
+          [ "Dining Out", "#61c9ea" ],
+          [ "General Merchandise", "#805dee" ],
+          [ "Clothing & Accessories", "#6ad28a" ],
+          [ "Electronics", "#e99537" ],
+          [ "Healthcare", "#4da568" ],
+          [ "Insurance", "#6471eb" ],
+          [ "Utilities", "#db5a54" ],
+          [ "Transportation", "#df4e92" ],
+          [ "Gas & Fuel", "#c44fe9" ],
+          [ "Education", "#eb5429" ],
+          [ "Charitable Donations", "#61c9ea" ],
+          [ "Subscriptions", "#805dee" ]
+        ]
+      end
   end
 
   def replace_and_destroy!(replacement)
@@ -47,9 +76,14 @@ class Category < ApplicationRecord
     end
   end
 
-  private
+  def subcategory?
+    parent.present?
+  end
 
-    def clear_internal_category
-      self.internal_category = nil
+  private
+    def category_level_limit
+      if subcategory? && parent.subcategory?
+        errors.add(:parent, "can't have more than 2 levels of subcategories")
+      end
     end
 end

app/models/demo/generator.rb

@@ -90,6 +90,11 @@ class Demo::Generator
       categories.each do |category|
         family.categories.create!(name: category, color: COLORS.sample)
       end
+
+      food = family.categories.find_by(name: "Food & Drink")
+      family.categories.create!(name: "Restaurants", parent_category: food)
+      family.categories.create!(name: "Groceries", parent_category: food)
+      family.categories.create!(name: "Alcohol & Bars", parent_category: food)
     end
 
     def create_merchants!

app/views/account/trades/_header.html.erb

@@ -34,7 +34,7 @@
             <dd class="text-gray-900"><%= trade.security.ticker %></dd>
           </div>
 
-          <% if trade.buy? %>
+          <% if trade.qty.positive? %>
             <div class="flex items-center justify-between text-sm">
               <dt class="text-gray-500"><%= t(".purchase_qty_label") %></dt>
               <dd class="text-gray-900"><%= trade.qty.abs %></dd>
@@ -53,7 +53,7 @@
             </div>
           <% end %>
 
-          <% if trade.buy? && trade.unrealized_gain_loss.present? %>
+          <% if trade.qty.positive? && trade.unrealized_gain_loss.present? %>
             <div class="flex items-center justify-between text-sm">
               <dt class="text-gray-500"><%= t(".total_return_label") %></dt>
               <dd style="color: <%= trade.unrealized_gain_loss.color %>;">

app/views/categories/_badge.html.erb

@@ -2,7 +2,7 @@
 <% category ||= null_category %>
 
 <div>
-  <span class="flex items-center gap-1 text-sm font-medium rounded-full px-1.5 py-1 border"
+  <span class="flex items-center gap-1 text-sm font-medium rounded-full px-1.5 py-1 border truncate"
         style="
           background-color: color-mix(in srgb, <%= category.color %> 5%, white);
           border-color: color-mix(in srgb, <%= category.color %> 30%, white);

app/views/categories/_category.html.erb

@@ -1,7 +1,11 @@
 <%# locals: (category:) %>
 
-<div id="<%= dom_id(category) %>" class="flex justify-between items-center p-4 bg-white">
+<div id="<%= dom_id(category) %>" class="flex justify-between items-center px-4 pb-4 <%= "pt-4" unless category.subcategory? %> <%= "pb-4" unless category.subcategories.any? %> bg-white">
   <div class="flex w-full items-center gap-2.5">
+    <% if category.subcategory? %>
+      <%= lucide_icon "corner-down-right", class: "shrink-0 w-5 h-5 text-gray-400 ml-2" %>
+    <% end %>
+
     <%= render partial: "categories/badge", locals: { category: category } %>
   </div>
   <div class="justify-self-end">

app/views/categories/_form.html.erb

@@ -1,9 +1,12 @@
+<%# locals: (category:, categories:) %>
+
 <div data-controller="color-avatar">
   <%= styled_form_with model: category, class: "space-y-4", data: { turbo_frame: :_top } do |f| %>
     <section class="space-y-4">
       <div class="w-fit m-auto">
         <%= render partial: "shared/color_avatar", locals: { name: category.name, color: category.color } %>
       </div>
+
       <div class="flex gap-2 items-center justify-center">
         <% Category::COLORS.each do |color| %>
           <label class="relative">
@@ -12,8 +15,14 @@
           </label>
         <% end %>
       </div>
-      <div class="relative flex items-center border border-gray-200 rounded-lg">
-        <%= f.text_field :name, placeholder: t(".placeholder"), required: true, autofocus: true, data: { color_avatar_target: "name" } %>
+
+      <% if category.errors.any? %>
+        <%= render "shared/form_errors", model: category %>
+      <% end %>
+
+      <div class="space-y-2">
+        <%= f.text_field :name, placeholder: t(".placeholder"), required: true, autofocus: true, label: "Name", data: { color_avatar_target: "name" } %>
+        <%= f.select :parent_id, categories.pluck(:name, :id), { include_blank: "(unassigned)", label: "Parent category (optional)" } %>
       </div>
     </section>
 

app/views/categories/_menu.html.erb

@@ -5,7 +5,7 @@
     <%= render partial: "categories/badge", locals: { category: transaction.category } %>
   </button>
   <div data-menu-target="content" class="absolute z-10 hidden w-screen mt-2 max-w-min cursor-default">
-    <div class="w-64 text-sm font-semibold leading-6 text-gray-900 bg-white shadow-lg shrink rounded-xl ring-1 ring-gray-900/5">
+    <div class="w-80 text-sm font-semibold leading-6 text-gray-900 bg-white shadow-lg shrink rounded-xl ring-1 ring-gray-900/5">
       <%= turbo_frame_tag "category_dropdown", src: category_dropdown_path(category_id: transaction.category_id, transaction_id: transaction.id), loading: :lazy do %>
         <div class="p-6 flex items-center justify-center">
           <p class="text-sm text-gray-500 animate-pulse"><%= t(".loading") %></p>

app/views/categories/edit.html.erb

@@ -1,3 +1,3 @@
 <%= modal_form_wrapper title: t(".edit") do %>
-  <%= render "form", category: @category %>
+  <%= render "form", category: @category, categories: @categories %>
 <% end %>

app/views/categories/index.html.erb

@@ -23,18 +23,32 @@
 
         <div class="border border-alpha-black-25 rounded-md bg-white shadow-xs">
           <div class="overflow-hidden rounded-md">
-            <%= render partial: @categories, spacer_template: "categories/ruler" %>
+            <% Category::Group.for(@categories).each_with_index do |group, idx| %>
+              <%= render group.category %>
+
+              <% group.subcategories.each do |subcategory| %>
+                <%= render subcategory %>
+              <% end %>
+
+              <% unless idx == Category::Group.for(@categories).count - 1 %>
+                <%= render "categories/ruler" %>
+              <% end %>
+            <% end %>
           </div>
         </div>
       </div>
     <% else %>
       <div class="flex justify-center items-center py-20">
-        <div class="text-center flex flex-col items-center max-w-[300px]">
-          <p class="text-gray-900 mb-1 font-medium text-sm"><%= t(".empty") %></p>
-          <%= link_to new_category_path, class: "w-fit flex text-white text-sm font-medium items-center gap-1 bg-gray-900 rounded-lg p-2 pr-3", data: { turbo_frame: "modal" } do %>
-            <%= lucide_icon("plus", class: "w-5 h-5") %>
-            <span><%= t(".new") %></span>
-          <% end %>
+        <div class="text-center flex flex-col items-center max-w-[500px]">
+          <p class="text-sm text-gray-500 mb-4"><%= t(".empty") %></p>
+          <div class="flex items-center gap-2">
+            <%= button_to t(".bootstrap"), bootstrap_categories_path, class: "btn btn--primary" %>
+
+            <%= link_to new_category_path, class: "btn btn--outline flex items-center gap-1", data: { turbo_frame: "modal" } do %>
+              <%= lucide_icon("plus", class: "w-5 h-5") %>
+              <span><%= t(".new") %></span>
+            <% end %>
+          </div>
         </div>
       </div>
     <% end %>

app/views/categories/new.html.erb

@@ -1,3 +1,3 @@
 <%= modal_form_wrapper title: t(".new_category") do %>
-  <%= render "form", category: @category %>
+  <%= render "form", category: @category, categories: @categories %>
 <% end %>

app/views/category/dropdowns/_row.html.erb

@@ -15,6 +15,9 @@
     <span class="w-5 h-5">
       <%= lucide_icon("check", class: "w-5 h-5 text-gray-500") if is_selected %>
     </span>
+    <% if category.subcategory? %>
+      <%= lucide_icon "corner-down-right", class: "shrink-0 w-5 h-5 text-gray-400" %>
+    <% end %>
     <%= render partial: "categories/badge", locals: { category: category } %>
   <% end %>
 

app/views/category/dropdowns/show.html.erb

@@ -10,8 +10,21 @@
       <div class="pb-2 pl-4 mr-2 text-gray-500 hidden" data-list-filter-target="emptyMessage">
         <%= t(".no_categories") %>
       </div>
-      <% @categories.each do |category| %>
-        <%= render partial: "category/dropdowns/row", locals: { category: } %>
+      <% if @categories.any? %>
+        <% Category::Group.for(@categories).each do |group| %>
+          <%= render "category/dropdowns/row", category: group.category %>
+
+          <% group.subcategories.each do |category| %>
+            <%= render "category/dropdowns/row", category: category %>
+          <% end %>
+        <% end %>
+      <% else %>
+        <div class="flex justify-center items-center py-12">
+          <div class="text-center flex flex-col items-center max-w-[500px]">
+            <p class="text-sm text-gray-500 font-normal mb-4"><%= t(".empty") %></p>
+            <%= button_to t(".bootstrap"), bootstrap_categories_path, class: "btn btn--outline", data: { turbo_frame: :_top } %>
+          </div>
+        </div>
       <% end %>
     </div>
     <hr>