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
|
package DBIx::Class::Helper::Row::ToJSON;
$DBIx::Class::Helper::Row::ToJSON::VERSION = '2.037000';
# ABSTRACT: Remove the boilerplate from your TO_JSON functions
use strict;
use warnings;
use parent 'DBIx::Class::Row';
__PACKAGE__->mk_group_accessors(inherited => '_serializable_columns');
__PACKAGE__->mk_group_accessors(inherited => '_unserializable_data_types');
my $dont_serialize = {
text => 1,
ntext => 1,
blob => 1,
};
sub _is_column_serializable {
my ( $self, $column ) = @_;
my $info = $self->column_info($column);
if (!defined $info->{is_serializable}) {
if (defined $info->{data_type} &&
$self->unserializable_data_types->{lc $info->{data_type}}
) {
$info->{is_serializable} = 0;
} else {
$info->{is_serializable} = 1;
}
}
return $info->{is_serializable};
}
sub serializable_columns {
my $self = shift;
if (!$self->_serializable_columns) {
$self->_serializable_columns([
grep $self->_is_column_serializable($_),
$self->result_source->columns
]);
}
return $self->_serializable_columns;
}
sub TO_JSON {
my $self = shift;
my $columns_info = $self->columns_info($self->serializable_columns);
return {
map +($_ => $self->$_),
map +($columns_info->{$_}{accessor} || $_),
keys %$columns_info
};
}
sub unserializable_data_types {
my $self = shift;
if (!$self->_unserializable_data_types) {
$self->_unserializable_data_types($dont_serialize);
}
return $self->_unserializable_data_types;
}
1;
__END__
=pod
=head1 NAME
DBIx::Class::Helper::Row::ToJSON - Remove the boilerplate from your TO_JSON functions
=head1 SYNOPSIS
package MyApp::Schema::Result::KittenRobot;
use parent 'DBIx::Class::Core';
__PACKAGE__->load_components(qw{Helper::Row::ToJSON});
__PACKAGE__->table('KittenRobot');
__PACKAGE__->add_columns(
id => {
data_type => 'integer',
is_auto_increment => 1,
},
kitten => {
data_type => 'integer',
},
robot => {
data_type => 'text',
is_nullable => 1,
},
your_mom => {
data_type => 'blob',
is_nullable => 1,
is_serializable => 1,
},
);
1;
This helper adds a JSON method like the following:
sub TO_JSON {
return {
id => $self->id,
kitten => $self->kitten,
# robot => $self->robot, # <-- doesn't serialize text columns
your_mom => $self->your_mom, # <-- normally wouldn't but explicitly
# asked for in the column spec above
}
}
=head1 METHODS
=head2 _is_column_serializable
$self->_is_column_serializable('kitten')
returns true if a column should be serializable or not. Currently this marks
everything as serializable unless C<is_serializable> is set to false, or
C<data_type> is a C<blob>, C<text>, or C<ntext> columns. If you wanted to only
have explicit serialization you might override this method to look like this:
sub _is_column_serializable {
my ( $self, $column ) = @_;
my $info = $self->column_info($column);
return defined $info->{is_serializable} && $info->{is_serializable};
}
=head2 serializable_columns
$self->serializable_columns
simply returns a list of columns that TO_JSON should serialize.
=head2 TO_JSON
$self->TO_JSON
returns a hashref representing your object. Override this method to add data
to the returned hashref:
sub TO_JSON {
my $self = shift;
return {
customer_name => $self->customer->name,
%{ $self->next::method },
}
}
=head2 unserializable_data_types
$self->unserializable_data_types
Simply returns a hashref of data types that TO_JSON should not serialize.
Defaults to C<blob>, C<text>, or C<ntext>.
If you wanted to allow serialization of text data types, you might override this
method to look like this:
sub unserializable_data_types {
return {
blob => 1,
ntext => 1,
};
}
=head1 AUTHOR
Arthur Axel "fREW" Schmidt <frioux+cpan@gmail.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2024 by Arthur Axel "fREW" Schmidt.
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
|
