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: 29 days 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 (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-11-13T12:30:32.000Z (about 2 months ago)
• Last Synced: 2024-11-13T13:35:59.540Z (about 2 months ago)
• Topics: cpan, perl, perl5
• Language: Perl
• Homepage: https://metacpan.org/pod/Data::Text
• Size: 94.7 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.14

# SYNOPSIS

Handle text in an OO way.

    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.

## 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.

## trim

Removes leading and trailing spaces from the text.

## rtrim

Removes trailing spaces from the text.

## replace

Replaces words.

    use Data::Text;

    my $dt = Data::Text->new();

    $dt->append('Hello World');

    $dt->replace({ 'Hello' => 'Goodbye dear' });

    print $dt->as_string(), "\n";       # Outputs "Goodbye dear world"

## 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

# SEE ALSO

[String::Clean](https://metacpan.org/pod/String%3A%3AClean), [String::Util](https://metacpan.org/pod/String%3A%3AUtil), [Lingua::String](https://metacpan.org/pod/Lingua%3A%3AString)

# SUPPORT

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-2024 Nigel Horne.

This program is released under the following licence: GPL2