-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
294 lines (234 loc) · 6.4 KB
/
README
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
293
NAME
Plack::App::File::PYX - Plack PYX directory application.
SYNOPSIS
use Plack::App::File::PYX;
my $obj = Plack::App::File::PYX->new(%parameters);
my $psgi_ar = $obj->serve_path($env, $file);
my $app = $obj->to_app;
METHODS
"new"
my $obj = Plack::App::File::PYX->new(%parameters);
Constructor.
Returns instance of object.
* "content_type"
Content-Type of serialized output. There is possibility of callback
(reference to code) with $file argument which return content type
string.
Default value is 'text/html'.
* "encoding"
Set the file encoding for text files. Defaults to 'utf-8'.
* "file"
The file path to create responses from. Optional.
If it's set the application would ALWAYS create a response out of
the file and there will be no security check etc. (hence fast). If
it's not set, the application uses "root" to find the matching file.
* "indent"
Set Tags::Output::* class for output serialization.
Default value is Tags::Output::Raw.
* "root"
Document root directory. Defaults to "." (current directory)
"serve_path"
my $psgi_ar = $obj->serve_path($env, $file);
Process file on disk and serve it to application.
Returns reference to array (PSGI structure).
"to_app"
my $app = $obj->to_app;
Creates Plack application.
Returns Plack::Component object.
EXAMPLE1
use strict;
use warnings;
use File::Temp;
use IO::Barf;
use Plack::App::File::PYX;
use Plack::Runner;
# Temporary file with PYX.
my $temp_pyx_file = File::Temp->new->filename;
# PYX file.
my $pyx = <<'END';
(html
(head
(title
-Title
)title
)head
(body
(div
-Hello world
)div
)body
)html
END
barf($temp_pyx_file, $pyx);
# Run application with one PYX file.
my $app = Plack::App::File::PYX->new('file' => $temp_pyx_file)->to_app;
Plack::Runner->new->run($app);
# Output:
# HTTP::Server::PSGI: Accepting connections at http://0:5000/
# > curl http://localhost:5000/
# <html><head><title>Title</title></head><body><div>Hello world</div></body></html>
EXAMPLE2
use strict;
use warnings;
use File::Temp;
use IO::Barf;
use Plack::App::File::PYX;
use Plack::Runner;
# Temporary file with PYX.
my $temp_pyx_file = File::Temp->new->filename;
# PYX file.
my $pyx = <<'END';
(html
(head
(title
-Title
)title
)head
(body
(div
-Hello world
)div
)body
)html
END
barf($temp_pyx_file, $pyx);
# Run application with one PYX file.
my $app = Plack::App::File::PYX->new(
'file' => $temp_pyx_file,
'indent' => 'Tags::Output::Indent',
)->to_app;
Plack::Runner->new->run($app);
# Output:
# HTTP::Server::PSGI: Accepting connections at http://0:5000/
# > curl http://localhost:5000/
# <html>
# <head>
# <title>
# Title
# </title>
# </head>
# <body>
# <div>
# Hello world
# </div>
# </body>
# </html>
EXAMPLE3
use strict;
use warnings;
use File::Temp;
use IO::Barf;
use Plack::App::File::PYX;
use Plack::Runner;
# Temporary file with PYX.
my $temp_pyx_file = File::Temp->new->filename;
# PYX file.
my $pyx = <<'END';
?xml version="1.0"
(svg
Axmlns http://www.w3.org/2000/svg
(rect
Ax 80
Ay 60
Awidth 250
Aheight 250
Arx 20
Astyle fill:#ff0000; stroke:#000000; stroke-width:2px;
)rect
(rect
Ax 140
Ay 120
Awidth 250
Aheight 250
Arx 40
Astyle fill:#0000ff; stroke:#000000; stroke-width:2px; fill-opacity:0.7;
)rect
)svg
END
barf($temp_pyx_file, $pyx);
# Run application with one PYX file.
my $app = Plack::App::File::PYX->new(
'content_type' => 'image/svg+xml',
'file' => $temp_pyx_file,
'indent' => 'Tags::Output::Indent',
)->to_app;
Plack::Runner->new->run($app);
# Output:
# HTTP::Server::PSGI: Accepting connections at http://0:5000/
# > curl http://localhost:5000/
# <?xml version="1.0"?>
# <svg xmlns="http://www.w3.org/2000/svg">
# <rect x="80" y="60" width="250" height="250" rx="20" style=
# "fill:#ff0000; stroke:#000000; stroke-width:2px;">
# </rect>
# <rect x="140" y="120" width="250" height="250" rx="40" style=
# "fill:#0000ff; stroke:#000000; stroke-width:2px; fill-opacity:0.7;">
# </rect>
# </svg>
EXAMPLE4
use strict;
use warnings;
use File::Temp;
use IO::Barf;
use Plack::App::File::PYX;
use Plack::Runner;
# Temporary file with PYX.
my $temp_pyx_file = File::Temp->new->filename;
# PYX file in UTF8, prepared for iso-8859-2 output.
my $pyx = <<'END';
(html
(head
(title
-žščřďťň
)title
(meta
Acharset iso-8859-2
)meta
)head
(body
(div
-Hello in iso-8859-2 encoding - Ahoj světe!
)div
)body
)html
END
barf($temp_pyx_file, $pyx);
# Run application with one PYX file.
my $app = Plack::App::File::PYX->new(
'encoding' => 'iso-8859-2',
'file' => $temp_pyx_file,
'indent' => 'Tags::Output::Indent',
)->to_app;
Plack::Runner->new->run($app);
# Output:
# HTTP::Server::PSGI: Accepting connections at http://0:5000/
# > curl http://localhost:5000/
# XXX in ISO-8859-2 encoding
# <html>
# <head>
# <title>
# žščřďťň
# </title>
# <meta charset="iso-8859-2">
# </meta>
# </head>
# <body>
# <div>
# Hello in iso-8859-2 encoding - Ahoj světe!
# </div>
# </body>
# </html>
DEPENDENCIES
Encode, English, Error::Pure, HTTP::Date, Plack::App::File,
Plack::Util::Accessor, PYX::SGML::Tags, Tags::Output::Raw,
Unicode::UTF8.
REPOSITORY
<https://github.com/michal-josef-spacek/Plack-App-File-PYX>
AUTHOR
Michal Josef Špaček <mailto:[email protected]>
<http://skim.cz>
LICENSE AND COPYRIGHT
© 2020 Michal Josef Špaček
BSD 2-Clause License
VERSION
0.02