Rock Paper Scissors

Description

This Ruby web app allows users to regsiter their name and play rock, paper, scissors against the computer.

Technologies used

• Ruby
• Rspec (test framework)
• Sinatra (Ruby web framework)
• Capybara (web feature test library)

Personal motivation

• Building a web app
• Separation of concerns using the MVC model
• Encapsulation and delegation between classes
• Test driving using automated feature tests as well as unit test
• Testing behaviour over state

Steps to download

1. Fork this repo

2. git clone git@github.com:<userName>/rps-challenge.git onto your local machine

Steps to run

1. Run ruby app.rb in root project directory

2. Visit http://localhost:4567/

To run tests

Run rspec directly in root of your local project

My approach

1. Break down user stories into an object model

2. Add capybara config requirements into spec_helper.rb

   • config.include Capybara::DSL
   • require File.join(File.dirname(__FILE__), '..', 'app.rb')

3. Write first feature test - testing infrastructure on home (/) route

4. Make it pass by creating app.rb controller file with "/" route

5. Extend by creating index.erb view file

6. Check in client by running ruby app.rb and visiting localhost:4567

7. Continue with second feature test - testing enter name form

8. Follow red, green, refactor cycle for each feature test

9. Repeat until basic user story functionality is covered

10. Test-drive extracting Score class from the controller code into the model, using units tests, ensuring features tests don't break

Structure

• Controller: app.rb
• Views: views/<name>.erb
• Models: lib/<name>.rb

User stories

User story 1: Register name
---------------------------
As a marketeer,
So that I can see my name in lights,
I would like to register my name before playing an online game.


User story 2: Play game
-----------------------
As a marketeer,
So that I can enjoy myself away from the daily grind,
I would like to be able to play rock/paper/scissors.

---

---

Original Readme - RPS Challenge

Task

Knowing how to build web applications is getting us almost there as web developers!

The Makers Academy Marketing Array ( MAMA ) have asked us to provide a game for them. Their daily grind is pretty tough and they need time to steam a little.

Your task is to provide a Rock, Paper, Scissors game for them so they can play on the web with the following user stories:

As a marketeer
So that I can see my name in lights
I would like to register my name before playing an online game

As a marketeer
So that I can enjoy myself away from the daily grind
I would like to be able to play rock/paper/scissors

Hints on functionality

• the marketeer should be able to enter their name before the game
• the marketeer will be presented the choices (rock, paper and scissors)
• the marketeer can choose one option
• the game will choose a random option
• a winner will be declared

As usual please start by

• Forking this repo
• TEST driving development of your app

Bonus level 1: Multiplayer

Change the game so that two marketeers can play against each other ( yes there are two of them ).

Bonus level 2: Rock, Paper, Scissors, Spock, Lizard

Use the special rules ( you can find them here http://en.wikipedia.org/wiki/Rock-paper-scissors-lizard-Spock )

Basic Rules

• Rock beats Scissors
• Scissors beats Paper
• Paper beats Rock

In code review we'll be hoping to see:

• All tests passing
• High Test coverage (>95% is good)
• The code is elegant: every class has a clear responsibility, methods are short etc.

Reviewers will potentially be using this code review rubric. Referring to this rubric in advance may make the challenge somewhat easier. You should be the judge of how much challenge you want this weekend.

Notes on test coverage

Please ensure you have the following AT THE TOP of your spec_helper.rb in order to have test coverage stats generated on your pull request:

require 'simplecov'
require 'simplecov-console'

SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
  SimpleCov::Formatter::Console,
  # Want a nice code coverage website? Uncomment this next line!
  # SimpleCov::Formatter::HTMLFormatter
])
SimpleCov.start

You can see your test coverage when you run your tests. If you want this in a graphical form, uncomment the HTMLFormatter line and see what happens!