burger_game 0.1.1 → 1.0.0

data/lib/recipe.rb

@@ -25,6 +25,7 @@ class Recipe
   # Collect recipe names (array of strings)
   # and ingredient lists (array of arrays of hashes)
   @@recipe_names = []
+  @@no_of_recipe = 0
   @@ingredient_lists = []
   @@all_recipes.each do |recipe|
     @@recipe_names << recipe.keys[0]
@@ -32,6 +33,7 @@ class Recipe
       @@ingredient_lists << list
     end
   end
+  @@no_of_recipe = @@recipe_names.length
 
   def initialize
   end
@@ -44,6 +46,10 @@ class Recipe
     @@recipe_names
   end
 
+  def self.no_of_recipe
+    @@no_of_recipe
+  end
+
   def self.ingredient_lists
     @@ingredient_lists
   end

data/lib/screen_message.rb

@@ -1,7 +1,7 @@
 # Import Gems
 require 'tty-box'
-require 'tty-screen'
 require 'tty-prompt'
+require 'artii'
 
 class ScreenMessage
   # Constant variable for display formatting space
@@ -22,18 +22,11 @@ class ScreenMessage
     msg = "You have entered an invalid value #{input}\nPlease enter the value in a valid format. Use -h or --help to view Help menu.\n"
   end
 
