burger_game 0.1.1 → 1.0.4

data/bin/start_burger_game

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'burger_game'
+
+begin
+  BurgerGame.new *ARGV.dup
+rescue StandardError => e
+  puts "Something went wrong."
+  puts "Error message: " + e.message
+end

data/burger_game.gemspec

@@ -0,0 +1,37 @@
+Gem::Specification.new do |s|
+  s.name          = "burger_game"
+  s.version       = "1.0.4"
+  s.summary       = "A Ruby Burger Game"
+  s.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."
+  s.authors       = ["Jessica Gozali"]
+  s.email         = "gcas012115@coderacademy.edu.au"
+  s.require_paths = ["lib"]
+  s.bindir        = "bin"
+  s.executables   = ["start_burger_game"]
+  s.files         = ["./burger_game.gemspec",
+                     "./Gemfile",
+                     "./Gemfile.lock",
+                     "./LICENSE",
+                     "./bin/start_burger_game",
+                     "./lib/burger_game.rb",
+                     "./lib/customer_request.rb",
+                     "./lib/game_state.rb",
+                     "./lib/player_option.rb",
+                     "./lib/recipe.rb",
+                     "./lib/score_comparison.rb",
+                     "./lib/screen_message.rb",
+                     "./lib/customer_request.json",
+                     "./lib/customer_response.json",
+                     "./lib/recipe.json",
+                     "./spec/burger_game_spec.rb"]
+  s.homepage      =  "https://rubygems.org/gems/burger_game"
+  s.license       =  "GPL-3.0"
+  s.required_ruby_version = "~> 2.7"
+  s.add_runtime_dependency "bundler", "~> 2.2"
+  s.add_runtime_dependency "artii", "~> 2.1"
+  s.add_runtime_dependency "colorize", "~> 0.8.1"
+  s.add_runtime_dependency "json", "~> 2.5"
+  s.add_runtime_dependency "rspec", "~> 3.10"
+  s.add_runtime_dependency "tty-box", "~> 0.7.0"
+  s.add_runtime_dependency "tty-prompt", "~> 0.23.1"
+end

data/lib/burger_game.rb

@@ -10,187 +10,190 @@ require_relative './player_option'
 require_relative './score_comparison'
 
 class BurgerGame
-  # Initialise
-  game_state = GameState.new
-  show_menu = Recipe.new
-  no_of_recipe = Recipe.all_recipes.length
-  screen = ScreenMessage.new
-  player_options = PlayerOption.new
-  customer = CustomerRequest.new
-  options = OpenStruct.new
-
-  # Handle command line argument
-  opt_parser = OptionParser.new do |opt|
-    opt.banner = "Usage: main.rb [options]"
-
-    opt.on("-h", "--help", "Print this Help menu for Ruby Burger Game.") do |arg|
-      puts opt
-      exit
+  def initialize(*args)
+    # Initialise
+    game_state = GameState.new
+    show_menu = Recipe.new
+    no_of_recipe = Recipe.no_of_recipe
+    screen = ScreenMessage.new
+    player_options = PlayerOption.new
+    customer = CustomerRequest.new
+    no_of_customer = CustomerRequest.no_of_customer
+    options = OpenStruct.new
+
+    # Handle command line argument
+    opt_parser = OptionParser.new do |opt|
+      opt.banner = "Usage: start_burger_game [options]"
+
+      opt.on("-h", "--help", "Print this Help menu for Ruby Burger Game.") do |arg|
+        puts opt
+        exit
+      end
+
+      opt.on("-m", "--money TARGET_MONEY", screen.display_h_money) { |arg| options.target_money = arg }
+
+      opt.on("-r", "--reputation MAX_REPUTATION", screen.display_h_reputation) { |arg| options.max_reputation = arg }
     end
 
