mirror of
https://github.com/we-promise/sure.git
synced 2026-04-08 06:44:52 +00:00
* Implement API v1 Imports controller - Add Api::V1::ImportsController with index, show, and create actions - Add Jbuilder views for index and show - Add integration tests - Implement row generation logic in create action - Update routes * Validate import account belongs to family - Add validation to Import model to ensure account belongs to the same family - Add regression test case in Api::V1::ImportsControllerTest * updating docs to be more detailed * Rescue StandardError instead of bare rescue in ImportsController * Optimize Imports API and fix documentation - Implement rows_count counter cache for Imports - Preload rows in Api::V1::ImportsController#show - Update documentation to show correct OAuth scopes * Fix formatting in ImportsControllerTest * Permit all import parameters and fix unknown attribute error * Restore API routes for auth, chats, and messages * removing pr summary * Fix trailing whitespace and configured? test failure - Update Import#configured? to use rows_count for performance and consistency - Mock rows_count in TransactionImportTest - Fix trailing whitespace in migration * Harden security and fix mass assignment in ImportsController - Handle type and account_id explicitly in create action - Rename import_params to import_config_params for clarity - Validate type against Import::TYPES * Fix MintImport rows_count update and migration whitespace - Update MintImport#generate_rows_from_csv to update rows_count counter cache - Fix trailing whitespace and final newline in AddRowsCountToImports migration * Implement full-screen Drag and Drop CSV import on Transactions page - Add DragAndDropImport Stimulus controller listening on document - Add full-screen overlay with icon and text to Transactions index - Update ImportsController to handle direct file uploads via create action - Add system test for drag and drop functionality * Implement Drag and Drop CSV upload on Import Upload page - Add drag-and-drop-import controller to import/uploads/show - Add full-screen overlay to import/uploads/show - Annotate upload form and input with drag-and-drop targets - Add PR_SUMMARY.md * removing pr summary * Add file validation to ImportsController - Validate file size (max 10MB) and MIME type in create action - Prevent memory exhaustion and invalid file processing - Defined MAX_CSV_SIZE and ALLOWED_MIME_TYPES in Import model * Refactor dragLeave logic with counter pattern to prevent flickering * Extract shared drag-and-drop overlay partial - Create app/views/imports/_drag_drop_overlay.html.erb - Update transactions/index and import/uploads/show to use the partial - Reduce code duplication in views * Update Brakeman and harden ImportsController security - Update brakeman to 7.1.2 - Explicitly handle type assignment in ImportsController#create to avoid mass assignment - Remove :type from permitted import parameters * Fix trailing whitespace in DragAndDropImportTest * Don't commit LLM comments as file * FIX add api validation --------- Co-authored-by: Carlos Adames <cj@Carloss-MacBook-Air.local> Co-authored-by: Juan José Mata <jjmata@jjmata.com> Co-authored-by: sokie <sokysrm@gmail.com>
304 lines
7.9 KiB
Ruby
304 lines
7.9 KiB
Ruby
class Import < ApplicationRecord
|
|
MaxRowCountExceededError = Class.new(StandardError)
|
|
MappingError = Class.new(StandardError)
|
|
|
|
MAX_CSV_SIZE = 10.megabytes
|
|
ALLOWED_MIME_TYPES = %w[text/csv text/plain application/vnd.ms-excel application/csv].freeze
|
|
|
|
TYPES = %w[TransactionImport TradeImport AccountImport MintImport CategoryImport RuleImport].freeze
|
|
SIGNAGE_CONVENTIONS = %w[inflows_positive inflows_negative]
|
|
SEPARATORS = [ [ "Comma (,)", "," ], [ "Semicolon (;)", ";" ] ].freeze
|
|
|
|
NUMBER_FORMATS = {
|
|
"1,234.56" => { separator: ".", delimiter: "," }, # US/UK/Asia
|
|
"1.234,56" => { separator: ",", delimiter: "." }, # Most of Europe
|
|
"1 234,56" => { separator: ",", delimiter: " " }, # French/Scandinavian
|
|
"1,234" => { separator: "", delimiter: "," } # Zero-decimal currencies like JPY
|
|
}.freeze
|
|
|
|
AMOUNT_TYPE_STRATEGIES = %w[signed_amount custom_column].freeze
|
|
|
|
belongs_to :family
|
|
belongs_to :account, optional: true
|
|
|
|
before_validation :set_default_number_format
|
|
|
|
scope :ordered, -> { order(created_at: :desc) }
|
|
|
|
enum :status, {
|
|
pending: "pending",
|
|
complete: "complete",
|
|
importing: "importing",
|
|
reverting: "reverting",
|
|
revert_failed: "revert_failed",
|
|
failed: "failed"
|
|
}, validate: true, default: "pending"
|
|
|
|
validates :type, inclusion: { in: TYPES }
|
|
validates :amount_type_strategy, inclusion: { in: AMOUNT_TYPE_STRATEGIES }
|
|
validates :col_sep, inclusion: { in: SEPARATORS.map(&:last) }
|
|
validates :signage_convention, inclusion: { in: SIGNAGE_CONVENTIONS }, allow_nil: true
|
|
validates :number_format, presence: true, inclusion: { in: NUMBER_FORMATS.keys }
|
|
validate :account_belongs_to_family
|
|
|
|
has_many :rows, dependent: :destroy
|
|
has_many :mappings, dependent: :destroy
|
|
has_many :accounts, dependent: :destroy
|
|
has_many :entries, dependent: :destroy
|
|
|
|
class << self
|
|
def parse_csv_str(csv_str, col_sep: ",")
|
|
CSV.parse(
|
|
(csv_str || "").strip,
|
|
headers: true,
|
|
col_sep: col_sep,
|
|
converters: [ ->(str) { str&.strip } ],
|
|
liberal_parsing: true
|
|
)
|
|
end
|
|
end
|
|
|
|
def publish_later
|
|
raise MaxRowCountExceededError if row_count_exceeded?
|
|
raise "Import is not publishable" unless publishable?
|
|
|
|
update! status: :importing
|
|
|
|
ImportJob.perform_later(self)
|
|
end
|
|
|
|
def publish
|
|
raise MaxRowCountExceededError if row_count_exceeded?
|
|
|
|
import!
|
|
|
|
family.sync_later
|
|
|
|
update! status: :complete
|
|
rescue => error
|
|
update! status: :failed, error: error.message
|
|
end
|
|
|
|
def revert_later
|
|
raise "Import is not revertable" unless revertable?
|
|
|
|
update! status: :reverting
|
|
|
|
RevertImportJob.perform_later(self)
|
|
end
|
|
|
|
def revert
|
|
Import.transaction do
|
|
accounts.destroy_all
|
|
entries.destroy_all
|
|
end
|
|
|
|
family.sync_later
|
|
|
|
update! status: :pending
|
|
rescue => error
|
|
update! status: :revert_failed, error: error.message
|
|
end
|
|
|
|
def csv_rows
|
|
@csv_rows ||= parsed_csv
|
|
end
|
|
|
|
def csv_headers
|
|
parsed_csv.headers
|
|
end
|
|
|
|
def csv_sample
|
|
@csv_sample ||= parsed_csv.first(2)
|
|
end
|
|
|
|
def dry_run
|
|
mappings = {
|
|
transactions: rows_count,
|
|
categories: Import::CategoryMapping.for_import(self).creational.count,
|
|
tags: Import::TagMapping.for_import(self).creational.count
|
|
}
|
|
|
|
mappings.merge(
|
|
accounts: Import::AccountMapping.for_import(self).creational.count,
|
|
) if account.nil?
|
|
|
|
mappings
|
|
end
|
|
|
|
def required_column_keys
|
|
[]
|
|
end
|
|
|
|
def column_keys
|
|
raise NotImplementedError, "Subclass must implement column_keys"
|
|
end
|
|
|
|
def generate_rows_from_csv
|
|
rows.destroy_all
|
|
|
|
mapped_rows = csv_rows.map do |row|
|
|
{
|
|
account: row[account_col_label].to_s,
|
|
date: row[date_col_label].to_s,
|
|
qty: sanitize_number(row[qty_col_label]).to_s,
|
|
ticker: row[ticker_col_label].to_s,
|
|
exchange_operating_mic: row[exchange_operating_mic_col_label].to_s,
|
|
price: sanitize_number(row[price_col_label]).to_s,
|
|
amount: sanitize_number(row[amount_col_label]).to_s,
|
|
currency: (row[currency_col_label] || default_currency).to_s,
|
|
name: (row[name_col_label] || default_row_name).to_s,
|
|
category: row[category_col_label].to_s,
|
|
tags: row[tags_col_label].to_s,
|
|
entity_type: row[entity_type_col_label].to_s,
|
|
notes: row[notes_col_label].to_s
|
|
}
|
|
end
|
|
|
|
rows.insert_all!(mapped_rows)
|
|
update_column(:rows_count, rows.count)
|
|
end
|
|
|
|
def sync_mappings
|
|
transaction do
|
|
mapping_steps.each do |mapping_class|
|
|
mappables_by_key = mapping_class.mappables_by_key(self)
|
|
|
|
updated_mappings = mappables_by_key.map do |key, mappable|
|
|
mapping = mappings.find_or_initialize_by(key: key, import: self, type: mapping_class.name)
|
|
mapping.mappable = mappable
|
|
mapping.create_when_empty = key.present? && mappable.nil?
|
|
mapping
|
|
end
|
|
|
|
updated_mappings.each { |m| m.save(validate: false) }
|
|
mapping_class.where.not(id: updated_mappings.map(&:id)).destroy_all
|
|
end
|
|
end
|
|
end
|
|
|
|
def mapping_steps
|
|
[]
|
|
end
|
|
|
|
def uploaded?
|
|
raw_file_str.present?
|
|
end
|
|
|
|
def configured?
|
|
uploaded? && rows_count > 0
|
|
end
|
|
|
|
def cleaned?
|
|
configured? && rows.all?(&:valid?)
|
|
end
|
|
|
|
def publishable?
|
|
cleaned? && mappings.all?(&:valid?)
|
|
end
|
|
|
|
def revertable?
|
|
complete? || revert_failed?
|
|
end
|
|
|
|
def has_unassigned_account?
|
|
mappings.accounts.where(key: "").any?
|
|
end
|
|
|
|
def requires_account?
|
|
family.accounts.empty? && has_unassigned_account?
|
|
end
|
|
|
|
# Used to optionally pre-fill the configuration for the current import
|
|
def suggested_template
|
|
family.imports
|
|
.complete
|
|
.where(account: account, type: type)
|
|
.order(created_at: :desc)
|
|
.first
|
|
end
|
|
|
|
def apply_template!(import_template)
|
|
update!(
|
|
import_template.attributes.slice(
|
|
"date_col_label", "amount_col_label", "name_col_label",
|
|
"category_col_label", "tags_col_label", "account_col_label",
|
|
"qty_col_label", "ticker_col_label", "price_col_label",
|
|
"entity_type_col_label", "notes_col_label", "currency_col_label",
|
|
"date_format", "signage_convention", "number_format",
|
|
"exchange_operating_mic_col_label"
|
|
)
|
|
)
|
|
end
|
|
|
|
def max_row_count
|
|
10000
|
|
end
|
|
|
|
private
|
|
def row_count_exceeded?
|
|
rows_count > max_row_count
|
|
end
|
|
|
|
def import!
|
|
# no-op, subclasses can implement for customization of algorithm
|
|
end
|
|
|
|
def default_row_name
|
|
"Imported item"
|
|
end
|
|
|
|
def default_currency
|
|
account&.currency || family.currency
|
|
end
|
|
|
|
def parsed_csv
|
|
@parsed_csv ||= self.class.parse_csv_str(raw_file_str, col_sep: col_sep)
|
|
end
|
|
|
|
def sanitize_number(value)
|
|
return "" if value.nil?
|
|
|
|
format = NUMBER_FORMATS[number_format]
|
|
return "" unless format
|
|
|
|
# First, normalize spaces and remove any characters that aren't numbers, delimiters, separators, or minus signs
|
|
sanitized = value.to_s.strip
|
|
|
|
# Handle French/Scandinavian format specially
|
|
if format[:delimiter] == " "
|
|
sanitized = sanitized.gsub(/\s+/, "") # Remove all spaces first
|
|
else
|
|
sanitized = sanitized.gsub(/[^\d#{Regexp.escape(format[:delimiter])}#{Regexp.escape(format[:separator])}\-]/, "")
|
|
|
|
# Replace delimiter with empty string
|
|
if format[:delimiter].present?
|
|
sanitized = sanitized.gsub(format[:delimiter], "")
|
|
end
|
|
end
|
|
|
|
# Replace separator with period for proper float parsing
|
|
if format[:separator].present?
|
|
sanitized = sanitized.gsub(format[:separator], ".")
|
|
end
|
|
|
|
# Return empty string if not a valid number
|
|
unless sanitized =~ /\A-?\d+\.?\d*\z/
|
|
return ""
|
|
end
|
|
|
|
sanitized
|
|
end
|
|
|
|
def set_default_number_format
|
|
self.number_format ||= "1,234.56" # Default to US/UK format
|
|
end
|
|
|
|
def account_belongs_to_family
|
|
return if account.nil?
|
|
return if account.family_id == family_id
|
|
|
|
errors.add(:account, "must belong to your family")
|
|
end
|
|
end
|