vic_studio_game 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 286f9a5ad2d334e716dae0bec8983091a5cfa37649d4f8481444906ab92b5d22
+  data.tar.gz: 8a55b17a2f8caaf8be6b44d9170d531d2449bfa1836122de05af21c19966b3b0
+SHA512:
+  metadata.gz: e3ec77cc862d7e8b6d7b9155aa4288adc3a5176b1cae53447ff50725b1e9637ab707f942b33595629435ca74ebd33771bd672159ab60d9778214d825ab7f309b
+  data.tar.gz: b6fdf1360301a8ffb42f58a367c7bb689f9721768b3d50bc9195ef0702c4d934dbcc131f0a02643a3ed4adb5cbe5bb474176e786b50ccc06ab7e9c5f93f08f8c

data/LICENCE

@@ -0,0 +1 @@
+Just use it!

data/README

@@ -0,0 +1 @@
+Game implemented as part of the PragmaticStudio Ruby course.

data/bin/my_favorite_players.csv

@@ -0,0 +1,3 @@
+Alex,100
+Vic,60
+Pestunia,125

data/bin/players.csv

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

data/bin/studio_game

@@ -0,0 +1,32 @@
+#!/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_players_file = File.join(File.dirname(__FILE__), "players.csv")
+knuckleheads.load_players(ARGV.shift || default_players_file)
+
+klutz = StudioGame::ClumsyPlayer.new("klutz", 105)
+knuckleheads.add_player(klutz)
+
+berserker = StudioGame::BerserkPlayer.new("berserker", 50)
+knuckleheads.add_player(berserker)
+
+loop do
+  puts "\nHow many game rounds? ('quit' to exit)"
+  answer = gets.chomp.downcase
+  case answer
+  when /^\d+$/
+    knuckleheads.play(answer.to_i)
+  when 'quit', 'exit', 'q', 'e'
+    knuckleheads.print_stats
+    break
+  else
+    puts "Please enter a number or 'quit'"
+  end
+end
+
+knuckleheads.save_high_scores

data/lib/studio_game/auditable.rb

@@ -0,0 +1,7 @@
+module StudioGame
+  module Auditable
+    def audit
+      puts "Rolled a #{self.number} (#{self.class})"
+    end
+  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
+      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/studio_game/clumsy_player.rb

@@ -0,0 +1,40 @@
+require_relative 'player'
+require_relative 'treasure_trove'
+
+module StudioGame
+  class ClumsyPlayer < Player
+
+    attr_accessor :boost_factor
+
+    def initialize(name, health=100, boost_factor=1)
+      super(name, health)
+      @boost_factor = boost_factor
+    end
+
+    def found_treasure(treasure)
+      damaged_treasure = Treasure.new(treasure.name, treasure.points / 2.0)
+      super(damaged_treasure)
+    end
+
+    def w00t
+      @boost_factor.times { super }
+    end
+  end
+
+  if __FILE__ == $0
+    clumsy = ClumsyPlayer.new("klutz", 105)
+
+    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/studio_game/die.rb

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

data/lib/studio_game/game.rb

