studio_game_alec 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7568733f543e2785e59632a7e4faaecc2124dd3b3f2ee312428944327f4c057
-  data.tar.gz: cd449ee1a87747501e6224a5b0c58eaa0c74df020f39639b30a319de1117fffe
+  metadata.gz: b7ef493cd57a4029f2f8fb25822758b15615a7aa9182c7f147fe5dad9a943c01
+  data.tar.gz: 7fcd9f2bf8bb475d5dbe9a45d5ce8e782b6c45ab8a0188d62890c21712053bb9
 SHA512:
-  metadata.gz: 919f706a3dc21b5dc73fbe2223bfd1ed544ccea35cc8a8ae837fb54efe0b8af79f3f27f647682bceede1ab9f9bf0862c5361b351df604d9e51926bc53584db77
-  data.tar.gz: be7a75f072dac13eb99e4f3bb063831562b3cc22a234b5e38972a3435bf71381cb8039402cb0c08371e509ef17f9fb7b1bb9485f4ad7e17e9201c460a5da67a1
+  metadata.gz: d498da2d6117cb51838b6a7f0082b6567853daf7870d8d1a941854125866484af642d797ca422d2a58e7f89f67e25c5770ccf7f445691158ffe1fbd8b00d4498
+  data.tar.gz: 9fba2237bab643eae1a05e6d9a065e315df4b6ddbbf91442a0293875ae2ab178fcad412522f7906183518cc93e113d5bf8a768f282333d9354f423764a51c9c5

data/README.md

@@ -1,12 +1,147 @@
-# Flicks
+# StudioGame (Alec)
 
-Command-line app/gem to play a game.
+Jogo de terminal em Ruby com **jogadores, dados, tesouros e variações de jogadores** (Clumsy e Berserk), empacotado como gem.
 
