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

package ouse;

use strict;
use warnings;

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