mirror of
https://github.com/we-promise/sure.git
synced 2026-04-10 15:54:48 +00:00
8ed69132cf
- Added server-side validation to Category model to enforce 6-digit hex format for colors. - Added HTML pattern attribute to category form for client-side validation. - Updated tests to cover validation and fixed existing tests using shorthand hex colors.
277 lines
11 KiB
Ruby
277 lines
11 KiB
Ruby
class Category < ApplicationRecord
|
|
has_many :transactions, dependent: :nullify, class_name: "Transaction"
|
|
has_many :import_mappings, as: :mappable, dependent: :destroy, class_name: "Import::Mapping"
|
|
|
|
belongs_to :family
|
|
|
|
has_many :budget_categories, dependent: :destroy
|
|
has_many :subcategories, class_name: "Category", foreign_key: :parent_id, dependent: :nullify
|
|
belongs_to :parent, class_name: "Category", optional: true
|
|
|
|
validates :name, :color, :lucide_icon, :family, presence: true
|
|
validates :color, format: { with: /\A#[0-9A-Fa-f]{6}\z/ }
|
|
validates :name, uniqueness: { scope: :family_id }
|
|
|
|
validate :category_level_limit
|
|
|
|
before_save :inherit_color_from_parent
|
|
|
|
scope :alphabetically, -> { order(:name) }
|
|
scope :alphabetically_by_hierarchy, -> {
|
|
left_joins(:parent)
|
|
.order(Arel.sql("COALESCE(parents_categories.name, categories.name)"))
|
|
.order(Arel.sql("parents_categories.name IS NOT NULL"))
|
|
.order(:name)
|
|
}
|
|
scope :roots, -> { where(parent_id: nil) }
|
|
# Legacy scopes - classification removed; these now return all categories
|
|
scope :incomes, -> { all }
|
|
scope :expenses, -> { all }
|
|
|
|
COLORS = %w[#e99537 #4da568 #6471eb #db5a54 #df4e92 #c44fe9 #eb5429 #61c9ea #805dee #6ad28a]
|
|
|
|
UNCATEGORIZED_COLOR = "#737373"
|
|
OTHER_INVESTMENTS_COLOR = "#e99537"
|
|
TRANSFER_COLOR = "#444CE7"
|
|
PAYMENT_COLOR = "#db5a54"
|
|
TRADE_COLOR = "#e99537"
|
|
|
|
ICON_KEYWORDS = {
|
|
/income|salary|paycheck|wage|earning/ => "circle-dollar-sign",
|
|
/groceries|grocery|supermarket/ => "shopping-bag",
|
|
/food|dining|restaurant|meal|lunch|dinner|breakfast/ => "utensils",
|
|
/coffee|cafe|café/ => "coffee",
|
|
/shopping|retail/ => "shopping-cart",
|
|
/transport|transit|commute|subway|metro/ => "bus",
|
|
/parking/ => "circle-parking",
|
|
/car|auto|vehicle/ => "car",
|
|
/gas|fuel|petrol/ => "fuel",
|
|
/flight|airline/ => "plane",
|
|
/travel|trip|vacation|holiday/ => "plane",
|
|
/hotel|lodging|accommodation/ => "hotel",
|
|
/movie|cinema|film|theater|theatre/ => "film",
|
|
/music|concert/ => "music",
|
|
/game|gaming/ => "gamepad-2",
|
|
/entertainment|leisure/ => "drama",
|
|
/sport|fitness|gym|workout|exercise/ => "dumbbell",
|
|
/pharmacy|drug|medicine|pill|medication|dental|dentist/ => "pill",
|
|
/health|medical|clinic|doctor|physician/ => "stethoscope",
|
|
/personal care|beauty|salon|spa|hair/ => "scissors",
|
|
/mortgage|rent/ => "home",
|
|
/home|house|apartment|housing/ => "home",
|
|
/improvement|renovation|remodel/ => "hammer",
|
|
/repair|maintenance/ => "wrench",
|
|
/electric|power|energy/ => "zap",
|
|
/water|sewage/ => "waves",
|
|
/internet|cable|broadband|subscription|streaming/ => "wifi",
|
|
/utilities|utility/ => "lightbulb",
|
|
/phone|telephone/ => "phone",
|
|
/mobile|cell/ => "smartphone",
|
|
/insurance/ => "shield",
|
|
/gift|present/ => "gift",
|
|
/donat|charity|nonprofit/ => "hand-helping",
|
|
/tax|irs|revenue/ => "landmark",
|
|
/loan|debt|credit card/ => "credit-card",
|
|
/service|professional/ => "briefcase",
|
|
/fee|charge/ => "receipt",
|
|
/bank|banking/ => "landmark",
|
|
/saving/ => "piggy-bank",
|
|
/invest|stock|fund|portfolio/ => "trending-up",
|
|
/pet|dog|cat|animal|vet/ => "paw-print",
|
|
/education|school|university|college|tuition/ => "graduation-cap",
|
|
/book|reading|library/ => "book",
|
|
/child|kid|baby|infant|daycare/ => "baby",
|
|
/cloth|apparel|fashion|wear/ => "shirt",
|
|
/ticket/ => "ticket"
|
|
}.freeze
|
|
|
|
# Category name keys for i18n
|
|
UNCATEGORIZED_NAME_KEY = "models.category.uncategorized"
|
|
OTHER_INVESTMENTS_NAME_KEY = "models.category.other_investments"
|
|
INVESTMENT_CONTRIBUTIONS_NAME_KEY = "models.category.investment_contributions"
|
|
|
|
class Group
|
|
attr_reader :category, :subcategories
|
|
|
|
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
|
|
|
|
def initialize(category, subcategories = nil)
|
|
@category = category
|
|
@subcategories = subcategories || []
|
|
end
|
|
end
|
|
|
|
class << self
|
|
def suggested_icon(name)
|
|
name_down = name.to_s.downcase
|
|
|
|
ICON_KEYWORDS.each do |pattern, icon|
|
|
return icon if name_down.match?(pattern)
|
|
end
|
|
|
|
"shapes"
|
|
end
|
|
|
|
def icon_codes
|
|
%w[
|
|
ambulance apple award baby badge-dollar-sign banknote barcode bar-chart-3 bath
|
|
battery bed-single beer bike bluetooth bone book book-open briefcase building bus
|
|
cake calculator calendar-heart calendar-range camera car cat chart-line
|
|
circle-dollar-sign circle-parking coffee coins compass cookie cooking-pot
|
|
credit-card dices dog drama drill droplet drum dumbbell film flame flower flower-2
|
|
fuel gamepad-2 gem gift glasses globe graduation-cap hammer hand-heart
|
|
hand-helping heart-handshake handshake headphones heart heart-pulse home hotel
|
|
house ice-cream-cone key landmark laptop leaf lightbulb luggage mail map-pin
|
|
martini mic monitor moon music package palette party-popper paw-print pen pencil
|
|
percent phone pie-chart piggy-bank pill pizza plane plug popcorn power printer
|
|
puzzle receipt receipt-text ribbon scale scissors settings shield shield-plus
|
|
shirt shopping-bag shopping-basket shopping-cart smartphone sparkles sprout
|
|
stethoscope store sun tablet-smartphone tag target tent thermometer ticket train
|
|
trees tree-palm trending-up trophy truck tv umbrella undo-2 unplug users utensils
|
|
video wallet wallet-cards waves wifi wine wrench zap
|
|
]
|
|
end
|
|
|
|
def bootstrap!
|
|
default_categories.each do |name, color, icon|
|
|
find_or_create_by!(name: name) do |category|
|
|
category.color = color
|
|
category.lucide_icon = icon
|
|
end
|
|
end
|
|
end
|
|
|
|
def uncategorized
|
|
new(
|
|
name: I18n.t(UNCATEGORIZED_NAME_KEY),
|
|
color: UNCATEGORIZED_COLOR,
|
|
lucide_icon: "circle-dashed"
|
|
)
|
|
end
|
|
|
|
def other_investments
|
|
new(
|
|
name: I18n.t(OTHER_INVESTMENTS_NAME_KEY),
|
|
color: OTHER_INVESTMENTS_COLOR,
|
|
lucide_icon: "trending-up"
|
|
)
|
|
end
|
|
|
|
# Helper to get the localized name for uncategorized
|
|
def uncategorized_name
|
|
I18n.t(UNCATEGORIZED_NAME_KEY)
|
|
end
|
|
|
|
# Returns all possible uncategorized names across all supported locales
|
|
# Used to detect uncategorized filter regardless of URL parameter language
|
|
def all_uncategorized_names
|
|
LanguagesHelper::SUPPORTED_LOCALES.map do |locale|
|
|
I18n.t(UNCATEGORIZED_NAME_KEY, locale: locale)
|
|
end.uniq
|
|
end
|
|
|
|
# Helper to get the localized name for other investments
|
|
def other_investments_name
|
|
I18n.t(OTHER_INVESTMENTS_NAME_KEY)
|
|
end
|
|
|
|
# Helper to get the localized name for investment contributions
|
|
def investment_contributions_name
|
|
I18n.t(INVESTMENT_CONTRIBUTIONS_NAME_KEY)
|
|
end
|
|
|
|
# Returns all possible investment contributions names across all supported locales
|
|
# Used to detect investment contributions category regardless of locale
|
|
def all_investment_contributions_names
|
|
LanguagesHelper::SUPPORTED_LOCALES.map do |locale|
|
|
I18n.t(INVESTMENT_CONTRIBUTIONS_NAME_KEY, locale: locale)
|
|
end.uniq
|
|
end
|
|
|
|
private
|
|
def default_categories
|
|
[
|
|
[ "Income", "#22c55e", "circle-dollar-sign" ],
|
|
[ "Food & Drink", "#f97316", "utensils" ],
|
|
[ "Groceries", "#407706", "shopping-bag" ],
|
|
[ "Shopping", "#3b82f6", "shopping-cart" ],
|
|
[ "Transportation", "#0ea5e9", "bus" ],
|
|
[ "Travel", "#2563eb", "plane" ],
|
|
[ "Entertainment", "#a855f7", "drama" ],
|
|
[ "Healthcare", "#4da568", "pill" ],
|
|
[ "Personal Care", "#14b8a6", "scissors" ],
|
|
[ "Home Improvement", "#d97706", "hammer" ],
|
|
[ "Mortgage / Rent", "#b45309", "home" ],
|
|
[ "Utilities", "#eab308", "lightbulb" ],
|
|
[ "Subscriptions", "#6366f1", "wifi" ],
|
|
[ "Insurance", "#0284c7", "shield" ],
|
|
[ "Sports & Fitness", "#10b981", "dumbbell" ],
|
|
[ "Gifts & Donations", "#61c9ea", "hand-helping" ],
|
|
[ "Taxes", "#dc2626", "landmark" ],
|
|
[ "Loan Payments", "#e11d48", "credit-card" ],
|
|
[ "Services", "#7c3aed", "briefcase" ],
|
|
[ "Fees", "#6b7280", "receipt" ],
|
|
[ "Savings & Investments", "#059669", "piggy-bank" ],
|
|
[ investment_contributions_name, "#0d9488", "trending-up" ]
|
|
]
|
|
end
|
|
end
|
|
|
|
def inherit_color_from_parent
|
|
if subcategory?
|
|
self.color = parent.color
|
|
end
|
|
end
|
|
|
|
def replace_and_destroy!(replacement)
|
|
transaction do
|
|
transactions.update_all category_id: replacement&.id
|
|
destroy!
|
|
end
|
|
end
|
|
|
|
def parent?
|
|
subcategories.any?
|
|
end
|
|
|
|
def subcategory?
|
|
parent.present?
|
|
end
|
|
|
|
def name_with_parent
|
|
subcategory? ? "#{parent.name} > #{name}" : name
|
|
end
|
|
|
|
# Predicate: is this the synthetic "Uncategorized" category?
|
|
def uncategorized?
|
|
!persisted? && name == I18n.t(UNCATEGORIZED_NAME_KEY)
|
|
end
|
|
|
|
# Predicate: is this the synthetic "Other Investments" category?
|
|
def other_investments?
|
|
!persisted? && name == I18n.t(OTHER_INVESTMENTS_NAME_KEY)
|
|
end
|
|
|
|
# Predicate: is this any synthetic (non-persisted) category?
|
|
def synthetic?
|
|
uncategorized? || other_investments?
|
|
end
|
|
|
|
private
|
|
def category_level_limit
|
|
if (subcategory? && parent.subcategory?) || (parent? && subcategory?)
|
|
errors.add(:parent, "can't have more than 2 levels of subcategories")
|
|
end
|
|
end
|
|
|
|
def monetizable_currency
|
|
family.currency
|
|
end
|
|
end
|