view release on metacpan or  search on metacpan

lib/Ado/Manual/Plugins.pod  view on Meta::CPAN

=pod

=encoding utf8

=head1 NAME

Ado::Manual::Plugins - Ado plugins and how to write an Ado::Plugin

=head1 DESCRIPTION

C<@Ado::ISA=qw(Mojolicious)>. It is distributed together with a few plugins to
make it usable as a basic Mojolicious application. Theoretically all of the
plugins, distributed with L<Ado> could be disabled so you can start your project
only as a bare (I<but full>) L<Mojolicious> application, if you wish.  Later you
can decide to enable some of them and eventually add (your own) L<Mojolicious>
or L<Ado> plugins. Here is how it looks.

=for HTML <img src="https://raw.githubusercontent.com/kberov/Ado/master/public/img/Ado-Building-Blocks.png" />

=head1 PLUGINS

Ado comes with the following default plugins. They can be used as examples and
for inspiration.

=over

=item * L<Ado::Plugin::AdoHelpers> - Default Ado helpers

=item * L<Ado::Plugin::Auth> - Authenticate users

=item * L<Ado::Plugin::I18n> - Internationalization and localization for Ado

=item * L<Ado::Plugin::MarkDownRenderer> - Render markdown to HTML

=item * L<Ado::Plugin::Routes> - Keep routes in their own configuration file separately

=item * L<Ado::Control::Test> - A controller used for testing Ado
(not a plugin by it self)

=back

The following plugins are written by me and are distributed separately. You can
install and use them in your application. Please help make them better.

=over

=item * L<Ado::Plugin::Admin> - system (site) administration user interface.

=item * L<Ado::Plugin::Site> - Manage your Sites.

=item * L<Ado::Plugin::Vest> - Messaging services for an Ado system!

=back

Do not hesitate to contact the Ado team and request your plugin to be added
to the above list.

=head1 WRITING A PLUGIN

There is I<almost> nothing special about writing an L<Ado::Plugin>. The only
difference between Ado and Mojolicious plugins is that Ado plugins can
retrieve their settings from their own configuration files.

The configuration file must be named after the respective plugin. A plugin
Ado::Plugin::Hello (when installed) will search its configuration in
C<app-E<gt>home-E<gt>rel_dir('etc/plugins/hello.conf')>. depending on the
current mode (C<$ENV{MOJO_MODE}>). The file
C<app-E<gt>home-E<gt>rel_dir('etc/plugins/hello.$ENV{MOJO_MODE}.conf')> will
also be loaded and will override all settings from
C<app-E<gt>home-E<gt>rel_dir('etc/plugins/hello.conf')>. The file must return
a HASHREF. See the code of the listed plugins below for examples of how and
what can be done in a plugin.

lib/Ado/Manual/Plugins.pod  view on Meta::CPAN

    title VARCHAR NOT NULL UNIQUE,
    body TEXT NOT NULL,
    published BOOL DEFAULT '0',
    deleted BOOL NOT NULL DEFAULT '0',
    user_id INTEGER REFERENCES users(id),
    group_id INTEGER REFERENCES groups(id),
    permissions VARCHAR(10) DEFAULT '-rwxr-xr-xr'
  );
  CREATE INDEX blog_published ON blog(published);
  CREATE INDEX blog_deleted ON blog(deleted);

=item * Add some dummy records.

  INSERT INTO blog(title,body,user_id,group_id)
  VALUES('Hey','Hello world',3,3);
  INSERT INTO blog(title,body,user_id,group_id)
  VALUES('Hey You','Hello Universe',3,3);

=item * Generate the files for the plugin. These are the files which you will edit :).

  $ cd ~/opt/public_dev
  $ ado generate adoplugin -n Blog --crud -t blog

The above command will generate the needed files for an ado plugin which can
even be uploaded to and subsequently downloaded from
L<CPAN|http://www.cpan.org/>. L<CPAN> is the best open source dependency
management system. You can also use L<Stratopan|https://stratopan.com/> if you
wish.

=back

Ado uses L<Ado::Build> and L<Ado::BuildPlugin> which extend L<Module::Build>.
They were created to add some custom actions and handle the additional
C<templates>,C<log> and C<public> directories in Ado root folder.
The file tree looks like the following:

  ~/opt/public_dev/Ado-Plugin-Blog$ tree
  .
  ├── Build.PL
  ├── etc
  │   └── plugins
  │       └── blog.conf
  ├── lib
  │   └── Ado
  │       ├── Control
  │       │   └── Blog.pm
  │       └── Plugin
  │           └── Blog.pm
  ├── templates
  │   └── blog
  │       ├── create.html.ep
  │       ├── delete.html.ep
  │       ├── list.html.ep
  │       └── read.html.ep
  └── t
      └── plugin
          └── blog-00.t


No worries, your plugin has everything needed to be installed from CPAN.
L<Ado::Plugin::Vest> was started using this command.

L<Ado> can be stripped down to a bare Mojolicious application by not loading
any plugins. And L<Ado> can be extended I<infinitely> just by adding helpers,
conditions, routes, templates and injecting code into hooks from plugins.
I<This is true for any Mojolicious application.>


=head1 SPONSORS

The original author

=head1 SEE ALSO

L<Mojolicious::Plugins>, L<Mojolicious::Plugin>,


=head1 AUTHOR

Красимир Беров (Krasimir Berov)

=head1 COPYRIGHT AND LICENSE

Copyright 2013-2014 Красимир Беров (Krasimir Berov).

This program is free software, you can redistribute it and/or
modify it under the terms of the
GNU Lesser General Public License v3 (LGPL-3.0).
You may copy, distribute and modify the software provided that
modifications are open source. However, software that includes
the license may release under a different license.

See http://opensource.org/licenses/lgpl-3.0.html for more information.

=cut