AbstractFactoryTest Class Reference

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

Inheritance diagram for AbstractFactoryTest:

Collaboration diagram for AbstractFactoryTest:

Public Member Functions
	buildFactoryReflection ()
	getMethodsProvider ()
	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)
	getMethodsProvider More...
	testKitchensinkInfoRivals (ReflectionMethod $method_reflection, string $name)
	getMethodsProvider More...
	testKitchensinkInfoBackground (ReflectionMethod $method_reflection, string $name)
	getMethodsProvider More...
	testKitchensinkInfoFeatureWiki (ReflectionMethod $method_reflection, string $name)
	getMethodsProvider More...
	testKitchensinkInfoJavaScript (ReflectionMethod $method_reflection, string $name)
	getMethodsProvider More...
	testKitchensinkInfoRules (ReflectionMethod $method_reflection, string $name)
	getMethodsProvider More...
	testKitchensinkInfoContext (ReflectionMethod $method_reflection, string $name)
	getMethodsProvider More...
	kitchensinkInfoSettingsMergedWithDefaults (string $name)

Data Fields
const	COMPONENT = 1
const	FACTORY = 2

Protected Member Functions
	returnsFactory (array $docstring_data)
	returnsComponent (array $docstring_data)
	isFactoryName (string $name)
	getRegexFactoryNamespace ()

Private Attributes
array	$omit_factory_methods
array	$kitchensink_info_settings_default
array array	$description_categories = ['purpose', 'composition', 'effect', 'rival']
array	$rules_categories
Crawler EntriesYamlParser	$yaml_parser
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 , 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 AbstractFactoryTest.php.

Member Function Documentation

buildFactoryReflection()

AbstractFactoryTest::buildFactoryReflection ( )

final

Definition at line 100 of file AbstractFactoryTest.php.

Referenced by getMethodsProvider(), and setUp().

                                                  : ReflectionClass
    {
        return new ReflectionClass($this->factory_title);
    }

Here is the caller graph for this function:

getMethodsProvider()

AbstractFactoryTest::getMethodsProvider ( )

final

Definition at line 105 of file AbstractFactoryTest.php.

References $omit_factory_methods, and buildFactoryReflection().

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

Here is the call graph for this function:

getRegexFactoryNamespace()

AbstractFactoryTest::getRegexFactoryNamespace ( )

protected

Definition at line 222 of file AbstractFactoryTest.php.

Referenced by testFactoryMethodNameCompatibleDocstring().

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

Here is the caller graph for this function:

isFactoryName()

AbstractFactoryTest::isFactoryName ( string  $name )

finalprotected

Definition at line 95 of file AbstractFactoryTest.php.

Referenced by returnsFactory(), and testProperName().

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

Here is the caller graph for this function:

kitchensinkInfoSettingsMergedWithDefaults()

AbstractFactoryTest::kitchensinkInfoSettingsMergedWithDefaults ( string  $name )

final

Definition at line 361 of file AbstractFactoryTest.php.

References $kitchensink_info_settings_default.

Referenced by testKitchensinkInfoBackground(), testKitchensinkInfoContext(), testKitchensinkInfoDescription(), testKitchensinkInfoFeatureWiki(), testKitchensinkInfoJavaScript(), and testKitchensinkInfoRules().

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

Here is the caller graph for this function:

returnsComponent()

AbstractFactoryTest::returnsComponent ( array  $docstring_data )

finalprotected

Definition at line 89 of file AbstractFactoryTest.php.

Referenced by testReturnType().

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

Here is the caller graph for this function:

returnsFactory()

AbstractFactoryTest::returnsFactory ( array  $docstring_data )

finalprotected

Definition at line 84 of file AbstractFactoryTest.php.

References isFactoryName().

Referenced by testFactoryMethodNameCompatibleDocstring(), testKitchensinkInfoContext(), testMethodParams(), and testReturnType().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setUp()

AbstractFactoryTest::setUp

(

)

Definition at line 120 of file AbstractFactoryTest.php.

References buildFactoryReflection().

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

Here is the call graph for this function:

testCheckYamlExtraction()

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

final

Tests whether the YAML Kitchen Sink info can be parsed.

getMethodsProvider

Definition at line 148 of file AbstractFactoryTest.php.

References Vendor\Package\$e, and $message.

Referenced by testFactoryMethodNameCompatibleDocstring(), testKitchensinkInfoBackground(), testKitchensinkInfoContext(), testKitchensinkInfoDescription(), testKitchensinkInfoFeatureWiki(), testKitchensinkInfoJavaScript(), testKitchensinkInfoRivals(), testKitchensinkInfoRules(), testMethodParams(), and testReturnType().

                                                                                                    : 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];
    }

Here is the caller graph for this function:

testFactoryMethodNameCompatibleDocstring()

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

final

Tests whether the method name matches the return doctring?

getMethodsProvider

Definition at line 188 of file AbstractFactoryTest.php.

