CPAN::Groonga

package Zing::Encoder::Json;

use 5.014;

use strict;
use warnings;

use registry 'Zing::Types';
use routines;

use Data::Object::Class;

extends 'Zing::Encoder';

use JSON -convert_blessed_universally;

our $VERSION = '0.01'; # VERSION

# METHODS

method decode(Str $data) {
  return JSON->new->allow_nonref->convert_blessed->decode($data);
}

method encode(HashRef $data) {
  return JSON->new->allow_nonref->convert_blessed->encode($data);
}

1;

=encoding utf8

=head1 NAME

Zing::Encoder::Json - JSON Serialization Abstraction

=cut

=head1 ABSTRACT

JSON Data Serialization Abstraction

=cut

=head1 SYNOPSIS

  use Zing::Encoder::Json;

  my $encoder = Zing::Encoder::Json->new;

  # $encoder->encode({ status => 'okay' });

=cut

=head1 DESCRIPTION

This package provides a L<JSON> data serialization abstraction for use with
L<Zing::Store> stores.

=cut

=head1 LIBRARIES

This package uses type constraints from:

L<Zing::Types>

=cut

=head1 METHODS

This package implements the following methods:

=cut

=head2 decode

  decode(Str $data) : HashRef

The decode method decodes the data provided.

=over 4

=item decode example #1

  # given: synopsis

  $encoder->decode('{ "status":"okay" }');

=back

=cut

=head2 encode

  encode(HashRef $data) : Str

The encode method encodes the data provided.

=over 4

=item encode example #1

  # given: synopsis

  $encoder->encode({ status => 'okay' });

=back

=cut

=head1 AUTHOR

Al Newkirk, C<awncorp@cpan.org>

=head1 LICENSE

Copyright (C) 2011-2019, Al Newkirk, et al.

This is free software; you can redistribute it and/or modify it under the terms
of the The Apache License, Version 2.0, as elucidated in the L<"license
file"|https://github.com/iamalnewkirk/zing-encoder-json/blob/master/LICENSE>.

=head1 PROJECT

L<Wiki|https://github.com/iamalnewkirk/zing-encoder-json/wiki>

L<Project|https://github.com/iamalnewkirk/zing-encoder-json>

L<Initiatives|https://github.com/iamalnewkirk/zing-encoder-json/projects>

L<Milestones|https://github.com/iamalnewkirk/zing-encoder-json/milestones>

L<Contributing|https://github.com/iamalnewkirk/zing-encoder-json/blob/master/CONTRIBUTE.md>

L<Issues|https://github.com/iamalnewkirk/zing-encoder-json/issues>

=cut