@@ -0,0 +1,128 @@
+require_relative 'player'
+require_relative 'die'
+require_relative 'game_turn'
+require_relative 'treasure_trove'
+require 'csv'
+
+module StudioGame
+  class Game
+    attr_reader :name
+
+    def initialize(title)
+      @title = title
+      @players = []
+    end
+
+    def add_player(player)
+      @players << player
+    end
+
+    def play(rounds)
+      puts "There are #{@players.size} players in #{@title}: "
+
+      @players.each do |player|
+        puts player
+      end
+
+      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_stats
+      strong_players, wimpy_players = @players.partition { |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
+
+      @players.sort.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 "\n#{@title} High Scores:"
+      @players.sort.each do |player|
+        puts high_score_entry(player)
+      end
+    end
+
+    def to_s
+      "Game - #{@title}\n" +
+      "Players:\n" +
+      @players.join("\n")
+    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 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 save_high_scores(to_file="high_scores.txt")
+      File.open(to_file, "w") do |file|
+        file.puts "\n#{@title} High Scores:"
+        @players.sort.each do |player|
+          file.puts high_score_entry(player)
+        end
+      end
+    end
+
+    def high_score_entry(player)
+      formatted_name = player.name.ljust(20, '.')
+      "#{formatted_name} #{player.score}"
+    end
+
+  end
+
+  if __FILE__ == $0
+
+    game = Game.new("Boxingring")
+
+    player1 = Player.new("moe")
+    player2 = Player.new("larry", 60)
+    player3 = Player.new("curly", 125)
+
+    game.add_player(player1)
+    game.add_player(player2)
+    game.add_player(player3)
+
+    puts game
+  end
+end

data/lib/studio_game/game_turn.rb

@@ -0,0 +1,22 @@
+require_relative 'player'
+require_relative 'die'
+require_relative 'treasure_trove'
+
+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
+
+      player.found_treasure(TreasureTrove.random)
+
+    end
+  end
+end

data/lib/studio_game/loaded_die.rb

@@ -0,0 +1,16 @@
+require_relative "auditable"
+
+module StudioGame
+  class LoadedDie
+    include Auditable
+
+    attr_reader :number
+
+    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 w00t
+      self.health += 15
+      puts "#{self.name} got w00ted!"
+    end
+
+    def blam
+      self.health -= 10
+      puts "#{self.name} got blammed!"
+    end
+
+    def strong?
+      self.health > 100
+    end
+  end
+end

data/lib/studio_game/player.rb

@@ -0,0 +1,59 @@
+require_relative "playable"
+
+module StudioGame
+  class Player
+
+    include Playable
+
+    attr_accessor :name, :health
+
+    def initialize(name, health=100)
+      @name = name.capitalize
+      @health = health
+      @found_treasures = Hash.new(0)
+    end
+
+    def to_s
+      "I'm #{@name} with health = #{@health}, points = #{points}, and score = #{score}."
+    end
+
+    def score
+      @health + points
+    end
+
+    def <=>(other)
+      other.score <=> self.score
+    end
+
+    def found_treasure(treasure)
+      @found_treasures[treasure.name] += treasure.points
+      puts "#{@name} found a #{treasure.name} worth #{treasure.points} points."
+    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
+
+    def self.from_csv(player_data)
+      name, health = player_data
+      player = Player.new(name, Integer(health))
+    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/studio_game/treasure_trove.rb

@@ -0,0 +1,18 @@
+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
+  end
+end

data/spec/studio_game/berserk_player_spec.rb

@@ -0,0 +1,46 @@
+require "studio_game/berserk_player"
+
+module StudioGame
+  describe BerserkPlayer do
+
+    before do
+      $stdout = StringIO.new
+      @initial_health = 100
+      @player = BerserkPlayer.new("boris", @initial_health)
+    end
+
+    it "should not be berserk when created" do
+      @player.berserk?.should be_false
+    end
+
+    it "should not go berserk when w00t-ed 5 times or less" do
+      5.times do
+        @player.w00t
+        @player.berserk?.should be_false
+      end
+    end
+
+    it "should go berserk when w00t-ed the 6th time" do
+      6.times { @player.w00t }
+
+      @player.berserk?.should be_true
+    end
+
+    it "should remain berserk when w00t-ed more than 6 times" do
+      8.times { @player.w00t }
+
+      @player.berserk?.should be_true
+    end
+
+    it "should w00t instead of blam he's gone berserk" do
+      # given the player has gone berserk
+      6.times { @player.w00t }
+
+      # when
+      2.times { @player.blam }
+
+      # then
+      @player.health.should == @initial_health + (8 * 15)
+    end
+  end
+end

data/spec/studio_game/clumsy_player_spec.rb

@@ -0,0 +1,57 @@
+require 'studio_game/clumsy_player'
+
+module StudioGame
+  describe ClumsyPlayer do
+
+    context "when finds a new treasure" do
+
+      before do
+        $stdout = StringIO.new
+        @player = ClumsyPlayer.new("klutz")
+      end
+
+      it "only gets half of its points" do
+        @player.points.should == 0
+
+        hammer = Treasure.new(:hammer, 50)
+        @player.found_treasure(hammer)
+        @player.found_treasure(hammer)
+        @player.found_treasure(hammer)
+
+        @player.points.should == 75
+
+        crowbar = Treasure.new(:crowbar, 400)
+        @player.found_treasure(crowbar)
+
+        @player.points.should == 275
+
+        yielded = []
+        @player.each_found_treasure do |treasure|
+          yielded << treasure
+        end
+
+        yielded.should == [Treasure.new(:hammer, 75), Treasure.new(:crowbar, 200)]
+      end
+
+    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
+        @player.boost_factor.should == 5
+      end
+
+      it "gets boost factor number of w00ts when w00ted" do
+        @player.w00t
+
+        @player.health.should == @initial_health + (15 * @boost_factor)
+      end
+    end
+
+  end
+end

data/spec/studio_game/game_spec.rb

@@ -0,0 +1,68 @@
+require 'studio_game/game'
+
+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 "w00ts the player if a high number is rolled" do
+          Die.any_instance.stub(:roll).and_return(5)
+
+          # when
+          @game.play(2)
+
+          # then
+          @player.health.should == @initial_health + (15 * 2)
+      end
+
+      it "skips the player if a medium number is rolled" do
+          Die.any_instance.stub(:roll).and_return(3)
+
+          @game.play(2)
+
+          @player.health.should == @initial_health
+      end
+
+      it "blams the player if a low number is rolled" do
+          Die.any_instance.stub(:roll).and_return(1)
+
+          @game.play(2)
+
+          @player.health.should == @initial_health - (10 * 2)
+      end
+
+      it "assigns a treasure for points during a player's turn" do
+        @game.play(1)
+
+        @player.points.should_not 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))
+
+        game.total_points.should == 500
+      end
+
+  end
+end

