package Mojo::ByteStream; use Mojo::Base -base; use overload '""' => sub { shift->to_string }, fallback => 1; use Mojo::Collection; use Mojo::Util; sub import { my $class = shift; return unless @_ > 0; no strict 'refs'; no warnings 'redefine'; my $caller = caller; *{"${caller}::b"} = sub { $class->new(@_) }; } # "Do we have any food that wasn't brutally slaughtered? # Well, I think the veal died of loneliness." sub new { my $self = shift->SUPER::new(); $self->{bytestream} = join '', @_; return $self; } sub b64_decode { my $self = shift; $self->{bytestream} = Mojo::Util::b64_decode($self->{bytestream}); return $self; } sub b64_encode { my $self = shift; $self->{bytestream} = Mojo::Util::b64_encode($self->{bytestream}, @_); return $self; } sub camelize { my $self = shift; Mojo::Util::camelize $self->{bytestream}; return $self; } sub clone { my $self = shift; return $self->new($self->{bytestream}); } sub decamelize { my $self = shift; Mojo::Util::decamelize $self->{bytestream}; return $self; } # "I want to share something with you: The three little sentences that will # get you through life. # Number 1: 'Cover for me.' # Number 2: 'Oh, good idea, Boss!' # Number 3: 'It was like that when I got here.'" sub decode { my $self = shift; Mojo::Util::decode shift || 'UTF-8', $self->{bytestream}; return $self; } sub encode { my $self = shift; Mojo::Util::encode shift || 'UTF-8', $self->{bytestream}; return $self; } sub hmac_md5_sum { my $self = shift; $self->{bytestream} = Mojo::Util::hmac_md5_sum $self->{bytestream}, @_; return $self; } sub hmac_sha1_sum { my $self = shift; $self->{bytestream} = Mojo::Util::hmac_sha1_sum $self->{bytestream}, @_; return $self; } sub html_escape { my $self = shift; Mojo::Util::html_escape $self->{bytestream}; return $self; } sub html_unescape { my $self = shift; Mojo::Util::html_unescape $self->{bytestream}; return $self; } sub md5_bytes { my $self = shift; $self->{bytestream} = Mojo::Util::md5_bytes $self->{bytestream}; return $self; } sub md5_sum { my $self = shift; $self->{bytestream} = Mojo::Util::md5_sum $self->{bytestream}; return $self; } sub punycode_decode { my $self = shift; Mojo::Util::punycode_decode $self->{bytestream}; return $self; } sub punycode_encode { my $self = shift; Mojo::Util::punycode_encode $self->{bytestream}; return $self; } # "Old people don't need companionship. # They need to be isolated and studied so it can be determined what # nutrients they have that might be extracted for our personal use." sub qp_decode { my $self = shift; Mojo::Util::qp_decode $self->{bytestream}; return $self; } sub qp_encode { my $self = shift; Mojo::Util::qp_encode $self->{bytestream}; return $self; } sub quote { my $self = shift; Mojo::Util::quote $self->{bytestream}; return $self; } sub say { my ($self, $handle) = @_; $handle ||= \*STDOUT; utf8::encode $self->{bytestream} if utf8::is_utf8 $self->{bytestream}; print $handle $self->{bytestream}, "\n"; } sub secure_compare { my ($self, $check) = @_; return Mojo::Util::secure_compare $self->{bytestream}, $check; } sub sha1_bytes { my $self = shift; $self->{bytestream} = Mojo::Util::sha1_bytes $self->{bytestream}; return $self; } sub sha1_sum { my $self = shift; $self->{bytestream} = Mojo::Util::sha1_sum $self->{bytestream}; return $self; } sub size { length shift->{bytestream} } sub split { my ($self, $p) = @_; Mojo::Collection->new(map { $self->new($_) } split $p, $self->{bytestream}); } sub to_string { shift->{bytestream} } sub trim { my $self = shift; Mojo::Util::trim $self->{bytestream}, @_; return $self; } sub unquote { my $self = shift; Mojo::Util::unquote $self->{bytestream}, @_; return $self; } sub url_escape { my $self = shift; Mojo::Util::url_escape $self->{bytestream}, @_; return $self; } sub url_unescape { my $self = shift; Mojo::Util::url_unescape $self->{bytestream}; return $self; } sub xml_escape { my $self = shift; Mojo::Util::xml_escape $self->{bytestream}; return $self; } 1; __END__ =head1 NAME Mojo::ByteStream - ByteStream =head1 SYNOPSIS # Manipulate bytestreams use Mojo::ByteStream; my $stream = Mojo::ByteStream->new('foo_bar_baz'); print $stream->camelize; # Chain methods my $stream = Mojo::ByteStream->new('foo bar baz')->quote; $stream = $stream->unquote->encode('UTF-8')->b64_encode; print "$stream"; # Use the alternative constructor use Mojo::ByteStream 'b'; my $stream = b('foobarbaz')->html_escape; =head1 DESCRIPTION L<Mojo::ByteStream> provides a more friendly API for the bytestream manipulation functions in L<Mojo::Util>. =head1 METHODS L<Mojo::ByteStream> inherits all methods from L<Mojo::Base> and implements the following new ones. =head2 C<new> my $stream = Mojo::ByteStream->new('test123'); Construct a new L<Mojo::ByteStream> object. =head2 C<b64_decode> $stream = $stream->b64_decode; Base64 decode bytestream. =head2 C<b64_encode> $stream = $stream->b64_encode; $stream = $stream->b64_encode(''); Base64 encode bytestream. =head2 C<camelize> $stream = $stream->camelize; Convert snake case bytestream to camel case and replace C<-> with C<::>. foo_bar -> FooBar foo_bar-baz -> FooBar::Baz =head2 C<clone> my $stream2 = $stream->clone; Clone bytestream. =head2 C<decamelize> $stream = $stream->decamelize; Convert camel case bytestream to snake case and replace C<::> with C<->. FooBar -> foo_bar FooBar::Baz -> foo_bar-baz =head2 C<decode> $stream = $stream->decode; $stream = $stream->decode($encoding); Decode bytestream, defaults to C<UTF-8>. $stream->decode('UTF-8')->to_string; =head2 C<encode> $stream = $stream->encode; $stream = $stream->encode($encoding); Encode bytestream, defaults to C<UTF-8>. $stream->encode('UTF-8')->to_string; =head2 C<hmac_md5_sum> $stream = $stream->hmac_md5_sum($secret); Turn bytestream into HMAC-MD5 checksum of old content. =head2 C<hmac_sha1_sum> $stream = $stream->hmac_sha1_sum($secret); Turn bytestream into HMAC-SHA1 checksum of old content. Note that Perl 5.10 or L<Digest::SHA> are required for C<SHA1> support. =head2 C<html_escape> $stream = $stream->html_escape; HTML escape bytestream. =head2 C<html_unescape> $stream = $stream->html_unescape; HTML unescape bytestream. =head2 C<md5_bytes> $stream = $stream->md5_bytes; Turn bytestream into binary MD5 checksum of old content. =head2 C<md5_sum> $stream = $stream->md5_sum; Turn bytestream into MD5 checksum of old content. =head2 C<punycode_decode> $stream = $stream->punycode_decode; Punycode decode bytestream, as described in RFC 3492. =head2 C<punycode_encode> $stream = $stream->punycode_encode; Punycode encode bytestream, as described in RFC 3492. =head2 C<qp_decode> $stream = $stream->qp_decode; Quoted Printable decode bytestream. =head2 C<qp_encode> $stream = $stream->qp_encode; Quoted Printable encode bytestream. =head2 C<quote> $stream = $stream->quote; Quote bytestream. =head2 C<say> $stream->say; $stream->say(*STDERR); Print bytestream to handle or STDOUT and append a newline. =head2 C<secure_compare> my $success = $stream->secure_compare($string); Constant time comparison algorithm to prevent timing attacks. =head2 C<sha1_bytes> $stream = $stream->sha1_bytes; Turn bytestream into binary SHA1 checksum of old content. Note that Perl 5.10 or L<Digest::SHA> are required for C<SHA1> support. =head2 C<sha1_sum> $stream = $stream->sha1_sum; Turn bytestream into SHA1 checksum of old content. Note that Perl 5.10 or L<Digest::SHA> are required for C<SHA1> support. =head2 C<size> my $size = $stream->size; Size of bytestream. =head2 C<split> my $collection = $stream->split(','); Turn bytestream into L<Mojo::Collection>. Note that this method is EXPERIMENTAL and might change without warning! $stream->split(',')->map(sub { $_->quote })->join("\n")->say; =head2 C<to_string> my $string = $stream->to_string; Stringify bytestream. =head2 C<trim> $stream = $stream->trim; Trim whitespace characters from both ends of bytestream. =head2 C<unquote> $stream = $stream->unquote; Unquote bytestream. =head2 C<url_escape> $stream = $stream->url_escape; $stream = $stream->url_escape('A-Za-z0-9\-\.\_\~'); URL escape bytestream. =head2 C<url_unescape> $stream = $stream->url_unescape; URL unescape bytestream. =head2 C<xml_escape> $stream = $stream->xml_escape; XML escape bytestream, this is a much faster version of C<html_escape> escaping only the characters C<&>, C<E<lt>>, C<E<gt>>, C<"> and C<'>. =head1 SEE ALSO L<Mojolicious>, L<Mojolicious::Guides>, L<http://mojolicio.us>. =cut