This repository has been archived by the owner on Nov 10, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 58
/
class-wordpress-readme-parser.php
292 lines (264 loc) · 9.74 KB
/
class-wordpress-readme-parser.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<?php
/**
* Lightweight WordPress readme.txt parser and converter to Markdown
* The WordPress-Plugin-Readme-Parser project is too heavy and has too many dependencies for what we need (we don't need conversion to HTML)
* @link https://github.com/markjaquith/WordPress-Plugin-Readme-Parser Alternative to WordPress-Plugin-Readme-Parser
* @version 1.1.1
* @author Weston Ruter <[email protected]> (@westonruter)
* @copyright Copyright (c) 2017, XWP <https://xwp.co/>
* @license MIT
*/
class WordPress_Readme_Parser {
public $path;
public $source;
public $title = '';
public $short_description = '';
public $metadata = array();
public $sections = array();
function __construct( $args = array() ) {
$args = array_merge( get_object_vars( $this ), $args );
foreach ( $args as $key => $value ) {
$this->$key = $value;
}
// @codingStandardsIgnoreStart
$this->source = file_get_contents( $this->path );
// @codingStandardsIgnoreEnd
if ( ! $this->source ) {
throw new Exception( 'readme.txt was empty or unreadable' );
}
// Parse metadata
$syntax_ok = preg_match( '/^=== (.+?) ===\r?\n(.+?)\r?\n\r?\n(.+?)\r?\n(.+)/s', $this->source, $matches );
if ( ! $syntax_ok ) {
throw new Exception( 'Malformed metadata block' );
}
$this->title = $matches[1];
$this->short_description = $matches[3];
$readme_txt_rest = $matches[4];
$this->metadata = array_fill_keys( array( 'Contributors', 'Tags', 'Requires at least', 'Tested up to', 'Stable tag', 'License', 'License URI' ), null );
foreach ( explode( "\n", $matches[2] ) as $metadatum ) {
if ( ! preg_match( '/^(.+?):\s+(.+)$/', $metadatum, $metadataum_matches ) ) {
throw new Exception( "Parse error in $metadatum" );
}
list( $name, $value ) = array_slice( $metadataum_matches, 1, 2 );
$this->metadata[ $name ] = trim( $value );
}
$this->metadata['Contributors'] = array_filter( preg_split( '/\s*,\s*/', $this->metadata['Contributors'] ) );
$this->metadata['Tags'] = array_filter( preg_split( '/\s*,\s*/', $this->metadata['Tags'] ) );
$syntax_ok = preg_match_all( '/(?:^|\r?\n)== (.+?) ==\r?\n(.+?)(?=\r?\n== |$)/s', $readme_txt_rest, $section_matches, PREG_SET_ORDER );
if ( ! $syntax_ok ) {
throw new Exception( 'Failed to parse sections from readme.txt' );
}
foreach ( $section_matches as $section_match ) {
array_shift( $section_match );
$heading = array_shift( $section_match );
$body = trim( array_shift( $section_match ) );
$subsections = array();
// Check if there is front matter
if ( preg_match( '/^(\s*[^=].+?)(?=\r?\n=|$)(.*$)/s', $body, $matches ) ) {
$body = $matches[1];
$subsection_search_area = $matches[2];
} else {
$subsection_search_area = $body;
$body = null;
}
// Parse subsections
if ( preg_match_all( '/(?:^|\r?\n)= (.+?) =\r?\n(.+?)(?=\r?\n= |$)/s', $subsection_search_area, $subsection_matches, PREG_SET_ORDER ) ) {
foreach ( $subsection_matches as $subsection_match ) {
array_shift( $subsection_match );
$subsections[] = array(
'heading' => array_shift( $subsection_match ),
'body' => trim( array_shift( $subsection_match ) ),
);
}
}
$this->sections[] = compact( 'heading', 'body', 'subsections' );
}
}
/**
* Convert the parsed readme.txt into Markdown
* @param array|string [$params]
* @return string
*/
function to_markdown( $params = array() ) {
$that = $this;
$general_section_formatter = function ( $body ) use ( $params ) {
$body = preg_replace(
'#\[youtube\s+(?:https?://www\.youtube\.com/watch\?v=|https?://youtu\.be/)(.+?)\]#',
'[](https://www.youtube.com/watch?v=$1)',
$body
);
// Convert <pre lang="php"> into GitHub-flavored ```php markdown blocks
$body = preg_replace(
'#\n?<pre lang="(\w+)">\r?\n?(.+?)\r?\n?</pre>\r?\n?#s',
"\n" . '```$1' . "\n" . '$2' . "\n" . '```' . "\n",
$body
);
return $body;
};
// Parse sections
$section_formatters = array(
'Screenshots' => function ( $body ) use ( $that, $params ) {
$body = trim( $body );
$new_body = '';
if ( ! preg_match_all( '/^\d+\. (.+?)\s*$/m', $body, $screenshot_matches, PREG_SET_ORDER ) ) {
throw new Exception( 'Malformed screenshot section' );
}
foreach ( $screenshot_matches as $i => $screenshot_match ) {
$img_extensions = array( 'jpg', 'gif', 'png' );
foreach ( $img_extensions as $ext ) {
$filepath = sprintf( '%s/screenshot-%d.%s', $params['assets_dir'], $i + 1, $ext );
if ( file_exists( dirname( $that->path ) . DIRECTORY_SEPARATOR . $filepath ) ) {
break;
} else {
$filepath = null;
}
}
if ( empty( $filepath ) ) {
continue;
}
$screenshot_name = $screenshot_match[1];
$new_body .= sprintf( "### %s\n", $screenshot_name );
$new_body .= "\n";
$new_body .= sprintf( "\n", $screenshot_name, $filepath );
$new_body .= "\n";
}
return $new_body;
},
);
// Format metadata
$formatted_metadata = array_filter( $this->metadata );
$formatted_metadata['Contributors'] = implode(
', ',
array_map(
function ( $contributor ) {
$contributor = strtolower( $contributor );
// @todo Map to GitHub account
return sprintf( '[%1$s](https://profiles.wordpress.org/%1$s)', $contributor );
},
$this->metadata['Contributors']
)
);
if ( ! empty( $this->metadata['Tags'] ) ) {
$formatted_metadata['Tags'] = implode(
', ',
array_map(
function ( $tag ) {
return sprintf( '[%1$s](https://wordpress.org/plugins/tags/%2$s)', $tag, str_replace( ' ', '-', $tag ) );
},
$this->metadata['Tags']
)
);
}
if ( isset( $formatted_metadata['License URI'] ) && isset( $formatted_metadata['License'] ) ) {
$formatted_metadata['License'] = sprintf( '[%s](%s)', $formatted_metadata['License'], $formatted_metadata['License URI'] );
}
unset( $formatted_metadata['License URI'] );
if ( 'trunk' === $this->metadata['Stable tag'] ) {
$formatted_metadata['Stable tag'] .= ' (master)';
}
// Render metadata
$markdown = "<!-- DO NOT EDIT THIS FILE; it is auto-generated from readme.txt -->\n";
$markdown .= sprintf( "# %s\n", empty( $params['title'] ) ? $this->title : $params['title'] );
$markdown .= "\n";
if ( file_exists( $params['assets_dir'] . '/banner-1544x500.png' ) ) {
$markdown .= "";
$markdown .= "\n";
}
$markdown .= sprintf( "%s\n", $this->short_description );
$markdown .= "\n";
foreach ( $formatted_metadata as $name => $value ) {
$markdown .= sprintf( "**%s:** %s \n", $name, $value );
}
// All of the supported badges.
$badges = array(
'badge_fury_url',
'travis_ci_pro_url',
'travis_ci_url',
'coveralls_url',
'codecov_url',
'grunt_url',
'david_url',
'david_dev_url',
'gemnasium_url',
'gemnasium_dev_url',
'gitter_url',
);
$badge_md = '';
for ( $i = 0; $i < count( $badges ); $i++ ) {
if ( isset( $params[ $badges[ $i ] ] ) ) {
$badge = $badges[ $i ];
$url = $params[ $badge ];
if ( 'badge_fury_url' === $badge ) {
$badge_md .= sprintf( '[](%1$s) ', $url );
}
if ( 'travis_ci_pro_url' === $badge ) {
$badge_md .= sprintf( '[](%2$s) ', $params['travis_ci_pro_badge_src'], $url );
}
if ( 'travis_ci_url' === $badge ) {
$badge_md .= sprintf( '[](%2$s) ', $params['travis_ci_badge_src'], $url );
}
if ( 'coveralls_url' === $badge ) {
$badge_md .= sprintf( '[](%s) ', $params['coveralls_badge_src'], $url );
}
if ( 'codecov_url' === $badge ) {
$badge_md .= sprintf( '[](%s) ', $params['codecov_badge_src'], $url );
}
if ( 'grunt_url' === $badge ) {
$badge_md .= sprintf( '[](http://%1$s) ', $url );
}
if ( 'david_url' === $badge ) {
$badge_md .= sprintf( '[](%1$s) ', $url );
}
if ( 'david_dev_url' === $badge ) {
$badge_md .= sprintf( '[](%1$s?type=dev) ', $url );
}
if ( 'gemnasium_url' === $badge ) {
$badge_md .= sprintf( '[](%2$s) ', $params['gemnasium_badge_src'], $url );
}
if ( 'gemnasium_dev_url' === $badge ) {
$badge_md .= sprintf( '[](%2$s#development-dependencies) ', $params['gemnasium_dev_badge_src'], $url );
}
if ( 'gitter_url' === $badge ) {
$badge_md .= sprintf( '[](%1$s) ', $url );
}
}
}
if ( ! empty( $badge_md ) ) {
$markdown .= "\n";
$markdown .= $badge_md;
$markdown .= "\n";
}
$markdown .= "\n";
foreach ( $this->sections as $section ) {
$markdown .= sprintf( "## %s ##\n", $section['heading'] );
$markdown .= "\n";
$body = $section['body'];
$body = call_user_func( $general_section_formatter, $body );
if ( isset( $section_formatters[ $section['heading'] ] ) ) {
$body = trim( call_user_func( $section_formatters[ $section['heading'] ], $body ) );
}
if ( $body ) {
$markdown .= sprintf( "%s\n", $this->chomp( $body ) );
}
foreach ( $section['subsections'] as $subsection ) {
$sub_body = $subsection['body'];
$sub_body = call_user_func( $general_section_formatter, $sub_body );
$markdown .= sprintf( "### %s ###\n", $subsection['heading'] );
$markdown .= sprintf( "%s\n", $this->chomp( $sub_body ) );
$markdown .= "\n";
}
$markdown .= "\n";
}
return $markdown;
}
/**
* Remove last newline. Props Perl.
*
* @param $string
*
* @return string
*/
function chomp( $string ) {
return preg_replace( '/\n$/', '', $string );
}
}