[gitmo/Mouse.git] / lib / ouse.pm

package ouse;

use strict;
use warnings;

our $VERSION   = '0.59';

BEGIN {
    my $package;
    sub import { 
        $package = $_[1] || 'Class';
        if ($package =~ /^\+/) {
            $package =~ s/^\+//;
            eval "require $package; 1" or die;
        }
    }
    use Filter::Simple sub { s/^/package $package;\nuse Mouse;\n/; }
}

1;

__END__

=pod

=head1 NAME

ouse - syntactic sugar to make Mouse one-liners easier

=head1 SYNOPSIS

  # create a Mouse class on the fly ...
  perl -Mouse=Foo -e 'has bar => ( is=>q[ro], default => q[baz] ); print Foo->new->bar' # prints baz

  # loads an existing class (Mouse or non-Mouse)
  # and re-"opens" the package definition to make
  # debugging/introspection easier
  perl -Mouse=+My::Class -e 'print join ", " => __PACKAGE__->meta->get_method_list' 

=head1 DESCRIPTION

ouse.pm is a simple source filter that adds C<package $name; use Mouse;> 
to the beginning of your script and was entirely created because typing 
perl -e'package Foo; use Mouse; ...' was annoying me... especially after
getting used to having C<-Moose> for Moose.

=head1 INTERFACE 

ouse provides exactly one method and it's automically called by perl:

=over 4

=item B<import($package)>

Pass a package name to import to be used by the source filter.

=back

=head1 DEPENDENCIES

You will need L<Filter::Simple> and eventually L<Mouse>

=head1 INCOMPATIBILITIES

None reported. But it is a source filter and might have issues there.

=head1 BUGS

All complex software has bugs lurking in it, and this module is no
exception. If you find a bug please either email me, or add the bug
to cpan-RT.

=head1 AUTHOR

For all intents and purposes, blame:

Chris Prather  C<< <perigrin@cpan.org> >>

...who wrote ouse.pm, which was adapted for use by Mouse by:

Ricardo SIGNES C<< <rjbs@cpan.org> >>

=head1 COPYRIGHT AND LICENSE

Copyright 2008 Shawn M Moore.

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

=cut
Commit	Line	Data
b0e7066c	1	package ouse;
	2
	3	use strict;
	4	use warnings;
	5
	6	our $VERSION = '0.59';
	7
	8	BEGIN {
	9	my $package;
	10	sub import {
	11	$package = $_[1] \|\| 'Class';
	12	if ($package =~ /^\+/) {
	13	$package =~ s/^\+//;
	14	eval "require $package; 1" or die;
	15	}
	16	}
	17	use Filter::Simple sub { s/^/package $package;\nuse Mouse;\n/; }
	18	}
	19
	20	1;
	21
	22	__END__
	23
	24	=pod
	25
	26	=head1 NAME
	27
	28	ouse - syntactic sugar to make Mouse one-liners easier
	29
	30	=head1 SYNOPSIS
	31
	32	# create a Mouse class on the fly ...
	33	perl -Mouse=Foo -e 'has bar => ( is=>q[ro], default => q[baz] ); print Foo->new->bar' # prints baz
	34
	35	# loads an existing class (Mouse or non-Mouse)
	36	# and re-"opens" the package definition to make
	37	# debugging/introspection easier
	38	perl -Mouse=+My::Class -e 'print join ", " => __PACKAGE__->meta->get_method_list'
	39
	40	=head1 DESCRIPTION
	41
	42	ouse.pm is a simple source filter that adds C<package $name; use Mouse;>
	43	to the beginning of your script and was entirely created because typing
	44	perl -e'package Foo; use Mouse; ...' was annoying me... especially after
	45	getting used to having C<-Moose> for Moose.
	46
	47	=head1 INTERFACE
	48
	49	ouse provides exactly one method and it's automically called by perl:
	50
	51	=over 4
	52
	53	=item B<import($package)>
	54
	55	Pass a package name to import to be used by the source filter.
	56
	57	=back
	58
	59	=head1 DEPENDENCIES
	60
	61	You will need L<Filter::Simple> and eventually L<Mouse>
	62
	63	=head1 INCOMPATIBILITIES
	64
65	None reported. But it is a source filter and might have issues there.
66
67	=head1 BUGS
68
69	All complex software has bugs lurking in it, and this module is no
70	exception. If you find a bug please either email me, or add the bug
71	to cpan-RT.
72
73	=head1 AUTHOR
74
75	For all intents and purposes, blame:
76
77	Chris Prather C<< <perigrin@cpan.org> >>
78
79	...who wrote ouse.pm, which was adapted for use by Mouse by:
80
81	Ricardo SIGNES C<< <rjbs@cpan.org> >>
82
83	=head1 COPYRIGHT AND LICENSE
84
85	Copyright 2008 Shawn M Moore.
86
87	This program is free software; you can redistribute it and/or modify it
88	under the same terms as Perl itself.
89
90	=cut