References $message, getRegexFactoryNamespace(), returnsFactory(), testCheckYamlExtraction(), and testReturnType().

     : 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("\\", $this->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);
        }
    }

Here is the call graph for this function:

testKitchensinkInfoBackground()

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

final

getMethodsProvider

Definition at line 285 of file AbstractFactoryTest.php.

References $message, kitchensinkInfoSettingsMergedWithDefaults(), and testCheckYamlExtraction().

                                                                                                          : 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);
        }
    }

Here is the call graph for this function:

testKitchensinkInfoContext()

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

final

getMethodsProvider

Definition at line 351 of file AbstractFactoryTest.php.

References $message, kitchensinkInfoSettingsMergedWithDefaults(), returnsFactory(), and testCheckYamlExtraction().

                                                                                                       : 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);
        }
    }

Here is the call graph for this function:

testKitchensinkInfoDescription()

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

final

getMethodsProvider

Definition at line 247 of file AbstractFactoryTest.php.

References $message, kitchensinkInfoSettingsMergedWithDefaults(), and testCheckYamlExtraction().

                                                                                                           : 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(", ", $this->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($this->description_categories, $existing_keys);
            $this->assertGreaterThanOrEqual(
                1,
                $existing_expected_keys,
                $message
            );
        }
    }

Here is the call graph for this function:

testKitchensinkInfoFeatureWiki()

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

final

getMethodsProvider

Definition at line 299 of file AbstractFactoryTest.php.

References $message, kitchensinkInfoSettingsMergedWithDefaults(), and testCheckYamlExtraction().

                                                                                                           : 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);
        }
    }

Here is the call graph for this function:

testKitchensinkInfoJavaScript()

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

final

getMethodsProvider

Definition at line 313 of file AbstractFactoryTest.php.

References $message, kitchensinkInfoSettingsMergedWithDefaults(), and testCheckYamlExtraction().

                                                                                                          : 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);
        }
    }

Here is the call graph for this function:

testKitchensinkInfoRivals()

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

final

getMethodsProvider

Definition at line 271 of file AbstractFactoryTest.php.

References $message, and testCheckYamlExtraction().

                                                                                                      : 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);
    }

Here is the call graph for this function:

testKitchensinkInfoRules()

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

final

getMethodsProvider

Definition at line 327 of file AbstractFactoryTest.php.

References $message, kitchensinkInfoSettingsMergedWithDefaults(), and testCheckYamlExtraction().

                                                                                                     : 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(", ", $this->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($this->rules_categories, $existing_keys);
            $this->assertGreaterThanOrEqual(
                1,
                $existing_expected_keys,
                $message
            );
        }
    }

Here is the call graph for this function:

testMethodParams()

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

final

Tests whether methods returning factories have no parameters.

getMethodsProvider

Definition at line 232 of file AbstractFactoryTest.php.

References $message, returnsFactory(), and testCheckYamlExtraction().

                                                                                             : 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);
        }
    }

Here is the call graph for this function:

testProperName()

AbstractFactoryTest::testProperName

(

)

Definition at line 136 of file AbstractFactoryTest.php.

References $message, and isFactoryName().

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

Here is the call graph for this function:

testProperNamespace()

AbstractFactoryTest::testProperNamespace

(

)

Definition at line 126 of file AbstractFactoryTest.php.

References $message.

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

testReturnType()

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

final

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

getMethodsProvider

Definition at line 170 of file AbstractFactoryTest.php.

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

Referenced by testFactoryMethodNameCompatibleDocstring().

                                                                                           : 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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$description_categories

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

private

Definition at line 68 of file AbstractFactoryTest.php.

$kitchensink_info_settings_default

array AbstractFactoryTest::$kitchensink_info_settings_default

private

Initial value:

= [
        'description' => true

Definition at line 52 of file AbstractFactoryTest.php.

Referenced by kitchensinkInfoSettingsMergedWithDefaults().

$omit_factory_methods

array AbstractFactoryTest::$omit_factory_methods

private

Initial value:

= [
        "helpTopics"
    ]

Definition at line 43 of file AbstractFactoryTest.php.

Referenced by getMethodsProvider().

$reflection

ReflectionClass AbstractFactoryTest::$reflection

private

Definition at line 82 of file AbstractFactoryTest.php.

$rules_categories

array AbstractFactoryTest::$rules_categories

private

Initial value:

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

Definition at line 70 of file AbstractFactoryTest.php.

$yaml_parser

Crawler EntriesYamlParser AbstractFactoryTest::$yaml_parser

private

Definition at line 81 of file AbstractFactoryTest.php.

COMPONENT

const AbstractFactoryTest::COMPONENT = 1

Definition at line 38 of file AbstractFactoryTest.php.

FACTORY

const AbstractFactoryTest::FACTORY = 2

Definition at line 39 of file AbstractFactoryTest.php.

---

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

• tests/UI/AbstractFactoryTest.php