Refactor valuation visitors and enhance mock instrument handling

src/brms/instruments/mock.py

@@ -3,10 +3,16 @@
 from typing import TYPE_CHECKING, Optional
 
 from brms.instruments.base import Instrument
-from brms.instruments.visitors.valuation import BankingBookValuationVisitor
+from brms.instruments.visitors.valuation import ValuationVisitor
+from brms.models.scenario import ScenarioManager
 
 if TYPE_CHECKING:
+    from brms.instruments.amortizing_fixed_rate_loan import AmortizingFixedRateLoan
     from brms.instruments.base import CreditRating, Issuer
+    from brms.instruments.covered_bond import CoveredBond
+    from brms.instruments.credit_card import CreditCard
+    from brms.instruments.fixed_rate_bond import FixedRateBond
+    from brms.instruments.personal_loan import PersonalLoan
     from brms.instruments.visitors import Visitor
     from brms.models.base import BookType
 
@@ -30,17 +36,33 @@ def accept(self, visitor: "Visitor") -> None:
         visitor.visit_mock_instrument(self)
 
 
-class MockValuationVisitor(BankingBookValuationVisitor):
+class MockValuationVisitor(ValuationVisitor):
     """A mock valuation visitor that sets a new value for mock instruments."""
 
     def __init__(self, new_value: float) -> None:
         """Initialize the MockValuationVisitor with a new value.
 
         :param new_value: The new value to set for the mock instrument.
         """
-        super().__init__(scenario=None)
+        sm = ScenarioManager()
+        super().__init__(scenario_manager=sm, valuation_date=None)
         self.new_value = new_value
 
     def visit_mock_instrument(self, instrument: "MockInstrument") -> None:
         """Visit a mock instrument."""
         instrument.value = self.new_value
+
+    def visit_fixed_rate_bond(self, instrument: "FixedRateBond") -> None:
+        """Value a fixed rate bond."""
+
+    def visit_amortizing_fixed_rate_loan(self, instrument: "AmortizingFixedRateLoan") -> None:
+        """Value an amortizing fixed rate bond."""
+
+    def visit_covered_bond(self, instrument: "CoveredBond") -> None:
+        """Value a covered bond."""
+
+    def visit_personal_loan(self, instrument: "PersonalLoan") -> None:
+        """Value a personal loan."""
+
+    def visit_credit_card(self, instrument: "CreditCard") -> None:
+        """Value a credit card."""

src/brms/models/transaction.py

@@ -9,10 +9,16 @@
 from brms.instruments.cash import Cash
 from brms.instruments.common_equity import CommonEquity
 from brms.instruments.deposit import Deposit
+from brms.instruments.mock import MockValuationVisitor
 from brms.instruments.mortgage import Mortgage
 from brms.instruments.visitors.valuation import ValuationVisitor
 from brms.models.bank import Bank
-from brms.models.bank_book import BookType, Position, UnrealizedOCIGainLossTracker, UnrealizedTradingGainLossTracker
+from brms.models.bank_book import (
+    BookType,
+    Position,
+    UnrealizedOCIGainLossTracker,
+    UnrealizedTradingGainLossTracker,
+)
 
 
 class Action(Enum):
@@ -144,6 +150,8 @@ def execute(self) -> bool:
         Returns:
             bool: True if the transaction was executed, False if it was already executed.
         """
+        if isinstance(self.valuation_visitor, MockValuationVisitor):
+            pass
         if not self.executed:
             self._execute()
             self.executed = True
@@ -238,7 +246,10 @@ def create_transaction(
         # Marking to market transactions must have a valuation visitor
         if (
             transaction_type
-            in (TransactionType.SECURITY_FVOCI_MARK_TO_MARKET, TransactionType.SECURITY_FVTPL_MARK_TO_MARKET)
+            in (
+                TransactionType.SECURITY_FVOCI_MARK_TO_MARKET,
+                TransactionType.SECURITY_FVTPL_MARK_TO_MARKET,
+            )
             and valuation_visitor is None
         ):
             error_message = f"ValuationVisitor must be provided for transaction type {transaction_type}."
@@ -404,7 +415,11 @@ class LoanDisbursementTransaction(Transaction):
 
     def controller_actions(self) -> GUIControllerInstruction:
         return {
-            self.cash_to_disburse: (Action.REMOVE, BookType.BANKING_BOOK, Position.LONG),
+            self.cash_to_disburse: (
+                Action.REMOVE,
+                BookType.BANKING_BOOK,
+                Position.LONG,
+            ),
             self.instrument: (Action.ADD, BookType.BANKING_BOOK, Position.LONG),
         }
 
@@ -536,7 +551,8 @@ def controller_actions(self) -> GUIControllerInstruction:
 
     def _execute(self) -> None:
         self.cash_to_receive = self.instrument
-        self.valuation_visitor.set_date(self.transaction_date, date_must_be_in_simulation=False)
+        if not isinstance(self.valuation_visitor, MockValuationVisitor):
+            self.valuation_visitor.set_date(self.transaction_date, date_must_be_in_simulation=False)
         self.mortgage.accept(self.valuation_visitor)
         self.bank.banking_book.add_instrument(self.cash_to_receive, Position.LONG)
         self.bank.ledger.post(self.journal_entry)
@@ -856,7 +872,7 @@ def _execute(self) -> None:
         if not isinstance(self.valuation_visitor, ValuationVisitor):
             error = "ValuationVisitor not set"
             raise TypeError(error)
-        if self.transaction_date is None:
+        if self.transaction_date is None and not isinstance(self.valuation_visitor, MockValuationVisitor):
             error = "Transaction date not set"
             raise TypeError(error)
 
@@ -866,7 +882,8 @@ def _execute(self) -> None:
         self.old_unrealized_trading_loss = self.tracker.get_unrealized_loss(self.instrument)
         self.old_value = self.instrument.value
         # Value the FVTPL instrument at transaction date
-        self.valuation_visitor.set_date(self.transaction_date)
+        if not isinstance(self.valuation_visitor, MockValuationVisitor):
+            self.valuation_visitor.set_date(self.transaction_date)
         self.instrument.accept(self.valuation_visitor)
         self.new_value = self.instrument.value
         # P&L
@@ -923,7 +940,7 @@ def _execute(self) -> None:
         if not isinstance(self.valuation_visitor, ValuationVisitor):
             error = "ValuationVisitor not set"
             raise TypeError(error)
-        if self.transaction_date is None:
+        if self.transaction_date is None and not isinstance(self.valuation_visitor, MockValuationVisitor):
             error = "Transaction date not set"
             raise TypeError(error)
 
@@ -933,7 +950,8 @@ def _execute(self) -> None:
         self.old_unrealized_oci_loss = self.tracker.get_unrealized_loss(self.instrument)
         self.old_value = self.instrument.value
         # Value the FVOCI instrument at transaction date
-        self.valuation_visitor.set_date(self.transaction_date)
+        if not isinstance(self.valuation_visitor, MockValuationVisitor):
+            self.valuation_visitor.set_date(self.transaction_date)
         self.instrument.accept(self.valuation_visitor)
         self.new_value = self.instrument.value
         # P&L