1
0
mirror of https://github.com/erusev/parsedown.git synced 2023-08-10 21:13:06 +03:00

Compare commits

..

946 Commits

Author SHA1 Message Date
32278afaf3 Fix title 2022-05-21 22:40:24 +01:00
b3f0ae4a7e Merge pull request #821 from erusev/documentation-v2.0
Documentation 2.0
2022-05-21 22:37:26 +01:00
7c7d581601 Error level 1 instead of totallyTyped
Seems this is now the equivalent and sanctioned way to do this.
2022-05-21 22:31:09 +01:00
5cc84366cb Test on 8.1 2022-05-21 22:31:00 +01:00
6be43664fd Add additional explaination for the State object
Adds a small non-technical introduction to help with intuition, after
the object appears for the first time.
2022-05-21 22:26:39 +01:00
bf6cfe8af0 Show importing of Parsedown and State in example 2021-12-08 20:38:35 +00:00
6fdcfaa14a Add initial documentation
This isn't yet complete, but is a decent start
2021-12-08 20:38:35 +00:00
79effc4ae2 Ignore invalid docblock in tests 2021-12-08 20:35:46 +00:00
f77cb47528 Remove unnecessary cast 2021-12-08 20:32:09 +00:00
95c9cce7de Update php-cs-fixer 2021-10-16 00:45:18 +01:00
9749ef7a8e Slightly nicer to allow construction from StateBearer 2021-10-15 23:23:14 +01:00
638079a3da Slightly nicer method name
Normally this name might be too vague for an interface, but implementing
this interface is a fairly special use case. We can expect dedicated
types here (so method name unlikely to be an issue).
2021-10-15 23:20:20 +01:00
421a2393d0 StateBearer must be constructable from State 2021-10-15 23:18:08 +01:00
4af22ec41a Allow substitution of blocks and inlines 2021-10-15 19:25:47 +01:00
4553515e8e Relax mutation tolerance 2021-10-13 22:12:06 +01:00
8ce88c1b36 Off by 1 2021-10-13 19:55:23 +01:00
b73fe2e9ec Apply correct state 2021-10-13 19:52:27 +01:00
7b0a9cda04 Transformations must return transformable renderables 2021-10-13 19:46:53 +01:00
05a47e7083 Complete docblock 2021-10-13 19:35:21 +01:00
e9dec33dc6 Replacing all function to TransformableRenderable 2021-10-13 19:26:07 +01:00
a9f41548d3 adding method for Container 2021-10-13 19:02:52 +01:00
71d9263664 Pass State to render stack closure 2021-10-13 18:50:04 +01:00
8fc49f6b0a Add TransformableRenderable capability 2021-10-12 21:58:24 +01:00
a48c451d6c Restrict autolinks to https 2021-10-12 18:21:17 +01:00
2ea4bece92 Return statebearer instead of state 2021-10-12 18:12:00 +01:00
efaf20d005 Minor refactor to use type hints 2021-10-12 18:05:58 +01:00
0f27f2e842 Add initState to tests 2021-10-12 18:04:36 +01:00
c773305bc1 Add RenderStack
This is a special configurable that can be used to alter the
Renderable[] AST before output.
2021-10-12 00:06:51 +01:00
7c2681be19 Remove travis 2021-10-11 23:12:06 +01:00
9d5af12971 Run both commonmark tests 2021-10-11 20:49:58 +01:00
58bb815870 Dev flag 2021-10-11 20:48:31 +01:00
de06199f4e Support old phpunit, remove lock file 2021-10-11 20:47:21 +01:00
f396d49a4c Use static analysis plugin for infection 2021-10-11 20:43:25 +01:00
7f11869f65 Remove infection for unit tests 2021-10-11 20:33:25 +01:00
3472b9bd3f GitHub Actions 2021-10-11 20:26:42 +01:00
7d1b9ca562 Better autolinks
This doesn't follow gfm spec yet, work lifted from my code over
at
8505e2737e/src/Parsers/GitHubFlavor/Inlines/AutoLink.php

Fixes #505
Fixes #717
2021-10-11 20:09:57 +01:00
cc5614bc5c Test 8.0 in travis 2021-10-11 19:25:58 +01:00
ca16d7573d Fix psalm errors 2021-10-11 19:23:44 +01:00
98aab22002 Update dependencies 2021-10-11 19:22:23 +01:00
9f6112e70a Ignore phpunit result cache 2021-10-11 19:21:21 +01:00
0c5e8c152e Merge pull request #767 from aidantwoods/enhancement/header-slug
Create ID's for Header elements so they can be referenced in anchor tags
2020-05-10 14:41:15 +01:00
8764512c23 Add SlugRegister so IDs are not duplicated 2020-05-10 14:32:01 +01:00
4e99e29d28 Trim leading and trailing hyphens from slug 2020-05-10 14:32:00 +01:00
d8bf07535c Strip superscripts and divisions from eventual slug
As suggested by @Ayesh

Co-authored-by: Ayesh Karunaratne <ayesh@ayesh.me>
2020-05-10 14:32:00 +01:00
e332b4710a Add HeaderSlug configurable
Adds HeaderSlug configurable, with the option for the slug function
to be customised.

Co-authored-by: netniV <netniv@hotmail.com>
2020-05-10 14:31:55 +01:00
74df602863 Merge pull request #768 from aidantwoods/feature/mutable-configurable
Add mutable configurable
2020-05-10 14:30:15 +01:00
c835535176 Implement DefinitionBook as MutableConfigurable
This is a slightly more correct implementation, but perhaps not worth
the headache.
2020-05-10 14:19:05 +01:00
0ef406e6d2 Add MutableConfigurable
Hopefully I do not regret this...
2020-05-10 14:18:51 +01:00
8e8d1dac21 Resolve dependencies when running unit tests 2020-05-05 22:20:11 +01:00
bc018e1d00 Remove 'matrix' key 2020-05-05 22:19:56 +01:00
dbb929fff7 Commit lock file so static analysis results are stable 2020-05-05 22:19:14 +01:00
836c028aa0 Add flag to get type-coverage 2020-01-26 13:09:19 +00:00
bded7a6ff3 PHP 7.4 is now released 2020-01-19 18:14:37 +00:00
2235e36a2c Use verb imperative to indicate method is non-mutating 2020-01-19 18:06:22 +00:00
a6c17f449e previousEmptyLines -> precedingEmptyLines 2020-01-19 17:15:02 +00:00
7610eacbf9 Fix uppercase typo 2020-01-19 15:36:53 +00:00
525b72349b Expensive operation last 2020-01-19 15:34:04 +00:00
39b8b04d33 Clarify sequential lines being tracked are empty 2020-01-19 15:32:51 +00:00
8d09320009 Compute on read optimisation for previousEmptyLines 2020-01-19 15:31:33 +00:00
a72455c78a Use ->toHtml over ->text 2020-01-19 15:26:48 +00:00
a2ea704a43 Use list type over int array 2020-01-19 15:23:58 +00:00
13932bca9a Simplify match logic 2020-01-19 15:09:44 +00:00
0a6408043f Only run units on 7.4snapshot 2019-09-09 23:46:04 +01:00
01319b7572 Add 7.4 snapshot 2019-09-09 23:37:31 +01:00
0a1e4bd802 Formatting fix 2019-09-09 23:33:06 +01:00
bfdd0f29bc More specific annotation 2019-09-09 23:27:36 +01:00
5db3687892 $matches is guarenteed to contain data for the full pattern 2019-09-09 23:26:21 +01:00
bde621e4c4 Drop master from psalm requirement 2019-09-09 23:15:11 +01:00
f75e7bd970 Prefer master until next release 2019-07-31 23:25:25 +01:00
18ee4ffe04 Bump min psalm version 2019-07-25 19:18:26 +02:00
54f7719a08 Force return type to T
It's currently not a planned feature to allow Psalm to understand
the type relationship of class-name => class-instance as the array
here is constructed.
Ref: https://github.com/vimeo/psalm/issues/1969
2019-07-25 19:16:28 +02:00
f51dd8878a Drop use of undefined reference 2019-07-25 19:07:08 +02:00
211a7eb5aa Tables always acquire previous 2019-07-25 16:18:00 +02:00
37f306c3a8 Utilise constant arrays over static vars 2019-07-25 00:45:53 +02:00
ea55a9ffb0 Integer keys aren't necessary 2019-07-25 00:33:15 +02:00
b9bc0b7d37 Update expect-to-pass cache 2019-07-25 00:27:05 +02:00
34902bc80c Account for type 7 HTML blocks
These differ from type 6 blocks in a few ways (other than the HTML
element names given in the spec).

1. Type 7 blocks cannot interrupt paragraphs
2. Type 7 block must contain ONLY whitespace on the rest of the
   line, whereas type 6 blocks need only be followed by whitespace
   after the tag name, or have the opening tag be complete.
2019-07-25 00:22:09 +02:00
f4fb5bd943 Add type 7 HTML block tests 2019-07-25 00:20:59 +02:00
614c76be6f Drop pre 7.1
Drop pre 5.6 for constant arrays
Drop pre 7.1 for private constants
2019-07-25 00:18:29 +02:00
91b8bda46e Update test cache 2019-06-16 21:36:11 +01:00
5a12d4245f Allow unused class in tests 2019-06-16 21:35:13 +01:00
298b319d96 Fix malformed return type 2019-06-16 21:33:55 +01:00
7b1389b48b More specific return type 2019-06-16 21:32:37 +01:00
efcccb3256 Update commonmark cache 2019-04-10 07:02:52 +01:00
9eb6a02334 Limit recursion depth by configurable
Fixes https://github.com/erusev/parsedown/issues/681
2019-04-07 17:34:40 +01:00
b9b75dbcea Update commonmark cache 2019-04-07 16:38:46 +01:00
35d24d0b56 PHP < 7 patch 2019-04-07 16:38:46 +01:00
3f74fe8347 Port fix for https://github.com/erusev/parsedown/issues/699 into new
codebase
2019-04-07 16:38:46 +01:00
710a6ad250 Remove format error 2019-04-07 16:38:46 +01:00
9b9c9d83d2 Update CommonMark expect to pass 2019-04-07 16:38:46 +01:00
d32f5de2fe According to GFM spec these shouldn't infact be recognised 2019-04-07 16:38:45 +01:00
99525fdd76 Match GFM spec for extended autolinks
There is a small list of characters which may precede an autolink
2019-04-07 16:38:45 +01:00
de1e0b9361 Update README to match Travis breadth 2019-04-07 16:38:45 +01:00
c86757b6ae Use caret operator for PHP version
As suggested by @glensc
2019-04-07 16:38:20 +01:00
33522f0aa4 Normalise link reference lookups
Ref: https://github.com/erusev/parsedown/pull/104
2019-04-07 16:38:19 +01:00
7f6127f3f8 Ensure we cover all mutations in tests 2019-04-07 16:38:19 +01:00
4adbd0b8a7 Backtracking capable inlines better expressed by interface 2019-04-07 16:38:19 +01:00
4501a094db Remove copy-pasto 2019-04-07 16:38:19 +01:00
4a215f33d4 Trim in renderer 2019-04-07 16:38:19 +01:00
3ccd64a9a1 Expand public API of Components
Ref: https://github.com/erusev/parsedown/issues/694
2019-04-07 16:38:19 +01:00
3c0b528d54 Constructor shouldn't be part of public API 2019-04-07 16:38:18 +01:00
f83ee87902 Make this pattern a bit more reusable 2019-04-07 16:38:18 +01:00
747abe7600 Test indented code boundary when list advances 2019-04-07 16:38:18 +01:00
a396fccace No contexts implies everything being appended is a blank line
(of which where is at least one).
2019-04-07 16:38:18 +01:00
93e68056a8 Further improve tests 2019-04-07 16:38:18 +01:00
4fb6ac31a5 Improve tests 2019-04-07 16:38:18 +01:00
69f6754c4d These classes of mutations would be caught be static analysis
Infection doesn't support running Psalm, so removing
the mutations is next best solution.
2019-04-07 16:38:18 +01:00
d8d483bd6a Add some component level tests 2019-04-07 16:38:17 +01:00
c0792947a6 Remove unused methods 2019-04-07 16:38:17 +01:00
658129d847 Suppress instead of writing super verbose tests 2019-04-07 16:38:17 +01:00
65450f47cd Simplify 2019-04-07 16:38:17 +01:00
fc23ca5ef5 Remove more redundant checks 2019-04-07 16:38:17 +01:00
015e476f3e Remove unused import 2019-04-07 16:38:17 +01:00
289b641a42 Remove inaccurate comment 2019-04-07 16:38:17 +01:00
147a87a4f3 These are self-explainitory 2019-04-07 16:38:16 +01:00
b90efc69ec Ensure marker is properly contained in the Inline 2019-04-07 16:38:16 +01:00
dbe37bcb0e Type check tests 2019-04-07 16:38:16 +01:00
30613b2430 Ensure $startPosition is positive 2019-04-07 16:38:16 +01:00
cef5b16ae0 Update excludes 2019-04-07 16:38:16 +01:00
5ecfc42728 Early exit if found 2019-04-07 16:38:16 +01:00
3bb24c20a6 Assert marker is correct for hard and soft breaks 2019-04-07 16:38:16 +01:00
369aea5d8d Collect State from continuable state updating block on advance 2019-04-07 16:38:15 +01:00
2b79d599fb Require State to build and advance blocks 2019-04-07 16:38:15 +01:00
8fd3c77109 Tighten requirements 2019-04-07 16:38:15 +01:00
df703dcb0e Missed one 2019-04-07 16:38:15 +01:00
36fac49ed8 Remove redundant checks
These don't appear to have a measurable positive impact on performance.
2019-04-07 16:38:15 +01:00
41fb6b0d43 Move url sanitisation out of Element class 2019-04-07 16:38:15 +01:00
a681cf631c Acquisition capable blocks as an interface 2019-04-07 16:38:15 +01:00
6ac6b7f7f7 Test blockquote whitespace handling 2019-04-07 16:38:14 +01:00
3c6578dd4b Remove deleted stage 2019-04-07 16:38:14 +01:00
c2973100e0 Fix whitespace trimming for soft and hard breaks 2019-04-07 16:38:14 +01:00
0626a83289 Test trimming doesn't occur when asymmetric 2019-04-07 16:38:14 +01:00
2efae741bb Simplify expression 2019-04-07 16:38:14 +01:00
93650fb9b5 PHP 5.5 compat 2019-04-07 16:38:14 +01:00
9bf91d7183 Cache spec locally for 5 minutes 2019-04-07 16:38:13 +01:00
f95c3bb154 --show-mutations over cat infection.log 2019-04-07 16:38:13 +01:00
660c2e43a3 Paragraph would end itself and new one must start for header row to
exist
2019-04-07 16:38:13 +01:00
d9792bb12c Ensure markers are checked when beginning blocks 2019-04-07 16:38:13 +01:00
08c40afc16 Test against HTML block endings 2019-04-07 16:38:13 +01:00
14f8ff52e1 Test continuation of indented code blocks 2019-04-07 16:38:13 +01:00
c310625b93 Length not necessary 2019-04-07 16:38:13 +01:00
811991b27d Run mutation tests after unit tests on supported platforms 2019-04-07 16:38:12 +01:00
d29f900374 Nightly doesn't have xdebug 2019-04-07 16:38:12 +01:00
efe324c08b Add mutation testing 2019-04-07 16:38:12 +01:00
54f2c4eb4c Fix recovered spaces calculation 2019-04-07 16:38:12 +01:00
117912c373 Substr over indexing string 2019-04-07 16:38:12 +01:00
63a97a926b Remove leftover hackyness 2019-04-07 16:38:12 +01:00
cb211a88a8 PHP < 7 compat 2019-04-07 16:38:12 +01:00
c49d40027f Add StateBearer which can carry state 2019-04-07 16:38:11 +01:00
4dee1e9a55 Add convenience instance-based initialisers 2019-04-07 16:38:11 +01:00
dbc0efeec0 Require integer-keyed lists so that array_merge result is predictable 2019-04-07 16:38:11 +01:00
fe1355ef9e Test strict and weak in Travis 2019-04-07 16:38:11 +01:00
f2f7433dcf Switch to CommonMarkStrict tests 2019-04-07 16:38:11 +01:00
a2bca78f7e Fix whitespace errors 2019-04-07 16:38:11 +01:00
42d21a2413 Remove cached items no that longer exist in spec.txt 2019-04-07 16:38:10 +01:00
f47ba7aa34 Track whitespace left on blank lines to match CommonMark
Test changes copy pasted to match CommonMark reference parser
2019-04-07 16:38:10 +01:00
49dd8b113d Make sure closing sequence is removed correctly 2019-04-07 16:38:10 +01:00
30763a0f38 HTML tags should have a name 2019-04-07 16:38:10 +01:00
3dd1326ded Trim paragraph contents 2019-04-07 16:38:10 +01:00
0f55cd5b26 Permit empty links 2019-04-07 16:38:10 +01:00
5ada761532 Cache new passing tests 2019-04-07 16:38:10 +01:00
4fa89c1a80 Fix regex compilation 2019-04-07 16:38:09 +01:00
7b72eb6454 As best I can tell, these were passed accidently before 2019-04-07 16:38:09 +01:00
745db11d2f Since SafeMode concerns output, spacing should still be parsed like markup 2019-04-07 16:38:09 +01:00
82d20d8ffe Markup like CommonMark 2019-04-07 16:38:09 +01:00
7fd6e0bb31 Backslash escape like CommonMark 2019-04-07 16:38:09 +01:00
eab734b457 Match CommonMark's rendering a bit better 2019-04-07 16:38:08 +01:00
2e0ad27c5e CommonMark escapes double-quotes 2019-04-07 16:38:08 +01:00
d6c97ee111 Make escaping slightly less aggressive 2019-04-07 16:38:08 +01:00
62615f4fc5 Allow empty code spans 2019-04-07 16:38:08 +01:00
50e135cd4e Update expect-to-pass CommonMark spec examples for f4e0234 2019-04-07 16:38:08 +01:00
0514997103 Add initial test/commonmark/ folder 2019-04-07 16:38:08 +01:00
4c0734d935 Sync phpunit data set and CommonMark spec example numbers 2019-04-07 16:38:07 +01:00
734b4fc3d7 Test Parsedown against cached expect-to-pass CommonMark spec examples
This test suite runs tests the same way as `test/CommonMarkTestWeak.php`, but uses a cached set of CommonMark spec examples in `test/commonmark/`. It is executed along with Parsedown's default test suite and runs various CommonMark spec examples, which are expected to pass. If they don't pass, the Parsedown build fails. The intention of this test suite is to make sure, that previously passed CommonMark spec examples don't fail due to unwanted side-effects of code changes.

You can re-create the `test/commonmark/` directory by executing the PHPUnit group `update`. The test suite will then run `test/CommonMarkTestWeak.php` and create files with the Markdown source and the resulting HTML markup of all passed tests. The command to execute looks like the following:

    $ phpunit --group update
2019-04-07 16:38:07 +01:00
4563ee592d Don't assume marker type is correct 2019-04-07 16:38:07 +01:00
cbe7b25b21 No markup can be achieved by removing the respective parsing Components 2019-04-07 16:38:07 +01:00
f0da746c7b Remove reminder comment
urlsLinked(false) is replaced by customising to remove
the inline from InlineTypes configurable when initialising
Parsedown
2019-04-07 16:38:07 +01:00
aab56cf8cc Fix strange formatting 2019-04-07 16:38:07 +01:00
48c0c34470 Caching for initial configurable values removes need to seed state 2019-04-07 16:38:07 +01:00
bc3c1544c5 Don't special case invisible
If something has no html, it doesn't need to have a newline
2019-04-07 16:38:06 +01:00
d6f526d80f Return state after block parse instead of mutating the instance copy 2019-04-07 16:38:06 +01:00
b728f254b7 Ensure Url parsing is removed all the way down (not just edge) 2019-04-07 16:38:06 +01:00
ebde35cf0d Add some style cleanup rules already followed 2019-04-07 16:38:06 +01:00
d733c262c2 Cleanup logical operators 2019-04-07 16:38:06 +01:00
19e21f2d1b Remove test extensions 2019-04-07 16:38:06 +01:00
11da347aa1 We don't need to pass a Parsedown instance down
Since Parsedown is instancible from State, we only
need to carry that down.
2019-04-07 16:38:05 +01:00
b89bd0e3c2 Add breaks configurable 2019-04-07 16:38:05 +01:00
fce09a702a Put reused code in a trait so boolean configurables are easy to make 2019-04-07 16:38:05 +01:00
8fe93f30ac Add easy way to remove Components from InlineTyes and BlockTypes 2019-04-07 16:38:05 +01:00
9f9ef78662 This should be slightly faster
Merge would honour changes, and removals
are equivalent to changing to default value.
2019-04-07 16:38:05 +01:00
57632f38fb More meaningful method name 2019-04-07 16:38:05 +01:00
5e7fb61879 More keyword fixes for pre-PHP7 2019-04-07 16:38:05 +01:00
2618509cc6 Now the class is a bit shorter we can remove these makeshift dividers 2019-04-07 16:38:04 +01:00
fce4633ff9 Inlines and Blocks as Configurables 2019-04-07 16:38:04 +01:00
eb90905d27 Default value is intrinsic to a configurable, we can just always
retrieve that.
2019-04-07 16:38:04 +01:00
5a50930cb0 Allow inlines to backtrack into characters that were suspected as
inlines but ruled out
This is required for backslash escaped Hard breaks to work:
Parsedown first checks to see if these are escape sequences,
however when they are ruled out they should not be assumed to be
plaintext since a later inline (Hardbreak) may backtrack into these
unconsumed characters.
2019-04-07 16:38:04 +01:00
1fd2e14b72 Add hard and soft breaks 2019-04-07 16:38:04 +01:00
714ae50211 Text variable isn't very useful inside the loop 2019-04-07 16:38:04 +01:00
14b3761687 Produce Blocks before converting to StateRenderables
(As we do with Inlines)
2019-04-07 16:38:04 +01:00
00821bd072 Don't remove right #'s too early (before dealing with whitesapce) 2019-04-07 16:38:03 +01:00
b8cdc6e9a5 Remove closing # sequence from header 2019-04-07 16:38:03 +01:00
9d97b8eb6a We should be using strict mode in commonmark benchmark 2019-04-07 16:38:03 +01:00
67231cbae1 Tabs are allowed after header delimiter 2019-04-07 16:38:03 +01:00
81a2050608 Headers can't start with more than three spaces 2019-04-07 16:38:03 +01:00
3d41f270c2 Better name for testing safe mode and strict mode state
Add a nice named constructor
2019-04-07 16:38:03 +01:00
bb424e606f Improve indent handling by lists 2019-04-07 16:38:03 +01:00
51c3d9d445 Make it clearer this is one backslash character 2019-04-07 16:38:02 +01:00
74bba0b2fa rtrim non hard breaking lines 2019-04-07 16:38:02 +01:00
fc37ad11ed Tabs shouldn't break thematic breaks 2019-04-07 16:38:02 +01:00
4e9a0113c3 Thematic breaks can't have an indent of more than 3 2019-04-07 16:38:02 +01:00
96d8a1f18c Add dead code test to composer test script 2019-04-07 16:38:02 +01:00
82c981657d Require Inlines to provide a best plaintext rendering
This allows markdown to be parsed "inside" the alt
attribute of an image, and then the best plaintext
can be used as the rest.
This improves CommonMark compliance.
2019-04-07 16:38:02 +01:00
576a2c4519 Generalise line parsing to return Inlines before applying state 2019-04-07 16:38:01 +01:00
083ad582c7 State management
Decouple state from final rendering
Restore initial state after parsing
2019-04-07 16:38:01 +01:00
c9388cb5c2 Make use of line name instead of lineElements 2019-04-07 16:38:01 +01:00
bb8a16ad81 Remove useless line method
This will be achievable by directly restricting enabled Components
2019-04-07 16:38:01 +01:00
2cfd05a00e Test for dead code in travis 2019-04-07 16:38:01 +01:00
7f526c07a0 Indent offset is encompassed in Lines object 2019-04-07 16:38:01 +01:00
366600034c This isn't used and is derivable from the indent 2019-04-07 16:38:01 +01:00
6add0ea877 Remove useless variables 2019-04-07 16:38:00 +01:00
dac6b01d1a Remove meaningless interrupt check
Interrupted implies previousEmptyLines > 0 in incoming Context
2019-04-07 16:38:00 +01:00
6f5780abfd Improve Link API 2019-04-07 16:38:00 +01:00
2757274854 Constant arrays to static vars for PHP 5.5 2019-04-07 16:38:00 +01:00
37895448ba Fix PHP 5.6 bug 2019-04-07 16:38:00 +01:00
6f1bc7db14 Fix pre PHP7 closure-as-property closure syntax 2019-04-07 16:38:00 +01:00
e4ed4da626 More keyword related fixes for pre PHP 7 2019-04-07 16:38:00 +01:00
351a68a14c Remove some return type hints that I missed 2019-04-07 16:37:59 +01:00
a9aa7e7aae Test on PHP 5.5 and 5.6
Issue on pre PHP 7 may be to do with method name and not call syntax as
suspected
2019-04-07 16:37:59 +01:00
f8003dcded Remove debug lines 2019-04-07 16:37:59 +01:00
ca008872ba Use latest PHP on non-unit test build staged 2019-04-07 16:37:59 +01:00
7188f49a71 7.3 was released, so make failure blocking 2019-04-07 16:37:59 +01:00
b3608829e5 Calling static functions on metatype class string is >=PHP7 only
🤷‍♂️
2019-04-07 16:37:59 +01:00
f420fad41f Remove ignore statement for core class :) 2019-04-07 16:37:59 +01:00
f58845c480 Bump Psalm version for new static analysis features 2019-04-07 16:37:58 +01:00
04816a9944 Adjust tests for new API
Remove tests that test old core and extension features
Comment out test for no markup independent of safe mode
2019-04-07 16:37:58 +01:00
e2c9b2fa2b Remap text-level elements retreival 2019-04-07 16:37:58 +01:00
799ced66fa Use Parsedown directly
Remove UrlsLinked adjustment--we'll have a better way
of doing that later
2019-04-07 16:37:58 +01:00
e6e24a8d0d Rewrite to use new internals 2019-04-07 16:37:58 +01:00
36cfb21908 Remove no longer needed parts of core class 2019-04-07 16:37:58 +01:00
dbdbda52a8 Make Parsedown non-extendable and remove comment header 2019-04-07 16:37:58 +01:00
114eb0bc5b Add required imports 2019-04-07 16:37:57 +01:00
a286033f52 Implement UrlTag 2019-04-07 16:37:57 +01:00
53bb9a6467 Implement Url 2019-04-07 16:37:57 +01:00
db1d0a4999 Implement Strikethrough 2019-04-07 16:37:57 +01:00
f256352f53 Implement SpecialCharacter 2019-04-07 16:37:57 +01:00
778eacd081 Implement Markup 2019-04-07 16:37:57 +01:00
5e8905c455 Implement Image 2019-04-07 16:37:57 +01:00
dad0088adb Implement Link 2019-04-07 16:37:56 +01:00
79a38a1ebb Implement EscapeSequence 2019-04-07 16:37:56 +01:00
164a39f3e9 Implement Emphasis 2019-04-07 16:37:56 +01:00
f2a3a2fb08 Implement Email 2019-04-07 16:37:56 +01:00
497045d25b Implement Code 2019-04-07 16:37:56 +01:00
760945008b Implement plaintext 2019-04-07 16:37:56 +01:00
25cf5a1729 Add some traits for common Inline implementations 2019-04-07 16:37:55 +01:00
18e239fba1 Implement Paragraph 2019-04-07 16:37:55 +01:00
b53971e656 Implement Table 2019-04-07 16:37:55 +01:00
0c730e0dc5 Implement Reference 2019-04-07 16:37:55 +01:00
565c8dd3cc Implement IndentedCode 2019-04-07 16:37:55 +01:00
ee094cb397 Implement Markup 2019-04-07 16:37:55 +01:00
edc004f503 Implement SetextHeader 2019-04-07 16:37:55 +01:00
af97e99b39 Implement Rule 2019-04-07 16:37:54 +01:00
a95bc60c30 Implement List 2019-04-07 16:37:54 +01:00
07c2566042 Implement Header 2019-04-07 16:37:54 +01:00
57c6350184 Implement FencedCode 2019-04-07 16:37:54 +01:00
194c916c6a Implement Comment 2019-04-07 16:37:54 +01:00
c50deda690 Implement BlockQuote 2019-04-07 16:37:54 +01:00
3094329950 Add traits to provide common block implementations 2019-04-07 16:37:54 +01:00
74a855946d Add some more exotic type specialisations of block 2019-04-07 16:37:53 +01:00
c17868cac8 Basic block and inline definitions 2019-04-07 16:37:53 +01:00
5a00cb7f07 Define a basic component 2019-04-07 16:37:53 +01:00
db657952d1 Add DefinitionBook configurable to replace definition data 2019-04-07 16:37:53 +01:00
c55dbb0d3f Add safe mode and strict mode configurables 2019-04-07 16:37:53 +01:00
072f91df47 Add some useful renderables 2019-04-07 16:37:53 +01:00
c852b487b4 Expose text string backing 2019-04-07 16:37:53 +01:00
00835c5101 Adjustments to rendering spacing 2019-04-07 16:37:52 +01:00
a971e5aa54 Put element related sanitisation and data in a centralised location 2019-04-07 16:37:52 +01:00
23cfbd153c Add canonical state renderable to provide default implementation for
renderables to be trivially state renderable
2019-04-07 16:37:52 +01:00
23560bfa33 Add handler so closures can implement state renderable via the wrapper 2019-04-07 16:37:52 +01:00
1f06b47e6c Add configurable and state 2019-04-07 16:37:52 +01:00
7746c9df06 Add state renderable -- all renderables are state renderables 2019-04-07 16:37:52 +01:00
dcc5ea0c9b Add Excerpt class 2019-04-07 16:37:52 +01:00
7ef8b30043 Capitalisation 2019-04-07 16:37:51 +01:00
deaf0682b5 Make tab shortage function public 2019-04-07 16:37:51 +01:00
3a0db641aa Test format before units 2019-04-07 16:37:51 +01:00
215953334e Update psalm version for bugfixes 2019-04-07 16:37:51 +01:00
1541859e0e PHP < 7 compat for Html renderables 2019-04-07 16:37:51 +01:00
0f6c0fa84d PHP < 7 compat
Don't use token name for function name

Remove return typehint

