Makers Academy - Week 2 Project
Outline | Task | Installation Instructions | User Stories | Objects & Methods | Future Work
Build London's Oystercard system in Ruby.
This challenge starts with going over the foundational skills from last week's Boris Bikes, and then introduces some additinal complexities with the Oystercard system.
- Clone the repo to your local machine
- Run the command
gem install bundle
(if you don't have bundler already) - When the installation completes, run
bundle
- Run the program via IRB
- Tests can be run using RSpec. Run the command
RSpec
.
In order to use public transport
As a customer
I want money on my card
In order to keep using public transport
As a customer
I want to add money to my card
In order to protect my money
As a customer
I don't want to put too much money on my card
In order to pay for my journey
As a customer
I need my fare deducted from my card
In order to get through the barriers
As a customer
I need to touch in and out
In order to pay for my journey
As a customer
I need to have the minimum amount for a single journey
In order to pay for my journey
As a customer
I need to pay for my journey when it's complete
In order to pay for my journey
As a customer
I need to know where I've travelled from
In order to know where I have been
As a customer
I want to see to all my previous trips
In order to know how far I have travelled
As a customer
I want to know what zone a station is in
In order to be charged correctly
As a customer
I need a penalty charge deducted if I fail to touch in or out
In order to be charged the correct amount
As a customer
I need to have the correct fare calculated
Methods | Description |
---|---|
OysterCard.new | Creates a new instance of Oyster Card |
.top_up(amount) | Allows the user to top up their balance by a given amount |
.touch_in(station) | Creates a new instance of journey and stores the station as an attribute of journey within the journey log |
.touch_out(station) | Adds the finish station attribute to the current instance of journey and deduces the fare |
Methods | Description |
---|---|
.start(station) | Sets the station as the @entry_station attribute of the journey instance & sets in_journey? to true. |
.exit(station) | Sets the station as the @exit_station attribute of the journey instance & sets in_journey? to false. |
.fare | Calulates the fare based on the minimum fare and if a penalty has been issued for a previous journey |
On a revisit of the project, in order to reduce coupling in the code, I would extract a JourneyLog class from Journey.