https://github.com/nigelhorne/data-text
Class to handle text in an OO way
https://github.com/nigelhorne/data-text
cpan perl perl5
Last synced: 3 months ago
JSON representation
Class to handle text in an OO way
- Host: GitHub
- URL: https://github.com/nigelhorne/data-text
- Owner: nigelhorne
- License: gpl-2.0
- Created: 2021-09-12T19:21:24.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-08-04T19:43:13.000Z (4 months ago)
- Last Synced: 2025-08-04T22:21:13.373Z (4 months ago)
- Topics: cpan, perl, perl5
- Language: Perl
- Homepage: https://metacpan.org/pod/Data::Text
- Size: 159 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# NAME
Data::Text - Class to handle text in an OO way
# VERSION
Version 0.18
# DESCRIPTION
`Data::Text` provides an object-oriented interface for managing and manipulating text content in Perl.
It wraps string operations in a class-based structure,
enabling clean chaining of methods like appending, trimming, replacing words, and joining text with conjunctions.
It supports flexible input types,
including strings, arrays, and other `Data::Text` objects,
and overloads common operators to allow intuitive comparisons and stringification.
# SYNOPSIS
use Data::Text;
my $d = Data::Text->new("Hello, World!\n");
print $d->as_string();
# SUBROUTINES/METHODS
## new
Creates a Data::Text object.
The optional parameter contains a string, or object, to initialise the object with.
## set
Sets the object to contain the given text.
The argument can be a reference to an array of strings, or an object.
If called with an object, the message as\_string() is sent to it for its contents.
$d->set({ text => "Hello, World!\n" });
$d->set(text => [ 'Hello, ', 'World!', "\n" ]);
## append
Adds data given in "text" to the end of the object.
Contains a simple sanity test for consecutive punctuation.
I expect I'll improve that.
Successive calls to append() can be daisy chained.
$d->set('Hello ')->append("World!\n");
The argument can be a reference to an array of strings, or an object.
If called with an object, the message as\_string() is sent to it for its contents.
## uppercase
Converts the text to uppercase.
$d->uppercase();
## lowercase
Converts the text to lowercase.
$d->lowercase();
## clear
Clears the text and resets internal state.
$d->clear();
## equal
Are two texts the same?
my $t1 = Data::Text->new('word');
my $t2 = Data::Text->new('word');
print ($t1 == $t2), "\n"; # Prints 1
## not\_equal
Are two texts different?
my $t1 = Data::Text->new('xyzzy');
my $t2 = Data::Text->new('plugh');
print ($t1 != $t2), "\n"; # Prints 1
## as\_string
Returns the text as a string.
## length
Returns the length of the text.
This is actually the number of characters, not the number of bytes.
## trim
Removes leading and trailing spaces from the text.
## rtrim
Removes trailing spaces from the text.
## replace
Replaces multiple words in the text.
$d->append('Hello World');
$d->replace({ 'Hello' => 'Goodbye', 'World' => 'Universe' });
print $d->as_string(), "\n"; # Outputs "Goodbye Universe"
## appendconjunction
Add a list as a conjunction. See [Lingua::Conjunction](https://metacpan.org/pod/Lingua%3A%3AConjunction)
Because of the way Data::Text works with quoting,
this code works
my $d1 = Data::Text->new();
my $d2 = Data::Text->new('a');
my $d3 = Data::Text->new('b');
# Prints "a and b\n"
print $d1->appendconjunction($d2, $d3)->append("\n");
# AUTHOR
Nigel Horne, ``
# BUGS
There is no Unicode or UTF-8 support.
# SEE ALSO
[String::Util](https://metacpan.org/pod/String%3A%3AUtil), [Lingua::String](https://metacpan.org/pod/Lingua%3A%3AString)
# SUPPORT
This module is provided as-is without any warranty.
You can find documentation for this module with the perldoc command.
perldoc Data::Text
You can also look for information at:
- MetaCPAN
[https://metacpan.org/release/Data-Text](https://metacpan.org/release/Data-Text)
- RT: CPAN's request tracker
[https://rt.cpan.org/NoAuth/Bugs.html?Dist=Data-Text](https://rt.cpan.org/NoAuth/Bugs.html?Dist=Data-Text)
- CPAN Testers' Matrix
[http://matrix.cpantesters.org/?dist=Data-Text](http://matrix.cpantesters.org/?dist=Data-Text)
- CPAN Testers Dependencies
[http://deps.cpantesters.org/?module=Data::Text](http://deps.cpantesters.org/?module=Data::Text)
# LICENSE AND COPYRIGHT
Copyright 2021-2025 Nigel Horne.
This program is released under the following licence: GPL2