d051495a08a9fd6aaf3e6f0e63a4875e8ee8ca32
[gitmo/MooseX-Storage.git] / lib / MooseX / Storage / Util.pm
1 package MooseX::Storage::Util;
2 use Moose qw(confess blessed);
3
4 use MooseX::Storage::Engine ();
5 use utf8 ();
6
7 our $VERSION   = '0.30';
8 our $AUTHORITY = 'cpan:STEVAN';
9
10 sub peek {
11     my ($class, $data, %options) = @_;
12
13     if (exists $options{'format'}) {
14
15         my $inflater = $class->can('_inflate_' . lc($options{'format'}));
16
17         (defined $inflater)
18             || confess "No inflater found for " . $options{'format'};
19
20         $data = $class->$inflater($data);
21     }
22
23     (ref($data) && ref($data) eq 'HASH' && !blessed($data))
24         || confess "The data has to be a HASH reference, but not blessed";
25
26     $options{'key'} ||= $MooseX::Storage::Engine::CLASS_MARKER;
27
28     return $data->{$options{'key'}};
29
30 }
31
32 sub _inflate_json {
33     my ($class, $json) = @_;
34
35     eval { require JSON::Any; JSON::Any->import };
36     confess "Could not load JSON module because : $@" if $@;
37
38     utf8::encode($json) if utf8::is_utf8($json);
39
40     my $data = eval { JSON::Any->jsonToObj($json) };
41     if ($@) {
42         confess "There was an error when attempting to peek at JSON: $@";
43     }
44
45     return $data;
46 }
47
48 sub _inflate_yaml {
49     my ($class, $yaml) = @_;
50
51     require Best;
52     eval { Best->import([[ qw[YAML::Syck YAML] ]]) };
53     confess "Could not load YAML module because : $@" if $@;
54
55     my $inflater = Best->which('YAML::Syck')->can('Load');
56
57     (defined $inflater)
58         || confess "Could not load the YAML inflator";
59
60     my $data = eval { $inflater->($yaml) };
61     if ($@) {
62         confess "There was an error when attempting to peek at YAML : $@";
63     }
64     return $data;
65 }
66
67 no Moose::Role;
68
69 1;
70
71 __END__
72
73 =pod
74
75 =head1 NAME
76
77 MooseX::Storage::Util - A MooseX::Storage swiss-army chainsaw
78
79 =head1 DESCRIPTION
80
81 This module provides a set of tools, some sharp and focused,
82 others more blunt and crude. But no matter what, they are useful
83 bits to have around when dealing with MooseX::Storage code.
84
85 =head1 METHODS
86
87 All the methods in this package are class methods and should
88 be called appropriately.
89
90 =over 4
91
92 =item B<peek ($data, %options)>
93
94 This method will help you to verify that the serialized class you
95 have gotten is what you expect it to be before you actually
96 unfreeze/unpack it.
97
98 The C<$data> can be either a perl HASH ref or some kind of serialized
99 data (JSON, YAML, etc.).
100
101 The C<%options> are as follows:
102
103 =over 4
104
105 =item I<format>
106
107 If this is left blank, we assume that C<$data> is a plain perl HASH ref
108 otherwise we attempt to inflate C<$data> based on the value of this option.
109
110 Currently only JSON and YAML are supported here.
111
112 =item I<key>
113
114 The default is to try and extract the class name, but if you want to check
115 another key in the data, you can set this option. It will return the value
116 found in the key for you.
117
118 =back
119
120 =back
121
122 =head2 Introspection
123
124 =over 4
125
126 =item B<meta>
127
128 =back
129
130 =head1 TODO
131
132 Add more stuff to this module :)
133
134 =head1 BUGS
135
136 All complex software has bugs lurking in it, and this module is no
137 exception. If you find a bug please either email me, or add the bug
138 to cpan-RT.
139
140 =head1 AUTHOR
141
142 Stevan Little E<lt>stevan.little@iinteractive.comE<gt>
143
144 =head1 COPYRIGHT AND LICENSE
145
146 Copyright 2007-2008 by Infinity Interactive, Inc.
147
148 L<http://www.iinteractive.com>
149
150 This library is free software; you can redistribute it and/or modify
151 it under the same terms as Perl itself.
152
153 =cut