davmcgregor/airport_challenge

Fly!

Makers Academy - Week 1 Weekend Project

Airport-challenge ✈️ ️

Outline | Task | Installation Instructions | Feature Tests | User Stories | Objects & Methods | Testing | Further improvements

Outline

This program replicates the flow of traffic at an airport. Planes can land and take off when it is sunny, and no planes can land or take off when it is stormy.

This challenge is the first weekend challenge at Makers Academy.

The Task

This project is based on the User Stories listed below. Each User Story has been further broken down into Objects and Methods. Tests have been designed for all features in line with TDD best-practice.

Installation Instructions

1. Fork this repository, clone to your local machine then change into the directory:

$ git clone git@github.com:davmcgregor/airport_challenge.git 
$ cd airport_challenge

2. Load dependencies with bundle:

$ gem install bundle
$ bundle

3. Run the app in the terminal:

$ irb
> require './lib/airport_challenge.rb'

Feature Tests (How it works)

Airports have a default capacity of 100 planes but the user can specify their own capacity.

> airport = Airport.new # => @capacity = 100
> large_airport = Airport.new(200) # => @capacity = 200

Airports are empty once initialised - planes need to land before they are allowed to take off.

> plane = Plane.new
> airport.land(plane) # => :landed
> airport.take_off(plane) # => :flying

If the weather is stormy then no planes can land or take off.

User Stories

As an air traffic controller 
So I can get passengers to a destination 
I want to instruct a plane to land at an airport

As an air traffic controller 
So I can get passengers on the way to their destination 
I want to instruct a plane to take off from an airport and confirm that it is no longer in the airport

As an air traffic controller 
To ensure safety 
I want to prevent landing when the airport is full 

As the system designer
So that the software can be used for many different airports
I would like a default airport capacity that can be overridden as appropriate

As an air traffic controller 
To ensure safety 
I want to prevent takeoff when weather is stormy 

As an air traffic controller 
To ensure safety 
I want to prevent landing when weather is stormy 

Objects & Methods

For the user stories I created a domain model for each object, including attributes and behaviour:

Object:	Airport
Attributes:	Planes	Capacity	Weather
Methods:	Land	Take off	Full?	In airport?

Object:	Plane
Attributes:	Location
Methods:	Land	Take off	Grounded?	Flying?

Object:	Weather
Attributes:	Sunny	Stormy
Methods:	Stormy?

Testing

Tests were written with RSpec. To run the tests in terminal:

$> cd airport_challenge
$> rspec

The following edge cases have been tested and refactored:

1. Planes can only take off from airports they are in
2. Planes that are already flying cannot take off and/or be in an airport
3. Planes that are landed cannot land again and must be in an airport

Further Improvements

• Refactor tests
• Update README