—

              
#
# File: lib/Devel/Ladybug/Str.pm
#
# Copyright (c) 2009 TiVo Inc.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Common Public License v1.0
# which accompanies this distribution, and is available at
# http://opensource.org/licenses/cpl1.0.txt
#
HideShow 63 lines of Pod
=pod
=head1 NAME
Devel::Ladybug::Str - Overloaded object class for strings
=head1 DESCRIPTION
Extends L<Devel::Ladybug::Scalar>, L<Mime::Base64>, and
L<Unicode::String>.
=head1 SYNOPSIS
  use Devel::Ladybug::Str;
  my $string = Devel::Ladybug::Str->new("Lorem Ipsum");
  #
  # Overloaded to work like a native string
  #
  print "$string\n";
  if ( $string =~ /Ipsum/ ) {
    print "Word\n";
  }
=head1 PUBLIC INSTANCE METHODS
=over 4
=item * $self->split($splitRegex)
Object wrapper for Perl's built-in C<split()> function. Functionally
the same as C<split($splitStr, $self)>.
Returns a new Devel::Ladybug::Array containing the split elements.
  my $scalar = Devel::Ladybug::Scalar->new("Foo, Bar, Rebar, D-bar");
  my $array  = $scalar->split(qr/, */);
  $array->each( sub {
    print "Have item: $_\n";
  } );
  # Have item: Foo
  # Have item: Bar
  # Have item: Rebar
  # Have item: D-bar
=item * chomp, chop, chr, crypt, eval, index, lc, lcfirst, length, rindex, substr, uc, ucfirst
These object methods are wrappers to built-in Perl functions. See
L<perlfunc>.
=back
=head1 SEE ALSO
This file is part of L<Devel::Ladybug>.
=cut
package Devel::Ladybug::Str;
use strict;
use warnings;
use base qw| Unicode::String Devel::Ladybug::Scalar MIME::Base64 |;
sub assert {
  my $class = shift;
  my @rules = @_;
  my %parsed =
    Devel::Ladybug::Type::__parseTypeArgs( Devel::Ladybug::Type::isStr,
    @rules );
  $parsed{columnType} ||= 'VARCHAR(1024)';
  $parsed{maxSize}    ||= 1024;
  return $class->__assertClass()->new(%parsed);
}
sub split {
  my $self  = shift;
  my $regex = shift;
  return Devel::Ladybug::Array->new( CORE::split( $regex, $self ) );
}
sub chomp {
  my $self = shift;
  return CORE::chomp($self);
}
sub chop {
  my $self = shift;
  return CORE::chop($self);
}
sub chr {
  my $self = shift;
  return CORE::chr($self);
}
sub crypt {
  my $self = shift;
  my $salt = shift;
  return CORE::crypt( $self, $salt );
}
sub eval {
  my $self = shift;
  return CORE::eval($self);
}
sub index {
  my $self   = shift;
  my $substr = shift;
  my $pos    = shift;
  return CORE::index( $self, $substr, $pos );
}
sub lc {
  my $self = shift;
  return CORE::lc($self);
}
sub lcfirst {
  my $self = shift;
  return CORE::lcfirst($self);
}
sub length {
  my $self = shift;
  return CORE::length($self);
}
sub rindex {
  my $self   = shift;
  my $substr = shift;
  my $pos    = shift;
  return CORE::rindex( $self, $substr, $pos );
}
sub substr {
  my $self   = shift;
  my $offset = shift;
  my $len    = shift;
  return CORE::substr( $self, $offset, $len );
}
sub uc {
  my $self = shift;
  return CORE::uc($self);
}
sub ucfirst {
  my $self = shift;
  return CORE::ucfirst($self);
}
1;