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

Inheritance diagram for AbstractFactoryTest:

Collaboration diagram for AbstractFactoryTest:

Public Member Functions
	buildFactoryReflection ()

	methods_provider ()

	setUp ()

	test_proper_namespace ()

	test_proper_name ()

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

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

	test_factory_method_name_compatible_docstring ($method_reflection, $name)
	Tests whether the method name matches the. More...

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

	test_kitchensink_info_description ($method_reflection, $name)
	methods_provider More...

	test_kitchensink_info_background ($method_reflection, $name)
	methods_provider More...

	test_kitchensink_info_featurewiki ($method_reflection, $name)
	methods_provider More...

	test_kitchensink_info_javascript ($method_reflection, $name)
	methods_provider More...

	test_kitchensink_info_rules ($method_reflection, $name)
	methods_provider More...

	test_kitchensink_info_context ($method_reflection, $name)
	methods_provider More...

	kitchensink_info_settings_merged_with_defaults ($name)

Data Fields
const	COMPONENT = 1

const	FACTORY = 2

Protected Member Functions
	returnsFactory ($docstring_data)

	returnsComponent ($docstring_data)

	isFactoryName ($name)

	get_regex_factory_namespace ()

Private Attributes
	$kitchensink_info_settings_default

	$description_categories

	$rules_categories

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 17 of file AbstractFactoryTest.php.

Member Function Documentation

◆ buildFactoryReflection()

AbstractFactoryTest::buildFactoryReflection ( )

final

Definition at line 68 of file AbstractFactoryTest.php.

Referenced by methods_provider(), and setUp().

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

Here is the caller graph for this function:

◆ get_regex_factory_namespace()

AbstractFactoryTest::get_regex_factory_namespace ( )

protected

Definition at line 181 of file AbstractFactoryTest.php.

Referenced by test_factory_method_name_compatible_docstring().

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

Here is the caller graph for this function:

◆ isFactoryName()

AbstractFactoryTest::isFactoryName ( $name )

finalprotected

Definition at line 64 of file AbstractFactoryTest.php.

Referenced by returnsFactory(), and test_proper_name().

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

Here is the caller graph for this function:

◆ kitchensink_info_settings_merged_with_defaults()

AbstractFactoryTest::kitchensink_info_settings_merged_with_defaults ( $name )

final

Definition at line 306 of file AbstractFactoryTest.php.

References $kitchensink_info_settings_default.

