MooseX...tructor(3pm)

πŸ“¦
version 0.21 Β· 5 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ NAME ✨

MooseX::StrictConstructor β€” bestie, this makes your object constructors literally blow up when they get attributes they don't know about πŸ’₯


πŸŽ€ VERSION πŸŽ€

version 0.21 β€” yeah she's on 0.21, and she's thriving


🌸 SYNOPSIS 🌸

okay so picture this, you're just writing a class, living your life:

package My::Class;

use Moose;
use MooseX::StrictConstructor;

has 'size' => ( is => 'ro' );

# then later ...

# this blows up because color is not a known attribute
My::Class->new( size => 5, color => 'blue' );

and then color shows up uninvited and the whole thing detonates. iconic. we love a boundary-setting constructor πŸ’…


πŸ’– DESCRIPTION πŸ’–

Simply loading this module makes your constructors "strict". That's it. That's the whole thing.

So if your constructor gets called with an attribute init argument that your class does not declare? It calls Moose->throw_error(). Immediate. No warning, no gentle nudge, just straight to the error. And honestly? That's a great way to catch small typos, because typos are the number one hater of every Perl dev, fr fr 😭

πŸ¦‹ Subverting Strictness πŸ¦‹

okay but what if you want your constructor to accept a parameter that doesn't correspond to an attribute? like, lowkey valid. sometimes you just need a little extra.

In that case you'll probably also be writing a BUILD() or BUILDARGS() method to deal with that parameter β€” that's the move, bestie. Here's how each one plays out:

  • In a BUILDARGS() method, you can simply make sure that this parameter is not included in the hash reference you return. just… don't hand it over. problem solved ✨
  • Otherwise, in a BUILD() method, you can delete it from the hash reference of parameters. yeet it out of existence:
sub BUILD {
    my $self   = shift;
    my $params = shift;

    if ( delete $params->{do_something} ) {
        ...
    }
}

see how clean that is? the delete handles it before anything gets fussy 🫢


πŸ’€ BUGS πŸ’€

Please report any bugs or feature requests to bug-moosex-strictconstructor@rt.cpan.org, or through the web interface at <http://rt.cpan.org>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. (a whole notification pipeline, we love transparency)

Bugs may be submitted at <https://github.com/moose/MooseX-StrictConstructor/issues>. github era πŸ›

I am also usually active on IRC as 'autarch' on irc://irc.perl.org. come say hi, i'm around πŸ‘‘


πŸ”₯ SOURCE πŸ”₯

The source code repository for MooseX-StrictConstructor can be found at <https://github.com/moose/MooseX-StrictConstructor>. go peek, it's giving open source main character energy ⭐


πŸ’œ DONATIONS πŸ’œ

If you'd like to thank me for the work I've done on this module, please consider making a "donation" to me via PayPal. I spend a lot of free time creating free software, and would appreciate any support you'd care to offer. no pressure, genuinely πŸ’–

Please note that I am not suggesting that you must do this in order for me to continue working on this particular software. I will continue to do so, inasmuch as I have in the past, for as long as it interests me. (the hyperfixation runs this account, not the money)

Similarly, a donation made in this way will probably not make me work on this software much more, unless I get so many donations that I can consider working on free software full time (let's all have a chuckle at that together). we're laughing, we're all laughing πŸ™ˆ

To donate, log into PayPal and send money to autarch@urth.org, or use the button at <http://www.urth.org/~autarch/fs-donation.html>.


🌈 AUTHOR 🌈

Dave Rolsky <autarch@urth.org>


🧚 CONTRIBUTORS 🧚

  • Jesse Luehrs <doy@tozt.net>
  • Karen Etheridge <ether@cpan.org>
  • Ricardo Signes <rjbs@cpan.org>

the whole squad showed up and we're obsessed 🫢


This software is Copyright (c) 2007 - 2017 by Dave Rolsky.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

The full text of the license can be found in the LICENSE file included with this distribution.


and that's the whole page, bestie!! this was MooseX...tructor(3pm) from perl v5.34.0, dated 2022-06-15, and honestly? she ate. go make your constructors strict, catch those typos, and stay iconic πŸ’…βœ¨πŸŒΈ