File Coverage

blib/lib/Rest/HtmlVis.pm

Criterion	Covered	Total	%
statement	9	54	16.6
branch	0	30	0.0
condition	0	3	0.0
subroutine	3	7	42.8
pod	2	3	66.6
total	14	97	14.4

package Rest::HtmlVis;

use 5.006;
use strict;
use warnings FATAL => 'all';

=head1 NAME

Rest::HtmlVis - Rest API visualizer in HTML

=head1 VERSION

Version 0.01

=cut

our $VERSION = '0.01';


=head1 SYNOPSIS

Transform perl hash to html.
Each key in perl hash is transormed to the piece of html, js and css those are include in main html.

Example:

	use Rest::HtmlVis;

	my $htmlvis = Rest::HtmlVis->new({
		events => Rest::HtmlVis::Events
	});

	$htmlvis->html({

		events => [
		],

		links => {
			rel => 'root',
			href => /,
			name => Root resource
		}

		form => {
			GET => {
				from => {
					type => 'time',
					default => time(),
				}
			},
			POST => {
				DATA => {
					type => "text"
					temperature => 25
				},

			}
		}
	});


HtmlVis has default blocks that are show everytime:

=over 4

=item * default.base

See L.

=item * default.content

See L.

=back

These blocks can be rewrite when the base or content key is set in constructor params.

=head1 SUBROUTINES/METHODS

=head2 new( params )

Create new htmlvis object. You have to specify params for keys that should be transformed.

=head3 params

Define keys in input hash and library that manage this key.

Example:

	{ events => Rest::HtmlVis::Events }

Specific param is 'param.local' that defines if third party javascript and css is download from internet or from local repository.
If you want to use local repository it is important to serve static content from static directory.
Example:

	mount '/static' => Plack::App::File->new(root => "/path_to_static_directory/static/")->to_app;

=cut

my $based = {
	'default.base' => 'Rest::HtmlVis::Base',
	'default.content' => 'Rest::HtmlVis::Content',
};

sub new {
	my ($class, $params) = @_;

	my $htmlVis;

	my $self = bless {}, $class;

	### Set local
	$self->{local} = delete $params->{'param.local'} if exists $params->{'param.local'};

	### Set params
	foreach my $key (keys %$params) {
		$based->{$key} = $params->{$key};
	}

	### Add htmlvis
	foreach my $key (sort keys %{$based}){
		$self->loadVisObject($key, $based->{$key});
	}

	return $self;
}

sub loadVisObject {
	my ($self, $key, $class) = @_;

	if (_try_load($class)){
		my $vis = $class->new;
		my $order = $vis->getOrder;
		push(@{$self->{htmlVis}{$order}}, {
			key => $key,
			object => $vis
		}) if $vis->isa('Rest::HtmlVis::Key');
	}
}

=head2 html( hash_struct )

Convert input hash struct to html. Return html string.

=cut

sub html {
	my ($self, $struct, $env) = @_;

	return unless ref $struct eq 'HASH';

	### manage keys
	my $head_parts = '';
	my $onload_parts = '';
	my $html_parts = '';

	my $rowBlocks = 0; # count number of blocks in row

	### Add blocks
	foreach my $order (sort keys %{$self->{htmlVis}}) {
		foreach my $obj (@{$self->{htmlVis}{$order}}) {

			my $vis = $obj->{object};
			next unless $vis->setStruct($obj->{key}, $struct, $env);

			my $head = $vis->head($self->{local});
			$head_parts .= $head if $head;

			my $onload = $vis->onload();
			$onload_parts .= $onload if $onload;

			my $html = $vis->html();
			if ($html){
				$rowBlocks += $vis->blocks();
				my $newRow = ($vis->newRow() or $rowBlocks > 12) ? 1 : 0;

				$html_parts .= '' if $newRow;
				$html_parts .= $html;
				$html_parts .= '' if $newRow;
				$rowBlocks = 0 if $newRow;
			}
		}
	}

	return "\n\n\n$head_parts\n\n\n$html_parts\n\n";
}

### Try load library
sub _try_load {
	my $mod = shift;

	return 0 unless $mod;
	return 1 if ($mod->can("html")); # because of local class in psgi
	eval("use $mod; 1") ? return 1 : return 0;
}

=head1 TUTORIAL

L

=head1 AUTHOR

Vaclav Dovrtel, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to github repository.

=head1 ACKNOWLEDGEMENTS

Inspired by L

=head1 REPOSITORY

L

=head1 LICENSE AND COPYRIGHT

Copyright 2015 Vaclav Dovrtel.

This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.

See L for more information.

=cut

1; # End of Rest::HtmlVis