Dave Cross: Still Munging Data With Perl: Online event - Mar 17 Learn more

RTKH / Raisin-0.94 / lib / Raisin / Encoder.pm 

            

              
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

              
#!perl
#PODNAME: Raisin::Encoder
#ABSTRACT: A helper for L<Raisin::Middleware::Formatter> over encoder modules
use strict;
use warnings;
package Raisin::Encoder;
$Raisin::Encoder::VERSION = '0.94';
use Plack::Util;
use Plack::Util::Accessor qw(registered);
sub new { bless { registered => {} }, shift }
sub register {
    my ($self, $format, $class) = @_;
    $self->{registered}{$format} = $class;
}
sub builtin {
    {
        json => 'Raisin::Encoder::JSON',
        yaml => 'Raisin::Encoder::YAML',
        text => 'Raisin::Encoder::Text',
    };
}
sub all {
    my $self = shift;
    my %s = (
        %{ $self->builtin },
        %{ $self->registered },
    );
    \%s;
}
sub for {
    my ($self, $format) = @_;
    $self->all->{$format};
}
sub media_types_map_flat_hash {
    my $self = shift;
    my $s = $self->all;
    my %media_types_map = map {
        Plack::Util::load_class($s->{$_});
        $_ => $s->{$_}->detectable_by;
    } keys %$s;
    my %media_types_map_flat_hash = map {
        my $k = $_; map { $_ => $k } @{ $media_types_map{$k} }
    } keys %media_types_map;
    %media_types_map_flat_hash;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Raisin::Encoder - A helper for L<Raisin::Middleware::Formatter> over encoder modules
=head1 VERSION
version 0.94
=head1 SYNOPSIS
    my $enc = Raisin::Encoder->new;
    $enc->register(xml => 'Some::XML::Formatter');
    $enc->for('json');
    $enc->media_types_map_flat_hash;
=head1 DESCRIPTION
Provides an easy interface to use and register encoders.
=head1 METHODS
=head2 register
Allows user to register their own encoders.
    $enc->register(xml => 'Some::XML::Formatter');
Also it can override L</builtin> types as the user ones have more precedence.
    $enc->register(json => 'My::Own::JSON::Formatter');
=head2 builtin
Returns a list of encoders which are bundled with L<Raisin>.
They are: L<Raisin::Encoder::JSON>, L<Raisin::Encoder::Text>,
L<Raisin::Encoder::YAML>.
=head2 registered
Returns a list of encoders which were registered by user.
=head2 all
Returns a list of both L</builtin> and L</users>.
=head2 for
Returns a class name for specified format.
=head2 media_types_map_flat_hash
Returns a hash of media types and associated formats.
=head1 AUTHOR
Artur Khabibullin
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2019 by Artur Khabibullin.
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