playoffs 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1a073c8554e9f8e237a7d55bab24bd078671fd84464bcedca0e1ef557851286
-  data.tar.gz: 07ecbd52187a90afb8fbc3e27abadac5ecb4c2ffdc75cd5ae686f742eb7921b9
+  metadata.gz: f197d46a02950cbcb057d745d07a3926082e09efc8e91c4935e84675c0c52f60
+  data.tar.gz: 746469e25a41e507424a225c4fb05acd6fe38e1808478b07154733a3286b4aa5
 SHA512:
-  metadata.gz: 867f0f7137c5e84349f7a1ee530eb7662a93f2782a6c0752908a0d26e0bcf2045c1857231f5e4bed0bafeb34e308a9a98751962709083cf7c8b1c746c3e7723a
-  data.tar.gz: 1a2c1debbbfddbcccabd9ebc38a6f568c0c6a1f7220ebfa678c0992de78701f6f78ce6e91c6328d4b551b4c1b0744c5cf2cf784afd485a9af43c97ab55d05077
+  metadata.gz: 0ecc670d3b1736f563772f3eaa21b224cc641295c618cb2b9eeb05cd325341a59784ea3d06c988c3667557a6f3a162a4a238c9f43d4b0ae8219c8b2aef72ab69
+  data.tar.gz: 86fd1b47d7ffa6209b190c122d6df0af7b6b63d13fa4f9c435000b6cc29461091f88b64e17d05a39b813947d5cd32fe44648376177c2808d185dba3bf2e0dc5c

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.0.1
+
+* Extract out portions of Cli into Loader and Simulator classes.
+
 ### 1.0.0
 
 * Initial version.

data/lib/playoffs/cli.rb

@@ -15,10 +15,25 @@ module Playoffs
     sig { returns(String) }
     attr_reader :script
 
-    sig { params(io: T.any(IO, StringIO), script: String).void }
-    def initialize(io, script: 'bin/playoffs')
+    sig { returns(Loader) }
+    attr_reader :loader
+
+    sig { returns(Simulator) }
+    attr_reader :simulator
+
+    sig do
+      params(
+        io: T.any(IO, StringIO),
+        script: String,
+        loader: Loader,
+        simulator: Simulator
+      ).void
+    end
+    def initialize(io, script: 'bin/playoffs', loader: Loader.new, simulator: RandomSimulator.new)
       @io = io
       @script = script
+      @loader = loader
+      @simulator = simulator
     end
 
     sig { params(args: T::Array[String]).returns(Cli) }
@@ -45,39 +60,6 @@ module Playoffs
       self
     end
 
-    protected
-
-    sig { overridable.params(path: String, tournament: Tournament).returns(Cli) }
-    def save(path, tournament)
-      FileUtils.mkdir_p(File.dirname(path))
-
-      File.open(path, 'w') { |out| YAML.dump(tournament, out) }
-
-      self
-    end
-
-    sig { overridable.params(path: String).returns(Tournament) }
-    def load(path)
-      YAML.load_file(
-        path,
-        permitted_classes: [
-          BestOf,
-          Round,
-          Series,
-          Team,
-          Tournament
-        ],
-        aliases: true
-      )
-    end
-
-    sig { overridable.params(series: Series).returns(Team) }
-    def pick(series)
-      index = rand(0..1)
-
-      T.must(series.teams[index])
-    end
-
     private
 
     # rubocop:disable Metrics/AbcSize
@@ -119,28 +101,28 @@ module Playoffs
 
       tournament = Basketball.tournament_for(eastern_teams:, western_teams:)
 
-      save(path, tournament)
+      loader.save(path, tournament)
 
       self
     end
 
     sig { params(path: String, _action: String, _args: T::Array[String]).returns(Cli) }
     def run_bracket(path, _action, _args)
-      io.puts(load(path).print_bracket)
+      io.puts(loader.load(path).print_bracket)
 
       self
     end
 
     sig { params(path: String, _action: String, _args: T::Array[String]).returns(Cli) }
     def run_rounds(path, _action, _args)
-      io.puts(load(path).print_rounds)
+      io.puts(loader.load(path).print_rounds)
 
       self
     end
 
     sig { params(path: String, _action: String, _args: T::Array[String]).returns(Cli) }
     def run_up(path, _action, _args)