-    opt.on("-m", "--money TARGET_MONEY", screen.display_h_money) { |arg| options.target_money = arg }
-
-    opt.on("-r", "--reputation MAX_REPUTATION", screen.display_h_reputation) { |arg| options.max_reputation = arg }
-  end
-
-  # ERROR HANDLING for command line argument
-  begin
-    opt_parser.parse!
-  rescue OptionParser::InvalidOption => e
-    puts "You have entered an invalid option. Please check the available options in our Help menu '-h' or '--help'."
-    puts e.message
-    exit
-  rescue OptionParser::MissingArgument => e
-    puts "You have not entered the argument for your option."
-    puts e.message
-    exit
-  rescue OptionParser::ParseError => e
-    puts "Error when parsing argument."
-    puts e.message
-    exit
-  rescue => e
-    puts "Something went wrong."
-    puts "Error message: " + e.message
-    exit
-  end
-
-  if (options.target_money)
-    if ((options.target_money.to_i >= 10 ) && (options.target_money.to_i <= 99 ))
-      puts "Change TARGET_MONEY to: $#{options.target_money}.00."
-      # Set target money in GameState
-      game_state.set_target_money(options.target_money.to_f)
-    else
-      puts screen.display_invalid("for TARGET_MONEY.")
+    # ERROR HANDLING for command line argument
+    begin
+      opt_parser.parse!(args)
+    rescue OptionParser::InvalidOption => e
+      puts "You have entered an invalid option. Please check the available options in our Help menu '-h' or '--help'."
+      puts e.message
       exit
-    end
-    
-  end
-  if (options.max_reputation)
-    if ((options.max_reputation.to_i >= 1 ) && (options.max_reputation.to_i <= 10 ))
-      puts "Change MAX_REPUTATION to: #{options.max_reputation}."
-      # Set max reputation in GameState
-      game_state.set_max_reputation(options.max_reputation.to_i)
-    else
-      puts screen.display_invalid("for MAX_REPUTATION.")
+    rescue OptionParser::MissingArgument => e
+      puts "You have not entered the argument for your option."
+      puts e.message
+      exit
+    rescue OptionParser::ParseError => e
+      puts "Error when parsing argument."
+      puts e.message
+      exit
+    rescue => e
+      puts "Something went wrong."
+      puts "Error message: " + e.message
       exit
     end
-  end
 
-  # Ask user if they want to launch the game or exit
-  puts
-  launch_game = player_options.get_launch_game
+    if (options.target_money)
+      if ((options.target_money.to_i >= 10 ) && (options.target_money.to_i <= 99 ))
+        puts "Change TARGET_MONEY to: $#{options.target_money}.00."
+        # Set target money in GameState
+        game_state.set_target_money(options.target_money.to_f)
+      else
+        puts screen.display_invalid("for TARGET_MONEY.")
+        exit
+      end
       
-  # Exit command line if user select Exit
-  exit if launch_game === false
-
-  # Show welcome message
-  puts
-  puts screen.display_welcome
-  puts
-  screen.go_to_next
+    end
+    if (options.max_reputation)
+      if ((options.max_reputation.to_i >= 1 ) && (options.max_reputation.to_i <= 10 ))
+        puts "Change MAX_REPUTATION to: #{options.max_reputation}."
+        # Set max reputation in GameState
+        game_state.set_max_reputation(options.max_reputation.to_i)
+      else
+        puts screen.display_invalid("for MAX_REPUTATION.")
+        exit
+      end
+    end
 
-  # Feature 1: Options to see instructions or to start the game
-  loop do
+    # Ask user if they want to launch the game or exit
     puts
-    start_game = player_options.get_start_game
-
-    break if start_game === true
+    launch_game = player_options.launch_game
+        
+    # Exit command line if user select Exit
+    exit if launch_game === false
 
-    # Show instructions
+    # Show welcome message
     puts
-    puts screen.display_instructions
-    
+    puts screen.display_welcome
     puts
     screen.go_to_next
-  end
 
-  # Show prologue
-  puts
-  puts screen.display_prologue
+    # Feature 1: Options to see instructions or to start the game
+    loop do
+      puts
+      start_game = player_options.start_game
 
-  puts
-  screen.go_to_next
+      break if start_game === true
 
-  # Loop game until WIN / GAME OVER
-  loop do
-    # Display current money and reputation status
-    puts game_state.display_game_state
+      # Show instructions
+      puts
+      puts screen.display_instructions
+      
+      puts
+      screen.go_to_next
+    end
 
+    # Show prologue
     puts
-    screen.go_to_next
+    puts screen.display_prologue
 