-  def go_to_next
-    # Create instance of TTY Prompt
-    prompt = TTY::Prompt.new
-
-    prompt.select("Press enter to continue.", %w(Next))
-  end
-
   # Method for displaying message frame
   def msg_frame(title, msg, height = 10)
     msg_box = TTY::Box.frame({
       enable_color: true, # force to always color output
-      width: 150,
+      width: 80,
       height: height,
       align: :center,
       padding: 3,
@@ -73,9 +66,15 @@ class ScreenMessage
   end
   
   def display_welcome
+    # Create instance of Artii
+    artii = Artii::Base.new
     title = "   WELCOME   "
-    msg = "Hello there... Welcome to Ruby Burger!\n\n\n~ END ~"
-    height = 13
+    msg = "Hello there... Welcome to" + "\n\n"
+    msg += artii.asciify('Burger Game') + "\n\n"
+    msg += "We are going to build burgers for customers." + "\n"
+    msg += "Clear your mind, put on your best smile..." + "\n"
+    msg += "And... we're ready to stack 'em burgers!"
+    height = 24
 
     # Format output using frame
     msg_frame(title, msg, height)
@@ -83,8 +82,12 @@ class ScreenMessage
 
   def display_instructions
     title = "   HOW TO PLAY   "
-    msg = "Instructions:\n\n1. When shop's Menu is displayed, memorise burger names, ingredients and quantity needed, and ingredients stack order.\n\n2. Customer's request will consists of the name of the burger, and custom preferences, such as 'no sauce' or 'extra 1 patty'.\n\n3. Enter ingredient and quantity needed in order, from bottom of the stack to the top.\n\n4. Keep customers happy and earn money to meet the target (You Win).\n\n5. Be careful not to make the customer angry and let your reputation get to 0 (Game Over).\n\n\n~ END ~"
-    height = 23
+    msg = "Instructions:\n\n1. When shop's Menu is displayed, memorise \"burger names\", \"ingredients\" and \"quantity\" needed, and ingredients \"stack order\"." + "\n\n"
+    msg += "2. Customer's request will consists of the \"name of the burger\", and custom \"preferences\", such as 'no sauce' or 'extra 1 patty'." + "\n\n"
+    msg += "3. Select ingredient and quantity needed in order, from \"bottom\" of the stack \"to the top\". Enter \"0\" for requests that ask to leave some ingredients out because we need to keep the correct order of the stack." + "\n\n"
+    msg += "4. When you build the burger perfectly as per customer request, the happy customer will increase your reputation by 1 point and pay $10 for the burger. Otherwise, if you miss a thing or two, but still acceptable, the pay would be halved but no reputation points given. If you fail to make a decent burger for the customer, the angry customer will not pay and they will take 1 point off your reputation." + "\n\n"
+    msg += "5. Keep enough customers happy and earn money to meet the target (You Win). Be careful not to make too many customers angry and let your reputation get to 0 (Game Over)."
+    height = 32
 
     # Format output using frame
     msg_frame(title, msg, height)
@@ -92,8 +95,14 @@ class ScreenMessage
   
   def display_prologue
     title = "   PROLOGUE   "
-    msg = "Ruby Burger is dedicated in fulfilling the ever growing customers' demand of customised and personalised burgers.\n\nOur job is to build a burger following our shop's Menu recipes, while adjusting into different customers' preferences.\n\n In the next scene, we will memorise our Menu and recipes.\n\nHint: Memorise burger names, ingredients and quantity needed, and ingredients stack order. Build burger from bottom up. Enter ingredients from the bottom of the stack to the top as seen in the recipes.\n\n\n~ END ~"
-    height = 19
+    msg = "Ruby Burger is dedicated in fulfilling the ever growing customers' demand of customised and personalised burgers.\n"
+    msg += "Our job is to build a burger following our shop's Menu recipes, while adjusting into different customers' preferences.\n"
+    msg += "In the next scene, we will memorise our Menu and recipes." + "\n\n"
+    msg += "Hint:\n"
+    msg += "Memorise \"burger names\", \"ingredients\" and \"quantity\" needed, and ingredients \"stack order\".\n"
+    msg += "Build burger from \"bottom up\". Select ingredients from the bottom of the stack to the top as seen in the recipes.\n"
+    msg += "Enter \"0\" for requests that ask to leave some ingredients to keep the correct order of the stack."
+    height = 22
 
     # Format output using frame
     msg_frame(title, msg, height)
@@ -115,10 +124,12 @@ class ScreenMessage
     msg += "      \\      `````     /   |          |" + "\n"
     msg += "     |``--........--'`|    '.______.'" + "\n"
     msg += "\\              /          " + "\n"
-    msg += "jgs  `'----------'`              " + "\n\n"
+    msg += "jgs  `'----------'`              " + "\n\n\n"
 
-    msg += "-- all ASCII artwork copyrighted ©1996-01 -- Joan G. Stark -- All Rights Reserved --" + "\n\n"
-    msg += "\n\n\n~ END ~"
+    msg += "-- all ASCII artwork copyrighted ©1996-01 --" + "\n"
+    msg += "Joan G. Stark" + "\n"
+    msg += "-- All Rights Reserved --" + "\n\n"
+    msg += "\n~ END ~"
 
     height = 35
 
@@ -127,13 +138,34 @@ class ScreenMessage
   end
 
   def display_game_over
+    # Create instance of Artii
+    artii = Artii::Base.new
     title = "   GAME OVER   "
-    msg = "Oh no! Everyone is leaving because you didn't stack the right burgers!\n\nOwning a burger shop, especially a Ruby one, is tough.\nYou need to practice hard (or just use the handicap ARGV in command line, read the instruction in the installation guide in README.md).\n\nDon't give up! You can always try again next time!" + "\n\n"
+    msg = artii.asciify('GAME OVER') + "\n\n"
+    msg += "Oh no! Everyone is leaving because you didn't stack the right burgers!" + "\n\n"
+    msg += "Owning a burger shop, especially a Ruby one, is tough.\n"
+    msg += "You need to practice hard (or just use the handicap ARGV in command line, read the instruction in the installation/usage guide in README.md).\n\nDon't give up! You can always try again next time!" + "\n\n"
     msg += "You are lucky this is just a game..."
     msg += "\n\n\n~ END ~"
-    height = 20
+    height = 30
 
     # Format output using frame
     msg_frame(title, msg, height)
   end
+
+  def go_to_next
+    # Create instance of TTY Prompt
+    prompt = TTY::Prompt.new
+
+    input = prompt.select("Do you want to continue?") do |menu|
+      menu.choice "Next"
+      menu.choice "Exit"
+    end
+
+    if input == "Exit"
+      exit
+    else
+      input
+    end
+  end
 end

data/spec/burger_game_spec.rb

@@ -0,0 +1,128 @@
+require_relative '../burger_game'
+require_relative '../lib/screen_message'
+require_relative '../lib/recipe'
+require_relative '../lib/player_option'
+require_relative '../lib/customer_request'
+require_relative '../lib/score_comparison'
+require_relative '../lib/game_state'
+
+# Test case for Feature 1
+# and for MAIN FEATURES: Feature 7
+describe ScreenMessage do
+  # This block runs before each test case defined in 'it' block
+  before(:each) do
+    @screen_message = ScreenMessage.new
+  end
+
+  it "check if display_welcome is defined" do
+    expect(@screen_message.display_welcome.class).to eq(String)
+  end
+
+  it "check if display_instructions is defined" do
+    expect(@screen_message.display_instructions.class).to eq(String)
+  end
+
+  it "check if display_prologue is defined" do
+    expect(@screen_message.display_prologue.class).to eq(String)
+  end
+
+  it "check if display_win is defined" do
+    expect(@screen_message.display_win.class).to eq(String)
+  end
+
+  it "check if display_win is defined" do
+    expect(@screen_message.display_game_over.class).to eq(String)
+  end
+end
+
+# Test case for Feature 2
+describe Recipe do
+  it "should display the recipe" do
+    recipe = Recipe.new
+    recipe_no = 1
+    expect(recipe.display_recipe(recipe_no).class).to eq(String)
+  end
+end
+
+# Test case for Feature 3
+# and for Feature 6
+describe CustomerRequest do
+  # This block runs before each test case defined in 'it' block
+  before(:each) do
+    @customer = CustomerRequest.new
+    @customer_no = 1
+  end
+
+  it "should display customer request" do
+    expect(@customer.display_request(@customer_no).class).to eq(String)
+  end
+
+  it "should display customer response" do
+    mood = "angry"
+    expect(@customer.display_response(@customer_no, mood).class).to eq(String)
+  end
+end
+
+# Test case for MAIN FEATURES: Feature 4
+describe PlayerOption do
+  # This block runs before each test case defined in 'it' block
+  before(:each) do
+    @player_selections = PlayerOption.new
+  end
+
+  it "should launch the game" do
+    expect(@player_selections.launch_game.class).to be(TrueClass) | be(FalseClass)
+  end
+
+  it "should start the game" do
+    expect(@player_selections.start_game.class).to be(TrueClass) | be(FalseClass)
+  end
+
+  it "should get player's options" do
+    expect(@player_selections.get_selection.class).to eq(Array)
+  end
+end
+
+# Test case for MAIN FEATURES: Feature 5
+describe ScoreComparison do
+  # This block runs before each test case defined in 'it' block
+  before(:each) do
+    player_recipe = [{ "Bun" => 1 }, { "Lettuce" => 2}, { "Grilled Chicken" => 2 }, { "Tomato Sauce" => 4 }, { "Cheese" => 3 }]
+    customer_no = 1
+    customer = CustomerRequest.new
+    @compare = ScoreComparison.new(player_recipe, customer.get_request(customer_no))
+  end
+
+  it "should calculate score for player input and customer request comparison" do
+    expect(@compare.get_score).to be(4)
+  end
+
+  it "should get correct customer mood" do
+    expect(@compare.get_mood(@compare.get_score)).to eq("neutral")
+  end
+end
+
+describe GameState do
+  # This block runs before each test case defined in 'it' block
+  before(:each) do
+    player_recipe = [{ "Bun" => 1 }, { "Lettuce" => 2 }, { "Grilled Chicken" => 2 }, { "Tomato Sauce" => 4 }, { "Cheese" => 3 }]
+    customer_no = 1
+    customer = CustomerRequest.new
+    @compare = ScoreComparison.new(player_recipe, customer.get_request(customer_no))
+    @game_state = GameState.new
+  end
+
+  it "should get correct current money amount" do
+    score = @compare.get_score
+    mood = @compare.get_mood(score)
+    expect(@compare.calculate_state(mood)[0]).to be(5.0)
+  end
+
+  it "should get correct current reputation points" do
+    expect(@compare.calculate_state(@compare.get_mood(@compare.get_score))[1]).to be(10)
+  end
+
+  it "should display game state" do
+    expect(@game_state.display_game_state.class).to eq(String)
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: burger_game
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jessica Gozali
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
-dependencies: []
+date: 2021-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: A simple text-based Ruby terminal game, that simulates a burger shop,
   where you need to build the meal for the customers with different requests and preferences.
 email: gcas012115@coderacademy.edu.au
@@ -17,13 +31,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- "./lib/burger_game.rb"
+- "./Gemfile"
+- "./Gemfile.lock"
+- "./LICENSE"
+- "./burger_game.gemspec"
+- "./burger_game.rb"
+- "./burger_game.sh"
 - "./lib/customer_request.rb"
+- "./lib/data/customer_request.json"
+- "./lib/data/customer_response.json"
+- "./lib/data/recipe.json"
 - "./lib/game_state.rb"
 - "./lib/player_option.rb"
 - "./lib/recipe.rb"
 - "./lib/score_comparison.rb"
 - "./lib/screen_message.rb"
+- "./spec/burger_game_spec.rb"
 homepage: https://rubygems.org/gems/burger_game
 licenses:
 - GPL-3.0
@@ -34,9 +57,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="