-## Run from source
+> Nome do gem (exemplo): `studio_game_alec`
+
+---
+
+## 🚀 Instalação e execução
+
+### Rodando direto do código-fonte
+No diretório do projeto:
+
+```bash
 ruby bin/studio_game
+```
+
+Se você não passar um arquivo de jogadores via CLI, o script usa o `players.csv` que fica em `bin/` por padrão.
+
+Também funciona passando um CSV na linha de comando:
+
+```bash
+ruby bin/studio_game my_favorite_players.csv
+```
+
+### Como gem (local)
+Empacote e instale localmente:
+
+```bash
+gem build studio_game.gemspec
+gem install studio_game_alec-<versao>.gem
+```
+
+Depois rode:
+
+```bash
+studio_game
+```
+
+> No Windows, o executável será resolvido pelo RubyGems. Se preferir, rode: `ruby bin/studio_game`.
+
+---
+
+## 📁 Estrutura do projeto
+
+```
+games/
+├─ bin/
+│  ├─ studio_game          # script principal (tem shebang)
+│  └─ players.csv          # CSV padrão (nome,vida)
+├─ lib/
+│  └─ studio_game/
+│     ├─ auditable.rb
+│     ├─ berserk_player.rb
+│     ├─ clumsy_player.rb
+│     ├─ die.rb
+│     ├─ game.rb
+│     ├─ game_turn.rb
+│     ├─ loaded_die.rb
+│     ├─ playable.rb
+│     ├─ player.rb
+│     └─ treasure_trove.rb
+├─ spec/
+│  └─ studio_game/         # specs RSpec
+├─ LICENSE
+├─ README.md
+└─ studio_game.gemspec
+```
+
+- **Namespace:** todo o código vive dentro do módulo `StudioGame` para evitar colisões.
+- **bin/studio_game:** script CLI com shebang (`#!/usr/bin/env ruby`). Faz _fallback_ do `$LOAD_PATH` para `lib` quando usado fora da gem.
+- **lib/studio_game/**: código da biblioteca (classes/módulos).
+- **spec/**: testes RSpec.
+
+---
+
+## 🧩 Conceitos principais
+
+- **Player** (`player.rb`): representa um jogador com `name`, `health`, coleta tesouros e calcula `score` (= `health` + `points`). Inclui o mixin **Playable**.
+- **Playable** (`playable.rb`): mixin com `w00t`, `blam` e `strong?` (altera/consulta `health` via getters/setters).
+- **TreasureTrove** (`treasure_trove.rb`): define `Treasure = Struct.new(:name,:points)` e a constante `TREASURES`; possui `.random`.
+- **Die/LoadedDie** (`die.rb`, `loaded_die.rb`): rolam valores (o carregado favorece 1,1,2,5,6,6). Ambos incluem **Auditable**.
+- **Auditable** (`auditable.rb`): imprime “Rolled a X (DieClass)” após cada rolagem.
+- **Game** (`game.rb`): agrega jogadores, carrega CSV, executa rodadas, soma pontos e salva _high scores_.
+- **GameTurn** (`game_turn.rb`): executa a lógica de um turno para um jogador (rola dado, aplica `blam/w00t/skip` e concede tesouro).
+- **ClumsyPlayer / BerserkPlayer**: variações de `Player` que modificam comportamento de `w00t` e de coleta de tesouros.
+
+---
+
+## 🧪 Testes
+
+Rode todos os testes:
+
+```bash
+rspec
+```
+
+Principais coisas testadas:
+- Ordenação de jogadores por `score` (usa `<=>` em `Player`).
+- Cálculo de `points` e `score` (soma de tesouros + vida).
+- Efeitos de `w00t`/`blam` e força (`strong?`).
+- Lógica de turno com _stubs_ de dado (`allow_any_instance_of(LoadedDie).to receive(:roll).and_return(n)`).
+- Comportamentos de `ClumsyPlayer` e `BerserkPlayer`.
+
+---
+
+## 📦 CSVs e caminhos
+
+- `bin/studio_game` resolve o CSV padrão assim:
+
+```ruby
+default_player_file = File.join(File.dirname(__FILE__), 'players.csv')
+game.load_players(ARGV.shift || default_player_file)
+```
+
+- Você pode passar um arquivo `.csv` via CLI como primeiro argumento.
+
+Formato do CSV:
+```
+Moe,100
+Larry,60
+Curly,125
+```
+
+---
+
+## 🧾 High Scores
+
+Após sair do loop, o jogo grava `high_score.txt` com as entradas ordenadas. Cada linha é formatada por `Game#high_score_entry`:
+
+```
+<nome com padding de pontos> <score>
+```
+
+---
+
+## 🛠️ Dicas de desenvolvimento
+
+- Use `require 'studio_game/arquivo'` quando a gem estiver instalada.
+- No script binário, o `begin/rescue LoadError` faz _fallback_ para `$LOAD_PATH` local, útil fora da gem.
+- Para debugar I/O em testes, o spec redireciona `STDOUT` (`$stdout = StringIO.new`).
+
+---
+
+## 📚 Licença
 
-## Features
-- Load players from CSV
-- Points system (blam/w00t)
-- Treasure trove
-- Clumsy and beserker player
+MIT – veja o arquivo `LICENSE`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: studio_game_alec
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - LucioAlec
@@ -23,19 +23,54 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-description: |
-  # Flicks
-
-  Command-line app/gem to play a game.
-
-  ## Run from source
-  ruby bin/studio_game
-
-  ## Features
-  - Load players from CSV
-  - Points system (blam/w00t)
-  - Treasure trove
-  - Clumsy and beserker player
+description: "# StudioGame (Alec)\n\nJogo de terminal em Ruby com **jogadores, dados,
+  tesouros e variações de jogadores** (Clumsy e Berserk), empacotado como gem.\n\n>
+  Nome do gem (exemplo): `studio_game_alec`\n\n---\n\n## \U0001F680 Instalação e execução\n\n###
+  Rodando direto do código-fonte\nNo diretório do projeto:\n\n```bash\nruby bin/studio_game\n```\n\nSe
+  você não passar um arquivo de jogadores via CLI, o script usa o `players.csv` que
+  fica em `bin/` por padrão.\n\nTambém funciona passando um CSV na linha de comando:\n\n```bash\nruby
+  bin/studio_game my_favorite_players.csv\n```\n\n### Como gem (local)\nEmpacote e
+  instale localmente:\n\n```bash\ngem build studio_game.gemspec\ngem install studio_game_alec-<versao>.gem\n```\n\nDepois
+  rode:\n\n```bash\nstudio_game\n```\n\n> No Windows, o executável será resolvido
+  pelo RubyGems. Se preferir, rode: `ruby bin/studio_game`.\n\n---\n\n## \U0001F4C1
+  Estrutura do projeto\n\n```\ngames/\n├─ bin/\n│  ├─ studio_game          # script
+  principal (tem shebang)\n│  └─ players.csv          # CSV padrão (nome,vida)\n├─
+  lib/\n│  └─ studio_game/\n│     ├─ auditable.rb\n│     ├─ berserk_player.rb\n│     ├─
+  clumsy_player.rb\n│     ├─ die.rb\n│     ├─ game.rb\n│     ├─ game_turn.rb\n│     ├─
+  loaded_die.rb\n│     ├─ playable.rb\n│     ├─ player.rb\n│     └─ treasure_trove.rb\n├─
+  spec/\n│  └─ studio_game/         # specs RSpec\n├─ LICENSE\n├─ README.md\n└─ studio_game.gemspec\n```\n\n-
+  **Namespace:** todo o código vive dentro do módulo `StudioGame` para evitar colisões.\n-
+  **bin/studio_game:** script CLI com shebang (`#!/usr/bin/env ruby`). Faz _fallback_
+  do `$LOAD_PATH` para `lib` quando usado fora da gem.\n- **lib/studio_game/**: código
+  da biblioteca (classes/módulos).\n- **spec/**: testes RSpec.\n\n---\n\n## \U0001F9E9
+  Conceitos principais\n\n- **Player** (`player.rb`): representa um jogador com `name`,
+  `health`, coleta tesouros e calcula `score` (= `health` + `points`). Inclui o mixin
+  **Playable**.\n- **Playable** (`playable.rb`): mixin com `w00t`, `blam` e `strong?`
+  (altera/consulta `health` via getters/setters).\n- **TreasureTrove** (`treasure_trove.rb`):
+  define `Treasure = Struct.new(:name,:points)` e a constante `TREASURES`; possui
+  `.random`.\n- **Die/LoadedDie** (`die.rb`, `loaded_die.rb`): rolam valores (o carregado
+  favorece 1,1,2,5,6,6). Ambos incluem **Auditable**.\n- **Auditable** (`auditable.rb`):
+  imprime “Rolled a X (DieClass)” após cada rolagem.\n- **Game** (`game.rb`): agrega
+  jogadores, carrega CSV, executa rodadas, soma pontos e salva _high scores_.\n- **GameTurn**
+  (`game_turn.rb`): executa a lógica de um turno para um jogador (rola dado, aplica
+  `blam/w00t/skip` e concede tesouro).\n- **ClumsyPlayer / BerserkPlayer**: variações
+  de `Player` que modificam comportamento de `w00t` e de coleta de tesouros.\n\n---\n\n##
+  \U0001F9EA Testes\n\nRode todos os testes:\n\n```bash\nrspec\n```\n\nPrincipais
+  coisas testadas:\n- Ordenação de jogadores por `score` (usa `<=>` em `Player`).\n-
+  Cálculo de `points` e `score` (soma de tesouros + vida).\n- Efeitos de `w00t`/`blam`
+  e força (`strong?`).\n- Lógica de turno com _stubs_ de dado (`allow_any_instance_of(LoadedDie).to
+  receive(:roll).and_return(n)`).\n- Comportamentos de `ClumsyPlayer` e `BerserkPlayer`.\n\n---\n\n##
+  \U0001F4E6 CSVs e caminhos\n\n- `bin/studio_game` resolve o CSV padrão assim:\n\n```ruby\ndefault_player_file
+  = File.join(File.dirname(__FILE__), 'players.csv')\ngame.load_players(ARGV.shift
+  || default_player_file)\n```\n\n- Você pode passar um arquivo `.csv` via CLI como
+  primeiro argumento.\n\nFormato do CSV:\n```\nMoe,100\nLarry,60\nCurly,125\n```\n\n---\n\n##
+  \U0001F9FE High Scores\n\nApós sair do loop, o jogo grava `high_score.txt` com as
+  entradas ordenadas. Cada linha é formatada por `Game#high_score_entry`:\n\n```\n<nome
+  com padding de pontos> <score>\n```\n\n---\n\n## \U0001F6E0️ Dicas de desenvolvimento\n\n-
+  Use `require 'studio_game/arquivo'` quando a gem estiver instalada.\n- No script
+  binário, o `begin/rescue LoadError` faz _fallback_ para `$LOAD_PATH` local, útil
+  fora da gem.\n- Para debugar I/O em testes, o spec redireciona `STDOUT` (`$stdout
+  = StringIO.new`).\n\n---\n\n## \U0001F4DA Licença\n\nMIT – veja o arquivo `LICENSE`.\n"
 email: lucioalec@gmail.com
 executables:
 - studio_game