aobgame 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7df45a30c5322964b83c48329c4dcbb30a1220d036fe1035cc612b6e19ab9800
+  data.tar.gz: 6a66121cb669d5fa6846d0b4cd5e1b7b998078513d0e7c7481f47eacb73edf91
+SHA512:
+  metadata.gz: 6395a09673bcdfb8c2798bf46a636d08a07c2812ce70ca8723d3deaa1d6acd2dc3202c636904251d528218fced10d65da43012a050b88d935b868652117e4546
+  data.tar.gz: 050156dffe66025b06bb8bfa7dcc5c996a943f695f22b4910302acb86670afb723a860bbc47742dc8252fac97d5534c4a285a598d73431d1f00a81815e72787d

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2022 André O. Brown
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -0,0 +1,3 @@
+Just a basic game created for a pretty good course. 
+
+Hi Joana and David 👋🏾

data/bin/aobgame

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/aobgame/player"
+require_relative "../lib/aobgame/clumsy_player"
+require_relative "../lib/aobgame/berserk_player"
+require_relative "../lib/aobgame/game"
+
+game = AobGame::Game.new("Enter The Matrix")
+default_player_file = File.join(File.dirname(__FILE__), "players.csv")
+game.load_players(ARGV.shift || default_player_file)
+klutzier = AobGame::ClumsyPlayer.new("klutzier", 105)
+game.add_player(klutzier)
+berserker = AobGame::BerserkPlayer.new("berserker", 50)
+game.add_player(berserker)
+klutz = AobGame::ClumsyPlayer.new("klutz", 105, 4)
+game.add_player(klutz)
+
+loop do
+  puts "\nHow many game rounds? ('quit' to exit)"
+  answer = gets.chomp.downcase
+  case answer
+  when /^\d+$/
+    game.play(answer.to_i)
+  when "quit", "exit", "q", "x"
+    game.print_stats
+    break
+  else
+    puts "Please enter a number or 'quit'"
+  end
+end
+
+game.save_high_scores

data/bin/players.csv

@@ -0,0 +1,3 @@
+Andre,100
+Joana,101
+David,125

data/lib/aobgame/auditable.rb

@@ -0,0 +1,7 @@
+module AobGame
+  module Auditable
+    def audit
+      puts "Rolled a #{self.number} (#{self.class})"
+    end
+  end
+end

data/lib/aobgame/berserk_player.rb

@@ -0,0 +1,31 @@
+require_relative "player"
+
+module AobGame
+  class BerserkPlayer < Player
+    def initialize(name, health = 100)
+      super(name, health)
+      @w00t_count = 0
+    end
+
+    def berserk?
+      @w00t_count > 5
+    end
+
+    def w00t
+      super
+      @w00t_count += 1
+      puts "#{@name} is berserk!" if berserk?
+    end
+
+    def blam
+      berserk? ? w00t : super
+    end
+  end
+
+  if __FILE__ == $0
+    berserker = BerserkPlayer.new("berserker", 50)
+    6.times { berserker.w00t }
+    2.times { berserker.blam }
+    puts berserker.health
+  end
+end

data/lib/aobgame/clumsy_player.rb

@@ -0,0 +1,38 @@
+require_relative "player"
+
+module AobGame
+  class ClumsyPlayer < Player
+    attr_reader :boost_factor
+
+    def initialize(name, health = 100, boost_factor = 1)
+      super(name, health)
+      @boost_factor = boost_factor
+    end
+
+    def w00t
+      @boost_factor.times { super }
+    end
+
+    def found_treasure(treasure)
+      damaged_treasure = Treasure.new(treasure.name, treasure.points / 2.0)
+      super(damaged_treasure)
+    end
+  end
+
+  if __FILE__ == $0
+    clumsy = ClumsyPlayer.new("klutz")
+
+    hammer = Treasure.new(:hammer, 50)
+    clumsy.found_treasure(hammer)
+    clumsy.found_treasure(hammer)
+    clumsy.found_treasure(hammer)
+
+    crowbar = Treasure.new(:crowbar, 400)
+    clumsy.found_treasure(crowbar)
+
+    clumsy.each_found_treasure do |treasure|
+      puts "#{treasure.points} total #{treasure.name} points"
+    end
+    puts "#{clumsy.points} grand total points"
+  end
+end

data/lib/aobgame/die.rb