-      tournament = load(path)
+      tournament = loader.load(path)
 
       series = tournament.up_next
 
@@ -154,26 +136,26 @@ module Playoffs
       id = args[2].to_s
 
       team = Team.new(id)
-      tournament = load(path)
+      tournament = loader.load(path)
       series = tournament.up_next
 
       T.must(series).win(team)
 
       io.puts(series)
 
-      save(path, tournament)
+      loader.save(path, tournament)
 
       self
     end
 
     sig { params(path: String, _action: String, _args: T::Array[String]).returns(Cli) }
     def run_sim(path, _action, _args)
-      tournament = load(path)
+      tournament = loader.load(path)
 
       total = 0
       # while not nil (and assign series)
       while (series = tournament.up_next)
-        team = pick(series)
+        team = simulator.pick(series)
 
         series.win(team)
 
@@ -184,14 +166,14 @@ module Playoffs
 
       io.puts(tournament.winner.to_s)
 
-      save(path, tournament)
+      loader.save(path, tournament)
 
       self
     end
 
     sig { params(path: String, _action: String, _args: T::Array[String]).returns(Cli) }
     def run_winner(path, _action, _args)
-      tournament = load(path)
+      tournament = loader.load(path)
 
       io.puts(tournament.winner) if tournament.over?
 

data/lib/playoffs/loader.rb

@@ -0,0 +1,47 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Playoffs
+  # Knows how to (de)serialize a tournament and read/write from/to disk.
+  class Loader
+    extend T::Sig
+
+    sig { overridable.params(tournament: Tournament).returns(String) }
+    def serialize(tournament)
+      io = StringIO.new
+
+      YAML.dump(tournament, io)
+
+      io.string
+    end
+
+    sig { overridable.params(string: String).returns(Tournament) }
+    def deserialize(string)
+      YAML.load(
+        string,
+        permitted_classes: [
+          BestOf,
+          Round,
+          Series,
+          Team,
+          Tournament
+        ],
+        aliases: true
+      )
+    end
+
+    sig { overridable.params(path: String, tournament: Tournament).void }
+    def save(path, tournament)
+      FileUtils.mkdir_p(File.dirname(path))
+
+      File.write(path, serialize(tournament))
+
+      self
+    end
+
+    sig { overridable.params(path: String).returns(Tournament) }
+    def load(path)
+      deserialize(File.read(path))
+    end
+  end
+end

data/lib/playoffs/random_simulator.rb

@@ -0,0 +1,19 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative 'simulator'
+
+module Playoffs
+  # Very simple example of how to select a winner for a series.
+  class RandomSimulator
+    extend T::Sig
+    include Simulator
+
+    sig { override.params(series: Series).returns(Team) }
+    def pick(series)
+      index = rand(0..1)
+
+      T.must(series.teams[index])
+    end
+  end
+end

data/lib/playoffs/simulator.rb

@@ -0,0 +1,14 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Playoffs
+  # Describes what functionality a Simulator should implement.
+  module Simulator
+    extend T::Sig
+    extend T::Helpers
+    interface!
+
+    sig { abstract.params(series: Series).returns(Team) }
+    def pick(series); end
+  end
+end

data/lib/playoffs/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Playoffs
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/playoffs.rb

@@ -9,6 +9,8 @@ require_relative 'playoffs/basketball'
 require_relative 'playoffs/best_of'
 require_relative 'playoffs/cli'
 require_relative 'playoffs/contestant'
+require_relative 'playoffs/loader'
+require_relative 'playoffs/random_simulator'
 require_relative 'playoffs/round'
 require_relative 'playoffs/series'
 require_relative 'playoffs/team'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playoffs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -276,8 +276,11 @@ files:
 - lib/playoffs/best_of.rb
 - lib/playoffs/cli.rb
 - lib/playoffs/contestant.rb
+- lib/playoffs/loader.rb
+- lib/playoffs/random_simulator.rb
 - lib/playoffs/round.rb
 - lib/playoffs/series.rb
+- lib/playoffs/simulator.rb
 - lib/playoffs/team.rb
 - lib/playoffs/tournament.rb
 - lib/playoffs/tournament/bracketable.rb