Defines tests every SHOULD pass UI-factory. More...

Inheritance diagram for AbstractFactoryTestCase:

Collaboration diagram for AbstractFactoryTestCase:

Public Member Functions
	setUp ()

	testProperNamespace ()

	testProperName ()

	testCheckYamlExtraction (ReflectionMethod $method_reflection, string $name)
	Tests whether the YAML Kitchen Sink info can be parsed. More...

	testReturnType (ReflectionMethod $method_reflection, string $name)
	Tests whether the method either returns a factory or a component. More...

	testFactoryMethodNameCompatibleDocstring (ReflectionMethod $method_reflection, string $name)
	Tests whether the method name matches the return doctring? More...

	testMethodParams (ReflectionMethod $method_reflection, string $name)
	Tests whether methods returning factories have no parameters. More...

	testKitchensinkInfoDescription (ReflectionMethod $method_reflection, string $name)

	testKitchensinkInfoRivals (ReflectionMethod $method_reflection, string $name)

	testKitchensinkInfoBackground (ReflectionMethod $method_reflection, string $name)

	testKitchensinkInfoFeatureWiki (ReflectionMethod $method_reflection, string $name)

	testKitchensinkInfoJavaScript (ReflectionMethod $method_reflection, string $name)

	testKitchensinkInfoRules (ReflectionMethod $method_reflection, string $name)

	testKitchensinkInfoContext (ReflectionMethod $method_reflection, string $name)

	kitchensinkInfoSettingsMergedWithDefaults (string $name)

Static Public Member Functions
static	buildFactoryReflection ()

static	getMethodsProvider ()

Data Fields
const	COMPONENT = 1

const	FACTORY = 2

Static Public Attributes
static string	$factory_title = ''

Protected Member Functions
	returnsFactory (array $docstring_data)

	returnsComponent (array $docstring_data)

	isFactoryName (string $name)

	getRegexFactoryNamespace ()

Private Attributes
Crawler EntriesYamlParser	$yaml_parser

Static Private Attributes
static array	$omit_factory_methods

static array	$kitchensink_info_settings_default

static array	$description_categories = ['purpose', 'composition', 'effect', 'rival']

static array	$rules_categories

static ReflectionClass	$reflection

Detailed Description

Defines tests every SHOULD pass UI-factory.

Checks as much rules as possible from the 'Interfaces to Factories' part of the UI framework rules.

TODO: This test heavily relies on data providers and dependencies. PHPUnit does not support dependencies per provided data set via @depends, therefore the test express the dependencies explicitly by calling subsequent testing methods. These leads to test methods being executed to often.

Definition at line 36 of file AbstractFactoryTestCase.php.

Member Function Documentation

◆ buildFactoryReflection()

static AbstractFactoryTestCase::buildFactoryReflection ( )

staticfinal

Definition at line 101 of file AbstractFactoryTestCase.php.

                                                         : ReflectionClass
    {
        return new ReflectionClass(static::$factory_title);
    }

Referenced by getMethodsProvider(), and setUp().

Here is the caller graph for this function:

◆ getMethodsProvider()

static AbstractFactoryTestCase::getMethodsProvider ( )

staticfinal

Definition at line 106 of file AbstractFactoryTestCase.php.

                                                     : array
    {
 
        $reflection = self::buildFactoryReflection();
        return array_filter(
            array_map(function ($element) {
                if (!in_array($element->getName(), self::$omit_factory_methods)) {
                    return array($element, $element->getName());
                }
                return false;
            }, $reflection->getMethods())
        );
    }

References $reflection, and buildFactoryReflection().

Here is the call graph for this function:

◆ getRegexFactoryNamespace()

AbstractFactoryTestCase::getRegexFactoryNamespace ( )

protected

Reimplemented in MainFactoryTest.

Definition at line 221 of file AbstractFactoryTestCase.php.

                                                 : string
    {
        return str_replace("\\", "\\\\", self::$reflection->getNamespaceName());
    }

◆ isFactoryName()