Remove parameter typehints
2019-04-07 16:37:51 +01:00
0f36000dc9 Add typed Context and Lines objects 2019-04-07 16:37:50 +01:00
57b86b3fc4 Use psalm for static analysis
Don't check the main Parsedown file just yet
2019-04-07 16:37:50 +01:00
f6a845fa52 Use typed Line object 2019-04-07 16:37:50 +01:00
db04e1575f Commonmark stage should be allowed to fail in travis 2019-04-07 16:37:50 +01:00
6d03fa0d3a Rephrasing 2019-04-07 16:37:50 +01:00
49829c2019 Remove HHVM for now 2019-04-07 16:37:50 +01:00
c419295466 Remove unsupported dependencies when running unit tests (PHP < 7 compat) 2019-04-07 16:37:50 +01:00
23b07fa185 Cache composer cache in travis 2019-04-07 16:37:49 +01:00
5795a6f0a9 Add travis build stages 2019-04-07 16:37:49 +01:00
a42848da57 CommonMark weak test in composer 2019-04-07 16:37:49 +01:00
82a528711f Fix commonmark test 2019-04-07 16:37:49 +01:00
8c091b8e63 Testing composer shortcuts 2019-04-07 16:37:49 +01:00
a636bf7bfa Update phpunit version 2019-04-07 16:37:49 +01:00
8512e65a18 Standardise formatting 2019-04-07 16:37:49 +01:00
267256cbb8 Fix typos 2019-04-07 16:37:48 +01:00
f8aa618f3d Default construct to empty text 2019-04-07 16:37:48 +01:00
f85f6cbd40 Add setting constructors for each property 2019-04-07 16:37:48 +01:00
822cf15ac9 Add helper constructor with variadic 2019-04-07 16:37:48 +01:00
9046f066df Html/Component -> Html/Renderable 2019-04-07 16:37:48 +01:00
7690b98f61 Correct namespace 2019-04-07 16:37:48 +01:00
04581d0915 Basic HTML constructs 2019-04-07 16:37:47 +01:00
5ab8839d04 PHP 5.3 and 5.4 class name support 2019-04-07 16:37:47 +01:00
c429c47fee Remove strict_types for PHP 5.3 and 5.4 compat 2019-04-07 16:37:47 +01:00
88ab68fd0b Refactor into namespaces for PSR-4 2019-04-07 16:37:47 +01:00
bfaa76d370 Reflect travis breadth in README
Closes https://github.com/erusev/parsedown/issues/692
2019-04-07 16:36:22 +01:00
3825db53a2 Merge branch '1.8.x-beta' 2019-04-06 17:58:29 +01:00
fe7a50eceb New release due to mislabeled previous tag 2019-03-17 18:47:21 +00:00
bce642f2d7 7.3 was released 2019-03-17 18:38:54 +00:00
7d4c06cb52 Bump version 2019-03-17 17:19:07 +00:00
f7b66e6b20 Merge pull request #701 from aidantwoods/fix/spaces-in-class-names-1.8.x-beta
[1.8.x-beta] Fix spaces in class names
2019-03-17 17:10:10 +00:00
811bc32726 Fix test platforms 2019-03-17 17:04:25 +00:00
8fd5464c46 [1.8.x-beta] Fix spaces in class names 2019-03-17 17:01:52 +00:00
21c8c792de Merge pull request #698 from cybernet/patch-1
Symfony Demo link update
2019-03-14 18:49:20 +00:00
6ca29539e1 Symfony Demo link update 2019-03-12 20:49:21 +00:00
a503c1a69b composer/composer#7990 2019-03-02 12:08:48 +02:00
819c68899d Simplify installation instructions 2018-12-28 13:17:22 +02:00
4c2d79fc6a More consistent code blocks in readme 2018-12-28 12:50:30 +02:00
48a2fb26fe Add badges to readme 2018-12-28 12:47:13 +02:00
33b79d2446 More logo padding and no underline 2018-12-28 02:21:55 +02:00
d6d2d96459 Add repo name as h1 2018-12-28 02:19:44 +02:00
d5b6ab5198 Readme logo to be centered 2018-12-28 02:14:25 +02:00
15e8439c7f Back to smaller padding in readme logo 2018-12-28 02:04:16 +02:00
ff6148f9b9 Improve readme badges 2018-12-28 01:56:45 +02:00
dfd8657bc5 h1 around logo in readme 2018-12-28 01:28:59 +02:00
ee64646765 More padding for logo in readme 2018-12-28 01:21:51 +02:00
c956090b55 Update readme logo 2018-12-28 01:07:49 +02:00
0be26550f3 Update readme logo 2018-12-28 00:55:48 +02:00
8e26a65a6f More consistent letter case in readme 2018-12-28 00:41:14 +02:00
2a24a8583b More consistent formatting in readme 2018-12-28 00:36:04 +02:00
1d55344e92 Simpler readme header 2018-12-27 23:59:37 +02:00
5dc8d1cc39 Simpler readme examples 2018-12-27 23:51:07 +02:00
33cf0f0b99 Centered header in readme 2018-12-27 23:46:53 +02:00
dc1ff7d6c2 Remove horizontal rule from readme 2018-12-27 22:50:39 +02:00
0f0987571d Bigger headings in readme 2018-12-27 22:32:54 +02:00
18eaa649b5 Add logo to readme 2018-12-27 22:23:17 +02:00
e124572b60 Merge pull request #675 from andreybolonin/patch-1
add php 7.3
2018-11-16 07:45:32 +00:00
1686a34469 add php 7.3 to allow_failures 2018-11-16 09:34:17 +02:00
2bd7113c55 Merge pull request #676 from aidantwoods/fix/uninitialized-string-offset
Fix access to potentially uninitialised offset
2018-11-06 21:49:46 +00:00
29fce0ec37 Fix access to potentially uninitialised offset 2018-11-06 21:10:23 +00:00
b0bbc275d4 add php 7.3 2018-10-31 15:48:28 +02:00
72f9ca92ae Merge pull request #671 from aidantwoods/fix/line-ending-standardisation
Ensure line-breaks get standardised when using Parsedown via `line` method
2018-10-16 18:51:05 +01:00
89c3fa05d9 Ensure line-breaks get standardised when using via line method
As noted in https://github.com/erusev/parsedown/pull/624 there are
occasions where line break standardisation is assumed (e.g. where
`inlineCode` replaces line breaks with a space).