@@ -0,0 +1,19 @@
+require_relative "auditable"
+
+module AobGame
+  class Die
+    include Auditable
+
+    attr_reader :number
+
+    def initialize
+      roll
+    end
+
+    def roll
+      @number = rand(1..6)
+      audit
+      @number
+    end
+  end
+end

data/lib/aobgame/game.rb

@@ -0,0 +1,98 @@
+require_relative "game_turn"
+require_relative "treasure_trove"
+require "csv"
+
+module AobGame
+  class Game
+    attr_reader :title
+
+    def initialize(title)
+      @title = title
+      @players = []
+    end
+
+    def add_player(player)
+      @players << player
+    end
+
+    def load_players(from_file)
+      CSV.foreach(from_file) do |row|
+        player = Player.new(row[0], row[1].to_i)
+        add_player(player)
+      end
+    end
+
+    def play(rounds)
+      puts "There are #{@players.size} players #{@title}:"
+      treasures = TreasureTrove::TREASURES
+      puts "\nThere are #{treasures.size} treasures to be found:"
+      treasures.each do |treasure|
+        puts "A #{treasure.name} is worth #{treasure.points} points"
+      end
+      1.upto(rounds) do |round|
+        if block_given?
+          break if yield
+        end
+        puts "\nRound #{round}:"
+        @players.each do |player|
+          GameTurn.take_turn(player)
+          puts player
+        end
+      end
+    end
+
+    def print_name_and_health(player)
+      puts "#{player.name} (#{player.health})"
+    end
+
+    def high_score_entry(player)
+      formatted_name = player.name.ljust(20, ".")
+      "#{formatted_name} #{player.score}"
+    end
+
+    def print_stats
+      strong_players = @players.select { |player| player.strong? }
+      wimpy_players = @players.reject { |player| player.strong? }
+
+      puts "\n#{@title} Statistics:"
+
+      puts "\n#{strong_players.size} strong players:"
+      strong_players.each do |player|
+        print_name_and_health(player)
+      end
+
+      puts "\n#{wimpy_players.size} wimpy players:"
+      wimpy_players.each do |player|
+        print_name_and_health(player)
+      end
+
+      puts "\n#{@title} High Scores:"
+      @players.sort.each do |player|
+        puts high_score_entry(player)
+      end
+
+      @players.each do |player|
+        puts "\n#{player.name}'s point totals:"
+        player.each_found_treasure do |treasure|
+          puts "#{treasure.points} total #{treasure.name} points"
+        end
+        puts "#{player.points} grand total points"
+      end
+
+      puts "#{total_points} total points from treasures found"
+    end
+
+    def total_points
+      @players.reduce(0) { |sum, player| sum + player.points }
+    end
+
+    def save_high_scores(to_file = "high_scores.txt")
+      File.open(to_file, "w") do |file|
+        file.puts "#{@title} High Scores:"
+        @players.sort.each do |player|
+          file.puts high_score_entry(player)
+        end
+      end
+    end
+  end
+end

data/lib/aobgame/game_turn.rb

@@ -0,0 +1,22 @@
+require_relative "player"
+require_relative "die"
+require_relative "loaded_die"
+
+module AobGame
+  module GameTurn
+    def self.take_turn(player)
+      die = Die.new
+      #die = LoadedDie.new
+      case die.roll
+      when 1..2
+        player.blam
+      when 3..4
+        puts "#{player.name} was skipped."
+      else
+        player.w00t
+      end
+      treasure = TreasureTrove.random
+      player.found_treasure(treasure)
+    end
+  end
+end

data/lib/aobgame/loaded_die.rb

@@ -0,0 +1,15 @@
+require_relative "auditable"
+
+module AobGame
+  class LoadedDie
+    include Auditable
+
+    attr_reader :number
+
+    def roll
+      numbers = [1, 1, 2, 5, 6, 6]
+      audit
+      @number = numbers.sample
+    end
+  end
+end

data/lib/aobgame/playable.rb

@@ -0,0 +1,17 @@
+module AobGame
+  module Playable
+    def blam
+      self.health -= 10
+      puts "#{self.name} got blammed!"
+    end
+
+    def w00t
+      self.health += 15
+      puts "#{self.name} got w00ted!"
+    end
+
+    def strong?
+      self.health > 100
+    end
+  end
+end

data/lib/aobgame/player.rb

