mirror of
https://github.com/we-promise/sure.git
synced 2026-04-07 14:31:25 +00:00
Remove InvestmentActivityDetector and related functionality
- Deleted the `InvestmentActivityDetector` and associated tests. - Removed rake tasks for backfilling and clearing investment activity labels. - Simplified transaction processing in `SimplefinEntry::Processor` by removing inferred activity label logic. - Added new rule `SetInvestmentActivityLabel` for setting labels using rules. - Updated `Rule::Registry::TransactionResource` to include the new rule executor.
This commit is contained in:
@@ -1,347 +0,0 @@
|
||||
# Detects internal investment activity (fund swaps, reinvestments) by comparing
|
||||
# holdings snapshots between syncs and marks matching transactions as excluded
|
||||
# from cashflow. This is provider-agnostic and works with any holdings data.
|
||||
#
|
||||
# Usage:
|
||||
# detector = InvestmentActivityDetector.new(account)
|
||||
# detector.detect_and_mark_internal_activity(current_holdings, recent_transactions)
|
||||
#
|
||||
class InvestmentActivityDetector
|
||||
def initialize(account)
|
||||
@account = account
|
||||
end
|
||||
|
||||
# Class method for inferring activity label from description and amount
|
||||
# without needing a full detector instance
|
||||
# @param name [String] Transaction name/description
|
||||
# @param amount [Numeric] Transaction amount
|
||||
# @param account [Account, nil] Optional account for context (e.g., retirement plan detection)
|
||||
# @return [String, nil] Activity label or nil if unknown
|
||||
def self.infer_label_from_description(name, amount, account = nil)
|
||||
new(nil).send(:infer_from_description, name, amount, account)
|
||||
end
|
||||
|
||||
# Call this after syncing transactions for an investment/crypto account
|
||||
# @param current_holdings [Array] Array of holding objects/hashes from provider
|
||||
# @param recent_transactions [Array<Transaction>] Recently imported transactions
|
||||
def detect_and_mark_internal_activity(current_holdings, recent_transactions)
|
||||
return unless @account.investment? || @account.crypto?
|
||||
return if current_holdings.blank?
|
||||
|
||||
previous_snapshot = @account.holdings_snapshot_data || []
|
||||
|
||||
# Find holdings changes that indicate buys/sells
|
||||
changes = detect_holdings_changes(previous_snapshot, current_holdings)
|
||||
|
||||
# Match changes to transactions and mark them as excluded
|
||||
changes.each do |change|
|
||||
matched_entry = find_matching_entry(change, recent_transactions)
|
||||
next unless matched_entry
|
||||
|
||||
transaction = matched_entry.entryable
|
||||
|
||||
# Only auto-set if not already manually set by user (respect user overrides)
|
||||
unless matched_entry.locked?(:exclude_from_cashflow)
|
||||
matched_entry.update!(exclude_from_cashflow: true)
|
||||
matched_entry.lock_attr!(:exclude_from_cashflow)
|
||||
|
||||
Rails.logger.info(
|
||||
"InvestmentActivityDetector: Auto-excluded entry #{matched_entry.id} " \
|
||||
"(#{matched_entry.name}) as internal #{change[:type]} of #{change[:symbol] || change[:description]}"
|
||||
)
|
||||
end
|
||||
|
||||
# Set activity label if not already set
|
||||
if transaction.is_a?(Transaction) && transaction.investment_activity_label.blank?
|
||||
label = infer_activity_label(matched_entry, change[:type])
|
||||
transaction.update!(investment_activity_label: label) if label.present?
|
||||
end
|
||||
end
|
||||
|
||||
# Store current snapshot for next comparison
|
||||
save_holdings_snapshot(current_holdings)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Infer activity label from change type and transaction description
|
||||
def infer_activity_label(entry, change_type)
|
||||
# If we know it's a buy or sell from holdings comparison
|
||||
return "Buy" if change_type == :buy
|
||||
return "Sell" if change_type == :sell
|
||||
|
||||
# Otherwise try to infer from description
|
||||
infer_from_description(entry)
|
||||
end
|
||||
|
||||
# Infer activity label from transaction description
|
||||
# Can be called with an Entry or with name/amount directly
|
||||
# @param entry_or_name [Entry, String] Entry object or transaction name
|
||||
# @param amount [Numeric, nil] Transaction amount (required if entry_or_name is String)
|
||||
# @param account [Account, nil] Optional account for context (e.g., retirement plan detection)
|
||||
def infer_from_description(entry_or_name, amount = nil, account = nil)
|
||||
if entry_or_name.respond_to?(:name)
|
||||
description = (entry_or_name.name || "").upcase
|
||||
amount = entry_or_name.amount || 0
|
||||
account ||= entry_or_name.try(:account)
|
||||
else
|
||||
description = (entry_or_name || "").upcase
|
||||
amount ||= 0
|
||||
end
|
||||
|
||||
# Check if this is a retirement plan account (401k, 403b, etc.)
|
||||
account_name = (account&.name || "").upcase
|
||||
retirement_indicators = %w[401K 403B RETIREMENT TOTALSOURCE NETBENEFITS]
|
||||
retirement_phrases = [ "SAVINGS PLAN", "THRIFT PLAN", "PENSION" ]
|
||||
is_retirement_plan = retirement_indicators.any? { |ind| account_name.include?(ind) } ||
|
||||
retirement_phrases.any? { |phrase| account_name.include?(phrase) }
|
||||
|
||||
# Check for sweep/money market patterns (but NOT money market FUND purchases)
|
||||
# INVESTOR CL indicates this is a money market fund, not a sweep
|
||||
sweep_patterns = %w[SWEEP SETTLEMENT]
|
||||
money_market_sweep = description.include?("MONEY MARKET") && !description.include?("INVESTOR")
|
||||
common_money_market_tickers = %w[VMFXX SPAXX FDRXX SWVXX SPRXX]
|
||||
|
||||
if sweep_patterns.any? { |p| description.include?(p) } ||
|
||||
money_market_sweep ||
|
||||
common_money_market_tickers.any? { |t| description == t }
|
||||
return amount.positive? ? "Sweep Out" : "Sweep In"
|
||||
end
|
||||
|
||||
# Check for likely interest/dividend on money market funds
|
||||
# Small amounts (under $5) on money market funds are typically interest income
|
||||
money_market_fund_patterns = %w[MONEY\ MARKET VMFXX SPAXX FDRXX SWVXX SPRXX VUSXX]
|
||||
is_money_market_fund = money_market_fund_patterns.any? { |p| description.include?(p) }
|
||||
|
||||
if is_money_market_fund && amount.abs < 5
|
||||
# Small money market amounts are interest, not buys/sells
|
||||
return "Interest"
|
||||
end
|
||||
|
||||
# Check for dividend patterns
|
||||
# "CASH" alone typically indicates dividend payout in brokerage feeds (only for inflows)
|
||||
if description.include?("DIVIDEND") || description.include?("DISTRIBUTION") ||
|
||||
(description == "CASH" && amount < 0)
|
||||
return "Dividend"
|
||||
end
|
||||
|
||||
# Check for interest
|
||||
return "Interest" if description.include?("INTEREST")
|
||||
|
||||
# Check for fees
|
||||
return "Fee" if description.include?("FEE") || description.include?("CHARGE")
|
||||
|
||||
# Check for reinvestment
|
||||
return "Reinvestment" if description.include?("REINVEST")
|
||||
|
||||
# Check for exchange/conversion
|
||||
return "Exchange" if description.include?("EXCHANGE") || description.include?("CONVERSION")
|
||||
|
||||
# Check for contribution patterns
|
||||
return "Contribution" if description.include?("CONTRIBUTION") || description.include?("DEPOSIT")
|
||||
|
||||
# Check for withdrawal patterns
|
||||
return "Withdrawal" if description.include?("WITHDRAWAL") || description.include?("DISBURSEMENT")
|
||||
|
||||
# Check for fund names that indicate buy/sell activity
|
||||
# Positive amount = money out from account perspective = buying securities
|
||||
# Negative amount = money in = selling securities
|
||||
fund_patterns = %w[
|
||||
INDEX FUND ADMIRAL ETF SHARES TRUST
|
||||
VANGUARD FIDELITY SCHWAB ISHARES SPDR
|
||||
500\ INDEX TOTAL\ MARKET GROWTH BOND
|
||||
]
|
||||
|
||||
# Common fund ticker patterns
|
||||
fund_ticker_patterns = %w[
|
||||
VFIAX VTSAX VXUS VBTLX VTIAX VTTVX
|
||||
VTI VOO VGT VIG VYM VGIT
|
||||
FXAIX FZROX FSKAX FBALX
|
||||
SWTSX SWPPX SCHD SCHX
|
||||
SPY QQQ IVV AGG
|
||||
IBIT GBTC ETHE
|
||||
]
|
||||
|
||||
is_fund_transaction = fund_patterns.any? { |p| description.include?(p) } ||
|
||||
fund_ticker_patterns.any? { |t| description.include?(t) }
|
||||
|
||||
if is_fund_transaction
|
||||
if is_retirement_plan && amount.negative?
|
||||
# Negative amount in retirement plan = payroll contribution buying shares
|
||||
return "Contribution"
|
||||
else
|
||||
return amount.positive? ? "Buy" : "Sell"
|
||||
end
|
||||
end
|
||||
|
||||
nil # Unknown - user can set manually
|
||||
end
|
||||
|
||||
def detect_holdings_changes(previous, current)
|
||||
changes = []
|
||||
|
||||
current.each do |holding|
|
||||
prev = find_previous_holding(previous, holding)
|
||||
|
||||
if prev.nil?
|
||||
# New holding appeared = BUY
|
||||
changes << {
|
||||
type: :buy,
|
||||
symbol: holding_symbol(holding),
|
||||
description: holding_description(holding),
|
||||
shares: holding_shares(holding),
|
||||
cost_basis: holding_cost_basis(holding),
|
||||
created_at: holding_created_at(holding)
|
||||
}
|
||||
elsif holding_shares(holding) > prev_shares(prev)
|
||||
# Shares increased = BUY
|
||||
changes << {
|
||||
type: :buy,
|
||||
symbol: holding_symbol(holding),
|
||||
description: holding_description(holding),
|
||||
shares_delta: holding_shares(holding) - prev_shares(prev),
|
||||
cost_basis_delta: holding_cost_basis(holding) - prev_cost_basis(prev)
|
||||
}
|
||||
elsif holding_shares(holding) < prev_shares(prev)
|
||||
# Shares decreased = SELL
|
||||
changes << {
|
||||
type: :sell,
|
||||
symbol: holding_symbol(holding),
|
||||
description: holding_description(holding),
|
||||
shares_delta: prev_shares(prev) - holding_shares(holding)
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
# Check for holdings that completely disappeared = SELL ALL
|
||||
previous.each do |prev|
|
||||
unless current.any? { |h| same_holding?(h, prev) }
|
||||
changes << {
|
||||
type: :sell,
|
||||
symbol: prev_symbol(prev),
|
||||
description: prev_description(prev),
|
||||
shares: prev_shares(prev)
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
changes
|
||||
end
|
||||
|
||||
def find_matching_entry(change, transactions)
|
||||
transactions.each do |txn|
|
||||
entry = txn.respond_to?(:entry) ? txn.entry : txn
|
||||
next unless entry
|
||||
next if entry.exclude_from_cashflow? # Already excluded
|
||||
|
||||
# Match by cost_basis amount (for buys with known cost)
|
||||
if change[:cost_basis].present? && change[:cost_basis].to_d > 0
|
||||
amount_diff = (entry.amount.to_d.abs - change[:cost_basis].to_d.abs).abs
|
||||
return entry if amount_diff < 0.01
|
||||
end
|
||||
|
||||
# Match by cost_basis delta (for additional buys)
|
||||
if change[:cost_basis_delta].present? && change[:cost_basis_delta].to_d > 0
|
||||
amount_diff = (entry.amount.to_d.abs - change[:cost_basis_delta].to_d.abs).abs
|
||||
return entry if amount_diff < 0.01
|
||||
end
|
||||
|
||||
# Match by description containing security name/symbol
|
||||
entry_desc = entry.name&.downcase || ""
|
||||
|
||||
if change[:symbol].present?
|
||||
return entry if entry_desc.include?(change[:symbol].downcase)
|
||||
end
|
||||
|
||||
if change[:description].present?
|
||||
# Match first few words of description for fuzzy matching
|
||||
desc_words = change[:description].downcase.split.first(3).join(" ")
|
||||
return entry if desc_words.present? && entry_desc.include?(desc_words)
|
||||
end
|
||||
end
|
||||
|
||||
nil
|
||||
end
|
||||
|
||||
def find_previous_holding(previous, current)
|
||||
symbol = holding_symbol(current)
|
||||
return previous.find { |p| prev_symbol(p) == symbol } if symbol.present?
|
||||
|
||||
# Fallback to description matching if no symbol
|
||||
desc = holding_description(current)
|
||||
previous.find { |p| prev_description(p) == desc } if desc.present?
|
||||
end
|
||||
|
||||
def same_holding?(current, previous)
|
||||
current_symbol = holding_symbol(current)
|
||||
prev_sym = prev_symbol(previous)
|
||||
|
||||
if current_symbol.present? && prev_sym.present?
|
||||
current_symbol == prev_sym
|
||||
else
|
||||
holding_description(current) == prev_description(previous)
|
||||
end
|
||||
end
|
||||
|
||||
def save_holdings_snapshot(holdings)
|
||||
snapshot_data = holdings.map do |h|
|
||||
{
|
||||
"symbol" => holding_symbol(h),
|
||||
"description" => holding_description(h),
|
||||
"shares" => holding_shares(h).to_s,
|
||||
"cost_basis" => holding_cost_basis(h).to_s,
|
||||
"market_value" => holding_market_value(h).to_s
|
||||
}
|
||||
end
|
||||
|
||||
@account.update!(
|
||||
holdings_snapshot_data: snapshot_data,
|
||||
holdings_snapshot_at: Time.current
|
||||
)
|
||||
end
|
||||
|
||||
# Normalize access - holdings could be AR objects or hashes from different providers
|
||||
def holding_symbol(h)
|
||||
h.try(:symbol) || h.try(:ticker) || h["symbol"] || h[:symbol] || h["ticker"] || h[:ticker]
|
||||
end
|
||||
|
||||
def holding_description(h)
|
||||
h.try(:description) || h.try(:name) || h["description"] || h[:description] || h["name"] || h[:name]
|
||||
end
|
||||
|
||||
def holding_shares(h)
|
||||
val = h.try(:shares) || h.try(:qty) || h["shares"] || h[:shares] || h["qty"] || h[:qty]
|
||||
val.to_d
|
||||
end
|
||||
|
||||
def holding_cost_basis(h)
|
||||
val = h.try(:cost_basis) || h["cost_basis"] || h[:cost_basis]
|
||||
val.to_d
|
||||
end
|
||||
|
||||
def holding_market_value(h)
|
||||
val = h.try(:market_value) || h.try(:amount) || h["market_value"] || h[:market_value] || h["amount"] || h[:amount]
|
||||
val.to_d
|
||||
end
|
||||
|
||||
def holding_created_at(h)
|
||||
h.try(:created_at) || h["created"] || h[:created] || h["created_at"] || h[:created_at]
|
||||
end
|
||||
|
||||
# Previous snapshot accessor methods (snapshot is always a hash)
|
||||
def prev_symbol(p)
|
||||
p["symbol"] || p[:symbol]
|
||||
end
|
||||
|
||||
def prev_description(p)
|
||||
p["description"] || p[:description]
|
||||
end
|
||||
|
||||
def prev_shares(p)
|
||||
(p["shares"] || p[:shares]).to_d
|
||||
end
|
||||
|
||||
def prev_cost_basis(p)
|
||||
(p["cost_basis"] || p[:cost_basis]).to_d
|
||||
end
|
||||
end
|
||||
@@ -74,37 +74,10 @@ class LunchflowAccount::Processor
|
||||
return unless [ "Investment", "Crypto" ].include?(lunchflow_account.current_account&.accountable_type)
|
||||
|
||||
LunchflowAccount::Investments::HoldingsProcessor.new(lunchflow_account).process
|
||||
|
||||
# Detect and mark internal investment activity (fund swaps, reinvestments)
|
||||
detect_internal_investment_activity
|
||||
rescue => e
|
||||
report_exception(e, "holdings")
|
||||
end
|
||||
|
||||
def detect_internal_investment_activity
|
||||
account = lunchflow_account.current_account
|
||||
return unless account&.investment? || account&.crypto?
|
||||
|
||||
# Get current holdings from raw payload
|
||||
current_holdings = lunchflow_account.raw_holdings_payload || []
|
||||
return if current_holdings.blank?
|
||||
|
||||
# Get recent transactions (last 30 days to catch any we might have missed)
|
||||
recent_transactions = account.entries
|
||||
.joins("INNER JOIN transactions ON transactions.id = entries.entryable_id AND entries.entryable_type = 'Transaction'")
|
||||
.where(date: 30.days.ago.to_date..Date.current)
|
||||
.where(exclude_from_cashflow: false)
|
||||
.map(&:entryable)
|
||||
.compact
|
||||
|
||||
InvestmentActivityDetector.new(account).detect_and_mark_internal_activity(
|
||||
current_holdings,
|
||||
recent_transactions
|
||||
)
|
||||
rescue => e
|
||||
Rails.logger.warn("InvestmentActivityDetector failed for Lunchflow account #{lunchflow_account.id}: #{e.message}")
|
||||
end
|
||||
|
||||
def report_exception(error, context)
|
||||
Sentry.capture_exception(error) do |scope|
|
||||
scope.set_tags(
|
||||
|
||||
@@ -103,51 +103,10 @@ class PlaidAccount::Processor
|
||||
def process_investments
|
||||
PlaidAccount::Investments::TransactionsProcessor.new(plaid_account, security_resolver: security_resolver).process
|
||||
PlaidAccount::Investments::HoldingsProcessor.new(plaid_account, security_resolver: security_resolver).process
|
||||
|
||||
# Detect and mark internal investment activity (fund swaps, reinvestments)
|
||||
# Note: Plaid already creates Trade entries for buy/sell, but this catches cash transactions
|
||||
detect_internal_investment_activity
|
||||
rescue => e
|
||||
report_exception(e)
|
||||
end
|
||||
|
||||
def detect_internal_investment_activity
|
||||
account = AccountProvider.find_by(provider: plaid_account)&.account
|
||||
return unless account&.investment? || account&.crypto?
|
||||
|
||||
# Get current holdings from raw payload
|
||||
raw_holdings = plaid_account.raw_investments_payload&.dig("holdings") || []
|
||||
return if raw_holdings.blank?
|
||||
|
||||
# Transform to common format
|
||||
current_holdings = raw_holdings.map do |h|
|
||||
response = security_resolver.resolve(plaid_security_id: h["security_id"])
|
||||
security = response.security
|
||||
{
|
||||
"symbol" => security&.ticker,
|
||||
"description" => security&.name,
|
||||
"shares" => h["quantity"],
|
||||
"cost_basis" => h["cost_basis"],
|
||||
"market_value" => h["institution_value"]
|
||||
}
|
||||
end
|
||||
|
||||
# Get recent transactions (last 30 days to catch any we might have missed)
|
||||
recent_transactions = account.entries
|
||||
.joins("INNER JOIN transactions ON transactions.id = entries.entryable_id AND entries.entryable_type = 'Transaction'")
|
||||
.where(date: 30.days.ago.to_date..Date.current)
|
||||
.where(exclude_from_cashflow: false)
|
||||
.map(&:entryable)
|
||||
.compact
|
||||
|
||||
InvestmentActivityDetector.new(account).detect_and_mark_internal_activity(
|
||||
current_holdings,
|
||||
recent_transactions
|
||||
)
|
||||
rescue => e
|
||||
Rails.logger.warn("InvestmentActivityDetector failed for Plaid account #{plaid_account.id}: #{e.message}")
|
||||
end
|
||||
|
||||
def process_liabilities
|
||||
case [ plaid_account.plaid_type, plaid_account.plaid_subtype ]
|
||||
when [ "credit", "credit card" ]
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
class Rule::ActionExecutor::SetInvestmentActivityLabel < Rule::ActionExecutor
|
||||
def label
|
||||
"Set investment activity label"
|
||||
end
|
||||
|
||||
def type
|
||||
"select"
|
||||
end
|
||||
|
||||
def options
|
||||
Transaction::ACTIVITY_LABELS.map { |l| [ l, l ] }
|
||||
end
|
||||
|
||||
def execute(transaction_scope, value: nil, ignore_attribute_locks: false, rule_run: nil)
|
||||
return 0 unless Transaction::ACTIVITY_LABELS.include?(value)
|
||||
|
||||
scope = transaction_scope
|
||||
|
||||
unless ignore_attribute_locks
|
||||
scope = scope.enrichable(:investment_activity_label)
|
||||
end
|
||||
|
||||
count_modified_resources(scope) do |txn|
|
||||
txn.enrich_attribute(
|
||||
:investment_activity_label,
|
||||
value,
|
||||
source: "rule"
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -20,6 +20,7 @@ class Rule::Registry::TransactionResource < Rule::Registry
|
||||
Rule::ActionExecutor::SetTransactionTags.new(rule),
|
||||
Rule::ActionExecutor::SetTransactionMerchant.new(rule),
|
||||
Rule::ActionExecutor::SetTransactionName.new(rule),
|
||||
Rule::ActionExecutor::SetInvestmentActivityLabel.new(rule),
|
||||
Rule::ActionExecutor::ExcludeTransaction.new(rule)
|
||||
]
|
||||
|
||||
|
||||
@@ -151,37 +151,10 @@ class SimplefinAccount::Processor
|
||||
return unless simplefin_account.current_account&.accountable_type == "Investment"
|
||||
SimplefinAccount::Investments::TransactionsProcessor.new(simplefin_account).process
|
||||
SimplefinAccount::Investments::HoldingsProcessor.new(simplefin_account).process
|
||||
|
||||
# Detect and mark internal investment activity (fund swaps, reinvestments)
|
||||
detect_internal_investment_activity
|
||||
rescue => e
|
||||
report_exception(e, "investments")
|
||||
end
|
||||
|
||||
def detect_internal_investment_activity
|
||||
account = simplefin_account.current_account
|
||||
return unless account&.investment? || account&.crypto?
|
||||
|
||||
# Get current holdings from raw payload
|
||||
current_holdings = simplefin_account.raw_holdings_payload || []
|
||||
return if current_holdings.blank?
|
||||
|
||||
# Get recent transactions (last 30 days to catch any we might have missed)
|
||||
recent_transactions = account.entries
|
||||
.joins("INNER JOIN transactions ON transactions.id = entries.entryable_id AND entries.entryable_type = 'Transaction'")
|
||||
.where(date: 30.days.ago.to_date..Date.current)
|
||||
.where(exclude_from_cashflow: false)
|
||||
.map(&:entryable)
|
||||
.compact
|
||||
|
||||
InvestmentActivityDetector.new(account).detect_and_mark_internal_activity(
|
||||
current_holdings,
|
||||
recent_transactions
|
||||
)
|
||||
rescue => e
|
||||
Rails.logger.warn("InvestmentActivityDetector failed for account #{simplefin_account.current_account&.id}: #{e.message}")
|
||||
end
|
||||
|
||||
def process_liabilities
|
||||
case simplefin_account.current_account&.accountable_type
|
||||
when "CreditCard"
|
||||
|
||||
@@ -18,8 +18,7 @@ class SimplefinEntry::Processor
|
||||
source: "simplefin",
|
||||
merchant: merchant,
|
||||
notes: notes,
|
||||
extra: extra_metadata,
|
||||
investment_activity_label: inferred_activity_label
|
||||
extra: extra_metadata
|
||||
)
|
||||
end
|
||||
|
||||
@@ -205,11 +204,4 @@ class SimplefinEntry::Processor
|
||||
end
|
||||
parts.presence&.join(" | ")
|
||||
end
|
||||
|
||||
# Infer investment activity label from transaction description
|
||||
# Only returns a label for investment/crypto accounts
|
||||
def inferred_activity_label
|
||||
return nil unless account&.investment? || account&.crypto?
|
||||
InvestmentActivityDetector.infer_label_from_description(name, amount, account)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -20,19 +20,12 @@ class Transaction < ApplicationRecord
|
||||
investment_contribution: "investment_contribution" # Transfer to investment/crypto account, included in budget as investment expense
|
||||
}
|
||||
|
||||
# Labels for internal investment activity (auto-exclude from cashflow)
|
||||
# Only internal shuffling should be excluded, not contributions/dividends/withdrawals
|
||||
INTERNAL_ACTIVITY_LABELS = %w[Buy Sell Reinvestment Exchange].freeze
|
||||
|
||||
# All valid investment activity labels (for UI dropdown)
|
||||
ACTIVITY_LABELS = [
|
||||
"Buy", "Sell", "Sweep In", "Sweep Out", "Dividend", "Reinvestment",
|
||||
"Interest", "Fee", "Transfer", "Contribution", "Withdrawal", "Exchange", "Other"
|
||||
].freeze
|
||||
|
||||
after_save :sync_exclude_from_cashflow_with_activity_label,
|
||||
if: :saved_change_to_investment_activity_label?
|
||||
|
||||
# Pending transaction scopes - filter based on provider pending flags in extra JSONB
|
||||
# Works with any provider that stores pending status in extra["provider_name"]["pending"]
|
||||
scope :pending, -> {
|
||||
@@ -159,17 +152,4 @@ class Transaction < ApplicationRecord
|
||||
|
||||
FamilyMerchantAssociation.where(family: family, merchant: merchant).delete_all
|
||||
end
|
||||
|
||||
# Sync exclude_from_cashflow based on activity label
|
||||
# Internal activities (Buy, Sell, etc.) should be excluded from cashflow
|
||||
def sync_exclude_from_cashflow_with_activity_label
|
||||
return unless entry&.account&.investment? || entry&.account&.crypto?
|
||||
return if entry.locked?(:exclude_from_cashflow) # Respect user's manual setting
|
||||
|
||||
should_exclude = INTERNAL_ACTIVITY_LABELS.include?(investment_activity_label)
|
||||
|
||||
if entry.exclude_from_cashflow != should_exclude
|
||||
entry.update!(exclude_from_cashflow: should_exclude)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,189 +0,0 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
# Backfill investment activity labels for existing transactions
|
||||
#
|
||||
# Usage examples:
|
||||
# # Preview (dry run) - show what labels would be set
|
||||
# bin/rails 'sure:investments:backfill_labels[dry_run=true]'
|
||||
#
|
||||
# # Execute the backfill for all investment/crypto accounts
|
||||
# bin/rails 'sure:investments:backfill_labels[dry_run=false]'
|
||||
#
|
||||
# # Backfill for a specific account
|
||||
# bin/rails 'sure:investments:backfill_labels[account_id=8b46387c-5aa4-4a92-963a-4392c10999c9,dry_run=false]'
|
||||
#
|
||||
# # Force re-label already-labeled transactions
|
||||
# bin/rails 'sure:investments:backfill_labels[dry_run=false,force=true]'
|
||||
|
||||
namespace :sure do
|
||||
namespace :investments do
|
||||
desc "Backfill activity labels for existing investment transactions. Args: account_id (optional), dry_run=true, force=false"
|
||||
task :backfill_labels, [ :account_id, :dry_run, :force ] => :environment do |_, args|
|
||||
# Support named args (key=value) - parse all positional args for key=value pairs
|
||||
kv = {}
|
||||
[ args[:account_id], args[:dry_run], args[:force] ].each do |raw|
|
||||
next unless raw.is_a?(String) && raw.include?("=")
|
||||
k, v = raw.split("=", 2)
|
||||
kv[k.to_s] = v
|
||||
end
|
||||
|
||||
# Only use positional args if they don't contain "=" (otherwise they're named args in wrong position)
|
||||
positional_account_id = args[:account_id] unless args[:account_id].to_s.include?("=")
|
||||
positional_dry_run = args[:dry_run] unless args[:dry_run].to_s.include?("=")
|
||||
positional_force = args[:force] unless args[:force].to_s.include?("=")
|
||||
|
||||
account_id = (kv["account_id"] || positional_account_id).presence
|
||||
dry_raw = (kv["dry_run"] || positional_dry_run).to_s.downcase
|
||||
force_raw = (kv["force"] || positional_force).to_s.downcase
|
||||
force = %w[true yes 1].include?(force_raw)
|
||||
|
||||
# Default to dry_run=true unless explicitly disabled
|
||||
dry_run = if dry_raw.blank?
|
||||
true
|
||||
elsif %w[1 true yes y].include?(dry_raw)
|
||||
true
|
||||
elsif %w[0 false no n].include?(dry_raw)
|
||||
false
|
||||
else
|
||||
puts({ ok: false, error: "invalid_argument", message: "dry_run must be one of: true/yes/1 or false/no/0" }.to_json)
|
||||
exit 1
|
||||
end
|
||||
|
||||
# Build account scope
|
||||
accounts = if account_id.present?
|
||||
Account.where(id: account_id)
|
||||
else
|
||||
Account.where(accountable_type: %w[Investment Crypto])
|
||||
end
|
||||
|
||||
if accounts.none?
|
||||
puts({ ok: false, error: "no_accounts", message: "No investment/crypto accounts found" }.to_json)
|
||||
exit 1
|
||||
end
|
||||
|
||||
total_processed = 0
|
||||
total_labeled = 0
|
||||
total_skipped = 0
|
||||
total_errors = 0
|
||||
|
||||
accounts.find_each do |account|
|
||||
# Skip non-investment/crypto accounts if processing all
|
||||
next unless account.investment? || account.crypto?
|
||||
|
||||
acct_processed = 0
|
||||
acct_labeled = 0
|
||||
acct_skipped = 0
|
||||
acct_errors = 0
|
||||
|
||||
# Find transactions (optionally include already-labeled if force=true)
|
||||
entries = account.entries
|
||||
.joins("INNER JOIN transactions ON transactions.id = entries.entryable_id AND entries.entryable_type = 'Transaction'")
|
||||
.includes(:entryable)
|
||||
|
||||
unless force
|
||||
entries = entries.where("transactions.investment_activity_label IS NULL OR transactions.investment_activity_label = ''")
|
||||
end
|
||||
|
||||
entries.find_each do |entry|
|
||||
acct_processed += 1
|
||||
total_processed += 1
|
||||
|
||||
begin
|
||||
transaction = entry.transaction
|
||||
current_label = transaction.investment_activity_label
|
||||
label = InvestmentActivityDetector.infer_label_from_description(entry.name, entry.amount, account)
|
||||
|
||||
# Skip if no label can be inferred
|
||||
if label.blank?
|
||||
acct_skipped += 1
|
||||
total_skipped += 1
|
||||
next
|
||||
end
|
||||
|
||||
# Skip if label unchanged (when force=true)
|
||||
if current_label == label
|
||||
acct_skipped += 1
|
||||
total_skipped += 1
|
||||
next
|
||||
end
|
||||
|
||||
if dry_run
|
||||
if current_label.present?
|
||||
puts " [DRY RUN] Would relabel '#{entry.name}' (#{entry.amount}) from '#{current_label}' to '#{label}'"
|
||||
else
|
||||
puts " [DRY RUN] Would label '#{entry.name}' (#{entry.amount}) as '#{label}'"
|
||||
end
|
||||
else
|
||||
transaction.update!(investment_activity_label: label)
|
||||
if current_label.present?
|
||||
puts " Relabeled '#{entry.name}' (#{entry.amount}) from '#{current_label}' to '#{label}'"
|
||||
else
|
||||
puts " Labeled '#{entry.name}' (#{entry.amount}) as '#{label}'"
|
||||
end
|
||||
end
|
||||
acct_labeled += 1
|
||||
total_labeled += 1
|
||||
rescue => e
|
||||
acct_errors += 1
|
||||
total_errors += 1
|
||||
puts({ error: e.class.name, message: e.message, entry_id: entry.id }.to_json)
|
||||
end
|
||||
end
|
||||
|
||||
puts({ account_id: account.id, account_name: account.name, accountable_type: account.accountable_type, processed: acct_processed, labeled: acct_labeled, skipped: acct_skipped, errors: acct_errors, dry_run: dry_run, force: force }.to_json)
|
||||
end
|
||||
|
||||
puts({ ok: true, total_processed: total_processed, total_labeled: total_labeled, total_skipped: total_skipped, total_errors: total_errors, dry_run: dry_run }.to_json)
|
||||
end
|
||||
|
||||
desc "Clear all investment activity labels (for testing). Args: account_id (required), dry_run=true"
|
||||
task :clear_labels, [ :account_id, :dry_run ] => :environment do |_, args|
|
||||
kv = {}
|
||||
[ args[:account_id], args[:dry_run] ].each do |raw|
|
||||
next unless raw.is_a?(String) && raw.include?("=")
|
||||
k, v = raw.split("=", 2)
|
||||
kv[k.to_s] = v
|
||||
end
|
||||
|
||||
# Only use positional args if they don't contain "="
|
||||
positional_account_id = args[:account_id] unless args[:account_id].to_s.include?("=")
|
||||
positional_dry_run = args[:dry_run] unless args[:dry_run].to_s.include?("=")
|
||||
|
||||
account_id = (kv["account_id"] || positional_account_id).presence
|
||||
dry_raw = (kv["dry_run"] || positional_dry_run).to_s.downcase
|
||||
|
||||
unless account_id.present?
|
||||
puts({ ok: false, error: "usage", message: "Provide account_id" }.to_json)
|
||||
exit 1
|
||||
end
|
||||
|
||||
dry_run = if dry_raw.blank?
|
||||
true
|
||||
elsif %w[1 true yes y].include?(dry_raw)
|
||||
true
|
||||
elsif %w[0 false no n].include?(dry_raw)
|
||||
false
|
||||
else
|
||||
puts({ ok: false, error: "invalid_argument", message: "dry_run must be one of: true/yes/1 or false/no/0" }.to_json)
|
||||
exit 1
|
||||
end
|
||||
|
||||
account = Account.find(account_id)
|
||||
|
||||
count = account.entries
|
||||
.joins("INNER JOIN transactions ON transactions.id = entries.entryable_id AND entries.entryable_type = 'Transaction'")
|
||||
.where("transactions.investment_activity_label IS NOT NULL AND transactions.investment_activity_label != ''")
|
||||
.count
|
||||
|
||||
if dry_run
|
||||
puts({ ok: true, message: "Would clear #{count} labels", dry_run: true }.to_json)
|
||||
else
|
||||
Transaction.joins(:entry)
|
||||
.where(entries: { account_id: account_id })
|
||||
.where("investment_activity_label IS NOT NULL AND investment_activity_label != ''")
|
||||
.update_all(investment_activity_label: nil)
|
||||
puts({ ok: true, message: "Cleared #{count} labels", dry_run: false }.to_json)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,299 +0,0 @@
|
||||
require "test_helper"
|
||||
|
||||
class InvestmentActivityDetectorTest < ActiveSupport::TestCase
|
||||
include EntriesTestHelper
|
||||
|
||||
setup do
|
||||
@family = families(:empty)
|
||||
@investment_account = @family.accounts.create!(
|
||||
name: "Brokerage",
|
||||
balance: 10000,
|
||||
cash_balance: 2000,
|
||||
currency: "USD",
|
||||
accountable: Investment.new
|
||||
)
|
||||
@detector = InvestmentActivityDetector.new(@investment_account)
|
||||
end
|
||||
|
||||
test "detects new holding purchase and marks matching transaction" do
|
||||
# Create a transaction that matches a new holding purchase
|
||||
entry = create_transaction(
|
||||
account: @investment_account,
|
||||
amount: 1000,
|
||||
name: "Buy VFIAX"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
# Simulate holdings snapshot showing a new holding
|
||||
current_holdings = [
|
||||
{ "symbol" => "VFIAX", "cost_basis" => 1000.0, "shares" => 10 }
|
||||
]
|
||||
|
||||
# No previous snapshot
|
||||
@investment_account.update!(holdings_snapshot_data: nil, holdings_snapshot_at: nil)
|
||||
|
||||
@detector.detect_and_mark_internal_activity(current_holdings, [ transaction ])
|
||||
|
||||
entry.reload
|
||||
assert entry.exclude_from_cashflow?, "Transaction matching new holding should be excluded from cashflow"
|
||||
end
|
||||
|
||||
test "detects holding sale and marks matching transaction" do
|
||||
# Set up previous holdings
|
||||
previous_holdings = [
|
||||
{ "symbol" => "VFIAX", "cost_basis" => 2000.0, "shares" => 20 }
|
||||
]
|
||||
@investment_account.update!(
|
||||
holdings_snapshot_data: previous_holdings,
|
||||
holdings_snapshot_at: 1.day.ago
|
||||
)
|
||||
|
||||
# Create a transaction for the sale proceeds (negative = inflow)
|
||||
entry = create_transaction(
|
||||
account: @investment_account,
|
||||
amount: -1000,
|
||||
name: "Sell VFIAX"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
# Current holdings show reduced position
|
||||
current_holdings = [
|
||||
{ "symbol" => "VFIAX", "cost_basis" => 1000.0, "shares" => 10 }
|
||||
]
|
||||
|
||||
@detector.detect_and_mark_internal_activity(current_holdings, [ transaction ])
|
||||
|
||||
entry.reload
|
||||
assert entry.exclude_from_cashflow?, "Transaction matching holding sale should be excluded from cashflow"
|
||||
end
|
||||
|
||||
test "respects locked exclude_from_cashflow attribute" do
|
||||
# Create a transaction and lock the attribute
|
||||
entry = create_transaction(
|
||||
account: @investment_account,
|
||||
amount: 1000,
|
||||
name: "Buy VFIAX"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
# User explicitly set to NOT exclude (and locked it)
|
||||
entry.update!(exclude_from_cashflow: false)
|
||||
entry.lock_attr!(:exclude_from_cashflow)
|
||||
|
||||
current_holdings = [
|
||||
{ "symbol" => "VFIAX", "cost_basis" => 1000.0, "shares" => 10 }
|
||||
]
|
||||
|
||||
@detector.detect_and_mark_internal_activity(current_holdings, [ transaction ])
|
||||
|
||||
entry.reload
|
||||
assert_not entry.exclude_from_cashflow?, "Locked attribute should not be overwritten"
|
||||
end
|
||||
|
||||
test "updates holdings snapshot after detection" do
|
||||
current_holdings = [
|
||||
{ "symbol" => "VFIAX", "cost_basis" => 1000.0, "shares" => 10 },
|
||||
{ "symbol" => "IBIT", "cost_basis" => 500.0, "shares" => 5 }
|
||||
]
|
||||
|
||||
@detector.detect_and_mark_internal_activity(current_holdings, [])
|
||||
|
||||
@investment_account.reload
|
||||
# Snapshot is normalized with string values and additional fields
|
||||
snapshot = @investment_account.holdings_snapshot_data
|
||||
assert_equal 2, snapshot.size
|
||||
assert_equal "VFIAX", snapshot[0]["symbol"]
|
||||
assert_equal "1000.0", snapshot[0]["cost_basis"]
|
||||
assert_equal "10.0", snapshot[0]["shares"]
|
||||
assert_equal "IBIT", snapshot[1]["symbol"]
|
||||
assert_not_nil @investment_account.holdings_snapshot_at
|
||||
end
|
||||
|
||||
test "matches transaction by cost_basis amount within tolerance" do
|
||||
entry = create_transaction(
|
||||
account: @investment_account,
|
||||
amount: 1000.005, # Very close - within 0.01 tolerance
|
||||
name: "Investment purchase"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
# Holding with cost basis close to transaction amount (within 0.01)
|
||||
current_holdings = [
|
||||
{ "symbol" => "VFIAX", "cost_basis" => 1000.0, "shares" => 10 }
|
||||
]
|
||||
|
||||
@detector.detect_and_mark_internal_activity(current_holdings, [ transaction ])
|
||||
|
||||
entry.reload
|
||||
assert entry.exclude_from_cashflow?, "Should match transaction within tolerance"
|
||||
end
|
||||
|
||||
test "does not mark unrelated transactions" do
|
||||
# Create a regular expense transaction
|
||||
entry = create_transaction(
|
||||
account: @investment_account,
|
||||
amount: 50,
|
||||
name: "Account fee"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
# Holdings that don't match
|
||||
current_holdings = [
|
||||
{ "symbol" => "VFIAX", "cost_basis" => 1000.0, "shares" => 10 }
|
||||
]
|
||||
|
||||
@detector.detect_and_mark_internal_activity(current_holdings, [ transaction ])
|
||||
|
||||
entry.reload
|
||||
assert_not entry.exclude_from_cashflow?, "Unrelated transaction should not be excluded"
|
||||
end
|
||||
|
||||
test "works with crypto accounts" do
|
||||
crypto_account = @family.accounts.create!(
|
||||
name: "Crypto Wallet",
|
||||
balance: 5000,
|
||||
currency: "USD",
|
||||
accountable: Crypto.new
|
||||
)
|
||||
detector = InvestmentActivityDetector.new(crypto_account)
|
||||
|
||||
entry = create_transaction(
|
||||
account: crypto_account,
|
||||
amount: 1000,
|
||||
name: "Buy BTC"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
current_holdings = [
|
||||
{ "symbol" => "BTC", "cost_basis" => 1000.0, "shares" => 0.02 }
|
||||
]
|
||||
|
||||
detector.detect_and_mark_internal_activity(current_holdings, [ transaction ])
|
||||
|
||||
entry.reload
|
||||
assert entry.exclude_from_cashflow?, "Should work with crypto accounts"
|
||||
end
|
||||
|
||||
test "handles empty holdings gracefully" do
|
||||
entry = create_transaction(
|
||||
account: @investment_account,
|
||||
amount: 1000,
|
||||
name: "Some transaction"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
# Should not raise, just do nothing
|
||||
assert_nothing_raised do
|
||||
@detector.detect_and_mark_internal_activity([], [ transaction ])
|
||||
end
|
||||
|
||||
entry.reload
|
||||
assert_not entry.exclude_from_cashflow?
|
||||
end
|
||||
|
||||
test "handles nil holdings gracefully" do
|
||||
entry = create_transaction(
|
||||
account: @investment_account,
|
||||
amount: 1000,
|
||||
name: "Some transaction"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
assert_nothing_raised do
|
||||
@detector.detect_and_mark_internal_activity(nil, [ transaction ])
|
||||
end
|
||||
|
||||
entry.reload
|
||||
assert_not entry.exclude_from_cashflow?
|
||||
end
|
||||
|
||||
test "sets Buy label for new holding purchase" do
|
||||
entry = create_transaction(
|
||||
account: @investment_account,
|
||||
amount: 1000,
|
||||
name: "Some investment"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
current_holdings = [
|
||||
{ "symbol" => "VFIAX", "cost_basis" => 1000.0, "shares" => 10 }
|
||||
]
|
||||
|
||||
@detector.detect_and_mark_internal_activity(current_holdings, [ transaction ])
|
||||
|
||||
transaction.reload
|
||||
assert_equal "Buy", transaction.investment_activity_label
|
||||
end
|
||||
|
||||
test "sets Sell label for holding sale" do
|
||||
previous_holdings = [
|
||||
{ "symbol" => "VFIAX", "cost_basis" => 2000.0, "shares" => 20 }
|
||||
]
|
||||
@investment_account.update!(
|
||||
holdings_snapshot_data: previous_holdings,
|
||||
holdings_snapshot_at: 1.day.ago
|
||||
)
|
||||
|
||||
entry = create_transaction(
|
||||
account: @investment_account,
|
||||
amount: -1000,
|
||||
name: "VFIAX Sale"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
current_holdings = [
|
||||
{ "symbol" => "VFIAX", "cost_basis" => 1000.0, "shares" => 10 }
|
||||
]
|
||||
|
||||
@detector.detect_and_mark_internal_activity(current_holdings, [ transaction ])
|
||||
|
||||
transaction.reload
|
||||
assert_equal "Sell", transaction.investment_activity_label
|
||||
end
|
||||
|
||||
test "infers Sweep In label from money market description" do
|
||||
entry = create_transaction(
|
||||
account: @investment_account,
|
||||
amount: -500,
|
||||
name: "VANGUARD FEDERAL MONEY MARKET"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
# Call with empty holdings but simulate it being a sweep
|
||||
# This tests the infer_from_description fallback
|
||||
current_holdings = [
|
||||
{ "symbol" => "VMFXX", "cost_basis" => 500.0, "shares" => 500 }
|
||||
]
|
||||
|
||||
@detector.detect_and_mark_internal_activity(current_holdings, [ transaction ])
|
||||
|
||||
transaction.reload
|
||||
# Should be either "Buy" (from holdings match) or "Sweep In" (from description)
|
||||
assert transaction.investment_activity_label.present?
|
||||
end
|
||||
|
||||
test "infers Dividend label from CASH description" do
|
||||
entry = create_transaction(
|
||||
account: @investment_account,
|
||||
amount: -50,
|
||||
name: "CASH"
|
||||
)
|
||||
transaction = entry.transaction
|
||||
|
||||
# No holdings change, but description-based inference
|
||||
current_holdings = [
|
||||
{ "symbol" => "VFIAX", "cost_basis" => 1000.0, "shares" => 10 }
|
||||
]
|
||||
@investment_account.update!(
|
||||
holdings_snapshot_data: current_holdings,
|
||||
holdings_snapshot_at: 1.day.ago
|
||||
)
|
||||
|
||||
@detector.detect_and_mark_internal_activity(current_holdings, [ transaction ])
|
||||
|
||||
# Since there's no holdings change, no label gets set via holdings match
|
||||
# But if we manually test the infer_from_description method...
|
||||
label = @detector.send(:infer_from_description, entry)
|
||||
assert_equal "Dividend", label
|
||||
end
|
||||
end
|
||||
@@ -100,4 +100,36 @@ class Rule::ActionTest < ActiveSupport::TestCase
|
||||
assert_equal new_name, transaction.reload.entry.name
|
||||
end
|
||||
end
|
||||
|
||||
test "set_investment_activity_label" do
|
||||
# Does not modify transactions that are locked (user edited them)
|
||||
@txn1.lock_attr!(:investment_activity_label)
|
||||
|
||||
action = Rule::Action.new(
|
||||
rule: @transaction_rule,
|
||||
action_type: "set_investment_activity_label",
|
||||
value: "Dividend"
|
||||
)
|
||||
|
||||
action.apply(@rule_scope)
|
||||
|
||||
assert_nil @txn1.reload.investment_activity_label
|
||||
|
||||
[ @txn2, @txn3 ].each do |transaction|
|
||||
assert_equal "Dividend", transaction.reload.investment_activity_label
|
||||
end
|
||||
end
|
||||
|
||||
test "set_investment_activity_label ignores invalid values" do
|
||||
action = Rule::Action.new(
|
||||
rule: @transaction_rule,
|
||||
action_type: "set_investment_activity_label",
|
||||
value: "InvalidLabel"
|
||||
)
|
||||
|
||||
result = action.apply(@rule_scope)
|
||||
|
||||
assert_equal 0, result
|
||||
assert_nil @txn1.reload.investment_activity_label
|
||||
end
|
||||
end
|
||||
|
||||
@@ -35,13 +35,6 @@ class TransactionTest < ActiveSupport::TestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "INTERNAL_ACTIVITY_LABELS contains expected labels" do
|
||||
assert_includes Transaction::INTERNAL_ACTIVITY_LABELS, "Buy"
|
||||
assert_includes Transaction::INTERNAL_ACTIVITY_LABELS, "Sell"
|
||||
assert_includes Transaction::INTERNAL_ACTIVITY_LABELS, "Reinvestment"
|
||||
assert_includes Transaction::INTERNAL_ACTIVITY_LABELS, "Exchange"
|
||||
end
|
||||
|
||||
test "ACTIVITY_LABELS contains all valid labels" do
|
||||
assert_includes Transaction::ACTIVITY_LABELS, "Buy"
|
||||
assert_includes Transaction::ACTIVITY_LABELS, "Sell"
|
||||
|
||||
Reference in New Issue
Block a user