MAINT: refactor set_location

Summary

Some refactoring to allow multiple samples to be borrowed.

Focus

• Where code is changed, we move away from the old naming scheme of boxes.
• Before, we had the state machine behavior distributed over lots of files. It is now defined in box_loan.py and tested in a new unit test.

Test Environment

unit and integration test: run manually

There is a test-profile with an appropriate dump that you can use to start linkahead

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

loanpy/src/loan/accept_loan_request.py

@@ -28,30 +28,23 @@ from .box_loan import (main, get_loan, F_LOAN, assert_loan_state,
                          get_borrower_names, set_property)
 
 
-def _accept_loan_request(data):
-    """Update a loan Record and add the `accepted` Property."""
-    loan = get_loan(data[F_LOAN])
+def _accept_loan_request(loan):
+    """Update a loan Record: add the `accepted` Property."""
     assert_loan_state(loan, S_LOAN_REQUESTED)
 
     # This changes the state from "loan_requested" to "loan_accepted".
     set_property(loan, LOAN_ACCEPTED, get_timestamp())
 
-    # To be sure that it worked:
-    assert_loan_state(loan, S_LOAN_ACCEPTED)
-
-    db.Container().extend([
-        loan
-    ]).update()
-
-    return loan
+    db.Container().extend([loan]).update()
 
 
 def accept_loan_request(data):
     """Accept a loan request.
 
-    I.e. update the `Loan` Record and add the `accepted` Property.
+    I.e. add the `accepted` Property to the `Loan` Record.
     """
-    loan = _accept_loan_request(data)
+    loan = get_loan(data[F_LOAN])
+    _accept_loan_request(loan)
     fn, ln = get_borrower_names(loan)
 
     print_success('Thank you for accepting the loan request by {fn} {ln}. See '