Bank-Tech-Test

Challenge:

Build a Tech Test to given specifications with a focus on clean and readable code

Specification

Given a client makes a deposit of 1000 on 10-01-2012
And a deposit of 2000 on 13-01-2012
And a withdrawal of 500 on 14-01-2012
When she prints her bank statement
Then she would see

date || credit || debit || balance
14/01/2012 || || 500.00 || 2500.00
13/01/2012 || 2000.00 || || 3000.00
10/01/2012 || 1000.00 || || 1000.00

Feedback and changes

What the coach liked

• The error handling on bad inputs

• A central loader class app.rb that saves me all the irb set up

• Statement class is clean and well implemented

• Tests are well written and use doubles very well

• The code in general is very high quality

Improvements to be made

• No need for balance attribute on accounts as this can be calculated using the balance on transactions, avoiding duplication

• Too much abstraction in having a seperate transaction history class, initially put in for SRP purposes, but is actually somewhat redundant and over-engineered

• There are three tests for different types of print statements, but this is uneccesary for requirements and these can be combined into one

• A few tests are redundant

User Stories

As a User
So I can store my money
I would like to make a deposit

As a User
So I can use my money
I would like to make a withdrawal

As a User
So I can see my transaction history
I would like to print my statement


As a Developer
So I can pass my tech test
I would like the print to be formatted like the diagram

Design

Original design with print statement defined on account class

Updated design with separated responsibilities

 

Extras

• I kept it close to the specification, but made small additions where easy and appropriate
• Users cannot deposit/ withdraw anything but numeric values
• Users cannot withdraw more than they have as no overdraft was specified
• Separated printing a statement to it's own class even though it is simpler as a feature on the account, to adhere to SRP

 

 

Completed Features:

• Create an account with added transaction history
• Make deposits and withdrawals that record transactions in the transaction history
• Print out a statement in the desired format

 

How to install and run

 

Setup

git clone https://github.com/MattDawson2020/gilded-rose-ruby-tech-test

-bundle

Run App

App is REPL based, use IRB (or PRY) and require the app.rb file, which in turn requires the class files for you

• Create an account object { account = Account.new }in the terminal, which defaults to a balance of 0
• Use account.deposit(amount) or account.withdraw(amount) with amount being an integer or float numeric value
• You can use account.transaction_history to see an array of transactions
• To select an individual transaction use account.transaction_history.transactions and a selector { i.e .first }
• To create a statement object { statement = Statement.new(account) } with an injected account object
• To print a statement use statement.print_statement, it will draw data through the injected account and format it for you