-    # Feature 2: Formatted display for showing shop's menu
-    puts
-    puts "Ruby Burger's Menu"
-    puts 
-    puts
-    puts "We have #{no_of_recipe} recipes. Try to remember the recipe name, the stack order of ingredients and the quantity. We will build the burger from bottom to top."
     puts
+    screen.go_to_next
 
-    # Loop to display all recipes
-    i = 0
+    # Loop game until WIN / GAME OVER
     loop do
-      puts show_menu.display_recipe(i)
+      # Display current money and reputation status
+      puts game_state.display_game_state
 
       puts
       screen.go_to_next
 
-      i += 1
-      break if i > (no_of_recipe - 1)
-    end
+      # Feature 2: Formatted display for showing shop's menu
+      puts
+      puts "Ruby Burger's Menu"
+      puts 
+      puts
+      puts "We have #{no_of_recipe} recipes. Try to remember the recipe name, the stack order of ingredients and the quantity. We will build the burger from bottom to top."
+      puts
 
-    # Feature 3: Randomised customers with set of request (and associated preferences) and responses
-    # Display customer request
-    puts
-    puts "There is a customer in the queue..."
-    puts
-    # Randomise customer
-    customer_no = rand(0..9)
-    puts customer.display_request(customer_no)
-    puts
+      # Loop to display all recipes
+      i = 0
+      loop do
+        puts show_menu.display_recipe(i)
 
-    puts
-    screen.go_to_next
+        puts
+        screen.go_to_next
 
-    # Feature 4: Selectable options for list of ingredients, so no manual entry (typing) is needed.
-    # Quantity input as integer within a pre-set range.
-    # Display player's options
-    player_recipe = player_options.get_options
-    customer_recipe = customer.get_request(customer_no)
-
-    # Feature 5: Score calculation based on customer's request and preferences compared to player's input
-    # Calculate score
-    compare = ScoreComparison.new(player_recipe, customer_recipe)
-    score = compare.get_score
-    mood = compare.get_mood(score)
-    
-    # Feautre 6: Get customers' responses from a JSON file
-    # Display customer's response
-    puts
-    puts "The customer wants to say something..."
-    puts
-    puts customer.display_response(customer_no, mood)
+        i += 1
+        break if i > (no_of_recipe - 1)
+      end
 
-    puts
-    screen.go_to_next
-    puts
+      # Feature 3: Randomised customers with set of request (and associated preferences) and responses
+      # Display customer request
+      puts
+      puts "There is a customer in the queue..."
+      puts
+      # Randomise customer
+      customer_no = rand(no_of_customer)
+      puts customer.display_request(customer_no)
+      puts
 
-    # Update game state
-    compare.calculate_state(mood)
+      puts
+      screen.go_to_next
 
-    # Feature 7: Lose/win criteria based on reputation and money
-    # GAME OVER condition
-    if GameState.current_reputation == 0
-      puts screen.display_game_over
+      # Feature 4: Selectable options for list of ingredients, so no manual entry (typing) is needed.
+      # Quantity input as integer within a pre-set range.
+      # Display player's options
+      player_recipe = player_options.get_selection
+      customer_recipe = customer.get_request(customer_no)
+
+      # Feature 5: Score calculation based on customer's request and preferences compared to player's input
+      # Calculate score
+      compare = ScoreComparison.new(player_recipe, customer_recipe)
+      score = compare.get_score
+      mood = compare.get_mood(score)
+      
+      # Feautre 6: Get customers' responses from a JSON file
+      # Display customer's response
       puts
-      break
-    end
+      puts "The customer wants to say something..."
+      puts
+      puts customer.display_response(customer_no, mood)
 
-    # WIN condition
-    if GameState.current_money >= GameState.target_money
-      puts screen.display_win
       puts
-      break
+      screen.go_to_next
+      puts
+
+      # Update game state
+      compare.calculate_state(mood)
+
+      # Feature 7: Lose/win criteria based on reputation and money
+      # GAME OVER condition
+      if GameState.current_reputation == 0
+        puts screen.display_game_over
+        puts
+        break
+      end
+
+      # WIN condition
+      if GameState.current_money >= GameState.target_money
+        puts screen.display_win
+        puts
+        break
+      end
     end
   end
 end

