From 241ea857922fb58d3784b22231c4cafeed0fed48 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dani=20Santamar=C3=ADa?= <santaka87@gmail.com>
Date: Thu, 8 Apr 2021 19:00:07 +0200
Subject: [PATCH] [php][step_shotgun_surgery-01_base] Add Shotgun Surgery
 example

---
 .../src/Application/GetStepDuration.php       | 24 ++++++++
 .../src/Domain/DurationMultiplier.php         | 21 +++++++
 .../src/Domain/Question.php                   |  9 +++
 .../src/Domain/QuizStep.php                   | 26 +++++++++
 .../src/Domain/Step.php                       | 22 +++++++
 .../src/Domain/StepDurationCalculator.php     | 12 ++++
 .../Domain/StepDurationCalculatorChain.php    | 38 ++++++++++++
 .../Domain/StepDurationCalculatorFactory.php  | 17 ++++++
 .../src/Domain/StepDurationCalculatorQuiz.php | 18 ++++++
 .../Domain/StepDurationCalculatorVideo.php    | 18 ++++++
 .../src/Domain/StepEnums.php                  | 22 +++++++
 .../src/Domain/StepRepository.php             | 10 ++++
 .../src/Domain/VideoStep.php                  | 26 +++++++++
 .../tests/Application/GetStepDurationTest.php | 58 +++++++++++++++++++
 14 files changed, 321 insertions(+)
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Application/GetStepDuration.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/DurationMultiplier.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/Question.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/QuizStep.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/Step.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculator.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorChain.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorFactory.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorQuiz.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorVideo.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepEnums.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepRepository.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/src/Domain/VideoStep.php
 create mode 100644 examples/php/php-step_shotgun_surgery-01_base/tests/Application/GetStepDurationTest.php

diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Application/GetStepDuration.php b/examples/php/php-step_shotgun_surgery-01_base/src/Application/GetStepDuration.php
new file mode 100644
index 00000000..b6b193da
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Application/GetStepDuration.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Application;
+
+use CodelyTv\StepShotgunSurgery\Domain\StepDurationCalculatorFactory;
+use CodelyTv\StepShotgunSurgery\Domain\StepRepository;
+
+class GetStepDuration
+{
+    private StepRepository $steps;
+
+    public function __construct(StepRepository $steps)
+    {
+        $this->steps = $steps;
+    }
+
+    public function __invoke(string $stepId): float
+    {
+        $step = $this->steps->find($stepId);
+        return StepDurationCalculatorFactory::build()->calculate($step);
+    }
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/DurationMultiplier.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/DurationMultiplier.php
new file mode 100644
index 00000000..9124c5a8
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/DurationMultiplier.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+class DurationMultiplier
+{
+    public static function multiplierFor(Step $step): float
+    {
+        if ($step->type() === StepEnums::STEP_TYPE_VIDEO) {
+            return StepEnums::STEP_DURATION_MULTIPLIER_VIDEO;
+        }
+
+        if ($step->type() === StepEnums::STEP_TYPE_QUIZ) {
+            return StepEnums::STEP_DURATION_MULTIPLIER_QUIZ;
+        }
+
+        return 1.0;
+    }
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/Question.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/Question.php
new file mode 100644
index 00000000..b30eb4ab
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/Question.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+class Question
+{
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/QuizStep.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/QuizStep.php
new file mode 100644
index 00000000..a52bda45
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/QuizStep.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+final class QuizStep extends Step
+{
+    private array $questions;
+
+    public function __construct(string $id, Question ...$questions)
+    {
+        parent::__construct($id);
+        $this->questions = $questions;
+    }
+
+    public function type(): string
+    {
+        return StepEnums::STEP_TYPE_QUIZ;
+    }
+
+    public function questionCount(): int
+    {
+        return count($this->questions);
+    }
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/Step.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/Step.php
new file mode 100644
index 00000000..ccde418c
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/Step.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+abstract class Step
+{
+    private string $id;
+
+    public function __construct(string $id)
+    {
+        $this->id = $id;
+    }
+
+    public function id(): string
+    {
+        return $this->id;
+    }
+
+    abstract public function type(): string;
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculator.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculator.php
new file mode 100644
index 00000000..34e2558b
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculator.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+interface StepDurationCalculator
+{
+    public function supports(Step $step): bool;
+
+    public function calculate(Step $step): float;
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorChain.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorChain.php
new file mode 100644
index 00000000..670f2e53
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorChain.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+use RuntimeException;
+
+class StepDurationCalculatorChain implements StepDurationCalculator
+{
+    /** @var StepDurationCalculator[] */
+    private array $calculators;
+
+    public function __construct(StepDurationCalculator ...$calculators)
+    {
+        $this->calculators = $calculators;
+    }
+
+    public function supports(Step $step): bool
+    {
+        return in_array($step->type(), StepEnums::STEP_TYPES);
+    }
+
+    public function calculate(Step $step): float
+    {
+        if (!$this->supports($step)) {
+            throw new RuntimeException("Missing calculator for step type {$step->type()}");
+        }
+
+        foreach ($this->calculators as $calculator) {
+            if ($calculator->supports($step)) {
+                return $calculator->calculate($step);
+            }
+        }
+
+        throw new RuntimeException("Missing calculator for step type {$step->type()}");
+    }
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorFactory.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorFactory.php
new file mode 100644
index 00000000..bc80a0ba
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorFactory.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+class StepDurationCalculatorFactory
+{
+    public static function build(): StepDurationCalculator
+    {
+        // Remember to add the calculator!!
+        return new StepDurationCalculatorChain(
+            new StepDurationCalculatorVideo(),
+            new StepDurationCalculatorQuiz(),
+        );
+    }
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorQuiz.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorQuiz.php
new file mode 100644
index 00000000..fa3d2e98
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorQuiz.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+class StepDurationCalculatorQuiz implements StepDurationCalculator
+{
+    public function supports(Step $step): bool
+    {
+        return $step instanceof QuizStep;
+    }
+
+    public function calculate(Step $step): float
+    {
+        return $step->questionCount() * StepEnums::QUIZ_QUESTION_DURATION * DurationMultiplier::multiplierFor($step);
+    }
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorVideo.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorVideo.php
new file mode 100644
index 00000000..16999699
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepDurationCalculatorVideo.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+class StepDurationCalculatorVideo implements StepDurationCalculator
+{
+    public function supports(Step $step): bool
+    {
+        return $step instanceof VideoStep;
+    }
+
+    public function calculate(Step $step): float
+    {
+        return $step->videoDuration() * DurationMultiplier::multiplierFor($step);
+    }
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepEnums.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepEnums.php
new file mode 100644
index 00000000..b9c78b9e
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepEnums.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+final class StepEnums
+{
+    public const STEP_TYPE_VIDEO = 'video';
+    public const STEP_TYPE_QUIZ = 'quiz';
+
+    public const STEP_DURATION_MULTIPLIER_VIDEO = 1.1;
+    public const STEP_DURATION_MULTIPLIER_QUIZ = 1.5;
+
+    public const QUIZ_QUESTION_DURATION = 5;
+
+    # Important: don't forget to add here the type!!
+    public const STEP_TYPES = [
+        self::STEP_TYPE_VIDEO,
+        self::STEP_TYPE_QUIZ
+    ];
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepRepository.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepRepository.php
new file mode 100644
index 00000000..897cddb2
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/StepRepository.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+interface StepRepository
+{
+    public function find(string $id): Step;
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/src/Domain/VideoStep.php b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/VideoStep.php
new file mode 100644
index 00000000..5a2c3b1f
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/src/Domain/VideoStep.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodelyTv\StepShotgunSurgery\Domain;
+
+final class VideoStep extends Step
+{
+    private int $videoDuration;
+
+    public function __construct(string $id, int $videoDuration)
+    {
+        parent::__construct($id);
+        $this->videoDuration = $videoDuration;
+    }
+
+    public function type(): string
+    {
+        return StepEnums::STEP_TYPE_VIDEO;
+    }
+
+    public function videoDuration(): int
+    {
+        return $this->videoDuration;
+    }
+}
diff --git a/examples/php/php-step_shotgun_surgery-01_base/tests/Application/GetStepDurationTest.php b/examples/php/php-step_shotgun_surgery-01_base/tests/Application/GetStepDurationTest.php
new file mode 100644
index 00000000..123f76ee
--- /dev/null
+++ b/examples/php/php-step_shotgun_surgery-01_base/tests/Application/GetStepDurationTest.php
@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace CodelyTv\StepShotgunSurgery\Tests\Application;
+
+use CodelyTv\StepShotgunSurgery\Application\GetStepDuration;
+use CodelyTv\StepShotgunSurgery\Domain\Question;
+use CodelyTv\StepShotgunSurgery\Domain\QuizStep;
+use CodelyTv\StepShotgunSurgery\Domain\Step;
+use CodelyTv\StepShotgunSurgery\Domain\StepRepository;
+use CodelyTv\StepShotgunSurgery\Domain\VideoStep;
+use PHPUnit\Framework\TestCase;
+
+final class GetStepDurationTest extends TestCase
+{
+    private StepRepository $stepRepository;
+    private GetStepDuration $getStepDuration;
+
+    protected function setUp(): void
+    {
+        $this->stepRepository = $this->createMock(StepRepository::class);
+        $this->getStepDuration = new GetStepDuration($this->stepRepository);
+    }
+
+    /** @test */
+    public function shouldReturnVideoStepDuration(): void
+    {
+        $videoStep = new VideoStep('videoId', 10);
+        $this->givenStepRepositoryHas($videoStep);
+
+        $duration = ($this->getStepDuration)('videoId');
+
+        self::assertSame(11.0, $duration);
+    }
+
+    /** @test */
+    public function shouldReturnQuizStepDuration(): void
+    {
+        $questions = [
+            new Question(),
+            new Question(),
+        ];
+        $quizStep = new QuizStep('videoId', ...$questions);
+        $this->givenStepRepositoryHas($quizStep);
+
+        $duration = ($this->getStepDuration)('videoId');
+
+        self::assertSame(15.0, $duration);
+    }
+
+    public function givenStepRepositoryHas(Step $step): void
+    {
+        $this->stepRepository
+            ->method('find')
+            ->willReturn($step);
+    }
+}