lib/Moose/Meta/Attribute/Native/Trait/String.pm

   1 package Moose::Meta::Attribute::Native::Trait::String;
   2 use Moose::Role;
   3
   4 our $VERSION   = '0.89';
   5 $VERSION = eval $VERSION;
   6 our $AUTHORITY = 'cpan:STEVAN';
   7
   8 use Moose::Meta::Attribute::Native::MethodProvider::String;
   9
  10 with 'Moose::Meta::Attribute::Native::Trait';
  11
  12 has 'method_provider' => (
  13     is        => 'ro',
  14     isa       => 'ClassName',
  15     predicate => 'has_method_provider',
  16     default   => 'Moose::Meta::Attribute::Native::MethodProvider::String',
  17 );
  18
  19 sub _default_default { q{} }
  20 sub _default_is { 'rw' }
  21 sub _helper_type { 'Str' }
  22
  23 after '_check_handles_values' => sub {
  24     my $self    = shift;
  25     my $handles = $self->handles;
  26
  27     unless ( scalar keys %$handles ) {
  28         my $method_constructors = $self->method_constructors;
  29         my $attr_name           = $self->name;
  30
  31         foreach my $method ( keys %$method_constructors ) {
  32             $handles->{$method} = ( $method . '_' . $attr_name );
  33         }
  34     }
  35 };
  36
  37 no Moose::Role;
  38
  39 1;
  40
  41 __END__
  42
  43 =pod
  44
  45 =head1 NAME
  46
  47 Moose::Meta::Attribute::Native::Trait::String
  48
  49 =head1 SYNOPSIS
  50
  51   package MyHomePage;
  52   use Moose;
  53
  54   has 'text' => (
  55       metaclass => 'String',
  56       is        => 'rw',
  57       isa       => 'Str',
  58       default   => q{},
  59       handles  => {
  60           add_text     => 'append',
  61           replace_text => 'replace',
  62       }
  63   );
  64
  65   my $page = MyHomePage->new();
  66   $page->add_text("foo"); # same as $page->text($page->text . "foo");
  67
  68 =head1 DESCRIPTION
  69
  70 This module provides a simple string attribute, to which mutating string
  71 operations can be applied more easily (no need to make an lvalue attribute
  72 metaclass or use temporary variables). Additional methods are provided for
  73 completion.
  74
  75 If your attribute definition does not include any of I<is>, I<isa>,
  76 I<default> or I<handles> but does use the C<String> metaclass,
  77 then this module applies defaults as in the L</SYNOPSIS>
  78 above. This allows for a very basic counter definition:
  79
  80   has 'foo' => (metaclass => 'String');
  81   $obj->append_foo;
  82
  83 =head1 PROVIDED METHODS
  84
  85 These methods are implemented in
  86 L<Moose::Meta::Attribute::Native::MethodProvider::STring>. It is important to
  87 note that all those methods do in place modification of the value stored in
  88 the attribute.
  89
  90 =over 4
  91
  92 =item I<inc>
  93
  94 Increments the value stored in this slot using the magical string autoincrement
  95 operator. Note that Perl doesn't provide analogous behavior in C<-->, so
  96 C<dec> is not available.
  97
  98 =item I<append> C<$string>
  99
 100 Append a string, like C<.=>.
 101
 102 =item I<prepend> C<$string>
 103
 104 Prepend a string.
 105
 106 =item I<replace> C<$pattern> C<$replacement>
 107
 108 Performs a regexp substitution (L<perlop/s>). There is no way to provide the
 109 C<g> flag, but code references will be accepted for the replacement, causing
 110 the regex to be modified with a single C<e>. C</smxi> can be applied using the
 111 C<qr> operator.
 112
 113 =item I<match> C<$pattern>
 114
 115 Like I<replace> but without the replacement. Provided mostly for completeness.
 116
 117 =item C<chop>
 118
 119 L<perlfunc/chop>
 120
 121 =item C<chomp>
 122
 123 L<perlfunc/chomp>
 124
 125 =item C<clear>
 126
 127 Sets the string to the empty string (not the value passed to C<default>).
 128
 129 =back
 130
 131 =head1 METHODS
 132
 133 =over 4
 134
 135 =item B<meta>
 136
 137 =item B<method_provider>
 138
 139 =item B<has_method_provider>
 140
 141 =back
 142
 143 =head1 BUGS
 144
 145 All complex software has bugs lurking in it, and this module is no
 146 exception. If you find a bug please either email me, or add the bug
 147 to cpan-RT.
 148
 149 =head1 AUTHOR
 150
 151 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 152
 153 =head1 COPYRIGHT AND LICENSE
 154
 155 Copyright 2007-2009 by Infinity Interactive, Inc.
 156
 157 L<http://www.iinteractive.com>
 158
 159 This library is free software; you can redistribute it and/or modify
 160 it under the same terms as Perl itself.
 161
 162 =cut