Initial commit

step5-wrapping-up-with-unit-tests/my_module.info.yml

@@ -0,0 +1,5 @@
+name: My Module
+type: module
+core: 8.x
+core_version_requirement: ^8 || ^9
+package: Custom

step5-wrapping-up-with-unit-tests/my_module.routing.yml

@@ -0,0 +1,7 @@
+blog.page:
+  path: /blog
+  defaults:
+    _controller: Drupal\my_module\Controller\BlogPageController
+    _title: Blog
+  requirements:
+    _permission: access content

step5-wrapping-up-with-unit-tests/my_module.services.yml

@@ -0,0 +1,6 @@
+services:
+  Drupal\my_module\Controller\BlogPageController:
+    autowire: true
+
+  Drupal\my_module\Repository\ArticleRepository:
+    autowire: true

step5-wrapping-up-with-unit-tests/src/Controller/BlogPageController.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Drupal\my_module\Controller;
+
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
+use Drupal\my_module\Repository\ArticleRepository;
+
+class BlogPageController {
+
+  use StringTranslationTrait;
+
+  /**
+   * @var \Drupal\my_module\Repository\ArticleRepository
+   */
+  private $articleRepository;
+
+  /**
+   * @var \Drupal\Core\Entity\EntityViewBuilderInterface
+   */
+  private $nodeViewBuilder;
+
+  public function __construct(
+    EntityTypeManagerInterface $entityTypeManager,
+    ArticleRepository $articleRepository
+  ) {
+    $this->nodeViewBuilder = $entityTypeManager->getViewBuilder('node');
+    $this->articleRepository = $articleRepository;
+  }
+
+  public function __invoke(): array {
+    $build = [];
+
+    $articles = $this->articleRepository->getAll();
+
+    foreach ($articles as $article) {
+      $build[] = $this->nodeViewBuilder->view($article, 'teaser');
+    }
+
+    return [
+      '#markup' => render($build),
+    ];
+  }
+
+}

step5-wrapping-up-with-unit-tests/src/Repository/ArticleRepository.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Drupal\my_module\Repository;
+
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\node\Entity\Node;
+use Drupal\node\NodeInterface;
+
+class ArticleRepository {
+
+  /**
+   * @var \Drupal\Core\Entity\EntityStorageInterface
+   */
+  private $nodeStorage;
+
+  public function __construct(EntityTypeManagerInterface $entityTypeManager) {
+    $this->nodeStorage = $entityTypeManager->getStorage('node');
+  }
+
+  public function getAll(): array {
+    $articles = $this->nodeStorage->loadByProperties([
+      'status' => Node::PUBLISHED,
+      'type' => 'article',
+    ]);
+
+    uasort($articles, function (NodeInterface $a, NodeInterface $b): bool {
+      return $a->getCreatedTime() < $b->getCreatedTime();
+    });
+
+    return $articles;
+  }
+
+}

step5-wrapping-up-with-unit-tests/src/Wrapper/ArticleWrapper.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Drupal\my_module\Wrapper;
+
+use Drupal\Component\Datetime\TimeInterface;
+use Drupal\node\NodeInterface;
+
+class ArticleWrapper {
+
+  private $article;
+
+  public function __construct(TimeInterface $time, NodeInterface $node) {
+    $this->verifyNodeType($node);
+
+    $this->time = $time;
+    $this->article = $node;
+  }
+
+  public function getOriginal(): NodeInterface {
+    return $this->article;
+  }
+
+  private function verifyNodeType(NodeInterface $node): void {
+    if ($node->bundle() != 'article') {
+      throw new \InvalidArgumentException(sprintf(
+        '%s is not an article',
+        $node->bundle()
+      ));
+    }
+  }
+
+  public function isPublishable(): bool {
+    $created = $this->article->getCreatedTime();
+
+    $difference = $this->time->getRequestTime() - $created;
+
+    return $difference >= 60 * 60 * 24 * 3;
+  }
+
+}

step5-wrapping-up-with-unit-tests/tests/src/Functional/BlogPageTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Drupal\my_module\Functional;
+
+use Drupal\Tests\BrowserTestBase;
+use Symfony\Component\HttpFoundation\Response;
+
+class BlogPageTest extends BrowserTestBase {
+
+  protected $defaultTheme = 'stark';
+
+  protected static $modules = [
+    'node',
+    'my_module',
+  ];
+
+  /** @test */
+  public function the_blog_page_loads_for_anonymous_users_and_contains_the_right_text() {
+    $this->drupalGet('/blog');
+
+    $session = $this->assertSession();
+
+    $session->statusCodeEquals(Response::HTTP_OK);
+    $session->responseContains('<h1>Blog</h1>');
+  }
+
+}

step5-wrapping-up-with-unit-tests/tests/src/Functional/MyModuleTest.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Drupal\Tests\my_module\Functional;
+
+use Drupal\Tests\BrowserTestBase;
+use Symfony\Component\HttpFoundation\Response;
+
+class MyModuleTest extends BrowserTestBase {
+
+  protected $defaultTheme = 'stark';
+
+  /** @test */
+  public function the_front_page_loads_for_anonymous_users() {
+    $this->drupalGet('<front>');
+
+    $this->assertResponse(Response::HTTP_OK);
+  }
+
+}