@@ -0,0 +1,64 @@
+require_relative "treasure_trove"
+require_relative "playable"
+
+module AobGame
+  class Player
+    include Playable
+
+    attr_accessor :name
+    attr_accessor :health
+
+    def initialize(name, health = 100)
+      @name = name.capitalize
+      @health = health
+      @found_treasures = Hash.new(0)
+    end
+
+    def <=>(other)
+      other.score <=> score
+    end
+
+    def to_s
+      "I'm #{@name} with health = #{@health}, points = #{points}, and score = #{score}."
+    end
+
+    def self.from_csv(string)
+      name, health = string.split(",")
+      Player.new(name, Integer(health))
+    end
+
+    def score
+      @health + points
+    end
+
+    def name=(new_name)
+      @name = new_name.capitalize
+    end
+
+    def found_treasure(treasure)
+      @found_treasures[treasure.name] += treasure.points
+      puts "#{@name} found a #{treasure.name} worth #{treasure.points} points."
+      puts "#{@name}'s treasures: #{@found_treasures}"
+    end
+
+    def points
+      @found_treasures.values.reduce(0, :+)
+    end
+
+    def each_found_treasure
+      @found_treasures.each do |name, points|
+        yield Treasure.new(name, points)
+      end
+    end
+  end
+
+  if __FILE__ == $0
+    player = Player.new("moe")
+    puts player.name
+    puts player.health
+    player.w00t
+    puts player.health
+    player.blam
+    puts player.health
+  end
+end

data/lib/aobgame/treasure_trove.rb

@@ -0,0 +1,17 @@
+module AobGame
+  Treasure = Struct.new(:name, :points)
+
+  module TreasureTrove
+    def self.random
+      TREASURES.sample
+    end
+    TREASURES = [
+      Treasure.new(:pie, 5),
+      Treasure.new(:bottle, 25),
+      Treasure.new(:hammer, 50),
+      Treasure.new(:skillet, 100),
+      Treasure.new(:broomstick, 200),
+      Treasure.new(:crowbar, 400),
+    ]
+  end
+end

data/spec/aobgame/berserk_player_spec.rb

@@ -0,0 +1,29 @@
+require "aobgame/berserk_player"
+
+module AobGame
+  describe BerserkPlayer do
+    before do
+      @initial_health = 50
+      @player = BerserkPlayer.new("berserker", @initial_health)
+    end
+
+    it "does not go berserk when w00ted up to 5 times" do
+      1.upto(5) { @player.w00t }
+
+      expect(@player.berserk?).to be_falsey
+    end
+
+    it "goes berserk when w00ted more than 5 times" do
+      1.upto(6) { @player.w00t }
+
+      expect(@player.berserk?).to be_truthy
+    end
+
+    it "gets w00ted instead of blammed when it's gone berserk" do
+      1.upto(6) { @player.w00t }
+      1.upto(2) { @player.blam }
+
+      expect(@player.health).to eq(@initial_health + (8 * 15))
+    end
+  end
+end

data/spec/aobgame/clumsy_player_spec.rb

@@ -0,0 +1,50 @@
+require "aobgame/clumsy_player"
+
+module AobGame
+  describe ClumsyPlayer do
+    before do
+      @player = ClumsyPlayer.new("klutz")
+    end
+
+    it "only gets half the point value for each treasure" do
+      expect(@player.points).to eq(0)
+
+      hammer = Treasure.new(:hammer, 50)
+      @player.found_treasure(hammer)
+      @player.found_treasure(hammer)
+      @player.found_treasure(hammer)
+
+      expect(@player.points).to eq(75)
+
+      crowbar = Treasure.new(:crowbar, 400)
+      @player.found_treasure(crowbar)
+
+      expect(@player.points).to eq(275)
+
+      yielded = []
+      @player.each_found_treasure do |treasure|
+        yielded << treasure
+      end
+
+      expect(yielded).to eq([Treasure.new(:hammer, 75), Treasure.new(:crowbar, 200)])
+    end
+
+    context "with a boost factor" do
+      before do
+        @initial_health = 100
+        @boost_factor = 5
+        @player = ClumsyPlayer.new("klutz", @initial_health, @boost_factor)
+      end
+
+      it "has a boost factor" do
+        expect(@player.boost_factor).to eq(5)
+      end
+
+      it "gets boost factor number of w00ts when w00ted" do
+        @player.w00t
+
+        expect(@player.health).to eq(@initial_health + (15 * @boost_factor))
+      end
+    end
+  end
+end

