mirror of
https://github.com/we-promise/sure.git
synced 2026-05-12 15:15:01 +00:00
139c89d0f4
* feat(investments): add India investment subtypes and exchange support * fix(yahoo-finance): scope Indian exchange de-duplication per company instead of globally Resolves feedback from Codex and CodeRabbit on #1413. prefer_indian_exchange previously collapsed all Indian securities into a single entry, silently dropping unrelated tickers. Now groups Indian listings by name and only de-duplicates within each group, so distinct companies (e.g. Reliance and Infosys) are preserved while NSE/BSE dual-listings still prefer NSE. - Derive India subtype keys dynamically from Investment::SUBTYPES in tests - Fix missing keyword arguments in Security.new test calls * refactor(yahoo-finance): generalize exchange config and dual-listing de-duplication Replaces hardcoded Indian exchange logic with a declarative EXCHANGE_CONFIG hash that maps ISO MIC codes to Yahoo-specific settings (symbol suffix, default currency, dual-listing group, and preference rank). This makes adding new markets a one-line hash entry instead of scattered conditionals. * fix(yahoo-finance): normalize security names for dual-listing de-duplication * fix(yahoo-finance): skip dual-listing de-duplication when filtering by exchange * fix: address PR review feedback for India market support - fix cache key mismatch in fetch_security_price by normalizing symbol before building cache key - remove dead YAHOO_EXCHANGE_CURRENCY constant - tighten normalize_symbol guard to use end_with?(suffix) instead of include?('.') - remove misleading '# India' comment from Property::SUBTYPES - remove 'rented' property subtype in favor of 'investment_property' - rename 'demat' to 'indian_stocks' for clarity - add INR to CURRENCY_REGION_MAP so India appears first for INR users - add dotted-symbol regression test for normalize_symbol * fix(investments): rename 'demat' subtype to 'indian_stocks' and remove trailing comma
150 lines
9.2 KiB
Ruby
150 lines
9.2 KiB
Ruby
class Investment < ApplicationRecord
|
|
include Accountable
|
|
|
|
# Tax treatment categories:
|
|
# - taxable: Gains taxed when realized
|
|
# - tax_deferred: Taxes deferred until withdrawal
|
|
# - tax_exempt: Qualified gains are tax-free
|
|
# - tax_advantaged: Special tax benefits with conditions
|
|
SUBTYPES = {
|
|
# === United States ===
|
|
"brokerage" => { short: "Brokerage", long: "Brokerage", region: "us", tax_treatment: :taxable },
|
|
"401k" => { short: "401(k)", long: "401(k)", region: "us", tax_treatment: :tax_deferred },
|
|
"roth_401k" => { short: "Roth 401(k)", long: "Roth 401(k)", region: "us", tax_treatment: :tax_exempt },
|
|
"403b" => { short: "403(b)", long: "403(b)", region: "us", tax_treatment: :tax_deferred },
|
|
"457b" => { short: "457(b)", long: "457(b)", region: "us", tax_treatment: :tax_deferred },
|
|
"tsp" => { short: "TSP", long: "Thrift Savings Plan", region: "us", tax_treatment: :tax_deferred },
|
|
"ira" => { short: "IRA", long: "Traditional IRA", region: "us", tax_treatment: :tax_deferred },
|
|
"roth_ira" => { short: "Roth IRA", long: "Roth IRA", region: "us", tax_treatment: :tax_exempt },
|
|
"sep_ira" => { short: "SEP IRA", long: "SEP IRA", region: "us", tax_treatment: :tax_deferred },
|
|
"simple_ira" => { short: "SIMPLE IRA", long: "SIMPLE IRA", region: "us", tax_treatment: :tax_deferred },
|
|
"529_plan" => { short: "529 Plan", long: "529 Education Savings Plan", region: "us", tax_treatment: :tax_advantaged },
|
|
"hsa" => { short: "HSA", long: "Health Savings Account", region: "us", tax_treatment: :tax_advantaged },
|
|
"ugma" => { short: "UGMA", long: "UGMA Custodial Account", region: "us", tax_treatment: :taxable },
|
|
"utma" => { short: "UTMA", long: "UTMA Custodial Account", region: "us", tax_treatment: :taxable },
|
|
|
|
# === United Kingdom ===
|
|
"isa" => { short: "ISA", long: "Individual Savings Account", region: "uk", tax_treatment: :tax_exempt },
|
|
"lisa" => { short: "LISA", long: "Lifetime ISA", region: "uk", tax_treatment: :tax_exempt },
|
|
"sipp" => { short: "SIPP", long: "Self-Invested Personal Pension", region: "uk", tax_treatment: :tax_deferred },
|
|
"workplace_pension_uk" => { short: "Pension", long: "Workplace Pension", region: "uk", tax_treatment: :tax_deferred },
|
|
|
|
# === Canada ===
|
|
"tfsa" => { short: "TFSA", long: "Tax-Free Savings Account", region: "ca", tax_treatment: :tax_exempt },
|
|
"rrsp" => { short: "RRSP", long: "Registered Retirement Savings Plan", region: "ca", tax_treatment: :tax_deferred },
|
|
"non-registered" => { short: "Non-Registered", long: "Non-Registered Investment Account", region: "ca", tax_treatment: :taxable },
|
|
"fhsa" => { short: "FHSA", long: "First Home Savings Account", region: "ca", tax_treatment: :tax_exempt },
|
|
"rdsp" => { short: "RDSP", long: "Registered Disability Savings Plan", region: "ca", tax_treatment: :tax_advantaged },
|
|
"resp" => { short: "RESP", long: "Registered Education Savings Plan", region: "ca", tax_treatment: :tax_advantaged },
|
|
"dpsp" => { short: "DPSP", long: "Deferred Profit Sharing Plan", region: "ca", tax_treatment: :tax_deferred },
|
|
"prpp" => { short: "PRPP", long: "Pooled Registered Pension Plan", region: "ca", tax_treatment: :tax_deferred },
|
|
"lira" => { short: "LIRA", long: "Locked-In Retirement Account", region: "ca", tax_treatment: :tax_deferred },
|
|
"rrif" => { short: "RRIF", long: "Registered Retirement Income Fund", region: "ca", tax_treatment: :tax_deferred },
|
|
"lif" => { short: "LIF", long: "Life Income Fund", region: "ca", tax_treatment: :tax_deferred },
|
|
"lrif" => { short: "LRIF", long: "Locked-In Retirement Income Fund", region: "ca", tax_treatment: :tax_deferred },
|
|
"prif" => { short: "PRIF", long: "Prescribed Registered Retirement Income Fund", region: "ca", tax_treatment: :tax_deferred },
|
|
"rlif" => { short: "RLIF", long: "Restricted Life Income Fund", region: "ca", tax_treatment: :tax_deferred },
|
|
|
|
# === Australia ===
|
|
"super" => { short: "Super", long: "Superannuation", region: "au", tax_treatment: :tax_deferred },
|
|
"smsf" => { short: "SMSF", long: "Self-Managed Super Fund", region: "au", tax_treatment: :tax_deferred },
|
|
|
|
# === Europe ===
|
|
"assurance_vie" => { short: "AV", long: "Assurance Vie", region: "eu", tax_treatment: :tax_advantaged },
|
|
"pea" => { short: "PEA", long: "Plan d'Épargne en Actions", region: "eu", tax_treatment: :tax_advantaged },
|
|
"pillar_3a" => { short: "Pillar 3a", long: "Private Pension (Pillar 3a)", region: "eu", tax_treatment: :tax_deferred },
|
|
"riester" => { short: "Riester", long: "Riester-Rente", region: "eu", tax_treatment: :tax_deferred },
|
|
|
|
# === India ===
|
|
# Pensions & insurance
|
|
"nps" => { short: "NPS", long: "National Pension System", region: "in", tax_treatment: :tax_advantaged },
|
|
"apy" => { short: "APY", long: "Atal Pension Yojana", region: "in", tax_treatment: :tax_advantaged },
|
|
"life_insurance" => { short: "Life Insurance", long: "Life Insurance", region: "in", tax_treatment: :tax_advantaged },
|
|
# Equity / market-linked
|
|
"indian_stocks" => { short: "Indian Stocks", long: "Indian Stocks (Demat)", region: "in", tax_treatment: :taxable },
|
|
"indian_equity" => { short: "Indian Equity", long: "Indian Equity", region: "in", tax_treatment: :taxable },
|
|
"indian_etf" => { short: "Indian ETF", long: "Indian ETF", region: "in", tax_treatment: :taxable },
|
|
# Fixed-income / small-savings
|
|
"ppf" => { short: "PPF", long: "Public Provident Fund", region: "in", tax_treatment: :tax_exempt },
|
|
"ssy" => { short: "SSY", long: "Sukanya Samriddhi Yojana", region: "in", tax_treatment: :tax_exempt },
|
|
"nsc" => { short: "NSC", long: "National Savings Certificate", region: "in", tax_treatment: :tax_advantaged },
|
|
"scss" => { short: "SCSS", long: "Senior Citizens' Savings Scheme", region: "in", tax_treatment: :taxable },
|
|
"fd" => { short: "FD", long: "Fixed Deposit", region: "in", tax_treatment: :taxable },
|
|
"rd" => { short: "RD", long: "Recurring Deposit", region: "in", tax_treatment: :taxable },
|
|
"pomis" => { short: "POMIS", long: "Post Office Monthly Income Scheme", region: "in", tax_treatment: :taxable },
|
|
"kvp" => { short: "KVP", long: "Kisan Vikas Patra", region: "in", tax_treatment: :taxable },
|
|
# Bonds
|
|
"g_sec" => { short: "G-Sec", long: "Government Securities (G-Secs)", region: "in", tax_treatment: :taxable },
|
|
"sdl" => { short: "SDL", long: "State Development Loans (SDLs)", region: "in", tax_treatment: :taxable },
|
|
"corporate_bond" => { short: "Corporate Bond", long: "Corporate Bond", region: "in", tax_treatment: :taxable },
|
|
"infrastructure_bond" => { short: "Infra Bond", long: "Infrastructure Bond", region: "in", tax_treatment: :tax_advantaged },
|
|
"tax_free_bond" => { short: "Tax-Free Bond", long: "Tax-Free Bond", region: "in", tax_treatment: :tax_exempt },
|
|
# India-specific gold instruments
|
|
"gold_etf" => { short: "Gold ETF", long: "Gold ETF", region: "in", tax_treatment: :taxable },
|
|
"gold_mf" => { short: "Gold MF", long: "Gold Mutual Fund", region: "in", tax_treatment: :taxable },
|
|
"sgb" => { short: "SGB", long: "Sovereign Gold Bond", region: "in", tax_treatment: :tax_advantaged },
|
|
|
|
# === Generic (available everywhere) ===
|
|
"pension" => { short: "Pension", long: "Pension", region: nil, tax_treatment: :tax_deferred },
|
|
"retirement" => { short: "Retirement", long: "Retirement Account", region: nil, tax_treatment: :tax_deferred },
|
|
"mutual_fund" => { short: "Mutual Fund", long: "Mutual Fund", region: nil, tax_treatment: :taxable },
|
|
"gold" => { short: "Gold", long: "Gold (physical or digital)", region: nil, tax_treatment: :taxable },
|
|
"angel" => { short: "Angel", long: "Angel Investment", region: nil, tax_treatment: :taxable },
|
|
"trust" => { short: "Trust", long: "Trust", region: nil, tax_treatment: :taxable },
|
|
"other" => { short: "Other", long: "Other Investment", region: nil, tax_treatment: :taxable }
|
|
}.freeze
|
|
|
|
def tax_treatment
|
|
SUBTYPES.dig(subtype, :tax_treatment) || :taxable
|
|
end
|
|
|
|
class << self
|
|
def color
|
|
"#1570EF"
|
|
end
|
|
|
|
def classification
|
|
"asset"
|
|
end
|
|
|
|
def icon
|
|
"chart-line"
|
|
end
|
|
|
|
def region_label_for(region)
|
|
I18n.t("accounts.subtype_regions.#{region || 'generic'}")
|
|
end
|
|
|
|
# Maps currency codes to regions for prioritizing user's likely region
|
|
CURRENCY_REGION_MAP = {
|
|
"USD" => "us",
|
|
"GBP" => "uk",
|
|
"CAD" => "ca",
|
|
"AUD" => "au",
|
|
"EUR" => "eu",
|
|
"CHF" => "eu",
|
|
"INR" => "in"
|
|
}.freeze
|
|
|
|
# Returns subtypes grouped by region for use with grouped_options_for_select
|
|
# Optionally accepts currency to prioritize user's region first
|
|
def subtypes_grouped_for_select(currency: nil)
|
|
user_region = CURRENCY_REGION_MAP[currency]
|
|
grouped = SUBTYPES.group_by { |_, v| v[:region] }
|
|
|
|
# Build region order: user's region first (if known), then Generic, then others
|
|
other_regions = %w[us uk ca au eu in] - [ user_region ].compact
|
|
region_order = if user_region
|
|
[ user_region, nil, *other_regions ].uniq
|
|
else
|
|
[ nil, *other_regions ].uniq
|
|
end
|
|
|
|
region_order.filter_map do |region|
|
|
next unless grouped[region]
|
|
[ region_label_for(region), grouped[region].map { |k, v| [ v[:long], k ] } ]
|
|
end
|
|
end
|
|
end
|
|
end
|