Data::Censor(3pm)

📦
version 0.04 · 2 versions
, in ubuntu stonking

💖 Data::Censor 💖

okay bestie, so this is Data::Censor — a Perl module (it's in the User Contributed Perl Documentation, iykyk) whose whole personality is censoring sensitive stuff in a data structure. like, you've got a hash full of card numbers and passwords and you do NOT want those vibes leaking anywhere. that's the job. slay.

✨ VERSION ✨

Version 0.04 🎀

🌸 SYNOPSIS 🌸

okay so here's the whole vibe, bestie — read it, it's giving "I got you":

    # OO way, letting you specify your own list of sensitive-looking fields, and
    # what they should be replaced by (all options here are optional)
    my $censor = Data::Censor->new(
        # Specify which fields to censor:
        sensitive_fields => [ qw(card_number password) ],

        # Specify text to replace their values with:
        replacement => '(Sensitive data hidden)',

        # Or specify callbacks for each field name which return the "censored"
        # value - in this case, masking a card number (PAN) to show only the
        # last four digits:
        replacement_callbacks => {
            card_number => sub {
                my $pan = shift;
                return "x" x (length($pan) - 4) . substr($pan, -4, 4);
            },
        },
    );

    # Censor the data in-place (changes the data structure, returns the number
    # of keys censored)
    my $censor_count = $censor->censor(\%data);

    # Alternate non-OO interface, using default settings and returning a cloned
    # version of the data after censoring:
    my $censored_data = Data::Censor->clone_and_censor(\%data);

periodt. 💅

👑 new (CONSTRUCTOR) 👑

here's what it'll accept when you make one, bestie:

  • sensitive_fields — this is either an arrayref of sensitive fields, which get checked for equality, or a regex that gets tested against every key to see if it counts as sensitive. your call, both iconic.
  • replacement — the string that every value gets swapped out for. BUT listen: any censoring callback you handed over in replacement_callbacks that matches this key will 100% take precedence over this plain string. callbacks stay winning. 🔥
  • replacement_callbacks — a hashref of key => sub {...}, where each key is a column name to match, and the coderef takes the uncensored value and gives you back the censored value. the classic use is masking a card number while leaving the last 4 digits visible, which is so real of you. 🫶
lowkey important: if you provide both replacement and replacement_callbacks, any callback that's defined and matches the key being considered takes precedence. no cap.

🦋 METHODS 🦋

censor

you hand it a data structure (a hashref), it clones it and returns the cloned version after censoring all the potentially sensitive data inside. bye sensitive data 👋

clone_and_censor

clones the hashref you gave it (using Clone — and ngl it will die if that's not installed 😭), then censors the cloned data and returns it.

you can use it as a class method OR an object method:

  • class method = the quick lil way when you don't wanna instantiate an object
  • object method = when you wanna apply your custom settings to the object first

look:

    # As a class method
    my $censored_data = Data::Censor->clone_and_censor($data);

    # or as an object method
    my $censor = Data::Censor->new( replacement => "SECRET!" );
    my $censored_data = $censor->clone_and_censor($data);

slay, both. 💖

🌈 AUTHOR 🌈

David Precious (BIGPRESH), "<davidp at preshweb.co.uk>" 🎀

and a lil lore drop for you bestie: this code was originally written for the Dancer project by him, and he pulled it out into a seperate distribution because he was using it for code at work. main character origin story fr fr.

💜 SUPPORT 💜

you can find documentation for this module with the perldoc command, bestie:

    perldoc Data::Censor

go read it, it's right there. 👑

Copyright 2018 David Precious.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

<http://www.perlfoundation.org/artistic_license_2_0>

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

and that's the whole page, pookie 💅 this one's from perl v5.40.1, dated 2026-01-03 — and it goes out as Data::Censor(3pm). ty for coming to my ted talk, mwah 🎀✨🦋

📦 where this page comes from