burger_game 1.0.1 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc1d0c98f88b17a7513b6c86dd8dfaa492612164ac943b9274aee79e9d8de483
-  data.tar.gz: fab481d8be76b65c24463561bcb029e67f005c422614ecf75c5100c801d06315
+  metadata.gz: 016a5be00bfc91801f7968d288aedbd6c465a83661bef6f2ce9eec89c53a2393
+  data.tar.gz: b4642b36acc216fdad31819e88855f076c925e49cc0ddd480cdeb7c21b4e5d1e
 SHA512:
-  metadata.gz: 6dac60f1e1771c18c5af6ccba90751f158b901982be687ab68a1be6599a168eeb8e005711e8b388b36deed764ee65d4ba514b6227afce5966b43c8d6fa891553
-  data.tar.gz: 0405c0efea01172f8b01b75c3d3fbf5662ee47e7fb8be26974801bf51afdce7a43c55331c094c878af33c60522d8dc46de672cda54d223366693919544fc641b
+  metadata.gz: 45fb5e026aa06c0b7083550cc5c79143b6a4a04a8a56d7e139d2ee7304527e578a8111cf56a6380d5cb8c2840d7b4c0fc1bfccaf0f8ecca79ed4d6f7a01d25a5
+  data.tar.gz: 8f3fd3ff6e8f60c484256f830f873b9bc08822ad09f71863f0a5d310f01f64c93bfd37f2dc487cccb659ba387c4bd8d3b2fa6548bd30f5019cc73ace1c8bc913

data/Gemfile.lock

