mirror of
https://github.com/we-promise/sure.git
synced 2026-04-13 17:14:05 +00:00
* Record dividends and interest as Trades in investment accounts
All investment income (dividends and interest) is now modeled as a
Trade with qty: 0 and price: 0, keeping security_id NOT NULL on trades
intact. Dividends require a security; interest falls back to a
per-account synthetic cash security (kind: "cash", offline: true) when
none is selected, matching how brokerages handle uninvested cash
internally.
- Add `kind` column to securities ("standard" | "cash") with DB check
constraint; `Security.cash_for(account)` lazily finds or creates the
synthetic cash security; `scope :standard` excludes synthetic
securities from user-facing pickers
- Trade::CreateForm: new `dividend` type (security required); `interest`
now creates a Trade instead of a Transaction
- Trade form: Dividend and Interest in the type dropdown with a security
combobox (required for dividend, optional for interest)
- transactions table: untouched
* UI fixes
* HealthChecker — both scopes now chain .standard to exclude cash securities from provider health checks.
DB query moved to model — Account#traded_standard_securities in app/models/account.rb, view uses account.traded_standard_securities.
DRY income creation — create_income_trade(sec:, label:, name:) extracted as shared private method; create_dividend_income and create_interest_income delegate to it.
show.html.erb blocks merged — single unless trade.qty.zero? block covers qty/price/fee fields.
Test extended — assert_response :unprocessable_entity added after the assert_no_difference block.
* Hide cash account ticker from no-security trade detail
* Fix CodeRabbit review issues from PR #1311
- Remove duplicate YAML keys in translation files (de, es, fr)
- Add error handling for security resolution in create_dividend_income
- Extract income trade check to reduce duplication in header template
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
* Include holdings in dividend/interest security picker
The security picker for dividend/interest trades should include all securities
in holdings, not just those with trade history. This fixes the issue where
accounts with imported holdings (e.g., SimpleFIN) but no trades would have an
empty picker and be unable to record dividends.
Uses UNION to combine securities from both trades and holdings.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
* scope picker to holdings only (a trade creates a holding anyway)
---------
Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
449 lines
15 KiB
Ruby
449 lines
15 KiB
Ruby
class Account < ApplicationRecord
|
|
include AASM, Syncable, Monetizable, Chartable, Linkable, Enrichable, Anchorable, Reconcileable, TaxTreatable
|
|
|
|
before_validation :assign_default_owner, if: -> { owner_id.blank? }
|
|
|
|
validates :name, :balance, :currency, presence: true
|
|
validate :owner_belongs_to_family, if: -> { owner_id.present? && family_id.present? }
|
|
|
|
belongs_to :family
|
|
belongs_to :owner, class_name: "User", optional: true
|
|
belongs_to :import, optional: true
|
|
|
|
has_many :account_shares, dependent: :destroy
|
|
has_many :shared_users, through: :account_shares, source: :user
|
|
has_many :import_mappings, as: :mappable, dependent: :destroy, class_name: "Import::Mapping"
|
|
has_many :entries, dependent: :destroy
|
|
has_many :transactions, through: :entries, source: :entryable, source_type: "Transaction"
|
|
has_many :valuations, through: :entries, source: :entryable, source_type: "Valuation"
|
|
has_many :trades, through: :entries, source: :entryable, source_type: "Trade"
|
|
has_many :holdings, dependent: :destroy
|
|
has_many :balances, dependent: :destroy
|
|
has_many :recurring_transactions, dependent: :destroy
|
|
|
|
monetize :balance, :cash_balance
|
|
|
|
enum :classification, { asset: "asset", liability: "liability" }, validate: { allow_nil: true }
|
|
|
|
scope :visible, -> { where(status: [ "draft", "active" ]) }
|
|
scope :assets, -> { where(classification: "asset") }
|
|
scope :liabilities, -> { where(classification: "liability") }
|
|
scope :alphabetically, -> { order(:name) }
|
|
scope :manual, -> {
|
|
left_joins(:account_providers)
|
|
.where(account_providers: { id: nil })
|
|
.where(plaid_account_id: nil, simplefin_account_id: nil)
|
|
}
|
|
|
|
scope :visible_manual, -> {
|
|
visible.manual
|
|
}
|
|
|
|
scope :listable_manual, -> {
|
|
manual.where.not(status: :pending_deletion)
|
|
}
|
|
|
|
# All accounts a user can access (owned + shared with them)
|
|
scope :accessible_by, ->(user) {
|
|
left_joins(:account_shares)
|
|
.where("accounts.owner_id = :uid OR account_shares.user_id = :uid", uid: user.id)
|
|
.distinct
|
|
}
|
|
|
|
# Accounts a user can write to (owned or shared with full_control)
|
|
scope :writable_by, ->(user) {
|
|
left_joins(:account_shares)
|
|
.where("accounts.owner_id = :uid OR (account_shares.user_id = :uid AND account_shares.permission = 'full_control')", uid: user.id)
|
|
.distinct
|
|
}
|
|
|
|
# Accounts that count in a user's financial calculations
|
|
scope :included_in_finances_for, ->(user) {
|
|
left_joins(:account_shares)
|
|
.where(
|
|
"accounts.owner_id = :uid OR " \
|
|
"(account_shares.user_id = :uid AND account_shares.include_in_finances = true)",
|
|
uid: user.id
|
|
)
|
|
.distinct
|
|
}
|
|
|
|
has_one_attached :logo, dependent: :purge_later
|
|
|
|
delegated_type :accountable, types: Accountable::TYPES, dependent: :destroy
|
|
delegate :subtype, to: :accountable, allow_nil: true
|
|
|
|
# Writer for subtype that delegates to the accountable
|
|
# This allows forms to set subtype directly on the account
|
|
def subtype=(value)
|
|
accountable&.subtype = value
|
|
end
|
|
|
|
accepts_nested_attributes_for :accountable, update_only: true
|
|
|
|
# Account state machine
|
|
aasm column: :status, timestamps: true do
|
|
state :active, initial: true
|
|
state :draft
|
|
state :disabled
|
|
state :pending_deletion
|
|
|
|
event :activate do
|
|
transitions from: [ :draft, :disabled ], to: :active
|
|
end
|
|
|
|
event :disable do
|
|
transitions from: [ :draft, :active ], to: :disabled
|
|
end
|
|
|
|
event :enable do
|
|
transitions from: :disabled, to: :active
|
|
end
|
|
|
|
event :mark_for_deletion do
|
|
transitions from: [ :draft, :active, :disabled ], to: :pending_deletion
|
|
end
|
|
end
|
|
|
|
class << self
|
|
def human_attribute_name(attribute, options = {})
|
|
options = { moniker: Current.family&.moniker_label || "Family" }.merge(options)
|
|
super(attribute, options)
|
|
end
|
|
|
|
def create_and_sync(attributes, skip_initial_sync: false, opening_balance_date: nil)
|
|
attributes[:accountable_attributes] ||= {} # Ensure accountable is created, even if empty
|
|
# Default cash_balance to balance unless explicitly provided (e.g., Crypto sets it to 0)
|
|
attrs = attributes.dup
|
|
attrs[:cash_balance] = attrs[:balance] unless attrs.key?(:cash_balance)
|
|
account = new(attrs)
|
|
initial_balance = attributes.dig(:accountable_attributes, :initial_balance)&.to_d
|
|
|
|
transaction do
|
|
account.save!
|
|
|
|
manager = Account::OpeningBalanceManager.new(account)
|
|
result = manager.set_opening_balance(
|
|
balance: initial_balance || account.balance,
|
|
date: opening_balance_date
|
|
)
|
|
raise result.error if result.error
|
|
|
|
account.auto_share_with_family! if account.family.share_all_by_default?
|
|
end
|
|
|
|
# Skip initial sync for linked accounts - the provider sync will handle balance creation
|
|
# after the correct currency is known
|
|
account.sync_later unless skip_initial_sync
|
|
account
|
|
end
|
|
|
|
|
|
def create_from_simplefin_account(simplefin_account, account_type, subtype = nil)
|
|
# Respect user choice when provided; otherwise infer a sensible default
|
|
# Require an explicit account_type; do not infer on the backend
|
|
if account_type.blank? || account_type.to_s == "unknown"
|
|
raise ArgumentError, "account_type is required when creating an account from SimpleFIN"
|
|
end
|
|
|
|
# Get the balance from SimpleFin
|
|
balance = simplefin_account.current_balance || simplefin_account.available_balance || 0
|
|
|
|
# SimpleFin returns negative balances for credit cards (liabilities)
|
|
# But Sure expects positive balances for liabilities
|
|
if account_type == "CreditCard" || account_type == "Loan"
|
|
balance = balance.abs
|
|
end
|
|
|
|
# Calculate cash balance correctly for investment accounts
|
|
cash_balance = balance
|
|
if account_type == "Investment"
|
|
begin
|
|
calculator = SimplefinAccount::Investments::BalanceCalculator.new(simplefin_account)
|
|
calculated = calculator.cash_balance
|
|
cash_balance = calculated unless calculated.nil?
|
|
rescue => e
|
|
Rails.logger.warn(
|
|
"Investment cash_balance calculation failed for " \
|
|
"SimpleFin account #{simplefin_account.id}: #{e.class} - #{e.message}"
|
|
)
|
|
# Fallback to zero as suggested
|
|
cash_balance = 0
|
|
end
|
|
end
|
|
|
|
family = simplefin_account.simplefin_item.family
|
|
attributes = {
|
|
family: family,
|
|
name: simplefin_account.name,
|
|
balance: balance,
|
|
cash_balance: cash_balance,
|
|
currency: simplefin_account.currency,
|
|
accountable_type: account_type,
|
|
accountable_attributes: build_simplefin_accountable_attributes(simplefin_account, account_type, subtype),
|
|
simplefin_account_id: simplefin_account.id
|
|
}
|
|
|
|
# Skip initial sync - provider sync will handle balance creation with correct currency
|
|
create_and_sync(attributes, skip_initial_sync: true)
|
|
end
|
|
|
|
def create_from_enable_banking_account(enable_banking_account, account_type, subtype = nil)
|
|
# Get the balance from Enable Banking
|
|
balance = enable_banking_account.current_balance || 0
|
|
|
|
# Enable Banking may return negative balances for liabilities
|
|
# Sure expects positive balances for liabilities
|
|
if account_type == "CreditCard" || account_type == "Loan"
|
|
balance = balance.abs
|
|
end
|
|
|
|
cash_balance = balance
|
|
|
|
family = enable_banking_account.enable_banking_item.family
|
|
attributes = {
|
|
family: family,
|
|
name: enable_banking_account.name,
|
|
balance: balance,
|
|
cash_balance: cash_balance,
|
|
currency: enable_banking_account.currency || "EUR"
|
|
}
|
|
|
|
accountable_attributes = {}
|
|
accountable_attributes[:subtype] = subtype if subtype.present?
|
|
|
|
# Skip initial sync - provider sync will handle balance creation with correct currency
|
|
create_and_sync(
|
|
attributes.merge(
|
|
accountable_type: account_type,
|
|
accountable_attributes: accountable_attributes
|
|
),
|
|
skip_initial_sync: true
|
|
)
|
|
end
|
|
|
|
def create_from_coinbase_account(coinbase_account)
|
|
# All Coinbase accounts are crypto exchange accounts
|
|
family = coinbase_account.coinbase_item.family
|
|
|
|
# Extract native balance and currency from Coinbase (e.g., USD, EUR, GBP)
|
|
native_balance = coinbase_account.raw_payload&.dig("native_balance", "amount").to_d
|
|
native_currency = coinbase_account.raw_payload&.dig("native_balance", "currency") || family.currency
|
|
|
|
attributes = {
|
|
family: family,
|
|
name: coinbase_account.name,
|
|
balance: native_balance,
|
|
cash_balance: 0, # No cash - all value is in holdings
|
|
currency: native_currency,
|
|
accountable_type: "Crypto",
|
|
accountable_attributes: {
|
|
subtype: "exchange",
|
|
tax_treatment: "taxable"
|
|
}
|
|
}
|
|
|
|
# Skip initial sync - provider sync will handle balance/holdings creation
|
|
create_and_sync(attributes, skip_initial_sync: true)
|
|
end
|
|
|
|
|
|
private
|
|
|
|
def build_simplefin_accountable_attributes(simplefin_account, account_type, subtype)
|
|
attributes = {}
|
|
attributes[:subtype] = subtype if subtype.present?
|
|
|
|
# Set account-type-specific attributes from SimpleFin data
|
|
case account_type
|
|
when "CreditCard"
|
|
# For credit cards, available_balance often represents available credit
|
|
if simplefin_account.available_balance.present? && simplefin_account.available_balance > 0
|
|
attributes[:available_credit] = simplefin_account.available_balance
|
|
end
|
|
when "Loan"
|
|
# For loans, we might get additional data from the raw_payload
|
|
# This is where loan-specific information could be extracted if available
|
|
# Currently we don't have specific loan fields from SimpleFin protocol
|
|
end
|
|
|
|
attributes
|
|
end
|
|
end
|
|
|
|
def institution_name
|
|
read_attribute(:institution_name).presence || provider&.institution_name
|
|
end
|
|
|
|
def institution_domain
|
|
read_attribute(:institution_domain).presence || provider&.institution_domain
|
|
end
|
|
|
|
def logo_url
|
|
if institution_domain.present? && Setting.brand_fetch_client_id.present?
|
|
logo_size = Setting.brand_fetch_logo_size
|
|
|
|
"https://cdn.brandfetch.io/#{institution_domain}/icon/fallback/lettermark/w/#{logo_size}/h/#{logo_size}?c=#{Setting.brand_fetch_client_id}"
|
|
elsif provider&.logo_url.present?
|
|
provider.logo_url
|
|
elsif logo.attached?
|
|
Rails.application.routes.url_helpers.rails_blob_path(logo, only_path: true)
|
|
end
|
|
end
|
|
|
|
def destroy_later
|
|
mark_for_deletion!
|
|
DestroyJob.perform_later(self)
|
|
end
|
|
|
|
# Override destroy to handle error recovery for accounts
|
|
def destroy
|
|
super
|
|
rescue => e
|
|
# If destruction fails, transition back to disabled state
|
|
# This provides a cleaner recovery path than the generic scheduled_for_deletion flag
|
|
disable! if may_disable?
|
|
raise e
|
|
end
|
|
|
|
def current_holdings
|
|
holdings
|
|
.where(currency: currency)
|
|
.where.not(qty: 0)
|
|
.where(
|
|
id: holdings.select("DISTINCT ON (security_id) id")
|
|
.where(currency: currency)
|
|
.order(:security_id, date: :desc)
|
|
)
|
|
.order(amount: :desc)
|
|
end
|
|
|
|
def start_date
|
|
first_entry_date = entries.minimum(:date) || Date.current
|
|
first_entry_date - 1.day
|
|
end
|
|
|
|
def lock_saved_attributes!
|
|
super
|
|
accountable.lock_saved_attributes!
|
|
end
|
|
|
|
def first_valuation
|
|
entries.valuations.order(:date).first
|
|
end
|
|
|
|
def first_valuation_amount
|
|
first_valuation&.amount_money || balance_money
|
|
end
|
|
|
|
# Get short version of the subtype label
|
|
def short_subtype_label
|
|
accountable_class.short_subtype_label_for(subtype) || accountable_class.display_name
|
|
end
|
|
|
|
# Get long version of the subtype label
|
|
def long_subtype_label
|
|
accountable_class.long_subtype_label_for(subtype) || accountable_class.display_name
|
|
end
|
|
|
|
def supports_default?
|
|
depository? || credit_card?
|
|
end
|
|
|
|
def eligible_for_transaction_default?
|
|
supports_default? && active? && !linked?
|
|
end
|
|
|
|
# Determines if this account supports manual trade entry
|
|
# Investment accounts always support trades; Crypto only if subtype is "exchange"
|
|
def supports_trades?
|
|
return true if investment?
|
|
return accountable.supports_trades? if crypto? && accountable.respond_to?(:supports_trades?)
|
|
false
|
|
end
|
|
|
|
def traded_standard_securities
|
|
Security.where(id: holdings.select(:security_id))
|
|
.standard
|
|
.distinct
|
|
.order(:ticker)
|
|
end
|
|
|
|
# The balance type determines which "component" of balance is being tracked.
|
|
# This is primarily used for balance related calculations and updates.
|
|
#
|
|
# "Cash" = "Liquid"
|
|
# "Non-cash" = "Illiquid"
|
|
# "Investment" = A mix of both, including brokerage cash (liquid) and holdings (illiquid)
|
|
def balance_type
|
|
case accountable_type
|
|
when "Depository", "CreditCard"
|
|
:cash
|
|
when "Property", "Vehicle", "OtherAsset", "Loan", "OtherLiability"
|
|
:non_cash
|
|
when "Investment", "Crypto"
|
|
:investment
|
|
else
|
|
raise "Unknown account type: #{accountable_type}"
|
|
end
|
|
end
|
|
|
|
def owned_by?(user)
|
|
user.present? && owner_id == user.id
|
|
end
|
|
|
|
def shared_with?(user)
|
|
return false if user.nil?
|
|
|
|
owned_by?(user) ||
|
|
if account_shares.loaded?
|
|
account_shares.any? { |s| s.user_id == user.id }
|
|
else
|
|
account_shares.exists?(user: user)
|
|
end
|
|
end
|
|
|
|
def shared?
|
|
account_shares.any?
|
|
end
|
|
|
|
def permission_for(user)
|
|
return :owner if owned_by?(user)
|
|
account_shares.find_by(user: user)&.permission&.to_sym
|
|
end
|
|
|
|
def share_with!(user, permission: "read_only", include_in_finances: true)
|
|
account_shares.create!(user: user, permission: permission, include_in_finances: include_in_finances)
|
|
end
|
|
|
|
def unshare_with!(user)
|
|
account_shares.where(user: user).destroy_all
|
|
end
|
|
|
|
def auto_share_with_family!
|
|
records = family.users.where.not(id: owner_id).pluck(:id).map do |user_id|
|
|
{ account_id: id, user_id: user_id, permission: "read_write",
|
|
include_in_finances: true, created_at: Time.current, updated_at: Time.current }
|
|
end
|
|
|
|
AccountShare.insert_all(records, unique_by: %i[account_id user_id]) if records.any?
|
|
end
|
|
|
|
private
|
|
|
|
def assign_default_owner
|
|
return if owner.present?
|
|
|
|
if Current.user.present? && Current.user.family_id == family_id
|
|
self.owner = Current.user
|
|
else
|
|
self.owner = family&.users&.find_by(role: %w[admin super_admin]) || family&.users&.order(:created_at)&.first
|
|
end
|
|
end
|
|
|
|
def owner_belongs_to_family
|
|
return if User.where(id: owner_id, family_id: family_id).exists?
|
|
errors.add(:owner, :invalid, message: "must belong to the same family as the account")
|
|
end
|
|
end
|