added experimental max_memory_size attribute to Mojo::Asset::Memory

mojolicious · Oct 22, 2011 · 61e18b2 · 61e18b2
1 parent 8500233
commit 61e18b2
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 8 deletions.
diff --git a/Changes b/Changes
@@ -1,6 +1,8 @@
 This file documents the revision history for Perl extension Mojolicious.
 
 2.05    2011-10-22 00:00:00
+        - Added EXPERIMENTAL max_memory_size attribute to
+          Mojo::Asset::Memory.
         - Improved start_tls method in Mojo::IOLoop by allowing it to accept
           more options.
         - Improved MOJO_MAX_MEMORY_SIZE handling by moving it from

diff --git a/lib/Mojo/Asset.pm b/lib/Mojo/Asset.pm
@@ -84,7 +84,7 @@ Size of asset data in bytes.
 
 =head2 C<slurp>
 
-  my $string = $file->slurp;
+  my $string = $asset->slurp;
 
 Read all asset data at once.
 

diff --git a/lib/Mojo/Asset/File.pm b/lib/Mojo/Asset/File.pm
@@ -193,7 +193,8 @@ L<Mojo::Asset::File> is a container for file assets.
 
 =head1 ATTRIBUTES
 
-L<Mojo::Asset::File> implements the following attributes.
+L<Mojo::Asset::File> inherits all attributes from L<Mojo::Asset> and
+implements the following new ones.
 
 =head2 C<cleanup>
 

diff --git a/lib/Mojo/Asset/Memory.pm b/lib/Mojo/Asset/Memory.pm
@@ -5,6 +5,8 @@ use Carp 'croak';
 use IO::File;
 use Mojo::Asset::File;
 
+has max_memory_size => sub { $ENV{MOJO_MAX_MEMORY_SIZE} || 262144 };
+
 # "There's your giraffe, little girl.
 #  I'm a boy.
 #  That's the spirit. Never give up."
@@ -18,7 +20,7 @@ sub add_chunk {
   my ($self, $chunk) = @_;
   $self->{content} .= $chunk if defined $chunk;
   return Mojo::Asset::File->new->add_chunk($self->slurp)
-    if $self->size > ($ENV{MOJO_MAX_MEMORY_SIZE} || 262144);
+    if $self->size > $self->max_memory_size;
   return $self;
 }
 
@@ -77,6 +79,21 @@ Mojo::Asset::Memory - In-memory asset
 
 L<Mojo::Asset::Memory> is a container for in-memory assets.
 
+=head1 ATTRIBUTES
+
+L<Mojo::Asset::Memory> inherits all attributes from L<Mojo::Asset> and
+implements the following new ones.
+
+=head2 C<max_memory_size>
+
+  my $size = $mem->max_memory_size;
+  $mem     = $mem->max_memory_size(1024);
+
+Maximum asset size in bytes, only attempt upgrading to a L<Mojo::Asset::File>
+object after reaching this limit, defaults to the value of
+C<MOJO_MAX_MEMORY_SIZE> or C<5262144>.
+Note that this attribute is EXPERIMENTAL and might change without warning!
+
 =head1 METHODS
 
 L<Mojo::Asset::Memory> inherits all methods from L<Mojo::Asset> and
@@ -121,7 +138,7 @@ Size of asset data in bytes.
 
 =head2 C<slurp>
 
-  my $string = $file->slurp;
+  my $string = mem->slurp;
 
 Read all asset data at once.
 

diff --git a/lib/Mojo/Headers.pm b/lib/Mojo/Headers.pm
@@ -338,7 +338,8 @@ L<Mojo::Headers> implements the following attributes.
   my $size = $headers->max_line_size;
   $headers = $headers->max_line_size(1024);
 
-Maximum line size in bytes, defaults to C<10240>.
+Maximum line size in bytes, defaults to the value of C<MOJO_MAX_LINE_SIZE> or
+C<10240>.
 Note that this attribute is EXPERIMENTAL and might change without warning!
 
 =head1 METHODS

diff --git a/lib/Mojo/Message.pm b/lib/Mojo/Message.pm
@@ -635,7 +635,8 @@ to L<Mojo::JSON>.
   my $size = $message->max_message_size;
   $message = $message->max_message_size(1024);
 
-Maximum message size in bytes, defaults to C<5242880>.
+Maximum message size in bytes, defaults to the value of
+C<MOJO_MAX_MESSAGE_SIZE> or C<5242880>.
 
 =head1 METHODS
 
@@ -805,7 +806,7 @@ Remove leftover data from message parser.
 
   $message->max_line_size(1024);
 
-Maximum line size in bytes.
+Alias for L<Mojo::Headers/"max_line_size">.
 Note that this method is EXPERIMENTAL and might change without warning!
 
 =head2 C<param>

diff --git a/lib/Mojo/Transaction/WebSocket.pm b/lib/Mojo/Transaction/WebSocket.pm
@@ -407,7 +407,8 @@ Mask outgoing frames with XOR cipher and a random 32bit key.
   my $size = $ws->max_websocket_size;
   $ws      = $ws->max_websocket_size(1024);
 
-Maximum WebSocket message size in bytes, defaults to C<262144>.
+Maximum WebSocket message size in bytes, defaults to the value of
+C<MOJO_MAX_WEBSOCKET_SIZE> or C<262144>.
 
 =head1 METHODS