mirror of
https://github.com/we-promise/sure.git
synced 2026-04-09 07:14:47 +00:00
* Add full import/export support for rules with versioned JSON schema This commit implements comprehensive import/export functionality for rules, allowing users to back up and restore their rule definitions. Key features: - Export rules to both CSV and NDJSON formats with versioned schema (v1) - Import rules from CSV with full support for nested conditions and actions - UUID to name mapping for categories and merchants for portability - Support for compound conditions with sub-conditions - Comprehensive test coverage for export and import functionality - UI integration for rules import in the imports interface Technical details: - Extended Family::DataExporter to generate rules.csv and include rules in all.ndjson - Created RuleImport model following the existing Import STI pattern - Added migration for rule-specific columns in import_rows table - Implemented serialization helpers to map UUIDs to human-readable names - Added i18n support for the new import option - Included versioning in NDJSON export to support future schema evolution The implementation ensures rules can be safely exported from one family and imported into another, even when category/merchant IDs differ, by mapping between names and IDs during export/import. * Fix AR migration version * Mention support for rules export * Rabbit suggestion * Fix tests * Missed schema.rb * Fix sample CSV download for rule import * Fix parsing in Rules import * Fix tests * Rule import message i18n * Export tag names, not UUIDs * Make sure tags are created if needed at import * Avoid test errors when running in parallel --------- Co-authored-by: Claude <noreply@anthropic.com>
353 lines
10 KiB
Ruby
353 lines
10 KiB
Ruby
require "zip"
|
|
require "csv"
|
|
|
|
class Family::DataExporter
|
|
def initialize(family)
|
|
@family = family
|
|
end
|
|
|
|
def generate_export
|
|
# Create a StringIO to hold the zip data in memory
|
|
zip_data = Zip::OutputStream.write_buffer do |zipfile|
|
|
# Add accounts.csv
|
|
zipfile.put_next_entry("accounts.csv")
|
|
zipfile.write generate_accounts_csv
|
|
|
|
# Add transactions.csv
|
|
zipfile.put_next_entry("transactions.csv")
|
|
zipfile.write generate_transactions_csv
|
|
|
|
# Add trades.csv
|
|
zipfile.put_next_entry("trades.csv")
|
|
zipfile.write generate_trades_csv
|
|
|
|
# Add categories.csv
|
|
zipfile.put_next_entry("categories.csv")
|
|
zipfile.write generate_categories_csv
|
|
|
|
# Add rules.csv
|
|
zipfile.put_next_entry("rules.csv")
|
|
zipfile.write generate_rules_csv
|
|
|
|
# Add all.ndjson
|
|
zipfile.put_next_entry("all.ndjson")
|
|
zipfile.write generate_ndjson
|
|
end
|
|
|
|
# Rewind and return the StringIO
|
|
zip_data.rewind
|
|
zip_data
|
|
end
|
|
|
|
private
|
|
|
|
def generate_accounts_csv
|
|
CSV.generate do |csv|
|
|
csv << [ "id", "name", "type", "subtype", "balance", "currency", "created_at" ]
|
|
|
|
# Only export accounts belonging to this family
|
|
@family.accounts.includes(:accountable).find_each do |account|
|
|
csv << [
|
|
account.id,
|
|
account.name,
|
|
account.accountable_type,
|
|
account.subtype,
|
|
account.balance.to_s,
|
|
account.currency,
|
|
account.created_at.iso8601
|
|
]
|
|
end
|
|
end
|
|
end
|
|
|
|
def generate_transactions_csv
|
|
CSV.generate do |csv|
|
|
csv << [ "date", "account_name", "amount", "name", "category", "tags", "notes", "currency" ]
|
|
|
|
# Only export transactions from accounts belonging to this family
|
|
@family.transactions
|
|
.includes(:category, :tags, entry: :account)
|
|
.find_each do |transaction|
|
|
csv << [
|
|
transaction.entry.date.iso8601,
|
|
transaction.entry.account.name,
|
|
transaction.entry.amount.to_s,
|
|
transaction.entry.name,
|
|
transaction.category&.name,
|
|
transaction.tags.pluck(:name).join(","),
|
|
transaction.entry.notes,
|
|
transaction.entry.currency
|
|
]
|
|
end
|
|
end
|
|
end
|
|
|
|
def generate_trades_csv
|
|
CSV.generate do |csv|
|
|
csv << [ "date", "account_name", "ticker", "quantity", "price", "amount", "currency" ]
|
|
|
|
# Only export trades from accounts belonging to this family
|
|
@family.trades
|
|
.includes(:security, entry: :account)
|
|
.find_each do |trade|
|
|
csv << [
|
|
trade.entry.date.iso8601,
|
|
trade.entry.account.name,
|
|
trade.security.ticker,
|
|
trade.qty.to_s,
|
|
trade.price.to_s,
|
|
trade.entry.amount.to_s,
|
|
trade.currency
|
|
]
|
|
end
|
|
end
|
|
end
|
|
|
|
def generate_categories_csv
|
|
CSV.generate do |csv|
|
|
csv << [ "name", "color", "parent_category", "classification", "lucide_icon" ]
|
|
|
|
# Only export categories belonging to this family
|
|
@family.categories.includes(:parent).find_each do |category|
|
|
csv << [
|
|
category.name,
|
|
category.color,
|
|
category.parent&.name,
|
|
category.classification,
|
|
category.lucide_icon
|
|
]
|
|
end
|
|
end
|
|
end
|
|
|
|
def generate_rules_csv
|
|
CSV.generate do |csv|
|
|
csv << [ "name", "resource_type", "active", "effective_date", "conditions", "actions" ]
|
|
|
|
# Only export rules belonging to this family
|
|
@family.rules.includes(conditions: :sub_conditions, actions: []).find_each do |rule|
|
|
csv << [
|
|
rule.name,
|
|
rule.resource_type,
|
|
rule.active,
|
|
rule.effective_date&.iso8601,
|
|
serialize_conditions_for_csv(rule.conditions),
|
|
serialize_actions_for_csv(rule.actions)
|
|
]
|
|
end
|
|
end
|
|
end
|
|
|
|
def generate_ndjson
|
|
lines = []
|
|
|
|
# Export accounts with full accountable data
|
|
@family.accounts.includes(:accountable).find_each do |account|
|
|
lines << {
|
|
type: "Account",
|
|
data: account.as_json(
|
|
include: {
|
|
accountable: {}
|
|
}
|
|
)
|
|
}.to_json
|
|
end
|
|
|
|
# Export categories
|
|
@family.categories.find_each do |category|
|
|
lines << {
|
|
type: "Category",
|
|
data: category.as_json
|
|
}.to_json
|
|
end
|
|
|
|
# Export tags
|
|
@family.tags.find_each do |tag|
|
|
lines << {
|
|
type: "Tag",
|
|
data: tag.as_json
|
|
}.to_json
|
|
end
|
|
|
|
# Export merchants (only family merchants)
|
|
@family.merchants.find_each do |merchant|
|
|
lines << {
|
|
type: "Merchant",
|
|
data: merchant.as_json
|
|
}.to_json
|
|
end
|
|
|
|
# Export transactions with full data
|
|
@family.transactions.includes(:category, :merchant, :tags, entry: :account).find_each do |transaction|
|
|
lines << {
|
|
type: "Transaction",
|
|
data: {
|
|
id: transaction.id,
|
|
entry_id: transaction.entry.id,
|
|
account_id: transaction.entry.account_id,
|
|
date: transaction.entry.date,
|
|
amount: transaction.entry.amount,
|
|
currency: transaction.entry.currency,
|
|
name: transaction.entry.name,
|
|
notes: transaction.entry.notes,
|
|
excluded: transaction.entry.excluded,
|
|
category_id: transaction.category_id,
|
|
merchant_id: transaction.merchant_id,
|
|
tag_ids: transaction.tag_ids,
|
|
kind: transaction.kind,
|
|
created_at: transaction.created_at,
|
|
updated_at: transaction.updated_at
|
|
}
|
|
}.to_json
|
|
end
|
|
|
|
# Export trades with full data
|
|
@family.trades.includes(:security, entry: :account).find_each do |trade|
|
|
lines << {
|
|
type: "Trade",
|
|
data: {
|
|
id: trade.id,
|
|
entry_id: trade.entry.id,
|
|
account_id: trade.entry.account_id,
|
|
security_id: trade.security_id,
|
|
ticker: trade.security.ticker,
|
|
date: trade.entry.date,
|
|
qty: trade.qty,
|
|
price: trade.price,
|
|
amount: trade.entry.amount,
|
|
currency: trade.currency,
|
|
created_at: trade.created_at,
|
|
updated_at: trade.updated_at
|
|
}
|
|
}.to_json
|
|
end
|
|
|
|
# Export valuations
|
|
@family.entries.valuations.includes(:account, :entryable).find_each do |entry|
|
|
lines << {
|
|
type: "Valuation",
|
|
data: {
|
|
id: entry.entryable.id,
|
|
entry_id: entry.id,
|
|
account_id: entry.account_id,
|
|
date: entry.date,
|
|
amount: entry.amount,
|
|
currency: entry.currency,
|
|
name: entry.name,
|
|
created_at: entry.created_at,
|
|
updated_at: entry.updated_at
|
|
}
|
|
}.to_json
|
|
end
|
|
|
|
# Export budgets
|
|
@family.budgets.find_each do |budget|
|
|
lines << {
|
|
type: "Budget",
|
|
data: budget.as_json
|
|
}.to_json
|
|
end
|
|
|
|
# Export budget categories
|
|
@family.budget_categories.includes(:budget, :category).find_each do |budget_category|
|
|
lines << {
|
|
type: "BudgetCategory",
|
|
data: budget_category.as_json
|
|
}.to_json
|
|
end
|
|
|
|
# Export rules with versioned schema
|
|
@family.rules.includes(conditions: :sub_conditions, actions: []).find_each do |rule|
|
|
lines << {
|
|
type: "Rule",
|
|
version: 1,
|
|
data: serialize_rule_for_export(rule)
|
|
}.to_json
|
|
end
|
|
|
|
lines.join("\n")
|
|
end
|
|
|
|
def serialize_rule_for_export(rule)
|
|
{
|
|
name: rule.name,
|
|
resource_type: rule.resource_type,
|
|
active: rule.active,
|
|
effective_date: rule.effective_date&.iso8601,
|
|
conditions: rule.conditions.where(parent_id: nil).map { |condition| serialize_condition(condition) },
|
|
actions: rule.actions.map { |action| serialize_action(action) }
|
|
}
|
|
end
|
|
|
|
def serialize_condition(condition)
|
|
data = {
|
|
condition_type: condition.condition_type,
|
|
operator: condition.operator,
|
|
value: resolve_condition_value(condition)
|
|
}
|
|
|
|
if condition.compound? && condition.sub_conditions.any?
|
|
data[:sub_conditions] = condition.sub_conditions.map { |sub| serialize_condition(sub) }
|
|
end
|
|
|
|
data
|
|
end
|
|
|
|
def serialize_action(action)
|
|
{
|
|
action_type: action.action_type,
|
|
value: resolve_action_value(action)
|
|
}
|
|
end
|
|
|
|
def resolve_condition_value(condition)
|
|
return condition.value unless condition.value.present?
|
|
|
|
# Map category UUIDs to names for portability
|
|
if condition.condition_type == "transaction_category" && condition.value.present?
|
|
category = @family.categories.find_by(id: condition.value)
|
|
return category&.name || condition.value
|
|
end
|
|
|
|
# Map merchant UUIDs to names for portability
|
|
if condition.condition_type == "transaction_merchant" && condition.value.present?
|
|
merchant = @family.merchants.find_by(id: condition.value)
|
|
return merchant&.name || condition.value
|
|
end
|
|
|
|
condition.value
|
|
end
|
|
|
|
def resolve_action_value(action)
|
|
return action.value unless action.value.present?
|
|
|
|
# Map category UUIDs to names for portability
|
|
if action.action_type == "set_transaction_category" && action.value.present?
|
|
category = @family.categories.find_by(id: action.value) || @family.categories.find_by(name: action.value)
|
|
return category&.name || action.value
|
|
end
|
|
|
|
# Map merchant UUIDs to names for portability
|
|
if action.action_type == "set_transaction_merchant" && action.value.present?
|
|
merchant = @family.merchants.find_by(id: action.value) || @family.merchants.find_by(name: action.value)
|
|
return merchant&.name || action.value
|
|
end
|
|
|
|
# Map tag UUIDs to names for portability
|
|
if action.action_type == "set_transaction_tags" && action.value.present?
|
|
tag = @family.tags.find_by(id: action.value) || @family.tags.find_by(name: action.value)
|
|
return tag&.name || action.value
|
|
end
|
|
|
|
action.value
|
|
end
|
|
|
|
def serialize_conditions_for_csv(conditions)
|
|
conditions.where(parent_id: nil).map { |c| serialize_condition(c) }.to_json
|
|
end
|
|
|
|
def serialize_actions_for_csv(actions)
|
|
actions.map { |a| serialize_action(a) }.to_json
|
|
end
|
|
end
|