data/spec/aobgame/game_spec.rb

@@ -0,0 +1,65 @@
+require "aobgame/game"
+
+module AobGame
+  describe Game do
+    before do
+      @game = Game.new("Knuckleheads")
+
+      @initial_health = 100
+      @player = Player.new("moe", @initial_health)
+
+      @game.add_player(@player)
+    end
+
+    it "w00ts the player if a high number is rolled" do
+      allow_any_instance_of(Die).to receive(:roll).and_return(5)
+
+      @game.play(2)
+
+      expect(@player.health).to eq(@initial_health + (15 * 2))
+    end
+
+    it "skips the player if a medium number is rolled" do
+      allow_any_instance_of(Die).to receive(:roll).and_return(3)
+
+      @game.play(2)
+
+      expect(@player.health).to eq(@initial_health)
+    end
+
+    it "blams the player if a low number is rolled" do
+      allow_any_instance_of(Die).to receive(:roll).and_return(1)
+
+      @game.play(2)
+
+      expect(@player.health).to eq(@initial_health - (10 * 2))
+    end
+
+    it "assigns a treasure for points during a player's turn" do
+      game = Game.new("Knuckleheads")
+      player = Player.new("moe")
+
+      game.add_player(player)
+
+      game.play(1)
+
+      expect(player.points).not_to be_zero
+    end
+
+    it "computes total points as the sum of all player points" do
+      game = Game.new("Knuckleheads")
+
+      player1 = Player.new("moe")
+      player2 = Player.new("larry")
+
+      game.add_player(player1)
+      game.add_player(player2)
+
+      player1.found_treasure(Treasure.new(:hammer, 50))
+      player1.found_treasure(Treasure.new(:hammer, 50))
+      player2.found_treasure(Treasure.new(:crowbar, 400))
+
+      expect(game.total_points).to eq(500)
+    end
+  end
+end

data/spec/aobgame/player_spec.rb

@@ -0,0 +1,126 @@
+require "aobgame/player"
+require "aobgame/treasure_trove"
+
+module AobGame
+  describe Player do
+    before do
+      $stdout = StringIO.new
+      @initial_health = 150
+      @player = Player.new("larry", @initial_health)
+    end
+
+    it "has a capitalized name" do
+      expect(@player.name).to eq("Larry")
+    end
+
+    it "has an initial health" do
+      expect(@player.health).to eq(150)
+    end
+
+    it "has a string representation" do
+      @player.found_treasure(Treasure.new(:hammer, 50))
+
+      @player.found_treasure(Treasure.new(:hammer, 50))
+
+      expect(@player.to_s).to eq("I'm Larry with health = 150, points = 100, and score = 250.")
+    end
+
+    it "computes a score as the sum of its health and points" do
+      @player.found_treasure(Treasure.new(:hammer, 50))
+      @player.found_treasure(Treasure.new(:hammer, 50))
+
+      expect(@player.score).to eq(250)
+    end
+
+    it "increases health by 15 when w00ted" do
+      @player.w00t
+
+      expect(@player.health).to eq(@initial_health + 15)
+    end
+
+    it "decreases health by 10 when blammed" do
+      @player.blam
+
+      expect(@player.health).to eq(@initial_health - 10)
+    end
+
+    context "with a health greater than 100" do
+      before do
+        @player = Player.new("larry", 150)
+      end
+
+      it "is strong" do
+        expect(@player).to be_strong
+      end
+    end
+
+    context "with a health of 100 or less" do
+      before do
+        @player = Player.new("larry", 100)
+      end
+
+      it "is wimpy" do
+        expect(@player).not_to be_strong
+      end
+    end
+
+    context "in a collection of players" do
+      before do
+        @player1 = Player.new("moe", 100)
+        @player2 = Player.new("larry", 200)
+        @player3 = Player.new("curly", 300)
+
+        @players = [@player1, @player2, @player3]
+      end
+
+      it "is sorted by decreasing score" do
+        expect(@players.sort).to eq([@player3, @player2, @player1])
+      end
+    end
+
+    it "computes points as the sum of all treasure points" do
+      expect(@player.points).to eq(0)
+
+      @player.found_treasure(Treasure.new(:hammer, 50))
+
+      expect(@player.points).to eq(50)
+
+      @player.found_treasure(Treasure.new(:crowbar, 400))
+
+      expect(@player.points).to eq(450)
+
+      @player.found_treasure(Treasure.new(:hammer, 50))
+
+      expect(@player.points).to eq(500)
+    end
+
+    it "yields each found treasure and its total points" do
+      @player.found_treasure(Treasure.new(:skillet, 100))
+      @player.found_treasure(Treasure.new(:skillet, 100))
+      @player.found_treasure(Treasure.new(:hammer, 50))
+      @player.found_treasure(Treasure.new(:bottle, 5))
+      @player.found_treasure(Treasure.new(:bottle, 5))
+      @player.found_treasure(Treasure.new(:bottle, 5))
+      @player.found_treasure(Treasure.new(:bottle, 5))
+      @player.found_treasure(Treasure.new(:bottle, 5))
+
+      yielded = []
+      @player.each_found_treasure do |treasure|
+        yielded << treasure
+      end
+
+      expect(yielded).to eq([
+                           Treasure.new(:skillet, 200),
+                           Treasure.new(:hammer, 50),
+                           Treasure.new(:bottle, 25),
+                         ])
+    end
+
+    it "can be created from a CSV string" do
+      player = Player.from_csv("larry,150")
+
+      expect(player.name).to eq("Larry")
+      expect(player.health).to eq(150)
+    end
+  end
+end