data/lib/customer_request.json

@@ -0,0 +1,172 @@
+[
+  {
+    "   A Customer   ":
+    [
+      {
+        "Normal Burger":
+        [
+          {"Cheese": 0}
+        ]
+      },
+      {
+        "Request": "Hello! Can I please have a \"Normal Burger\" today?"
+      },
+      {
+        "Preference": "I don't like cheese, so, with no cheese please!"
+      }
+    ]
+  },
+  {
+    "   Captain Australia   ":
+    [
+      {
+        "Questionable Burger":
+        [
+          {"Grilled Chicken": 5}
+        ]
+      },
+      {
+        "Request": "G'day mate! Can I get \"Questionable Burger\" please?"
+      },
+      {
+        "Preference": "I'm so hungry, please put an extra patty in my burger! Ta!"
+      }
+    ]
+  },
+  {
+    "   John Citizen   ":
+    [
+      {
+        "Healthy Burger":
+        [
+          {"Lettuce": 0}
+        ]
+      },
+      {
+        "Request": "Hi there. I'm a healthy person you know.\nSo, can I have \"Healthy Burger\" please?"
+      },
+      {
+        "Preference": "And, with no veggies please. Yes, you heard me right, no veggies!"
+      }
+    ]
+  },
+  {
+    "   Jane Citizen   ":
+    [
+      {
+        "Healthy Burger":
+        [
+          {"Grilled Chicken": 0}
+        ]
+      },
+      {
+        "Request": "Hi... I'd like to have the \"Healthy Burger\" please."
+      },
+      {
+        "Preference": "I don't want the chicken. It reminds me of John..."
+      }
+    ]
+  },
+  {
+    "   Scott Morris   ":
+    [
+      {
+        "Questionable Burger":
+        [
+          {"Cheese": 5}
+        ]
+      },
+      {
+        "Request": "Good day! A quick question, can I have the \"Questionable Burger\" please?"
+      },
+      {
+        "Preference": "With extra two slices of cheese please.\nI hope it is not cheesy. Hahaha! *laughs at own attempt to be funny*"
+      }
+    ]
+  },
+  {
+    "   The Mighty Princess   ":
+    [
+      {
+        "Healthy Burger":
+        [
+          {"Lettuce": 4}
+        ]
+      },
+      {
+        "Request": "Oh, tell me dear citizen, can this Princess have the \"Healthy Burger\" please?"
+      },
+      {
+        "Preference": "Make it with extra one lettuce! I will reward you handsomely..."
+      }
+    ]
+  },
+  {
+    "   Donald T.   ":
+    [
+      {
+        "Questionable Burger":
+        [
+          {"Lettuce": 0}
+        ]
+      },
+      {
+        "Request": "I'm a busy man. Give the \"Questionable Burger\". Thanks."
+      },
+      {
+        "Preference": "Oh, and I'll have it without lettuce!\nNo lettuce!! *throws fist in the air*"
+      }
+    ]
+  },
+  {
+    "   Mickey M.   ":
+    [
+      {
+        "Healthy Burger":
+        [
+          {"Tomato Sauce": 2}
+        ]
+      },
+      {
+        "Request": "Hello... Hmm... I'm interested in trying the \"Healthy Burger\" please..."
+      },
+      {
+        "Preference": "I love tomato, so can I have double the sauce please?"
+      }
+    ]
+  },
+  {
+    "   Unicorn   ":
+    [
+      {
+        "Questionable Burger":
+        [
+          {"Tomato Sauce": 0}
+        ]
+      },
+      {
+        "Request": "Hiya! Can I have \"Questionable Burger\" please?"
+      },
+      {
+        "Preference": "Leave the tomato sauce out please.\nIt will ruin the colour balance of my rainbow."
+      }
+    ]
+  },
+  {
+    "   A Robot   ":
+    [
+      {
+        "Normal Burger":
+        [
+          {"Grilled Chicken": 3}
+        ]
+      },
+      {
+        "Request": "Beep... Can I have the.. Beep... \"Normal Burger\" please?"
+      },
+      {
+        "Preference": "Beep... With triple... Beep... Patty please..."
+      }
+    ]
+  }
+]