File Coverage

blib/lib/Formatter/HTML/Preformatted.pm

Criterion	Covered	Total	%
statement	36	37	97.3
branch	1	2	50.0
condition	1	3	33.3
subroutine	9	10	90.0
pod	5	5	100.0
total	52	57	91.2

package Formatter::HTML::Preformatted;

use 5.006;
use strict;
use warnings;
use URI::Find::Simple qw( list_uris change_uris );


our $VERSION = '0.95';

=head1 NAME

Formatter::HTML::Preformatted - Absolute minimal HTML formatting of pure text

=head1 SYNOPSIS

  use Formatter::HTML::Preformatted;
  my $formatter = Formatter::HTML::Preformatted->format($data);
  print $formatter->fragment;
  my @links = $text->links;
  print ${$links}[0]->{url};

=head1 DESCRIPTION

This module will simply take any text-string and put it in a HTML
C element. It will escape tags and entities. It will also look
through it to see if there are any URIs, and they will be turned into
hyperlinks.

=head1 METHODS

This module conforms with the L API specification, version 0.95:

=over

=item C

The format function that you call to initialise the formatter. It
takes the plain text as a string argument and returns an object of
this class.

=cut

sub format {
  my $that  = shift;
  my $class = ref($that) || $that;
  my $self = {
	      _text => shift,
	     };
  bless($self, $class);
  return $self;
}

=item C

To get only the text enclosed in the minimal C element, you will
call this method. It returns a string with the HTML fragment.

=cut

sub fragment {
  my $self = shift;
  my $raw = $self->{_text};
  # Escaping the stuff that needs escaping.
  $raw =~ s/&/&/g;
  $raw =~ s/\>/>/g;
  $raw =~ s/\

  return "\n" . change_uris($raw, sub { "$_[0]" }) . "\n\n";
}

=item C

Will add a document type declaration and some minimal markup, to
return a full, valid, HTML document. You may specify an optional
C<$charset> parameter. This will include a HTML C element with
the chosen character set. It will still be your responsibility to
ensure that the document served is encoded with this character set.

=cut

sub document {
  my $self = shift;
  my $result = '' . "\n\n";
  my $charset = shift;
  if ($charset) {
    $result .= "\n" . '' . "\n\n";
  }
  $result .= "\n" . $self->fragment . "\n\n\n";
  return $result;
}


=item C

Will return all links found the input plain text string. They will be
found in an arrayref where each element has a key C.

=cut

sub links {
  my $self = shift;
  my @arr;
  foreach (list_uris($self->{_text})) {
    push(@arr, {url => $_, title => ''});
  }
  return \@arr;
}

=item C </td>
</tr>

<tr>
<td  class="h" >
<a name="111">111</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s">   </td>
</tr>

<tr>
<td  class="h" >
<a name="112">112</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s"> Since this formatter has no way of finding the title of the document </td>
</tr>

<tr>
<td  class="h" >
<a name="113">113</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s"> this method will always return C<undef>. </td>
</tr>

<tr>
<td  class="h" >
<a name="114">114</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s">   </td>
</tr>

<tr>
<td  class="h" >
<a name="115">115</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s"> =cut </td>
</tr>

<tr>
<td  class="h" >
<a name="116">116</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s">   </td>
</tr>

<tr>
<td  class="h" >
<a name="117">117</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s">   </td>
</tr>

<tr>
<td  class="h" >
<a name="118">118</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s"> sub title { </td>
</tr>

<tr>
<td  class="h" >
<a name="119">119</a>
</td>

<td  class="c0" >

0

</td>

<td >

 

</td>

<td >

 

</td>

<td  class="c0" >
 <a href="blib-lib-Formatter-HTML-Preformatted-pm--subroutine.html#119-1"> 
0
 </a> 
</td>

<td  class="c3" >
 <a href="blib-lib-Formatter-HTML-Preformatted-pm--subroutine.html#119-1"> 
1
 </a> 
</td>

<td >

 

</td>

<td class="s">   return undef; </td>
</tr>

<tr>
<td  class="h" >
<a name="120">120</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s"> } </td>
</tr>

<tr>
<td  class="h" >
<a name="121">121</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s">   </td>
</tr>

<tr>
<td  class="h" >
<a name="122">122</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s">   </td>
</tr>

<tr>
<td  class="h" >
<a name="123">123</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s">   </td>
</tr>

<tr>
<td  class="h" >
<a name="124">124</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s">   </td>
</tr>

<tr>
<td  class="h" >
<a name="125">125</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s">   </td>
</tr>

<tr>
<td  class="h" >
<a name="126">126</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s"> 1; </td>
</tr>

<tr>
<td  class="h" >
<a name="127">127</a>
</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td >

 

</td>

<td class="s"> __END__ </td>
</tr>

</table>

</body>
</html>