├── .styleci.yml
├── tests
├── assets
│ ├── exampleConfig.yml
│ ├── src
│ │ ├── SingleComponent
│ │ │ ├── index.html
│ │ │ ├── index.php
│ │ │ └── functions.php
│ │ └── ComponentWithArea
│ │ │ └── index.php
│ ├── exampleConfigWithSingleComponent.json
│ └── exampleConfig.json
├── bootstrap.php
├── TestCase.php
├── TestHelper.php
├── test-helpers.php
├── test-render.php
├── test-flynt.php
├── test-defaults.php
├── test-componentManager.php
└── test-buildConstructionPlan.php
├── .gitignore
├── .coveralls.yml
├── .github
├── CODE_OF_CONDUCT.md
└── CONTRIBUTING.md
├── humbug.json.dist
├── .distignore
├── package.json
├── .editorconfig
├── phpcs.ruleset.xml
├── phpunit.xml.dist
├── composer.json
├── flynt-core.php
├── .scrutinizer.yml
├── LICENSE.md
├── .travis.yml
├── lib
├── Flynt
│ ├── Helpers.php
│ ├── ComponentManager.php
│ ├── Defaults.php
│ ├── Render.php
│ └── BuildConstructionPlan.php
└── Flynt.php
├── README.md
├── CHANGELOG.md
└── composer.lock
/.styleci.yml:
--------------------------------------------------------------------------------
1 | preset: psr2
2 |
--------------------------------------------------------------------------------
/tests/assets/exampleConfig.yml:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/tests/assets/src/SingleComponent/index.html:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/tests/assets/src/SingleComponent/index.php:
--------------------------------------------------------------------------------
1 | SingleComponent
2 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | Thumbs.db
3 | wp-cli.local.yml
4 | node_modules/
5 | vendor/
6 | humbuglog.txt
7 |
--------------------------------------------------------------------------------
/.coveralls.yml:
--------------------------------------------------------------------------------
1 | service_name: travis-ci
2 | coverage_clover: logs/clover.xml
3 | json_path: logs/coveralls-upload.json
4 |
--------------------------------------------------------------------------------
/tests/assets/src/ComponentWithArea/index.php:
--------------------------------------------------------------------------------
1 | ComponentWithArea
2 |
--------------------------------------------------------------------------------
/tests/assets/exampleConfigWithSingleComponent.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "SingleComponent",
3 | "customData": {
4 | "test": "result"
5 | }
6 | }
7 |
--------------------------------------------------------------------------------
/.github/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Code of Conduct
2 |
3 | [You can read the Flynt Code of Conduct here](https://github.com/flyntwp/guidelines/blob/master/CODE_OF_CONDUCT.md).
4 |
--------------------------------------------------------------------------------
/humbug.json.dist:
--------------------------------------------------------------------------------
1 | {
2 | "source": {
3 | "directories": [
4 | "lib"
5 | ]
6 | },
7 | "timeout": 10,
8 | "logs": {
9 | "text": "humbuglog.txt"
10 | }
11 | }
--------------------------------------------------------------------------------
/.github/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing to Flynt Core
2 |
3 | Thank you for taking the time to contribute! Read the [Flynt Contributing Guidelines here](https://github.com/flyntwp/guidelines/blob/master/CONTRIBUTING.md).
4 |
--------------------------------------------------------------------------------
/tests/assets/src/SingleComponent/functions.php:
--------------------------------------------------------------------------------
1 | ",
6 | "license": "MIT",
7 | "devDependencies": {
8 | "conventional-github-releaser": "^1.1.3",
9 | "standard-version": "^4.0.0"
10 | },
11 | "scripts": {
12 | "release": "standard-version",
13 | "releaseGithub": "conventional-github-releaser -p angular"
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | # This file is for unifying the coding style for different editors and IDEs
2 | # editorconfig.org
3 |
4 | # WordPress Coding Standards
5 | # https://make.wordpress.org/core/handbook/coding-standards/
6 |
7 | root = true
8 |
9 | [*]
10 | charset = utf-8
11 | end_of_line = lf
12 | insert_final_newline = true
13 | trim_trailing_whitespace = true
14 | indent_style = tab
15 | indent_size = 4
16 |
17 | [{.jshintrc,*.json,*.yml}]
18 | indent_style = space
19 | indent_size = 2
20 |
21 | [{*.txt,wp-config-sample.php}]
22 | end_of_line = crlf
23 |
--------------------------------------------------------------------------------
/phpcs.ruleset.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | Coding Standards for Flynt Core
4 |
5 | .
6 |
7 |
8 |
9 | */node_modules/*
10 | */vendor/*
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
1 |
9 |
10 |
11 | ./tests/
12 |
13 |
14 |
15 |
16 | ./lib/
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "flyntwp/flynt-core",
3 | "type": "wordpress-plugin",
4 | "description": "The Flynt Core Plugin provides a small public interface, combined with several WordPress hooks, to achieve the main principles of the Flynt Framework.",
5 | "license": "MIT",
6 | "authors": [
7 | {
8 | "name": "bleech",
9 | "email": "hello@bleech.de"
10 | }
11 | ],
12 | "homepage": "https://github.com/flyntwp/flynt-core",
13 | "require": {
14 | "composer/installers": "~1.0"
15 | },
16 | "require-dev": {
17 | "phpunit/phpunit": "^5.6",
18 | "brain/monkey": "1.*",
19 | "squizlabs/php_codesniffer": "~2.0"
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/tests/TestCase.php:
--------------------------------------------------------------------------------
1 | andReturnUsing(['\\Flynt\\Tests\\TestHelper', 'getTemplateDirectory']);
19 |
20 | Functions::expect('trailingslashit')
21 | ->andReturnUsing(['\\Flynt\\Tests\\TestHelper', 'trailingSlashIt']);
22 | }
23 |
24 | protected function tearDown()
25 | {
26 | Monkey::tearDownWP();
27 | parent::tearDown();
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/flynt-core.php:
--------------------------------------------------------------------------------
1 | 1) {
30 | return self::extractNestedDataFromArray($args);
31 | } else {
32 | return $args[0];
33 | }
34 | }
35 |
36 | protected static function accessArrayOrObject($key, $data)
37 | {
38 | $output = '';
39 | if (is_array($key) || is_object($key)) {
40 | $output = $key;
41 | } elseif (is_array($data) && array_key_exists($key, $data)) {
42 | $output = $data[$key];
43 | } elseif (is_object($data) && property_exists($data, $key)) {
44 | $output = $data->$key;
45 | }
46 | return $output;
47 | }
48 | }
49 |
--------------------------------------------------------------------------------
/lib/Flynt.php:
--------------------------------------------------------------------------------
1 | registerComponent($componentName, $componentPath);
40 | }
41 |
42 | function registerComponents($components = [])
43 | {
44 | $componentManager = ComponentManager::getInstance();
45 | array_walk($components, function ($componentPath, $componentName) use ($componentManager) {
46 | if (is_int($componentName)) {
47 | $componentName = $componentPath;
48 | $componentPath = null;
49 | } else {
50 | $componentPath = (isset($componentPath)) ? $componentPath : null;
51 | }
52 | $componentManager->registerComponent($componentName, $componentPath);
53 | });
54 | }
55 |
--------------------------------------------------------------------------------
/tests/TestHelper.php:
--------------------------------------------------------------------------------
1 | $componentName,
13 | 'customData' => [
14 | 'test0' => 0,
15 | 'test1' => 'string',
16 | 'test2' => [
17 | 'something strange'
18 | ],
19 | 'duplicate' => 'newValue'
20 | ],
21 | 'areas' => []
22 | ];
23 | }
24 |
25 | // how to use: TestHelper::getCustomComponent('Component', ['name', 'dataFilter'])
26 | public static function getCustomComponent($componentName = 'Component', $config = [])
27 | {
28 | return array_filter(self::getCompleteComponent($componentName), function ($key) use ($config) {
29 | return in_array($key, $config);
30 | }, ARRAY_FILTER_USE_KEY);
31 | }
32 |
33 | public static function getComponentIndexPath($componentName)
34 | {
35 | return self::getComponentPath(null, $componentName) . '/index.php';
36 | }
37 |
38 | public static function getConfigPath()
39 | {
40 | return __DIR__ . "/assets/";
41 | }
42 |
43 | public static function getComponentsPath()
44 | {
45 | return __DIR__ . '/assets/src/';
46 | }
47 |
48 | public static function getComponentPath($componentPath, $componentName)
49 | {
50 | if (is_null($componentPath)) {
51 | return __DIR__ . '/assets/src/' . $componentName;
52 | }
53 | return $componentPath;
54 | }
55 |
56 | public static function getTemplateDirectory()
57 | {
58 | return __DIR__ . "/assets";
59 | }
60 |
61 | public static function trailingSlashIt($string)
62 | {
63 | return rtrim($string, '/\\') . '/';
64 | }
65 | }
66 |
--------------------------------------------------------------------------------
/tests/test-helpers.php:
--------------------------------------------------------------------------------
1 | $bar
27 | ];
28 | $arr = [
29 | 'foo' => $foo
30 | ];
31 | $fooObj = (object) $foo;
32 | $obj = (object) [
33 | 'foo' => $fooObj
34 | ];
35 | $value = Helpers::extractNestedDataFromArray([null]);
36 | $this->assertEquals($value, '');
37 | $value = Helpers::extractNestedDataFromArray(['string']);
38 | $this->assertEquals($value, 'string');
39 | $value = Helpers::extractNestedDataFromArray(['stringA', 'stringB']);
40 | $this->assertEquals($value, '');
41 | $value = Helpers::extractNestedDataFromArray(['stringA', null, 'stringB']);
42 | $this->assertEquals($value, '');
43 | $value = Helpers::extractNestedDataFromArray([$arr, 'boo']);
44 | $this->assertEquals($value, '');
45 | $value = Helpers::extractNestedDataFromArray([$arr, 'foo']);
46 | $this->assertEquals($value, $foo);
47 | $value = Helpers::extractNestedDataFromArray([$arr, 'foo', 'bar']);
48 | $this->assertEquals($value, $bar);
49 | $value = Helpers::extractNestedDataFromArray([[], $arr, 'foo']);
50 | $this->assertEquals($value, $foo);
51 | $value = Helpers::extractNestedDataFromArray([$arr]);
52 | $this->assertEquals($value, $arr);
53 | $value = Helpers::extractNestedDataFromArray([$arr, $foo]);
54 | $this->assertEquals($value, $foo);
55 | $value = Helpers::extractNestedDataFromArray([$obj, 'foo']);
56 | $this->assertEquals($value, $fooObj);
57 | $value = Helpers::extractNestedDataFromArray([$obj, 'foo', 'bar']);
58 | $this->assertEquals($value, $bar);
59 | }
60 | }
61 |
--------------------------------------------------------------------------------
/lib/Flynt/ComponentManager.php:
--------------------------------------------------------------------------------
1 | isRegistered($componentName)) {
40 | trigger_error("Component {$componentName} is already registered!", E_USER_WARNING);
41 | return false;
42 | }
43 |
44 | // register component / require functions.php
45 | $componentPath = trailingslashit(apply_filters('Flynt/componentPath', $componentPath, $componentName));
46 |
47 | // add component to internal list (array)
48 | $this->add($componentName, $componentPath);
49 |
50 | do_action('Flynt/registerComponent', $componentName);
51 | do_action("Flynt/registerComponent?name={$componentName}", $componentName);
52 |
53 | return true;
54 | }
55 |
56 | public function getComponentFilePath($componentName, $fileName = 'index.php')
57 | {
58 | $componentDir = $this->getComponentDirPath($componentName);
59 |
60 | if (false === $componentDir) {
61 | return false;
62 | }
63 |
64 | // dir path already has a trailing slash
65 | $filePath = $componentDir . $fileName;
66 |
67 | return is_file($filePath) ? $filePath : false;
68 | }
69 |
70 | public function getComponentDirPath($componentName)
71 | {
72 | $dirPath = $this->get($componentName);
73 |
74 | // check if dir exists
75 | if (!is_dir($dirPath)) {
76 | return false;
77 | }
78 |
79 | return $dirPath;
80 | }
81 |
82 | protected function add($name, $path)
83 | {
84 | $this->components[$name] = $path;
85 | return true;
86 | }
87 |
88 | public function get($componentName)
89 | {
90 | // check if component exists / is registered
91 | if (!$this->isRegistered($componentName)) {
92 | trigger_error("Cannot get component: Component '{$componentName}' is not registered!", E_USER_WARNING);
93 | return false;
94 | }
95 |
96 | return $this->components[$componentName];
97 | }
98 |
99 | public function remove($componentName)
100 | {
101 | unset($this->components[$componentName]);
102 | }
103 |
104 | public function getAll()
105 | {
106 | return $this->components;
107 | }
108 |
109 | public function removeAll()
110 | {
111 | $this->components = [];
112 | }
113 |
114 | public function isRegistered($componentName)
115 | {
116 | return array_key_exists($componentName, $this->components);
117 | }
118 | }
119 |
--------------------------------------------------------------------------------
/lib/Flynt/Defaults.php:
--------------------------------------------------------------------------------
1 | getComponentFilePath($componentName);
43 | $output = self::renderFile($componentData, $areaHtml, $filePath);
44 | }
45 | return $output;
46 | }
47 |
48 | public static function setComponentPath($componentPath, $componentName)
49 | {
50 | if (is_null($componentPath)) {
51 | $componentPath = self::getComponentsDirectory() . '/' . $componentName;
52 | }
53 | return $componentPath;
54 | }
55 |
56 | public static function getComponentsDirectory()
57 | {
58 | return get_template_directory() . '/' . self::COMPONENT_DIR;
59 | }
60 |
61 | // this action needs to be removed by the user if they want to overwrite this functionality
62 | public static function loadFunctionsFile($componentName)
63 | {
64 | $componentManager = ComponentManager::getInstance();
65 | $filePath = $componentManager->getComponentFilePath($componentName, 'functions.php');
66 | if (false !== $filePath) {
67 | require_once $filePath;
68 | }
69 | }
70 |
71 | protected static function renderFile($componentData, $areaHtml, $filePath)
72 | {
73 | if (!is_file($filePath)) {
74 | trigger_error("Template not found: {$filePath}", E_USER_WARNING);
75 | return '';
76 | }
77 |
78 | $area = function ($areaName) use ($areaHtml) {
79 | if (array_key_exists($areaName, $areaHtml)) {
80 | return $areaHtml[$areaName];
81 | }
82 | };
83 |
84 | $data = function () use ($componentData) {
85 | $args = func_get_args();
86 | array_unshift($args, $componentData);
87 | return Helpers::extractNestedDataFromArray($args);
88 | };
89 |
90 | ob_start();
91 | require $filePath;
92 | $output = ob_get_contents();
93 | ob_get_clean();
94 |
95 | return $output;
96 | }
97 | }
98 |
--------------------------------------------------------------------------------
/lib/Flynt/Render.php:
--------------------------------------------------------------------------------
1 | 'test'
45 | ]],
46 | [[
47 | 'data' => []
48 | ]],
49 | [[
50 | 'name' => 'test',
51 | 'data' => 'dataNotArray'
52 | ]],
53 | [[
54 | 'name' => [],
55 | 'data' => 'dataNotArray'
56 | ]],
57 | [[
58 | 'name' => 'test',
59 | 'data' => [],
60 | 'areas' => [
61 | []
62 | ]
63 | ]],
64 | [[
65 | 'name' => 'test',
66 | 'data' => [],
67 | 'areas' => [
68 | 'testArea' => [
69 | 'test'
70 | ]
71 | ]
72 | ]],
73 | [[
74 | 'name' => 'test',
75 | 'data' => [],
76 | 'areas' => [
77 | 'testArea' => [
78 | 'name' => 'test',
79 | 'data' => []
80 | ]
81 | ]
82 | ]]
83 | ];
84 | }
85 |
86 | /**
87 | * @dataProvider badValues
88 | */
89 | public function testShowWarningWhenConstructionPlanIsInvalid($badValue)
90 | {
91 | $this->expectException('PHPUnit_Framework_Error_Warning');
92 | $cp = Render::fromConstructionPlan($badValue);
93 | }
94 |
95 | /**
96 | * @dataProvider badValues
97 | */
98 | public function testReturnsEmptyStringWhenConstructionPlanIsInvalid($badValue)
99 | {
100 | $cp = @Render::fromConstructionPlan($badValue);
101 | $this->assertEquals($cp, '');
102 | }
103 |
104 | public function testAppliesCustomHtmlHook()
105 | {
106 | // test whether custom html can be used
107 | $componentName = 'SingleComponent';
108 | $cp = [
109 | 'name' => $componentName,
110 | 'data' => []
111 | ];
112 |
113 | $shouldBeHtml = "{$componentName} After Filter Hook
\n";
114 |
115 | Filters::expectApplied('Flynt/renderComponent')
116 | ->once()
117 | ->with(Mockery::mustBe(null), Mockery::type('string'), Mockery::type('array'), Mockery::type('array'))
118 | ->andReturn($shouldBeHtml);
119 |
120 | $html = Render::fromConstructionPlan($cp);
121 | $this->assertEquals($html, $shouldBeHtml);
122 | }
123 |
124 | public function testAppliesCustomHtmlHookToANestedComponent()
125 | {
126 | $parentComponentName = 'ComponentWithArea';
127 | $childComponentName = 'SingleComponent';
128 |
129 | // test whether custom html can be used
130 | $cp = [
131 | 'name' => $parentComponentName,
132 | 'data' => [],
133 | 'areas' => [
134 | 'area51' => [
135 | [
136 | 'name' => $childComponentName,
137 | 'data' => []
138 | ]
139 | ]
140 | ]
141 | ];
142 |
143 | $shouldBeChildOutput = "{$childComponentName} After Filter Hook
\n";
144 | $shouldBeHtml = "{$parentComponentName} result" . $shouldBeChildOutput . "
\n";
145 |
146 | Filters::expectApplied('Flynt/renderComponent')
147 | ->times(2)
148 | ->with(Mockery::mustBe(null), Mockery::type('string'), Mockery::type('array'), Mockery::type('array'))
149 | ->andReturn($shouldBeHtml);
150 |
151 | // Specific Filters renderComponent?name=SingleComponent for example
152 | Filters::expectApplied('Flynt/renderComponent?name=' . $childComponentName)
153 | ->once()
154 | ->with(Mockery::type('string'), Mockery::type('string'), Mockery::type('array'), Mockery::type('array'))
155 | ->andReturn($shouldBeChildOutput);
156 |
157 | $html = Render::fromConstructionPlan($cp);
158 | $this->assertEquals($html, $shouldBeHtml);
159 | }
160 |
161 | public function testDoesBeforeAndAfterActions()
162 | {
163 | $constructionPlan = [
164 | 'name' => 'test'
165 | ];
166 |
167 | Actions::expectFired('Flynt/beforeRenderConstructionPlan')
168 | ->once()
169 | ->with($constructionPlan);
170 |
171 | Actions::expectFired('Flynt/afterRenderConstructionPlan')
172 | ->once()
173 | ->with($constructionPlan);
174 |
175 | @Render::fromConstructionPlan($constructionPlan);
176 | }
177 | }
178 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # flynt-core
2 |
3 | [](https://github.com/RichardLitt/standard-readme)
4 | [](https://travis-ci.org/flyntwp/flynt-core)
5 | [](https://scrutinizer-ci.com/g/flyntwp/flynt-core/?branch=master)
6 | [](https://coveralls.io/github/flyntwp/flynt-core)
7 |
8 | > The core building block of the [Flynt Framework](https://flyntwp.com).
9 |
10 | The Flynt Core WordPress plugin provides a small public interface, combined with several WordPress hooks, to achieve the main principles of the [Flynt Framework](https://flyntwp.com).
11 |
12 | **:warning: DEPRECATED. This repository is no longer in active development. For the latest version of Flynt please use the [new Flynt repository](https://github.com/flyntwp/flynt). :warning:**
13 |
14 | ## Table of Contents
15 |
16 | - [Background](#background)
17 | - [Install](#install)
18 | - [Usage](#usage)
19 | - [Maintainers](#maintainers)
20 | - [Contribute](#contribute)
21 | - [License](#license)
22 |
23 | ## Background
24 |
25 | This plugin essentially functions as a HTML generator with two key steps:
26 |
27 | 1. Given a minimal configuration, the Flynt Core plugin creates a hierarchical plan for how the site will be constructed (the **Construction Plan**).
28 | 2. The Construction Plan is parsed and rendered into HTML.
29 |
30 | Each configuration passed to the plugin represents a single component. This configuration can also contain additional, nested component configurations, which are contained within "areas".
31 |
32 | ## Install
33 |
34 |
35 |
36 | To install via composer, run:
37 |
38 | ```bash
39 | composer require flyntwp/flynt-core
40 | ```
41 |
42 | Activate the plugin in the WordPress back-end and you're good to go.
43 |
44 | ## Usage
45 |
46 | ### Hello World
47 | To see the simplest way of using Flynt Core, add the following code to your theme's `functions.php`:
48 |
49 | ```php
50 | $componentManager = Flynt\ComponentManager::getInstance();
51 | $componentManager->registerComponent('HelloWorld');
52 |
53 | add_filter('Flynt/renderComponent?name=HelloWorld', function () {
54 | return 'Hello, world!';
55 | });
56 | ```
57 | This defines a new component ('HelloWorld'), which when rendered, will output the text 'Hello, world!'.
58 |
59 | To render the component, add the following code to your theme's `index.php`:
60 |
61 | ```php
62 | Flynt\echoHtmlFromConfig([
63 | 'name' => 'HelloWorld'
64 | ]);
65 | ```
66 |
67 | ### Initialize Default Settings
68 |
69 | We recommend initializing the plugin's default settings. Do this by adding the following line of code to your theme's `functions.php`:
70 |
71 | ```php
72 | Flynt\initDefaults();
73 | ```
74 |
75 | This will:
76 |
77 | - Implement the component structure.
78 | - Load component scripts.
79 | - Enable PHP file rendering.
80 |
81 | This also adds the following hooks:
82 |
83 | ```php
84 | // Set the config path to './config'.
85 | add_filter('Flynt/configPath', ['Flynt\Defaults', 'setConfigPath'], 999, 2);
86 |
87 | // Parse `.json` config files.
88 | add_filter('Flynt/configFileLoader', ['Flynt\Defaults', 'loadConfigFile'], 999, 3);
89 |
90 | // Set the component path to `./Components`.
91 | add_filter('Flynt/componentPath', ['Flynt\Defaults', 'setComponentPath'], 999, 2);
92 |
93 | // Load ./Components/{$componentName}/functions.php from every registered component.
94 | add_action('Flynt/registerComponent', ['Flynt\Defaults', 'loadFunctionsFile']);
95 |
96 | // Render `./Components/{$componentName}/index.php` and make view helper functions `$data` and `$area` available (see explanation below).
97 | add_filter('Flynt/renderComponent', ['Flynt\Defaults', 'renderComponent'], 999, 4);
98 | ```
99 |
100 | With the 'Flynt/renderComponent' filter added above you can now use the following helper functions in your template files:
101 | - `$data` is used to access the component's data in the view template.
102 | - `$area` is used to include the HTML of an area's components into the components template itself.
103 |
104 | [You can read the full documentation here.](https://docs.flyntwp.com/guide/core/)
105 |
106 | ## Maintainers
107 |
108 | This project is maintained by [bleech](https://github.com/bleech).
109 |
110 | The main people in charge of this repo are:
111 |
112 | - [Dominik Tränklein](https://github.com/domtra)
113 | - [Doğa Gürdal](https://github.com/Qakulukiam)
114 |
115 | ## Contribute
116 |
117 | To contribute, please use GitHub [issues](https://github.com/flyntwp/flynt-core/issues). Pull requests are accepted. Please also take a moment to read the [Contributing Guidelines](https://github.com/flyntwp/guidelines/blob/master/CONTRIBUTING.md) and [Code of Conduct](https://github.com/flyntwp/guidelines/blob/master/CODE_OF_CONDUCT.md).
118 |
119 | If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
120 |
121 | ## License
122 |
123 | MIT © [bleech](https://www.bleech.de)
124 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Change Log
2 |
3 | All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4 |
5 |
6 | # 1.0.0 (2017-03-27)
7 |
8 |
9 | ### Bug Fixes
10 |
11 | * **BuildConstructionPlan:** always create valid construction plan ([55376f8](https://github.com/flyntwp/flynt-core/commit/55376f8))
12 | * **constructionPlan:** changed exceptions to warnings ([e6c4542](https://github.com/flyntwp/flynt-core/commit/e6c4542))
13 | * **constructionPlan:** do not require non-empty areas for dynamicSubmodules + refactor names ([af34a92](https://github.com/flyntwp/flynt-core/commit/af34a92))
14 | * **defaultLoader:** corrected naming for registerModule hook, added correct exception tests for warn ([254b860](https://github.com/flyntwp/flynt-core/commit/254b860))
15 | * **defaultLoader:** corrected use to be use function for the helper function ([d1f2a8c](https://github.com/flyntwp/flynt-core/commit/d1f2a8c))
16 | * **defaults:** missing argument 4 areaHtml ([cf855a0](https://github.com/flyntwp/flynt-core/commit/cf855a0))
17 | * **render:** changed exceptions to warnings ([c7230c8](https://github.com/flyntwp/flynt-core/commit/c7230c8))
18 | * **Render:** Error messages ([697aca6](https://github.com/flyntwp/flynt-core/commit/697aca6))
19 | * **renderer:** throw exception when template not found ([e940ff5](https://github.com/flyntwp/flynt-core/commit/e940ff5))
20 | * **wpStarter:** register renamed to correct: registerModule ([8c329e0](https://github.com/flyntwp/flynt-core/commit/8c329e0))
21 |
22 |
23 | ### Features
24 |
25 | * **buildConstructionPlan:** added initModuleConfig filter ([09717f9](https://github.com/flyntwp/flynt-core/commit/09717f9))
26 | * **buildConstructionPlan:** added modifyModuleData filters ([369ba9b](https://github.com/flyntwp/flynt-core/commit/369ba9b))
27 | * **buildConstructionPlan:** added parentData overwrite ([c3e5a46](https://github.com/flyntwp/flynt-core/commit/c3e5a46))
28 | * **ComponentManager:** added isRegistered ([47a1c35](https://github.com/flyntwp/flynt-core/commit/47a1c35))
29 | * **ComponentManager:** pass name as second parameter for component-specific registerComponent actio ([b7def8d](https://github.com/flyntwp/flynt-core/commit/b7def8d))
30 | * **composer:** add composer installers and type wordpress plugin ([406fb71](https://github.com/flyntwp/flynt-core/commit/406fb71))
31 | * **composer:** add composer package info ([b7f0707](https://github.com/flyntwp/flynt-core/commit/b7f0707))
32 | * **composer:** autoload flynt-core-plugin.php ([c9ff920](https://github.com/flyntwp/flynt-core/commit/c9ff920))
33 | * **constructionPlan:** added default path for config + adjusted tests, refactored getTemplateDirect ([5da250d](https://github.com/flyntwp/flynt-core/commit/5da250d))
34 | * **constructionPlan:** added filter hook for fromConfigFile loading, added additional checks for co ([100b5bc](https://github.com/flyntwp/flynt-core/commit/100b5bc))
35 | * **constructionPlan:** added load from config file (json) ([a08b028](https://github.com/flyntwp/flynt-core/commit/a08b028))
36 | * **constructionPlan:** apply WPStarter/dynamicSubmodules filter ([1368641](https://github.com/flyntwp/flynt-core/commit/1368641))
37 | * **constructionPlan:** nested dynamic submodules ([c30fa87](https://github.com/flyntwp/flynt-core/commit/c30fa87))
38 | * **ConstructionPlan:** added first tests and basic functionality for single module config ([1995b79](https://github.com/flyntwp/flynt-core/commit/1995b79))
39 | * **defaultLoader:** moved default functionality for config file loading and rendering to its own cl ([51f9ff8](https://github.com/flyntwp/flynt-core/commit/51f9ff8))
40 | * **defaults:** added getModulesDirectory method for default modules path ([37af61d](https://github.com/flyntwp/flynt-core/commit/37af61d))
41 | * **helpers:** add extractNestedDataFromArray helper function ([021dbe7](https://github.com/flyntwp/flynt-core/commit/021dbe7))
42 | * **helpers:** extract data helper now also works with objects ([74d575a](https://github.com/flyntwp/flynt-core/commit/74d575a))
43 | * **helpers:** extractData - added ability to use array further down the param line ([966cd77](https://github.com/flyntwp/flynt-core/commit/966cd77))
44 | * **moduleManager:** added ModuleManager Class, refactored WPStarter Class into global namespaced fu ([23ba863](https://github.com/flyntwp/flynt-core/commit/23ba863))
45 | * **render:** added correct params to renderModule filters and refactored class + tests ([4b07a64](https://github.com/flyntwp/flynt-core/commit/4b07a64))
46 | * **render:** use null as default arg in renderModule filter ([3e80add](https://github.com/flyntwp/flynt-core/commit/3e80add))
47 | * **renderer:** add basic render functionality for single and nested modules ([b8003f7](https://github.com/flyntwp/flynt-core/commit/b8003f7))
48 | * **renderer:** added renderModule hook ([d071f48](https://github.com/flyntwp/flynt-core/commit/d071f48))
49 | * **renderer:** added single module render hook ([f1edd70](https://github.com/flyntwp/flynt-core/commit/f1edd70))
50 | * **wpStarter:** added get_template_directory to modulesPath filter and renamed defaultModulesPath t ([c37bb88](https://github.com/flyntwp/flynt-core/commit/c37bb88))
51 | * **wpStarter:** added missing getModuleFilePath method ([be73b5d](https://github.com/flyntwp/flynt-core/commit/be73b5d))
52 | * **wpStarter:** added registerModule actions ([741a667](https://github.com/flyntwp/flynt-core/commit/741a667))
53 | * **wpStarter:** added registerModule functionality + shortcut methods for public API ([98fa7be](https://github.com/flyntwp/flynt-core/commit/98fa7be))
54 | * **wpStarter:** added registerModules ([bec7863](https://github.com/flyntwp/flynt-core/commit/bec7863))
55 | * **wpStarter:** registerModule optional argument for path ([d234e28](https://github.com/flyntwp/flynt-core/commit/d234e28))
56 |
--------------------------------------------------------------------------------
/lib/Flynt/BuildConstructionPlan.php:
--------------------------------------------------------------------------------
1 | isRegistered($config['name'])) {
71 | trigger_error(
72 | "Component '{$config['name']}' could not be found in component list. Did you forget to register the component?",
73 | E_USER_WARNING
74 | );
75 | return false;
76 | }
77 | }
78 |
79 | protected static function overwriteParentData(&$config, $parentData)
80 | {
81 | if (array_key_exists('parentData', $config)) {
82 | if (is_array($config['parentData'])) {
83 | $parentData = $config['parentData'];
84 | }
85 | unset($config['parentData']);
86 | }
87 | return $parentData;
88 | }
89 |
90 | protected static function addCustomData($config)
91 | {
92 | if (array_key_exists('customData', $config)) {
93 | if (is_array($config['customData'])) {
94 | // custom data overwrites original data
95 | $config['data'] = array_merge($config['data'], $config['customData']);
96 | }
97 | unset($config['customData']);
98 | }
99 | return $config;
100 | }
101 |
102 | protected static function applyDataModifications($config, $parentData)
103 | {
104 | $config['data'] = apply_filters(
105 | 'Flynt/addComponentData',
106 | $config['data'],
107 | $parentData,
108 | $config
109 | );
110 | $config['data'] = apply_filters(
111 | "Flynt/addComponentData?name={$config['name']}",
112 | $config['data'],
113 | $parentData,
114 | $config
115 | );
116 | return $config;
117 | }
118 |
119 | protected static function addSubcomponents($config, $parentData)
120 | {
121 | // add dynamic subcomponents to areas
122 | $areas = array_key_exists('areas', $config) ? $config['areas'] : [];
123 | $config['areas'] = apply_filters(
124 | "Flynt/dynamicSubcomponents?name={$config['name']}",
125 | $areas,
126 | $config['data'],
127 | $parentData
128 | );
129 |
130 | // iterate areas and recursively map child component construction plan
131 | if (!empty($config['areas'])) {
132 | $areaNames = array_keys($config['areas']);
133 | $config['areas'] = array_reduce($areaNames, function ($output, $areaName) use ($config, $parentData) {
134 | $components = $config['areas'][$areaName];
135 | $output[$areaName] = array_filter(self::mapAreaComponents($components, $config, $areaName, $parentData));
136 | return $output;
137 | }, []);
138 | }
139 |
140 | // remove empty 'areas' key from config
141 | // this can happen if there were no areas defined to begin with
142 | if (empty($config['areas'])) {
143 | unset($config['areas']);
144 | }
145 |
146 | return $config;
147 | }
148 |
149 | protected static function mapAreaComponents($components, $config, $areaName, $parentData)
150 | {
151 | return array_map(function ($component) use ($config, $areaName, $parentData) {
152 | $data = empty($config['data']) ? $parentData : $config['data'];
153 | return self::fromConfigRecursive($component, $data);
154 | }, $components);
155 | }
156 | }
157 |
--------------------------------------------------------------------------------
/tests/test-flynt.php:
--------------------------------------------------------------------------------
1 | shouldReceive('getInstance')
54 | ->once()
55 | ->andReturn($componentManagerMock);
56 |
57 | $componentManagerMock
58 | ->shouldReceive('registerComponent')
59 | ->with($componentName, $componentPath)
60 | ->once();
61 |
62 | registerComponent($componentName, $componentPath);
63 | }
64 |
65 | /**
66 | * @runInSeparateProcess
67 | * @preserveGlobalState disabled
68 | */
69 | public function testRegistersComponentsFromArray()
70 | {
71 | $componentManagerMock = Mockery::mock('ComponentManager');
72 |
73 | Mockery::mock('alias:Flynt\ComponentManager')
74 | ->shouldReceive('getInstance')
75 | ->times(3)
76 | ->andReturn($componentManagerMock);
77 |
78 | $componentManagerMock
79 | ->shouldReceive('registerComponent')
80 | ->with('ComponentA', null)
81 | ->ordered()
82 | ->once();
83 |
84 | $componentManagerMock
85 | ->shouldReceive('registerComponent')
86 | ->with('ComponentB', 'some/path')
87 | ->ordered()
88 | ->once();
89 |
90 | $componentManagerMock
91 | ->shouldReceive('registerComponent')
92 | ->with('ComponentC', null)
93 | ->ordered()
94 | ->once();
95 |
96 | $componentsWithPaths = [
97 | 'ComponentA' => null,
98 | 'ComponentB' => 'some/path',
99 | 'ComponentC' => null
100 | ];
101 |
102 | registerComponents($componentsWithPaths);
103 |
104 | $componentManagerMock
105 | ->shouldReceive('registerComponent')
106 | ->with('ComponentD', null)
107 | ->ordered()
108 | ->once();
109 |
110 | $componentManagerMock
111 | ->shouldReceive('registerComponent')
112 | ->with('ComponentE', null)
113 | ->ordered()
114 | ->once();
115 |
116 | $componentManagerMock
117 | ->shouldReceive('registerComponent')
118 | ->with('ComponentF', null)
119 | ->ordered()
120 | ->once();
121 |
122 | $componentsWithoutPaths = [
123 | 'ComponentD',
124 | 'ComponentE',
125 | 'ComponentF'
126 | ];
127 |
128 | registerComponents($componentsWithoutPaths);
129 |
130 | $componentManagerMock
131 | ->shouldReceive('registerComponent')
132 | ->with('ComponentG', null)
133 | ->ordered()
134 | ->once();
135 |
136 | $componentManagerMock
137 | ->shouldReceive('registerComponent')
138 | ->with('ComponentH', null)
139 | ->ordered()
140 | ->once();
141 |
142 | $componentManagerMock
143 | ->shouldReceive('registerComponent')
144 | ->with('ComponentI', 'some/path')
145 | ->ordered()
146 | ->once();
147 |
148 | $componentsMixed = [
149 | 'ComponentG',
150 | 'ComponentH' => null,
151 | 'ComponentI' => 'some/path'
152 | ];
153 |
154 | registerComponents($componentsMixed);
155 | }
156 |
157 | /**
158 | * @runInSeparateProcess
159 | * @preserveGlobalState disabled
160 | */
161 | public function testEchoesHtmlFromConfiguration()
162 | {
163 | $config = [
164 | 'name' => 'SingleComponent',
165 | 'customData' => [
166 | 'test' => 'result'
167 | ]
168 | ];
169 |
170 | $constructionPlan = [
171 | 'name' => 'SingleComponent',
172 | 'data' => [
173 | 'test' => 'result'
174 | ]
175 | ];
176 |
177 | Mockery::mock('alias:Flynt\BuildConstructionPlan')
178 | ->shouldReceive('fromConfig')
179 | ->once()
180 | ->with($config)
181 | ->andReturn($constructionPlan);
182 |
183 | Mockery::mock('alias:Flynt\Render')
184 | ->shouldReceive('fromConstructionPlan')
185 | ->once()
186 | ->with($constructionPlan)
187 | ->andReturn('test');
188 |
189 | $this->expectOutputString('test');
190 | echoHtmlFromConfig($config);
191 | }
192 |
193 | /**
194 | * @runInSeparateProcess
195 | * @preserveGlobalState disabled
196 | */
197 | public function testEchoesHtmlFromConfigurationFile()
198 | {
199 | $configFileName = 'exampleConfigWithSingleComponent.json';
200 |
201 | $constructionPlan = [
202 | 'name' => 'SingleComponent',
203 | 'data' => [
204 | 'test' => 'result'
205 | ]
206 | ];
207 |
208 | Mockery::mock('alias:Flynt\BuildConstructionPlan')
209 | ->shouldReceive('fromConfigFile')
210 | ->once()
211 | ->with($configFileName)
212 | ->andReturn($constructionPlan);
213 |
214 | Mockery::mock('alias:Flynt\Render')
215 | ->shouldReceive('fromConstructionPlan')
216 | ->once()
217 | ->with($constructionPlan)
218 | ->andReturn('test');
219 |
220 | $this->expectOutputString('test');
221 | echoHtmlFromConfigFile($configFileName);
222 | }
223 |
224 | /**
225 | * @runInSeparateProcess
226 | * @preserveGlobalState disabled
227 | */
228 | public function testCallsDefaultsInitFunction()
229 | {
230 | Mockery::mock('alias:Flynt\Defaults')
231 | ->shouldReceive('init')
232 | ->once();
233 |
234 | initDefaults();
235 | }
236 | }
237 |
--------------------------------------------------------------------------------
/tests/test-defaults.php:
--------------------------------------------------------------------------------
1 | once()
40 | ->with(['Flynt\Defaults', 'setConfigPath'], 999, 2);
41 |
42 | Defaults::init();
43 | }
44 |
45 | public function testAddsFilterForConfigFileLoader()
46 | {
47 | Filters::expectAdded('Flynt/configFileLoader')
48 | ->once()
49 | ->with(['Flynt\Defaults', 'loadConfigFile'], 999, 3);
50 |
51 | Defaults::init();
52 | }
53 |
54 | public function testAddsFilterForRenderComponent()
55 | {
56 | Filters::expectAdded('Flynt/renderComponent')
57 | ->once()
58 | ->with(['Flynt\Defaults', 'renderComponent'], 999, 4);
59 |
60 | Defaults::init();
61 | }
62 |
63 | public function testAddsFilterForComponentPath()
64 | {
65 | Filters::expectAdded('Flynt/componentPath')
66 | ->once()
67 | ->with(['Flynt\Defaults', 'setComponentPath'], 999, 2);
68 |
69 | Defaults::init();
70 | }
71 |
72 | public function testAddsActionForRegisterComponent()
73 | {
74 | Actions::expectAdded('Flynt/registerComponent')
75 | ->once()
76 | ->with(['Flynt\Defaults', 'loadFunctionsFile']);
77 |
78 | Defaults::init();
79 | }
80 |
81 | public function testReturnsAConfigPath()
82 | {
83 | $configPath = Defaults::setConfigPath(null, 'config.json');
84 | $this->assertEquals($configPath, TestHelper::getTemplateDirectory() . '/config/config.json');
85 | }
86 |
87 | public function testLoadsAndDecodesJsonFile()
88 | {
89 | $configPath = TestHelper::getConfigPath() . 'exampleConfigWithSingleComponent.json';
90 | $config = Defaults::loadConfigFile(null, '', $configPath);
91 | $this->assertEquals($config, [
92 | 'name' => 'SingleComponent',
93 | 'customData' => [
94 | 'test' => 'result'
95 | ]
96 | ]);
97 | }
98 |
99 | /**
100 | * @runInSeparateProcess
101 | * @preserveGlobalState disabled
102 | */
103 | public function testRenderShowsWarningIfComponentFileIsADirectory()
104 | {
105 | $componentName = 'SingleComponent';
106 | $componentData = [];
107 | $areaHtml = [];
108 |
109 | $this->expectException('PHPUnit_Framework_Error_Warning');
110 |
111 | $this->mockComponentManager()
112 | ->shouldReceive('getComponentFilePath')
113 | ->once()
114 | ->with($componentName)
115 | ->andReturn(TestHelper::getComponentsPath() . $componentName);
116 |
117 | $output = Defaults::renderComponent(null, $componentName, $componentData, $areaHtml);
118 | $this->assertEquals($output, '');
119 | }
120 |
121 | /**
122 | * @runInSeparateProcess
123 | * @preserveGlobalState disabled
124 | */
125 | public function testRenderShowsWarningIfComponentFileDoesntExist()
126 | {
127 | $componentName = 'SomeComponentThatDoesntExist';
128 | $componentData = [];
129 | $areaHtml = [];
130 |
131 | $this->expectException('PHPUnit_Framework_Error_Warning');
132 |
133 | $this->mockComponentManager()
134 | ->shouldReceive('getComponentFilePath')
135 | ->once()
136 | ->with($componentName)
137 | ->andReturn('not/a/real/file.php');
138 |
139 | $output = Defaults::renderComponent(null, $componentName, $componentData, $areaHtml);
140 | }
141 |
142 | /**
143 | * @runInSeparateProcess
144 | * @preserveGlobalState disabled
145 | */
146 | public function testRenderReturnsEmptyStringOnError()
147 | {
148 | $componentName = 'SomeComponentThatDoesntExist';
149 | $componentData = [];
150 | $areaHtml = [];
151 |
152 | $this->mockComponentManager()
153 | ->shouldReceive('getComponentFilePath')
154 | ->once()
155 | ->with($componentName)
156 | ->andReturn('not/a/real/file.php');
157 |
158 | // suppress exception to get an output
159 | $output = @Defaults::renderComponent(null, $componentName, $componentData, $areaHtml);
160 | $this->assertEquals($output, '');
161 | }
162 |
163 | /**
164 | * @runInSeparateProcess
165 | * @preserveGlobalState disabled
166 | */
167 | public function testRendersFileCorrectly()
168 | {
169 | $componentName = 'SingleComponent';
170 | $componentData = [
171 | 'test' => 'result'
172 | ];
173 | $areaHtml = [];
174 |
175 | $this->mockComponentManager()
176 | ->shouldReceive('getComponentFilePath')
177 | ->once()
178 | ->with($componentName)
179 | ->andReturn(TestHelper::getComponentsPath() . $componentName . '/index.php');
180 |
181 | Mockery::mock('alias:Flynt\Helpers')
182 | ->shouldReceive('extractNestedDataFromArray')
183 | ->andReturn('result');
184 |
185 | $output = Defaults::renderComponent(null, $componentName, $componentData, $areaHtml);
186 |
187 | $expectedHTML = "SingleComponent result
\n";
188 |
189 | $this->assertEquals($output, $expectedHTML);
190 | }
191 |
192 | /**
193 | * @runInSeparateProcess
194 | * @preserveGlobalState disabled
195 | */
196 | public function testRendersNestedComponentsCorrectly()
197 | {
198 | $parentComponentName = 'ComponentWithArea';
199 | $childComponentName = 'SingleComponent';
200 | $componentData = [
201 | 'test' => 'result'
202 | ];
203 |
204 | $this->mockComponentManager()
205 | ->shouldReceive('getComponentFilePath')
206 | ->times(2)
207 | ->with(Mockery::type('string'))
208 | ->andReturnUsing(['\\Flynt\\Tests\\TestHelper', 'getComponentIndexPath']);
209 |
210 | Mockery::mock('alias:Flynt\Helpers')
211 | ->shouldReceive('extractNestedDataFromArray')
212 | ->andReturn('result');
213 |
214 | $areaHtml = [
215 | 'area51' => Defaults::renderComponent(null, $childComponentName, $componentData, [])
216 | ];
217 | $output = Defaults::renderComponent(null, $parentComponentName, $componentData, $areaHtml);
218 |
219 | $this->assertEquals($output, "{$parentComponentName} result
{$childComponentName} result
\n