Issue #2855815: Add custom coupon storage, provide loadByCode method.

Author: mitrpaka

modules/promotion/src/CouponStorage.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Drupal\commerce_promotion;
+
+use Drupal\commerce\CommerceContentEntityStorage;
+
+/**
+ * Defines the coupon storage.
+ */
+class CouponStorage extends CommerceContentEntityStorage implements CouponStorageInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function loadByCode($code) {
+    $coupons = $this->loadByProperties(['code' => $code]);
+
+    return reset($coupons);
+  }
+
+}

modules/promotion/src/CouponStorageInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Drupal\commerce_promotion;
+
+use Drupal\Core\Entity\ContentEntityStorageInterface;
+
+/**
+ * Defines the interface for coupon storage.
+ */
+interface CouponStorageInterface extends ContentEntityStorageInterface {
+
+  /**
+   * Loads the coupon for the given coupon code.
+   *
+   * @param string $code
+   *   The coupon code.
+   *
+   * @return \Drupal\commerce_promotion\Entity\CouponInterface
+   *   The coupon.
+   */
+  public function loadByCode($code);
+
+}

modules/promotion/src/Entity/Coupon.php

@@ -13,6 +13,7 @@
  *   id = "commerce_promotion_coupon",
  *   label = @Translation("Coupon"),
  *   handlers = {
+ *     "storage" = "Drupal\commerce_promotion\CouponStorage",
  *     "views_data" = "Drupal\views\EntityViewsData",
  *     "form" = {
  *       "add" = "Drupal\Core\Entity\ContentEntityForm",

modules/promotion/tests/src/Kernel/CouponStorageTest.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Drupal\Tests\commerce_promotion\Kernel;
+
+use Drupal\commerce_promotion\Entity\Coupon;
+use Drupal\Tests\commerce\Kernel\CommerceKernelTestBase;
+
+/**
+ * Tests coupon storage.
+ *
+ * @group commerce
+ */
+class CouponStorageTest extends CommerceKernelTestBase {
+
+  /**
+   * The coupon storage.
+   *
+   * @var \Drupal\commerce_promotion\CouponStorageInterface
+   */
+  protected $couponStorage;
+
+  /**
+   * Modules to enable.
+   *
+   * @var array
+   */
+  public static $modules = [
+    'entity_reference_revisions',
+    'profile',
+    'state_machine',
+    'commerce_order',
+    'commerce_product',
+    'commerce_promotion',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+
+    $this->installEntitySchema('profile');
+    $this->installEntitySchema('commerce_order');
+    $this->installEntitySchema('commerce_order_type');
+    $this->installEntitySchema('commerce_promotion');
+    $this->installEntitySchema('commerce_promotion_coupon');
+    $this->installConfig([
+      'profile',
+      'commerce_order',
+      'commerce_promotion',
+    ]);
+
+    $this->couponStorage = $this->container->get('entity_type.manager')->getStorage('commerce_promotion_coupon');
+  }
+
+  /**
+   * Loads a coupon by its code.
+   */
+  public function testLoadByCode() {
+    $coupon_code = $this->randomMachineName();
+    $coupon = Coupon::create([
+      'code' => $coupon_code,
+      'status' => TRUE,
+    ]);
+    $coupon->save();
+
+    $coupon_loaded = $this->couponStorage->loadByCode($coupon_code);
+    $this->assertEquals($coupon->id(), $coupon_loaded->id());
+  }
+
+}