data/spec/studio_game/player_spec.rb

@@ -0,0 +1,117 @@
+require 'studio_game/player'
+require 'studio_game/treasure_trove'
+
+module StudioGame
+  describe Player do
+
+      before do
+          $stdout = StringIO.new
+          @player = Player.new("larry", 150)
+          @initial_health = 150
+      end
+
+      it "has a capitalized name" do
+          @player.name.should == "Larry"
+      end
+
+      it "has an initial health" do
+          @player.health.should == 150
+      end
+
+      it "has a string representation" do
+        @player.found_treasure(Treasure.new(:hammer, 50))
+        @player.found_treasure(Treasure.new(:hammer, 50))
+
+        @player.to_s.should == "I'm Larry with health = 150, points = 100, and score = 250."
+      end
+
+      it "increases health by 15 when w00ted" do
+          @player.w00t
+          @player.health.should == @initial_health + 15
+      end
+
+      it "decreases health by 10 when blammed" do
+          @player.blam
+          @player.health.should == @initial_health - 10
+      end
+
+      context "with a health greater than 100" do
+          before do
+            @player = Player.new("larry", 150)
+          end
+
+          it "is strong" do
+            @player.should 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
+            @player.should_not 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
+          @players.sort.should == [@player3, @player2, @player1]
+        end
+      end
+
+      it "computes points as the sum of all treasure points" do
+        @player.points.should == 0
+
+        @player.found_treasure(Treasure.new(:hammer, 50))
+
+        @player.points.should == 50
+
+        @player.found_treasure(Treasure.new(:crowbar, 400))
+
+        @player.points.should == 450
+
+        @player.found_treasure(Treasure.new(:hammer, 50))
+
+        @player.points.should == 500
+      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))
+
+        @player.score.should == 250
+      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
+
+        yielded.should == [
+          Treasure.new(:skillet, 200),
+          Treasure.new(:hammer, 50),
+          Treasure.new(:bottle, 25)
+        ]
+      end
+  end
+end

data/spec/studio_game/treasure_trove_spec.rb

@@ -0,0 +1,59 @@
+require 'studio_game/treasure_trove'
+
+module StudioGame
+  describe Treasure do
+
+    before do
+      @treasure = Treasure.new(:hammer, 50)
+    end
+
+    it "has a name attribute" do
+      @treasure.name.should == :hammer
+    end
+
+    it "has a points attribute" do
+      @treasure.points.should == 50
+    end
+
+  end
+
+  describe TreasureTrove do
+
+    it "has six treasures" do
+      TreasureTrove::TREASURES.size.should == 6
+    end
+
+    it "has a pie worth 5 points" do
+      TreasureTrove::TREASURES[0].should == Treasure.new(:pie, 5)
+    end
+
+    it "has a bottle worth 25 points" do
+      TreasureTrove::TREASURES[1].should == Treasure.new(:bottle, 25)
+    end
+
+    it "has a hammer worth 50 points" do
+      TreasureTrove::TREASURES[2].should == Treasure.new(:hammer, 50)
+    end
+
+    it "has a skillet worth 100 points" do
+      TreasureTrove::TREASURES[3].should == Treasure.new(:skillet, 100)
+    end
+
+    it "has a broomstick worth 200 points" do
+      TreasureTrove::TREASURES[4].should == Treasure.new(:broomstick, 200)
+    end
+
+    it "has a crowbar worth 400 points" do
+      TreasureTrove::TREASURES[5].should == Treasure.new(:crowbar, 400)
+    end
+
+    it "returns a random treasure" do
+      treasure = TreasureTrove.random
+
+      TreasureTrove::TREASURES.should include(treasure)
+
+      # or use alternate expectation syntax:
+      # expect(TreasureTrove::TREASURES).to include(treasure)
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: vic_studio_game
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- vic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-21 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: 'Game implemented as part of the PragmaticStudio Ruby course.
+
+  '
+email: vic@vic.com
+executables:
+- studio_game
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENCE
+- README
+- bin/my_favorite_players.csv
+- bin/players.csv
+- bin/studio_game
+- 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: https://vic.vic.com
+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.3
+signing_key:
+specification_version: 4
+summary: Pragmatic Studio Game Implementation
+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