AbstractFactoryTestCase::isFactoryName ( string $name )

finalprotected

Definition at line 96 of file AbstractFactoryTestCase.php.

                                                        : bool
    {
        return preg_match("#^(\\\\)?ILIAS\\\\UI\\\\Component\\\\([a-zA-Z]+\\\\)*Factory$#", $name) === 1;
    }

Referenced by returnsFactory(), and testProperName().

Here is the caller graph for this function:

◆ kitchensinkInfoSettingsMergedWithDefaults()

AbstractFactoryTestCase::kitchensinkInfoSettingsMergedWithDefaults ( string $name )

final

Definition at line 344 of file AbstractFactoryTestCase.php.

                                                                                 : array
    {
        if (array_key_exists($name, static::$kitchensink_info_settings)) {
            return array_merge(
                static::$kitchensink_info_settings_default,
                static::$kitchensink_info_settings[$name]
            );
        } else {
            return static::$kitchensink_info_settings_default;
        }
    }

◆ returnsComponent()

AbstractFactoryTestCase::returnsComponent ( array $docstring_data )

finalprotected

Definition at line 90 of file AbstractFactoryTestCase.php.

                                                                    : bool
    {
        $reflection = new ReflectionClass($docstring_data["namespace"]);
        return in_array("ILIAS\\UI\\Component\\Component", $reflection->getInterfaceNames());
    }

References $reflection.

Referenced by testReturnType().

Here is the caller graph for this function:

◆ returnsFactory()

AbstractFactoryTestCase::returnsFactory ( array $docstring_data )

finalprotected

Definition at line 85 of file AbstractFactoryTestCase.php.

                                                                  : bool
    {
        return $this->isFactoryName($docstring_data["namespace"]);
    }

References isFactoryName().

Referenced by testReturnType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUp()

AbstractFactoryTestCase::setUp ( )

Definition at line 122 of file AbstractFactoryTestCase.php.

                           : void
    {
        $this->yaml_parser = new Crawler\EntriesYamlParser();
        self::$reflection = $this->buildFactoryReflection();
    }

References buildFactoryReflection().

Here is the call graph for this function:

◆ testCheckYamlExtraction()

AbstractFactoryTestCase::testCheckYamlExtraction	(	ReflectionMethod	$method_reflection,
		string	$name
	)

final

Tests whether the YAML Kitchen Sink info can be parsed.

Definition at line 149 of file AbstractFactoryTestCase.php.

                                                                                                    : array
    {
        try {
            //Todo (TA) this is not pretty. We should think about using only reflection in the parser as well.
            $function_name_string = "\n public function " . $method_reflection->getName() . "()";
            $docstring_data = $this->yaml_parser->parseArrayFromString(
                $method_reflection->getDocComment() . $function_name_string
            );
            $this->assertTrue(true);
        } catch (CrawlerException\CrawlerException $e) {
            $message = "TODO ($name): fix parse error in kitchen sink yaml: " . $e->getMessage();
            $this->assertTrue(false, $message);
        }
        $this->assertCount(1, $docstring_data);
        return $docstring_data[0];
    }

References Vendor\Package\$e.

Referenced by testReturnType().

Here is the caller graph for this function:

◆ testFactoryMethodNameCompatibleDocstring()

AbstractFactoryTestCase::testFactoryMethodNameCompatibleDocstring	(	ReflectionMethod	$method_reflection,
		string	$name
	)

final

Tests whether the method name matches the return doctring?

