Leyland - Plack-based framework for RESTful web applications
version 0.001007
# in app.psgi:
#!/usr/bin/perl -w
use strict;
use warnings;
use MyApp;
my $config = {
app => 'MyApp',
views => ['Tenjin'],
locales => './i18n',
};
my $myapp = MyApp->new(config => $config);
my $app = sub {
$myapp->handle(shift);
};
Leyland is a Plack-based application framework for building truely RESTful, MVC-style web applications.
"Another application framework?" you ask? Well yes! You see, after several years of Catalyst development, I grew tired of Catalyst's bloat, and the fact that it made it very hard (pretty much impossible if you ask me) to create truely RESTful applications. I then moved for a short while to Dancer, which had a nice syntax for defining routes and had at least some REST properties, but I quickly found it didn't fit my needs as well, and that it also made it very difficult to write truely RESTful applications. I also really missed Catalyst's "context object" and some of its other features, and simply couldn't get used to Dancer's whole functional syntax you're supposed to use inside your routes. While there were quite a few other options on CPAN, I didn't like any of them, plus pretty much none of them were native Plack frameworks, which for me is a bit of a minus (can't blame them though as most of them predate Plack), so I decided to create my own framework, based on Plack and designed to my liking. This is the mess that I've created. You will find that it mostly resembles Catalyst, while providing a syntax mostly similar to Dancer, but with a lot of crazy ideas of its own.
Development of Leyland began August 2010. I have been using it extensively for several projects, some of them already in production. Therefore, the API has somewhat stabilized and I do not consider it in alpha status. That said, Leyland still is immature, and I cannot guarantee that API changes won't be made, nor that it is bug free or even secure enough. If you're thinking of using Leyland for a production project, please test it thoroughly beforehand.
To learn about using Leyland, please refer to the Leyland::Manual. The documentation of this distribution's classes is for reference only, the manual is where you're most likely to find your answers. Or not.
Leyland is named after Mr. Bean's clunker of a car - the British Leyland Mini 1000. I don't know why.
A hash-ref of configuration options for the application. If not provided, a default configuration will be used.
The name of the class to be used as the context class for every request. Defaults to Leyland::Context. If provided, the class must extend Leyland::Context.
The package name of the application, for example MyApp or My::App. Automatically created from the app's configuration. If config doesn't define a name, 'Leyland' will be used.
A logger object that does Leyland::Logger, providing the application with logging capabilities. Automatically built from the app's config, unless config doesn't define a logger, in which case Leyland::Logger::STDERR will be used.
If application config defines a path for localization files, this will hold a Leyland::Localizer object, which is based on Locale::Wolowitz.
An array refernce of all Leyland::View classes enabled in the app's configuration. If none defined, Tenjin is used by default.
A Tie::IxHash object holding all routes defined in the application's controllers. Automatically created, not to be used directly by applications.
An integer representing the number of requests handled by the application. Automatically created.
The plack environment in which the application is running. This is the PLACK_ENV environment variable. Defaults to "development" unless you've provided a specific value to plackup (via the -E switch or by changing PLACK_ENV directly).
Creates a new instance of this class. None of the attributes are required (in fact, you shouldn't pass most of them), but you will mostly pass the config attribute, and possibly the context_class attribute.
Meant to be overridden by applications, this is automatically called right after the application has been initialized, so it is useful for one-time initializations your application might need to perform. If not overridden, this method does nothing.
Receives a Plack environment hash-ref of an HTTP request, creates a new instance of the application's context class (most probably Leyland::Context), performs HTTP negotiations and finds routes matching the request. If any are found, the first one is invoked and an HTTP response is generated and returned.
You should note that requests to paths that end with a slash will automatically be redirected without the trailing slash.
This method will probably be called from app.psgi.
Returns a true value if the application has a localizer.
Returns a true value if the application has any view classes.
Returns a true value if the application has any routes defined in its controllers.
The following methods are only to be used internally.
Automatically called by Moose after instance creation, this method loads the context class, application logger, localizer, controllers and views. It then find all routes in the controllers, runs the application's setup() method, and prints a nice info table to the log.
Receives exceptions thrown by the application (including run-time errors) and generates an HTTP response with the error information, in a format recognizable by the client.
Returns a default configuration hash-ref.
Used by Text::SpanningTable when printing the application's info table.
Prints an info table of the application after initialization.
Ido Perlmuter, <ido at ido50.net>
I wish to thank the following people:
Please report any bugs or feature requests to bug-Leyland at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Leyland. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
You can find documentation for this module with the perldoc command.
perldoc Leyland
You can also look for information at:
Copyright 2010-2011 Ido Perlmuter.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