step5-wrapping-up-with-unit-tests/tests/src/Kernel/ArticleRepositoryTest.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Drupal\Tests\my_module\Kernel;
+
+use Drupal\Core\Datetime\DrupalDateTime;
+use Drupal\KernelTests\Core\Entity\EntityKernelTestBase;
+use Drupal\my_module\Repository\ArticleRepository;
+use Drupal\node\Entity\Node;
+use Drupal\Tests\node\Traits\NodeCreationTrait;
+
+class ArticleRepositoryTest extends EntityKernelTestBase {
+
+  use NodeCreationTrait;
+
+  public static $modules = [
+    'node',
+    'my_module',
+  ];
+
+  protected function setUp() {
+    parent::setUp();
+
+    $this->installSchema('node', ['node_access']);
+
+    $this->installConfig([
+      'filter',
+    ]);
+  }
+
+  /** @test */
+  public function nodes_that_are_not_articles_are_not_returned() {
+    $this->createNode(['type' => 'article'])->save();
+    $this->createNode(['type' => 'page'])->save();
+    $this->createNode(['type' => 'article'])->save();
+    $this->createNode(['type' => 'page'])->save();
+    $this->createNode(['type' => 'article'])->save();
+
+    $this->assertCount(5, Node::loadMultiple());
+
+    $repository = $this->container->get(ArticleRepository::class);
+    $articles = $repository->getAll();
+
+    $this->assertCount(3, $articles);
+  }
+
+  /** @test */
+  public function only_published_articles_are_returned() {
+    $this->createNode(['type' => 'article', 'status' => Node::PUBLISHED])->save();
+    $this->createNode(['type' => 'article', 'status' => Node::NOT_PUBLISHED])->save();
+    $this->createNode(['type' => 'article', 'status' => Node::PUBLISHED])->save();
+    $this->createNode(['type' => 'article', 'status' => Node::NOT_PUBLISHED])->save();
+    $this->createNode(['type' => 'article', 'status' => Node::PUBLISHED])->save();
+
+    $repository = $this->container->get(ArticleRepository::class);
+    $articles = $repository->getAll();
+
+    $this->assertCount(3, $articles);
+  }
+
+  /** @test */
+  public function nodes_are_ordered_by_date_and_returned_newest_first() {
+    $this->createNode(['type' => 'article', 'created' => (new DrupalDateTime('-2 days'))->getTimestamp()]);
+    $this->createNode(['type' => 'article', 'created' => (new DrupalDateTime('-1 week'))->getTimestamp()]);
+    $this->createNode(['type' => 'article', 'created' => (new DrupalDateTime('-1 hour'))->getTimestamp()]);
+    $this->createNode(['type' => 'article', 'created' => (new DrupalDateTime('-1 year'))->getTimestamp()]);
+    $this->createNode(['type' => 'article', 'created' => (new DrupalDateTime('-1 month'))->getTimestamp()]);
+
+    $repository = $this->container->get(ArticleRepository::class);
+    $nodes = $repository->getAll();
+    $nodeIds = array_keys($nodes);
+
+    $this->assertSame([3, 1, 2, 5, 4], $nodeIds);
+  }
+
+}

step5-wrapping-up-with-unit-tests/tests/src/Unit/Wrapper/ArticleWrapperTest.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Drupal\Tests\my_module\Unit\Wrapper;
+
+use Drupal\Component\Datetime\TimeInterface;
+use Drupal\my_module\Wrapper\ArticleWrapper;
+use Drupal\node\NodeInterface;
+use Drupal\Tests\UnitTestCase;
+
+class ArticleWrapperTest extends UnitTestCase {
+
+  private $time;
+
+  protected function setUp() {
+    $this->time = $this->createMock(TimeInterface::class);
+  }
+
+  /** @test */
+  public function it_returns_the_article() {
+    $article = $this->createMock(NodeInterface::class);
+    $article->method('id')->willReturn(5);
+    $article->method('bundle')->willReturn('article');
+
+    $articleWrapper = new ArticleWrapper($this->time, $article);
+
+    $this->assertInstanceOf(NodeInterface::class, $articleWrapper->getOriginal());
+    $this->assertSame(5, $articleWrapper->getOriginal()->id());
+    $this->assertSame('article', $articleWrapper->getOriginal()->bundle());
+  }
+
+  /** @test */
+  public function it_throws_an_exception_if_the_node_is_not_an_article() {
+    $this->expectException(\InvalidArgumentException::class);
+
+    $page = $this->createMock(NodeInterface::class);
+    $page->method('bundle')->willReturn('page');
+
+    new ArticleWrapper($this->time, $page);
+  }
+
+  /**
+   * @test
+   * @dataProvider articleCreatedDateProvider
+   */
+  public function articles_created_less_than_3_days_ago_are_not_publishable(
+    string $offset,
+    bool $expected
+  ) {
+    $this->time->method('getRequestTime')->willReturn(
+      (new \DateTime())->getTimestamp()
+    );
+
+    $article = $this->createMock(NodeInterface::class);
+    $article->method('bundle')->willReturn('article');
+
+    $article->method('getCreatedTime')->willReturn(
+      (new \DateTime())->modify($offset)->getTimestamp()
+    );
+
+    $articleWrapper = new ArticleWrapper($this->time, $article);
+
+    $this->assertSame($expected, $articleWrapper->isPublishable());
+  }
+
+  public function articleCreatedDateProvider() {
+    return [
+      ['-1 day', FALSE],
+      ['-2 days 59 minutes', FALSE],
+      ['-3 days', TRUE],
+      ['-1 week', TRUE],
+    ];
+  }
+}