Definition at line 187 of file AbstractFactoryTestCase.php.

     : void {
        $docstring_data = $this->testCheckYamlExtraction($method_reflection, $name);
        $this->testReturnType($method_reflection, $name);
 
        $return_doc = $docstring_data["namespace"];
        $name_uppercase = ucwords($name);
        $regex_factory_namespace = $this->getRegexFactoryNamespace();
        $regex_head = "#^(\\\\?)$regex_factory_namespace";
 
        $message = "TODO ($name): fix @return, it does not match the method name.";
        if ($this->returnsFactory($docstring_data)) {
            $this->assertMatchesRegularExpression(
                "$regex_head\\\\$name_uppercase\\\\Factory$#",
                $return_doc,
                $message
            );
        } else { // returnsComponent
            // Every component MUST be described by a single interface, where the name of
            // the interface corresponds to the name of the component.
            $standard_pattern = "$regex_head\\\\$name_uppercase#";
            $standard_case = preg_match($standard_pattern, $return_doc);
 
            // unless they only differ in a type and share a common prefix to their pathes.
            $namespace_parts = explode("\\", self::$reflection->getNamespaceName());
            $typediff_only_pattern = "$regex_head\\\\" . array_pop($namespace_parts) . "#";
            $typediff_only_case = preg_match($typediff_only_pattern, $return_doc);
 
            $this->assertTrue($standard_case || $typediff_only_case, $message);
        }
    }

◆ testKitchensinkInfoBackground()

AbstractFactoryTestCase::testKitchensinkInfoBackground	(	ReflectionMethod	$method_reflection,
		string	$name
	)

final

Definition at line 276 of file AbstractFactoryTestCase.php.

                                                                                                          : void
    {
        $docstring_data = $this->testCheckYamlExtraction($method_reflection, $name);
        $kitchensink_info_settings = $this->kitchensinkInfoSettingsMergedWithDefaults($name);
 
        if ($kitchensink_info_settings['background']) {
            $message = "TODO ($name): add a background field.";
            $this->assertArrayHasKey('background', $docstring_data, $message);
        }
    }

◆ testKitchensinkInfoContext()

AbstractFactoryTestCase::testKitchensinkInfoContext	(	ReflectionMethod	$method_reflection,
		string	$name
	)

final

Definition at line 334 of file AbstractFactoryTestCase.php.

                                                                                                       : void
    {
        $docstring_data = $this->testCheckYamlExtraction($method_reflection, $name);
        $kitchensink_info_settings = $this->kitchensinkInfoSettingsMergedWithDefaults($name);
        if (!$this->returnsFactory($docstring_data) && $kitchensink_info_settings["context"]) {
            $message = "TODO ($name): factory method returning component should have context field. Add it.";
            $this->assertArrayHasKey("context", $docstring_data, $message);
        }
    }

◆ testKitchensinkInfoDescription()

AbstractFactoryTestCase::testKitchensinkInfoDescription	(	ReflectionMethod	$method_reflection,
		string	$name
	)

final

Definition at line 242 of file AbstractFactoryTestCase.php.

                                                                                                           : void
    {
        $docstring_data = $this->testCheckYamlExtraction($method_reflection, $name);
        $kitchensink_info_settings = $this->kitchensinkInfoSettingsMergedWithDefaults($name);
 
        if ($kitchensink_info_settings['description']) {
            $message = "TODO ($name): add a description.";
            $this->assertArrayHasKey('description', $docstring_data, $message);
 
            $desc_fields = implode(", ", static::$description_categories);
            $message = "TODO ($name): the description field should at least contain one of these: $desc_fields.";
            $existing_keys = array_keys($docstring_data["description"]);
            $existing_expected_keys = array_intersect(static::$description_categories, $existing_keys);
            $this->assertGreaterThanOrEqual(
                1,
                $existing_expected_keys,
                $message
            );
        }
    }

◆ testKitchensinkInfoFeatureWiki()

AbstractFactoryTestCase::testKitchensinkInfoFeatureWiki	(	ReflectionMethod	$method_reflection,
		string	$name
	)

final

Definition at line 288 of file AbstractFactoryTestCase.php.

                                                                                                           : void
    {
        $docstring_data = $this->testCheckYamlExtraction($method_reflection, $name);
        $kitchensink_info_settings = $this->kitchensinkInfoSettingsMergedWithDefaults($name);
 
        if ($kitchensink_info_settings['featurewiki']) {
            $message = "TODO ($name): add a featurewiki field.";
            $this->assertArrayHasKey('featurewiki', $docstring_data, $message);
        }
    }

