blob: 0ee6b7864a1790a4e541a41eeda9fcae45d03c00 (
plain)
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
|
package Dancer2::Serializer::JSON;
# ABSTRACT: Serializer for handling JSON data
$Dancer2::Serializer::JSON::VERSION = '1.1.0';
use Moo;
use JSON::MaybeXS ();
use Scalar::Util 'blessed';
with 'Dancer2::Core::Role::Serializer';
has '+content_type' => ( default => sub {'application/json'} );
# helpers
sub from_json { __PACKAGE__->deserialize(@_) }
sub to_json { __PACKAGE__->serialize(@_) }
sub decode_json {
my ( $entity ) = @_;
JSON::MaybeXS::decode_json($entity);
}
sub encode_json {
my ( $entity ) = @_;
JSON::MaybeXS::encode_json($entity);
}
# class definition
sub serialize {
my ( $self, $entity, $options ) = @_;
my $config = blessed $self ? $self->config : {};
foreach (keys %$config) {
$options->{$_} = $config->{$_} unless exists $options->{$_};
}
$options->{utf8} = 1 if !defined $options->{utf8};
JSON::MaybeXS->new($options)->encode($entity);
}
sub deserialize {
my ( $self, $entity, $options ) = @_;
$options->{utf8} = 1 if !defined $options->{utf8};
JSON::MaybeXS->new($options)->decode($entity);
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dancer2::Serializer::JSON - Serializer for handling JSON data
=head1 VERSION
version 1.1.0
=head1 DESCRIPTION
This is a serializer engine that allows you to turn Perl data structures into
JSON output and vice-versa.
=head1 ATTRIBUTES
=head2 content_type
Returns 'application/json'
=head1 METHODS
=head2 serialize($content)
Serializes a Perl data structure into a JSON string.
=head2 deserialize($content)
Deserializes a JSON string into a Perl data structure.
=head1 FUNCTIONS
=head2 from_json($content, \%options)
This is an helper available to transform a JSON data structure to a Perl data structures.
=head2 to_json($content, \%options)
This is an helper available to transform a Perl data structure to JSON.
Calling this function will B<not> trigger the serialization's hooks.
=head2 Configuring the JSON Serializer using C<set engines>
The JSON serializer options can be configured via C<set engines>. The most
common settings are:
=over 4
=item allow_nonref
Ignore non-ref scalars returned from handlers. With this set the "Hello, World!"
handler returning a string will be dealt with properly.
=back
Set engines should be called prior to setting JSON as the serializer:
set engines =>
{
serializer =>
{
JSON =>
{
allow_nonref => 1
},
}
};
set serializer => 'JSON';
set content_type => 'application/json';
=head2 Returning non-JSON data.
Handlers can return non-JSON via C<send_as>, which overrides the default serializer:
get '/' =>
sub
{
send_as html =>
q{Welcome to the root of all evil...<br>step into my office.}
};
Any other non-JSON returned format supported by 'send_as' can be used.
=head1 AUTHOR
Dancer Core Developers
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2023 by Alexis Sukrieh.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|