@@ -1,60 +1,60 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    artii (2.1.2)
-    colorize (0.8.1)
-    diff-lcs (1.4.4)
-    json (2.5.1)
-    pastel (0.8.0)
-      tty-color (~> 0.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    strings (0.2.1)
-      strings-ansi (~> 0.2)
-      unicode-display_width (>= 1.5, < 3.0)
-      unicode_utils (~> 1.4)
-    strings-ansi (0.2.0)
-    tty-box (0.7.0)
-      pastel (~> 0.8)
-      strings (~> 0.2.0)
-      tty-cursor (~> 0.7)
-    tty-color (0.6.0)
-    tty-cursor (0.7.1)
-    tty-prompt (0.23.1)
-      pastel (~> 0.8)
-      tty-reader (~> 0.8)
-    tty-reader (0.9.0)
-      tty-cursor (~> 0.7)
-      tty-screen (~> 0.8)
-      wisper (~> 2.0)
-    tty-screen (0.8.1)
-    unicode-display_width (2.0.0)
-    unicode_utils (1.4.0)
-    wisper (2.0.1)
-
-PLATFORMS
-  ruby
-  x64-mingw32
-  x86_64-linux
-
-DEPENDENCIES
-  artii (~> 2.1)
-  colorize (~> 0.8.1)
-  json (~> 2.5)
-  rspec (~> 3.10)
-  tty-box (~> 0.7.0)
-  tty-prompt (~> 0.23.1)
-
-BUNDLED WITH
-   2.2.17
+GEM
+  remote: https://rubygems.org/
+  specs:
+    artii (2.1.2)
+    colorize (0.8.1)
+    diff-lcs (1.4.4)
+    json (2.5.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    strings (0.2.1)
+      strings-ansi (~> 0.2)
+      unicode-display_width (>= 1.5, < 3.0)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    tty-box (0.7.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-cursor (~> 0.7)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    unicode-display_width (2.0.0)
+    unicode_utils (1.4.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+  x86_64-linux
+
+DEPENDENCIES
+  artii (~> 2.1)
+  colorize (~> 0.8.1)
+  json (~> 2.5)
+  rspec (~> 3.10)
+  tty-box (~> 0.7.0)
+  tty-prompt (~> 0.23.1)
+
+BUNDLED WITH
+   2.2.17

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

@@ -1,27 +1,29 @@
 Gem::Specification.new do |s|
   s.name          = "burger_game"
-  s.version       = "1.0.1"
+  s.version       = "1.0.6"
   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",
-                     "./burger_game.rb",
-                     "./burger_game.sh",
                      "./Gemfile",
                      "./Gemfile.lock",
                      "./LICENSE",
-                     "./spec/burger_game_spec.rb",
+                     "./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/data/customer_request.json",
-                     "./lib/data/customer_response.json",
-                     "./lib/data/recipe.json"]
+                     "./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"

data/lib/burger_game.rb

@@ -0,0 +1,199 @@
+# For command line argument
+require 'optparse'
+require 'ostruct'
+
+require_relative './game_state'
+require_relative './screen_message'
+require_relative './recipe'
+require_relative './customer_request'
+require_relative './player_option'
+require_relative './score_comparison'
+
+class BurgerGame
+  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
+
+    # 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
+    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.")
+        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.")
+        exit
+      end
+    end
+
+    # Ask user if they want to launch the game or exit
+    puts
+    launch_game = player_options.launch_game
+        
+    # 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
+
+    # Feature 1: Options to see instructions or to start the game
+    loop do
+      puts
+      start_game = player_options.start_game
+
+      break if start_game === true
+
+      # Show instructions
+      puts
+      puts screen.display_instructions
+      
+      puts
+      screen.go_to_next
+    end
+
+    # Show prologue
+    puts
+    puts screen.display_prologue
+
+    puts
+    screen.go_to_next
+
+    # Loop game until WIN / GAME OVER
+    loop do
+      # Display current money and reputation status
+      puts game_state.display_game_state
+
+      puts
+      screen.go_to_next
+
+      # 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
+
+      # Loop to display all recipes
+      i = 0
+      loop do
+        puts show_menu.display_recipe(i)
+
+        puts
+        screen.go_to_next
+
+        i += 1
+        break if i > (no_of_recipe - 1)
+      end
+
+      # 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
+
+      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_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
+      puts "The customer wants to say something..."
+      puts
+      puts customer.display_response(customer_no, mood)
+
+      puts
+      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.rb

@@ -5,7 +5,8 @@ class CustomerRequest
   # ERROR HANDLING for reading files
   begin
     # Read customer_request.JSON file
-    customer_file = File.read('./lib/data/customer_request.json')
+    customer_file = File.read(File.join(File.dirname(__FILE__), './customer_request.json'))
+    
   rescue Errno::ENOENT => e
     puts "Could not find customer_request.json file. Please put customer_request.json in the 'data' directory."
     puts e.message
@@ -18,7 +19,8 @@ class CustomerRequest
   
   begin
     # Read customer_response.JSON file
-    response_file = File.read('./lib/data/customer_response.json')
+    response_file = File.read(File.join(File.dirname(__FILE__), './customer_response.json'))
+    
   rescue Errno::ENOENT => e
     puts "Could not find customer_response.json file. Please put customer_response.json in the 'data' directory."
     puts e.message

data/lib/recipe.rb

@@ -8,7 +8,8 @@ class Recipe
   # ERROR HANDLING for reading files
   begin
     # Read recipe.JSON file
-    file = File.read('./lib/data/recipe.json')
+    file = File.read(File.join(File.dirname(__FILE__), './recipe.json'))
+    
   rescue Errno::ENOENT => e
     puts "Could not find recipe.json file. Please put recipe.json in the 'data' directory."
     puts e.message

data/spec/burger_game_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../burger_game'
+require_relative '../lib/burger_game'
 require_relative '../lib/screen_message'
 require_relative '../lib/recipe'
 require_relative '../lib/player_option'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burger_game
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.6
 platform: ruby
 authors:
 - Jessica Gozali
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,26 +111,28 @@ dependencies:
 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
-executables: []
+executables:
+- start_burger_game
 extensions: []
 extra_rdoc_files: []
 files:
 - "./Gemfile"
 - "./Gemfile.lock"
 - "./LICENSE"
+- "./bin/start_burger_game"
 - "./burger_game.gemspec"
-- "./burger_game.rb"
-- "./burger_game.sh"
+- "./lib/burger_game.rb"
+- "./lib/customer_request.json"
 - "./lib/customer_request.rb"
-- "./lib/data/customer_request.json"
-- "./lib/data/customer_response.json"
-- "./lib/data/recipe.json"
+- "./lib/customer_response.json"
 - "./lib/game_state.rb"
 - "./lib/player_option.rb"
+- "./lib/recipe.json"
 - "./lib/recipe.rb"
 - "./lib/score_comparison.rb"
 - "./lib/screen_message.rb"
 - "./spec/burger_game_spec.rb"
+- bin/start_burger_game
 homepage: https://rubygems.org/gems/burger_game
 licenses:
 - GPL-3.0

data/burger_game.rb

@@ -1,197 +0,0 @@
-# For command line argument
-require 'optparse'
-require 'ostruct'
-
-require_relative './lib/game_state'
-require_relative './lib/screen_message'
-require_relative './lib/recipe'
-require_relative './lib/customer_request'
-require_relative './lib/player_option'
-require_relative './lib/score_comparison'
-
-class BurgerGame
-  # 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: main.rb [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
-
-  # 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.")
-      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.")
-      exit
-    end
-  end
-
-  # Ask user if they want to launch the game or exit
-  puts
-  launch_game = player_options.launch_game
-      
-  # 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
-
-  # Feature 1: Options to see instructions or to start the game
-  loop do
-    puts
-    start_game = player_options.start_game
-
-    break if start_game === true
-
-    # Show instructions
-    puts
-    puts screen.display_instructions
-    
-    puts
-    screen.go_to_next
-  end
-
-  # Show prologue
-  puts
-  puts screen.display_prologue
-
-  puts
-  screen.go_to_next
-
-  # Loop game until WIN / GAME OVER
-  loop do
-    # Display current money and reputation status
-    puts game_state.display_game_state
-
-    puts
-    screen.go_to_next
-
-    # 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
-
-    # Loop to display all recipes
-    i = 0
-    loop do
-      puts show_menu.display_recipe(i)
-
-      puts
-      screen.go_to_next
-
-      i += 1
-      break if i > (no_of_recipe - 1)
-    end
-
-    # 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
-
-    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_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
-    puts "The customer wants to say something..."
-    puts
-    puts customer.display_response(customer_no, mood)
-
-    puts
-    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

data/burger_game.sh

@@ -1,9 +0,0 @@
-#!/bin/bash
-if ! gem list -i burger_game > /dev/null; then
-  gem install burger_game
-fi
-if ! gem list -i bundler > /dev/null; then
-  gem install bundler
-fi
-bundle install --quiet
-ruby burger_game.rb "$@"