◆ testKitchensinkInfoJavaScript()

AbstractFactoryTestCase::testKitchensinkInfoJavaScript	(	ReflectionMethod	$method_reflection,
		string	$name
	)

final

Definition at line 300 of file AbstractFactoryTestCase.php.

                                                                                                          : void
    {
        $docstring_data = $this->testCheckYamlExtraction($method_reflection, $name);
        $kitchensink_info_settings = $this->kitchensinkInfoSettingsMergedWithDefaults($name);
 
        if ($kitchensink_info_settings['javascript']) {
            $message = "TODO ($name): add a javascript field.";
            $this->assertArrayHasKey('javascript', $docstring_data, $message);
        }
    }

◆ testKitchensinkInfoRivals()

AbstractFactoryTestCase::testKitchensinkInfoRivals	(	ReflectionMethod	$method_reflection,
		string	$name
	)

final

Definition at line 264 of file AbstractFactoryTestCase.php.

                                                                                                      : void
    {
        $docstring_data = $this->testCheckYamlExtraction($method_reflection, $name);
        if (isset($docstring_data["description"]) && isset($docstring_data["description"]["rivals"])) {
            $rules = $docstring_data["description"]["rivals"];
            $message = "TODO ($name): The Rivals field has a non-string index. Format like 'rival_name': 'description'";
            $this->assertTrue(array_unique(array_map("is_string", array_keys($rules))) === array(true), $message);
        }
        $this->assertTrue(true);
    }

◆ testKitchensinkInfoRules()

AbstractFactoryTestCase::testKitchensinkInfoRules	(	ReflectionMethod	$method_reflection,
		string	$name
	)

final

Definition at line 312 of file AbstractFactoryTestCase.php.

                                                                                                     : void
    {
        $docstring_data = $this->testCheckYamlExtraction($method_reflection, $name);
        $kitchensink_info_settings = $this->kitchensinkInfoSettingsMergedWithDefaults($name);
 
        if ($kitchensink_info_settings['rules']) {
            $message = "TODO ($name): add a rules field.";
            $this->assertArrayHasKey('rules', $docstring_data, $message);
 
            $rules_fields = implode(", ", static::$rules_categories);
            $message = "TODO ($name): the rules field should at least contain one of these: $rules_fields.";
            $existing_keys = array_keys($docstring_data["rules"]);
            $existing_expected_keys = array_intersect(static::$rules_categories, $existing_keys);
            $this->assertGreaterThanOrEqual(
                1,
                $existing_expected_keys,
                $message
            );
        }
    }

◆ testMethodParams()

AbstractFactoryTestCase::testMethodParams	(	ReflectionMethod	$method_reflection,
		string	$name
	)

final

Tests whether methods returning factories have no parameters.

Definition at line 230 of file AbstractFactoryTestCase.php.

                                                                                             : void
    {
        $docstring_data = $this->testCheckYamlExtraction($method_reflection, $name);
        if ($this->returnsFactory($docstring_data)) {
            $message = "TODO ($name): remove params from method that returns Factory.";
            $this->assertEquals(0, $method_reflection->getNumberOfParameters(), $message);
        }
    }

◆ testProperName()

AbstractFactoryTestCase::testProperName ( )

Reimplemented in MainFactoryTest.

Definition at line 138 of file AbstractFactoryTestCase.php.

                                    : void
    {
        $name = self::$reflection->getName();
        $message = "TODO: Give your factory a proper name.";
        $this->assertTrue($this->isFactoryName($name), $message);
    }

References isFactoryName().

Here is the call graph for this function:

◆ testProperNamespace()

AbstractFactoryTestCase::testProperNamespace ( )

Reimplemented in MainFactoryTest.

Definition at line 128 of file AbstractFactoryTestCase.php.

                                         : void
    {
        $message = "TODO: Put your factory into the proper namespace.";
        $this->assertMatchesRegularExpression(
            "#^ILIAS\\\\UI\\\\Component.#",
            self::$reflection->getNamespaceName(),
            $message
        );
    }

