NAME

File::Update - update/modify/mutate a file only on change in contents.

VERSION

version 0.2.1

SYNOPSIS

use Path::Tiny qw/ path /;
use File::Update qw/ write_on_change /;

my $text = "Updated on " . strftime("%Y-%m-%d", time) . "\n";

write_on_change(path("dated-file.txt"), \$text);


use Path::Tiny qw/ path /;
use File::Update qw/ modify_on_change /;

foreach my $fn (@ARGV)
{
    modify_on_change(
        path($fn),
        sub {
            my $text = shift;
            return $$text =~ s{\A#!/usr/bin/perl}{#!/usr/bin/env perl};
        }
    );
}

FUNCTIONS

write_on_change($path, \"new contents")

Accepts a Path::Tiny like object and a reference to a string that contains the new contents. Writes the new content only if it is different from the existing one in the file.

modify_on_change($path, sub { my $t = shift; return $$t =~ s/old/new/g;})

Accepts a subroutine reference that accepts the reference to the existing content, can mutate it and if it returns a true value, the new text is written to the file.

write_on_change_no_utf8($path, \"new contents")

Like write_on_change() but while using Path::Tiny's non-utf8 methods.

write_on_change_raw($path, \"new contents")

Like write_on_change() but while using Path::Tiny's *_raw methods.

Added in v0.2.0.

SUPPORT

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

• MetaCPAN

  A modern, open-source CPAN search engine, useful to view POD in HTML format.

  https://metacpan.org/release/File-Update

• Search CPAN

  The default CPAN search engine, useful to view POD in HTML format.

  http://search.cpan.org/dist/File-Update

• RT: CPAN's Bug Tracker

  The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

  https://rt.cpan.org/Public/Dist/Display.html?Name=File-Update

• CPAN Ratings

  The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.

  http://cpanratings.perl.org/d/File-Update

• CPANTS

  The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

  http://cpants.cpanauthors.org/dist/File-Update

• CPAN Testers

  The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

  http://www.cpantesters.org/distro/F/File-Update

• CPAN Testers Matrix

  The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

  http://matrix.cpantesters.org/?dist=File-Update

• CPAN Testers Dependencies

  The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

  http://deps.cpantesters.org/?module=File::Update

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-file-update at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=File-Update. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/shlomif/perl-File-Update

git clone https://github.com/shlomif/perl-File-Update.git

AUTHOR

Shlomi Fish <shlomif@cpan.org>

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/shlomif/file-update/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018 by Shlomi Fish.

This is free software, licensed under:

The MIT (X11) License

cpanm File::Update

perl -MCPAN -e shell
install File::Update