mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-08-02 20:15:22 +02:00
Transaction rules engine V1 (#1900)
* Domain model sketch
* Scaffold out rules domain
* Migrations
* Remove existing data enrichment for clean slate
* Sketch out business logic and basic tests
* Simplify rule scope building and action executions
* Get generator working again
* Basic implementation + tests
* Remove manual merchant management (rules will replace)
* Revert "Remove manual merchant management (rules will replace)"
This reverts commit 83dcbd9ff0.
* Family and Provider merchants model
* Fix brakeman warnings
* Fix notification loader
* Update notification position
* Add Rule action and condition registries
* Rule form with compound conditions and tests
* Split out notification types, add CTA type
* Rules form builder and Stimulus controller
* Clean up rule registry domain
* Clean up rules stimulus controller
* CTA message for rule when user changes transaction category
* Fix tests
* Lint updates
* Centralize notifications in Notifiable concern
* Implement category rule prompts with auto backoff and option to disable
* Fix layout bug caused by merge conflict
* Initialize rule with correct action for category CTA
* Add rule deletions, get rules working
* Complete dynamic rule form, split Stimulus controllers by resource
* Fix failing tests
* Change test password to avoid chromium conflicts
* Update integration tests
* Centralize all test password references
* Add re-apply rule action
* Rule confirm modal
* Run migrations
* Trigger rule notification after inline category updates
* Clean up rule styles
* Basic attribute locking for rules
* Apply attribute locks on user edits
* Log data enrichments, only apply rules to unlocked attributes
* Fix merge errors
* Additional merge conflict fixes
* Form UI improvements, ignore attribute locks on manual rule application
* Batch AI auto-categorization of transactions
* Auto merchant detection, ai enrichment in batches
* Fix Plaid merchant assignments
* Plaid category matching
* Cleanup 1
* Test cleanup
* Remove stale route
* Fix desktop chat UI issues
* Fix mobile nav styling issues
This commit is contained in:
Zach Gollwitzer
GitHub
parent
8edd7ecef0
commit
297a695d0f
152 changed files with 4502 additions and 612 deletions
42
test/models/family/auto_categorizer_test.rb
Normal file
42
test/models/family/auto_categorizer_test.rb
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
require "test_helper"
|
||||
|
||||
class Family::AutoCategorizerTest < ActiveSupport::TestCase
|
||||
include EntriesTestHelper, ProviderTestHelper
|
||||
|
||||
setup do
|
||||
@family = families(:dylan_family)
|
||||
@account = @family.accounts.create!(name: "Rule test", balance: 100, currency: "USD", accountable: Depository.new)
|
||||
@llm_provider = mock
|
||||
Provider::Registry.stubs(:get_provider).with(:openai).returns(@llm_provider)
|
||||
end
|
||||
|
||||
test "auto-categorizes transactions" do
|
||||
txn1 = create_transaction(account: @account, name: "McDonalds").transaction
|
||||
txn2 = create_transaction(account: @account, name: "Amazon purchase").transaction
|
||||
txn3 = create_transaction(account: @account, name: "Netflix subscription").transaction
|
||||
|
||||
test_category = @family.categories.create!(name: "Test category")
|
||||
|
||||
provider_response = provider_success_response([
|
||||
AutoCategorization.new(transaction_id: txn1.id, category_name: test_category.name),
|
||||
AutoCategorization.new(transaction_id: txn2.id, category_name: test_category.name),
|
||||
AutoCategorization.new(transaction_id: txn3.id, category_name: nil)
|
||||
])
|
||||
|
||||
@llm_provider.expects(:auto_categorize).returns(provider_response).once
|
||||
|
||||
assert_difference "DataEnrichment.count", 2 do
|
||||
Family::AutoCategorizer.new(@family, transaction_ids: [ txn1.id, txn2.id, txn3.id ]).auto_categorize
|
||||
end
|
||||
|
||||
assert_equal test_category, txn1.reload.category
|
||||
assert_equal test_category, txn2.reload.category
|
||||
assert_nil txn3.reload.category
|
||||
|
||||
# After auto-categorization, all transactions are locked and no longer enrichable
|
||||
assert_equal 0, @account.transactions.reload.enrichable(:category_id).count
|
||||
end
|
||||
|
||||
private
|
||||
AutoCategorization = Provider::LlmConcept::AutoCategorization
|
||||
end
|
||||
42
test/models/family/auto_merchant_detector_test.rb
Normal file
42
test/models/family/auto_merchant_detector_test.rb
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
require "test_helper"
|
||||
|
||||
class Family::AutoMerchantDetectorTest < ActiveSupport::TestCase
|
||||
include EntriesTestHelper, ProviderTestHelper
|
||||
|
||||
setup do
|
||||
@family = families(:dylan_family)
|
||||
@account = @family.accounts.create!(name: "Rule test", balance: 100, currency: "USD", accountable: Depository.new)
|
||||
@llm_provider = mock
|
||||
Provider::Registry.stubs(:get_provider).with(:openai).returns(@llm_provider)
|
||||
end
|
||||
|
||||
test "auto detects transaction merchants" do
|
||||
txn1 = create_transaction(account: @account, name: "McDonalds").transaction
|
||||
txn2 = create_transaction(account: @account, name: "Chipotle").transaction
|
||||
txn3 = create_transaction(account: @account, name: "generic").transaction
|
||||
|
||||
provider_response = provider_success_response([
|
||||
AutoDetectedMerchant.new(transaction_id: txn1.id, business_name: "McDonalds", business_url: "mcdonalds.com"),
|
||||
AutoDetectedMerchant.new(transaction_id: txn2.id, business_name: "Chipotle", business_url: "chipotle.com"),
|
||||
AutoDetectedMerchant.new(transaction_id: txn3.id, business_name: nil, business_url: nil)
|
||||
])
|
||||
|
||||
@llm_provider.expects(:auto_detect_merchants).returns(provider_response).once
|
||||
|
||||
assert_difference "DataEnrichment.count", 2 do
|
||||
Family::AutoMerchantDetector.new(@family, transaction_ids: [ txn1.id, txn2.id, txn3.id ]).auto_detect
|
||||
end
|
||||
|
||||
assert_equal "McDonalds", txn1.reload.merchant.name
|
||||
assert_equal "Chipotle", txn2.reload.merchant.name
|
||||
assert_equal "https://logo.synthfinance.com/mcdonalds.com", txn1.reload.merchant.logo_url
|
||||
assert_equal "https://logo.synthfinance.com/chipotle.com", txn2.reload.merchant.logo_url
|
||||
assert_nil txn3.reload.merchant
|
||||
|
||||
# After auto-detection, all transactions are locked and no longer enrichable
|
||||
assert_equal 0, @account.transactions.reload.enrichable(:merchant_id).count
|
||||
end
|
||||
|
||||
private
|
||||
AutoDetectedMerchant = Provider::LlmConcept::AutoDetectedMerchant
|
||||
end
|
||||
|
|
@ -17,6 +17,103 @@ class Provider::OpenaiTest < ActiveSupport::TestCase
|
|||
end
|
||||
end
|
||||
|
||||
test "auto categorizes transactions by various attributes" do
|
||||
VCR.use_cassette("openai/auto_categorize") do
|
||||
input_transactions = [
|
||||
{ id: "1", name: "McDonalds", amount: 20, classification: "expense", merchant: "McDonalds", hint: "Fast Food" },
|
||||
{ id: "2", name: "Amazon purchase", amount: 100, classification: "expense", merchant: "Amazon" },
|
||||
{ id: "3", name: "Netflix subscription", amount: 10, classification: "expense", merchant: "Netflix", hint: "Subscriptions" },
|
||||
{ id: "4", name: "paycheck", amount: 3000, classification: "income" },
|
||||
{ id: "5", name: "Italian dinner with friends", amount: 100, classification: "expense" },
|
||||
{ id: "6", name: "1212XXXBCaaa charge", amount: 2.99, classification: "expense" }
|
||||
]
|
||||
|
||||
response = @subject.auto_categorize(
|
||||
transactions: input_transactions,
|
||||
user_categories: [
|
||||
{ id: "shopping_id", name: "Shopping", is_subcategory: false, parent_id: nil, classification: "expense" },
|
||||
{ id: "subscriptions_id", name: "Subscriptions", is_subcategory: true, parent_id: nil, classification: "expense" },
|
||||
{ id: "restaurants_id", name: "Restaurants", is_subcategory: false, parent_id: nil, classification: "expense" },
|
||||
{ id: "fast_food_id", name: "Fast Food", is_subcategory: true, parent_id: "restaurants_id", classification: "expense" },
|
||||
{ id: "income_id", name: "Income", is_subcategory: false, parent_id: nil, classification: "income" }
|
||||
]
|
||||
)
|
||||
|
||||
assert response.success?
|
||||
assert_equal input_transactions.size, response.data.size
|
||||
|
||||
txn1 = response.data.find { |c| c.transaction_id == "1" }
|
||||
txn2 = response.data.find { |c| c.transaction_id == "2" }
|
||||
txn3 = response.data.find { |c| c.transaction_id == "3" }
|
||||
txn4 = response.data.find { |c| c.transaction_id == "4" }
|
||||
txn5 = response.data.find { |c| c.transaction_id == "5" }
|
||||
txn6 = response.data.find { |c| c.transaction_id == "6" }
|
||||
|
||||
assert_equal "Fast Food", txn1.category_name
|
||||
assert_equal "Shopping", txn2.category_name
|
||||
assert_equal "Subscriptions", txn3.category_name
|
||||
assert_equal "Income", txn4.category_name
|
||||
assert_equal "Restaurants", txn5.category_name
|
||||
assert_nil txn6.category_name
|
||||
end
|
||||
end
|
||||
|
||||
test "auto detects merchants" do
|
||||
VCR.use_cassette("openai/auto_detect_merchants") do
|
||||
input_transactions = [
|
||||
{ id: "1", name: "McDonalds", amount: 20, classification: "expense" },
|
||||
{ id: "2", name: "local pub", amount: 20, classification: "expense" },
|
||||
{ id: "3", name: "WMT purchases", amount: 20, classification: "expense" },
|
||||
{ id: "4", name: "amzn 123 abc", amount: 20, classification: "expense" },
|
||||
{ id: "5", name: "chaseX1231", amount: 2000, classification: "income" },
|
||||
{ id: "6", name: "check deposit 022", amount: 200, classification: "income" },
|
||||
{ id: "7", name: "shooters bar and grill", amount: 200, classification: "expense" },
|
||||
{ id: "8", name: "Microsoft Office subscription", amount: 200, classification: "expense" }
|
||||
]
|
||||
|
||||
response = @subject.auto_detect_merchants(
|
||||
transactions: input_transactions,
|
||||
user_merchants: [ { name: "Shooters" } ]
|
||||
)
|
||||
|
||||
assert response.success?
|
||||
assert_equal input_transactions.size, response.data.size
|
||||
|
||||
txn1 = response.data.find { |c| c.transaction_id == "1" }
|
||||
txn2 = response.data.find { |c| c.transaction_id == "2" }
|
||||
txn3 = response.data.find { |c| c.transaction_id == "3" }
|
||||
txn4 = response.data.find { |c| c.transaction_id == "4" }
|
||||
txn5 = response.data.find { |c| c.transaction_id == "5" }
|
||||
txn6 = response.data.find { |c| c.transaction_id == "6" }
|
||||
txn7 = response.data.find { |c| c.transaction_id == "7" }
|
||||
txn8 = response.data.find { |c| c.transaction_id == "8" }
|
||||
|
||||
assert_equal "McDonald's", txn1.business_name
|
||||
assert_equal "mcdonalds.com", txn1.business_url
|
||||
|
||||
assert_nil txn2.business_name
|
||||
assert_nil txn2.business_url
|
||||
|
||||
assert_equal "Walmart", txn3.business_name
|
||||
assert_equal "walmart.com", txn3.business_url
|
||||
|
||||
assert_equal "Amazon", txn4.business_name
|
||||
assert_equal "amazon.com", txn4.business_url
|
||||
|
||||
assert_nil txn5.business_name
|
||||
assert_nil txn5.business_url
|
||||
|
||||
assert_nil txn6.business_name
|
||||
assert_nil txn6.business_url
|
||||
|
||||
assert_equal "Shooters", txn7.business_name
|
||||
assert_nil txn7.business_url
|
||||
|
||||
assert_equal "Microsoft", txn8.business_name
|
||||
assert_equal "microsoft.com", txn8.business_url
|
||||
end
|
||||
end
|
||||
|
||||
test "basic chat response" do
|
||||
VCR.use_cassette("openai/chat/basic_response") do
|
||||
response = @subject.chat_response(
|
||||
|
|
|
|||
136
test/models/provider/plaid/category_alias_matcher_test.rb
Normal file
136
test/models/provider/plaid/category_alias_matcher_test.rb
Normal file
|
|
@ -0,0 +1,136 @@
|
|||
require "test_helper"
|
||||
|
||||
class Provider::Plaid::CategoryAliasMatcherTest < ActiveSupport::TestCase
|
||||
setup do
|
||||
@family = families(:empty)
|
||||
|
||||
# User income categories
|
||||
@income = @family.categories.create!(name: "Income", classification: "income")
|
||||
@dividend_income = @family.categories.create!(name: "Dividend Income", parent: @income, classification: "income")
|
||||
@interest_income = @family.categories.create!(name: "Interest Income", parent: @income, classification: "income")
|
||||
|
||||
# User expense categories
|
||||
@loan_payments = @family.categories.create!(name: "Loan Payments")
|
||||
@fees = @family.categories.create!(name: "Fees")
|
||||
@entertainment = @family.categories.create!(name: "Entertainment")
|
||||
|
||||
@food_and_drink = @family.categories.create!(name: "Food & Drink")
|
||||
@groceries = @family.categories.create!(name: "Groceries", parent: @food_and_drink)
|
||||
@restaurant = @family.categories.create!(name: "Restaurant", parent: @food_and_drink)
|
||||
|
||||
@shopping = @family.categories.create!(name: "Shopping")
|
||||
@clothing = @family.categories.create!(name: "Clothing", parent: @shopping)
|
||||
|
||||
@home = @family.categories.create!(name: "Home")
|
||||
@medical = @family.categories.create!(name: "Medical")
|
||||
@personal_care = @family.categories.create!(name: "Personal Care")
|
||||
@transportation = @family.categories.create!(name: "Transportation")
|
||||
@trips = @family.categories.create!(name: "Trips")
|
||||
|
||||
@services = @family.categories.create!(name: "Services")
|
||||
@car = @family.categories.create!(name: "Car", parent: @services)
|
||||
|
||||
@giving = @family.categories.create!(name: "Giving")
|
||||
|
||||
@matcher = Provider::Plaid::CategoryAliasMatcher.new(@family.categories)
|
||||
end
|
||||
|
||||
test "matches expense categories" do
|
||||
assert_equal @loan_payments, @matcher.match("loan_payments_car_payment")
|
||||
assert_equal @loan_payments, @matcher.match("loan_payments_credit_card_payment")
|
||||
assert_equal @loan_payments, @matcher.match("loan_payments_personal_loan_payment")
|
||||
assert_equal @loan_payments, @matcher.match("loan_payments_mortgage_payment")
|
||||
assert_equal @loan_payments, @matcher.match("loan_payments_student_loan_payment")
|
||||
assert_equal @loan_payments, @matcher.match("loan_payments_other_payment")
|
||||
assert_equal @fees, @matcher.match("bank_fees_atm_fees")
|
||||
assert_equal @fees, @matcher.match("bank_fees_foreign_transaction_fees")
|
||||
assert_equal @fees, @matcher.match("bank_fees_insufficient_funds")
|
||||
assert_equal @fees, @matcher.match("bank_fees_interest_charge")
|
||||
assert_equal @fees, @matcher.match("bank_fees_overdraft_fees")
|
||||
assert_equal @fees, @matcher.match("bank_fees_other_bank_fees")
|
||||
assert_equal @entertainment, @matcher.match("entertainment_casinos_and_gambling")
|
||||
assert_equal @entertainment, @matcher.match("entertainment_music_and_audio")
|
||||
assert_equal @entertainment, @matcher.match("entertainment_sporting_events_amusement_parks_and_museums")
|
||||
assert_equal @entertainment, @matcher.match("entertainment_tv_and_movies")
|
||||
assert_equal @entertainment, @matcher.match("entertainment_video_games")
|
||||
assert_equal @entertainment, @matcher.match("entertainment_other_entertainment")
|
||||
assert_equal @food_and_drink, @matcher.match("food_and_drink_beer_wine_and_liquor")
|
||||
assert_equal @food_and_drink, @matcher.match("food_and_drink_coffee")
|
||||
assert_equal @food_and_drink, @matcher.match("food_and_drink_fast_food")
|
||||
assert_equal @groceries, @matcher.match("food_and_drink_groceries")
|
||||
assert_equal @restaurant, @matcher.match("food_and_drink_restaurant")
|
||||
assert_equal @food_and_drink, @matcher.match("food_and_drink_vending_machines")
|
||||
assert_equal @food_and_drink, @matcher.match("food_and_drink_other_food_and_drink")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_bookstores_and_newsstands")
|
||||
assert_equal @clothing, @matcher.match("general_merchandise_clothing_and_accessories")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_convenience_stores")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_department_stores")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_discount_stores")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_electronics")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_gifts_and_novelties")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_office_supplies")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_online_marketplaces")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_pet_supplies")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_sporting_goods")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_superstores")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_tobacco_and_vape")
|
||||
assert_equal @shopping, @matcher.match("general_merchandise_other_general_merchandise")
|
||||
assert_equal @home, @matcher.match("home_improvement_furniture")
|
||||
assert_equal @home, @matcher.match("home_improvement_hardware")
|
||||
assert_equal @home, @matcher.match("home_improvement_repair_and_maintenance")
|
||||
assert_equal @home, @matcher.match("home_improvement_security")
|
||||
assert_equal @home, @matcher.match("home_improvement_other_home_improvement")
|
||||
assert_equal @medical, @matcher.match("medical_dental_care")
|
||||
assert_equal @medical, @matcher.match("medical_eye_care")
|
||||
assert_equal @medical, @matcher.match("medical_nursing_care")
|
||||
assert_equal @medical, @matcher.match("medical_pharmacies_and_supplements")
|
||||
assert_equal @medical, @matcher.match("medical_primary_care")
|
||||
assert_equal @medical, @matcher.match("medical_veterinary_services")
|
||||
assert_equal @medical, @matcher.match("medical_other_medical")
|
||||
assert_equal @personal_care, @matcher.match("personal_care_gyms_and_fitness_centers")
|
||||
assert_equal @personal_care, @matcher.match("personal_care_hair_and_beauty")
|
||||
assert_equal @personal_care, @matcher.match("personal_care_laundry_and_dry_cleaning")
|
||||
assert_equal @personal_care, @matcher.match("personal_care_other_personal_care")
|
||||
assert_equal @services, @matcher.match("general_services_accounting_and_financial_planning")
|
||||
assert_equal @car, @matcher.match("general_services_automotive")
|
||||
assert_equal @services, @matcher.match("general_services_childcare")
|
||||
assert_equal @services, @matcher.match("general_services_consulting_and_legal")
|
||||
assert_equal @services, @matcher.match("general_services_education")
|
||||
assert_equal @services, @matcher.match("general_services_insurance")
|
||||
assert_equal @services, @matcher.match("general_services_postage_and_shipping")
|
||||
assert_equal @services, @matcher.match("general_services_storage")
|
||||
assert_equal @services, @matcher.match("general_services_other_general_services")
|
||||
assert_equal @giving, @matcher.match("government_and_non_profit_donations")
|
||||
assert_nil @matcher.match("government_and_non_profit_government_departments_and_agencies")
|
||||
assert_nil @matcher.match("government_and_non_profit_tax_payment")
|
||||
assert_nil @matcher.match("government_and_non_profit_other_government_and_non_profit")
|
||||
assert_equal @transportation, @matcher.match("transportation_bikes_and_scooters")
|
||||
assert_equal @transportation, @matcher.match("transportation_gas")
|
||||
assert_equal @transportation, @matcher.match("transportation_parking")
|
||||
assert_equal @transportation, @matcher.match("transportation_public_transit")
|
||||
assert_equal @transportation, @matcher.match("transportation_taxis_and_ride_shares")
|
||||
assert_equal @transportation, @matcher.match("transportation_tolls")
|
||||
assert_equal @transportation, @matcher.match("transportation_other_transportation")
|
||||
assert_equal @trips, @matcher.match("travel_flights")
|
||||
assert_equal @trips, @matcher.match("travel_lodging")
|
||||
assert_equal @trips, @matcher.match("travel_rental_cars")
|
||||
assert_equal @trips, @matcher.match("travel_other_travel")
|
||||
assert_equal @home, @matcher.match("rent_and_utilities_gas_and_electricity")
|
||||
assert_equal @home, @matcher.match("rent_and_utilities_internet_and_cable")
|
||||
assert_equal @home, @matcher.match("rent_and_utilities_rent")
|
||||
assert_equal @home, @matcher.match("rent_and_utilities_sewage_and_waste_management")
|
||||
assert_equal @home, @matcher.match("rent_and_utilities_telephone")
|
||||
assert_equal @home, @matcher.match("rent_and_utilities_water")
|
||||
assert_equal @home, @matcher.match("rent_and_utilities_other_utilities")
|
||||
end
|
||||
|
||||
test "matches income categories" do
|
||||
assert_equal @dividend_income, @matcher.match("income_dividends")
|
||||
assert_equal @interest_income, @matcher.match("income_interest_earned")
|
||||
assert_equal @income, @matcher.match("income_tax_refund")
|
||||
assert_equal @income, @matcher.match("income_retirement_pension")
|
||||
assert_equal @income, @matcher.match("income_unemployment")
|
||||
assert_equal @income, @matcher.match("income_wages")
|
||||
assert_equal @income, @matcher.match("income_other_income")
|
||||
end
|
||||
end
|
||||
|
|
@ -23,21 +23,4 @@ class Provider::SynthTest < ActiveSupport::TestCase
|
|||
assert usage.plan.present?
|
||||
end
|
||||
end
|
||||
|
||||
test "enriches transaction" do
|
||||
VCR.use_cassette("synth/transaction_enrich") do
|
||||
response = @synth.enrich_transaction(
|
||||
"UBER EATS",
|
||||
amount: 25.50,
|
||||
date: Date.iso8601("2025-03-16"),
|
||||
city: "San Francisco",
|
||||
state: "CA",
|
||||
country: "US"
|
||||
)
|
||||
|
||||
data = response.data
|
||||
assert data.name.present?
|
||||
assert data.category.present?
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
|
|||
61
test/models/rule/action_test.rb
Normal file
61
test/models/rule/action_test.rb
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
require "test_helper"
|
||||
|
||||
class Rule::ActionTest < ActiveSupport::TestCase
|
||||
include EntriesTestHelper
|
||||
|
||||
setup do
|
||||
@family = families(:dylan_family)
|
||||
@transaction_rule = rules(:one)
|
||||
@account = @family.accounts.create!(name: "Rule test", balance: 1000, currency: "USD", accountable: Depository.new)
|
||||
|
||||
@grocery_category = @family.categories.create!(name: "Grocery")
|
||||
@whole_foods_merchant = @family.merchants.create!(name: "Whole Foods", type: "FamilyMerchant")
|
||||
|
||||
# Some sample transactions to work with
|
||||
@txn1 = create_transaction(date: Date.current, account: @account, amount: 100, name: "Rule test transaction1", merchant: @whole_foods_merchant).transaction
|
||||
@txn2 = create_transaction(date: Date.current, account: @account, amount: -200, name: "Rule test transaction2").transaction
|
||||
@txn3 = create_transaction(date: 1.day.ago.to_date, account: @account, amount: 50, name: "Rule test transaction3").transaction
|
||||
|
||||
@rule_scope = @account.transactions
|
||||
end
|
||||
|
||||
test "set_transaction_category" do
|
||||
# Does not modify transactions that are locked (user edited them)
|
||||
@txn1.lock!(:category_id)
|
||||
|
||||
action = Rule::Action.new(
|
||||
rule: @transaction_rule,
|
||||
action_type: "set_transaction_category",
|
||||
value: @grocery_category.id
|
||||
)
|
||||
|
||||
action.apply(@rule_scope)
|
||||
|
||||
assert_nil @txn1.reload.category
|
||||
|
||||
[ @txn2, @txn3 ].each do |transaction|
|
||||
assert_equal @grocery_category.id, transaction.reload.category_id
|
||||
end
|
||||
end
|
||||
|
||||
test "set_transaction_tags" do
|
||||
tag = @family.tags.create!(name: "Rule test tag")
|
||||
|
||||
# Does not modify transactions that are locked (user edited them)
|
||||
@txn1.lock!(:tag_ids)
|
||||
|
||||
action = Rule::Action.new(
|
||||
rule: @transaction_rule,
|
||||
action_type: "set_transaction_tags",
|
||||
value: tag.id
|
||||
)
|
||||
|
||||
action.apply(@rule_scope)
|
||||
|
||||
assert_equal [], @txn1.reload.tags
|
||||
|
||||
[ @txn2, @txn3 ].each do |transaction|
|
||||
assert_equal [ tag ], transaction.reload.tags
|
||||
end
|
||||
end
|
||||
end
|
||||
128
test/models/rule/condition_test.rb
Normal file
128
test/models/rule/condition_test.rb
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
require "test_helper"
|
||||
|
||||
class Rule::ConditionTest < ActiveSupport::TestCase
|
||||
include EntriesTestHelper
|
||||
|
||||
setup do
|
||||
@family = families(:empty)
|
||||
@transaction_rule = rules(:one)
|
||||
@account = @family.accounts.create!(name: "Rule test", balance: 1000, currency: "USD", accountable: Depository.new)
|
||||
|
||||
@grocery_category = @family.categories.create!(name: "Grocery")
|
||||
@whole_foods_merchant = @family.merchants.create!(name: "Whole Foods", type: "FamilyMerchant")
|
||||
|
||||
# Some sample transactions to work with
|
||||
create_transaction(date: Date.current, account: @account, amount: 100, name: "Rule test transaction1", merchant: @whole_foods_merchant)
|
||||
create_transaction(date: Date.current, account: @account, amount: -200, name: "Rule test transaction2")
|
||||
create_transaction(date: 1.day.ago.to_date, account: @account, amount: 50, name: "Rule test transaction3")
|
||||
create_transaction(date: 1.year.ago.to_date, account: @account, amount: 10, name: "Rule test transaction4", merchant: @whole_foods_merchant)
|
||||
create_transaction(date: 1.year.ago.to_date, account: @account, amount: 1000, name: "Rule test transaction5")
|
||||
|
||||
@rule_scope = @account.transactions
|
||||
end
|
||||
|
||||
test "applies transaction_name condition" do
|
||||
scope = @rule_scope
|
||||
|
||||
condition = Rule::Condition.new(
|
||||
rule: @transaction_rule,
|
||||
condition_type: "transaction_name",
|
||||
operator: "=",
|
||||
value: "Rule test transaction1"
|
||||
)
|
||||
|
||||
scope = condition.prepare(scope)
|
||||
|
||||
assert_equal 5, scope.count
|
||||
|
||||
filtered = condition.apply(scope)
|
||||
|
||||
assert_equal 1, filtered.count
|
||||
end
|
||||
|
||||
test "applies transaction_amount condition using absolute values" do
|
||||
scope = @rule_scope
|
||||
|
||||
condition = Rule::Condition.new(
|
||||
rule: @transaction_rule,
|
||||
condition_type: "transaction_amount",
|
||||
operator: ">",
|
||||
value: "50"
|
||||
)
|
||||
|
||||
scope = condition.prepare(scope)
|
||||
|
||||
filtered = condition.apply(scope)
|
||||
assert_equal 3, filtered.count
|
||||
end
|
||||
|
||||
test "applies transaction_merchant condition" do
|
||||
scope = @rule_scope
|
||||
|
||||
condition = Rule::Condition.new(
|
||||
rule: @transaction_rule,
|
||||
condition_type: "transaction_merchant",
|
||||
operator: "=",
|
||||
value: @whole_foods_merchant.id
|
||||
)
|
||||
|
||||
scope = condition.prepare(scope)
|
||||
|
||||
filtered = condition.apply(scope)
|
||||
assert_equal 2, filtered.count
|
||||
end
|
||||
|
||||
test "applies compound and condition" do
|
||||
scope = @rule_scope
|
||||
|
||||
parent_condition = Rule::Condition.new(
|
||||
rule: @transaction_rule,
|
||||
condition_type: "compound",
|
||||
operator: "and",
|
||||
sub_conditions: [
|
||||
Rule::Condition.new(
|
||||
condition_type: "transaction_merchant",
|
||||
operator: "=",
|
||||
value: @whole_foods_merchant.id
|
||||
),
|
||||
Rule::Condition.new(
|
||||
condition_type: "transaction_amount",
|
||||
operator: "<",
|
||||
value: "50"
|
||||
)
|
||||
]
|
||||
)
|
||||
|
||||
scope = parent_condition.prepare(scope)
|
||||
|
||||
filtered = parent_condition.apply(scope)
|
||||
assert_equal 1, filtered.count
|
||||
end
|
||||
|
||||
test "applies compound or condition" do
|
||||
scope = @rule_scope
|
||||
|
||||
parent_condition = Rule::Condition.new(
|
||||
rule: @transaction_rule,
|
||||
condition_type: "compound",
|
||||
operator: "or",
|
||||
sub_conditions: [
|
||||
Rule::Condition.new(
|
||||
condition_type: "transaction_merchant",
|
||||
operator: "=",
|
||||
value: @whole_foods_merchant.id
|
||||
),
|
||||
Rule::Condition.new(
|
||||
condition_type: "transaction_amount",
|
||||
operator: "<",
|
||||
value: "50"
|
||||
)
|
||||
]
|
||||
)
|
||||
|
||||
scope = parent_condition.prepare(scope)
|
||||
|
||||
filtered = parent_condition.apply(scope)
|
||||
assert_equal 2, filtered.count
|
||||
end
|
||||
end
|
||||
77
test/models/rule_test.rb
Normal file
77
test/models/rule_test.rb
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
require "test_helper"
|
||||
|
||||
class RuleTest < ActiveSupport::TestCase
|
||||
include EntriesTestHelper
|
||||
|
||||
setup do
|
||||
@family = families(:empty)
|
||||
@account = @family.accounts.create!(name: "Rule test", balance: 1000, currency: "USD", accountable: Depository.new)
|
||||
@whole_foods_merchant = @family.merchants.create!(name: "Whole Foods", type: "FamilyMerchant")
|
||||
@groceries_category = @family.categories.create!(name: "Groceries")
|
||||
end
|
||||
|
||||
test "basic rule" do
|
||||
transaction_entry = create_transaction(date: Date.current, account: @account, merchant: @whole_foods_merchant)
|
||||
|
||||
rule = Rule.create!(
|
||||
family: @family,
|
||||
resource_type: "transaction",
|
||||
effective_date: 1.day.ago.to_date,
|
||||
conditions: [ Rule::Condition.new(condition_type: "transaction_merchant", operator: "=", value: @whole_foods_merchant.id) ],
|
||||
actions: [ Rule::Action.new(action_type: "set_transaction_category", value: @groceries_category.id) ]
|
||||
)
|
||||
|
||||
rule.apply
|
||||
|
||||
transaction_entry.reload
|
||||
|
||||
assert_equal @groceries_category, transaction_entry.transaction.category
|
||||
end
|
||||
|
||||
test "compound rule" do
|
||||
transaction_entry1 = create_transaction(date: Date.current, amount: 50, account: @account, merchant: @whole_foods_merchant)
|
||||
transaction_entry2 = create_transaction(date: Date.current, amount: 100, account: @account, merchant: @whole_foods_merchant)
|
||||
|
||||
# Assign "Groceries" to transactions with a merchant of "Whole Foods" and an amount greater than $60
|
||||
rule = Rule.create!(
|
||||
family: @family,
|
||||
resource_type: "transaction",
|
||||
effective_date: 1.day.ago.to_date,
|
||||
conditions: [
|
||||
Rule::Condition.new(condition_type: "compound", operator: "and", sub_conditions: [
|
||||
Rule::Condition.new(condition_type: "transaction_merchant", operator: "=", value: @whole_foods_merchant.id),
|
||||
Rule::Condition.new(condition_type: "transaction_amount", operator: ">", value: 60)
|
||||
])
|
||||
],
|
||||
actions: [ Rule::Action.new(action_type: "set_transaction_category", value: @groceries_category.id) ]
|
||||
)
|
||||
|
||||
rule.apply
|
||||
|
||||
transaction_entry1.reload
|
||||
transaction_entry2.reload
|
||||
|
||||
assert_nil transaction_entry1.transaction.category
|
||||
assert_equal @groceries_category, transaction_entry2.transaction.category
|
||||
end
|
||||
|
||||
# Artificial limitation put in place to prevent users from creating overly complex rules
|
||||
# Rules should be shallow and wide
|
||||
test "no nested compound conditions" do
|
||||
rule = Rule.new(
|
||||
family: @family,
|
||||
resource_type: "transaction",
|
||||
actions: [ Rule::Action.new(action_type: "set_transaction_category", value: @groceries_category.id) ],
|
||||
conditions: [
|
||||
Rule::Condition.new(condition_type: "compound", operator: "and", sub_conditions: [
|
||||
Rule::Condition.new(condition_type: "compound", operator: "and", sub_conditions: [
|
||||
Rule::Condition.new(condition_type: "transaction_name", operator: "=", value: "Starbucks")
|
||||
])
|
||||
])
|
||||
]
|
||||
)
|
||||
|
||||
assert_not rule.valid?
|
||||
assert_equal [ "Compound conditions cannot be nested" ], rule.errors.full_messages
|
||||
end
|
||||
end
|
||||
Loading…
Add table
Add a link
Reference in a new issue