◆ testReturnType()

AbstractFactoryTestCase::testReturnType	(	ReflectionMethod	$method_reflection,
		string	$name
	)

final

Tests whether the method either returns a factory or a component.

Definition at line 170 of file AbstractFactoryTestCase.php.

                                                                                           : void
    {
        $message = "TODO ($name): fix return type, it must be a factory or a component.";
        $docstring_data = $this->testCheckYamlExtraction($method_reflection, $name);
        if ($this->returnsFactory($docstring_data)) {
            $this->assertTrue(true);
        } elseif ($this->returnsComponent($docstring_data)) {
            $this->assertTrue(true);
        } else {
            $this->assertTrue(false, $message);
        }
    }

References returnsComponent(), returnsFactory(), and testCheckYamlExtraction().

Here is the call graph for this function:

Field Documentation

◆ $description_categories

array AbstractFactoryTestCase::$description_categories = ['purpose', 'composition', 'effect', 'rival']

staticprivate

Definition at line 68 of file AbstractFactoryTestCase.php.

◆ $factory_title

string AbstractFactoryTestCase::$factory_title = ''

static

Definition at line 83 of file AbstractFactoryTestCase.php.

◆ $kitchensink_info_settings_default

array AbstractFactoryTestCase::$kitchensink_info_settings_default

staticprivate

Initial value:

= [
        'description' => true,
        'background' => false,
        'context' => true,
        'featurewiki' => false,
        'javascript' => false,
        'rules' => true
    ]

Definition at line 52 of file AbstractFactoryTestCase.php.

◆ $omit_factory_methods

array AbstractFactoryTestCase::$omit_factory_methods

staticprivate

Initial value:

= [
        "helpTopics"
    ]

Definition at line 43 of file AbstractFactoryTestCase.php.

◆ $reflection

ReflectionClass AbstractFactoryTestCase::$reflection

staticprivate

Definition at line 82 of file AbstractFactoryTestCase.php.

Referenced by getMethodsProvider(), and returnsComponent().

◆ $rules_categories

array AbstractFactoryTestCase::$rules_categories

staticprivate

Initial value:

= [
        'usage',
        'interaction',
        'wording',
        'style',
        'ordering',
        'responsiveness',
        'composition',
        'accessibility'
    ]

Definition at line 70 of file AbstractFactoryTestCase.php.

◆ $yaml_parser

Crawler EntriesYamlParser AbstractFactoryTestCase::$yaml_parser

private

Definition at line 81 of file AbstractFactoryTestCase.php.

◆ COMPONENT

const AbstractFactoryTestCase::COMPONENT = 1

Definition at line 38 of file AbstractFactoryTestCase.php.

◆ FACTORY

const AbstractFactoryTestCase::FACTORY = 2

Definition at line 39 of file AbstractFactoryTestCase.php.

The documentation for this class was generated from the following file:

components/ILIAS/UI/tests/AbstractFactoryTestCase.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ buildFactoryReflection()

◆ getMethodsProvider()

◆ getRegexFactoryNamespace()

◆ isFactoryName()

◆ kitchensinkInfoSettingsMergedWithDefaults()

◆ returnsComponent()

◆ returnsFactory()

◆ setUp()

◆ testCheckYamlExtraction()

◆ testFactoryMethodNameCompatibleDocstring()

◆ testKitchensinkInfoBackground()

◆ testKitchensinkInfoContext()

◆ testKitchensinkInfoDescription()

◆ testKitchensinkInfoFeatureWiki()

◆ testKitchensinkInfoJavaScript()

◆ testKitchensinkInfoRivals()

◆ testKitchensinkInfoRules()

◆ testMethodParams()

◆ testProperName()

◆ testProperNamespace()

◆ testReturnType()

Field Documentation

◆ $description_categories

◆ $factory_title

◆ $kitchensink_info_settings_default

◆ $omit_factory_methods

◆ $reflection

◆ $rules_categories

◆ $yaml_parser

◆ COMPONENT

◆ FACTORY