data/spec/aobgame/treasure_trove_spec.rb

@@ -0,0 +1,53 @@
+require "aobgame/treasure_trove"
+
+module AobGame
+  describe Treasure do
+    before do
+      @treasure = Treasure.new(:hammer, 50)
+    end
+
+    it "has a name attribute" do
+      expect(@treasure.name).to eq(:hammer)
+    end
+
+    it "has a points attribute" do
+      expect(@treasure.points).to eq(50)
+    end
+  end
+
+  describe TreasureTrove do
+    it "has six treasures" do
+      expect(TreasureTrove::TREASURES.size).to eq(6)
+    end
+
+    it "has a pie worth 5 points" do
+      expect(TreasureTrove::TREASURES[0]).to eq(Treasure.new(:pie, 5))
+    end
+
+    it "has a bottle worth 25 points" do
+      expect(TreasureTrove::TREASURES[1]).to eq(Treasure.new(:bottle, 25))
+    end
+
+    it "has a hammer worth 50 points" do
+      expect(TreasureTrove::TREASURES[2]).to eq(Treasure.new(:hammer, 50))
+    end
+
+    it "has a skillet worth 100 points" do
+      expect(TreasureTrove::TREASURES[3]).to eq(Treasure.new(:skillet, 100))
+    end
+
+    it "has a broomstick worth 200 points" do
+      expect(TreasureTrove::TREASURES[4]).to eq(Treasure.new(:broomstick, 200))
+    end
+
+    it "has a crowbar worth 400 points" do
+      expect(TreasureTrove::TREASURES[5]).to eq(Treasure.new(:crowbar, 400))
+    end
+
+    it "returns a random treasure" do
+      treasure = TreasureTrove.random
+
+      expect(TreasureTrove::TREASURES).to include(treasure)
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: aobgame
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- André O. Brown
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description: "Just a basic game created for a pretty good course. \n\nHi Joana and
+  David \U0001F44B\U0001F3FE"
+email: andre@aob.com.jm
+executables:
+- aobgame
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README
+- bin/aobgame
+- bin/players.csv
+- lib/aobgame/auditable.rb
+- lib/aobgame/berserk_player.rb
+- lib/aobgame/clumsy_player.rb
+- lib/aobgame/die.rb
+- lib/aobgame/game.rb
+- lib/aobgame/game_turn.rb
+- lib/aobgame/loaded_die.rb
+- lib/aobgame/playable.rb
+- lib/aobgame/player.rb
+- lib/aobgame/treasure_trove.rb
+- spec/aobgame/berserk_player_spec.rb
+- spec/aobgame/clumsy_player_spec.rb
+- spec/aobgame/game_spec.rb
+- spec/aobgame/player_spec.rb
+- spec/aobgame/treasure_trove_spec.rb
+homepage: https://www.andrebrown.ca
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A simple game built as part of a very good course.
+test_files:
+- spec/aobgame/berserk_player_spec.rb
+- spec/aobgame/clumsy_player_spec.rb
+- spec/aobgame/game_spec.rb
+- spec/aobgame/player_spec.rb
+- spec/aobgame/treasure_trove_spec.rb