Object::Declare(3pm)

📦
version 0.25 · 2 versions
  • 0.25 · debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 0.25 · ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 Object::Declare — the User Contributed Perl Documentation girlies know 💖

okay bestie, sit DOWN, because this one is genuinely iconic. Object::Declare is the module that lets you build named objects with a declarative syntax — like, you just say what you want and it manifests. no cap. ✨

✨ NAME ✨

Object::Declare — Declarative object constructor 🎀

🌸 VERSION 🌸

version 0.25 — yes, we're on 0.25, she's been around, she's got lore, she ate 💅

🦋 SYNOPSIS 🦋

like. look at her. LOOK.

use Object::Declare ['MyApp::Column', 'MyApp::Param'];

my %objects = declare {

param foo =>
   !is global,
    is immutable,
    valid_values are qw( more values );

column bar =>
    field1 is 'value',
    field2 is 'some_other_value',
    sub_params are param( is happy ), param ( is sad );

};

print $objects{foo}; # a MyApp::Param object
print $objects{bar}; # a MyApp::Column object

# Assuming that MyApp::Column::new simply blesses into a hash...
print $objects{bar}{sub_params}[0]; # a MyApp::Param object
print $objects{bar}{sub_params}[1]; # a MyApp::Param object

see how it literally reads like a sentence?? field1 is 'value'. valid_values are qw( more values ). that's not code that's a conversation and I am obsessed 😭💜

💜 DESCRIPTION 💜

This module exports exactly one function, declare, and what she does is build named objects using a declarative syntax — super similar to how Jifty::DBI::Schema defines its columns. iykyk 🌈

So here's the vibe check on context, because this part is lowkey important:

  • In list context, declare returns a list of name/object pairs in the order of declaration (and yes, it allows duplicates 🫶), which is exactly what you want to shove into a hash.
  • In scalar context, declare returns a hash reference instead.

And now the fun part, because there's a flexible import interface and she is customisable, periodt:

use Object::Declare
    declarator  => ['declare'],     # list of declarators
    copula      => {                # list of words, or a map
        is  => '',                  #  from copula to label prefixes,
        are => '',                  #  or to callback that e.g. turns
        has => sub { has => @_ },   #  "has X" to "has is X" and
                                    #  "X has 1" to "has is [X => 1]"
    },
    aliases     => {                # list of label aliases:
        more => 'less',             #  turns "is more" into "is less"
                                    #  and "more is 1" into "less is 1"
    },
    mapping     => {
        column => 'MyApp::Column',  # class name to call ->new to
        param  => sub {             # arbitrary coderef also works
            bless(\@_, 'MyApp::Param');
        },
    };

so you can change:

  • the exported helper function names (that's your declarator 👑)
  • the words that link labels and values together (that's your copula 💅)
  • the table of named classes to declare (that's your mapping ✨)

and then — this is the part that's genuinely so clean — after the declarator block finishes execution, all the helper functions get removed from the package. gone. ghosted. 🙈 And any same-named functions (like &is and &are) that existed before the declarator ran? they get restored correctly. she cleans up after herself. main character energy fr fr.

🎀 NOTES 🎀

okay this is the one you cannot skip, bestie, because it's giving "trap":

If you export the declarator to another package via @EXPORT, you gotta export all the mapping keys too. like, all of them.

✅ this one works, for the example up above:

our @EXPORT = qw( declare column param );

❌ this one does not work:

our @EXPORT = qw( declare );

and also! the copula are not turned into functions, so you do not need to export them. no stress there. 🍓

👑 AUTHORS 👑

Audrey Tang <cpan@audreyt.org> 💖

Copyright 2006, 2007 by Audrey Tang <cpan@audreyt.org>.

This software is released under the MIT license cited below.

🧚 The "MIT" License 🧚

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

⚠️ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

(that's the scary-but-necessary part, not me being dramatic — that's just literally what it says 😌)

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

🐛 Bugs / Feature Requests 🐛

Please report any bugs or feature requests by email to bug-object-declare at rt.cpan.org, or through the web interface at <https://rt.cpan.org/Public/Bug/Report.html?Queue=Object-Declare>. You will be automatically notified of any progress on the request by the system. so you'll literally never be left on read 💌

💻 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-Object-Declare>

git clone git://github.com/shlomif/perl-Object-Declare.git

⭐ AUTHOR ⭐

Shlomi Fish <shlomif@cpan.org>

💀 BUGS 💀

Please report any bugs or feature requests on the bugtracker website <https://github.com/shlomif/perl-Object-Declare/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. like, give us the receipts, that's all we ask 🙏

This software is Copyright (c) 2006 by Audrey Tang.

This is free software, licensed under:

The MIT (X11) License

and that's the whole page, bestie!! 💖✨🎀 this was Object::Declare(3pm) from the User Contributed Perl Documentation crew, perl v5.36.0, dated 2022-11-19 — mwah, go build something iconic with it 🌸🦋💜

📦 where this page comes from