ConfigurableLanguageTest - Code Metrics - Inspection of "Entity & Field Plugins" - jhedstrom/DrupalDriver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#157)

unknown

created 2018-05-30 22:18 UTC

ConfigurableLanguageTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	93
Duplicated Lines	21.51 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

Metric	Value
wmc	3
lcom	2
cbo	2
dl	20
loc	93
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	testLanguageCreateDelete()	0	24	1
A	testLanguageCreateDeleteByWrapper()	20	20	1
A	testLanguageDefaultLabel()	0	15	1

How to fix Duplicated Code

<?php

namespace Drupal\Tests\Driver\Kernel\Drupal8\Entity;

use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\Driver\Wrapper\Entity\DriverEntityDrupal8;

/**
 * Tests the driver's handling of language entities.
 *
 * @group driver
 */
class ConfigurableLanguageTest extends DriverEntityKernelTestBase
{

  /**
   * {@inheritdoc}
   */
    public static $modules = ['language',];

  /**
   * Machine name of the entity type being tested.
   *
   * @string
   */
    protected $entityType = 'configurable_language';

  /**
   * Our entity is a config entity.
   *
   * @boolean
   */
    protected $config = true;

  /**
   * Test that a language can be created and deleted.
   */
    public function testLanguageCreateDelete()
    {
        $langcode = 'de';
        $language = (object) [
        'langcode' => $langcode,
        ];
        $languageReturn = $this->driver->languageCreate($language);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        // Test return object has langcode property.
        $this->assertEquals($langcode, $languageReturn->langcode);

        // Test language is created.
        $loadedLanguage = \Drupal::languageManager()->getLanguage($langcode);
        $this->assertNotNull($loadedLanguage);

        // Test false is returned if language already exists.
        $languageReturn = $this->driver->languageCreate($language);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $this->assertFalse($languageReturn);

        // Check the language can be deleted.
        $this->driver->languageDelete($language);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $loadedLanguage = ConfigurableLanguage::load($langcode);
        $this->assertNull($loadedLanguage);
    }

  /**
   * Test that a language can be created and deleted.
   */
    public function testLanguageCreateDeleteByWrapper()

    {
        $langcode = $this->randomMachineName();
        $label = $this->randomMachineName();
        $entity = new DriverEntityDrupal8(
            $this->entityType
        );
        $entity->set('id', $langcode);
        $entity->set('label', $label);
        $entity->save();

        $language = ConfigurableLanguage::load($langcode);
        $this->assertNotNull($language);
        $this->assertEquals($langcode, $language->get('id'));

        // Check the language can be deleted.
        $entity->delete();
        $language = ConfigurableLanguage::load($langcode);
        $this->assertNull($language);
    }

    /**
     * Test that a default label is provided based on langcode.
     */
    public function testLanguageDefaultLabel()
    {
      $langcode = 'hu';
      $label = 'Hungarian';
      $entity = new DriverEntityDrupal8(
        $this->entityType
      );
      $entity->set('id', $langcode);
      $entity->save();

      $language = ConfigurableLanguage::load($langcode);
      $this->assertNotNull($language);
      $this->assertEquals($label, $language->get('label'));

    }
}


1		<?php
2
3		namespace Drupal\Tests\Driver\Kernel\Drupal8\Entity;
4
5		use Drupal\language\Entity\ConfigurableLanguage;
6		use Drupal\Driver\Wrapper\Entity\DriverEntityDrupal8;
7
8		/**
9		* Tests the driver's handling of language entities.
10		*
11		* @group driver
12		*/
13		class ConfigurableLanguageTest extends DriverEntityKernelTestBase
14		{
15
16		/**
17		* {@inheritdoc}
18		*/
19		public static $modules = ['language',];
20
21		/**
22		* Machine name of the entity type being tested.
23		*
24		* @string
25		*/
26		protected $entityType = 'configurable_language';
27
28		/**
29		* Our entity is a config entity.
30		*
31		* @boolean
32		*/
33		protected $config = true;
34
35		/**
36		* Test that a language can be created and deleted.
37		*/
38		public function testLanguageCreateDelete()
39		{
40		$langcode = 'de';
41		$language = (object) [
42		'langcode' => $langcode,
43		];
44		$languageReturn = $this->driver->languageCreate($language);
		0 ignored issues – show Bug introduced 2018-01-14 13:09 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Drupal\Driver\DriverInterface` as the method `languageCreate()` does only exist in the following implementations of said interface: `Drupal\Driver\DrupalDriver`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
45
46		// Test return object has langcode property.
47		$this->assertEquals($langcode, $languageReturn->langcode);
48
49		// Test language is created.
50		$loadedLanguage = \Drupal::languageManager()->getLanguage($langcode);
51		$this->assertNotNull($loadedLanguage);
52
53		// Test false is returned if language already exists.
54		$languageReturn = $this->driver->languageCreate($language);
		0 ignored issues – show Bug introduced 2018-01-14 13:09 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Drupal\Driver\DriverInterface` as the method `languageCreate()` does only exist in the following implementations of said interface: `Drupal\Driver\DrupalDriver`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
55		$this->assertFalse($languageReturn);
56
57		// Check the language can be deleted.
58		$this->driver->languageDelete($language);
		0 ignored issues – show Bug introduced 2018-01-14 13:09 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Drupal\Driver\DriverInterface` as the method `languageDelete()` does only exist in the following implementations of said interface: `Drupal\Driver\DrupalDriver`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
59		$loadedLanguage = ConfigurableLanguage::load($langcode);
60		$this->assertNull($loadedLanguage);
61		}
62
63		/**
64		* Test that a language can be created and deleted.
65		*/
66	View Code Duplication	public function testLanguageCreateDeleteByWrapper()
		0 ignored issues – show Duplication introduced 2018-01-14 13:09 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
67		{
68		$langcode = $this->randomMachineName();
69		$label = $this->randomMachineName();
70		$entity = new DriverEntityDrupal8(
71		$this->entityType
72		);
73		$entity->set('id', $langcode);
74		$entity->set('label', $label);
75		$entity->save();
76
77		$language = ConfigurableLanguage::load($langcode);
78		$this->assertNotNull($language);
79		$this->assertEquals($langcode, $language->get('id'));
80
81		// Check the language can be deleted.
82		$entity->delete();
83		$language = ConfigurableLanguage::load($langcode);
84		$this->assertNull($language);
85		}
86
87		/**
88		* Test that a default label is provided based on langcode.
89		*/
90		public function testLanguageDefaultLabel()
91		{
92		$langcode = 'hu';
93		$label = 'Hungarian';
94		$entity = new DriverEntityDrupal8(
95		$this->entityType
96		);
97		$entity->set('id', $langcode);
98		$entity->save();
99
100		$language = ConfigurableLanguage::load($langcode);
101		$this->assertNotNull($language);
102		$this->assertEquals($label, $language->get('label'));
103
104		}
105		}
106

jhedstrom / DrupalDriver

Pull Request — master (#157)

ConfigurableLanguageTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like