studio_game_sammy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3b48de88f533e581064caa59a624ccb655f4457a1afd0fb24b80dd1b5ec7e3b
+  data.tar.gz: 71532950a1c2fe6ba8597fe57eb5b6dba7cc65d3aaaeb1bc874a808c92dc3349
+SHA512:
+  metadata.gz: c6ca1f8baff455dee98014019ef5c66e34560cce3a600030d40517d69ff438201617115284d627f823f2b68875495263ff830bd712a5516af45c2f9993e9bebb
+  data.tar.gz: '086e3aa4d9fb4cbd53dce5a5115169e02c4cb6e71b76624be645b632e65eac97b1b40eb2f35d497c6050ea7633f2d4e28d8d7ec03b498779ec52945f6c3c90d3'

data/bin/players.csv

@@ -0,0 +1,3 @@
+Alvin,100
+Simon,60
+Theo,125

data/bin/studio_game

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/studio_game/game"
+require_relative "../lib/studio_game/clumsy_player"
+require_relative "../lib/studio_game/berserk_player"
+
+knuckleheads = StudioGame::Game.new("Knuckleheads")
+
+default_player_file = File.join(File.dirname(__FILE__), "players.csv")
+knuckleheads.load_players (ARGV.shift || default_player_file)
+
+klutz = StudioGame::ClumsyPlayer.new("klutz", 105)
+berserker = StudioGame::BerserkPlayer.new("berserker", 50)
+
+knuckleheads.add_player(klutz)
+knuckleheads.add_player(berserker)
+
+loop do
+  puts "How many game rounds? ('quit' to exit)"
+  user_input = gets.chomp.downcase
+
+  case user_input
+  when /\d+$/
+    knuckleheads.play(user_input.to_i)
+  when "exit", "quit"
+    knuckleheads.print_stats
+    break
+  else
+    puts "Please enter a valid a number or 'quit'."
+  end
+
+  knuckleheads.save_high_scores
+end

data/bin/test_players.csv

@@ -0,0 +1,3 @@
+moe,100
+larry,60
+curly, 125

data/lib/studio_game/auditable.rb

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

data/lib/studio_game/berserk_player.rb

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

data/lib/studio_game/clumsy_player.rb

@@ -0,0 +1,37 @@
+require_relative "player"
+
+module StudioGame
+  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)
+      super(Treasure.new(treasure.name, treasure.points / 2.0))
+    end
+  end
+end
+
+if __FILE__ == $0
+  clumsy = StudioGame::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

data/lib/studio_game/die.rb

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

data/lib/studio_game/game.rb

@@ -0,0 +1,93 @@
+require_relative "player"
+require_relative "game_turn"
+require_relative "treasure_trove"
+
+module StudioGame
+  class Game
+    attr_reader :title
+
+    def initialize(title)
+      @title = title.capitalize
+      @players = []
+    end
+
+    def add_player(player)
+      @players << player
+    end
+
+    def load_players(from_file)
+      File
+        .readlines(from_file)
+        .each { |line| add_player(Player.from_csv(line)) }
+    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 { |player| file.puts player.format_score }
+      end
+    end
+
+    def play(rounds)
+      puts "There are #{@players.size} players in #{@title}:"
+
+      @players.each { |player| puts player }
+
+      StudioGame::TreasureTrove.print_treasures
+
+      1.upto(rounds) do |number|
+        status = yield if block_given?
+
+        break if !status.nil? && status
+        puts "\nRound #{number}:"
+        @players.each do |player|
+          StudioGame::GameTurn.take_turn(player)
+          puts player
+        end
+      end
+    end
+
+    def print_name_and_health(player)
+      puts "#{player.name} (#{player.health})"
+    end
+
+    def total_points
+      @players.reduce(0) { |sum, player| sum + player.points }
+    end
+
+    def print_stats
+      strong, wimpy = @players.partition { |player| player.strong? }
+
+      puts "\n#{@title} Statistics:"
+
+      puts "\n#{strong.size} strong players:"
+      strong.each { |player| print_name_and_health(player) }
+
+      puts "\n#{wimpy.size} wimpy players:"
+      wimpy.each { |player| print_name_and_health(player) }
+
+      puts "\n#{@title} High Scores:"
+      @players.sort.each { |player| puts player.format_score }
+
+      @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
+      end
+
+      puts "".ljust(20, "*")
+      puts "#{total_points} points from treasures found"
+      puts "".ljust(20, "*")
+    end
+  end
+end
+
+if __FILE__ == $0
+  knuckleheads = StudioGame::Game.new("Knuckleheads")
+  knuckleheads.add_player(Player.new("moe"))
+  knuckleheads.add_player(Player.new("larry", 60))
+  knuckleheads.add_player(Player.new("curly", 125))
+
+  knuckleheads.play
+end

data/lib/studio_game/game_turn.rb

@@ -0,0 +1,22 @@
+require_relative "player"
+require_relative "die"
+
+module StudioGame
+  module GameTurn
+    def self.take_turn(player)
+      die = Die.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/studio_game/loaded_die.rb

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

