├── .gitignore
├── .styleci.yml
├── .travis.yml
├── Classes
├── Dsl
│ └── AfxDslImplementation.php
├── Exception
│ └── AfxException.php
└── Service
│ └── AfxService.php
├── Configuration
└── Settings.yaml
├── LICENSE
├── README.md
├── Tests
└── Functional
│ └── AfxServiceTest.php
└── composer.json
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | /Packages
3 | /composer.lock
4 |
--------------------------------------------------------------------------------
/.styleci.yml:
--------------------------------------------------------------------------------
1 | preset: psr2
2 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: php
2 | php:
3 | - '7.0'
4 | - '7.1'
5 | script: composer test
6 |
--------------------------------------------------------------------------------
/Classes/Dsl/AfxDslImplementation.php:
--------------------------------------------------------------------------------
1 | getMessage()));
31 | }
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/Classes/Exception/AfxException.php:
--------------------------------------------------------------------------------
1 | parse();
27 | $fusion = self::astNodeListToFusion($ast, $indentation);
28 | return $fusion;
29 | }
30 |
31 | /**
32 | * @param array $astNode
33 | * @param string $indentation
34 | * @return string
35 | */
36 | protected static function astToFusion($ast, $indentation = '')
37 | {
38 | switch ($ast['type']) {
39 | case 'expression':
40 | return self::astExpressionToFusion($ast['payload'], $indentation);
41 | break;
42 | case 'string':
43 | return self::astStringToFusion($ast['payload'], $indentation);
44 | break;
45 | case 'text':
46 | return self::astTextToFusion($ast['payload'], $indentation);
47 | break;
48 | case 'boolean':
49 | return self::astBooleanToFusion($ast['payload'], $indentation);
50 | break;
51 | case 'node':
52 | return self::astNodeToFusion($ast['payload'], $indentation);
53 | break;
54 | default:
55 | throw new AfxException(sprintf('ast type %s is unkonwn', $ast['type']));
56 | }
57 | }
58 |
59 | /**
60 | * @param array $payload
61 | * @param string $indentation
62 | * @return string
63 | */
64 | protected static function astBooleanToFusion($payload, $indentation = '')
65 | {
66 | return 'true';
67 | }
68 |
69 | /**
70 | * @param array $payload
71 | * @param string $indentation
72 | * @return string
73 | */
74 | protected static function astExpressionToFusion($payload, $indentation = '')
75 | {
76 | return '${' . $payload . '}';
77 | }
78 |
79 | /**
80 | * @param array $payload
81 | * @param string $indentation
82 | * @return string
83 | */
84 | protected static function astStringToFusion($payload, $indentation = '')
85 | {
86 | return '\'' . str_replace('\'', '\\\'', $payload) . '\'';
87 | }
88 |
89 | /**
90 | * @param array $payload
91 | * @param string $indentation
92 | * @return string
93 | */
94 | protected static function astTextToFusion($payload, $indentation = '')
95 | {
96 | return '\'' . str_replace('\'', '\\\'', $payload) . '\'';
97 | }
98 |
99 | /**
100 | * @param array $payload
101 | * @param string $indentation
102 | * @return string
103 | */
104 | protected static function astNodeToFusion($payload, $indentation = '')
105 | {
106 | $tagName = $payload['identifier'];
107 |
108 | // Tag
109 | if (strpos($tagName, ':') !== false) {
110 | // Named fusion-object
111 | $fusion = $tagName . ' {' . PHP_EOL;
112 | // Attributes are not prefixed
113 | $attributePrefix = '';
114 | } else {
115 | // Neos.Fusion:Tag
116 | $fusion = 'Neos.Fusion:Tag {' . PHP_EOL;
117 | $fusion .= $indentation . self::INDENTATION .'tagName = \'' . $tagName . '\'' . PHP_EOL;
118 | // Attributes are rendered as tag-attributes
119 | $attributePrefix = 'attributes.';
120 | // Self closing Tags stay self closing
121 | if ($payload['selfClosing'] === true) {
122 | $fusion .= $indentation . self::INDENTATION .'selfClosingTag = true' . PHP_EOL;
123 | }
124 | }
125 |
126 | // Attributes
127 | if ($payload['props'] && count($payload['props']) > 0) {
128 | foreach ($payload['props'] as $propName => $prop) {
129 | if ($propName == '@key' || $propName == '@children') {
130 | continue;
131 | } else {
132 | if ($propName{0} === '@') {
133 | $fusionName = $propName;
134 | } else {
135 | $fusionName = $attributePrefix . $propName;
136 | }
137 | $propFusion = self::astToFusion($prop, $indentation . self::INDENTATION);
138 | if ($propFusion !== null) {
139 | $fusion .= $indentation . self::INDENTATION . $fusionName . ' = ' . $propFusion . PHP_EOL;
140 | }
141 | }
142 | }
143 | }
144 |
145 | // Children
146 | if ($payload['children'] && count($payload['children']) > 0) {
147 | $childrenProp = Arrays::getValueByPath($payload, 'props.@children');
148 | if ($childrenProp) {
149 | if ($childrenProp['type'] == 'string') {
150 | $childrenPropertyName = $childrenProp['payload'];
151 | } else {
152 | throw new AfxException(
153 | sprintf('@children only supports string payloads %s found', $childrenProp['type'])
154 | );
155 | }
156 | } else {
157 | $childrenPropertyName = 'content';
158 | }
159 | $childFusion = self::astNodeListToFusion($payload['children'], $indentation . self::INDENTATION);
160 | if ($childFusion) {
161 | $fusion .= $indentation . self::INDENTATION . $childrenPropertyName . ' = ' . $childFusion . PHP_EOL;
162 | }
163 | }
164 |
165 | $fusion .= $indentation . '}';
166 |
167 | return $fusion;
168 | }
169 |
170 | /**
171 | * @param array $payload
172 | * @param string $indentation
173 | * @return string
174 | */
175 | protected static function astNodeListToFusion($payload, $indentation = '')
176 | {
177 | $index = 1;
178 |
179 | // ignore blank text if it is connected to a newline
180 | $payload = array_map(function ($astNode) {
181 | if ($astNode['type'] == 'text') {
182 | $astNode['payload'] = preg_replace('/[\\s]*\\n[\\s]*/u', '', $astNode['payload']);
183 | }
184 | return $astNode;
185 | }, $payload);
186 |
187 | // filter empty text nodes
188 | $payload = array_filter($payload, function ($astNode) {
189 | if ($astNode['type'] == 'text' && $astNode['payload'] == '') {
190 | return false;
191 | } else {
192 | return true;
193 | }
194 | });
195 |
196 | if (count($payload) == 0) {
197 | return '\'\'';
198 | } elseif (count($payload) == 1) {
199 | return self::astToFusion(array_shift($payload), $indentation);
200 | } else {
201 | $fusion = 'Neos.Fusion:Array {' . PHP_EOL;
202 | foreach ($payload as $astNode) {
203 | // detect key
204 | $fusionName = 'item_' . $index;
205 | if ($keyProperty = Arrays::getValueByPath($astNode, 'payload.props.@key')) {
206 | if ($keyProperty['type'] == 'string') {
207 | $fusionName = $keyProperty['payload'];
208 | } else {
209 | throw new AfxException(
210 | sprintf(
211 | '@key only supports string payloads %s was given',
212 | $astNode['props']['@key']['type']
213 | )
214 | );
215 | }
216 | }
217 |
218 | // convert node
219 | $nodeFusion = self::astToFusion($astNode, $indentation . self::INDENTATION);
220 | if ($nodeFusion !== null) {
221 | $fusion .= $indentation . self::INDENTATION . $fusionName . ' = ' . $nodeFusion . PHP_EOL;
222 | $index++;
223 | }
224 | }
225 | $fusion .= $indentation . '}';
226 | return $fusion;
227 | }
228 | }
229 | }
230 |
--------------------------------------------------------------------------------
/Configuration/Settings.yaml:
--------------------------------------------------------------------------------
1 | Neos:
2 | Fusion:
3 | dsl:
4 | afx: PackageFactory\AtomicFusion\AFX\Dsl\AfxDslImplementation
5 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # DEPRECATED PackageFactory.AtomicFusion.AFX
2 |
3 | **This package is deprecated in favor of https://github.com/neos/fusion-afx. This package will stay available for existing setups that depend on it but no bugfixes nor features will be added here.**
4 |
5 | > JSX inspired compact syntax for Neos.Fusion
6 |
7 | This package provides a fusion preprocessor that expands a compact xml-ish syntax to pure fusion code. This allows
8 | to write compact components that do'nt need a seperate template file and enables unplanned extensibility for the defined
9 | prototypes because the generated fusion-code can be overwritten and controlled from the outside if needed.
10 |
11 | ## Installation
12 |
13 | PackageFactory.AtomicFusion.AFX is available via packagist. Just add `"packagefactory/atomicfusion-afx" : "~3.0.0"`
14 | to the require-section of the composer.json or run `composer require packagefactory/atomicfusion-afx`.
15 |
16 | __We use semantic-versioning so every breaking change will increase the major-version number.__
17 |
18 | ## Usage
19 |
20 | With this package the following fusion code
21 |
22 | ```
23 | prototype(PackageFactory.AtomicFusion.AFX:Example) < prototype(PackageFactory.AtomicFusion:Component) {
24 |
25 | title = 'title text'
26 | subtitle = 'subtitle line'
27 | imageUri = 'https://dummyimage.com/600x400/000/fff'
28 |
29 | #
30 | # The code afx`...` is converted to the fusion code below at parse time.
31 | # Attention: Currently there is no way to escape closing-backticks inside the Expression.
32 | #
33 | renderer = afx`
34 |
35 |
{props.title}
36 |
{props.subtitle}
37 |
38 |
{props.headline}
85 | ```
86 | Is transpiled to:
87 | ```
88 | Neos.Fusion:Tag {
89 | tagName = 'h1'
90 | attributes.class = 'headline'
91 | content = ${props.headline}
92 | @if.hasHeadline = ${props.headline ? true : false}
93 | }
94 | ```
95 |
96 | If a tag is self-closing and has no content it will be rendered as self closing fusion-tag:.
97 | ```
98 |
99 | ```
100 | Is transpiled to:
101 | ```
102 | Neos.Fusion:Tag {
103 | tagName = 'br'
104 | selfClosingTag = true
105 | }
106 | ```
107 |
108 | ### Fusion-Object-Tags (namespaced Tags)
109 |
110 | All namespaced-tags are interpreted as prototype-names and all attributes are passed as top-level fusion-properties.
111 |
112 | The following html:
113 | ```
114 | {props.headline}
115 | ```
116 | Is transpiled as:
117 | ```
118 | Vendor.Site:Prototype {
119 | type = 'headline'
120 | content = ${props.headline}
121 | @if.hasHeadline= ${props.headline ? true : false}
122 | }
123 | ```
124 |
125 | ### Tag-Children
126 |
127 | The handling of child-nodes below an afx-node is differs based on the number of childNodes that are found.
128 |
129 | #### Single tag-children
130 |
131 | If a AFX-tag contains exactly one child this child is rendered directly into the `content`-attribute.
132 | The child is then interpreted as string, eel-expression, html- or fusion-object-tag.
133 |
134 | The following AFX-Code:
135 |
136 | ```
137 | {props.title}
138 | ```
139 | Is transpiled as:
140 | ```
141 | Neos.Fusion:Tag {
142 | tagName = 'h1'
143 | content = {props.title}
144 | }
145 | ```
146 |
147 | #### Multiple tag-children
148 |
149 | If an AFX-tag contains more than one child the content is are rendered as `Neos.Fusion:Array` into the
150 | `content`-attribute. The children are interpreted as string, eel-expression, html- or fusion-object-tag.
151 |
152 | The following AFX-Code:
153 |
154 | ```
155 | {props.title}: {props.subtitle}
156 | ```
157 | Is transpiled as:
158 | ```
159 | Neos.Fusion:Tag {
160 | tagName = 'h1'
161 | content = Neos.Fusion:Array {
162 | item_1 = {props.title}
163 | item_2 = ': '
164 | item_3 = ${props.subtitle}
165 | }
166 | }
167 | ```
168 |
169 | The `@key`-property of tag-children inside alters the name of the fusion-attribute to recive render the array-child into.
170 | If no `@key`-property is given `index_x` is used starting by `x=1`.
171 |
172 | ```
173 |
174 | {props.title}
175 |
{props.description}
176 |
177 | ```
178 | Is transpiled as:
179 | ```
180 | Vendor.Site:Prototype {
181 | text = Neos.Fusion:Array {
182 | title = Neos.Fusion:Tag {
183 | tagName = 'h2'
184 | content = ${props.title}
185 | }
186 | description = Neos.Fusion:Tag {
187 | tagName = 'p'
188 | content = ${props.description}
189 | }
190 | }
191 | }
192 | ```
193 |
194 | ### Meta-Attributes
195 |
196 | In general all meta-attributes start with an @-sign.
197 |
198 | The `@children`-attribute defined the property that is used to render the content/children of the current tag into.
199 | The default property name for the children is `content`.
200 |
201 | The `@key`-attribute can be used to define the property name of an item among its siblings if an array is rendered.
202 | If no `@key` is defined `index_x` is used starting at `x=1.
203 |
204 | All other meta attributes are directly added to the generated prototype and can be used for @if or @process statements.
205 |
206 | ### Whitespace and Newlines
207 |
208 | AFX is not html and makes some simplifications to the code to optimize the generated fusion and allow a structured notation
209 | of the component hierarchy.
210 |
211 | The following rules are applied for that:
212 |
213 | 1. **Newlines and Whitespace-Characters that are connected to a newline are considered irrelevant and are ignored**
214 |
215 | ```
216 |
217 | {'eelExpression 1'}
218 | {'eelExpression 2'}
219 |
220 | ```
221 | Is transpiled as:
222 | ```
223 | Neos.Fusion:Tag {
224 | tagName = 'h1'
225 | contents = Neos.Fusion:Array {
226 | item_1 = ${'eelExpression 1'}
227 | item_2 = ${'eelExpression 2'}
228 | }
229 | }
230 | ```
231 |
232 | 2. **Spaces between Elements on a single line are considered meaningful and are preserved**
233 |
234 | ```
235 |
236 | {'eelExpression 1'} {'eelExpression 2'}
237 |
238 | ```
239 | Is transpiled as:
240 | ```
241 | Neos.Fusion:Tag {
242 | tagName = 'h1'
243 | contents = Neos.Fusion:Array {
244 | item_1 = ${'eelExpression 1'}
245 | item_2 = ' '
246 | item_3 = ${'eelExpression 2'}
247 | }
248 | }
249 | ```
250 |
251 | ## Examples
252 |
253 | ### Rendering of Collections with `Neos.Fusion:Collection`
254 |
255 | For rendering of lists or menus a presentational-component usually will recieve arrays of
256 | preprocessed data as prop. To iterate over such an array the `Neos.Fusion:Collection`
257 | can be used in afx.
258 |
259 | ```
260 | prototype(PackageFactory.AtomicFusion.AFX:IterationExample) < prototype(PackageFactory.AtomicFusion:Component) {
261 |
262 | # array {[href:'http://www.example_1.com', title:'Title 1'], [href:'http://example_2.com', title:'Title 2']}
263 | items = null
264 |
265 | renderer = afx`
266 |
271 | `
272 | }
273 | ```
274 |
275 | ### Augmentation of Child-Components with `PackageFactory.AtomicFusion:Augmenter`
276 |
277 | The `PackageFactory.AtomicFusion:Augmenter` can be used to add additional attributes to rendered content.
278 | This allows some rendering flexibility without extending the api of the component. This is a
279 | useful pattern to avoid unneeded tag-wrapping in cases where only additional classes are needed.
280 |
281 | ```
282 | prototype(PackageFactory.AtomicFusion.AFX:SliderExample) < prototype(Packagefactory.AtomicFusion:Component) {
283 | images = ${[]}
284 | renderer = afx`
285 |
286 |
287 |
288 |
289 |
290 |
291 |
';
55 | $expectedFusion = <<<'EOF'
56 | Neos.Fusion:Tag {
57 | tagName = 'h1'
58 | content = ' '
59 | }
60 | EOF;
61 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
62 | }
63 |
64 | /**
65 | * @test
66 | */
67 | public function htmlTagsWithIgnoredContentAreConvertedToFusionTags()
68 | {
69 | $afxCode = '
70 |
71 |
';
72 | $expectedFusion = <<<'EOF'
73 | Neos.Fusion:Tag {
74 | tagName = 'h1'
75 | content = ''
76 | }
77 | EOF;
78 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
79 | }
80 |
81 | /**
82 | * @test
83 | */
84 | public function multipleHtmlTagsAreConvertedToFusionArray()
85 | {
86 | $afxCode = '';
87 | $expectedFusion = <<<'EOF'
88 | Neos.Fusion:Array {
89 | item_1 = Neos.Fusion:Tag {
90 | tagName = 'h1'
91 | }
92 | item_2 = Neos.Fusion:Tag {
93 | tagName = 'p'
94 | }
95 | item_3 = Neos.Fusion:Tag {
96 | tagName = 'p'
97 | }
98 | }
99 | EOF;
100 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
101 | }
102 |
103 | /**
104 | * @test
105 | */
106 | public function multipleHtmlTagsAndTextsAreConvertedToFusionArray()
107 | {
108 | $afxCode = 'FooBarBaz';
109 | $expectedFusion = <<<'EOF'
110 | Neos.Fusion:Array {
111 | item_1 = 'Foo'
112 | item_2 = Neos.Fusion:Tag {
113 | tagName = 'h1'
114 | }
115 | item_3 = 'Bar'
116 | item_4 = Neos.Fusion:Tag {
117 | tagName = 'p'
118 | }
119 | item_5 = 'Baz'
120 | }
121 | EOF;
122 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
123 | }
124 |
125 | /**
126 | * @test
127 | */
128 | public function whitepaceAroundAfxIsIgnored()
129 | {
130 | $afxCode = ' ';
131 | $expectedFusion = <<<'EOF'
132 | Neos.Fusion:Array {
133 | item_1 = Neos.Fusion:Tag {
134 | tagName = 'h1'
135 | }
136 | item_2 = Neos.Fusion:Tag {
137 | tagName = 'p'
138 | }
139 | }
140 | EOF;
141 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
142 | }
143 | /**
144 | * @test
145 | */
146 | public function multipleHtmlTagsAreConvertedToFusionTags()
147 | {
148 | $afxCode = '';
149 | $expectedFusion = <<<'EOF'
150 | Neos.Fusion:Array {
151 | item_1 = Neos.Fusion:Tag {
152 | tagName = 'h1'
153 | }
154 | item_2 = Neos.Fusion:Tag {
155 | tagName = 'p'
156 | }
157 | item_3 = Neos.Fusion:Tag {
158 | tagName = 'p'
159 | }
160 | }
161 | EOF;
162 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
163 | }
164 |
165 | /**
166 | * @test
167 | */
168 | public function whitespacesAndNewlinesAroundAfxCodeAreIgnored()
169 | {
170 | $afxCode = '
171 |
172 | ';
173 | $expectedFusion = <<<'EOF'
174 | Neos.Fusion:Tag {
175 | tagName = 'h1'
176 | }
177 | EOF;
178 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
179 | }
180 |
181 | /**
182 | * @test
183 | */
184 | public function htmlTagsAreConvertedToSelfClosingFusionTags()
185 | {
186 | $afxCode = '';
187 | $expectedFusion = <<<'EOF'
188 | Neos.Fusion:Tag {
189 | tagName = 'h1'
190 | selfClosingTag = true
191 | }
192 | EOF;
193 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
194 | }
195 |
196 | /**
197 | * @test
198 | */
199 | public function attributesInHtmlTagsAreConvertedToTagAttributes()
200 | {
201 | $afxCode = '';
202 | $expectedFusion = <<<'EOF'
203 | Neos.Fusion:Tag {
204 | tagName = 'h1'
205 | selfClosingTag = true
206 | attributes.content = 'bar'
207 | attributes.class = 'fooo'
208 | }
209 | EOF;
210 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
211 | }
212 |
213 | /**
214 | * @test
215 | */
216 | public function sindgleQuotesAreEscapedInAttributesAndChildren()
217 | {
218 | $afxCode = 'foo\'bar
';
219 | $expectedFusion = <<<'EOF'
220 | Neos.Fusion:Tag {
221 | tagName = 'h1'
222 | attributes.class = 'foo\'bar'
223 | content = 'foo\'bar'
224 | }
225 | EOF;
226 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
227 | }
228 |
229 | /**
230 | * @test
231 | */
232 | public function fusionTagsAreConvertedToFusionObjects()
233 | {
234 | $afxCode = '';
235 | $expectedFusion = <<<'EOF'
236 | Vendor.Site:Prototype {
237 | }
238 | EOF;
239 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
240 | }
241 |
242 | /**
243 | * @test
244 | */
245 | public function attributesInFusionTagsAreConvertedToFusionPropertiesOrEelExpressions()
246 | {
247 | $afxCode = '';
248 | $expectedFusion = <<<'EOF'
249 | Vendor.Site:Prototype {
250 | foo = 'bar'
251 | baz = 'bam'
252 | }
253 | EOF;
254 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
255 | }
256 |
257 | /**
258 | * @test
259 | */
260 | public function metaAttributesOfFusionObjectTagsAreConvertedToFusionProperties()
261 | {
262 | $afxCode = '';
263 | $expectedFusion = <<<'EOF'
264 | Vendor.Site:Prototype {
265 | @position = 'start'
266 | @if.hasTitle = ${title}
267 | }
268 | EOF;
269 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
270 | }
271 |
272 | /**
273 | * @test
274 | */
275 | public function metaAttributesOfHtmlTagsAreConvertedToFusionProperties()
276 | {
277 | $afxCode = '';
278 | $expectedFusion = <<<'EOF'
279 | Neos.Fusion:Tag {
280 | tagName = 'div'
281 | @position = 'start'
282 | @if.hasTitle = ${title}
283 | }
284 | EOF;
285 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
286 | }
287 |
288 | /**
289 | * @test
290 | */
291 | public function contentOfHtmlTagsIsRenderedAsFusionContent()
292 | {
293 | $afxCode = 'Fooo
';
294 | $expectedFusion = <<<'EOF'
295 | Neos.Fusion:Tag {
296 | tagName = 'h1'
297 | content = 'Fooo'
298 | }
299 | EOF;
300 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
301 | }
302 |
303 | /**
304 | * @test
305 | */
306 | public function contentOfFusionTagsIsRenderedAsFusionRenderer()
307 | {
308 | $afxCode = 'Fooo';
309 | $expectedFusion = <<<'EOF'
310 | Vendor.Site:Prototype {
311 | content = 'Fooo'
312 | }
313 | EOF;
314 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
315 | }
316 |
317 | /**
318 | * @test
319 | */
320 | public function textContentOfHtmlTagsIsRenderedAsConfiguredChildrenProperty()
321 | {
322 | $afxCode = 'Fooo';
323 | $expectedFusion = <<<'EOF'
324 | Vendor.Site:Prototype {
325 | children = 'Fooo'
326 | }
327 | EOF;
328 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
329 | }
330 |
331 | /**
332 | * @test
333 | */
334 | public function eelContentOfHtmlTagsIsRenderedAsConfiguredChildrenProperty()
335 | {
336 | $afxCode = '{eelExpression()}';
337 | $expectedFusion = <<<'EOF'
338 | Vendor.Site:Prototype {
339 | children = ${eelExpression()}
340 | }
341 | EOF;
342 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
343 | }
344 |
345 | /**
346 | * @test
347 | */
348 | public function complexChildrenAreRenderedAsArray()
349 | {
350 | $afxCode = 'foobar
';
351 | $expectedFusion = <<<'EOF'
352 | Neos.Fusion:Tag {
353 | tagName = 'h1'
354 | content = Neos.Fusion:Array {
355 | item_1 = Neos.Fusion:Tag {
356 | tagName = 'strong'
357 | content = 'foo'
358 | }
359 | item_2 = Neos.Fusion:Tag {
360 | tagName = 'i'
361 | content = 'bar'
362 | }
363 | }
364 | }
365 | EOF;
366 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
367 | }
368 |
369 | /**
370 | * @test
371 | */
372 | public function complexChildrenAreRenderedAsArrayIgnoringWhitespaceInBetween()
373 | {
374 | $afxCode = <<<'EOF'
375 |
376 |
377 | foo
378 |
379 | bar
380 |
381 |
382 | EOF;
383 |
384 | $expectedFusion = <<<'EOF'
385 | Neos.Fusion:Tag {
386 | tagName = 'h1'
387 | content = Neos.Fusion:Array {
388 | item_1 = Neos.Fusion:Tag {
389 | tagName = 'strong'
390 | content = 'foo'
391 | }
392 | item_2 = Neos.Fusion:Tag {
393 | tagName = 'i'
394 | content = 'bar'
395 | }
396 | }
397 | }
398 | EOF;
399 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
400 | }
401 |
402 | /**
403 | * @test
404 | */
405 | public function complexChildrenAreRenderedAsArrayWithOptionalKeys()
406 | {
407 | $afxCode = 'foobar
';
408 | $expectedFusion = <<<'EOF'
409 | Neos.Fusion:Tag {
410 | tagName = 'h1'
411 | content = Neos.Fusion:Array {
412 | key_one = Neos.Fusion:Tag {
413 | tagName = 'strong'
414 | content = 'foo'
415 | }
416 | key_two = Neos.Fusion:Tag {
417 | tagName = 'i'
418 | content = 'bar'
419 | }
420 | }
421 | }
422 | EOF;
423 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
424 | }
425 |
426 | /**
427 | * @test
428 | */
429 | public function complexChildrenAreCanContainTagsAnsValues()
430 | {
431 | $afxCode = 'a stringa tag{eelExpression()}
';
432 | $expectedFusion = <<<'EOF'
433 | Neos.Fusion:Tag {
434 | tagName = 'h1'
435 | content = Neos.Fusion:Array {
436 | item_1 = 'a string'
437 | item_2 = Neos.Fusion:Tag {
438 | tagName = 'strong'
439 | content = 'a tag'
440 | }
441 | item_3 = ${eelExpression()}
442 | }
443 | }
444 | EOF;
445 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
446 | }
447 |
448 | /**
449 | * @test
450 | */
451 | public function spacesNewLinesAndSpacesAroundAreIgnored()
452 | {
453 | $afxCode = '
454 | {eelExpression1}
455 | {eelExpression2}
456 | {eelExpression3}
457 |
';
458 |
459 | $expectedFusion = <<<'EOF'
460 | Neos.Fusion:Tag {
461 | tagName = 'h1'
462 | content = Neos.Fusion:Array {
463 | item_1 = ${eelExpression1}
464 | item_2 = ${eelExpression2}
465 | item_3 = ${eelExpression3}
466 | }
467 | }
468 | EOF;
469 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
470 | }
471 |
472 | /**
473 | * @test
474 | */
475 | public function spacesInsideALineArePreserved()
476 | {
477 | $afxCode = '
478 | {eelExpression1} {eelExpression2}
479 |
';
480 |
481 | $expectedFusion = <<<'EOF'
482 | Neos.Fusion:Tag {
483 | tagName = 'h1'
484 | content = Neos.Fusion:Array {
485 | item_1 = ${eelExpression1}
486 | item_2 = ' '
487 | item_3 = ${eelExpression2}
488 | }
489 | }
490 | EOF;
491 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
492 | }
493 |
494 | /**
495 | * @test
496 | */
497 | public function spacesInsideALineArePreservedAlsoForStrings()
498 | {
499 | $afxCode = '
500 | String {eelExpression} String
501 |
';
502 |
503 | $expectedFusion = <<<'EOF'
504 | Neos.Fusion:Tag {
505 | tagName = 'h1'
506 | content = Neos.Fusion:Array {
507 | item_1 = 'String '
508 | item_2 = ${eelExpression}
509 | item_3 = ' String'
510 | }
511 | }
512 | EOF;
513 | $this->assertEquals($expectedFusion, AfxService::convertAfxToFusion($afxCode));
514 | }
515 |
516 | /**
517 | * @test
518 | * @expectedException \PackageFactory\Afx\Exception
519 | */
520 | public function unclosedTagsRaisesException()
521 | {
522 | $afxCode = '';
523 | AfxService::convertAfxToFusion($afxCode);
524 | }
525 |
526 | /**
527 | * @test
528 | * @expectedException \PackageFactory\Afx\Exception
529 | */
530 | public function unclosedAttributeRaisesException()
531 | {
532 | $afxCode = '';
543 | AfxService::convertAfxToFusion($afxCode);
544 | }
545 | }
546 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "packagefactory/atomicfusion-afx",
3 | "description": "JSX inspired compact syntax for Neos.Fusion",
4 | "type": "neos-package",
5 | "license": "GPL-3.0",
6 | "authors": [
7 | {
8 | "name": "Martin Ficzel",
9 | "email": "martin.ficzel@gmx.de",
10 | "role": "Developer"
11 | },
12 | {
13 | "name": "Wilhelm Behncke",
14 | "email": "wilhelm.behncke@googlemail.com",
15 | "role": "Developer"
16 | }
17 | ],
18 | "require": {
19 | "neos/fusion": "^3.2.0 || ^4.0.0 || dev-master",
20 | "packagefactory/afx": "~2.0.1"
21 | },
22 | "require-dev": {
23 | "phpunit/phpunit": "~4.8 || ~5.4.0"
24 | },
25 | "autoload": {
26 | "psr-4": {
27 | "PackageFactory\\AtomicFusion\\AFX\\": "Classes/"
28 | }
29 | },
30 | "autoload-dev": {
31 | "psr-4": {
32 | "PackageFactory\\AtomicFusion\\AFX\\Tests\\": "Tests/"
33 | }
34 | },
35 | "extra": {
36 | "neos": {
37 | "package-key": "PackageFactory.AtomicFusion.AFX"
38 | }
39 | },
40 | "scripts": {
41 | "test:functional": [
42 | "composer install",
43 | "vendor/bin/phpunit Tests/Functional"
44 | ],
45 | "test": [
46 | "composer test:functional"
47 | ]
48 | }
49 | }
50 |
--------------------------------------------------------------------------------