Referenced by test_kitchensink_info_background(), test_kitchensink_info_context(), test_kitchensink_info_description(), test_kitchensink_info_featurewiki(), test_kitchensink_info_javascript(), and test_kitchensink_info_rules().

                                                                                     {
                 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:

◆ methods_provider()

AbstractFactoryTest::methods_provider ( )

final

Definition at line 72 of file AbstractFactoryTest.php.

References array, and buildFactoryReflection().

                                                  {
                 $reflection = $this->buildFactoryReflection();
                 return array_map(function($element) {
                         return array($element, $element->getName());
                 }, $reflection->getMethods());
         }

Here is the call graph for this function:

◆ returnsComponent()

AbstractFactoryTest::returnsComponent ( $docstring_data )

finalprotected

Definition at line 59 of file AbstractFactoryTest.php.

Referenced by test_return_type().

                                                                    {
                 $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 ( $docstring_data )

finalprotected

Definition at line 55 of file AbstractFactoryTest.php.

References isFactoryName().

Referenced by test_factory_method_name_compatible_docstring(), test_kitchensink_info_context(), test_method_params(), and test_return_type().

                                                                  {
                 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 81 of file AbstractFactoryTest.php.

References buildFactoryReflection().

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

Here is the call graph for this function:

◆ test_check_yaml_extraction()

AbstractFactoryTest::test_check_yaml_extraction	(	$method_reflection,
		$name
	)

final

Tests whether the YAML Kitchen Sink info can be parsed.

methods_provider

Definition at line 109 of file AbstractFactoryTest.php.

Referenced by test_factory_method_name_compatible_docstring(), test_kitchensink_info_background(), test_kitchensink_info_context(), test_kitchensink_info_description(), test_kitchensink_info_featurewiki(), test_kitchensink_info_javascript(), test_kitchensink_info_rules(), test_method_params(), and test_return_type().

                                                                                     {
                 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:

◆ test_factory_method_name_compatible_docstring()

AbstractFactoryTest::test_factory_method_name_compatible_docstring	(	$method_reflection,
		$name
	)

final

Tests whether the method name matches the.

Returns: doctring?

methods_provider

Definition at line 149 of file AbstractFactoryTest.php.

References get_regex_factory_namespace(), returnsFactory(), test_check_yaml_extraction(), and test_return_type().

                                                                                                        {
                 $docstring_data = $this->test_check_yaml_extraction($method_reflection, $name);
                 $this->test_return_type($method_reflection, $name);
 
                 $return_doc = $docstring_data["namespace"];
                 $name_uppercase = ucwords($name);
                 $regex_factory_namespace = $this->get_regex_factory_namespace();
                 $regex_head = "#^(\\\\?)$regex_factory_namespace";
 
                 $message = "TODO ($name): fix @return, it does not match the method name.";
                 if ($this->returnsFactory($docstring_data)) {
                         $this->assertRegExp
                         ( "$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:

◆ test_kitchensink_info_background()

AbstractFactoryTest::test_kitchensink_info_background	(	$method_reflection,
		$name
	)

final

methods_provider

Definition at line 227 of file AbstractFactoryTest.php.

References kitchensink_info_settings_merged_with_defaults(), and test_check_yaml_extraction().

                                                                                           {
                 $docstring_data = $this->test_check_yaml_extraction($method_reflection, $name);
                 $kitchensink_info_settings = $this->kitchensink_info_settings_merged_with_defaults($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:

◆ test_kitchensink_info_context()

AbstractFactoryTest::test_kitchensink_info_context	(	$method_reflection,
		$name
	)

final

methods_provider

Definition at line 289 of file AbstractFactoryTest.php.

References kitchensink_info_settings_merged_with_defaults(), returnsFactory(), and test_check_yaml_extraction().

                                                                                        {
                 $docstring_data = $this->test_check_yaml_extraction($method_reflection, $name);
                 $kitchensink_info_settings = $this->kitchensink_info_settings_merged_with_defaults($name);
 
                 // Special rules for factory methods:
                 if ($this->returnsFactory($docstring_data)) {
                         $message = "TODO ($name): remove 'context' field, method returns a factory.";
                         $this->assertArrayNotHasKey("context", $docstring_data, $message);
                 }
                 else { // returnsComponent
                         if ($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:

◆ test_kitchensink_info_description()

AbstractFactoryTest::test_kitchensink_info_description	(	$method_reflection,
		$name
	)

final

methods_provider

Definition at line 204 of file AbstractFactoryTest.php.

References kitchensink_info_settings_merged_with_defaults(), and test_check_yaml_extraction().

                                                                                            {
                 $docstring_data = $this->test_check_yaml_extraction($method_reflection, $name);
                 $kitchensink_info_settings = $this->kitchensink_info_settings_merged_with_defaults($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:

◆ test_kitchensink_info_featurewiki()

AbstractFactoryTest::test_kitchensink_info_featurewiki	(	$method_reflection,
		$name
	)

final

methods_provider

Definition at line 240 of file AbstractFactoryTest.php.

References kitchensink_info_settings_merged_with_defaults(), and test_check_yaml_extraction().

                                                                                            {
                 $docstring_data = $this->test_check_yaml_extraction($method_reflection, $name);
                 $kitchensink_info_settings = $this->kitchensink_info_settings_merged_with_defaults($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:

◆ test_kitchensink_info_javascript()

AbstractFactoryTest::test_kitchensink_info_javascript	(	$method_reflection,
		$name
	)

final

methods_provider

Definition at line 253 of file AbstractFactoryTest.php.

References kitchensink_info_settings_merged_with_defaults(), and test_check_yaml_extraction().

                                                                                           {
                 $docstring_data = $this->test_check_yaml_extraction($method_reflection, $name);
                 $kitchensink_info_settings = $this->kitchensink_info_settings_merged_with_defaults($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:

◆ test_kitchensink_info_rules()

AbstractFactoryTest::test_kitchensink_info_rules	(	$method_reflection,
		$name
	)

final

methods_provider

Definition at line 266 of file AbstractFactoryTest.php.

References kitchensink_info_settings_merged_with_defaults(), and test_check_yaml_extraction().

                                                                                      {
                 $docstring_data = $this->test_check_yaml_extraction($method_reflection, $name);
                 $kitchensink_info_settings = $this->kitchensink_info_settings_merged_with_defaults($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:

◆ test_method_params()

AbstractFactoryTest::test_method_params	(	$method_reflection,
		$name
	)

final

Tests whether methods returning factories have no parameters.

methods_provider

Definition at line 190 of file AbstractFactoryTest.php.

References returnsFactory(), and test_check_yaml_extraction().

                                                                             {
                 $docstring_data = $this->test_check_yaml_extraction($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:

◆ test_proper_name()

AbstractFactoryTest::test_proper_name ( )

Definition at line 95 of file AbstractFactoryTest.php.

References isFactoryName().

                                            {
                 $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:

◆ test_proper_namespace()

AbstractFactoryTest::test_proper_namespace ( )

Definition at line 86 of file AbstractFactoryTest.php.

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

◆ test_return_type()

AbstractFactoryTest::test_return_type	(	$method_reflection,
		$name
	)

final

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

methods_provider

Definition at line 130 of file AbstractFactoryTest.php.

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

Referenced by test_factory_method_name_compatible_docstring().

                                                                           {
                 $message = "TODO ($name): fix return type, it must be a factory or a component.";
                 $docstring_data = $this->test_check_yaml_extraction($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

AbstractFactoryTest::$description_categories

private

Initial value:

=

array('purpose', 'composition', 'effect', 'rival')

Definition at line 48 of file AbstractFactoryTest.php.

◆ $kitchensink_info_settings_default

AbstractFactoryTest::$kitchensink_info_settings_default

private

Initial value:

= array('description'
                        => true
                        ,'background'
                                        => false
                        ,'context'
                                        => true
                        ,'featurewiki'
                                        => false
                        ,'javascript'
                                        => false
                        ,'rules'
                                        => true)

Definition at line 28 of file AbstractFactoryTest.php.

Referenced by kitchensink_info_settings_merged_with_defaults().

◆ $rules_categories

AbstractFactoryTest::$rules_categories

private

Initial value:

=
                        array('usage', 'interaction', 'wording', 'style', 'ordering', 'responsiveness',
                                        'composition','accessibility')

Definition at line 51 of file AbstractFactoryTest.php.

◆ COMPONENT

const AbstractFactoryTest::COMPONENT = 1

Definition at line 19 of file AbstractFactoryTest.php.

◆ FACTORY

const AbstractFactoryTest::FACTORY = 2

Definition at line 20 of file AbstractFactoryTest.php.

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

tests/UI/AbstractFactoryTest.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ buildFactoryReflection()

◆ get_regex_factory_namespace()

◆ isFactoryName()

◆ kitchensink_info_settings_merged_with_defaults()

◆ methods_provider()

◆ returnsComponent()

◆ returnsFactory()

◆ setUp()

◆ test_check_yaml_extraction()

◆ test_factory_method_name_compatible_docstring()

◆ test_kitchensink_info_background()

◆ test_kitchensink_info_context()

◆ test_kitchensink_info_description()

◆ test_kitchensink_info_featurewiki()

◆ test_kitchensink_info_javascript()

◆ test_kitchensink_info_rules()

◆ test_method_params()

◆ test_proper_name()

◆ test_proper_namespace()

◆ test_return_type()

Field Documentation

◆ $description_categories

◆ $kitchensink_info_settings_default

◆ $rules_categories

◆ COMPONENT

◆ FACTORY