File Coverage

blib/lib/MsOffice/Word/Surgeon/Utils.pm

Criterion	Covered	Total	%
statement	13	13	100.0
branch	2	2	100.0
condition	3	3	100.0
subroutine	5	5	100.0
pod	2	2	100.0
total	25	25	100.0

package MsOffice::Word::Surgeon::Utils;
use strict;
use warnings;

use Exporter  qw/import/;
our @EXPORT = qw/maybe_preserve_spaces is_at_run_level/;

our $VERSION = '2.01';

sub maybe_preserve_spaces {
  my ($txt) = @_;
  return $txt =~ /^\s/ || $txt =~ /\s$/ ? ' xml:space="preserve"' : '';
}

sub is_at_run_level {
  my ($xml) = @_;
  return $xml =~ m[</w:(?:r|del|ins)>$];
}


1;

__END__

=encoding ISO-8859-1

=head1 NAME

MsOffice::Word::Surgeon::Utils - utility functions for MsOffice::Word::Surgeon

=head1 SYNOPSIS

  use MsOffice::Word::Surgeon::Utils qw(maybe_preserve_spaces);
  my $attr = maybe_preserve_spaces($some_text);


=head1 DESCRIPTION

Functions in this module are used internally by L<MsOffice::Word::Surgeon>.

=head1 FUNCTIONS

=head2 maybe_preserve_spaces

  my $attr = maybe_preserve_spaces($some_text);

Returns the XML attribute to be inserted into C<< <w:t> >> nodes and
C<< <w:delText> >> nodes when the literal text within the node starts
or ends with a space -- in that case the XML should contain the
attribute C<<  xml:space="preserve" >>

=head2 is_at_run_level

   if (is_at_run_level($xml)) {...}

Returns true if the given XML fragment ends with a C<< </w:r> >>,
C<< </w:del> >> or C<< </w:ins> >> node.