data/lib/studio_game/playable.rb

@@ -0,0 +1,17 @@
+module StudioGame
+  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/studio_game/player.rb

@@ -0,0 +1,80 @@
+require_relative "treasure_trove"
+require_relative "playable"
+
+module StudioGame
+  class Player
+    # by default object state is private (meaning instance variables)
+    # to make them public, we need to use the attr_accessor method -- short hand for getter and setter methods
+    # attr_accessor -- creates getter and setter methods
+    # attr_reader -- for getter methods
+    # attr_writer -- for setter methods
+
+    # virtual attribute -- a derived attribute
+    # self in class in ruby works the same as this in Java
+    # similar to how scopes go from inner to outer
+    # (parent scope tree trace to find definition for variable or function)
+    include Playable
+    attr_accessor :name, :health
+
+    def initialize(name, health = 100)
+      @name = name.capitalize
+      @health = health
+      @found_treasures = Hash.new(0)
+    end
+
+    def self.from_csv(string)
+      name, health = string.split(",")
+      Player.new(name, Integer(health))
+    end
+
+    def score
+      @health + points
+    end
+
+    def say_hello
+      "I'm #{@name} with a health of #{@health}."
+    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 { |name, points| yield Treasure.new(name, points) }
+    end
+
+    def format_score
+      "#{@name.ljust(20, ".")} #{score}"
+    end
+
+    # helper methods
+    def to_s
+      "I'm #{@name} with health=#{@health}, points=#{points}, and scores=#{score}."
+    end
+
+    def name=(name)
+      @name = name.capitalize
+    end
+
+    # by default, sort happens in descending order
+    def <=>(other)
+      other.score <=> score
+    end
+  end
+end
+
+if __FILE__ == $0
+  player = StudioGame::Player.new("moe")
+  puts player.name
+  puts player.health
+  player.w00t
+  puts player.health
+  player.blam
+  puts player.health
+end

data/lib/studio_game/treasure_trove.rb

@@ -0,0 +1,27 @@
+module StudioGame
+  Treasure = Struct.new(:name, :points)
+
+  module TreasureTrove
+    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)
+    ]
+
+    def self.random
+      TREASURES.sample
+    end
+
+    def self.print_treasures
+      puts "\nThere are #{TREASURES.size} treasures to be found:"
+      TREASURES.each do |treasure|
+        puts "A #{treasure.name} is worth #{treasure.points} points."
+      end
+    end
+  end
+end
+
+puts TreasureTrove::TREASURES if __FILE__ == $0

data/spec/studio_game/berserk_player_spec.rb

@@ -0,0 +1,30 @@
+require "studio_game/berserk_player"
+
+module StudioGame
+  describe BerserkPlayer do
+    before do
+      $stdout = StringIO.new
+      @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/studio_game/clumsy_player_spec.rb

@@ -0,0 +1,44 @@
+require "studio_game/clumsy_player"
+
+module StudioGame
+  describe ClumsyPlayer do
+    before do
+      $stdout = StringIO.new
+      @boost_factor = 2
+      @initial_health = 100
+      @player = ClumsyPlayer.new("klutz", @initial_health, @boost_factor)
+    end
+
+    it "has a boost factor" do
+      expect(@player.boost_factor).to eq(@boost_factor)
+    end
+
+    it "gets boosted when w00ted" do
+      @player.w00t
+      expect(@player.health).to eq(@initial_health + (15 * @boost_factor))
+    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 { |treasure| yielded << treasure }
+
+      expect(yielded).to eq(
+        [Treasure.new(:hammer, 75), Treasure.new(:crowbar, 200)]
+      )
+    end
+  end
+end

data/spec/studio_game/game_spec.rb

@@ -0,0 +1,73 @@
+require "studio_game/game"
+require "studio_game/player"
+
+module StudioGame
+  describe Game do
+    before do
+      $stdout = StringIO.new
+      @game = Game.new("Knuckleheads")
+      @initial_health = 100
+      @player = Player.new("moe", @initial_health)
+      @game.add_player(@player)
+    end
+
+    it "returns a capitalized title" do
+      expect(@game.title).to eq("Knuckleheads")
+    end
+
+    context "simulating game play" do
+      rounds = 2
+      it "w00ts the player if a high number is rolled" do
+        allow_any_instance_of(Die).to receive(:roll).and_return(5)
+        @game.play(rounds)
+
+        expect(@player.health).to eq(@initial_health + (15 * rounds))
+      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(rounds)
+
+        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(rounds)
+
+        expect(@player.health).to eq(@initial_health - (10 * rounds))
+      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 eq(0)
+      end
+    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))
+
+      total_points = player1.points + player2.points
+
+      expect(game.total_points).to eq(total_points)
+    end
+  end
+end

data/spec/studio_game/player_spec.rb

