studio_game_2021 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 818452ec448a8fa2b9e3b038a0f0d31dce944323eda4d0b8f0db1c3f60abd8d3
+  data.tar.gz: ab618b24bea3a53049418104a82a032b2200fc2b68db9ad3fd51ee0b79a78e2a
+SHA512:
+  metadata.gz: ee98d43574e61ad0a19c2f72dba44e7cbc53e70e7fb0db6b407927bbb479c396a7f6543daab0b8c9e65ffde76fd98cd8bbd7a4f4c2453434bca569b6ee8722b7
+  data.tar.gz: 32d007d8d9b8cfb66b58251ce4ec9626075cb8e45143aca251ffdc3be6ae010a4ddad6cc7d1a50f48b4c3df3c841f02da0bfdff0e37a2057a0fb0c74cb0c2e40

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 Becca Williams (Essentialist Dev)
+
+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,136 @@
+
+<!-- TABLE OF CONTENTS -->
+<details open="open">
+<summary>Table of Contents</summary>
+<ol>
+<li>
+<a href="#about-the-project">About The Project</a>
+<ul>
+<li><a href="#built-with">Built With</a></li>
+</ul>
+</li>
+<li>
+<a href="#getting-started">Getting Started</a>
+<ul>
+<li><a href="#prerequisites">Prerequisites</a></li>
+<li><a href="#installation">Installation</a></li>
+</ul>
+</li>
+<li><a href="#usage">Usage</a></li>
+<li><a href="#roadmap">Roadmap</a></li>
+<li><a href="#contributing">Contributing</a></li>
+<li><a href="#license">License</a></li>
+<li><a href="#contact">Contact</a></li>
+<li><a href="#acknowledgements">Acknowledgements</a></li>
+</ol>
+</details>
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+[![Product Name Screen Shot][Screenshot of gameplay and test list]](https://www.dropbox.com/s/mu1rrbx2mqowjkn/studio-game.png?dl=0)
+
+This game is a project built following the [Pragmatic Studio Ruby Course](https://online.pragmaticstudio.com/courses/ruby/). I absolutely adored going through this course, because it was unlike other courses in that the main focus wasn't syntax, but how to build a principle-driven, object-oriented program that contains many of the skills we'd need to build real-world projects. The instructors purposefully created exercises to let us build a program using the skills they demonstrated by building a different program. This wasn't a copy and paste kind of course. This game was actually my second run-through, where I test-drove everything from the start based on the objectives only.
+
+Skills I valued developing further with this project:
+- Test-driven development (50+ tests).
+- Using inheritance to model "is-a" relationships. For example, a clumsy player *is a* kind of player.
+- Using mixins (modules) to reuse behaviours that are common between classes, but should not be modeled with an inheritance relationship. A good tip was to look for 'able' behaviors in a class to extract, like 'playable', 'printable', 'taxable' etc.
+- Using a file block which lets you add in class usage examples that are only run when you run the class file specifically.
+- Overriding default methods (like sort, and renaming things so that they keep a specific format)
+
+Things I struggled with:
+- Testing behaviour that uses blocks. I had a lightbulb moment when I realised I should test the behaviour performed inside the block on a single item. Testing the output of an entire block is like testing Ruby syntax works. Alternatively, test the before and after state of something that changes as a result of using a block. Cooool.
+- Puts. It felt wrong to use puts to show the output in the console. I'd like to learn how to seperate the view logic for a command-line project later.
+
+Things I did to make it my own:
+- Wrote a lot more tests for my second run-through.
+- Noticed and extracted further 'able' behaviours into modules (like printing stats, formatting output and handling csv files).
+
+
+### Built With
+
+* [Ruby (language)](https://www.ruby-lang.org/en/)
+* [RSpec (framework)](https://rspec.info/)
+* [Vim (text-editor)](https://www.vim.org/)
+
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+To get a local copy up and running follow these steps:
+
+### Prerequisites
+
+This is an example of how to list things you need to use the software and how to install them.
+* gem
+```sh
+npm install npm@latest -g
+```
+
+### Installation
+
+1. Install the gem
+```sh
+gem install studio_game_2021
+```
+
+<!-- USAGE EXAMPLES -->
+## Usage
+To play a game from the command-line, open a new command project and run the command-line script like so:
+```sh
+studio_game
+```
+
+Or, if you'd like to use the game as a library, here's an example of how to use it in `irb`. You can also check the bottom of each class or module file for further usage instructions
+
+```
+>> require 'studio_game/game'
+=> true
+
+>> game = StudioGame::Game.new("Knuckleheads")
+=> #<StudioGame::Game:0x007fdea10252d8 @title="Knuckleheads", @players=[]>
+
+>> player = StudioGame::Player.new("Moe", 90)
+=> I'm Moe with health = 90, points = 0, and score = 90.
+
+>> game.add_player(player)
+=> [I'm Moe with health = 90, points = 0, and score = 90.]
+
+>> game.play(1)
+```
+
+
+<!-- ROADMAP -->
+## Roadmap
+
+I plan to customize this game further now that I have a solid foundation to explore from. It'll be fun to let the players interact with each other more, like swapping treasures, and maybe add some kind of board game with it's own features. That's my next focus.
+
+
+## Contributing
+
+Feel free to fork this project and play around with it. Open to feedback-related pr requests.
+
+
+  <!-- LICENSE -->
+## License
+
+  Distributed under the MIT License. See `LICENSE` for more information.
+
+
+
+  <!-- CONTACT -->
+## Contact
+
+  Becca - [@becca9941](https://twitter.com/Becca9941) - becca@essentialistdev.com
+
+  Project Link: [https://gitlab.com/EssentialistDev/studio-game](https://gitlab.com/EssentialistDev/studio-game)
+
+
+
+  <!-- ACKNOWLEDGEMENTS -->
+## Acknowledgements
+
+- [Pragmatic Studio](https://online.pragmaticstudio.com/courses/ruby/) for empowering me with awesome new development skills.
+- [Best-README-Template](https://github.com/Becca9941/Best-README-Template) for helping me write a README for this project.

data/bin/avatar_players.csv

@@ -0,0 +1,7 @@
+aang,100
+katara,100
+sokka,100
+zuko,100
+toph,100
+appa,100
+iroh,100

data/bin/players.csv

@@ -0,0 +1,6 @@
+rick,150
+morty,120
+pickle rick,150
+summer,110
+beth,100
+jerry,50

data/bin/studio_game

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

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,33 @@
+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
+end
+
+if __FILE__==$0
+  berserker = BerserkPlayer.new("berserker", 100)
+
+  6.times { berserker.w00t }
+  2.times { berserker.blam }
+
+  puts berserker.health
+end

data/lib/studio_game/clumsy_player.rb

@@ -0,0 +1,27 @@
+require_relative 'player'
+require_relative 'treasure_trove'
+
+module StudioGame
+  class ClumsyPlayer < Player
+    def find_treasure(treasure = TreasureTrove.random_treasure)
+      damaged_treasure = Treasure.new(treasure.name, treasure.points / 2)
+      super(damaged_treasure)
+    end
+  end
+end
+
+if __FILE__ == $0
+  clumsy = ClumsyPlayer.new("klutz")
+
+  hammer = Treasure.new("hammer", 100)
+
+  puts clumsy.find_treasure(hammer)
+  puts clumsy.find_treasure(hammer)
+  puts clumsy.find_treasure(hammer)
+
+  crowbar = Treasure.new("crowbar", 400)
+
+  puts clumsy.find_treasure(crowbar)
+
+  puts clumsy.found_treasures
+end

data/lib/studio_game/die.rb

@@ -0,0 +1,24 @@
+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
+
+if __FILE__==$0
+  die = Die.new
+  die.number
+end

data/lib/studio_game/formatting.rb

@@ -0,0 +1,11 @@
+module StudioGame
+  module Formatting
+    def format_dot_spacing(name, attribute_value)
+      "#{name.ljust(25, ".")} #{attribute_value}"
+    end
+
+    def format_section_title(title)
+      "\n" + " #{title.upcase} ".center(20, "-")
+    end
+  end
+end

data/lib/studio_game/game.rb

@@ -0,0 +1,63 @@
+require_relative 'player'
+require_relative 'game_turn'
+require_relative 'treasure_trove'
+require_relative 'formatting'
+require_relative 'handle_csv'
+
+module StudioGame
+  class Game
+    include Printable
+    include HandleCSV
+
+    attr_reader :title, :players
+    def initialize(title = "Game", players = [])
+      @title = title.capitalize
+      @players = players
+    end
+
+    def title=(new_title)
+      @title = new_title.capitalize
+    end
+
+    def add_player(player)
+      @players << player
+    end
+
+    def remove_player(player)
+      @players.delete(player)
+    end
+
+    def play(rounds = 1)
+      print_player_information
+      print_treasure_trove
+
+      1.upto(rounds) do |round|
+        if block_given?
+          break if yield
+        end
+
+        puts "\nROUND #{round}:"
+
+        @players.each do |player|
+          GameTurn.take_turn(player)
+        end
+      end
+    end
+  end
+end
+
+if __FILE__==$0
+  game = Game.new
+
+  # players
+  larry = Player.new("larry")
+  curly = Player.new("curly")
+  moe = Player.new("moe")
+
+  game.add_player(larry)
+  game.add_player(curly)
+  game.add_player(moe)
+  game.remove_player(curly)
+
+  game.play
+end

data/lib/studio_game/game_stats.rb

@@ -0,0 +1,47 @@
+module StudioGame
+  module GameStats
+
+    def print_stats
+      puts format_section_title("game stats")
+      print_strength_stats
+      print_treasure_stats
+      puts total_points
+      print_high_scores
+    end
+
+    def print_strength_stats
+
+      strong_players, wimpy_players = players.partition { |player| player.strong? }
+
+      puts "\nThere are #{strong_players.size} strong players:"
+      strong_players.each do |player|
+        puts player.print_health_status
+      end
+
+      puts "\nThere are #{wimpy_players.size} wimpy players:"
+      wimpy_players.each do |player|
+        puts player.print_health_status
+      end
+
+    end
+
+    def print_treasure_stats
+      players.each do |player|
+        player.print_treasures
+      end
+    end
+
+    def total_points
+      players.reduce(0) { |sum, player| sum += player.points }
+    end
+
+
+    def print_high_scores
+      puts "\n#{title} High Scores:"
+      players.sort.each do |player|
+        puts player.print_score
+      end
+    end
+
+  end
+end

data/lib/studio_game/game_turn.rb

@@ -0,0 +1,23 @@
+require_relative 'player'
+require_relative 'die'
+require_relative 'loaded_die'
+
+module StudioGame
+  module GameTurn
+    def self.take_turn(player)
+      die = Die.new
+      #die = LoadedDie.new
+
+      puts player.find_treasure
+
+      case die.roll
+      when 1..2
+        player.w00t
+      when 3..4
+        puts "#{player.name} was skipped!"
+      else
+        player.blam
+      end
+    end
+  end
+end