Closes #624
2018-10-16 18:41:42 +01:00
69163d6e88 Merge pull request #670 from tillkruss/patch-1
Add "tel:" to whitelist
2018-10-14 21:48:40 +01:00
3a0c964291 Add "tel:" to whitelist 2018-10-02 16:38:21 -07:00
1829106e60 Merge pull request #668 from itshoro/block-heading-min
remove redundant header level cap
2018-09-19 21:28:02 +01:00
464f5f9329 removed min function as it is redundant in the context 2018-09-19 17:36:40 +02:00
c26a2ee4bf Bump beta version 2018-06-11 19:15:32 +01:00
ba3b60d6e4 Merge pull request #641 from aidantwoods/fix/api-stability-complete-function-removal
Restore existence of protected API methods
2018-06-08 14:38:42 +01:00
0b1e6b8c86 Restore existence of protected API methods 2018-06-07 19:47:09 +01:00
1f69f7e697 Bump version 2018-05-08 22:46:15 +01:00
c83af0a7d5 Merge pull request #628 from aidantwoods/fix/revert-rawHtml-breaks-insertion
Preserve plain-text in AST to avoid blinding extensions to it
2018-05-08 22:41:44 +01:00
4686daf8c2 Preserve plain-text in AST to avoid blinding extensions to it 2018-05-08 22:32:57 +01:00
c9e7183cfa Merge pull request #627 from aidantwoods/fix/hidden-blocks
Intepret special "hidden" key as an empty element
2018-05-08 22:07:51 +01:00
9eed1104e7 Intepret special "hidden" key as an empty element 2018-05-08 21:54:30 +01:00
fd95703da5 Version bump 2018-05-07 14:26:12 +01:00
8d172a2994 Merge pull request #614 from aidantwoods/enhancement/performance-tweaks
General and performance tweaks
2018-05-07 11:18:21 +01:00
dfab7240a4 Merge pull request #621 from paukenba/master
Tilde characters may be escaped
2018-04-24 17:39:09 +01:00
113c6d2b21 Tilde characters may be escaped 2018-04-23 15:09:30 +02:00
a9764ec90f Remove complex string interpolation expressions 2018-04-14 15:27:06 +01:00
0a842fb5b1 Merge pull request #615 from aidantwoods/fix/old-handler-compat
Compatability fixes
2018-04-12 22:29:29 +01:00
7f4318dbdb PHP 5.3 == 💩 2018-04-12 22:22:53 +01:00
3e70819a20 Readability improvements, thanks @PhrozenByte 2018-04-12 22:16:25 +01:00
2bf7ca41a0 Add compat for extensions using old markup key. 2018-04-12 21:25:50 +01:00
b75fd409ff Must unset text key so that our destination is preferred as content 2018-04-12 21:10:09 +01:00
88a3f31dd7 Rewrite as one statement 2018-04-12 19:33:01 +01:00
726d4ef44a Sanity checks before starting regex engine 2018-04-09 18:09:45 +01:00
450a74fedf More expensive statement last 2018-04-09 18:09:45 +01:00
7e15d99d90 Remove regex from block rule 2018-04-09 18:09:44 +01:00
d2dd736e1b Remove regex from fenced code block
Also remove unused function
2018-04-09 18:09:44 +01:00
e74a5bd7ed In theory PHP stores the length of strings, so looking this up should be quick 2018-04-09 18:09:44 +01:00
b53aa74a72 Use standard library function 2018-04-09 18:09:44 +01:00
3ea08140b6 Remove use of array 2018-04-09 18:09:44 +01:00
c45e41950f Use standard library over while loop 2018-04-09 18:09:44 +01:00
2faba6fef5 Remove unneeded complete function 2018-04-09 18:09:44 +01:00
b42add3762 Make some regexes possesive 2018-04-09 18:09:43 +01:00
107223d3a0 Avoid recomputation 2018-04-09 18:09:43 +01:00
d4f1ac465c String interpolation is slightly faster than concat 2018-04-09 18:09:43 +01:00
d6e306d620 Optimise commonly used regexes to fail fast 2018-04-09 18:09:04 +01:00
dc5cf8770b The AST has high complexity here (and so traversal is hard anyway)
We gain quite a bit of a speed boost by working with text here
since this is a very common function
2018-04-09 18:09:04 +01:00
70f5c02d47 Use non-nestable values as keys for O(1) lookup 2018-04-09 18:09:04 +01:00
90ad738933 General readability 2018-04-09 18:09:04 +01:00
f2327023c1 No need to unset if not set 2018-04-09 18:09:04 +01:00
6f13f97674 Use mutating loop instead of array_map 2018-04-09 18:08:58 +01:00
8091e5586a Merge pull request #612 from aidantwoods/fix/table-columns
Table header should not be allowed to contain new lines
2018-04-09 16:53:07 +01:00
cb33daf0e6 Assert table header does not contain new lines 2018-04-09 16:38:03 +01:00
c440c91af5 Add failing test case 2018-04-09 16:32:36 +01:00
3514881e14 Merge pull request #611 from aidantwoods/enhancement/paragraph-block-semantics
Paragraph block semantics
2018-04-09 16:30:33 +01:00
043c55e4c6 Give paragraph block semantics for overloading 2018-04-09 15:12:17 +01:00
e4cd13350b Remove setLiteralBreaks 2018-04-09 15:11:45 +01:00
ae8067e862 Swap undefined type for type === 'Paragraph' for ease of reading
The way in which we use this assumes that it is a paragraph, for example
appending text into the handler argument — so there is no loss of
generality here, we're simply being explicit.
2018-04-09 14:48:48 +01:00
5353ebb524 Avoid needing two arrays
We only need to collect elements, we can discard finished blocks
2018-04-09 14:48:39 +01:00
39df7d4f8e Swap 'hidden' blocks for empty elements 2018-04-09 14:46:24 +01:00
50f15add44 Merge pull request #610 from aidantwoods/fix/lost-line-breaks
Fix lost line breaks
2018-04-09 14:19:38 +01:00
3f5b0ee781 Count number of interrupts 2018-04-09 14:13:10 +01:00
9a021b2130 Add failing test cases 2018-04-09 14:11:49 +01:00
43d25a74fe Fix function name 2018-04-08 18:40:50 +01:00
1d68e5506c Merge pull request #608 from aidantwoods/fix/recursion
Add seperate depth-first function instead of replacing recursive method
2018-04-08 18:02:17 +01:00
86940be224 Use mutating loop instead of creating new array 2018-04-08 17:49:36 +01:00
cdaf86b039 Add seperate depth-first function instead of replacing recursive method 2018-04-08 17:39:24 +01:00
1d65fb858a Restore file permission to that of 1.7.1 2018-04-08 14:30:23 +01:00
600db7e4de Bump version const to 1.8.0-beta-1 2018-04-08 02:46:30 +01:00
1be2a01de8 Merge pull request #607 from aidantwoods/update/readme-install-instructions
Update readme install instructions
2018-04-07 16:59:49 +01:00
f50ba3d803 Merge pull request #606 from erusev/revert-605-fix/this-php5.3-compat
Replace fix in "Explicitly capture $this for PHP 5.3"
2018-04-06 21:00:52 +01:00
387ef63888 Replace array reduce with foreach loop for PHP 5.3 compat 2018-04-06 20:55:27 +01:00
68be90348c Revert "Explicitly capture $this for PHP 5.3" 2018-04-06 20:50:34 +01:00
48b9f71bdc Merge pull request #605 from aidantwoods/fix/this-php5.3-compat
Explicitly capture $this for PHP 5.3
2018-04-06 20:44:32 +01:00
0039cd00f8 Explicitly capture $this for PHP 5.3 2018-04-06 20:40:25 +01:00
c6b717cc35 Merge pull request #604 from aidantwoods/fix/autobreak
Ensure autobreak false is honoured over empty name
2018-04-06 20:00:32 +01:00
8f3f61883d Merge pull request #603 from aidantwoods/fix/recursion
Apply depth first
2018-04-06 19:57:55 +01:00
4c9ea94d0c Apply depth first to avoid risk of segfault if closure creates subelements 2018-04-06 19:52:25 +01:00
32e69de014 Ensure autobreak false is honoured over empty name 2018-04-06 19:51:27 +01:00
201299ddc2 Merge pull request #602 from aidantwoods/enhancement/text-elements
Split some of `text` into `textElements`
2018-04-06 19:50:24 +01:00
557db7c179 Split some of text into textElements
`process` is no longer needed
2018-04-06 18:11:27 +01:00
0c0ed38290 Don't encourage downloading from master 2018-04-06 16:13:29 +01:00
798bda682e Update README.md
updated installation instructions. fixes #242
2018-04-06 16:09:36 +01:00
9b7b7348b4 Merge pull request #598 from aidantwoods/enhancement/set-literal-breaks
Add literalBreaks support
2018-04-06 15:06:45 +01:00
96581dbe16 Merge pull request #600 from aidantwoods/fix/code-block-closer
Fix fenced code block closer length rules
2018-04-05 18:46:49 +01:00
06b810cd4a Fix fenced code block closer to match CommonMark rules 2018-04-05 16:55:14 +01:00
38ea813b0e Add failing test case 2018-04-05 16:54:35 +01:00
24e48e91c8 Add literalBreaks support
Line breaks will be converted to <br />
2018-04-05 01:01:52 +01:00
e33f1a48c8 Merge pull request #596 from aidantwoods/enhancement/test-on-php72
Test on PHP 7.2
2018-04-02 19:56:02 +01:00
1c8f6bc253 Merge pull request #594 from aidantwoods/enhancement/ast-recursion-helper
Add recursive helper for AST
2018-04-02 19:53:58 +01:00
ed3e967fb6 Update README 2018-04-02 19:52:26 +01:00
3b3d13489b Test on PHP 7.2 2018-04-02 19:51:07 +01:00
498c88c4eb Merge pull request #589 from NathanBaulch/hashtag
Support #hashtag per CommonMark and GFM specs
2018-04-02 17:25:28 +01:00
772c919b05 Fix bug where empty atx headings would not be recognised (CommonMark)
Fixes #595
2018-04-02 17:18:01 +01:00
cf6d23de55 Rename hashtags enabled to strict mode
We can use this to seperate any intentional spec deviations from
spec behaviour so users can pick between compatability and spec
implementations
2018-04-02 17:18:01 +01:00
d0279cdd3b Enable #hashtag support via setting 2018-04-02 17:18:01 +01:00
8a90586218 Support #hashtag per CommonMark and GFM specs 2018-04-02 17:18:00 +01:00
390fa0da1b This is probably faster than duplicating the closure 2018-04-01 17:55:32 +01:00
9026b1abdb Add recursive helper for AST, use this for implementation of calling handler
recursively
2018-04-01 17:10:49 +01:00
68736f8800 Merge pull request #593 from aidantwoods/enhancement/process
Decouple manipulating final AST from `text` method
2018-04-01 16:37:44 +01:00
535110c57e Add process method so extensions may process final AST without
copying implementation of `text`
2018-03-31 23:23:12 +01:00
ce073c9baa Merge pull request #576 from aidantwoods/enhancement/moar-ast
Produce AST prior to render
2018-03-31 23:11:45 +01:00
e4d6c8f911 Add support for recursive handlers 2018-03-31 22:01:38 +01:00
cbe2e74d52 Merge pull request #592 from aidantwoods/fix/html-comment
Fix HTML comment endings
2018-03-30 19:28:40 +01:00
aa90dd481a Match CommonMark spec on HTML comments:
Start condition: line begins with the string `<!--`.
End condition: line contains the string `-->`.
2018-03-30 19:22:50 +01:00
20e592359f Add failing test case 2018-03-30 19:22:13 +01:00
9f1f5de387 Add recursive handle methods to generate entire AST for traversal 2018-03-28 20:59:56 +01:00
40b9da7837 Merge pull request #587 from aidantwoods/fix/ol-interrupt
Fix ordered list interrupt
2018-03-28 15:43:44 +01:00
a9c21447ce Only interrupt paragraph if starting with 1 2018-03-28 15:38:11 +01:00
a3e02c1d0e Add failing test case 2018-03-28 15:37:47 +01:00
40e797031e Old handler compatability layer 2018-03-28 03:42:38 +01:00
448b72a149 Merge pull request #586 from aidantwoods/fix/blockquote-adjacent
Fix merging of adjacent blockquotes
2018-03-28 03:31:36 +01:00
92e426e0e8 Fix merging of adjacent blockquotes 2018-03-28 03:27:09 +01:00
07216480db Change test to comply with CommonMark 2018-03-28 03:26:45 +01:00
caea783006 Add failing test case 2018-03-28 03:24:01 +01:00
d849d64611 Merge pull request #584 from aidantwoods/fix/tables
Permit 1 column tables with less delimiters
2018-03-27 23:18:41 +01:00
00e51ee424 Permit 1 column tables with less delimiters 2018-03-27 23:12:51 +01:00
0550c3eaf9 Merge pull request #583 from aidantwoods/fix/atx-headings
Fix trimming of internal #'s in ATX headers
2018-03-27 22:10:39 +01:00
790aed42ab Fix trimming of internal #'s 2018-03-27 22:04:11 +01:00
1c52cb6b5e Add failing test cases 2018-03-27 22:01:32 +01:00
ae13290221 Merge pull request #574 from aidantwoods/fix/remove-legacy-escaping
Remove legacy escaping
2018-03-27 13:18:30 +01:00
e16162e288 Merge pull request #582 from aidantwoods/fix/formatting
Formatting adjustments
2018-03-27 12:12:01 +01:00
244ea0aaa6 Remove some whitespace 2018-03-27 12:11:00 +01:00
2f291e0b2f Merge pull request #439 from aidantwoods/patch-4
Improve CommonMark mixed-marker list compliance
2018-03-27 11:31:34 +01:00
d2a73f9179 Trim whitespace 2018-03-27 11:23:04 +01:00
f594d4c18b Add more tests for CommonMark compliance 2018-03-27 11:20:04 +01:00
21cdd8a0b3 Merge branch 'master' into patch-4 2018-03-27 11:13:06 +01:00
a52d386250 Merge pull request #579 from aidantwoods/enhancement/gitignore
Add .gitignore for repo specific paths
2018-03-26 19:06:10 +01:00
dd9f4036ee Add .gitignore to export ignore in .gitattribtutes 2018-03-26 18:47:33 +01:00
e7fbbf537b Add repo specific paths to .gitignore 2018-03-26 18:45:34 +01:00
cac63f6fcb Merge pull request #578 from aidantwoods/fix/setext-heading-spaces
Fix setext heading space handling
2018-03-25 23:08:31 +01:00
f71bec00f4 Fix space handling in setext headings 2018-03-25 22:50:42 +01:00
913e04782f Add failing test cases to be fixed 2018-03-25 22:50:16 +01:00
1fa6b038af PHP 5.3 compat 2018-03-25 20:00:31 +01:00
e59fbd736d Remove 'markup' key exception for outputting via AST 2018-03-25 20:00:31 +01:00
8c14c5c239 Use rawHtml to provide conditional escaping for markup 2018-03-25 20:00:30 +01:00
0205a4cbe6 Use rawHtml to provide conditional escaping on special chars 2018-03-25 19:59:11 +01:00
011465bca6 Use rawHtml to provide conditional escaping for specialChars 2018-03-25 19:59:11 +01:00
adcba80502 Implement unmarked text via AST 2018-03-25 19:59:11 +01:00
65d7bc5013 Special casing for elements with no name 2018-03-25 19:59:11 +01:00
1a47e74be1 Quotes are permitted in escaped body 2018-03-25 19:59:05 +01:00
56cc41803a Merge pull request #514 from Daniel-KM/fix/consistency_follow
Added tests for consistency when a markdown follows a markup without blank line
2018-03-25 19:53:21 +01:00
d86d839677 Merge branch 'master' into fix/consistency_follow 2018-03-25 19:37:04 +01:00
d5ded2b935 Decouple handler argument from structure keys 2018-03-21 16:02:57 +00:00
098f24d189 Seperate handler delegation from AST
This also splits 'text' into 'text', 'elements', and
'element' to hopefully better communicate structure
2018-03-21 02:32:01 +00:00
eb55e426b9 Initial refactor to use AST 2018-03-21 02:18:34 +00:00
ced6187ca5 Merge pull request #575 from cebe/patch-3
Added inline example to README
2018-03-20 16:33:53 +00:00
972648ff64 Added inline example to README
see https://github.com/erusev/parsedown/issues/562
2018-03-20 16:56:40 +01:00
77dc0a090a Merge pull request #569 from aidantwoods/feature/unsafe-html
Add unsafeHtml option for extensions to use on trusted input
2018-03-18 21:58:48 +00:00
88dc949890 Refactor based on suggestion by @PhrozenByte 2018-03-18 20:17:12 +00:00
624a08b7eb Update commment 2018-03-15 19:55:33 +00:00
3fc54bc966 Allow extension to "vouch" for raw HTML they produce
Rename "unsafeHtml" to "rawHtml"
2018-03-15 19:46:03 +00:00
ef7ed7b66c Still grab the text if safe mode enabled, but output it escaped 2018-03-15 11:09:55 +00:00
e4c5be026d Further attempt to dissuade this feature's use 2018-03-15 11:00:03 +00:00
e6444bb57e Add unsafeHtml option for extensions to use on trusted input 2018-03-15 10:48:38 +00:00
a3265e7c6f Merge pull request #511 from aidantwoods/feature/null-name-element
Allow element to have no name
2018-03-15 09:41:16 +00:00
aac00ac742 Merge pull request #566 from aidantwoods/fix/email-autolink
Email autolink shouldn't be started by HTML tags
2018-03-10 00:06:59 +00:00
6830c3339f Readability
Thanks @PhrozenByte for the suggestion :)
2018-03-09 17:38:41 +00:00
19f1bb9353 Disable backtracking where the regex doesn't need it 2018-03-09 17:06:14 +00:00
721b885dd3 Fix #565 by validating email as defined in commonmark spec 2018-03-09 17:05:42 +00:00
f70d96479a Add test case for email surrounded by tags 2018-03-09 16:48:32 +00:00
92e9c27ba0 Merge pull request #563 from luizbills/master
bump version
2018-03-08 01:11:30 +00:00
9857334186 bump version 2018-03-07 22:04:55 -03:00
ae7e8e5067 bump version 2018-03-07 21:51:35 -03:00
253822057a refactor who uses it section in readme a bit more 2018-03-02 17:46:45 +02:00
a18bf495ed refactor who uses it section in readme 2018-03-02 17:40:21 +02:00
e5bf9560d7 add Laravel to who uses it 2018-03-02 17:37:16 +02:00
33b51eaefa Fix typo 2018-03-02 01:16:27 +00:00
d686a50292 Merge pull request #557 from aidantwoods/documentation/safe-mode
Talk about safe mode in the README
2018-03-01 19:59:44 +00:00
f3068df45a Remove extra line breaks 2018-03-01 19:54:58 +00:00
9b1f54b9d3 Lets be consistent with hyphenation 2018-03-01 18:45:38 +00:00
90439ef882 Rewrite section 2018-03-01 18:44:11 +00:00
72d30d33bc allow element to have no name 2018-03-01 01:17:32 +00:00
97dd037e6f Merge pull request #561 from PhrozenByte/patch-3
Add mbstring dependency to composer.json
2018-02-28 23:47:01 +00:00
fa89f0d743 Add mbstring dependency to composer.json 2018-02-28 20:42:25 +01:00
d638fd8a25 Merge pull request #560 from PhrozenByte/patch-2
Travis: Issue build error when Parsedown::version isn't up-to-date
2018-02-28 19:09:57 +00:00
cc53d5ae29 Travis: Issue build error when Parsedown::version isn't up-to-date 2018-02-28 20:04:45 +01:00
45f40696f6 Merge pull request #559 from PhrozenByte/patch-1
Update "Who uses it"
2018-02-28 18:07:37 +00:00
e8f3d4efc0 Merge pull request #558 from harikt/issue-232
Add test case to make sure issue 232 no longer exists
2018-02-28 18:02:14 +00:00
096e164756 Update README.md
Sort "Who uses it" alphabetically, add Laravel + Pico
2018-02-28 18:59:34 +01:00
e2f3961f80 Add test case to make sure issue 232 no longer exists 2018-02-28 23:25:38 +05:30
e941dcc3f0 Merge pull request #525 from aidantwoods/fix/infostring
Properly support fenced code block infostring
2018-02-28 17:06:25 +00:00
c192001a7e Merge pull request #433 from aidantwoods/patch-3
Fix Issue #358 – preventing double nested links
2018-02-28 17:05:58 +00:00
48a053fe29 Merge pull request #423 from PhrozenByte/bugfix/CommonMarkTest
Fix CommonMark test
2018-02-28 17:05:24 +00:00
5057e505d8 Merge pull request #475 from aidantwoods/loose-lists
Loose lists
2018-02-28 17:05:00 +00:00
ad62bf5a6f Talk about safe mode in the README 2018-02-28 17:03:46 +00:00
6678d59be4 Merge pull request #495 from aidantwoods/anti-xss
Prevent various XSS attacks [rebase and update of #276]
2018-02-28 13:41:37 +02:00
c999a4b61b improve readme 2018-01-29 20:55:30 +02:00
e938ab4ffe improve readme 2018-01-29 20:54:40 +02:00
e69374af0d improve readme 2018-01-29 20:52:27 +02:00
722b776684 Test multiple multiline lists 2018-01-29 14:38:19 +01:00
7fd92a8fbd update tests 2018-01-29 14:38:19 +01:00
0e1043a8d6 consistent li items for loose list 2018-01-29 14:38:19 +01:00
1196ed9512 Merge pull request #548 from m1guelpf-forks/patch-1
Update license year
2018-01-01 18:48:54 +02:00
1244122b84 Update LICENSE.txt 2018-01-01 14:09:31 +01:00
d98d60aaf3 Update license year 2017-12-31 22:10:48 +01:00
296ebf0e60 Merge pull request #429 from pablotheissen/patch-1
Support html tags containing dashes
2017-11-19 11:15:43 +02:00
a60ba300b1 Merge pull request #540 from jbafford/patch-1
Fix typo in README
2017-11-15 10:31:22 +02:00
089789dfff Fix typo in README 2017-11-14 17:13:31 -05:00
03e1a6ac02 Merge branch 'master' into bugfix/CommonMarkTest
Conflicts:
	.travis.yml
	test/CommonMarkTest.php
	test/ParsedownTest.php
	test/bootstrap.php
2017-11-14 22:09:25 +01:00
fbe3fe878f Merge pull request #539 from gabriel-caruso/phpunit
Use PHPUnit\Framework\TestCase instead of PHPUnit_Framework_TestCase
2017-11-14 22:44:03 +02:00
09827f542c Rewrite Travis CI 2017-11-14 15:19:24 -02:00
70ef6f5521 Make Travis CI use installed PHPUnit version, not global one 2017-11-14 13:21:11 -02:00
691e36b1f2 Use PHPUnit\Framework\TestCase instead of PHPUnit_Framework_TestCase 2017-11-11 00:56:03 -02:00
af6affdc2c improve readme 2017-11-06 16:54:00 +02:00
9cf41f27ab improve readme 2017-10-22 16:01:34 +03:00
16aadff2ed improve readme 2017-10-22 16:00:43 +03:00
07c937583d improve readme 2017-10-22 15:57:58 +03:00
4404201175 Properly support fenced code block infostring
Reference: http://spec.commonmark.org/0.28/#info-string
2017-08-20 10:28:46 +01:00
c05ef0c12a Merge branch 'aidantwoods-htmlblocks' into fix/consistency_follow 2017-06-23 00:00:00 +02:00
47e4163a68 Merge branch 'htmlblocks' of https://github.com/aidantwoods/parsedown into aidantwoods-htmlblocks 2017-06-23 00:00:00 +02:00
c05bff047a correct test to match CommonMark specified input for output 2017-06-22 00:03:12 +01:00
6a4afac0d0 remove ability for htmlblock to allow paragraph after if it closes on the same line 2017-06-22 00:02:03 +01:00
129f807e32 Inverted checks of consistency for markdown following markups. 2017-06-22 00:00:00 +02:00
be963a6531 Added tests for consistency when a markdown follows a markup without blank line. 2017-06-19 00:00:00 +02:00
728952b90a Merge pull request #499 from aidantwoods/fix/hhvm
Fix hhvm build failure
2017-05-14 17:47:48 +03:00
c82af01bd6 add sudo false 2017-05-14 14:39:09 +01:00
67c3efbea0 according to https://tools.ietf.org/html/rfc3986#section-3 the colon is a required part of the syntax, other methods of achieving the colon character (as to browser interpretation) should be taken care of by htmlencoding that is done on all attribute content 2017-05-10 16:57:18 +01:00
593ffd45a3 Merge pull request #406 from adrilo/patch-1
Create .gitattributes
2017-05-10 12:28:53 +03:00
bbb7687f31 safeMode will either apply all sanitisation techniques to an element or none (note that encoding HTML entities is done regardless because it speaks to character context, and that the only attributes/elements we should permit are the ones we actually mean to create) 2017-05-09 19:31:36 +01:00
b1e5aebaf6 add single safeMode option that encompasses protection from link destination xss and plain markup based xss into a single on/off switch 2017-05-09 19:22:58 +01:00
c63b690a79 remove duplicates 2017-05-09 14:50:15 +01:00
226f636360 remove $safe flag 2017-05-07 13:45:59 +01:00
2e4afde68d faster check substr at beginning of string 2017-05-06 16:32:51 +01:00
dc30cb441c add more protocols to the whitelist 2017-05-05 21:32:27 +01:00
f76b10aaab update readme 2017-05-04 10:28:55 +03:00
054ba3c487 urlencode urls that are potentially unsafe:
this should break urls that attempt to include a protocol, or port (these are absolute URLs and should have a whitelisted protocol for use)
but URLs that are relative, or relative from the site root should be preserved (though characters non essential for the URL structure may be urlencoded)

this approach has significant advantages over attempting to locate something like `javascript:alert(1)` or `javascript&colon;alert(1)` (which are both valid) because browsers have been known to ignore ridiculous characters when encountered (meaning something like `jav\ta\0\0script&colon;alert(1)` would be xss :( ). Instead of trying to chase down a way to interpret a URL to decide whether there is a protocol, this approach ensures that two essential characters needed to achieve a colon are encoded `:` (obviously) and `;` (from `&colon;`). If these characters appear in a relative URL then they are equivalent to their URL encoded form and so this change will be non breaking for that case.
2017-05-03 17:01:27 +01:00
4bae1c9834 whitelist regex for good attribute (no
no chars that could form a delimiter allowed
2017-05-03 00:39:01 +01:00
aee3963e6b jpeg, not jpg 2017-05-02 19:55:03 +01:00
4dc98b635d whitelist changes:
* add gif and jpg as allowed data images
* ensure that user controlled content fall only in the "data section" of the data URI (and does not intersect content-type definition in any way (best to be safe than sorry ;-)))
  "data section" as defined in: https://tools.ietf.org/html/rfc2397#section-3
2017-05-02 19:48:25 +01:00
e4bb12329e array_keys is probably faster 2017-05-02 01:32:24 +01:00
6d0156d707 dump attributes that contain characters that are impossible for validity, or very unlikely 2017-05-02 00:48:48 +01:00
29ad172261 Merge pull request #496 from aidantwoods/fix/ditch-hhvm-nightly
replace hhvm nightly with nightly
2017-05-01 19:35:36 +03:00
131ba75851 filter onevent attributes 2017-05-01 15:44:04 +01:00
924b26e16c replace hhvm nightly with nightly 2017-05-01 03:57:07 +01:00
af04ac92e2 add xss tests 2017-05-01 03:33:49 +01:00
6bb66db00f anti-xss
protect all attributes and content from xss via element method
filter special attributes (a href, img src)
expand url whitelist slightly to permit data images and mailto links
2017-05-01 03:25:07 +01:00
b3d45c4bb9 Add html escaping to all attributes capable of holding user input. 2017-05-01 02:00:38 +01:00
1d4296f34d Customizable whitelist of schemas for safeLinks 2017-05-01 01:58:34 +01:00
bf5105cb1a Improve safeLinks with whitelist. 2017-05-01 01:58:34 +01:00
1140613fc7 Prevent various XSS attacks 2017-05-01 01:58:34 +01:00
1d0af35f10 update test to result generated by CommonMark reference parser 2017-03-29 18:26:07 +01:00
d7956e3ade blockmarkup ends on interrupt by newline (CommonMark compliance) 2017-03-29 18:25:56 +01:00
4367f89a74 attempt to fix failing builds on 5.3 2017-03-29 19:30:24 +03:00
1bf24f7334 add kbd to text-level elements 2017-03-29 19:04:15 +03:00
0a09d5ad45 update tests to reflect changes in phpunit 6.0 2017-03-23 20:21:18 +02:00
3fc442b078 Merge pull request #484 from hkdobrev/patch-1
Add Symfony demo to "Who uses it?"
2017-03-10 09:41:24 +02:00
bd0e31a7dd Add Symfony demo to "Who uses it?"
409a65b373/composer.json (L24)
2017-03-10 01:04:53 +02:00
dfaf03639a Merge pull request #480 from pjona/patch-1
Removed double semicolon
2017-03-08 23:21:03 +02:00
7081afe8cb Removed double semicolon 2017-03-02 12:43:51 +01:00
4b6493999a Merge pull request #465 from aidantwoods/patch-8
Trim surrounding whitespace from URL in inlineLink
2017-01-23 09:45:19 +02:00
0172d779d7 Trim surrounding whitespace from URL in inlineLink
Fixes https://github.com/erusev/parsedown-extra/issues/103
2017-01-21 11:06:41 +00:00
cc5b38ca39 Merge pull request #459 from gene-sis/fix_inlineLink_regex
fix_inlineLink_regex
2017-01-07 16:51:03 +02:00
48351504de adjust two regex pattern within inlineLink() to reduce backtracking
add test with base64 image
2017-01-07 00:45:38 +01:00
20ff8bbb57 Merge pull request #447 from greut/phpunit-from-extra
Fix include from ParsedownTest
2016-11-02 17:56:58 +02:00
bc21988fe5 Fix include from ParsedownTest
I wasn't able to run all the tests from ParsedownExtra because of it.
2016-11-02 09:27:35 +01:00
e3c3e28554 Merge pull request #446 from jamesevickery/master
Grammar update
2016-10-25 17:39:55 +03:00
f053740132 Merge pull request #1 from erusev/master
Merge pull request #445 from jamesevickery/master
2016-10-25 15:24:11 +01:00
7a92a31739 Grammar update 2016-10-25 15:22:17 +01:00
6eca8796fb Merge pull request #445 from jamesevickery/master
Tiny grammar correction
2016-10-25 17:21:57 +03:00
8876c0984e Tiny grammar correction 2016-10-25 15:10:22 +01:00
67e454e300 Merge pull request #2 from PhrozenByte/aidantwoods/patch-4
Use the list marker width to determine whether a list item is continued
2016-10-14 08:29:11 +01:00
ae0211a84c Travis: Add PHP nightly 2016-10-13 22:17:03 +02:00
a9f696f7bb Improve CommonMark spec example regex
CommonMark spec example [#170](http://spec.commonmark.org/0.26/#example-170) has a empty HTML result.
2016-10-13 22:16:46 +02:00
a3836b1853 Handle subsequent list items which aren't indented sufficiently
Subsequent list items which aren't indented sufficiently are treated as part of the original list, see CommonMark spec example [#256](http://spec.commonmark.org/0.26/#example-256).
2016-10-13 20:44:02 +02:00
a9e1163c85 Fix code formatting 2016-10-13 19:52:38 +02:00
7b1529fff0 Use the list marker width to determine whether a list item is continued
This basically represents [list item parsing](http://spec.commonmark.org/0.26/#list-items), rule 1 of the CommonMark specs.
2016-10-13 19:51:32 +02:00
1d61f90bf9 Support list items starting with indented code 2016-10-13 19:47:06 +02:00
4b3b7df710 Support list items starting with a blank line
According to the CommonMark specs ([list items](http://spec.commonmark.org/0.26/#list-items), rule 3), list items starting with a blank line basically behave like as if the \n doesn't exist. Also see example [#241](http://spec.commonmark.org/0.26/#example-241).
2016-10-13 19:46:29 +02:00
30ff5c6e75 Remove unused $placeholder variable 2016-10-13 19:31:35 +02:00
bdf537e9d5 Fix ordered list start argument
See CommonMark spec examples [#226](http://spec.commonmark.org/0.26/#example-226) to #229
2016-10-13 19:30:50 +02:00
81025cd468 Revert "Break less previously passed CommonMarkWeak tests"
This reverts commit 2db3199510.
2016-10-13 19:25:43 +02:00
e691034861 Revert "Prevent failure with data set 77 in CommonMarkWeak"
This reverts commit 0a43799da4.
2016-10-13 19:25:37 +02:00
eb853da92a Revert "Prevent breaking remaining previously compliant CommonMarkWeak tests"
This reverts commit 6973302ca8.
2016-10-13 19:25:30 +02:00
6973302ca8 Prevent breaking remaining previously compliant CommonMarkWeak tests 2016-10-13 15:55:13 +01:00
0a43799da4 Prevent failure with data set 77 in CommonMarkWeak 2016-10-13 14:29:52 +01:00
2db3199510 Break less previously passed CommonMarkWeak tests 2016-10-12 18:10:44 +01:00
2423644d72 Move test/CommonMarkTest.php to test/CommonMarkTestStrict.php
Add parameter `$id` to CommonMark tests
2016-10-12 02:02:55 +02:00
8965c7864f More appropriate tests for these changes 2016-10-11 20:55:59 +01:00
d26b33c20f Add ) as an ordered list marker
Also added marker check to ordered list case when deciding to continue the current list
2016-10-11 19:18:43 +01:00
d9679141fa Update test to comply with CommonMark 2016-10-11 13:50:47 +01:00
0bd61a73ed Check that the current line is a list before starting a new one 2016-10-11 13:48:38 +01:00
06c4344a71 Contextual limits on indentation stripping 2016-10-11 13:38:47 +01:00
c4d4a6800d (beginning to) improve commonmark compliance:lists
These changes aren't fit for merge, nor do they work correctly (yet)
2016-10-11 12:05:33 +01:00
be671e72a3 Don't let Travis skip Parsedown's phpunit tests 2016-10-09 14:21:17 +02:00
f0587d41a9 Add test/CommonMarkTestWeak.php to .travis.yml
Failing tests don't break builds on purpose, Parsedown doesn't fully comply with the CommonMark specs at the moment. We should switch to test/CommonMarkTest.php later, see #423 for details.
2016-10-09 14:17:03 +02:00
cbc4b3f612 Merge pull request #436 from grogy/php71
Added PHP version 7.1 for tests
2016-10-09 13:04:16 +03:00
0080ef218e Added PHP version 7.1 for tests 2016-10-09 01:58:47 +02:00
3aef89b399 Line handler may prevent specified element nesting
Swap `under_scores` for `camelCasing`
2016-10-08 17:54:04 +01:00
f4e0234af0 Merge pull request #431 from aidantwoods/patch-2
Allow parsedown to specify list start attribute
2016-10-05 22:55:34 +03:00
5c22531e4d Allow parsedown to specify list start attribute
Syntax preferences
2016-10-05 18:27:54 +01:00
3978e33fd0 Allow parsedown to specify list start attribute
Remove github added tabs on blank lines
2016-10-05 18:17:12 +01:00
a37797ef34 Allow parsedown to specify list start attribute
Syntax preferences to match surrounding code
2016-10-05 18:15:47 +01:00
e3cd271f16 Allow parsedown to specify list start attribute
Performance: Swap preg_replace for stristr to obtain list start
2016-10-05 15:44:34 +01:00
f0b7b61c16 Allow parsedown to specify list start attribute
Should fix compatibility for PHP 5.3
2016-10-05 11:36:27 +01:00
ed41fcf3d6 Allow parsedown to specify list start attribute
oops
2016-10-05 10:06:40 +01:00
1fa8fae301 Allow parsedown to specify list start attribute
Readability improvements
2016-10-05 10:03:21 +01:00
543a6c4175 Line handler may prevent specified element nesting
Check if array is empty to shave some performance hits in the case than no non nestables are present.
2016-10-04 18:59:36 +01:00
932bafe0f0 update test for new feature 2016-10-04 17:43:37 +01:00
ac857809ab update test for new feature 2016-10-04 17:41:57 +01:00
846274996a Update ordered_list.html 2016-10-04 17:28:43 +01:00
c145a75848 update test for new feature 2016-10-04 15:44:50 +01:00
a81aedeb10 Line handler may prevent specified element nesting
Removed granularity controls – elements are assumed to be non nestable indefinitely once declared.
2016-10-04 15:27:11 +01:00
50952b3243 Line handler may prevent specified element nesting
This commit serves to add comments detailing parts of the new functionality, and to adjust syntax preferences to match that of the surrounding document. The commit title also now reflects the most significant change made.
2016-10-02 18:26:13 +01:00
4d3600f273 Extend disallowed assertion depth capabilities
I've built on the functionality of feature 1. in the previous commit to allow non nestables to be asserted indefinitely, or to a specified depth.
2016-10-02 17:37:08 +01:00
d6d5f53ff4 Fix Issue #358 – preventing double nested links
1. Add the ability for a parsed element to enforce that the line handler not parse any (immediate) child elements of a specified type.
2. Use 1. to allow parsed Url elements to tell the line handler not to parse any child Links or Urls where they are immediate children.
2016-10-01 15:56:14 +01:00
f17aa0438a Update Parsedown.php 2016-09-27 02:15:35 +01:00
38f4027d5e Update Parsedown.php
Okay, so maybe I should have looked 20 lines or so above where I made the edit in the element function – looks like it already supports adding attributes ;p
Have amended the change to blocklist to use the already existing functionality, and have reverted the change that I made to the element function.
2016-09-27 02:15:09 +01:00
2cee8d8a2d Update Parsedown.php
Looks like I might need to return the pattern which was used previously
Reverting last change as build still failed

This build will still fail, but I'm hoping it will only fair where the list start value has been inserted
2016-09-27 01:23:22 +01:00
cceefafd55 test
Attempting to determine which function change is causing test jobs to fail (in unexpected ways)
2016-09-27 01:16:00 +01:00
1c58e9d8d5 oops
oops
2016-09-27 00:57:57 +01:00
2772b034c6 Update Parsedown.php
(I think this should work)
Allow parsedown to specify list start attribute (see: https://github.com/erusev/parsedown/issues/100#issuecomment-249729602)
2016-09-27 00:53:51 +01:00
1a44cbd62c Update Parsedown.php
Made parsedown compatible with html-tags containing dashes.
see https://github.com/erusev/parsedown/issues/407#issuecomment-248833563
2016-09-22 12:21:39 +02:00
73dbe2fd17 Remove PHPUnit bootstrap in favour of composer 2016-09-05 22:04:46 +02:00
33a23fbfb2 Refactor PHPUnit bootstrap
This allows Parsedown extensions (like Parsedown Extra) to reuse existing Parsedown tests. See erusev/parsedown-extra#96 for details.
2016-09-05 21:10:23 +02:00
a2ed1592bd Merge pull request #424 from hkdobrev/patch-1
Update URL to dependants
2016-09-05 16:55:29 +03:00
3d7a473aa9 Update URL to dependants
As Packagist has now implemented the feature of listing packages
depending on another package, VersionEye is no longer needed for that.

As VersionEye scrapes the Packagist API to do the same, the original
source of information should be preferred.
2016-09-05 16:38:38 +03:00
228d5f4754 Improve test/CommonMarkTestWeak.php 2016-09-05 15:31:07 +02:00
2cacfb8da4 Improve test/CommonMarkTestWeak.php 2016-09-05 15:17:52 +02:00
d33e736fa3 Add test/CommonMarkTestWeak.php 2016-09-05 14:38:47 +02:00
3a46a31e09 Fix test/CommonMarkTest.php example regex 2016-09-05 14:37:34 +02:00
e1bcc1c472 Fix test/CommonMarkTest.php 2016-09-05 04:51:28 +02:00
f671ae7364 improve readme 2016-07-27 11:05:24 +03:00
b5951e08c6 Create .gitattributes
When using this library, all the files related to tests can be ignored. Tests are only useful when working on the library itself.
2016-06-24 14:18:01 +02:00
490a8f35a4 remove incompatible comment 2016-03-09 19:02:39 +02:00
94688f21cc improve readme 2016-01-07 19:36:51 +02:00
693f2c4842 Merge pull request #377 from PhrozenByte/patch-1
Update composer.json requirements
2016-01-07 19:14:25 +02:00
9545a295cf README.md: Add PHP 5.3+ requirement 2016-01-07 16:48:43 +01:00
3d649081e5 Update composer.json requirements
Fixes #374
2016-01-06 19:44:53 +01:00
32de2cedcc Merge pull request #373 from getgrav/master
Simple changes to make Parsedown more pluggable
2015-12-19 16:39:29 +02:00
e7443a2bd8 Fixed really sorry spelling errors 2015-12-18 20:45:14 -07:00
10a7ff776c Left as-is 2015-12-17 10:48:21 -07:00
5ad15b87fa Break out method_exists checks into extendable methods to allow for better pluggability 2015-12-17 10:46:44 -07:00
b166cab9a2 Make lines protected to allow for extendability 2015-12-17 10:46:04 -07:00
0f974bf34f improve readme 2015-11-26 15:08:28 +02:00
3d7cdeec5f remove duplicate item in: who uses it 2015-11-14 09:54:17 +02:00
97953b193e add Grav CMS to: who uses it 2015-11-14 09:52:07 +02:00
c046a6b646 Merge pull request #361 from grogy/php7-readme
remove PHP 7.0 from allow failures in tests + improve readme
2015-10-31 20:08:48 +02:00
f1fefc257c improve readme 2015-10-31 16:13:42 +02:00
6f23ec8203 improve readme 2015-10-31 15:52:07 +02:00
23d4544986 improve readme 2015-10-31 15:51:14 +02:00
5a4ff5d189 improve readme 2015-10-31 15:49:56 +02:00
50ac4a06e8 remove PHP 7.0 from allow failures in tests + improve readme 2015-10-31 01:55:49 +01:00
003af26499 improve readme 2015-10-31 00:45:21 +02:00
aa63058a88 improve readme 2015-10-31 00:38:24 +02:00
15d56cdd27 improve readme 2015-10-31 00:37:38 +02:00
93d77b0b47 improve readme 2015-10-31 00:35:04 +02:00
c8072a1987 add link to caret.io in readme 2015-10-31 00:33:11 +02:00
b008290917 Merge pull request #359 from tbreuss/master
Add Herbie CMS to "Who uses it?"
2015-10-25 16:42:45 +02:00
9928c933d8 Add Herbie CMS to "Who uses it?" 2015-10-25 13:33:13 +01:00
ddb3bd2107 Merge pull request #357 from donatj/master
Parsedown library shouldn't be executable
2015-10-21 01:43:13 +03:00
e603c2378d Parsedown library shouldn't be executable 2015-10-20 15:16:36 -05:00
3ebbd730b5 1.6.0 2015-10-04 19:44:32 +03:00
1f02626ed6 add link to caret.io 2015-10-01 18:47:31 +03:00
fa005fdb95 Merge pull request #336 from hkdobrev/late-static-binding
Use late static binding for Parsedown::instance()
2015-08-13 15:16:23 +03:00
5f40cab3e7 Use late static binding for Parsedown::instance()
Fixes erusev/parsedown-extra#67.

This introduces PHP 5.3+ late static binding to the Singleton pattern in Parsedown.
It will return an instance of Parsedown which inherits the class which
called the `instance()` method rather than always returning instance of just `Parsedown`.

Tests are testing this feature with a test class which inherits from Parsedown.
Notice that calling `instance()` with the default arguments after an instance of
`Parsedown` was already created, it will return it even though it is from just
an instance of `Parsedown`. So this is fixing the problem just partially.
2015-08-13 13:29:33 +03:00
0e89e3714b 1.5.4 2015-08-03 12:24:05 +03:00
6b24125f06 clean up 2015-07-31 17:01:14 +03:00
a589bcac79 resolve #342 2015-07-31 01:33:21 +03:00
a9dfc97ddc opening code fence doesn't need 2 regex groups 2015-07-16 16:57:13 +03:00
28774a4359 improve readme 2015-07-15 11:59:59 +03:00
b8b5711ee5 improve readme 2015-07-15 11:59:40 +03:00
9579e5f5e5 improve readme 2015-07-15 11:57:45 +03:00
7f7f6418a3 improve readme 2015-07-15 09:21:38 +03:00
ee81967749 improve readme 2015-07-03 17:11:23 +03:00
96e0810188 improve readme 2015-07-03 17:11:08 +03:00
99bd1bd678 improve readme 2015-07-03 17:06:52 +03:00
e7a6a06166 improve readme 2015-07-03 16:46:25 +03:00
eca5bb8262 improve readme 2015-07-03 16:45:22 +03:00
1312908056 improve readme 2015-07-03 16:42:47 +03:00
76b7d7babd improve readme 2015-07-03 16:39:51 +03:00
ba802c1c8d replace the term "incomplete" 2015-07-02 01:01:14 +03:00
438874e9a8 improve line 2015-06-25 01:05:05 +03:00
8e26f45dee improve readme 2015-06-15 17:38:15 +03:00
e2bb3eaaf8 clean up 2015-06-15 12:28:35 +03:00
0de61e7b3a improve readme 2015-06-15 12:09:57 +03:00
5b72dceb26 improve readme 2015-06-15 00:10:09 +03:00
95699c9ba6 improve readme 2015-06-14 22:55:21 +03:00
790066e9a7 improve readme 2015-05-26 13:37:45 +03:00
b9e5228e92 version 1.5.3 2015-04-29 23:22:24 +03:00
31c8856f53 Merge pull request #312 from garoevans/patch-1
Fix check against $matches
2015-04-24 08:24:06 +03:00
d5823ad622 Merge pull request #295 from hkdobrev/nightly
Test on nightly releases of PHP (7.0) and HHVM
2015-04-24 01:44:07 +03:00
6736ba9a04 Fix check against $matches
Fixes inline reference links with int 0 as reference

The link [link][0] where [0] is set at the bottom of the md file current breaks and it's truthy value is false.
2015-04-20 16:24:11 +01:00
468d1e3da8 improve readme 2015-03-18 20:44:57 +02:00
7aa1d97bba improve readme 2015-03-18 20:43:30 +02:00
f768f9c63f improve readme 2015-03-18 20:42:44 +02:00
aa83968534 improve readme 2015-03-18 20:41:23 +02:00
85eadccc05 Merge pull request #297 from hkdobrev/patch-1
Remove "tested in PHP 5.2"
2015-03-18 20:39:40 +02:00
c94fa12d67 Remove "tested on PHP 5.2"
It is no longer tested on PHP 5.2 in Travis CI.

See https://github.com/erusev/parsedown/pull/286
2015-03-18 17:15:00 +02:00
11e02d45fa improve readme 2015-03-18 16:20:28 +02:00
ecd53f9add improve readme 2015-03-18 16:16:51 +02:00
844b2f49ea Merge pull request #249 from HelpingHand1/patch-1
Updated readme to display travis-ci.org build test
2015-03-18 16:08:13 +02:00
b2ad712644 Test on nightly releases of PHP (7.0) and HHVM
See https://github.com/erusev/parsedown/issues/294

See 12bf1c6d05 (commitcomment-10090016)

Nightly releases are allowed to fail since they are not stable and
could fail in unpredictable ways.

New versions of PHP could be added as they are released.
I think they should not be in the allowed to fail part of the matrix then.
2015-03-09 10:14:57 +02:00
65116c3cb0 Merge pull request #286 from henriquemoody/travis
Remove PHP version 5.2 from Travis builds
2015-02-09 01:04:08 +02:00
147003107a Remove PHP version 5.2 from Travis builds 2015-02-08 21:00:50 -02:00
618b26056c Merge pull request #284 from jstanden/master
Fixes #283
2015-02-04 00:39:05 +02:00
b828fe7c8d Fixes #283 2015-02-03 13:58:47 -08:00
6c9df528aa Merge pull request #280 from kelunik/master
Fixes PHP 7 compatibility
2015-02-02 02:33:38 +02:00
cb8cc57742 Fixes #279 2015-02-02 00:58:24 +01:00
9da19c1108 version 1.5.1 2015-01-24 15:01:47 +02:00
ffd9d3b407 improve tests 2015-01-24 14:37:40 +02:00
e94ecf4adc resolve #277 2015-01-24 14:21:55 +02:00
4d3079b908 resolve #274 2015-01-24 14:03:05 +02:00
70e7a17380 update readme 2015-01-24 04:54:01 +02:00
9518c8e384 improve readme 2015-01-24 04:51:13 +02:00
c581284231 improve readme 2015-01-24 02:33:41 +02:00
cb1940255a improve readme 2015-01-24 01:31:49 +02:00
93d0ec9397 improve readme 2015-01-24 01:27:48 +02:00
9c6e7e880a improve readme 2015-01-24 01:26:59 +02:00
2d62e29625 improve readme 2015-01-24 01:21:16 +02:00
595f33871e improve readme 2015-01-24 01:18:49 +02:00
97e1e0efaa improve readme 2015-01-24 01:15:08 +02:00
648419467a clean up 2015-01-21 01:32:20 +02:00
6ddb6b2b33 resolve #90 2015-01-19 17:11:13 +02:00
0008e69a83 clean up 2015-01-19 17:09:51 +02:00
c664785485 inline methods should be able to handle unmarked inline elements 2015-01-19 17:05:10 +02:00
bdf0ef024e setter variables should not be private 2015-01-18 19:38:57 +02:00
21a3e8790a no need for a separate method for every special character 2015-01-16 03:57:47 +02:00
e5e8d02934 improve order of methods 2015-01-16 03:18:07 +02:00
7ff0f97811 improve performance 2015-01-16 02:59:51 +02:00
596350d1f5 improve names of elements 2015-01-16 02:49:55 +02:00
2cbd3010e4 url elements should not be restricted to http 2015-01-16 02:31:58 +02:00
3b4aa6bff7 change the parsing order of tag elements to improve performance 2015-01-16 01:46:43 +02:00
05a8f16e95 improve CommonMark compliance 2015-01-16 01:44:35 +02:00
79d924040a improve CommonMark compliance 2015-01-16 01:24:02 +02:00
b4a8eb3315 resolve #156 2015-01-16 00:04:18 +02:00
4383cce85b resolve #143 2015-01-15 22:31:31 +02:00
ada39109e4 resolve #189 2015-01-15 22:04:02 +02:00
a06cdfb814 improve fix for #184 2015-01-15 21:32:18 +02:00
6bee326c92 resolve #184 2015-01-15 21:10:09 +02:00
3fe867d294 update readme 2015-01-15 18:28:11 +02:00
f08d017bcb resolve #196 2015-01-15 02:45:45 +02:00
e61a6114b0 resolve #175 2015-01-15 02:37:20 +02:00
9ed72ccd09 resolve #126 2015-01-15 02:24:39 +02:00
09e1184d9f resolve #265 2015-01-15 00:56:12 +02:00
2de60a9a8b improve readme 2015-01-13 15:28:18 +02:00
73a75299f5 improve readme 2015-01-13 15:18:35 +02:00
0d28808392 void markup blocks be marked 2015-01-12 23:24:13 +02:00
78960cf792 improve formatting 2015-01-12 18:53:24 +02:00
8f2e9c7cf6 definitions are blocks
in the old implementation it wasn’t possible to have multiline
definitions
2015-01-12 18:52:17 +02:00
3eb6d349f0 "src" and "alt" attributes should come first 2015-01-12 02:58:08 +02:00
859b1b10c1 update tests 2015-01-12 02:57:20 +02:00
08b01a1a29 blocks should be able to return markup 2015-01-12 02:55:00 +02:00
1686b2fbff we no longer call inline elements spans 2015-01-12 02:55:00 +02:00
15a32fcd0e no need to know the structure of markup blocks 2015-01-12 02:55:00 +02:00
4aca208f96 update readme 2015-01-11 16:23:43 +02:00
cedf96a64e update readme 2015-01-11 16:04:19 +02:00
9f58363e4b Merge pull request #260 from rhukster/master
Fix for Parsedown stripping classes on images supported by ParsedownExtra
2015-01-11 14:50:08 +02:00
6b4a459f97 Merge pull request #261 from naNuke/master
breaksEnabled fix
2015-01-11 14:08:17 +02:00
05bf198d26 breaksEnabled fix 2015-01-11 06:12:01 +01:00
30234a58fa No longer needed in this solution 2015-01-10 19:44:30 -07:00
03ff22c7df Attempted fix for stripped classes on images with ParsedownExtra - re: https://github.com/erusev/parsedown-extra/issues/32 2015-01-10 19:40:39 -07:00
098f188552 update readme 2015-01-10 14:53:08 +02:00
e68a458105 improve consistency 2015-01-10 14:22:54 +02:00
86a27b48bc update readme 2015-01-10 03:43:48 +02:00
c45dee6850 update readme 2015-01-10 03:41:29 +02:00
06135cd75a improve CommonMark compliance 2015-01-10 02:45:51 +02:00
7d3af6bf83 update commonmark test 2015-01-09 00:08:14 +02:00
dfacf7a71a add urlsLinked setter 2015-01-08 16:13:55 +02:00
fd0d8125e7 introduce more structure to parsing of unmarked inlines 2015-01-08 15:19:43 +02:00
b1be886d65 improve names of protected members 2015-01-05 15:05:18 +02:00
19bc6a7083 update variable names to match updated member names 2015-01-05 14:22:06 +02:00
b5efe98e2f improve names of protected members 2015-01-05 14:22:06 +02:00
5639ef7d69 fix PHPDoc 2015-01-05 14:22:06 +02:00
d42fcdc423 improve readme 2015-01-05 14:18:36 +02:00
d29d879ec6 separate parsing of inlines that don't have markers to improve simplicity 2015-01-04 18:37:24 +02:00
c9b4de3c9d resolve #253 2014-12-21 13:51:16 +02:00
38cc1ca7e0 resolve #251 2014-12-16 13:58:33 +02:00
23c4097fde restore support for PHP 5.2 2014-12-15 13:59:37 +02:00
05e87566a9 Merge branch 'master' of https://github.com/erusev/parsedown 2014-12-15 01:08:15 +02:00
ac68800717 improve extensibility 2014-12-15 01:07:29 +02:00
1aade35c5e update test 2014-12-15 00:56:22 +02:00
361febf7c6 improve CommonMark compliance 2014-12-15 00:52:03 +02:00
4b7d7cdef2 updated readme.md per comment by cebe 2014-12-13 13:01:40 -05:00
715f7572ad improve readme 2014-12-12 02:30:45 +02:00
907bd11613 improve readme 2014-12-11 15:30:40 +02:00
56c6169822 improve readme 2014-12-11 14:34:58 +02:00
97e667ab30 Updated readme to display travis-ci.org build test 2014-12-10 18:13:48 -05:00
6d54fda73a improve readme 2014-12-10 20:37:33 +02:00
3b5e4e23ec improve readme 2014-12-10 20:36:15 +02:00
85ee06898b resolve #182 2014-12-10 17:19:05 +02:00
4c24e68b42 Merge remote-tracking branch 'origin/commonmark'
Conflicts:
	Parsedown.php
	phpunit.xml.dist
	test/ParsedownTest.php
2014-12-06 02:50:54 +02:00
094cb88dac update test 2014-12-02 23:53:19 +02:00
7ab3c60a77 improve CommonMark compliance 2014-12-02 22:23:43 +02:00
2438c1a43d improve output readability 2014-11-29 23:53:38 +02:00
46196c1ac3 markup formatting shouldn't impact results 2014-11-29 22:58:42 +02:00
aa3d4d6eb7 simplify 2014-11-29 21:39:42 +02:00
6fb534bc34 improve consistency 2014-11-29 21:34:46 +02:00
28a202ee9e simplify 2014-11-29 20:18:23 +02:00
e46be110fb Merge branch 'master' into commonmark 2014-11-29 16:42:04 +02:00
495e7ac73b resolve #247 2014-11-29 04:29:14 +02:00
5bc6d90f8b resolve #248 2014-11-28 14:03:12 +02:00
9816507a75 markup should preserve empty lines 2014-11-19 20:18:56 +02:00
7000cbc2d2 improve readme 2014-11-12 22:27:29 +02:00
6df242bc97 improve readme 2014-11-12 03:37:36 +02:00
f4453fd729 improve readme 2014-11-12 03:36:17 +02:00
d8011c00ab improve readme 2014-11-09 13:40:39 +02:00
da5d75e97e resolve #209 2014-10-29 22:29:46 +02:00
2adb87ef41 Merge pull request #236 from naNuke/escapeComment
Ignore html comments as well with markupEscape option.
2014-10-10 21:11:23 +03:00
74926c9831 Add test of escaped html comment. 2014-10-10 20:07:41 +02:00
68f3aea036 Ignore html comments as well with markupEscape option. 2014-10-10 19:07:25 +02:00
f91e4dece3 improve consistency 2014-09-26 13:06:40 +03:00
c62365adc4 improve extensibility of test case 2014-09-26 02:06:16 +03:00
bb7a3f41e3 improve readme 2014-09-22 12:01:39 +03:00
f64c1387f8 fix indents 2014-09-22 02:52:45 +03:00
59c77e706b improve consistency 2014-09-22 02:36:42 +03:00
e0965ce09b Merge pull request #224 from hkdobrev/no-markup-option
Add `noMarkup` option to escape user HTML
2014-09-21 23:19:23 +03:00
0a3fde3774 Add noMarkup option to escape user HTML
Resolves #106.

This change introduces a new option - `noMarkup`. You could set it the
`setNoMarkup()` method similar to the `setBreaksEnabled()` one.

Example usage:

``` php
<?php

$parsedown = new Parsedown();
$parsedown->setNoMarkup(true);
$parsedown->text('<div><strong>*Some text*</strong></div>');

// Outputs:
// <p>&lt;div>&lt;strong><em>Some text</em>&lts;/strong>&lt;/div></p>
```
2014-09-20 14:53:19 +03:00
93f7b26427 imp 2014-09-14 01:14:40 +03:00
d53c7dbcd9 Merge pull request #221 from hkdobrev/commonmark-renaming
Rename everything to CommonMark
2014-09-14 00:29:04 +03:00
42222e6b01 Rename everything to CommonMark 2014-09-14 00:11:18 +03:00
e1cb3b7b23 improve readme 2014-09-13 00:11:56 +03:00
5bf56ea041 improve readme 2014-09-12 23:52:06 +03:00
9e98ed04de improve readme 2014-09-11 15:47:59 +03:00
1c89e6f771 improve readme 2014-09-09 14:30:17 +03:00
e7d160049e Merge pull request #218 from hkdobrev/common-mark
Rename Standard Markdown to CommonMark
2014-09-06 01:17:15 +03:00
ce4a29aec5 Rename Standard Markdown to CommonMark
http://blog.codinghorror.com/standard-markdown-is-now-common-markdown/

2d37920c39
2014-09-06 01:12:35 +03:00
8ecf828777 Merge pull request #217 from hkdobrev/standard-markdown
Standard markdown
2014-09-05 23:38:01 +03:00
c18ff7f370 Add Docblock and attribution to JS test runner 2014-09-05 23:28:07 +03:00
6f1fac9823 Add Standard Markdown testsuite.
You could run the Parsedown testsuite only with:
    phpunit --testsuite ParsedownTests

And you could run the Standard Markdown one with:
    phpunit --testsuite StandardMarkdown

See more at http://standardmarkdown.com/
2014-09-05 23:12:33 +03:00
0220a93010 Merge pull request #208 from apfelbox/max-h6
Limit generated headlines to h6
2014-08-26 09:31:52 +03:00
512cc1f065 Limit generated headlines to h6 2014-08-25 21:06:03 +02:00
9437766539 Merge pull request #200 from hkdobrev/html-attributes-slashes
Allow slashes in HTML attributes
2014-08-14 01:27:48 +03:00
1127681d56 Allow slashes in HTML attributes 2014-08-13 23:54:52 +03:00
e33ac1c56e improve readme 2014-06-18 12:27:25 +03:00
d24439ada0 improve test suite 2014-05-21 23:20:46 +03:00
1ae100beab improve comment 2014-05-17 17:37:17 +03:00
82a5a78a36 improve readme 2014-05-17 17:13:00 +03:00
4ede4340ab improve readme 2014-05-16 03:34:43 +03:00
170a6bf770 improve readme 2014-05-16 01:27:54 +03:00
21db821324 improve readme 2014-05-16 01:15:21 +03:00
b384839d15 update readme 2014-05-14 20:07:52 +03:00
2da10d277b resolve #105 2014-05-14 13:14:49 +03:00
532b5ede35 resolve #129 2014-05-14 01:11:05 +03:00
2bd2f81f4f methods should not have more than one optional parameters 2014-05-12 16:18:00 +03:00
e318e66de5 improve consistency 2014-05-12 00:41:00 +03:00
0820d0a607 paragraph doesn't have to use a type 2014-05-12 00:34:47 +03:00
b8d1cfe91a improve extensibility 2014-05-11 22:31:02 +03:00
d85a233611 Merge pull request #171 from scarwu/master
identifyEscapeSequence() needs Array check
2014-05-11 20:57:05 +03:00
973d4a866d add array check 2014-05-11 23:36:01 +08:00
d19c2b6942 improve names 2014-05-10 16:28:00 +03:00
4dde57451d fix consecutive reference links 2014-05-06 17:05:49 +03:00
44686c4f1e improve extensibility 2014-05-06 01:12:27 +03:00
db02ecf259 "reference" is a definition 2014-05-05 14:43:31 +03:00
aa004d4595 improve code organisation 2014-05-05 14:39:40 +03:00
1bb65457ed remove unnecessary comments 2014-05-05 13:46:26 +03:00
0c9a4af8ab improve naming consistency 2014-05-03 18:02:06 +03:00
cc94c1b584 resolve #167 2014-05-02 18:21:10 +03:00
e8d8801db4 resolve #135 2014-05-01 02:44:35 +03:00
521803cdcd resolve #136 2014-05-01 02:42:01 +03:00
0eb480324c resolve #145 2014-05-01 02:02:14 +03:00
7c78aff578 resolve #163 2014-05-01 01:47:14 +03:00
2a5f99547c resolve #162 2014-05-01 01:05:31 +03:00
e373391e7d resolve #164 2014-05-01 00:29:21 +03:00
9fa415bcc5 resolve #160 2014-04-28 21:54:38 +03:00
37416b5f07 simplify folder name 2014-04-28 21:53:34 +03:00
83d3e3dbbf improve readability 2014-04-28 02:27:05 +03:00
307a987cb6 improve naming consistency 2014-04-28 02:14:46 +03:00
eab3cbf255 remove unnecessary nesting 2014-04-28 02:10:18 +03:00
cf7f32f891 definitions are not blocks 2014-04-27 01:54:52 +03:00
4150e00dc4 remove composer dependency 2014-04-26 01:09:28 +03:00
22affa124b travis should be able to run tests in 5.2 2014-04-26 01:06:15 +03:00
5e95242318 improve code consistency 2014-04-26 01:06:14 +03:00
504991a04e Merge pull request #158 from hkdobrev/travis-composer
Run composer install in Travis CI before tests
2014-04-25 00:06:06 +03:00
3d84201d74 Run composer install in Travis CI before tests
Tests are using the Composer autoloader since: cd1c030362

Because of that Composer should have actually dumped the autoloader in the `vendor/` folder,
before the tests are ran.
2014-04-25 00:01:20 +03:00
4f027386b1 "complete" calls should be more consistent 2014-04-24 23:52:42 +03:00
cd1c030362 tests should use autoloader 2014-04-24 22:44:30 +03:00
6081954185 resolve #154 2014-04-18 00:19:22 +03:00
d841003c65 fenced code blocks should respect indnetation 2014-04-17 23:09:10 +03:00
f310bbe13f nested calls to lines should not reset reference definitions 2014-04-17 15:07:09 +03:00
2595f366d9 texts should not share reference definitions 2014-04-17 14:43:45 +03:00
e5dc563804 replace tabs with spaces 2014-04-17 13:34:17 +03:00
e0901ee9c7 remove CONTRIBUTING.md 2014-04-17 11:47:53 +03:00
5316a2e0dd improve readme 2014-04-17 11:22:49 +03:00
5be4491943 make parser class more extensible 2014-04-17 10:59:35 +03:00
4e670129c8 simplify test class 2014-04-17 10:46:07 +03:00
159c3cede6 move deprecated methods to the bottom of the class 2014-04-17 01:11:30 +03:00
c10bde0174 common rules should be in a global .gitignore 2014-03-24 23:08:52 +02:00
24d872383c resolve #140 2014-03-19 00:58:26 +02:00
7ef45894a7 Merge pull request #128 from wkpark/fixup_table
resolve #125 using strpos()
2014-02-28 14:05:10 +02:00
9bf64d2e31 resolve #125 using strpos() 2014-02-27 23:58:24 +09:00
886c620440 Merge pull request #122 from wkpark/marker_index
use $closestMarkerIndex
2014-02-27 14:14:14 +02:00
e156c418d6 fixup regression due to commit 59907ff7 "simplify em/strong routine"
use $closestMarkerIndex correctly
2014-02-26 14:14:56 +09:00
1734f6fc85 Merge pull request #124 from hkdobrev/psr-2-bc
Add set_breaks_enabled() as an alias for BC
2014-02-25 00:48:28 +02:00
d8650cd77c Add set_breaks_enabled() as an alias for BC
Backwards-compatibility is kept with versions before PSR-2 naming.

See http://git.io/SsTarw
2014-02-25 00:43:09 +02:00
3fa9d62572 psr-2 names 2014-02-24 01:38:58 +02:00
4f851205a7 simplify content types 2014-02-24 00:55:34 +02:00
0985c2ef29 fix [0] reference labels 2014-02-23 23:43:18 +02:00
9fd9262f16 implement tables 2014-02-23 18:55:34 +02:00
a6756fd4fa resolve #117 2014-02-22 12:35:54 +02:00
1243fcf3e0 simplify example 2014-02-21 02:49:59 +02:00
1e8d917f7a replace synopsis with a more appropriate word 2014-02-21 02:26:23 +02:00
324eaf7c15 move synopsis to the top 2014-02-21 02:23:17 +02:00
f972f7f15d arrange methods 2014-02-21 02:22:31 +02:00
688b761d32 remove obsolete variables 2014-02-21 02:02:36 +02:00
b8bd12f565 parser should be less dependent on compiler 2014-02-21 01:54:23 +02:00
7a20a9fb60 Merge pull request #114 from wkpark/fixup_reference_label
fixup internal reference labling to make code more readable
2014-02-20 13:41:18 +02:00
6fed312d3c fixup internal reference labling to make code more readable 2014-02-19 13:30:46 +09:00
d0784d1006 Merge pull request #110 from wkpark/hr_heading
support HTML hr and headings
2014-02-17 21:29:57 +02:00
446fead459 simple html cases 2014-02-17 23:33:56 +09:00
ccbdfabaff support HR and headings as block markups 2014-02-17 23:31:08 +09:00
bc30ad8e30 Merge pull request #98 from hkdobrev/php-5.6
Run the testsuite on PHP 5.6
2014-02-12 21:45:52 +02:00
d9f325903a Run the testsuite on PHP 5.6 2014-02-12 19:13:14 +02:00
d29ff18299 resolve #92 2014-02-06 14:16:14 +02:00
95e9878fb0 improve tests 2014-02-06 02:37:09 +02:00
611aed179d simplify reference 2014-02-06 02:36:22 +02:00
abb88d59fa fix reference 2014-02-06 02:36:11 +02:00
1659 changed files with 12997 additions and 1429 deletions

6
.gitattributes vendored Normal file
View File

@ -0,0 +1,6 @@
# Ignore all tests for archive
/test export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/phpunit.xml.dist export-ignore

98
.github/workflows/ci.yml vendored Normal file
View File

@ -0,0 +1,98 @@
name: Parsedown
on: [push, pull_request]
jobs:
units:
name: Unit Tests
strategy:
matrix:
os: [ubuntu-latest]
php: [8.1, 8.0, 7.4, 7.3, 7.2, 7.1]
runs-on: ${{ matrix.os }}
steps:
- name: Set up PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
tools: composer:v2
- uses: actions/checkout@v2
- name: Run Tests
run: |
composer remove infection/infection --no-update --dev
composer remove roave/infection-static-analysis-plugin --no-update --dev
composer update --prefer-dist --no-interaction --no-progress
composer test-units
mutations:
name: Mutation Tests
strategy:
matrix:
os: [ubuntu-latest]
php: [8.1]
runs-on: ${{ matrix.os }}
steps:
- name: Set up PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
tools: composer:v2
- uses: actions/checkout@v2
- name: Run Tests
run: |
composer update --prefer-dist --no-interaction --no-progress
vendor/bin/roave-infection-static-analysis-plugin --show-mutations --threads=4 --min-msi=80 --min-covered-msi=80
static-analysis:
name: Code Format and Static Analysis
strategy:
matrix:
os: [ubuntu-latest]
php: [8.1]
runs-on: ${{ matrix.os }}
steps:
- name: Set up PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
tools: composer:v2
- uses: actions/checkout@v2
- name: Run Tests
run: |
composer install --prefer-dist --no-interaction --no-progress
composer test-static -- --shepherd
composer test-formatting
composer test-dead-code
commonmark:
name: CommonMark
continue-on-error: true
strategy:
matrix:
os: [ubuntu-latest]
php: [8.1]
runs-on: ${{ matrix.os }}
steps:
- name: Set up PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
tools: composer:v2
- uses: actions/checkout@v2
- name: Install
run: composer install --prefer-dist --no-interaction --no-progress
- name: CommonMark Strict
continue-on-error: true
run: composer test-commonmark
- name: CommonMark Weak
continue-on-error: true
run: composer test-commonmark-weak

9
.gitignore vendored
View File

@ -1,3 +1,6 @@
.DS_Store
.idea
nbproject
composer.lock
vendor/
infection.log
tests/spec_cache.txt
.phpunit.result.cache
composer.lock

37
.php-cs-fixer.dist.php Normal file
View File

@ -0,0 +1,37 @@
<?php
use PhpCsFixer\Config;
use PhpCsFixer\Finder;
$finder = Finder::create()
->in(__DIR__ . '/src/')
->in(__DIR__ . '/tests/')
;
$rules = [
'@PSR2' => true,
'array_syntax' => [
'syntax' => 'short',
],
'braces' => [
'allow_single_line_closure' => true,
],
'logical_operators' => true,
'native_constant_invocation' => [
'fix_built_in' => true,
],
'native_function_invocation' => [
'include' => ['@all'],
],
'no_unused_imports' => true,
'ordered_imports' => [
'sort_algorithm' => 'alpha',
],
'single_blank_line_before_namespace' => true,
'strict_comparison' => true,
'strict_param' => true,
'whitespace_after_comma_in_array' => true,
];
return (new Config)
->setRules($rules)
->setFinder($finder)
->setUsingCache(false)
->setRiskyAllowed(true)
;

View File

@ -1,8 +0,0 @@
language: php
php:
- 5.5
- 5.4
- 5.3
- 5.2
- hhvm

View File

@ -1,20 +0,0 @@
Pull Requests
-------------
Do create pull requests that:
* resolve an issue
* improve an existing feature or text
Do not create pull requests that:
* introduce a feature or text
* change the interface
* change the coding style
If a pull request contains unrelated changes, they should be submitted as separate pull requests.
License
-------
By contributing to the project, you grant the creator of the project a perpetual, worldwide, irrevocable license to use, reproduce and distribute your contributions and derivative works. You also warrant that you are the sole owner of your contributions and that they are your original works of authorship.

View File

@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2013 Emanuil Rusev, erusev.com
Copyright (c) 2013-2018 Emanuil Rusev, erusev.com
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
@ -17,4 +17,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

File diff suppressed because it is too large Load Diff

104
README.md
View File

@ -1,31 +1,99 @@
## Parsedown
<!-- ![Parsedown](https://i.imgur.com/yE8afYV.png) -->
Better [Markdown](http://en.wikipedia.org/wiki/Markdown) parser for PHP.
<p align="center"><img alt="Parsedown" src="https://i.imgur.com/fKVY6Kz.png" width="240" /></p>
***
<h1>Parsedown</h1>
[ [demo](http://parsedown.org/demo) ] [ [tests](http://parsedown.org/tests/) ]
[![Build Status](https://travis-ci.org/erusev/parsedown.svg)](https://travis-ci.org/erusev/parsedown)
[![Total Downloads](https://poser.pugx.org/erusev/parsedown/d/total.svg)](https://packagist.org/packages/erusev/parsedown)
[![Version](https://poser.pugx.org/erusev/parsedown/v/stable.svg)](https://packagist.org/packages/erusev/parsedown)
[![License](https://poser.pugx.org/erusev/parsedown/license.svg)](https://packagist.org/packages/erusev/parsedown)
***
Better Markdown Parser in PHP - <a href="http://parsedown.org/demo">Demo</a>.
### Features
## Features
* [fast](http://parsedown.org/speed)
* [consistent](http://parsedown.org/consistency)
* [GitHub Flavored](https://help.github.com/articles/github-flavored-markdown)
* [tested](https://travis-ci.org/erusev/parsedown) in PHP 5.2, 5.3, 5.4, 5.5 and [hhvm](http://www.hhvm.com/)
* friendly to international input
* One File
* No Dependencies
* [Super Fast](http://parsedown.org/speed)
* Extensible
* [GitHub flavored](https://help.github.com/articles/github-flavored-markdown)
* Tested in 5.5 to 7.3
* [Markdown Extra extension](https://github.com/erusev/parsedown-extra)
### Installation
## Installation
Include `Parsedown.php` or install [the composer package](https://packagist.org/packages/erusev/parsedown).
Install the [composer package]:
### Example
composer require erusev/parsedown
Or download the [latest release] and include `Parsedown.php`
[composer package]: https://packagist.org/packages/erusev/parsedown "The Parsedown package on packagist.org"
[latest release]: https://github.com/erusev/parsedown/releases/latest "The latest release of Parsedown"
## Example
```php
$text = 'Hello *Parsedown*!';
$Parsedown = new Parsedown();
$result = Parsedown::instance()->parse($text);
echo $result; # prints: <p>Hello <em>Parsedown</em>!</p>
echo $Parsedown->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>
```
You can also parse inline markdown only:
```php
echo $Parsedown->line('Hello _Parsedown_!'); # prints: Hello <em>Parsedown</em>!
```
More examples in [the wiki](https://github.com/erusev/parsedown/wiki/) and in [this video tutorial](http://youtu.be/wYZBY8DEikI).
## Security
Parsedown is capable of escaping user-input within the HTML that it generates. Additionally Parsedown will apply sanitisation to additional scripting vectors (such as scripting link destinations) that are introduced by the markdown syntax itself.
To tell Parsedown that it is processing untrusted user-input, use the following:
```php
$Parsedown->setSafeMode(true);
```
If instead, you wish to allow HTML within untrusted user-input, but still want output to be free from XSS it is recommended that you make use of a HTML sanitiser that allows HTML tags to be whitelisted, like [HTML Purifier](http://htmlpurifier.org/).
In both cases you should strongly consider employing defence-in-depth measures, like [deploying a Content-Security-Policy](https://scotthelme.co.uk/content-security-policy-an-introduction/) (a browser security feature) so that your page is likely to be safe even if an attacker finds a vulnerability in one of the first lines of defence above.
#### Security of Parsedown Extensions
Safe mode does not necessarily yield safe results when using extensions to Parsedown. Extensions should be evaluated on their own to determine their specific safety against XSS.
## Escaping HTML
> ⚠️  **WARNING:** This method isn't safe from XSS!
If you wish to escape HTML **in trusted input**, you can use the following:
```php
$Parsedown->setMarkupEscaped(true);
```
Beware that this still allows users to insert unsafe scripting vectors, such as links like `[xss](javascript:alert%281%29)`.
## Questions
**How does Parsedown work?**
It tries to read Markdown like a human. First, it looks at the lines. Its interested in how the lines start. This helps it recognise blocks. It knows, for example, that if a line starts with a `-` then perhaps it belongs to a list. Once it recognises the blocks, it continues to the content. As it reads, it watches out for special characters. This helps it recognise inline elements (or inlines).
We call this approach "line based". We believe that Parsedown is the first Markdown parser to use it. Since the release of Parsedown, other developers have used the same approach to develop other Markdown parsers in PHP and in other languages.
**Is it compliant with CommonMark?**
It passes most of the CommonMark tests. Most of the tests that don't pass deal with cases that are quite uncommon. Still, as CommonMark matures, compliance should improve.
**Who uses it?**
[Laravel Framework](https://laravel.com/), [Bolt CMS](http://bolt.cm/), [Grav CMS](http://getgrav.org/), [Herbie CMS](http://www.getherbie.org/), [Kirby CMS](http://getkirby.com/), [October CMS](http://octobercms.com/), [Pico CMS](http://picocms.org), [Statamic CMS](http://www.statamic.com/), [phpDocumentor](http://www.phpdoc.org/), [RaspberryPi.org](http://www.raspberrypi.org/), [Symfony Demo](https://github.com/symfony/demo) and [more](https://packagist.org/packages/erusev/parsedown/dependents).
**How can I help?**
Use it, star it, share it and if you feel generous, [donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=528P3NZQMP8N2).

View File

@ -12,7 +12,37 @@
"homepage": "http://erusev.com"
}
],
"require": {
"php": "^7.1||^8.0",
"ext-mbstring": "*"
},
"require-dev": {
"phpunit/phpunit": "^9.3.11||^8.5.21||^7.5.20",
"vimeo/psalm": "^4.10.0",
"friendsofphp/php-cs-fixer": "^3.0.0",
"infection/infection": "^0.25.0",
"roave/infection-static-analysis-plugin": "^1.10.0"
},
"autoload": {
"psr-0": {"Parsedown": ""}
"psr-4": {"Erusev\\Parsedown\\": "src/"}
},
"autoload-dev": {
"psr-4": {"Erusev\\Parsedown\\Tests\\": "tests/"}
},
"scripts": {
"test": [
"@test-static",
"@test-formatting",
"@test-dead-code",
"@test-units"
],
"test-static": "vendor/bin/psalm",
"test-dead-code": "vendor/bin/psalm --find-dead-code",
"test-units": "vendor/bin/phpunit",
"test-commonmark": "vendor/bin/phpunit tests/CommonMarkTestStrict.php",
"test-commonmark-weak": "vendor/bin/phpunit tests/CommonMarkTestWeak.php",
"test-formatting": "@composer fix -- --dry-run",
"fix": "vendor/bin/php-cs-fixer fix --verbose --show-progress=dots --diff"
}
}
}

View File

@ -0,0 +1,222 @@
# Implementing "Extensions" in v2.0
Parsedown v1.x allowed extensability through class extensions, where an developer
could extend the core Parsedown class, and access or override any of the `protected`
level methods and variables.
Whilst this approach allows huge breadth to the type of functionality that can
be added by an extension, it has some downsides too:
* ### Composability: extensions cannot be combined easily
An extension must extend another extension for two extensions to work together.
This limits the usefulness of small extensions, because they cannot be combined with another small or popular extension.
If an extension author wishes the extension to be compatible with another extension, they can only pick one.
* ### API stability
Because extensions have access to functions and variables at the `protected` API layer, it is hard to determine impacts of
internal changes. Yet, without being able to make a certain amount of internal change it is impractical to fix bugs or develop
new features. In the `1.x` branch, `1.8` was never released outside of a "beta" version for this reason: changes in the
`protected` API layer would break extensions.
In order to address these concerns, "extensions" in Parsedown v2.0 will become more like "plugins", and with that comes a lot of
flexability.
ParsedownExtra is a popular extension for Parsedown, and this has been completely re-implemented for 2.0. In order to use
ParsedownExtra with Parsedown, a user simply needs to write the following:
```php
$Parsedown = new Parsedown(new ParsedownExtra);
$actualMarkup = $Parsedown->toHtml($markdown);
```
Here, ParsedownExtra is *composed* with Parsedown, but does not extend it.
A key feature of *composability* is the ability to compose *multiple* extensions together, for example another
extension, say, `ParsedownMath` could be composed with `ParsedownExtra` in a user-defined order.
This time using the `::from` method, rather than the convinence constructor provided by `ParsedownExtra`.
```php
$Parsedown = new Parsedown(ParsedownExtra::from(ParsedownMath::from(new State)));
```
```php
$Parsedown = new Parsedown(ParsedownMath::from(ParsedownExtra::from(new State)));
```
In the above, the first object that we initialise the chain of composed extensions is the `State` object. This `State`
object is passed from `ParsedownExtra` to `ParsedownMath`, and then finally, to `Parsedown`. At each stage new
information is added to the `State`: adding or removing parsing instructions, and to enabling or disabling features.
The `State` object both contains instructions for how to parse a document (e.g. new blocks and inlines), as well as
information used throughout parsing (such as link reference definitions, or recursion depth). By writing `new State`,
we create a `State` object that is setup with Parsedown's default behaviours, and by passing that object through
different extensions (using the `::from` method), these extensions are free to alter, add to, or remove from that
default behaviour.
## Introduction to the `State` Object
Key to Parsedown's new composability for extensions is the `State` object.
This name is a little obtuse, but is importantly accurate.
A `State` object incorporates `Block`s, `Inline`s, some additional render steps, and any custom configuration options that
the user might want to set. This can **fully** control how a document is parsed and rendered.
In the above code, `ParsedownExtra` and `ParsedownMath` would both be implementing the `StateBearer` interface, which
essentially means "this class holds onto a particular Parsedown State". A `StateBearer` should be constructable from
an existing `State` via `::from(StateBearer $StateBearer)`, and reveals the `State` it is holding onto via `->state(): State`.
Implementing the `StateBearer` interface is **strongly encouraged** if implementing an extension, but not necessarily required.
In the end, you can modify Parsedown's behaviour by producing an appropriate `State` object (which itself is trivially a
`StateBearer`).
In general, extensions are encouraged to go further still, and split each self-contained piece of functionality out into its own
`StateBearer`. This will allow your users to cherry-pick specific pieces of functionality and combine it with other
functionality from different authors as they like. For example, a feature of ParsedownExtra is the ability to define and expand
"abbreviations". This feature is self-contained, and does not depend on other features (e.g. "footnotes").
A user could import *only* the abbreviations feature from ParsedownExtra by using the following:
```php
use Erusev\Parsedown\State;
use Erusev\Parsedown\Parsedown;
use Erusev\ParsedownExtra\Features\Abbreviations;
$State = Abbreviations::from(new State);
$Parsedown = new Parsedown($State);
$actualMarkup = $Parsedown->toHtml($markdown);
```
This allows a user to have fine-grained control over which features they import, and will allow them much more control over
combining features from multiple sources. E.g. a user may not like the way ParsedownExtra has implemented the "footnotes" feature,
and so may wish to utilise an implementation from another source. By implementing each feature as its own `StateBearer`, we give
users the freedom to compose features in a way that works for them.
## Anatomy of the `State` Object
The `State` object, generically, consists of a set of `Configurable`s. The word "set" is important here: only one instance of each
`Configurable` may exist in a `State`. If you need to store related data in a `Configurable`, your `Configurable` needs to handle
this containerisation itself.
`State` has a special property: all `Configurable`s "exist" in any `State` object when retrieving that `Configurable` with `->get`.
This means that retrieval cannot fail when using this method, though does mean that all `Configurable`s need to be "default constructable" (i.e. can be constructed into a "default" state). All `Configurable`s must therefore implement the static method
`initial`, which must return an instance of the given `Configurable`. No initial data will be provided, but the `Configurable` **must** arrive at some sane default instance.
`Configurable`s must also be immutable, unless they declare themeslves otherwise by implementing the `MutableConfigurable` interface.
### Blocks
One of the "core" `Configurable`s in Parsedown is `BlockTypes`. This contains a mapping of "markers" (a character that Parsedown
looks for, before handing off to the block-specific parser), and a list of `Block`s that can begin parsing from a specific marker.
Also contained, is a list of "unmarked" blocks, which Parsedown will hand off to prior to trying any marked blocks. Within marked
blocks there is also a precedence order, where the first block type to successfully parse in this list will be the one chosen.
The default value given by `BlockTypes::initial()` consists of Parsedown's default blocks. The following is a snapshot of this list:
```php
const DEFAULT_BLOCK_TYPES = [
'#' => [Header::class],
'*' => [Rule::class, TList::class],
'+' => [TList::class],
'-' => [SetextHeader::class, Table::class, Rule::class, TList::class],
...
```
This means that if a `-` marker is found, Parsedown will first try to parse a `SetextHeader`, then try to parse a `Table`, and
so on...
A new block can be added to this list in several ways. ParsedownExtra, for example, adds a new `Abbreviation` block as follows:
```php
$BlockTypes = $State->get(BlockTypes::class)
->addingMarkedLowPrecedence('*', [Abbreviation::class])
;
$State = $State->setting($BlockTypes);
```
This first retrieves the current value of the `BlockTypes` configurable, adds `Abbreviation` with low precedence (i.e. the
back of the list) to the `*` marker, and then updates the `$State` object by using the `->setting` method.
### Immutability
Note that the `->setting` method must be used to create a new instance of the `State` object because `BlockTypes` is immutable,
the same will be true of most configurables. This approach is preferred because mutations to `State` are localised by default: i.e.
only affect copies of `$State` which we provide to other methods, but does not affect copies of `$State` which were provided to our
code by a parent caller.
Localised mutability allows for more sensible reasoning by default, for example (this time talking about `Inline`s), the `Link` inline
can enforce that no inline `Url`s are parsed (which would cause double links in output when parsing something like:
`[https://example.com](https://example.com)`). This can be done by updating the copy of `$State` which is passed down to lower level
parsers to simply no longer include parsing of `Url`s:
```php
$State = $State->setting(
$State->get(InlineTypes::class)->removing([Url::class])
);
```
If `InlineTypes` were mutable, this change would not only affect decendent parsing, but would also affect all parsing which occured after our link was parsed (i.e. would stop URL parsing from that point on in the document).
Another use case for this is implementing a recursion limiter (which *is* implemented as a configurable). After a user-specifiable
max-depth is exceeded: further parsing will halt. The implementaion for this is extremely simple, only because of immutability.
### Mutability
The preference toward immutability by default is not an assertion that "mutability is bad", rather that "unexpected mutability
is bad". By opting-in to mutability, we can treat mutability with the care it deserves.
While immutabiltiy can do a lot to simplify reasoning in the majority of cases, there are some cirumstances where mutability is
required to implement a specific feature. An exmaple of this is found in ParsedownExtra's "abbreviations" feature, which implements
the following:
```php
final class AbbreviationBook implements MutableConfigurable
{
/** @var array<string, string> */
private $book;
/**
* @param array<string, string> $book
*/
public function __construct(array $book = [])
{
$this->book = $book;
}
/** @return self */
public static function initial()
{
return new self;
}
public function mutatingSet(string $abbreviation, string $definition): void
{
$this->book[$abbreviation] = $definition;
}
public function lookup(string $abbreviation): ?string
{
return $this->book[$abbreviation] ?? null;
}
/** @return array<string, string> */
public function all()
{
return $this->book;
}
/** @return self */
public function isolatedCopy(): self
{
return new self($this->book);
}
}
```
Under the hood, `AbbreviationBook` is nothing more than a string-to-string mapping between an abbreviation, and its definition.
The powerful feature here is that when an abbreviation is identified during parsing, that definition can be updated immediately
everywhere, without needing to worry about the current parsing depth, or organise an alternate method to sharing this data. Footnotes
also make use of this with a `FootnoteBook`, with slightly more complexity in what is stored (so that inline references can be
individually numbered).

18
infection.json.dist Normal file
View File

@ -0,0 +1,18 @@
{
"timeout": 10,
"source": {
"directories": [
"src"
]
},
"logs": {
"text": "infection.log"
},
"mutators": {
"@default": true,
"@cast": false,
"This": false,
"FunctionCall": false,
"NewObject": false
}
}

View File

@ -1,8 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit colors="true">
<phpunit bootstrap="vendor/autoload.php" colors="true">
<testsuites>
<testsuite>
<file>tests/Test.php</file>
<testsuite name="ParsedownTests">
<file>tests/ParsedownTest.php</file>
<file>tests/CommonMarkTest.php</file>
<directory suffix="Test.php">./tests/src</directory>
</testsuite>
</testsuites>
</phpunit>
<groups>
<exclude>
<group>update</group>
</exclude>
</groups>
</phpunit>

39
psalm.xml Normal file
View File

@ -0,0 +1,39 @@
<?xml version="1.0"?>
<psalm
errorLevel="1"
strictBinaryOperands="true"
checkForThrowsDocblock="true"
>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
<issueHandlers>
<PossiblyUnusedMethod>
<errorLevel type="suppress">
<directory name="tests" />
</errorLevel>
</PossiblyUnusedMethod>
<PropertyNotSetInConstructor>
<errorLevel type="suppress"><directory name="tests" /></errorLevel>
</PropertyNotSetInConstructor>
<UnusedClass>
<errorLevel type="suppress"><directory name="tests" /></errorLevel>
</UnusedClass>
<UndefinedInterfaceMethod>
<errorLevel type="suppress"><directory name="tests/src" /></errorLevel>
</UndefinedInterfaceMethod>
<PossiblyNullArrayAccess>
<errorLevel type="suppress"><directory name="tests/src" /></errorLevel>
</PossiblyNullArrayAccess>
<PossiblyNullReference>
<errorLevel type="suppress"><directory name="tests/src" /></errorLevel>
</PossiblyNullReference>
<InternalMethod>
<errorLevel type="suppress">
<directory name="tests" />
</errorLevel>
</InternalMethod>
</issueHandlers>
</psalm>

34
src/AST/Handler.php Normal file
View File

@ -0,0 +1,34 @@
<?php
namespace Erusev\Parsedown\AST;
use Erusev\Parsedown\Html\Renderable;
use Erusev\Parsedown\State;
/**
* @template T as Renderable
*/
final class Handler implements StateRenderable
{
/** @var callable(State):T */
private $closure;
/**
* @param callable(State):T $closure
*/
public function __construct(callable $closure)
{
$this->closure = $closure;
}
/**
* @param State $State
* @return T&Renderable
*/
public function renderable(State $State)
{
$closure = $this->closure;
return $closure($State);
}
}

View File

@ -0,0 +1,15 @@
<?php
namespace Erusev\Parsedown\AST;
use Erusev\Parsedown\Html\Renderable;
use Erusev\Parsedown\State;
interface StateRenderable
{
/**
* @param State $State
* @return Renderable
*/
public function renderable(State $State);
}

13
src/Component.php Normal file
View File

@ -0,0 +1,13 @@
<?php
namespace Erusev\Parsedown;
use Erusev\Parsedown\AST\StateRenderable;
interface Component
{
/**
* @return StateRenderable
*/
public function stateRenderable();
}

View File

@ -0,0 +1,13 @@
<?php
namespace Erusev\Parsedown\Components;
interface AcquisitioningBlock extends Block
{
/**
* Return true if the block was built encompassing the previous block
* $Block given to static::build, return false otherwise.
* @return bool
*/
public function acquiredPrevious();
}

View File

@ -0,0 +1,16 @@
<?php
namespace Erusev\Parsedown\Components;
use Erusev\Parsedown\Parsing\Excerpt;
interface BacktrackingInline extends Inline
{
/**
* Return an integer to declare that the inline should be treated as if it
* started from that position in the excerpt given to static::build.
* Return null to use the excerpt offset value.
* @return int|null
* */
public function modifyStartPositionTo();
}

22
src/Components/Block.php Normal file
View File

@ -0,0 +1,22 @@
<?php
namespace Erusev\Parsedown\Components;
use Erusev\Parsedown\Component;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\State;
interface Block extends Component
{
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static|null
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
);
}

View File

@ -0,0 +1,121 @@
<?php
namespace Erusev\Parsedown\Components\Blocks;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Components\ContinuableBlock;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\Parsing\Line;
use Erusev\Parsedown\Parsing\Lines;
use Erusev\Parsedown\State;
final class BlockQuote implements ContinuableBlock
{
/** @var Lines */
private $Lines;
/**
* @param Lines $Lines
*/
private function __construct($Lines)
{
$this->Lines = $Lines;
}
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static|null
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
) {
if (\preg_match('/^(>[ \t]?+)(.*+)/', $Context->line()->text(), $matches)) {
$indentOffset = $Context->line()->indentOffset() + $Context->line()->indent() + \strlen($matches[1]);
$recoveredSpaces = 0;
if (\strlen($matches[1]) === 2 && \substr($matches[1], 1, 1) === "\t") {
$recoveredSpaces = Line::tabShortage(0, $indentOffset -1) -1;
}
return new self(Lines::fromTextLines(
\str_repeat(' ', $recoveredSpaces) . $matches[2],
$indentOffset
));
}
return null;
}
/**
* @param Context $Context
* @param State $State
* @return self|null
*/
public function advance(Context $Context, State $State)
{
if ($Context->precedingEmptyLines() > 0) {
return null;
}
if (\preg_match('/^(>[ \t]?+)(.*+)/', $Context->line()->text(), $matches)) {
$indentOffset = $Context->line()->indentOffset() + $Context->line()->indent() + \strlen($matches[1]);
$recoveredSpaces = 0;
if (\strlen($matches[1]) === 2 && \substr($matches[1], 1, 1) === "\t") {
$recoveredSpaces = Line::tabShortage(0, $indentOffset -1) -1;
}
$Lines = $this->Lines->appendingTextLines(
\str_repeat(' ', $recoveredSpaces) . $matches[2],
$indentOffset
);
return new self($Lines);
}
if (!($Context->precedingEmptyLines() > 0)) {
$indentOffset = $Context->line()->indentOffset() + $Context->line()->indent();
$Lines = $this->Lines->appendingTextLines($Context->line()->text(), $indentOffset);
return new self($Lines);
}
return null;
}
/**
* @return array{Block[], State}
*/
public function contents(State $State)
{
return Parsedown::blocks($this->Lines, $State);
}
/**
* @return Handler<Element>
*/
public function stateRenderable()
{
return new Handler(
/** @return Element */
function (State $State) {
list($Blocks, $State) = $this->contents($State);
$StateRenderables = Parsedown::stateRenderablesFrom($Blocks);
$Renderables = $State->applyTo($StateRenderables);
$Renderables[] = new Text("\n");
return new Element('blockquote', [], $Renderables);
}
);
}
}

View File

@ -0,0 +1,149 @@
<?php
namespace Erusev\Parsedown\Components\Blocks;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Components\ContinuableBlock;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\State;
final class FencedCode implements ContinuableBlock
{
/** @var string */
private $code;
/** @var string */
private $infostring;
/** @var string */
private $marker;
/** @var int */
private $openerLength;
/** @var bool */
private $isComplete;
/**
* @param string $code
* @param string $infostring
* @param string $marker
* @param int $openerLength
* @param bool $isComplete
*/
private function __construct($code, $infostring, $marker, $openerLength, $isComplete)
{
$this->code = $code;
$this->infostring = $infostring;
$this->marker = $marker;
$this->openerLength = $openerLength;
$this->isComplete = $isComplete;
}
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static|null
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
) {
$marker = \substr($Context->line()->text(), 0, 1);
if ($marker !== '`' && $marker !== '~') {
return null;
}
$openerLength = \strspn($Context->line()->text(), $marker);
if ($openerLength < 3) {
return null;
}
$infostring = \trim(\substr($Context->line()->text(), $openerLength), "\t ");
if (\strpos($infostring, '`') !== false) {
return null;
}
return new self('', $infostring, $marker, $openerLength, false);
}
/**
* @param Context $Context
* @param State $State
* @return self|null
*/
public function advance(Context $Context, State $State)
{
if ($this->isComplete) {
return null;
}
$newCode = $this->code;
$newCode .= $Context->precedingEmptyLinesText();
if (($len = \strspn($Context->line()->text(), $this->marker)) >= $this->openerLength
&& \chop(\substr($Context->line()->text(), $len), ' ') === ''
) {
return new self($newCode, $this->infostring, $this->marker, $this->openerLength, true);
}
$newCode .= $Context->line()->rawLine() . "\n";
return new self($newCode, $this->infostring, $this->marker, $this->openerLength, false);
}
/** @return string */
public function infostring()
{
return $this->infostring;
}
/** @return string */
public function code()
{
return $this->code;
}
/**
* @return Element
*/
public function stateRenderable()
{
/**
* https://www.w3.org/TR/2011/WD-html5-20110525/elements.html#classes
* Every HTML element may have a class attribute specified.
* The attribute, if specified, must have a value that is a set
* of space-separated tokens representing the various classes
* that the element belongs to.
* [...]
* The space characters, for the purposes of this specification,
* are U+0020 SPACE, U+0009 CHARACTER TABULATION (tab),
* U+000A LINE FEED (LF), U+000C FORM FEED (FF), and
* U+000D CARRIAGE RETURN (CR).
*/
$infostring = \substr(
$this->infostring(),
0,
\strcspn($this->infostring(), " \t\n\f\r")
);
// only necessary pre-php7
if ($infostring === false) {
$infostring = '';
}
return new Element('pre', [], [new Element(
'code',
$infostring !== '' ? ['class' => "language-{$infostring}"] : [],
[new Text($this->code())]
)]);
}
}

View File

@ -0,0 +1,116 @@
<?php
namespace Erusev\Parsedown\Components\Blocks;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Configurables\HeaderSlug;
use Erusev\Parsedown\Configurables\SlugRegister;
use Erusev\Parsedown\Configurables\StrictMode;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\State;
final class Header implements Block
{
/** @var string */
private $text;
/** @var 1|2|3|4|5|6 */
private $level;
/**
* @param string $text
* @param 1|2|3|4|5|6 $level
*/
private function __construct($text, $level)
{
$this->text = $text;
$this->level = $level;
}
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static|null
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
) {
if ($Context->line()->indent() > 3) {
return null;
}
$level = \strspn($Context->line()->text(), '#');
if ($level > 6 || $level < 1) {
return null;
}
/** @var 1|2|3|4|5|6 $level */
$text = \ltrim($Context->line()->text(), '#');
$firstChar = \substr($text, 0, 1);
if (
$State->get(StrictMode::class)->isEnabled()
&& \trim($firstChar, " \t") !== ''
) {
return null;
}
$text = \trim($text, " \t");
# remove closing sequence
$removedClosing = \rtrim($text, '#');
$lastChar = \substr($removedClosing, -1);
if (\trim($lastChar, " \t") === '') {
$text = \rtrim($removedClosing, " \t");
}
return new self($text, $level);
}
/** @return string */
public function text()
{
return $this->text;
}
/** @return 1|2|3|4|5|6 */
public function level()
{
return $this->level;
}
/**
* @return Handler<Element>
*/
public function stateRenderable()
{
return new Handler(
/** @return Element */
function (State $State) {
$HeaderSlug = $State->get(HeaderSlug::class);
$Register = $State->get(SlugRegister::class);
$attributes = (
$HeaderSlug->isEnabled()
? ['id' => $HeaderSlug->transform($Register, $this->text())]
: []
);
return new Element(
'h' . \strval($this->level()),
$attributes,
$State->applyTo(Parsedown::line($this->text(), $State))
);
}
);
}
}

View File

@ -0,0 +1,93 @@
<?php
namespace Erusev\Parsedown\Components\Blocks;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Components\ContinuableBlock;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\Parsing\Line;
use Erusev\Parsedown\State;
final class IndentedCode implements ContinuableBlock
{
/** @var string */
private $code;
/**
* @param string $code
*/
private function __construct($code)
{
$this->code = $code;
}
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static|null
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
) {
if (isset($Block) && $Block instanceof Paragraph && ! ($Context->precedingEmptyLines() > 0)) {
return null;
}
if ($Context->line()->indent() < 4) {
return null;
}
return new self($Context->line()->ltrimBodyUpto(4) . "\n");
}
/**
* @param Context $Context
* @param State $State
* @return self|null
*/
public function advance(Context $Context, State $State)
{
if ($Context->line()->indent() < 4) {
return null;
}
$newCode = $this->code;
$offset = $Context->line()->indentOffset();
if ($Context->precedingEmptyLines() > 0) {
foreach (\explode("\n", $Context->precedingEmptyLinesText()) as $line) {
$newCode .= (new Line($line, $offset))->ltrimBodyUpto(4) . "\n";
}
$newCode = \substr($newCode, 0, -1);
}
$newCode .= $Context->line()->ltrimBodyUpto(4) . "\n";
return new self($newCode);
}
/** @return string */
public function code()
{
return $this->code;
}
/**
* @return Element
*/
public function stateRenderable()
{
return new Element(
'pre',
[],
[new Element('code', [], [new Text($this->code())])]
);
}
}

View File

@ -0,0 +1,256 @@
<?php
namespace Erusev\Parsedown\Components\Blocks;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Components\ContinuableBlock;
use Erusev\Parsedown\Configurables\SafeMode;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\RawHtml;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\State;
final class Markup implements ContinuableBlock
{
private const REGEX_HTML_ATTRIBUTE = '[a-zA-Z_:][\w:.-]*+(?:\s*+=\s*+(?:[^"\'=<>`\s]+|"[^"]*+"|\'[^\']*+\'))?+';
private const BLOCK_ELEMENTS = [
'address' => true,
'article' => true,
'aside' => true,
'base' => true,
'basefont' => true,
'blockquote' => true,
'body' => true,
'caption' => true,
'center' => true,
'col' => true,
'colgroup' => true,
'dd' => true,
'details' => true,
'dialog' => true,
'dir' => true,
'div' => true,
'dl' => true,
'dt' => true,
'fieldset' => true,
'figcaption' => true,
'figure' => true,
'footer' => true,
'form' => true,
'frame' => true,
'frameset' => true,
'h1' => true,
'h2' => true,
'h3' => true,
'h4' => true,
'h5' => true,
'h6' => true,
'head' => true,
'header' => true,
'hr' => true,
'html' => true,
'iframe' => true,
'legend' => true,
'li' => true,
'link' => true,
'main' => true,
'menu' => true,
'menuitem' => true,
'nav' => true,
'noframes' => true,
'ol' => true,
'optgroup' => true,
'option' => true,
'p' => true,
'param' => true,
'section' => true,
'source' => true,
'summary' => true,
'table' => true,
'tbody' => true,
'td' => true,
'tfoot' => true,
'th' => true,
'thead' => true,
'title' => true,
'tr' => true,
'track' => true,
'ul' => true,
];
private const SIMPLE_CONTAINS_END_CONDITIONS = [
2 => '-->',
3 => '?>',
4 => '>',
5 => ']]>',
];
private const SPECIAL_HTML_BLOCK_TAGS = [
'script' => true,
'style' => true,
'pre' => true,
];
/** @var string */
private $html;
/** @var 1|2|3|4|5|6|7 */
private $type;
/** @var bool */
private $closed;
/**
* @param string $html
* @param 1|2|3|4|5|6|7 $type
* @param bool $closed
*/
private function __construct($html, $type, $closed = false)
{
$this->html = $html;
$this->type = $type;
$this->closed = $closed;
}
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static|null
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
) {
$text = $Context->line()->text();
$rawLine = $Context->line()->rawLine();
if (\preg_match('/^<(?:script|pre|style)(?:\s++|>|$)/i', $text)) {
return new self($rawLine, 1, self::closes12345TypeMarkup(1, $text));
}
if (\substr($text, 0, 4) === '<!--') {
return new self($rawLine, 2, self::closes12345TypeMarkup(2, $text));
}
if (\substr($text, 0, 2) === '<?') {
return new self($rawLine, 3, self::closes12345TypeMarkup(3, $text));
}
if (\preg_match('/^<![A-Z]/', $text)) {
return new self($rawLine, 4, self::closes12345TypeMarkup(4, $text));
}
if (\substr($text, 0, 9) === '<![CDATA[') {
return new self($rawLine, 5, self::closes12345TypeMarkup(5, $text));
}
if (\preg_match('/^<([\/]?+)(\w++)(.*+)$/', $text, $matches)) {
$isClosing = ($matches[1] === '/');
$element = \strtolower($matches[2]);
$tail = $matches[3];
if (\array_key_exists($element, self::BLOCK_ELEMENTS)
&& \preg_match('/^(?:\s|$|>|\/)/', $tail)
) {
return new self($rawLine, 6);
}
if (
! $isClosing && \preg_match(
'/^(?:[ ]*+'.self::REGEX_HTML_ATTRIBUTE.')*(?:[ ]*+)[\/]?+[>](.*+)$/',
$tail,
$matches
) || $isClosing && \preg_match(
'/^(?:[ ]*+)[\/]?+[>](.*+)$/',
$tail,
$matches
)
) {
$tail = $matches[1];
if (! \array_key_exists($element, self::SPECIAL_HTML_BLOCK_TAGS)
&& ! (isset($Block) && $Block instanceof Paragraph && $Context->precedingEmptyLines() < 1)
&& \preg_match('/^\s*+$/', $tail)
) {
return new self($rawLine, 7);
}
}
}
return null;
}
/**
* @param Context $Context
* @param State $State
* @return self|null
*/
public function advance(Context $Context, State $State)
{
$closed = $this->closed;
$type = $this->type;
if ($closed) {
return null;
}
if (($type === 6 || $type === 7) && $Context->precedingEmptyLines() > 0) {
return null;
}
if ($type === 1 || $type === 2 || $type === 3 || $type === 4 || $type === 5) {
$closed = self::closes12345TypeMarkup($type, $Context->line()->text());
}
$html = $this->html . \str_repeat("\n", $Context->precedingEmptyLines() + 1);
$html .= $Context->line()->rawLine();
return new self($html, $type, $closed);
}
/**
* @param 1|2|3|4|5 $type
* @param string $text
* @return bool
*/
private static function closes12345TypeMarkup($type, $text)
{
if ($type === 1) {
if (\preg_match('/<\/(?:script|pre|style)>/i', $text)) {
return true;
}
} elseif (\stripos($text, self::SIMPLE_CONTAINS_END_CONDITIONS[$type]) !== false) {
return true;
}
return false;
}
/** @return string */
public function html()
{
return $this->html;
}
/**
* @return Handler<Element|RawHtml>
*/
public function stateRenderable()
{
return new Handler(
/** @return Element|RawHtml */
function (State $State) {
if ($State->get(SafeMode::class)->isEnabled()) {
return new Element('p', [], [new Text($this->html())]);
} else {
return new RawHtml($this->html());
}
}
);
}
}

View File

@ -0,0 +1,76 @@
<?php
namespace Erusev\Parsedown\Components\Blocks;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Components\ContinuableBlock;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\State;
final class Paragraph implements ContinuableBlock
{
/** @var string */
private $text;
/**
* @param string $text
*/
private function __construct($text)
{
$this->text = $text;
}
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
) {
return new self($Context->line()->text());
}
/**
* @param Context $Context
* @param State $State
* @return self|null
*/
public function advance(Context $Context, State $State)
{
if ($Context->precedingEmptyLines() > 0) {
return null;
}
return new self($this->text . "\n" . $Context->line()->text());
}
/** @return string */
public function text()
{
return $this->text;
}
/**
* @return Handler<Element>
*/
public function stateRenderable()
{
return new Handler(
/** @return Element */
function (State $State) {
return new Element(
'p',
[],
$State->applyTo(Parsedown::line(\trim($this->text()), $State))
);
}
);
}
}

View File

@ -0,0 +1,66 @@
<?php
namespace Erusev\Parsedown\Components\Blocks;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Components\StateUpdatingBlock;
use Erusev\Parsedown\Configurables\DefinitionBook;
use Erusev\Parsedown\Html\Renderables\Invisible;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\State;
final class Reference implements StateUpdatingBlock
{
/** @var State */
private $State;
private function __construct(State $State)
{
$this->State = $State;
}
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static|null
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
) {
if (\preg_match(
'/^\[(.+?)\]:[ ]*+<?(\S+?)>?(?:[ ]+["\'(](.+)["\')])?[ ]*+$/',
$Context->line()->text(),
$matches
)) {
$id = \strtolower($matches[1]);
$Data = [
'url' => $matches[2],
'title' => isset($matches[3]) ? $matches[3] : null,
];
$State->get(DefinitionBook::class)->mutatingSet($id, $Data);
return new self($State);
}
return null;
}
/** @return State */
public function latestState()
{
return $this->State;
}
/**
* @return Invisible
*/
public function stateRenderable()
{
return new Invisible;
}
}

View File

@ -0,0 +1,54 @@
<?php
namespace Erusev\Parsedown\Components\Blocks;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\State;
final class Rule implements Block
{
private function __construct()
{
}
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static|null
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
) {
if ($Context->line()->indent() > 3) {
return null;
}
$marker = \substr($Context->line()->text(), 0, 1);
if ($marker !== '*' && $marker !== '-' && $marker !== '_') {
return null;
}
if (
\substr_count($Context->line()->text(), $marker) >= 3
&& \chop($Context->line()->text(), " \t$marker") === ''
) {
return new self;
}
return null;
}
/**
* @return Element
*/
public function stateRenderable()
{
return Element::selfClosing('hr', []);
}
}

View File

@ -0,0 +1,108 @@
<?php
namespace Erusev\Parsedown\Components\Blocks;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\AcquisitioningBlock;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Configurables\HeaderSlug;
use Erusev\Parsedown\Configurables\SlugRegister;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\State;
final class SetextHeader implements AcquisitioningBlock
{
/** @var string */
private $text;
/** @var 1|2 */
private $level;
/**
* @param string $text
* @param 1|2 $level
*/
private function __construct($text, $level)
{
$this->text = $text;
$this->level = $level;
}
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static|null
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
) {
if (! isset($Block) || ! $Block instanceof Paragraph || $Context->precedingEmptyLines() > 0) {
return null;
}
$marker = \substr($Context->line()->text(), 0, 1);
if ($marker !== '=' && $marker !== '-') {
return null;
}
if (
$Context->line()->indent() < 4
&& \chop(\chop($Context->line()->text(), " \t"), $marker) === ''
) {
$level = ($marker === '=' ? 1 : 2);
return new self(\trim($Block->text()), $level);
}
return null;
}
/** @return bool */
public function acquiredPrevious()
{
return true;
}
/** @return string */
public function text()
{
return $this->text;
}
/** @return 1|2 */
public function level()
{
return $this->level;
}
/**
* @return Handler<Element>
*/
public function stateRenderable()
{
return new Handler(
/** @return Element */
function (State $State) {
$HeaderSlug = $State->get(HeaderSlug::class);
$Register = $State->get(SlugRegister::class);
$attributes = (
$HeaderSlug->isEnabled()
? ['id' => $HeaderSlug->transform($Register, $this->text())]
: []
);
return new Element(
'h' . \strval($this->level()),
$attributes,
$State->applyTo(Parsedown::line($this->text(), $State))
);
}
);
}
}

View File

@ -0,0 +1,346 @@
<?php
namespace Erusev\Parsedown\Components\Blocks;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Components\ContinuableBlock;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\Parsing\Line;
use Erusev\Parsedown\Parsing\Lines;
use Erusev\Parsedown\State;
final class TList implements ContinuableBlock
{
/** @var Lines[] */
private $Lis;
/** @var int|null */
private $listStart;
/** @var bool */
private $isLoose;
/** @var int */
private $indent;
/** @var 'ul'|'ol' */
private $type;
/** @var string */
private $marker;
/** @var int */
private $afterMarkerSpaces;
/** @var string */
private $markerType;
/** @var string */
private $markerTypeRegex;
/**
* @param Lines[] $Lis
* @param int|null $listStart
* @param bool $isLoose
* @param int $indent
* @param 'ul'|'ol' $type
* @param string $marker
* @param int $afterMarkerSpaces
* @param string $markerType
* @param string $markerTypeRegex
*/
private function __construct(
$Lis,
$listStart,
$isLoose,
$indent,
$type,
$marker,
$afterMarkerSpaces,
$markerType,
$markerTypeRegex
) {
$this->Lis = $Lis;
$this->listStart = $listStart;
$this->isLoose = $isLoose;
$this->indent = $indent;
$this->type = $type;
$this->marker = $marker;
$this->afterMarkerSpaces = $afterMarkerSpaces;
$this->markerType = $markerType;
$this->markerTypeRegex = $markerTypeRegex;
}
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static|null
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
) {
list($type, $pattern) = (
\substr($Context->line()->text(), 0, 1) <= '-'
? ['ul', '[*+-]']
: ['ol', '[0-9]{1,9}+[.\)]']
);
if (\preg_match(
'/^('.$pattern.')([\t ]++.*|$)/',
$Context->line()->text(),
$matches
)) {
$marker = $matches[1];
$preAfterMarkerSpacesIndentOffset = $Context->line()->indentOffset() + $Context->line()->indent() + \strlen($marker);
$LineWithMarkerIndent = new Line(isset($matches[2]) ? $matches[2] : '', $preAfterMarkerSpacesIndentOffset);
$indentAfterMarker = $LineWithMarkerIndent->indent();
if ($indentAfterMarker > 4) {
$perceivedIndent = $indentAfterMarker -1;
$afterMarkerSpaces = 1;
} else {
$perceivedIndent = 0;
$afterMarkerSpaces = $indentAfterMarker;
}
$indentOffset = $preAfterMarkerSpacesIndentOffset + $afterMarkerSpaces;
$text = \str_repeat(' ', $perceivedIndent) . $LineWithMarkerIndent->text();
$markerType = (
$type === 'ul'
? $marker
: \substr($marker, -1)
);
$markerTypeRegex = \preg_quote($markerType, '/');
/** @var int|null */
$listStart = null;
if ($type === 'ol') {
/** @psalm-suppress PossiblyFalseArgument */
$listStart = \intval(\strstr($matches[1], $markerType, true) ?: '0');
if (
$listStart !== 1
&& isset($Block)
&& $Block instanceof Paragraph
&& ! ($Context->precedingEmptyLines() > 0)
) {
return null;
}
}
return new self(
[!empty($text) ? Lines::fromTextLines($text, $indentOffset) : Lines::none()],
$listStart,
false,
$Context->line()->indent(),
$type,
$marker,
$afterMarkerSpaces,
$markerType,
$markerTypeRegex
);
}
}
/**
* @param Context $Context
* @param State $State
* @return self|null
*/
public function advance(Context $Context, State $State)
{
if ($Context->precedingEmptyLines() > 0 && \end($this->Lis)->isEmpty()) {
return null;
}
$newlines = \str_repeat("\n", $Context->precedingEmptyLines());
$requiredIndent = $this->indent + \strlen($this->marker) + $this->afterMarkerSpaces;
$isLoose = $this->isLoose;
$indent = $Context->line()->indent();
$Lis = $this->Lis;
if ($this->type === 'ol') {
$regex = '/^([0-9]++'.$this->markerTypeRegex.')([\t ]++.*|$)/';
} else {
$regex = '/^('.$this->markerTypeRegex.')([\t ]++.*|$)/';
}
if ($Context->line()->indent() < $requiredIndent
&& \preg_match($regex, $Context->line()->text(), $matches)
) {
if ($Context->precedingEmptyLines() > 0) {
$Lis[\count($Lis) -1] = $Lis[\count($Lis) -1]->appendingBlankLines(1);
$isLoose = true;
}
$marker = $matches[1];
$preAfterMarkerSpacesIndentOffset = $Context->line()->indentOffset() + $Context->line()->indent() + \strlen($marker);
$LineWithMarkerIndent = new Line(isset($matches[2]) ? $matches[2] : '', $preAfterMarkerSpacesIndentOffset);
$indentAfterMarker = $LineWithMarkerIndent->indent();
if ($indentAfterMarker > 4) {
$perceivedIndent = $indentAfterMarker -1;
$afterMarkerSpaces = 1;
} else {
$perceivedIndent = 0;
$afterMarkerSpaces = $indentAfterMarker;
}
$indentOffset = $preAfterMarkerSpacesIndentOffset + $afterMarkerSpaces;
$text = \str_repeat(' ', $perceivedIndent) . $LineWithMarkerIndent->text();
$Lis[] = Lines::fromTextLines($newlines . $text, $indentOffset);
return new self(
$Lis,
$this->listStart,
$isLoose,
$indent,
$this->type,
$marker,
$afterMarkerSpaces,
$this->markerType,
$this->markerTypeRegex
);
} elseif ($Context->line()->indent() < $requiredIndent && self::build($Context, $State) !== null) {
return null;
}
if ($Context->line()->indent() >= $requiredIndent) {
if ($Context->precedingEmptyLines() > 0) {
$Lis[\count($Lis) -1] = $Lis[\count($Lis) -1]->appendingBlankLines($Context->precedingEmptyLines());
$isLoose = true;
}
$text = $Context->line()->ltrimBodyUpto($requiredIndent);
$indentOffset = $Context->line()->indentOffset() + \min($requiredIndent, $Context->line()->indent());
$Lis[\count($Lis) -1] = $Lis[\count($Lis) -1]->appendingTextLines($text, $indentOffset);
return new self(
$Lis,
$this->listStart,
$isLoose,
$this->indent,
$this->type,
$this->marker,
$this->afterMarkerSpaces,
$this->markerType,
$this->markerTypeRegex
);
}
if (! ($Context->precedingEmptyLines() > 0)) {
$text = $Context->line()->ltrimBodyUpto($requiredIndent);
$Lis[\count($Lis) -1] = $Lis[\count($Lis) -1]->appendingTextLines(
$newlines . \str_repeat(' ', $Context->line()->indent()) . $text,
$Context->line()->indentOffset() + \min($requiredIndent, $Context->line()->indent())
);
return new self(
$Lis,
$this->listStart,
$isLoose,
$this->indent,
$this->type,
$this->marker,
$this->afterMarkerSpaces,
$this->markerType,
$this->markerTypeRegex
);
}
return null;
}
/**
* @return array{Block[], State}[]
*/
public function items(State $State)
{
return \array_map(
/** @return array{Block[], State} */
function (Lines $Lines) use ($State) {
return Parsedown::blocks($Lines, $State);
},
$this->Lis
);
}
/** @return 'ol'|'ul' */
public function type()
{
return $this->type;
}
/** @return int|null */
public function listStart()
{
return $this->listStart;
}
/**
* @return Handler<Element>
*/
public function stateRenderable()
{
return new Handler(
/** @return Element */
function (State $State) {
$listStart = $this->listStart();
return new Element(
$this->type(),
(
isset($listStart) && $listStart !== 1
? ['start' => \strval($listStart)]
: []
),
\array_map(
/**
* @param array{Block[], State} $Item
* @return Element
* */
function ($Item) {
list($Blocks, $State) = $Item;
$StateRenderables = Parsedown::stateRenderablesFrom($Blocks);
$Renderables = $State->applyTo($StateRenderables);
if (! $this->isLoose
&& isset($Renderables[0])
&& $Renderables[0] instanceof Element
&& $Renderables[0]->name() === 'p'
) {
$Contents = $Renderables[0]->contents();
unset($Renderables[0]);
$Renderables = \array_merge($Contents ?: [], $Renderables);
}
return new Element('li', [], $Renderables);
},
$this->items($State)
)
);
}
);
}
}

View File

@ -0,0 +1,273 @@
<?php
namespace Erusev\Parsedown\Components\Blocks;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\AcquisitioningBlock;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Components\ContinuableBlock;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\State;
/**
* @psalm-type _Alignment='left'|'center'|'right'
*/
final class Table implements AcquisitioningBlock, ContinuableBlock
{
/** @var list<_Alignment|null> */
private $alignments;
/** @var list<string> */
private $headerCells;
/** @var list<list<string>> */
private $rows;
/**
* @param list<_Alignment|null> $alignments
* @param list<string> $headerCells
* @param list<list<string>> $rows
*/
private function __construct($alignments, $headerCells, $rows)
{
$this->alignments = $alignments;
$this->headerCells = $headerCells;
$this->rows = $rows;
}
/**
* @param Context $Context
* @param State $State
* @param Block|null $Block
* @return static|null
*/
public static function build(
Context $Context,
State $State,
Block $Block = null
) {
if (! isset($Block) || ! $Block instanceof Paragraph) {
return null;
}
if (
\strpos($Block->text(), '|') === false
&& \strpos($Context->line()->text(), '|') === false
&& \strpos($Context->line()->text(), ':') === false
|| \strpos($Block->text(), "\n") !== false
) {
return null;
}
if (\chop($Context->line()->text(), ' -:|') !== '') {
return null;
}
$alignments = self::parseAlignments($Context->line()->text());
if (! isset($alignments)) {
return null;
}
# ~
$headerRow = \trim(\trim($Block->text()), '|');
$headerCells = \array_map('trim', \explode('|', $headerRow));
if (\count($headerCells) !== \count($alignments)) {
return null;
}
# ~
return new self($alignments, $headerCells, []);
}
/**
* @param Context $Context
* @param State $State
* @return self|null
*/
public function advance(Context $Context, State $State)
{
if ($Context->precedingEmptyLines() > 0) {
return null;
}
if (
\count($this->alignments) !== 1
&& \strpos($Context->line()->text(), '|') === false
) {
return null;
}
$row = \trim(\trim($Context->line()->text()), '|');
if (
! \preg_match_all('/(?:(\\\\[|])|[^|`]|`[^`]++`|`)++/', $row, $matches)
|| ! isset($matches[0])
) {
return null;
}
$cells = \array_map(
'trim',
\array_slice($matches[0], 0, \count($this->alignments))
);
return new self(
$this->alignments,
$this->headerCells,
\array_merge($this->rows, [$cells])
);
}
/**
* @param string $dividerRow
* @return list<_Alignment|null>|null
*/
private static function parseAlignments($dividerRow)
{
$dividerRow = \trim($dividerRow);
$dividerRow = \trim($dividerRow, '|');
$dividerCells = \explode('|', $dividerRow);
/** @var list<_Alignment|null> */
$alignments = [];
foreach ($dividerCells as $dividerCell) {
$dividerCell = \trim($dividerCell);
if ($dividerCell === '') {
return null;
}
/** @var _Alignment|null */
$alignment = null;
if (\substr($dividerCell, 0, 1) === ':') {
$alignment = 'left';
}
if (\substr($dividerCell, - 1) === ':') {
$alignment = $alignment === 'left' ? 'center' : 'right';
}
$alignments []= $alignment;
}
return $alignments;
}
/** @return bool */
public function acquiredPrevious()
{
return true;
}
/** @return list<Inline[]> */
public function headerRow(State $State)
{
return \array_map(
/**
* @param string $cell
* @return Inline[]
*/
function ($cell) use ($State) {
return Parsedown::inlines($cell, $State);
},
$this->headerCells
);
}
/** @return list<Inline[]>[] */
public function rows(State $State)
{
return \array_map(
/**
* @param list<string> $cells
* @return list<Inline[]>
*/
function ($cells) use ($State) {
return \array_map(
/**
* @param string $cell
* @return Inline[]
*/
function ($cell) use ($State) {
return Parsedown::inlines($cell, $State);
},
$cells
);
},
$this->rows
);
}
/** @return list<_Alignment|null> */
public function alignments()
{
return $this->alignments;
}
/**
* @return Handler<Element>
*/
public function stateRenderable()
{
return new Handler(
/** @return Element */
function (State $State) {
return new Element('table', [], [
new Element('thead', [], [new Element('tr', [], \array_map(
/**
* @param Inline[] $Cell
* @param _Alignment|null $alignment
* @return Element
*/
function ($Cell, $alignment) use ($State) {
return new Element(
'th',
isset($alignment) ? ['style' => "text-align: $alignment;"] : [],
$State->applyTo(Parsedown::stateRenderablesFrom($Cell))
);
},
$this->headerRow($State),
$this->alignments()
))]),
new Element('tbody', [], \array_map(
/**
* @param Inline[][] $Cells
* @return Element
*/
function ($Cells) use ($State) {
return new Element('tr', [], \array_map(
/**
* @param Inline[] $Cell
* @param _Alignment|null $alignment
* @return Element
*/
function ($Cell, $alignment) use ($State) {
return new Element(
'td',
isset($alignment) ? ['style' => "text-align: $alignment;"] : [],
$State->applyTo(Parsedown::stateRenderablesFrom($Cell))
);
},
$Cells,
\array_slice($this->alignments(), 0, \count($Cells))
));
},
$this->rows($State)
))
]);
}
);
}
}

View File

@ -0,0 +1,16 @@
<?php
namespace Erusev\Parsedown\Components;
use Erusev\Parsedown\Parsing\Context;
use Erusev\Parsedown\State;
interface ContinuableBlock extends Block
{
/**
* @param Context $Context
* @param State $State
* @return static|null
*/
public function advance(Context $Context, State $State);
}

29
src/Components/Inline.php Normal file
View File

@ -0,0 +1,29 @@
<?php
namespace Erusev\Parsedown\Components;
use Erusev\Parsedown\Component;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
interface Inline extends Component
{
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State);
/**
* Number of characters consumed by the build action.
* @return int
* */
public function width();
/**
* @return Text
*/
public function bestPlaintext();
}

View File

@ -0,0 +1,82 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class Code implements Inline
{
use WidthTrait;
/** @var string */
private $text;
/**
* @param string $text
* @param int $width
*/
private function __construct($text, $width)
{
$this->text = $text;
$this->width = $width;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
$marker = \substr($Excerpt->text(), 0, 1);
if ($marker !== '`') {
return null;
}
if (\preg_match(
'/^(['.$marker.']++)(.*?)(?<!['.$marker.'])\1(?!'.$marker.')/s',
$Excerpt->text(),
$matches
)) {
$text = \str_replace("\n", ' ', $matches[2]);
$firstChar = \substr($text, 0, 1);
$lastChar = \substr($text, -1);
if ($firstChar === ' ' && $lastChar === ' ') {
$text = \substr(\substr($text, 1), 0, -1);
}
return new self($text, \strlen($matches[0]));
}
return null;
}
/** @return string */
public function text()
{
return $this->text;
}
/**
* @return Element
*/
public function stateRenderable()
{
return new Element('code', [], [new Text($this->text())]);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text($this->text());
}
}

View File

@ -0,0 +1,83 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class Email implements Inline
{
use WidthTrait;
/** @var string */
private $text;
/** @var string */
private $url;
/**
* @param string $text
* @param string $url
* @param int $width
*/
private function __construct($text, $url, $width)
{
$this->text = $text;
$this->url = $url;
$this->width = $width;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
$hostnameLabel = '[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?';
$commonMarkEmail = '[a-zA-Z0-9.!#$%&\'*+\/=?^_`{|}~-]++@'
. $hostnameLabel . '(?:\.' . $hostnameLabel . ')*';
if (\preg_match("/^<((mailto:)?$commonMarkEmail)>/i", $Excerpt->text(), $matches)) {
$url = $matches[1];
if (! isset($matches[2])) {
$url = "mailto:$url";
}
return new self($matches[1], $url, \strlen($matches[0]));
}
}
/** @return string */
public function text()
{
return $this->text;
}
/** @return string */
public function url()
{
return $this->url;
}
/**
* @return Element
*/
public function stateRenderable()
{
return new Element('a', ['href' => $this->url()], [new Text($this->text())]);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text($this->text());
}
}

View File

@ -0,0 +1,99 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class Emphasis implements Inline
{
use WidthTrait;
/** @var string */
private $text;
/** @var 'em'|'strong' */
private $type;
private const STRONG_REGEX = [
'*' => '/^[*]{2}((?:\\\\\*|[^*]|[*][^*]*+[*])+?)[*]{2}(?![*])/s',
'_' => '/^__((?:\\\\_|[^_]|_[^_]*+_)+?)__(?!_)/us',
];
private const EM_REGEX = [
'*' => '/^[*]((?:\\\\\*|[^*]|[*][*][^*]+?[*][*])+?)[*](?![*])/s',
'_' => '/^_((?:\\\\_|[^_]|__[^_]*__)+?)_(?!_)\b/us',
];
/**
* @param string $text
* @param 'em'|'strong' $type
* @param int $width
*/
private function __construct($text, $type, $width)
{
$this->text = $text;
$this->type = $type;
$this->width = $width;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
$marker = \substr($Excerpt->text(), 0, 1);
if ($marker !== '*' && $marker !== '_') {
return null;
}
if (\preg_match(self::STRONG_REGEX[$marker], $Excerpt->text(), $matches)) {
$emphasis = 'strong';
} elseif (\preg_match(self::EM_REGEX[$marker], $Excerpt->text(), $matches)) {
$emphasis = 'em';
} else {
return null;
}
return new self($matches[1], $emphasis, \strlen($matches[0]));
}
/** @return string */
public function text()
{
return $this->text;
}
/**
* @return Handler<Element>
*/
public function stateRenderable()
{
return new Handler(
/** @return Element */
function (State $State) {
return new Element(
$this->type,
[],
$State->applyTo(Parsedown::line($this->text(), $State))
);
}
);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text($this->text());
}
}

View File

@ -0,0 +1,65 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class EscapeSequence implements Inline
{
use WidthTrait;
const SPECIALS = '!"#$%&\'()*+,-./:;<=>?@[\]^_`{|}~';
/** @var string */
private $text;
/**
* @param string $text
*/
private function __construct($text)
{
$this->text = $text;
$this->width = 2;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
$char = \substr($Excerpt->text(), 1, 1);
if ($char !== '' && \strpbrk($char, self::SPECIALS) !== false) {
return new self($char);
}
return null;
}
/** @return string */
public function char()
{
return $this->text;
}
/**
* @return Text
*/
public function stateRenderable()
{
return new Text($this->char());
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text($this->char());
}
}

View File

@ -0,0 +1,87 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\Components\BacktrackingInline;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class HardBreak implements BacktrackingInline
{
use WidthTrait;
/** @var int */
private $position;
/**
* @param int $width
* @param int $position
*/
private function __construct($width, $position)
{
$this->width = $width;
$this->position = $position;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
$marker = \substr($Excerpt->text(), 0, 1);
if ($marker !== "\n") {
return null;
}
$context = $Excerpt->context();
$offset = $Excerpt->offset();
if (\substr($context, $offset -1, 1) === '\\') {
$contentLen = $offset -1;
return new self($offset - $contentLen, $contentLen);
}
if (\substr($context, $offset -2, 2) === ' ') {
$trimTrailingWhitespace = \rtrim(\substr($context, 0, $offset));
$contentLen = \strlen($trimTrailingWhitespace);
return new self($offset - $contentLen, $contentLen);
}
return null;
}
/**
* Return an integer to declare that the inline should be treated as if it
* started from that position in the excerpt given to static::build.
* Return null to use the excerpt offset value.
* @return int|null
* */
public function modifyStartPositionTo()
{
return $this->position;
}
/**
* @return Element
*/
public function stateRenderable()
{
return Element::selfClosing('br', []);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text("\n");
}
}

View File

@ -0,0 +1,120 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Configurables\SafeMode;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Html\Sanitisation\UrlSanitiser;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
/** @psalm-type _Metadata=array{href: string, title?: string} */
final class Image implements Inline
{
use WidthTrait;
/** @var Link */
private $Link;
/**
* @param Link $Link
*/
private function __construct(Link $Link)
{
$this->Link = $Link;
$this->width = $Link->width() + 1;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
if (\substr($Excerpt->text(), 0, 1) !== '!') {
return null;
}
$Excerpt = $Excerpt->addingToOffset(1);
$Link = Link::build($Excerpt, $State);
if (! isset($Link)) {
return null;
}
return new self($Link);
}
/** @return string */
public function label()
{
return $this->Link->label();
}
/** @return string */
public function url()
{
return $this->Link->url();
}
/** @return string|null */
public function title()
{
return $this->Link->title();
}
/**
* @return Handler<Element>
*/
public function stateRenderable()
{
return new Handler(
/** @return Element */
function (State $State) {
$attributes = [
'src' => $this->url(),
'alt' => \array_reduce(
Parsedown::inlines($this->label(), $State),
/**
* @param string $text
* @return string
*/
function ($text, Inline $Inline) {
return (
$text
. $Inline->bestPlaintext()->getStringBacking()
);
},
''
),
];
$title = $this->title();
if (isset($title)) {
$attributes['title'] = $title;
}
if ($State->get(SafeMode::class)->isEnabled()) {
$attributes['src'] = UrlSanitiser::filter($attributes['src']);
}
return Element::selfClosing('img', $attributes);
}
);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text($this->label());
}
}

View File

@ -0,0 +1,154 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Configurables\DefinitionBook;
use Erusev\Parsedown\Configurables\InlineTypes;
use Erusev\Parsedown\Configurables\SafeMode;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Html\Sanitisation\UrlSanitiser;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
/** @psalm-type _Metadata=array{href: string, title?: string} */
final class Link implements Inline
{
use WidthTrait;
/** @var string */
private $label;
/** @var string */
private $url;
/** @var string|null */
private $title;
/**
* @param string $label
* @param string $url
* @param string|null $title
* @param int $width
*/
private function __construct($label, $url, $title, $width)
{
$this->label = $label;
$this->url = $url;
$this->title = $title;
$this->width = $width;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
$remainder = $Excerpt->text();
if (! \preg_match('/\[((?:[^][]++|(?R))*+)\]/', $remainder, $matches)) {
return null;
}
$label = $matches[1];
$width = \strlen($matches[0]);
$remainder = \substr($remainder, $width);
if (\preg_match('/^[(]\s*+(?:((?:[^ ()]++|[(][^ )]+[)])++)(?:[ ]+("[^"]*+"|\'[^\']*+\'))?\s*+)?[)]/', $remainder, $matches)) {
$url = isset($matches[1]) ? $matches[1] : '';
$title = isset($matches[2]) ? \substr($matches[2], 1, - 1) : null;
$width += \strlen($matches[0]);
return new self($label, $url, $title, $width);
} else {
if (\preg_match('/^\s*\[(.*?)\]/', $remainder, $matches)) {
$definition = \strlen($matches[1]) ? $matches[1] : $label;
$definition = \strtolower($definition);
$width += \strlen($matches[0]);
} else {
$definition = \strtolower($label);
}
$definition = \preg_replace('/\s++/', ' ', \trim($definition));
$data = $State->get(DefinitionBook::class)->lookup($definition);
if (! isset($data)) {
return null;
}
$url = $data['url'];
$title = isset($data['title']) ? $data['title'] : null;
return new self($label, $url, $title, $width);
}
}
/** @return string */
public function label()
{
return $this->label;
}
/** @return string */
public function url()
{
return $this->url;
}
/** @return string|null */
public function title()
{
return $this->title;
}
/**
* @return Handler<Element>
*/
public function stateRenderable()
{
return new Handler(
/** @return Element */
function (State $State) {
$attributes = ['href' => $this->url()];
$title = $this->title();
if (isset($title)) {
$attributes['title'] = $title;
}
if ($State->get(SafeMode::class)->isEnabled()) {
$attributes['href'] = UrlSanitiser::filter($attributes['href']);
}
$State = $State->setting(
$State->get(InlineTypes::class)->removing([Url::class])
);
return new Element(
'a',
$attributes,
$State->applyTo(Parsedown::line($this->label(), $State))
);
}
);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text($this->label());
}
}

View File

@ -0,0 +1,83 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Configurables\SafeMode;
use Erusev\Parsedown\Html\Renderables\RawHtml;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class Markup implements Inline
{
use WidthTrait;
const HTML_ATT_REGEX = '[a-zA-Z_:][\w:.-]*+(?:\s*+=\s*+(?:[^"\'=<>`\s]+|"[^"]*+"|\'[^\']*+\'))?+';
/** @var string */
private $html;
/**
* @param string $html
*/
private function __construct($html)
{
$this->html = $html;
$this->width = \strlen($html);
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
$secondChar = \substr($Excerpt->text(), 1, 1);
if ($secondChar === '/' && \preg_match('/^<\/\w[\w-]*+[ ]*+>/s', $Excerpt->text(), $matches)) {
return new self($matches[0]);
}
if ($secondChar === '!' && \preg_match('/^<!---?[^>-](?:-?+[^-])*-->/s', $Excerpt->text(), $matches)) {
return new self($matches[0]);
}
if ($secondChar !== ' ' && \preg_match('/^<\w[\w-]*+(?:[ ]*+'.self::HTML_ATT_REGEX.')*+[ ]*+\/?>/s', $Excerpt->text(), $matches)) {
return new self($matches[0]);
}
}
/** @return string */
public function html()
{
return $this->html;
}
/**
* @return Handler<Text|RawHtml>
*/
public function stateRenderable()
{
return new Handler(
/** @return Text|RawHtml */
function (State $State) {
if ($State->get(SafeMode::class)->isEnabled()) {
return new Text($this->html());
} else {
return new RawHtml($this->html());
}
}
);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text($this->html());
}
}

View File

@ -0,0 +1,57 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class PlainText implements Inline
{
use WidthTrait;
/** @var string */
private $text;
/**
* @param string $text
*/
private function __construct($text)
{
$this->text = $text;
$this->width = \strlen($text);
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static
*/
public static function build(Excerpt $Excerpt, State $State)
{
return new self($Excerpt->text());
}
/** @return string */
public function text()
{
return $this->text;
}
/**
* @return Text
*/
public function stateRenderable()
{
return new Text($this->text());
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text($this->text());
}
}

View File

@ -0,0 +1,97 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\BacktrackingInline;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Configurables\Breaks;
use Erusev\Parsedown\Html\Renderables\Container;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class SoftBreak implements BacktrackingInline
{
use WidthTrait;
/** @var int */
private $position;
/**
* @param int $width
* @param int $position
*/
private function __construct($width, $position)
{
$this->width = $width;
$this->position = $position;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
$marker = \substr($Excerpt->text(), 0, 1);
if ($marker !== "\n") {
return null;
}
$context = $Excerpt->context();
$offset = $Excerpt->offset();
$trimTrailingWhitespaceBefore = \rtrim(\substr($context, 0, $offset), ' ');
$trimLeadingWhitespaceAfter = \ltrim(\substr($context, $offset + 1), ' ');
$contentLenBefore = \strlen($trimTrailingWhitespaceBefore);
$contentLenAfter = \strlen($trimLeadingWhitespaceAfter);
$originalLen = \strlen($context);
$afterWidth = $originalLen - $offset - $contentLenAfter;
return new self($offset + $afterWidth - $contentLenBefore, $contentLenBefore);
}
/**
* Return an integer to declare that the inline should be treated as if it
* started from that position in the excerpt given to static::build.
* Return null to use the excerpt offset value.
* @return int|null
* */
public function modifyStartPositionTo()
{
return $this->position;
}
/**
* @return Handler<Text|Container>
*/
public function stateRenderable()
{
return new Handler(
/** @return Text|Container */
function (State $State) {
if ($State->get(Breaks::class)->isEnabled()) {
return new Container([
Element::selfClosing('br', []),
new Text("\n")
]);
}
return new Text("\n");
}
);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text("\n");
}
}

View File

@ -0,0 +1,64 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Html\Renderables\RawHtml;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class SpecialCharacter implements Inline
{
use WidthTrait;
/** @var string */
private $charCodeHtml;
/**
* @param string $charCodeHtml
*/
private function __construct($charCodeHtml)
{
$this->charCodeHtml = $charCodeHtml;
$this->width = \strlen($charCodeHtml) + 2;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
if (\preg_match('/^&(#?+[0-9a-zA-Z]++);/', $Excerpt->text(), $matches)) {
return new self($matches[1]);
}
return null;
}
/** @return string */
public function charCode()
{
return $this->charCodeHtml;
}
/**
* @return RawHtml
*/
public function stateRenderable()
{
return new RawHtml(
'&' . (new Text($this->charCode()))->getHtml() . ';'
);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text('&'.$this->charCode().';');
}
}

View File

@ -0,0 +1,76 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\AST\Handler;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class Strikethrough implements Inline
{
use WidthTrait;
/** @var string */
private $text;
/**
* @param string $text
* @param int $width
*/
private function __construct($text, $width)
{
$this->text = $text;
$this->width = $width;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
$text = $Excerpt->text();
if (\preg_match('/^~~(?=\S)(.+?)(?<=\S)~~/', $text, $matches)) {
return new self($matches[1], \strlen($matches[0]));
}
return null;
}
/** @return string */
public function text()
{
return $this->text;
}
/**
* @return Handler<Element>
*/
public function stateRenderable()
{
return new Handler(
/** @return Element */
function (State $State) {
return new Element(
'del',
[],
$State->applyTo(Parsedown::line($this->text(), $State))
);
}
);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text($this->text());
}
}

View File

@ -0,0 +1,105 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\Components\BacktrackingInline;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class Url implements BacktrackingInline
{
use WidthTrait;
private const URI = 'https?+:[^\s[:cntrl:]<>]*';
private const NO_TRAILING_PUNCT = '(?<![?!.,:*_~])';
/** @var string */
private $url;
/** @var int */
private $position;
/**
* @param string $url
* @param int $position
*/
private function __construct($url, $position)
{
$this->url = $url;
$this->width = \strlen($url);
$this->position = $position;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
// this needs some work to follow spec
if (
\preg_match(
'/'.self::URI.self::NO_TRAILING_PUNCT.'/iu',
$Excerpt->context(),
$matches,
\PREG_OFFSET_CAPTURE
)
) {
/** @var array{0: array{string, int}} $matches */
$url = $matches[0][0];
$position = \intval($matches[0][1]);
if (\preg_match('/[)]++$/', $url, $matches)) {
$trailingParens = \strlen($matches[0]);
$openingParens = \substr_count($url, '(');
$closingParens = \substr_count($url, ')');
if ($closingParens > $openingParens) {
$url = \substr($url, 0, -\min($trailingParens, $closingParens - $openingParens));
}
}
return new self($url, $position);
}
return null;
}
/**
* Return an integer to declare that the inline should be treated as if it
* started from that position in the excerpt given to static::build.
* Return null to use the excerpt offset value.
* @return int|null
* */
public function modifyStartPositionTo()
{
return $this->position;
}
/** @return string */
public function url()
{
return $this->url;
}
/**
* @return Element
*/
public function stateRenderable()
{
return new Element('a', ['href' => $this->url()], [new Text($this->url())]);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text($this->url());
}
}

View File

@ -0,0 +1,63 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Html\Renderables\Element;
use Erusev\Parsedown\Html\Renderables\Text;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\State;
final class UrlTag implements Inline
{
use WidthTrait;
/** @var string */
private $url;
/**
* @param string $url
* @param int $width
*/
private function __construct($url, $width)
{
$this->url = $url;
$this->width = $width;
}
/**
* @param Excerpt $Excerpt
* @param State $State
* @return static|null
*/
public static function build(Excerpt $Excerpt, State $State)
{
if (\preg_match('/^<(\w++:\/{2}[^ >]++)>/i', $Excerpt->text(), $matches)) {
return new self($matches[1], \strlen($matches[0]));
}
return null;
}
/** @return string */
public function url()
{
return $this->url;
}
/**
* @return Element
*/
public function stateRenderable()
{
return new Element('a', ['href' => $this->url()], [new Text($this->url())]);
}
/**
* @return Text
*/
public function bestPlaintext()
{
return new Text($this->url);
}
}

View File

@ -0,0 +1,15 @@
<?php
namespace Erusev\Parsedown\Components\Inlines;
trait WidthTrait
{
/** @var int */
private $width;
/** @return int */
public function width()
{
return $this->width;
}
}

View File

@ -0,0 +1,11 @@
<?php
namespace Erusev\Parsedown\Components;
use Erusev\Parsedown\State;
interface StateUpdatingBlock extends Block
{
/** @return State */
public function latestState();
}

9
src/Configurable.php Normal file
View File

@ -0,0 +1,9 @@
<?php
namespace Erusev\Parsedown;
interface Configurable
{
/** @return static */
public static function initial();
}

View File

@ -0,0 +1,231 @@
<?php
namespace Erusev\Parsedown\Configurables;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Components\Blocks\BlockQuote;
use Erusev\Parsedown\Components\Blocks\FencedCode;
use Erusev\Parsedown\Components\Blocks\Header;
use Erusev\Parsedown\Components\Blocks\IndentedCode;
use Erusev\Parsedown\Components\Blocks\Markup as BlockMarkup;
use Erusev\Parsedown\Components\Blocks\Reference;
use Erusev\Parsedown\Components\Blocks\Rule;
use Erusev\Parsedown\Components\Blocks\SetextHeader;
use Erusev\Parsedown\Components\Blocks\Table;
use Erusev\Parsedown\Components\Blocks\TList;
use Erusev\Parsedown\Configurable;
final class BlockTypes implements Configurable
{
private const DEFAULT_BLOCK_TYPES = [
'#' => [Header::class],
'*' => [Rule::class, TList::class],
'+' => [TList::class],
'-' => [SetextHeader::class, Table::class, Rule::class, TList::class],
'0' => [TList::class],
'1' => [TList::class],
'2' => [TList::class],
'3' => [TList::class],
'4' => [TList::class],
'5' => [TList::class],
'6' => [TList::class],
'7' => [TList::class],
'8' => [TList::class],
'9' => [TList::class],
':' => [Table::class],
'<' => [BlockMarkup::class],
'=' => [SetextHeader::class],
'>' => [BlockQuote::class],
'[' => [Reference::class],
'_' => [Rule::class],
'`' => [FencedCode::class],
'|' => [Table::class],
'~' => [FencedCode::class],
];
private const DEFAULT_UNMARKED_BLOCK_TYPES = [
IndentedCode::class,
];
/** @var array<array-key, list<class-string<Block>>> */
private $blockTypes;
/** @var list<class-string<Block>> */
private $unmarkedBlockTypes;
/**
* @param array<array-key, list<class-string<Block>>> $blockTypes
* @param list<class-string<Block>> $unmarkedBlockTypes
*/
public function __construct(array $blockTypes, array $unmarkedBlockTypes)
{
$this->blockTypes = $blockTypes;
$this->unmarkedBlockTypes = $unmarkedBlockTypes;
}
/** @return self */
public static function initial()
{
return new self(
self::DEFAULT_BLOCK_TYPES,
self::DEFAULT_UNMARKED_BLOCK_TYPES
);
}
/**
* @param string $marker
* @param list<class-string<Block>> $newBlockTypes
* @return self
*/
public function settingMarked($marker, array $newBlockTypes)
{
$blockTypes = $this->blockTypes;
$blockTypes[$marker] = $newBlockTypes;
return new self($blockTypes, $this->unmarkedBlockTypes);
}
/**
* @param string $marker
* @param list<class-string<Block>> $newBlockTypes
* @return self
*/
public function addingMarkedHighPrecedence($marker, array $newBlockTypes)
{
return $this->settingMarked(
$marker,
\array_merge(
$newBlockTypes,
isset($this->blockTypes[$marker]) ? $this->blockTypes[$marker] : []
)
);
}
/**
* @param class-string<Block> $searchBlockType
* @param class-string<Block> $replacementBlockType
*/
public function replacing($searchBlockType, $replacementBlockType): self
{
$replacer = self::makeReplacer($searchBlockType, $replacementBlockType);
return new self(
\array_map($replacer, $this->blockTypes),
$replacer($this->unmarkedBlockTypes)
);
}
/**
* @param class-string<Block> $searchBlockType
* @param class-string<Block> $replacementBlockType
* @return \Closure(list<class-string<Block>>):list<class-string<Block>>
*/
private static function makeReplacer($searchBlockType, $replacementBlockType)
{
/**
* @param list<class-string<Block>> $blockTypes
* @return list<class-string<Block>>
*/
return function ($blockTypes) use ($searchBlockType, $replacementBlockType) {
return \array_map(
/**
* @param class-string<Block> $blockType
* @return class-string<Block>
*/
function ($blockType) use ($searchBlockType, $replacementBlockType) {
return $blockType === $searchBlockType ? $replacementBlockType : $blockType;
},
$blockTypes
);
};
}
/**
* @param string $marker
* @param list<class-string<Block>> $newBlockTypes
* @return self
*/
public function addingMarkedLowPrecedence($marker, array $newBlockTypes)
{
return $this->settingMarked(
$marker,
\array_merge(
isset($this->blockTypes[$marker]) ? $this->blockTypes[$marker] : [],
$newBlockTypes
)
);
}
/**
* @param list<class-string<Block>> $newUnmarkedBlockTypes
* @return self
*/
public function settingUnmarked(array $newUnmarkedBlockTypes)
{
return new self($this->blockTypes, $newUnmarkedBlockTypes);
}
/**
* @param list<class-string<Block>> $newBlockTypes
* @return self
*/
public function addingUnmarkedHighPrecedence(array $newBlockTypes)
{
return $this->settingUnmarked(
\array_merge($newBlockTypes, $this->unmarkedBlockTypes)
);
}
/**
* @param list<class-string<Block>> $newBlockTypes
* @return self
*/
public function addingUnmarkedLowPrecedence(array $newBlockTypes)
{
return $this->settingUnmarked(
\array_merge($this->unmarkedBlockTypes, $newBlockTypes)
);
}
/**
* @param list<class-string<Block>> $removeBlockTypes
* @return self
*/
public function removing(array $removeBlockTypes)
{
return new self(
\array_map(
/**
* @param list<class-string<Block>> $blockTypes
* @return list<class-string<Block>>
*/
function ($blockTypes) use ($removeBlockTypes) {
return \array_values(\array_diff($blockTypes, $removeBlockTypes));
},
$this->blockTypes
),
\array_values(\array_diff($this->unmarkedBlockTypes, $removeBlockTypes))
);
}
/**
* @param string $marker
* @return list<class-string<Block>>
*/
public function markedBy($marker)
{
if (isset($this->blockTypes[$marker])) {
return $this->blockTypes[$marker];
}
return [];
}
/**
* @return list<class-string<Block>>
*/
public function unmarked()
{
return $this->unmarkedBlockTypes;
}
}

View File

@ -0,0 +1,35 @@
<?php
namespace Erusev\Parsedown\Configurables;
trait BooleanConfigurable
{
/** @var bool */
private $enabled = false;
/**
* @param bool $enabled
*/
public function __construct($enabled)
{
$this->enabled = $enabled;
}
/** @return bool */
public function isEnabled()
{
return $this->enabled;
}
/** @return static */
public static function enabled()
{
return new self(true);
}
/** @return static */
public static function initial()
{
return new self(false);
}
}

View File

@ -0,0 +1,10 @@
<?php
namespace Erusev\Parsedown\Configurables;
use Erusev\Parsedown\Configurable;
final class Breaks implements Configurable
{
use BooleanConfigurable;
}

View File

@ -0,0 +1,56 @@
<?php
namespace Erusev\Parsedown\Configurables;
use Erusev\Parsedown\MutableConfigurable;
/**
* @psalm-type _Data=array{url: string, title: string|null}
*/
final class DefinitionBook implements MutableConfigurable
{
/** @var array<string, _Data> */
private $book;
/**
* @param array<string, _Data> $book
*/
public function __construct(array $book = [])
{
$this->book = $book;
}
/** @return self */
public static function initial()
{
return new self;
}
/**
* @param string $id
* @param _Data $data
*/
public function mutatingSet($id, array $data): void
{
$this->book[$id] = $data;
}
/**
* @param string $id
* @return _Data|null
*/
public function lookup($id)
{
if (isset($this->book[$id])) {
return $this->book[$id];
}
return null;
}
/** @return static */
public function isolatedCopy(): self
{
return new self($this->book);
}
}

View File

@ -0,0 +1,100 @@
<?php
namespace Erusev\Parsedown\Configurables;
use Erusev\Parsedown\Configurable;
final class HeaderSlug implements Configurable
{
/** @var bool */
private $enabled = false;
/** @var \Closure(string):string */
private $slugCallback;
/** @var \Closure(string,int):string */
private $duplicationCallback;
/**
* @param bool $enabled
* @param (\Closure(string):string)|null $slugCallback
* @param (\Closure(string, int):string)|null $duplicationCallback
*/
public function __construct(
$enabled,
$slugCallback = null,
$duplicationCallback = null
) {
$this->enabled = $enabled;
if (! isset($slugCallback)) {
$this->slugCallback = function (string $text): string {
$slug = \mb_strtolower($text);
$slug = \str_replace(' ', '-', $slug);
$slug = \preg_replace('/[^\p{L}\p{Nd}\p{Nl}\p{M}-]+/u', '', $slug);
$slug = \trim($slug, '-');
return $slug;
};
} else {
$this->slugCallback = $slugCallback;
}
if (! isset($duplicationCallback)) {
$this->duplicationCallback = function (string $slug, int $duplicateNumber): string {
return $slug . '-' . \strval($duplicateNumber-1);
};
} else {
$this->duplicationCallback = $duplicationCallback;
}
}
/** @return bool */
public function isEnabled()
{
return $this->enabled;
}
public function transform(SlugRegister $SlugRegister, string $text): string
{
$slug = ($this->slugCallback)($text);
if ($SlugRegister->slugCount($slug) > 0) {
$newSlug = ($this->duplicationCallback)($slug, $SlugRegister->mutatingIncrement($slug));
while ($SlugRegister->slugCount($newSlug) > 0) {
$newSlug = ($this->duplicationCallback)($slug, $SlugRegister->mutatingIncrement($slug));
}
return $newSlug;
}
$SlugRegister->mutatingIncrement($slug);
return $slug;
}
/** @param \Closure(string):string $slugCallback */
public static function withCallback($slugCallback): self
{
return new self(true, $slugCallback);
}
/** @param \Closure(string,int):string $duplicationCallback */
public static function withDuplicationCallback($duplicationCallback): self
{
return new self(true, null, $duplicationCallback);
}
/** @return self */
public static function enabled()
{
return new self(true);
}
/** @return self */
public static function initial()
{
return new self(false);
}
}

View File

@ -0,0 +1,168 @@
<?php
namespace Erusev\Parsedown\Configurables;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Components\Inlines\Code;
use Erusev\Parsedown\Components\Inlines\Email;
use Erusev\Parsedown\Components\Inlines\Emphasis;
use Erusev\Parsedown\Components\Inlines\EscapeSequence;
use Erusev\Parsedown\Components\Inlines\HardBreak;
use Erusev\Parsedown\Components\Inlines\Image;
use Erusev\Parsedown\Components\Inlines\Link;
use Erusev\Parsedown\Components\Inlines\Markup as InlineMarkup;
use Erusev\Parsedown\Components\Inlines\SoftBreak;
use Erusev\Parsedown\Components\Inlines\SpecialCharacter;
use Erusev\Parsedown\Components\Inlines\Strikethrough;
use Erusev\Parsedown\Components\Inlines\Url;
use Erusev\Parsedown\Components\Inlines\UrlTag;
use Erusev\Parsedown\Configurable;
final class InlineTypes implements Configurable
{
private const DEFAULT_INLINE_TYPES = [
'!' => [Image::class],
'*' => [Emphasis::class],
'_' => [Emphasis::class],
'&' => [SpecialCharacter::class],
'[' => [Link::class],
':' => [Url::class],
'<' => [UrlTag::class, Email::class, InlineMarkup::class],
'`' => [Code::class],
'~' => [Strikethrough::class],
'\\' => [EscapeSequence::class],
"\n" => [HardBreak::class, SoftBreak::class],
];
/** @var array<array-key, list<class-string<Inline>>> */
private $inlineTypes;
/** @var string */
private $inlineMarkers;
/**
* @param array<array-key, list<class-string<Inline>>> $inlineTypes
*/
public function __construct(array $inlineTypes)
{
$this->inlineTypes = $inlineTypes;
$this->inlineMarkers = \implode('', \array_keys($inlineTypes));
}
/** @return self */
public static function initial()
{
return new self(self::DEFAULT_INLINE_TYPES);
}
/**
* @param string $marker
* @param list<class-string<Inline>> $newInlineTypes
* @return self
*/
public function setting($marker, array $newInlineTypes)
{
$inlineTypes = $this->inlineTypes;
$inlineTypes[$marker] = $newInlineTypes;
return new self($inlineTypes);
}
/**
* @param class-string<Inline> $searchInlineType
* @param class-string<Inline> $replacementInlineType
*/
public function replacing($searchInlineType, $replacementInlineType): self
{
return new self(
\array_map(
/**
* @param list<class-string<Inline>> $inlineTypes
* @return list<class-string<Inline>>
*/
function ($inlineTypes) use ($searchInlineType, $replacementInlineType) {
return \array_map(
/**
* @param class-string<Inline> $inlineType
* @return class-string<Inline>
*/
function ($inlineType) use ($searchInlineType, $replacementInlineType) {
return $inlineType === $searchInlineType ? $replacementInlineType : $inlineType;
},
$inlineTypes
);
},
$this->inlineTypes
)
);
}
/**
* @param string $marker
* @param list<class-string<Inline>> $newInlineTypes
* @return self
*/
public function addingHighPrecedence($marker, array $newInlineTypes)
{
return $this->setting(
$marker,
\array_merge(
$newInlineTypes,
isset($this->inlineTypes[$marker]) ? $this->inlineTypes[$marker] : []
)
);
}
/**
* @param string $marker
* @param list<class-string<Inline>> $newInlineTypes
* @return self
*/
public function addingLowPrecedence($marker, array $newInlineTypes)
{
return $this->setting(
$marker,
\array_merge(
isset($this->inlineTypes[$marker]) ? $this->inlineTypes[$marker] : [],
$newInlineTypes
)
);
}
/**
* @param list<class-string<Inline>> $removeInlineTypes
* @return self
*/
public function removing(array $removeInlineTypes)
{
return new self(\array_map(
/**
* @param list<class-string<Inline>> $inlineTypes
* @return list<class-string<Inline>>
*/
function ($inlineTypes) use ($removeInlineTypes) {
return \array_values(\array_diff($inlineTypes, $removeInlineTypes));
},
$this->inlineTypes
));
}
/**
* @param string $marker
* @return list<class-string<Inline>>
*/
public function markedBy($marker)
{
if (isset($this->inlineTypes[$marker])) {
return $this->inlineTypes[$marker];
}
return [];
}
/** @return string */
public function markers()
{
return $this->inlineMarkers;
}
}

View File

@ -0,0 +1,51 @@
<?php
namespace Erusev\Parsedown\Configurables;
use Erusev\Parsedown\Configurable;
final class RecursionLimiter implements Configurable
{
/** @var int */
private $maxDepth;
/** @var int */
private $currentDepth;
/**
* @param int $maxDepth
* @param int $currentDepth
*/
private function __construct($maxDepth, $currentDepth)
{
$this->maxDepth = $maxDepth;
$this->currentDepth = $currentDepth;
}
/** @return self */
public static function initial()
{
return self::maxDepth(256);
}
/**
* @param int $maxDepth
* @return self
*/
public static function maxDepth($maxDepth)
{
return new self($maxDepth, 0);
}
/** @return self */
public function incremented()
{
return new self($this->maxDepth, $this->currentDepth + 1);
}
/** @return bool */
public function isDepthExceeded()
{
return ($this->maxDepth < $this->currentDepth);
}
}

View File

@ -0,0 +1,42 @@
<?php
namespace Erusev\Parsedown\Configurables;
use Erusev\Parsedown\Configurable;
use Erusev\Parsedown\Html\Renderable;
use Erusev\Parsedown\State;
final class RenderStack implements Configurable
{
/** @var list<\Closure(Renderable[],State):Renderable[]> */
private $stack;
/**
* @param list<\Closure(Renderable[],State):Renderable[]> $stack
*/
private function __construct($stack = [])
{
$this->stack = $stack;
}
/** @return self */
public static function initial()
{
return new self;
}
/**
* @param \Closure(Renderable[],State):Renderable[] $RenderMap
* @return self
*/
public function push(\Closure $RenderMap): self
{
return new self(\array_merge($this->stack, [$RenderMap]));
}
/** @return list<\Closure(Renderable[],State):Renderable[]> */
public function getStack(): array
{
return $this->stack;
}
}

View File

@ -0,0 +1,10 @@
<?php
namespace Erusev\Parsedown\Configurables;
use Erusev\Parsedown\Configurable;
final class SafeMode implements Configurable
{
use BooleanConfigurable;
}

View File

@ -0,0 +1,45 @@
<?php
namespace Erusev\Parsedown\Configurables;
use Erusev\Parsedown\MutableConfigurable;
final class SlugRegister implements MutableConfigurable
{
/** @var array<string, int> */
private $register;
/**
* @param array<string, int> $register
*/
public function __construct(array $register = [])
{
$this->register = $register;
}
/** @return self */
public static function initial()
{
return new self;
}
public function mutatingIncrement(string $slug): int
{
if (! isset($this->register[$slug])) {
$this->register[$slug] = 0;
}
return ++$this->register[$slug];
}
public function slugCount(string $slug): int
{
return $this->register[$slug] ?? 0;
}
/** @return static */
public function isolatedCopy(): self
{
return new self($this->register);
}
}

View File

@ -0,0 +1,10 @@
<?php
namespace Erusev\Parsedown\Configurables;
use Erusev\Parsedown\Configurable;
final class StrictMode implements Configurable
{
use BooleanConfigurable;
}

11
src/Html/Renderable.php Normal file
View File

@ -0,0 +1,11 @@
<?php
namespace Erusev\Parsedown\Html;
use Erusev\Parsedown\AST\StateRenderable;
interface Renderable extends StateRenderable
{
/** @return string */
public function getHtml();
}

View File

@ -0,0 +1,17 @@
<?php
namespace Erusev\Parsedown\Html\Renderables;
use Erusev\Parsedown\Html\Renderable;
use Erusev\Parsedown\State;
trait CanonicalStateRenderable
{
/**
* @return Renderable
*/
public function renderable(State $State)
{
return $this;
}
}

View File

@ -0,0 +1,84 @@
<?php
namespace Erusev\Parsedown\Html\Renderables;
use Erusev\Parsedown\Html\Renderable;
use Erusev\Parsedown\Html\TransformableRenderable;
final class Container implements TransformableRenderable
{
use CanonicalStateRenderable;
/** @var Renderable[] */
private $Contents;
/**
* @param Renderable[] $Contents
*/
public function __construct($Contents = [])
{
$this->Contents = $Contents;
}
/**
* @return Renderable[]
*/
public function contents()
{
return $this->Contents;
}
public function adding(Renderable $Renderable): Container
{
return new Container(\array_merge($this->Contents, [$Renderable]));
}
/** @return string */
public function getHtml()
{
return \array_reduce(
$this->Contents,
/**
* @param string $html
* @param Renderable $Renderable
* @return string
*/
function ($html, Renderable $Renderable) {
return $html . $Renderable->getHtml();
},
''
);
}
/**
* @param \Closure(string):TransformableRenderable $Transform
* @return TransformableRenderable
*/
public function transformingContent(\Closure $Transform): TransformableRenderable
{
return new Container(\array_map(
function (Renderable $R) use ($Transform): Renderable {
if (! $R instanceof TransformableRenderable) {
return $R;
}
return $R->transformingContent($Transform);
},
$this->Contents
));
}
public function replacingAll(string $search, TransformableRenderable $Replacement): TransformableRenderable
{
return new Container(\array_map(
function (Renderable $R) use ($search, $Replacement): Renderable {
if (! $R instanceof TransformableRenderable) {
return $R;
}
return $R->replacingAll($search, $Replacement);
},
$this->Contents
));
}
}

View File

@ -0,0 +1,235 @@
<?php
namespace Erusev\Parsedown\Html\Renderables;
use Erusev\Parsedown\Html\Renderable;
use Erusev\Parsedown\Html\Sanitisation\CharacterFilter;
use Erusev\Parsedown\Html\Sanitisation\Escaper;
use Erusev\Parsedown\Html\TransformableRenderable;
final class Element implements TransformableRenderable
{
use CanonicalStateRenderable;
const TEXT_LEVEL_ELEMENTS = [
'a' => true,
'b' => true,
'i' => true,
'q' => true,
's' => true,
'u' => true,
'br' => true,
'em' => true,
'rp' => true,
'rt' => true,
'tt' => true,
'xm' => true,
'bdo' => true,
'big' => true,
'del' => true,
'img' => true,
'ins' => true,
'kbd' => true,
'sub' => true,
'sup' => true,
'var' => true,
'wbr' => true,
'abbr' => true,
'cite' => true,
'code' => true,
'font' => true,
'mark' => true,
'nobr' => true,
'ruby' => true,
'span' => true,
'time' => true,
'blink' => true,
'small' => true,
'nextid' => true,
'spacer' => true,
'strike' => true,
'strong' => true,
'acronym' => true,
'listing' => true,
'marquee' => true,
'basefont' => true,
];
/** @var string */
private $name;
/** @var array<string, string>*/
private $attributes;
/** @var Renderable[]|null */
private $Contents;
/**
* @param string $name
* @param array<string, string> $attributes
* @param Renderable[]|null $Contents
*/
public function __construct($name, $attributes, $Contents)
{
$this->name = $name;
$this->attributes = $attributes;
$this->Contents = $Contents;
}
/**
* @param string $name
* @param array<string, string> $attributes
* @return self
*/
public static function selfClosing($name, array $attributes)
{
return new self($name, $attributes, null);
}
/** @return string */
public function name()
{
return $this->name;
}
/**
* @return array<string, string>
*/
public function attributes()
{
return $this->attributes;
}
/**
* @return Renderable[]|null
*/
public function contents()
{
return $this->Contents;
}
/**
* @param string $name
* @return self
*/
public function settingName($name)
{
return new self($name, $this->attributes, $this->Contents);
}
/**
* @param array<string, string> $attributes
* @return self
*/
public function settingAttributes(array $attributes)
{
return new self($this->name, $attributes, $this->Contents);
}
/**
* @param Renderable[]|null $Contents
* @return self
*/
public function settingContents($Contents)
{
return new self($this->name, $this->attributes, $Contents);
}
/** @return string */
public function getHtml()
{
$elementName = CharacterFilter::htmlElementName($this->name);
$html = '<' . $elementName;
if (! empty($this->attributes)) {
foreach ($this->attributes as $name => $value) {
$html .= ' '
. CharacterFilter::htmlAttributeName($name)
. '="'
. Escaper::htmlAttributeValue($value)
. '"'
;
}
}
if ($this->Contents !== null) {
$html .= '>';
if (! empty($this->Contents)) {
foreach ($this->Contents as $C) {
if (
$C instanceof Element
&& ! \array_key_exists(\strtolower($C->name()), self::TEXT_LEVEL_ELEMENTS)
) {
$html .= "\n";
}
$html .= $C->getHtml();
}
$Last = \end($this->Contents);
if (
$Last instanceof Element
&& ! \array_key_exists(\strtolower($Last->name()), self::TEXT_LEVEL_ELEMENTS)
) {
$html .= "\n";
}
}
$html .= "</" . $elementName . ">";
} else {
$html .= ' />';
}
return $html;
}
/**
* @param \Closure(string):TransformableRenderable $Transform
* @return TransformableRenderable
*/
public function transformingContent(\Closure $Transform): TransformableRenderable
{
if (! isset($this->Contents)) {
return $this;
}
return new self($this->name, $this->attributes, \array_map(
function (Renderable $R) use ($Transform): Renderable {
if (! $R instanceof TransformableRenderable) {
return $R;
}
return $R->transformingContent($Transform);
},
$this->Contents
));
}
public function replacingAll(string $search, TransformableRenderable $Replacement): TransformableRenderable
{
if (! isset($this->Contents)) {
return $this;
}
return new self($this->name, $this->attributes, \array_map(
function (Renderable $R) use ($search, $Replacement): Renderable {
if (! $R instanceof TransformableRenderable) {
return $R;
}
return $R->replacingAll($search, $Replacement);
},
$this->Contents
));
}
}

View File

@ -0,0 +1,20 @@
<?php
namespace Erusev\Parsedown\Html\Renderables;
use Erusev\Parsedown\Html\Renderable;
final class Invisible implements Renderable
{
use CanonicalStateRenderable;
public function __construct()
{
}
/** @return string */
public function getHtml()
{
return '';
}
}

View File

@ -0,0 +1,27 @@
<?php
namespace Erusev\Parsedown\Html\Renderables;
use Erusev\Parsedown\Html\Renderable;
final class RawHtml implements Renderable
{
use CanonicalStateRenderable;
/** @var string */
private $html;
/**
* @param string $html
*/
public function __construct($html = '')
{
$this->html = $html;
}
/** @return string */
public function getHtml()
{
return $this->html;
}
}

View File

@ -0,0 +1,89 @@
<?php
namespace Erusev\Parsedown\Html\Renderables;
use Erusev\Parsedown\Html\Sanitisation\Escaper;
use Erusev\Parsedown\Html\TransformableRenderable;
final class Text implements TransformableRenderable
{
use CanonicalStateRenderable;
/** @var string */
private $text;
/**
* @param string $text
*/
public function __construct($text = '')
{
$this->text = $text;
}
/** @return string */
public function getStringBacking()
{
return $this->text;
}
/** @return string */
public function getHtml()
{
return Escaper::htmlElementValueEscapingDoubleQuotes($this->text);
}
/**
* @param \Closure(string):TransformableRenderable $Transform
* @return TransformableRenderable
*/
public function transformingContent(\Closure $Transform): TransformableRenderable
{
return $Transform($this->text);
}
public function replacingAll(string $search, TransformableRenderable $Replacement): TransformableRenderable
{
$searchLen = \strlen($search);
if ($searchLen < 1) {
return $this;
}
$result = \preg_match_all(
'/\b'.\preg_quote($search, '/').'\b/',
$this->text,
$matches,
\PREG_OFFSET_CAPTURE
);
if (empty($result)) {
return $this;
}
$lastEndPos = 0;
$Container = new Container;
foreach ($matches[0] as $match) {
$pos = $match[1];
$endPos = $pos + $searchLen;
if ($pos !== $lastEndPos) {
$Container = $Container->adding(
new Text(\substr($this->text, $lastEndPos, $pos - $lastEndPos))
);
}
$Container = $Container->adding($Replacement);
$lastEndPos = $endPos;
}
if (\strlen($this->text) !== $lastEndPos) {
$Container = $Container->adding(
new Text(\substr($this->text, $lastEndPos))
);
}
return $Container;
}
}

View File

@ -0,0 +1,44 @@
<?php
namespace Erusev\Parsedown\Html\Sanitisation;
final class CharacterFilter
{
/**
* @param string $text
* @return string
*/
public static function htmlAttributeName($text)
{
/**
* https://www.w3.org/TR/html/syntax.html#name
*
* Attribute names must consist of one or more characters other than
* the space characters, U+0000 NULL, U+0022 QUOTATION MARK ("),
* U+0027 APOSTROPHE ('), U+003E GREATER-THAN SIGN (>),
* U+002F SOLIDUS (/), and U+003D EQUALS SIGN (=) characters,
* the control characters, and any characters that are not defined by
* Unicode.
*/
return \preg_replace(
'/(?:[[:space:]\0"\'>\/=[:cntrl:]]|[^\pC\pL\pM\pN\pP\pS\pZ])++/iu',
'',
$text
);
}
/**
* @param string $text
* @return string
*/
public static function htmlElementName($text)
{
/**
* https://www.w3.org/TR/html/syntax.html#tag-name
*
* HTML elements all have names that only use alphanumeric
* ASCII characters.
*/
return \preg_replace('/[^[:alnum:]]/', '', $text);
}
}

View File

@ -0,0 +1,47 @@
<?php
namespace Erusev\Parsedown\Html\Sanitisation;
final class Escaper
{
/**
* @param string $text
* @return string
*/
public static function htmlAttributeValue($text)
{
return self::escape($text);
}
/**
* @param string $text
* @return string
*/
public static function htmlElementValue($text)
{
return self::escape($text, true);
}
/**
* @param string $text
* @return string
*/
public static function htmlElementValueEscapingDoubleQuotes($text)
{
return \htmlspecialchars($text, \ENT_COMPAT, 'UTF-8');
}
/**
* @param string $text
* @param bool $allowQuotes
* @return string
*/
private static function escape($text, $allowQuotes = false)
{
return \htmlspecialchars(
$text,
$allowQuotes ? \ENT_NOQUOTES : \ENT_QUOTES,
'UTF-8'
);
}
}

View File

@ -0,0 +1,58 @@
<?php
namespace Erusev\Parsedown\Html\Sanitisation;
final class UrlSanitiser
{
private const COMMON_SCHEMES = [
'http://',
'https://',
'ftp://',
'ftps://',
'mailto:',
'tel:',
'data:image/png;base64,',
'data:image/gif;base64,',
'data:image/jpeg;base64,',
'irc:',
'ircs:',
'git:',
'ssh:',
'news:',
'steam:',
];
/**
* Disable literal intepretation of unknown scheme in $url. Returns the
* filtered version of $url.
* @param string $url
* @param string[]|null $permittedSchemes
* @return string
*/
public static function filter($url, $permittedSchemes = null)
{
if (! isset($permittedSchemes)) {
$permittedSchemes = self::COMMON_SCHEMES;
}
foreach ($permittedSchemes as $scheme) {
if (self::striAtStart($url, $scheme)) {
return $url;
}
}
return \str_replace(':', '%3A', $url);
}
/**
* @param string $string
* @param string $needle
* @return bool
*/
private static function striAtStart($string, $needle)
{
$needleLen = \strlen($needle);
return \strtolower(\substr($string, 0, $needleLen)) === \strtolower($needle);
}
}

View File

@ -0,0 +1,34 @@
<?php
namespace Erusev\Parsedown\Html;
interface TransformableRenderable extends Renderable
{
/**
* Takes a closure $Transform which will provide a transformation of
* a "contained text" into Renderables.
*
* In order for TransformableRenderable to make sense, a Renderable must
* have:
* 1. Some concept of "contained text". $Transform can be applied
* piece-wise if your container contains logically disjoint sections
* of text.
* 2. A generic mechanism for containing other Renderables, or replacing
* the current renderable with a container.
*
* It is acceptable to only partially transform "contained text".
*
* @param \Closure(string):TransformableRenderable $Transform
* @return TransformableRenderable
*/
public function transformingContent(\Closure $Transform): TransformableRenderable;
/**
* Similar to transformingContent, but replace the string $search in text content
* with the renderable $Replacement and return the result.
*
* @param string $search
* @return TransformableRenderable
*/
public function replacingAll(string $search, TransformableRenderable $Replacement): TransformableRenderable;
}

View File

@ -0,0 +1,44 @@
<?php
namespace Erusev\Parsedown;
/**
* Beware that the values of MutableConfigurables are NOT stable. Values SHOULD
* be accessed as close to use as possible. Parsing operations sharing the same
* State SHOULD NOT be triggered between where values are read and where they
* need to be relied upon.
*/
interface MutableConfigurable extends Configurable
{
/**
* Objects contained in State can generally be regarded as immutable,
* however, when mutability is *required* then isolatedCopy (this method)
* MUST be implemented to take a reliable copy of the contained state,
* which MUST be fully seperable from the current instance. This is
* sometimes referred to as a "deep copy".
*
* The following assumption is made when you implement
* MutableConfigurable:
*
* A shared, (more or less) globally writable, instantaniously updating
* (at all parsing levels), single copy of a Configurable is intentional
* and desired.
*
* As such, Parsedown will use the isolatedCopy method to ensure state
* isolation between successive parsing calls (which are considered to be
* isolated documents).
*
* You MUST NOT depend on the method `initial` being called when a clean
* parsing state is desired, this will not reliably occur; implement
* isolatedCopy properly to allow Parsedown to manage this.
*
* Failing to implement this method properly can result in unintended
* side-effects. If possible, you should design your Configurable to be
* immutable, which allows a single copy to be shared safely, and mutations
* localised to a heirarchy for which the order of operations is easy to
* reason about.
*
* @return static
*/
public function isolatedCopy();
}

297
src/Parsedown.php Normal file
View File

@ -0,0 +1,297 @@
<?php
namespace Erusev\Parsedown;
use Erusev\Parsedown\AST\StateRenderable;
use Erusev\Parsedown\Components\AcquisitioningBlock;
use Erusev\Parsedown\Components\BacktrackingInline;
use Erusev\Parsedown\Components\Block;
use Erusev\Parsedown\Components\Blocks\Paragraph;
use Erusev\Parsedown\Components\ContinuableBlock;
use Erusev\Parsedown\Components\Inline;
use Erusev\Parsedown\Components\Inlines\PlainText;
use Erusev\Parsedown\Components\StateUpdatingBlock;
use Erusev\Parsedown\Configurables\BlockTypes;
use Erusev\Parsedown\Configurables\InlineTypes;
use Erusev\Parsedown\Configurables\RecursionLimiter;
use Erusev\Parsedown\Configurables\RenderStack;
use Erusev\Parsedown\Html\Renderable;
use Erusev\Parsedown\Parsing\Excerpt;
use Erusev\Parsedown\Parsing\Line;
use Erusev\Parsedown\Parsing\Lines;
final class Parsedown
{
const version = '2.0.0-dev';
/** @var State */
private $State;
public function __construct(StateBearer $StateBearer = null)
{
$State = ($StateBearer ?? new State)->state();
$this->State = $State->isolatedCopy();
}
/**
* @param string $markdown
* @return string
*/
public function toHtml($markdown)
{
list($StateRenderables, $State) = self::lines(
Lines::fromTextLines($markdown, 0),
$this->State->isolatedCopy()
);
$Renderables = \array_reduce(
\array_reverse($State->get(RenderStack::class)->getStack()),
/**
* @param Renderable[] $Renderables
* @param \Closure(Renderable[],State):Renderable[] $RenderMap
* @return Renderable[]
*/
function (array $Renderables, \Closure $RenderMap) use ($State): array {
return $RenderMap($Renderables, $State);
},
$State->applyTo($StateRenderables)
);
$html = self::render($Renderables);
return $html;
}
/**
* @return array{StateRenderable[], State}
*/
public static function lines(Lines $Lines, State $State)
{
list($Blocks, $State) = self::blocks($Lines, $State);
return [self::stateRenderablesFrom($Blocks), $State];
}
/**
* @param Component[] $Components
* @return StateRenderable[]
*/
public static function stateRenderablesFrom($Components)
{
return \array_map(
/**
* @param Component $Component
* @return StateRenderable
*/
function ($Component) { return $Component->stateRenderable(); },
$Components
);
}
/**
* @return array{Block[], State}
*/
public static function blocks(Lines $Lines, State $State)
{
$RecursionLimiter = $State->get(RecursionLimiter::class)->incremented();
if ($RecursionLimiter->isDepthExceeded()) {
$State = $State->setting(new BlockTypes([], []));
}
$State = $State->setting($RecursionLimiter);
/** @var Block[] */
$Blocks = [];
/** @var Block|null */
$Block = null;
/** @var Block|null */
$CurrentBlock = null;
foreach ($Lines->contexts() as $Context) {
$Line = $Context->line();
if (
isset($CurrentBlock)
&& $CurrentBlock instanceof ContinuableBlock
&& ! $CurrentBlock instanceof Paragraph
) {
$Block = $CurrentBlock->advance($Context, $State);
if ($Block instanceof StateUpdatingBlock) {
$State = $Block->latestState();
}
if (isset($Block)) {
$CurrentBlock = $Block;
continue;
}
}
$marker = \substr($Line->text(), 0, 1);
$potentialBlockTypes = \array_merge(
$State->get(BlockTypes::class)->unmarked(),
$State->get(BlockTypes::class)->markedBy($marker)
);
foreach ($potentialBlockTypes as $blockType) {
$Block = $blockType::build($Context, $State, $CurrentBlock);
if (isset($Block)) {
if ($Block instanceof StateUpdatingBlock) {
$State = $Block->latestState();
}
if (isset($CurrentBlock)
&& (
! $Block instanceof AcquisitioningBlock
|| ! $Block->acquiredPrevious()
)
) {
$Blocks[] = $CurrentBlock;
}
$CurrentBlock = $Block;
continue 2;
}
}
if (isset($CurrentBlock) && $CurrentBlock instanceof Paragraph) {
$Block = $CurrentBlock->advance($Context, $State);
}
if (isset($Block)) {
$CurrentBlock = $Block;
} else {
if (isset($CurrentBlock)) {
$Blocks[] = $CurrentBlock;
}
$CurrentBlock = Paragraph::build($Context, $State);
}
}
if (isset($CurrentBlock)) {
$Blocks[] = $CurrentBlock;
}
return [$Blocks, $State];
}
/**
* @param string $text
* @return StateRenderable[]
*/
public static function line($text, State $State)
{
return self::stateRenderablesFrom(self::inlines($text, $State));
}
/**
* @param string $text
* @return Inline[]
*/
public static function inlines($text, State $State)
{
# standardize line breaks
$text = \str_replace(["\r\n", "\r"], "\n", $text);
$RecursionLimiter = $State->get(RecursionLimiter::class)->incremented();
if ($RecursionLimiter->isDepthExceeded()) {
return [Plaintext::build(new Excerpt($text, 0), $State)];
}
$State = $State->setting($RecursionLimiter);
/** @var Inline[] */
$Inlines = [];
# $excerpt is based on the first occurrence of a marker
$InlineTypes = $State->get(InlineTypes::class);
$markerMask = $InlineTypes->markers();
for (
$Excerpt = (new Excerpt($text, 0))->pushingOffsetTo($markerMask);
$Excerpt->text() !== '';
$Excerpt = $Excerpt->pushingOffsetTo($markerMask)
) {
$marker = \substr($Excerpt->text(), 0, 1);
foreach ($InlineTypes->markedBy($marker) as $inlineType) {
$Inline = $inlineType::build($Excerpt, $State);
if (! isset($Inline)) {
continue;
}
$markerPosition = $Excerpt->offset();
/** @var int|null */
$startPosition = null;
if ($Inline instanceof BacktrackingInline) {
$startPosition = $Inline->modifyStartPositionTo();
}
if (! isset($startPosition)) {
$startPosition = $markerPosition;
}
$endPosition = $startPosition + $Inline->width();
if ($startPosition > $markerPosition
|| $endPosition < $markerPosition
|| $startPosition < 0
) {
continue;
}
$Inlines[] = Plaintext::build($Excerpt->choppingUpToOffset($startPosition), $State);
$Inlines[] = $Inline;
/** @psalm-suppress LoopInvalidation */
$Excerpt = $Excerpt->choppingFromOffset($endPosition);
continue 2;
}
/** @psalm-suppress LoopInvalidation */
$Excerpt = $Excerpt->addingToOffset(1);
}
$Inlines[] = Plaintext::build($Excerpt->choppingFromOffset(0), $State);
return $Inlines;
}
/**
* @param Renderable[] $Renderables
* @return string
*/
public static function render(array $Renderables)
{
return \trim(
\array_reduce(
$Renderables,
/**
* @param string $html
* @return string
*/
function ($html, Renderable $Renderable) {
$newHtml = $Renderable->getHtml();
return $html . ($newHtml === '' ? '' : "\n") . $newHtml;
},
''
),
"\n"
);
}
}

48
src/Parsing/Context.php Normal file
View File

@ -0,0 +1,48 @@
<?php
namespace Erusev\Parsedown\Parsing;
final class Context
{
/** @var Line */
private $Line;
/** @var int|null */
private $precedingEmptyLines;
/** @var string */
private $precedingEmptyLinesText;
/**
* @param Line $Line
* @param string $precedingEmptyLinesText
*/
public function __construct($Line, $precedingEmptyLinesText)
{
$this->Line = $Line;
$this->precedingEmptyLinesText = $precedingEmptyLinesText;
$this->precedingEmptyLines = null;
}
/** @return Line */
public function line()
{
return $this->Line;
}
/** @return int */
public function precedingEmptyLines()
{
if (! isset($this->precedingEmptyLines)) {
$this->precedingEmptyLines = \substr_count($this->precedingEmptyLinesText, "\n");
}
return $this->precedingEmptyLines;
}
/** @return string */
public function precedingEmptyLinesText()
{
return $this->precedingEmptyLinesText;
}
}

85
src/Parsing/Excerpt.php Normal file
View File

@ -0,0 +1,85 @@
<?php
namespace Erusev\Parsedown\Parsing;
final class Excerpt
{
/** @var string */
private $context;
/** @var int */
private $offset;
/** @var string */
private $text;
/**
* @param string $context
* @param int $offset
*/
public function __construct($context, $offset)
{
$this->context = $context;
$this->offset = $offset;
$this->text = \substr($context, $offset);
// only necessary pre-php7
if ($this->text === false) {
$this->text = '';
}
}
/**
* @param string $mask
* @return self
*/
public function pushingOffsetTo($mask)
{
return $this->addingToOffset(\strcspn($this->text, $mask));
}
/**
* @param int $offset
* @return self
*/
public function choppingFromOffset($offset)
{
return new self(\substr($this->context, $offset), 0);
}
/**
* @param int $offset
* @return self
*/
public function choppingUpToOffset($offset)
{
return new self(\substr($this->context, 0, $offset), 0);
}
/**
* @param int $offsetIncrement
* @return self
*/
public function addingToOffset($offsetIncrement)
{
return new self($this->context, $this->offset + $offsetIncrement);
}
/** @return string */
public function context()
{
return $this->context;
}
/** @return int */
public function offset()
{
return $this->offset;
}
/** @return string */
public function text()
{
return $this->text;
}
}

138
src/Parsing/Line.php Normal file
View File

@ -0,0 +1,138 @@
<?php
namespace Erusev\Parsedown\Parsing;
final class Line
{
const INDENT_STEP = 4;
/** @var int */
private $indent;
/** @var int */
private $indentOffset;
/** @var string */
private $rawLine;
/** @var string */
private $text;
/**
* @param string $line
* @param int $indentOffset
*/
public function __construct($line, $indentOffset = 0)
{
$this->rawLine = $line;
$this->indentOffset = $indentOffset % self::INDENT_STEP;
$lineWithoutTabs = self::indentTabsToSpaces($line, $indentOffset);
$this->indent = \strspn($lineWithoutTabs, ' ');
$this->text = \substr($lineWithoutTabs, $this->indent);
}
/** @return int */
public function indentOffset()
{
return $this->indentOffset;
}
/** @return string */
public function rawLine()
{
return $this->rawLine;
}
/**
* @param int $fromPosition
* @param int $indentOffset
* @return int
*/
public static function tabShortage($fromPosition, $indentOffset)
{
return self::INDENT_STEP - ($fromPosition + $indentOffset) % self::INDENT_STEP;
}
/**
* @param string $text
* @param int $indentOffset
* @return string
*/
private static function indentTabsToSpaces($text, $indentOffset = 0)
{
$rawIndentLen = \strspn($text, " \t");
$indentString = \substr($text, 0, $rawIndentLen);
$latterString = \substr($text, $rawIndentLen);
while (($beforeTab = \strstr($indentString, "\t", true)) !== false) {
$shortage = self::tabShortage(\mb_strlen($beforeTab, 'UTF-8'), $indentOffset);
$indentString = $beforeTab
. \str_repeat(' ', $shortage)
. \substr($indentString, \strlen($beforeTab) + 1)
;
}
return $indentString . $latterString;
}
/**
* @param int $pos
* @return string
*/
public function ltrimBodyUpto($pos)
{
if ($pos <= 0) {
return $this->rawLine;
}
if ($pos >= $this->indent) {
return \ltrim($this->rawLine, "\t ");
}
$rawIndentLen = \strspn($this->rawLine, " \t");
$rawIndentString = \substr($this->rawLine, 0, $rawIndentLen);
$effectiveIndent = 0;
foreach (\str_split($rawIndentString) as $n => $char) {
if ($char === "\t") {
$shortage = self::tabShortage($effectiveIndent, $this->indentOffset);
$effectiveIndent += $shortage;
if ($effectiveIndent >= $pos) {
$overshoot = $effectiveIndent - $pos;
return \str_repeat(' ', $overshoot) . \substr($this->rawLine, $n + 1);
}
continue;
} else {
$effectiveIndent += 1;
if ($effectiveIndent === $pos) {
return \substr($this->rawLine, $n + 1);
}
continue;
}
}
return \ltrim($this->rawLine, "\t ");
}
/** @return int */
public function indent()
{
return $this->indent;
}
/** @return string */
public function text()
{
return $this->text;
}
}

179
src/Parsing/Lines.php Normal file
View File

@ -0,0 +1,179 @@
<?php
namespace Erusev\Parsedown\Parsing;
final class Lines
{
/** @var Context[] */
private $Contexts;
/** @var bool */
private $containsBlankLines;
/** @var string */
private $trailingBlankLinesText;
/** @var int */
private $trailingBlankLines;
/**
* @param Context[] $Contexts
* @param string $trailingBlankLinesText
*/
private function __construct($Contexts, $trailingBlankLinesText)
{
$this->Contexts = $Contexts;
$this->trailingBlankLinesText = $trailingBlankLinesText;
$this->trailingBlankLines = \substr_count($trailingBlankLinesText, "\n");
$containsBlankLines = $this->trailingBlankLines > 0;
if (! $containsBlankLines) {
foreach ($Contexts as $Context) {
if ($Context->precedingEmptyLines() > 0) {
$containsBlankLines = true;
break;
}
}
}
$this->containsBlankLines = $containsBlankLines;
}
/** @return self */
public static function none()
{
return new self([], '');
}
/**
* @param string $text
* @param int $indentOffset
* @return self
*/
public static function fromTextLines($text, $indentOffset)
{
# standardize line breaks
$text = \str_replace(["\r\n", "\r"], "\n", $text);
$Contexts = [];
$sequentialEmptyLines = '';
foreach (\explode("\n", $text) as $line) {
if (\chop($line) === '') {
$sequentialEmptyLines .= $line . "\n";
continue;
}
$Contexts[] = new Context(
new Line($line, $indentOffset),
$sequentialEmptyLines
);
$sequentialEmptyLines = '';
}
return new self($Contexts, $sequentialEmptyLines);
}
/** @return bool */
public function isEmpty()
{
return ! $this->containsBlankLines && \count($this->Contexts) === 0;
}
/** @return Context[] */
public function contexts()
{
return $this->Contexts;
}
/** @return bool */
public function containsBlankLines()
{
return $this->containsBlankLines;
}
/** @return int */
public function trailingBlankLines()
{
return $this->trailingBlankLines;
}
/**
* @param int $count
* @return self
*/
public function appendingBlankLines($count = 1)
{
if ($count < 0) {
$count = 0;
}
$Lines = clone($this);
$Lines->trailingBlankLinesText .= \str_repeat("\n", $count);
$Lines->trailingBlankLines += $count;
$Lines->containsBlankLines = $Lines->containsBlankLines || ($count > 0);
return $Lines;
}
/**
* @param string $text
* @param int $indentOffset
* @return Lines
*/
public function appendingTextLines($text, $indentOffset)
{
$Lines = clone($this);
$NextLines = self::fromTextLines($text, $indentOffset);
if (\count($NextLines->Contexts) === 0) {
$Lines->trailingBlankLines += $NextLines->trailingBlankLines;
$Lines->trailingBlankLinesText .= $NextLines->trailingBlankLinesText;
$Lines->containsBlankLines = true;
return $Lines;
}
$NextLines->Contexts[0] = new Context(
$NextLines->Contexts[0]->line(),
$NextLines->Contexts[0]->precedingEmptyLinesText() . $Lines->trailingBlankLinesText
);
$Lines->Contexts = \array_merge($Lines->Contexts, $NextLines->Contexts);
$Lines->trailingBlankLines = $NextLines->trailingBlankLines;
$Lines->trailingBlankLinesText = $NextLines->trailingBlankLinesText;
$Lines->containsBlankLines = $Lines->containsBlankLines
|| $NextLines->containsBlankLines
;
return $Lines;
}
/** @return Lines */
public function appendingContext(Context $Context)
{
$Lines = clone($this);
$Context = new Context(
$Context->line(),
$Context->precedingEmptyLinesText() . $Lines->trailingBlankLinesText
);
if ($Context->precedingEmptyLines() > 0) {
$Lines->containsBlankLines = true;
}
$Lines->trailingBlankLines = 0;
$Lines->trailingBlankLinesText = '';
$Lines->Contexts[] = $Context;
return $Lines;
}
}

125
src/State.php Normal file
View File

@ -0,0 +1,125 @@
<?php
namespace Erusev\Parsedown;
use Erusev\Parsedown\AST\StateRenderable;
use Erusev\Parsedown\Html\Renderable;
final class State implements StateBearer
{
/**
* @var array<class-string<Configurable>, Configurable>
*/
private $state;
/**
* @var array<class-string<Configurable>, Configurable>
*/
private static $initialCache = [];
/**
* @param Configurable[] $Configurables
*/
public function __construct(array $Configurables = [])
{
$this->state = \array_combine(
\array_map(
/** @return class-string<Configurable> */
function (Configurable $C) { return \get_class($C); },
$Configurables
),
$Configurables
);
}
/**
* @return self
*/
public function setting(Configurable $C)
{
return new self([\get_class($C) => $C] + $this->state);
}
/**
* @return self
*/
public function mergingWith(State $State)
{
return new self($State->state + $this->state);
}
/**
* @template T as Configurable
* @template-typeof T $className
* @param class-string<T> $className
* @return T
*/
public function get($className)
{
if (
! isset($this->state[$className])
&& \is_subclass_of($className, MutableConfigurable::class, true)
) {
if (! isset(self::$initialCache[$className])) {
/** @var T */
self::$initialCache[$className] = $className::initial();
}
/**
* @var T
* @psalm-suppress PossiblyUndefinedMethod
*/
$this->state[$className] = self::$initialCache[$className]->isolatedCopy();
}
/** @var T */
return (
$this->state[$className]
?? self::$initialCache[$className]
?? self::$initialCache[$className] = $className::initial()
);
}
public function __clone()
{
$this->state = \array_map(
/** @return Configurable */
function (Configurable $C) { return clone($C); },
$this->state
);
}
/**
* @param StateRenderable[] $StateRenderables
* @return Renderable[]
*/
public function applyTo(array $StateRenderables)
{
return \array_map(
/** @return Renderable */
function (StateRenderable $SR) { return $SR->renderable($this); },
$StateRenderables
);
}
public function state(): State
{
return $this;
}
/** @return self */
public static function from(StateBearer $StateBearer)
{
return $StateBearer->state();
}
public function isolatedCopy(): self
{
return new self(\array_map(
function ($C) {
return $C instanceof MutableConfigurable ? $C->isolatedCopy() : $C;
},
$this->state
));
}
}

10
src/StateBearer.php Normal file
View File

@ -0,0 +1,10 @@
<?php
namespace Erusev\Parsedown;
interface StateBearer
{
public function state(): State;
/** @return static */
public static function from(StateBearer $StateBearer);
}

120
tests/CommonMarkTest.php Normal file
View File

@ -0,0 +1,120 @@
<?php
namespace Erusev\Parsedown\Tests;
/**
* Test Parsedown against cached expect-to-pass CommonMark spec examples
*
* This test suite runs tests the same way as `test/CommonMarkTestWeak.php`,
* but uses a cached set of CommonMark spec examples in `test/commonmark/`.
* It is executed along with Parsedown's default test suite and runs various
* CommonMark spec examples, which are expected to pass. If they don't pass,
* the Parsedown build fails. The intention of this test suite is to make sure,
* that previously passed CommonMark spec examples don't fail due to unwanted
* side-effects of code changes.
*
* You can re-create the `test/commonmark/` directory by executing the PHPUnit
* group `update`. The test suite will then run `test/CommonMarkTestWeak.php`
* and create files with the Markdown source and the resulting HTML markup of
* all passed tests. The command to execute looks like the following:
*
* $ phpunit --group update
*
* @link http://commonmark.org/ CommonMark
*/
class CommonMarkTest extends CommonMarkTestStrict
{
/**
* @return array<int, array{id: int, section: string, markdown: string, expectedHtml: string}>
* @throws \PHPUnit\Framework\AssertionFailedError
*/
public function data()
{
$data = [];
$dir = static::getDataDir();
$files = @\scandir($dir);
if (!empty($files)) {
foreach ($files as $file) {
if (($file === '.') || ($file === '..')) {
continue;
}
if (\substr($file, -3) === '.md') {
$testName = \substr($file, 0, -3);
if (\file_exists($dir . $testName . '.html')) {
\preg_match('/^(\d+)-(.*)$/', $testName, $matches);
$id = isset($matches[1]) ? \intval($matches[1]) : 0;
$section = isset($matches[2]) ? \preg_replace('/_+/', ' ', $matches[2]) : '';
$markdown = \file_get_contents($dir . $testName . '.md');
$expectedHtml = \file_get_contents($dir . $testName . '.html');
$data[$id] = [
'id' => $id,
'section' => $section,
'markdown' => $markdown,
'expectedHtml' => $expectedHtml
];
}
}
}
} else {
$this->fail('The CommonMark cache folder ' . $dir . ' is empty or not readable.');
}
return $data;
}
/**
* @group update
* @dataProvider dataUpdate
* @param int $id
* @param string $section
* @param string $markdown
* @param string $expectedHtml
* @return void
* @throws \PHPUnit\Framework\AssertionFailedError
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function testUpdateDatabase($id, $section, $markdown, $expectedHtml)
{
parent::testExample($id, $section, $markdown, $expectedHtml);
// you can only get here when the test passes
$dir = static::getDataDir(true);
$basename = \strval($id) . '-' . \preg_replace('/[^\w.-]/', '_', $section);
\file_put_contents($dir . $basename . '.md', $markdown);
\file_put_contents($dir . $basename . '.html', $expectedHtml);
}
/**
* @return array<int, array{id: int, section: string, markdown: string, expectedHtml: string}>
* @throws \PHPUnit\Framework\AssertionFailedError
*/
public function dataUpdate()
{
return parent::data();
}
/**
* @param bool $mkdir
* @return string
* @throws \PHPUnit\Framework\AssertionFailedError
*/
public static function getDataDir($mkdir = false)
{
$dir = __DIR__ . '/commonmark/';
if ($mkdir) {
if (!\file_exists($dir)) {
@\mkdir($dir);
}
if (!\is_dir($dir)) {
static::fail('Unable to create CommonMark cache folder ' . $dir . '.');
}
}
return $dir;
}
}

View File

@ -0,0 +1,120 @@
<?php
namespace Erusev\Parsedown\Tests;
use Erusev\Parsedown\Components\Inlines\Url;
use Erusev\Parsedown\Configurables\InlineTypes;
use Erusev\Parsedown\Configurables\StrictMode;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\State;
use PHPUnit\Framework\TestCase;
/**
* Test Parsedown against the CommonMark spec
*
* @link http://commonmark.org/ CommonMark
*/
class CommonMarkTestStrict extends TestCase
{
const SPEC_URL = 'https://raw.githubusercontent.com/jgm/CommonMark/master/spec.txt';
const SPEC_LOCAL_CACHE = 'spec_cache.txt';
const SPEC_CACHE_SECONDS = 300;
/** @var Parsedown */
protected $Parsedown;
/**
* @param string|null $name
* @param array $data
* @param string $dataName
*/
public function __construct($name = null, array $data = [], $dataName = '')
{
$this->Parsedown = new Parsedown(new State([
StrictMode::enabled(),
InlineTypes::initial()->removing([Url::class]),
]));
parent::__construct($name, $data, $dataName);
}
/**
* @dataProvider data
* @param int $_
* @param string $__
* @param string $markdown
* @param string $expectedHtml
* @return void
* @throws \PHPUnit\Framework\AssertionFailedError
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function testExample($_, $__, $markdown, $expectedHtml)
{
$actualHtml = $this->Parsedown->toHtml($markdown);
$this->assertEquals($expectedHtml, $actualHtml);
}
/**
* @return string
* @throws \PHPUnit\Framework\AssertionFailedError
*/
public function getSpec()
{
$specPath = __DIR__ .'/'.self::SPEC_LOCAL_CACHE;
if (
\is_file($specPath)
&& \time() - \filemtime($specPath) < self::SPEC_CACHE_SECONDS
) {
$spec = \file_get_contents($specPath);
} else {
$spec = \file_get_contents(self::SPEC_URL);
\file_put_contents($specPath, $spec);
}
if ($spec === false) {
$this->fail('Unable to load CommonMark spec from ' . self::SPEC_URL);
}
return $spec;
}
/**
* @return array<int, array{id: int, section: string, markdown: string, expectedHtml: string}>
* @throws \PHPUnit\Framework\AssertionFailedError
*/
public function data()
{
$spec = $this->getSpec();
$spec = \str_replace("\r\n", "\n", $spec);
/** @var string */
$spec = \strstr($spec, '<!-- END TESTS -->', true);
$matches = [];
\preg_match_all('/^`{32} example\n((?s).*?)\n\.\n(?:|((?s).*?)\n)`{32}$|^#{1,6} *(.*?)$/m', $spec, $matches, \PREG_SET_ORDER);
$data = [];
$currentId = 0;
$currentSection = '';
/** @var array{0: string, 1: string, 2?: string, 3?: string} $match */
foreach ($matches as $match) {
if (isset($match[3])) {
$currentSection = $match[3];
} else {
$currentId++;
$markdown = \str_replace('→', "\t", $match[1]);
$expectedHtml = isset($match[2]) ? \str_replace('→', "\t", $match[2]) : '';
$data[$currentId] = [
'id' => $currentId,
'section' => $currentSection,
'markdown' => $markdown,
'expectedHtml' => $expectedHtml
];
}
}
return $data;
}
}

View File

@ -0,0 +1,82 @@
<?php
namespace Erusev\Parsedown\Tests;
use Erusev\Parsedown\Html\Renderables\Element;
/**
* Test Parsedown against the CommonMark spec, but less aggressive
*
* The resulting HTML markup is cleaned up before comparison, so examples
* which would normally fail due to actually invisible differences (e.g.
* superfluous whitespaces), don't fail. However, cleanup relies on block
* element detection. The detection doesn't work correctly when a element's
* `display` CSS property is manipulated. According to that this test is only
* a interim solution on Parsedown's way to full CommonMark compatibility.
*
* @link http://commonmark.org/ CommonMark
*/
class CommonMarkTestWeak extends CommonMarkTestStrict
{
/** @var string */
protected $textLevelElementRegex;
/**
* @param string|null $name
* @param array $data
* @param string $dataName
*/
public function __construct($name = null, array $data = [], $dataName = '')
{
$textLevelElements = \array_keys(Element::TEXT_LEVEL_ELEMENTS);
$textLevelElements = \array_map(
function ($e) { return \preg_quote($e, '/'); },
$textLevelElements
);
$this->textLevelElementRegex = '\b(?:' . \implode('|', $textLevelElements) . ')\b';
parent::__construct($name, $data, $dataName);
}
/**
* @dataProvider data
* @param int $_
* @param string $__
* @param string $markdown
* @param string $expectedHtml
* @return void
* @throws \PHPUnit\Framework\AssertionFailedError
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function testExample($_, $__, $markdown, $expectedHtml)
{
$expectedHtml = $this->cleanupHtml($expectedHtml);
$actualHtml = $this->Parsedown->toHtml($markdown);
$actualHtml = $this->cleanupHtml($actualHtml);
$this->assertEquals($expectedHtml, $actualHtml);
}
/**
* @param string $markup
* @return string
*/
protected function cleanupHtml($markup)
{
// invisible whitespaces at the beginning and end of block elements
// however, whitespaces at the beginning of <pre> elements do matter
$markup = \preg_replace(
[
'/(<(?!(?:' . $this->textLevelElementRegex . '|\bpre\b))\w+\b[^>]*>(?:<' . $this->textLevelElementRegex . '[^>]*>)*)\s+/s',
'/\s+((?:<\/' . $this->textLevelElementRegex . '>)*<\/(?!' . $this->textLevelElementRegex . ')\w+\b>)/s'
],
'$1',
$markup
);
return $markup;
}
}

164
tests/ParsedownTest.php Executable file
View File

@ -0,0 +1,164 @@
<?php
namespace Erusev\Parsedown\Tests;
use Erusev\Parsedown\Components\Blocks\Markup as BlockMarkup;
use Erusev\Parsedown\Components\Inlines\Markup as InlineMarkup;
use Erusev\Parsedown\Configurables\BlockTypes;
use Erusev\Parsedown\Configurables\Breaks;
use Erusev\Parsedown\Configurables\HeaderSlug;
use Erusev\Parsedown\Configurables\InlineTypes;
use Erusev\Parsedown\Configurables\SafeMode;
use Erusev\Parsedown\Configurables\StrictMode;
use Erusev\Parsedown\Parsedown;
use Erusev\Parsedown\State;
use Erusev\Parsedown\StateBearer;
use PHPUnit\Framework\TestCase;
class ParsedownTest extends TestCase
{
/**
* @param string|null $name
* @param array $data
* @param string $dataName
*/
final public function __construct($name = null, array $data = [], $dataName = '')
{
$this->dirs = $this->initDirs();
parent::__construct($name, $data, $dataName);
}
/** @var string[] */
private $dirs;
/**
* @return string[]
*/
protected function initDirs()
{
return [\dirname(__FILE__).'/data/'];
}
protected function initState(string $testName): StateBearer
{
return new State([
new SafeMode(\substr($testName, 0, 3) === 'xss'),
new StrictMode(\substr($testName, 0, 6) === 'strict'),
new Breaks(\substr($testName, 0, 14) === 'breaks_enabled'),
new HeaderSlug(\substr($testName, 0, 4) === 'slug'),
]);
}
/**
* @dataProvider data
* @param string $test
* @param string $dir
* @return void
* @throws \PHPUnit\Framework\ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function test_($test, $dir)
{
$markdown = \file_get_contents($dir . $test . '.md');
$expectedMarkup = \file_get_contents($dir . $test . '.html');
$expectedMarkup = \str_replace("\r\n", "\n", $expectedMarkup);
$expectedMarkup = \str_replace("\r", "\n", $expectedMarkup);
$Parsedown = new Parsedown($this->initState($test));
$actualMarkup = $Parsedown->toHtml($markdown);
$this->assertEquals($expectedMarkup, $actualMarkup);
}
/** @return array<int, array{0:string, 1:string}> */
public function data()
{
$data = [];
foreach ($this->dirs as $dir) {
$Folder = new \DirectoryIterator($dir);
foreach ($Folder as $File) {
if (! $File->isFile()) {
continue;
}
$filename = $File->getFilename();
$extension = \pathinfo($filename, \PATHINFO_EXTENSION);
if ($extension !== 'md') {
continue;
}
$basename = $File->getBasename('.md');
if (\file_exists($dir . $basename . '.html')) {
$data []= [$basename, $dir];
}
}
}
return $data;
}
/**
* @return void
* @throws \PHPUnit\Framework\ExpectationFailedException
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
*/
public function test_no_markup()
{
$markdownWithHtml = <<<MARKDOWN_WITH_MARKUP
<div>_content_</div>
sparse:
<div>
<div class="inner">
_content_
</div>
</div>
paragraph
<style type="text/css">
p {
color: red;
}
</style>
comment
<!-- html comment -->
MARKDOWN_WITH_MARKUP;
$expectedHtml = <<<EXPECTED_HTML
<p>&lt;div&gt;<em>content</em>&lt;/div&gt;</p>
<p>sparse:</p>
<p>&lt;div&gt;
&lt;div class=&quot;inner&quot;&gt;
<em>content</em>
&lt;/div&gt;
&lt;/div&gt;</p>
<p>paragraph</p>
<p>&lt;style type=&quot;text/css&quot;&gt;
p {
color: red;
}
&lt;/style&gt;</p>
<p>comment</p>
<p>&lt;!-- html comment --&gt;</p>
EXPECTED_HTML;
$parsedownWithNoMarkup = new Parsedown(new State([
BlockTypes::initial()->removing([BlockMarkup::class]),
InlineTypes::initial()->removing([InlineMarkup::class]),
]));
$this->assertEquals($expectedHtml, $parsedownWithNoMarkup->toHtml($markdownWithHtml));
}
}

View File

@ -1,57 +0,0 @@
<?php
include 'Parsedown.php';
class Test extends PHPUnit_Framework_TestCase
{
const provider_dir = 'data/';
/**
* @dataProvider provider
*/
function test_($filename)
{
$path = $this->get_data_path();
$markdown = file_get_contents($path . $filename . '.md');
$expected_markup = file_get_contents($path . $filename . '.html');
$expected_markup = str_replace("\r\n", "\n", $expected_markup);
$expected_markup = str_replace("\r", "\n", $expected_markup);
$actual_markup = Parsedown::instance()->parse($markdown);
$this->assertEquals($expected_markup, $actual_markup);
}
function provider()
{
$provider = array();
$path = $this->get_data_path();
$DirectoryIterator = new DirectoryIterator($path);
foreach ($DirectoryIterator as $Item)
{
if ($Item->isFile())
{
$filename = $Item->getFilename();
$extension = pathinfo($filename, PATHINFO_EXTENSION);
if ($extension !== 'md')
continue;
$basename = $Item->getBasename('.md');
if (file_exists($path.$basename.'.html')) {
$provider [] = array($basename);
}
}
}
return $provider;
}
function get_data_path()
{
return dirname(__FILE__).'/'.self::provider_dir;
}
}

View File

@ -0,0 +1,2 @@
<pre><code>foo baz bim
</code></pre>

View File

@ -0,0 +1 @@
foo baz bim

View File

@ -0,0 +1 @@
<h1>Foo</h1>

View File

@ -0,0 +1 @@
# Foo

View File

@ -0,0 +1 @@
<pre><code></code></pre>

View File

@ -0,0 +1,2 @@
```
```

View File

@ -0,0 +1,4 @@
<pre><code>```
aaa
```
</code></pre>

View File

@ -0,0 +1,3 @@
```
aaa
```

View File

@ -0,0 +1,4 @@
<pre><code>```
aaa
```
</code></pre>

View File

@ -0,0 +1,3 @@
```
aaa
```

View File

@ -0,0 +1,2 @@
<pre><code>aaa
</code></pre>

View File

@ -0,0 +1,3 @@
```
aaa
```

View File

@ -0,0 +1,2 @@
<pre><code>aaa
</code></pre>

View File

@ -0,0 +1,3 @@
```
aaa
```

View File

@ -0,0 +1,2 @@
<p><code></code>
aaa</p>

Some files were not shown because too many files have changed in this diff Show More