@@ -0,0 +1,138 @@
+require "studio_game/player"
+require "studio_game/treasure_trove"
+
+module StudioGame
+  describe Player do
+    before do
+      $stdout = StringIO.new
+      @initial_health = 150
+      @initial_name = "larry"
+      @player = Player.new(@initial_name, @initial_health)
+      @treasure = Treasure.new(:hammer, 50)
+    end
+
+    it "has a capitalized name" do
+      @initial_name.capitalize!
+      expect(@player.name).to eq(@initial_name)
+    end
+
+    it "has an initial health" do
+      expect(@player.health).to eq(@initial_health)
+    end
+
+    it "has a string representation" do
+      @initial_name.capitalize!
+      @player.found_treasure(@treasure)
+      @player.found_treasure(@treasure)
+
+      expect(@player.to_s).to eq(
+        "I'm #{@initial_name} with health=#{@player.health}, points=#{@player.points}, and scores=#{@player.score}."
+      )
+    end
+
+    it "formats player name and score" do
+      @initial_name.capitalize!
+      @player.found_treasure(@treasure)
+      @player.found_treasure(@treasure)
+
+      result = "#{@initial_name}".ljust(20, ".") + " 250"
+
+      expect(@player.format_score).to eq(result)
+    end
+
+    it "computes a score as the sum of its health and points" do
+      @player.found_treasure(@treasure)
+      @player.found_treasure(@treasure)
+
+      player_score = @player.health + @treasure.points * 2
+
+      expect(@player.score).to eq(player_score)
+    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 "player strength" do
+      before { @player = Player.new(@initial_name, @initial_health) }
+
+      it "is strong when health is greater than 100" do
+        expect(@player.strong?).to be_truthy
+      end
+
+      it "is wimpy when health is less than 100" do
+        @player = Player.new(@initial_name, 100)
+
+        expect(@player.strong?).to be_falsy
+      end
+    end
+
+    context "sorting a collection of players" do
+      before do
+        @player1 = Player.new("moe", 100)
+        @player2 = Player.new(@initial_name, 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 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))
+
+      yields_treasures = []
+
+      @player.each_found_treasure { |treasure| yields_treasures << treasure }
+
+      expect(yields_treasures).to eq(
+        [
+          Treasure.new(:skillet, 200),
+          Treasure.new(:hammer, 50),
+          Treasure.new(:bottle, 25)
+        ]
+      )
+    end
+
+    it "can be created from a CSV string" do
+      @initial_name.capitalize!
+      player = Player.from_csv("larry,150")
+      expect(player.name).to eq(@initial_name)
+      expect(player.health).to eq(@initial_health)
+    end
+  end
+end

data/spec/studio_game/treasure_trove_spec.rb

@@ -0,0 +1,53 @@
+require "studio_game/treasure_trove"
+
+module StudioGame
+  describe Treasure do
+    before { @treasure = Treasure.new(:hammer, 50) }
+
+    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
+    before { @treasures = TreasureTrove::TREASURES }
+
+    it "has six treasures" do
+      expect(@treasures.size).to eq(6)
+    end
+
+    it "has a pie worth 5 points" do
+      expect(@treasures[0]).to eq(Treasure.new(:pie, 5))
+    end
+
+    it "has a bottle worth 25 points" do
+      expect(@treasures[1]).to eq(Treasure.new(:bottle, 25))
+    end
+
+    it "has a hammer worth 50 points" do
+      expect(@treasures[2]).to eq(Treasure.new(:hammer, 50))
+    end
+
+    it "has a skillet worth 100 points" do
+      expect(@treasures[3]).to eq(Treasure.new(:skillet, 100))
+    end
+
+    it "has a broomstick worth 200 points" do
+      expect(@treasures[4]).to eq(Treasure.new(:broomstick, 200))
+    end
+
+    it "has a crowbar worth 400 points" do
+      expect(@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,89 @@
+--- !ruby/object:Gem::Specification
+name: studio_game_sammy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Samuel Oyediran
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+description: ''
+email:
+executables:
+- studio_game
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README
+- bin/players.csv
+- bin/studio_game
+- bin/test_players.csv
+- lib/studio_game/auditable.rb
+- lib/studio_game/berserk_player.rb
+- lib/studio_game/clumsy_player.rb
+- lib/studio_game/die.rb
+- lib/studio_game/game.rb
+- lib/studio_game/game_turn.rb
+- lib/studio_game/loaded_die.rb
+- lib/studio_game/playable.rb
+- lib/studio_game/player.rb
+- lib/studio_game/treasure_trove.rb
+- spec/studio_game/berserk_player_spec.rb
+- spec/studio_game/clumsy_player_spec.rb
+- spec/studio_game/game_spec.rb
+- spec/studio_game/player_spec.rb
+- spec/studio_game/treasure_trove_spec.rb
+homepage:
+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.3.7
+signing_key:
+specification_version: 4
+summary: Studio Game is a command line game that assigns random treasures, funds and
+  defunds a list of players randomly.
+test_files:
+- spec/studio_game/berserk_player_spec.rb
+- spec/studio_game/clumsy_player_spec.rb
+- spec/studio_game/game_spec.rb
+- spec/studio_game/player_spec.rb
+- spec/studio_game/treasure_trove_spec.rb