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
|
package PGObject::Type::JSON;
use 5.010;
use strict;
use warnings;
use PGObject;
use JSON;
use Carp 'croak';
=head1 NAME
PGObject::Type::JSON - JSON wrappers for PGObject
=head1 VERSION
Version 2.0.1
=cut
our $VERSION = 2.000001;
=head1 SYNOPSIS
PGOBject::Type::JSON->register();
Columns of type json will be converted into hashrefs
my $obj = PGOBject::Type::JSON->new($hashref);
$obj will now serialize to the database as json.
=head1 DESCRIPTION
This module allows json types or others (specified by custom register) types to
be converted from JSON into objects according to their values.
This module assumes that encoding will be in UTF8 across the board and is not
safe to use with other database encodings.
=head1 SUBROUTINES/METHODS
=head2 register(registry => 'default', types => ['json'])
=cut
sub register{
my $self = shift @_;
croak "Can't pass reference to register \n".
"Hint: use the class instead of the object" if ref $self;
my %args = @_;
my $registry = $args{registry};
$registry ||= 'default';
my $types = $args{types};
$types = ['json', 'jsonb'] unless defined $types and @$types;
for my $type (@$types){
if ($PGObject::VERSION =~ /^1./){
my $ret =
PGObject->register_type(registry => $registry, pg_type => $type,
perl_class => $self);
return $ret unless $ret;
} else {
PGObject::Type::Registry->register_type(
registry => $registry, dbtype => $type, apptype => $self
);
}
}
return 1;
}
=head2 new($ref)
Stores this as a reference. Currently database nulls are stored as cyclical
references which is probably a bad idea. In the future we should probably
have a lexically scoped table for this.
=cut
sub new {
my ($class, $ref) = @_;
if (!ref $ref) {
my $src = $ref;
$ref = \$src;
}
bless $ref, $class;
}
=head2 from_db
serializes from the db. Note that database nulls are preserved distinct from
json null's.
=cut
sub from_db {
my ($class, $var) = @_;
$var = \$var unless defined $var;
return "$class"->new($var) if ref $var;
return "$class"->new(JSON->new->allow_nonref->decode($var));
}
=head2 to_db
returns undef if is_null. Otherwise returns the value encoded as JSON
=cut
sub to_db {
my $self = shift @_;
return undef if $self->is_null;
my $copy;
for ($self->reftype){
if ($_ eq 'SCALAR') { $copy = $$self if $_ eq 'SCALAR' }
elsif ($_ eq 'ARRAY') { $copy = []; push @$copy, $_ for @$self; }
elsif ($_ eq 'HASH') { $copy = {};
$copy->{$_} = $self->{$_} for keys %$self; }
}
return JSON->new->allow_nonref->convert_blessed->encode($copy);
}
=head2 reftype
Returns the reftype of the object (i.e. HASH, SCALAR, ARRAY)
=cut
sub reftype {
my ($self) = @_;
my $reftype = "$self";
my $pkg = __PACKAGE__;
$reftype =~ s/${pkg}=(\w+)\(.*\)/$1/;
$reftype = 'SCALAR' if $reftype eq 'REF';
return $reftype;
}
=head2 is_null
Returns true if is a database null.
=cut
sub is_null {
my $self = shift @_;
return 0 if $self->reftype ne 'SCALAR';
return 0 if !defined $$self;
return 1 if ref $self && ($self eq $$self);
return 0;
}
=head1 AUTHOR
Chris Travers, C<< <chris.travers at gmail.com> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-pgobject-type-json at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=PGObject-Type-JSON>. I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc PGObject::Type::JSON
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker (report bugs here)
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=PGObject-Type-JSON>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/PGObject-Type-JSON>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/PGObject-Type-JSON>
=item * Search CPAN
L<http://search.cpan.org/dist/PGObject-Type-JSON/>
=back
=head1 ACKNOWLEDGEMENTS
=head1 LICENSE AND COPYRIGHT
Copyright 2013 Chris Travers.
This program is released under the following license: BSD
=cut
1; # End of PGObject::Type::JSON
|
