Issue #2898380 by vegantriathlete, Mile23, eojthebrave, socketwench: Make content entity example more gender-inclusive

Author: Mile23

content_entity_example/content_entity_example.info.yml

@@ -6,4 +6,5 @@ core: 8.x
 # These modules are required by the tests, must be available at bootstrap time
 dependencies:
   - drupal:options
+  - drupal:user
   - examples:examples

content_entity_example/src/Entity/Contact.php

@@ -250,32 +250,6 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
       ->setDisplayConfigurable('form', TRUE)
       ->setDisplayConfigurable('view', TRUE);
 
-    // Gender field for the contact.
-    // ListTextType with a drop down menu widget.
-    // The values shown in the menu are 'male' and 'female'.
-    // In the view the field content is shown as string.
-    // In the form the choices are presented as options list.
-    $fields['gender'] = BaseFieldDefinition::create('list_string')
-      ->setLabel(t('Gender'))
-      ->setDescription(t('The gender of the Contact entity.'))
-      ->setSettings([
-        'allowed_values' => [
-          'female' => 'female',
-          'male' => 'male',
-        ],
-      ])
-      ->setDisplayOptions('view', [
-        'label' => 'above',
-        'type' => 'string',
-        'weight' => -4,
-      ])
-      ->setDisplayOptions('form', [
-        'type' => 'options_select',
-        'weight' => -4,
-      ])
-      ->setDisplayConfigurable('form', TRUE)
-      ->setDisplayConfigurable('view', TRUE);
-
     // Owner field of the contact.
     // Entity reference field, holds the reference to the user object.
     // The view shows the user name field of the user.

content_entity_example/src/Entity/Controller/ContactListBuilder.php

@@ -78,7 +78,6 @@ public function buildHeader() {
     $header['id'] = $this->t('ContactID');
     $header['name'] = $this->t('Name');
     $header['first_name'] = $this->t('First Name');
-    $header['gender'] = $this->t('Gender');
     $header['role'] = $this->t('Role');
     return $header + parent::buildHeader();
   }
@@ -91,7 +90,6 @@ public function buildRow(EntityInterface $entity) {
     $row['id'] = $entity->id();
     $row['name'] = $entity->link();
     $row['first_name'] = $entity->first_name->value;
-    $row['gender'] = $entity->gender->value;
     $row['role'] = $entity->role->value;
     return $row + parent::buildRow($entity);
   }

content_entity_example/tests/src/Functional/ContentEntityExampleTest.php

@@ -62,7 +62,6 @@ public function testContentEntityExample() {
     $edit = [
       'name[0][value]' => 'test name',
       'first_name[0][value]' => 'test first name',
-      'gender' => 'male',
       'role' => 'administrator',
     ];
     $this->drupalPostForm(NULL, $edit, 'Save');
@@ -77,7 +76,6 @@ public function testContentEntityExample() {
     $assert->pageTextContains('test name');
     $assert->pageTextContains('test first name');
     $assert->pageTextContains('administrator');
-    $assert->pageTextContains('male');
     $assert->linkExists('Add contact');
     $assert->linkExists('Edit');
     $assert->linkExists('Delete');
@@ -113,7 +111,6 @@ public function testPaths() {
     $contact = Contact::create([
       'name' => 'somename',
       'first_name' => 'Joe',
-      'gender' => 'female',
       'role' => 'administrator',
     ]);
     $contact->save();
@@ -269,7 +266,6 @@ public function testCreateAdminPermission() {
     $edit = [
       'name[0][value]' => 'Test Admin Name',
       'first_name[0][value]' => 'Admin First Name',
-      'gender' => 'female',
       'role' => 'administrator',
     ];
     $this->drupalPostForm($add_url, $edit, 'Save');
@@ -288,7 +284,6 @@ public function testCreateAdminPermission() {
     $edit = [
       'name[0][value]' => 'Mere Mortal Name',
       'first_name[0][value]' => 'Mortal First Name',
-      'gender' => 'male',
       'role' => 'user',
     ];
     $this->drupalPostForm($add_url, $edit, 'Save');

content_entity_example/tests/src/Kernel/ContactTest.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Drupal\Tests\content_entity_example\Kernel;
+
+use Drupal\content_entity_example\Entity\Contact;
+use Drupal\KernelTests\KernelTestBase;
+
+/**
+ * Test basic CRUD operations for our Contact entity type.
+ *
+ * @group content_entity_example
+ * @group examples
+ *
+ * @ingroup content_entity_example
+ */
+class ContactTest extends KernelTestBase {
+
+  protected static $modules = ['content_entity_example', 'options', 'user'];
+
+  /**
+   * Basic CRUD operations on a Contact entity.
+   */
+  public function testEntity() {
+    $this->installEntitySchema('content_entity_example_contact');
+    $entity = Contact::create([
+      'name' => 'Name',
+      'first_name' => 'Firstname',
+      'user_id' => 0,
+      'role' => 'user',
+    ]);
+    $this->assertNotNull($entity);
+    $this->assertEquals(SAVED_NEW, $entity->save());
+    $this->assertEquals(SAVED_UPDATED, $entity->set('role', 'administrator')->save());
+    $entity_id = $entity->id();
+    $this->assertNotEmpty($entity_id);
+    $entity->delete();
+    $this->assertNull(Contact::load($entity_id));
+  }
+
+}