GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MOOSEX::HAS::SUGAR (3)

.ds Aq ’

NAME

MooseX::Has::Sugar - Sugar Syntax for moose ’has’ fields

CONTENTS

VERSION

version 1.000004

SYNOPSIS

Moose has syntax is generally fine, but sometimes one gets bothered with the constant typing of string quotes for things. The MooseX::Types module exists and in many ways reduces the need for constant string creation.

    Primary Benefits at a Glance

Reduced Typing in has declarations.

The constant need to type => and is fine for one-off cases, but the instant you have more than about 4 attributes it starts to get annoying.

More compact declarations.

Reduces much of the redundant typing in most cases, which makes your life easier, and makes it take up less visual space, which makes it faster to read.

No String Worries

Strings are often problematic, due to white-space etc. Noted that if you do happen to mess them up, Moose should at least warn you that you’ve done something daft. Using this alleviates that worry.

    Before this Module.

Classical Moose



    has foo => (
            isa => Str,
            is  => ro,
            required => 1,
    );

    has bar => (
            isa => Str,
            is => rw
            lazy_build => 1,
    );



Lazy Evil way to do it:

<B>PLEASE DO NOT DO THISB>



    has qw( foo isa Str is ro required 1 );
    has qw( bar isa Str is rw lazy_build 1 );



    With this module

( and with MooseX::Types )



    use MooseX::Types::Moose qw( Str );
    use MooseX::Has::Sugar;

    has foo => (
            isa => Str,
            ro,
            required,
    );
    has bar => (
            isa => Str,
            rw,
            lazy_build,
    );



Or even



    use MooseX::Types::Moose qw( Str );
    use MooseX::Has::Sugar;

    has foo => ( isa => Str, ro,  required, );
    has bar => ( isa => Str, rw,  lazy_build, );



    Alternative Forms

Basic is Expansion Only

( using ::Sugar::Minimal instead )



    use MooseX::Types::Moose qw( Str );
    use MooseX::Has::Sugar::Minimal;

    has foo => (
            isa => Str,
            is  => ro,
            required => 1,
    );
    has bar => (
            isa => Str,
            is => rw,
            lazy_build => 1,
    );



Attribute Expansions with Basic Expansions

( Combining parts of this and ::Sugar::Minimal )



    use MooseX::Types::Moose qw( Str );
    use MooseX::Has::Sugar::Minimal;
    use MooseX::Has::Sugar qw( :attrs );

    has foo => (
            isa => Str,
            is  => ro,
            required,
    );
    has bar => (
            isa => Str,
            is => rw,
            lazy_build,
    );



EXPORT GROUPS

CW:default

Since 0.0300, this exports all our syntax, the same as :attrs :isattrs. Primarily because I found you generally want all the sugar, not just part of it. This also gets rid of that nasty exclusion logic.

CW:isattrs

This exports ro, rw and bare as lists, so they behave as stand-alone attributes like lazy does.



    has foo => (
            required,
            isa => Str,
            ro,
    );



<B>NOTE: This option is incompatible with ::Sugar::MinimalB> : CONFLICTS

CW:attrs

This exports lazy , lazy_build and required, coerce, weak_ref and auto_deref as subs that assume positive.



    has foo => (
            required,
            isa => Str,
    );



<B>NOTE: This option is incompatible with MooseX::Types and Moose’s Type Constraints ModuleB> : CONFLICTS

CW:is

<B>DEPRECATEDB>. See ::Sugar::Minimal for the same functionality

CW:allattrs

<B>DEPRECATEDB>, just use :default or do



    use MooseX::Has::Sugar;



EXPORTED FUNCTIONS

CWbare

returns (is,bare)

CWro

returns (is,ro)

CWrw

returns (is,rw)

CWrequired

returns (required,1)

CWlazy

returns (lazy,1)

CWlazy_build

returns (lazy_build,1)

CWweak_ref

returns (weak_ref,1)

CWcoerce

returns (coerce,1)

<B>WARNING:B> Conflict with MooseX::Types and Moose::Util::TypeConstraints, see CONFLICTS.

CWauto_deref

returns (auto_deref,1)

CONFLICTS

    MooseX::Has::Sugar::Minimal

    MooseX::Has::Sugar::Saccharin

This module is not intended to be used in conjunction with
::Sugar::Minimal or ::Sugar::Saccharin

We export many of the same symbols and its just not very sensible.

    MooseX::Types

    Moose::Util::TypeConstraints

due to exporting the coerce symbol, using us in the same scope as a call to



    use MooseX::Types ....



or
use Moose::Util::TypeConstraints

will result in a symbol collision.

We recommend using and creating proper type libraries instead, ( which will absolve you entirely of the need to use MooseX::Types and MooseX::Has::Sugar(::*)? in the same scope )

AUTHOR

Kent Fredric <kentnl at cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Kent Fredric.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MOOSEX::HAS::SUGAR (3) 2014-08-16

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.