• Stars
    star
    160
  • Rank 227,810 (Top 5 %)
  • Language
    Perl
  • License
    Other
  • Created over 14 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

yet another web application framework

Build Status

NAME

Amon2 - lightweight web application framework

SYNOPSIS

package MyApp;
use parent qw/Amon2/;
use Amon2::Config::Simple;
sub load_config { Amon2::Config::Simple->load(shift) }

DESCRIPTION

Amon2 is simple, readable, extensible, STABLE, FAST web application framework based on Plack.

METHODS

CLASS METHODS for Amon2 class

  • my $c = MyApp->context();

    Get the context object.

  • MyApp->set_context($c)

    Set your context object(INTERNAL USE ONLY).

CLASS METHODS for inherited class

  • MyApp->config()

    This method returns configuration information. It is generated by MyApp->load_config().

  • MyApp->mode_name()

    This is a mode name for Amon2. The default implementation of this method is:

      sub mode_name { $ENV{PLACK_ENV} }
    

    You can override this method if you want to determine the mode by other method.

  • MyApp->new()

    Create new context object.

  • MyApp->bootstrap()

      my $c = MyApp->bootstrap();
    

    Create new context object and set it to global context. When you are writing CLI script, setup the global context object by this method.

  • MyApp->base_dir()

    This method returns the application base directory.

  • MyApp->load_plugin($module_name[, \%config])

    This method loads the plugin for the application.

    $module_name package name of the plugin. You can write it as two form like DBIx::Class:

      __PACKAGE__->load_plugin("Web::CSRFDefender");    # => loads Amon2::Plugin::Web::CSRFDefender
    

    If you want to load a plugin in your own name space, use the '+' character before a package name, like following: __PACKAGE__->load_plugin("+MyApp::Plugin::Foo"); # => loads MyApp::Plugin::Foo

  • MyApp->load_plugins($module_name[, \%config ], ...)

    Load multiple plugins at one time.

    If you want to load a plugin in your own name space, use the '+' character before a package name like following:

      __PACKAGE__->load_plugins("+MyApp::Plugin::Foo"); # => loads MyApp::Plugin::Foo
    
  • MyApp->load_config()

    You can get a configuration hashref from config/$ENV{PLACK_ENV}.pl. You can override this method for customizing configuration loading method.

  • MyApp->add_config()

    DEPRECATED.

  • MyApp->debug_mode()

    ((EXPERIMENTAL))

    This method returns a boolean value. It returns true when $ENV{AMON2_DEBUG} is true value, false otherwise.

    You can override this method if you need.

PROJECT LOCAL MODE

THIS MODE IS HIGHLY EXPERIMENTAL

Normally, Amon2's context is stored in a global variable.

This module makes the context to project local.

It means, normally context class using Amon2 use $Amon2::CONTEXT in each project, but context class using "PROJECT LOCAL MODE" use $MyApp::CONTEXT.

It means you can't use code depend <Amon2-context>> and <Amon2-context>> under this mode.>

NOTES ABOUT create_request

Older Amon2::Web::Request has only 1 argument like following, it uses Amon2->context to get encoding:

sub create_request {
    my ($class, $env) = @_;
    Amon2::Web::Request->new($env);
}

If you want to use "PROJECT LOCAL MODE", you need to pass class name of context class, as following:

sub create_request {
    my ($class, $env) = @_;
    Amon2::Web::Request->new($env, $class);
}

HOW DO I ENABLE PROJECT LOCAL MODE?

MyApp-make_local_context() > turns on the project local mode.

There is no way to revert it, thanks.

METHODS

This module inserts 3 methods to your context class.

  • MyApp->context()

    Shorthand for $MyApp::CONTEXT

  • MyApp->set_context($context)

    It's the same as:

      $MyApp::CONTEXT = $context
    
  • my $guard = MyApp->context_guard()

    Create new context guard class.

    It's the same as:

      Amon2::ContextGuard->new(shift, \$MyApp::CONTEXT);
    

DOCUMENTS

More complicated documents are available on http://amon.64p.org/

SUPPORTS

#amon at irc.perl.org is also available.

AUTHOR

Tokuhiro Matsuno [email protected]

CONTRIBUTORS

  • noblejasper
  • hiratara
  • s-aska
  • Kentaro Kuribayashi
  • Yuki Ibe
  • mattn
  • Masahiro Nagano
  • rightgo09
  • karupanerura
  • hatyuki
  • Keiji, Yoshimi
  • Nishibayashi Takuji
  • dragon3
  • Fuji, Goro
  • issm
  • hisaichi5518
  • Adrian
  • Fuji, Goro
  • ITO Nobuaki
  • Geraud CONTINSOUZAS
  • Syohei YOSHIDA
  • magnolia
  • Katsuhiro Konishi

LICENSE

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

More Repositories

1

plenv

Perl binary manager
Shell
500
star
2

java-handbook

137
star
3

git-xlsx-textconv

Go
132
star
4

akaza

Yet another Japanese IME for IBus/Linux
Rust
127
star
5

Furl

pretty fast http client library for perl5
Perl
103
star
6

Minilla

Authorizing tool for CPAN modules
Perl
97
star
7

Perl-Build

Perl
77
star
8

spring-vue-sample

Java
71
star
9

p6-Crust

PSGI library stack for Perl6
Raku
66
star
10

node-perl

Node perl wrapper
C++
63
star
11

toydi

Java
63
star
12

cpan-outdated

detect outdated CPAN modules
Perl
52
star
13

tora

Tora! Tora! Tora!
Perl
51
star
14

avans

Tiny thin web application framework for Java 8
Java
50
star
15

js-xlsx-demo

JavaScript
50
star
16

SQL-Maker

Perl
46
star
17

jawiki-kana-kanji-dict

Generate SKK/MeCab dictionary from Wikipedia(Japanese edition)
Python
40
star
18

node-mruby

C++
40
star
19

Daiku

Yet another build tool on Perl5
Perl
38
star
20

teng-handbook

Perl
38
star
21

mobirc

IRC Gateway for MobilePhone/iPhone/PC
JavaScript
34
star
22

Test-TCP

Test::TCP for perl
Perl
33
star
23

jsref

JavaScript
33
star
24

re2c-lemon-tutorial

C++
32
star
25

p5-router-simple

simple http router
Perl
32
star
26

tinyorm

Tiny O/R mapper for Java
Java
29
star
27

p5-psgiref

(DEPRECATED)just a prototype!
Perl
28
star
28

Web-Query

Perl
27
star
29

OrePAN

Perl
26
star
30

obsidian-2hop-links-plugin

TypeScript
26
star
31

optimize-perl-doc

how to optimize your perl code?
Perl
26
star
32

strftime-js

JavaScript
25
star
33

frepan

freshness mirror of cpan viewer
JavaScript
25
star
34

menta

General extlib/ for CGI applications.
Perl
25
star
35

PJP

Perl
24
star
36

micro_dispatcher.js

JavaScript
22
star
37

data-model-tutorial

the tutorial documents for Data::Model
Perl
22
star
38

OrePAN2

Perl
22
star
39

hoshipad

JavaScript
22
star
40

FormValidator-Lite

very lite and fast validation library for perl
Perl
21
star
41

go-examples

my Golang examples repo.
Go
21
star
42

THWebViewController

Minimalistic WebViewController
Objective-C
20
star
43

go-hsperfdata

Quite fast jps/jstat
Go
20
star
44

Test-Pretty

Perl
20
star
45

p5-http-server-fast

(DEPRECATED)
C++
18
star
46

p6-HTTP-Server-Tiny

Web application server for Perl6
Perl 6
18
star
47

gearman-stat.psgi

Display gearman stats.
18
star
48

visualwidth-js

JavaScript
18
star
49

Router-Boom

Perl
18
star
50

obsidian-pomodoro-plugin

TypeScript
17
star
51

Archer

Perl
17
star
52

nanobench

Tiny benchmarking framework for Java 7+
Java
17
star
53

nanowww

C++ lightweight, fast, portable HTTP client library
Perl
17
star
54

mouse

Moose minus the antlers
Perl
16
star
55

http-session

http session management library for perl
Perl
16
star
56

www-mobilecarrierjp

WWW::MobileCarrierJP
Perl
16
star
57

Tiffany

Template-For-All, Generic interface for perl template engines.
Perl
16
star
58

HTML-TreeBuilder-LibXML

drop-in-replacement for HTML::TreeBuilder::XPath
Perl
16
star
59

DBIx-Inspector

Perl
16
star
60

w3m

my private repo of w3m
C
15
star
61

File-Zglob

Perl
15
star
62

madeye

simple infrastructure monitoring tool
Perl
15
star
63

Smart-Args

the new args.pm!
Perl
15
star
64

Test-Kantan

Perl
14
star
65

Caroline

Yet another line editing library for Perl5
Perl
14
star
66

p5-net-drizzle

libdrizzle bindings for perl5
C
14
star
67

perl-echo-servers

C
14
star
68

gearman-starter.pl

bootstrap script for gearman worker
Perl
13
star
69

MySQL-BinLog

Perl
13
star
70

obsidian-stopwatch-plugin

TypeScript
13
star
71

MetaCPANExplorer

CSS
13
star
72

node-tcc

C++
13
star
73

HTML-Pictogram-MobileJp

[emoji:1] ใฟใŸใ„ใชใฎใ‚’ๅ‡ฆ็†ใงใใ‚‹ไบบ
Perl
13
star
74

App-watcher

Perl
13
star
75

tinyvalidator

Tiny validation library for Java 8
Java
13
star
76

Text-Markdown-Hoedown

Perl
13
star
77

java-samples

Java
12
star
78

nanotap

yet another tap header library
HTML
12
star
79

App-scan_prereqs_cpanfile

Scan prerequisite modules and generate CPANfile
Perl
12
star
80

MojaMoja

(PoC)yet another sinatra-ish framework built on CPAN modules
Perl
12
star
81

Test-SharedFork

Test::SharedFork
Perl
12
star
82

p5-cgi-emulate-psgi

CGI::Emulate::PSGI
Perl
11
star
83

p5-anyevent-mprpc

MessagePack RPC component for AnyEvent!
Perl
11
star
84

mRuby.pm

Perl
11
star
85

devel-bindpp

Devel::BindPP makes writing perl extension easily
C++
11
star
86

Test-Power

Perl
11
star
87

regexp-trie

Regexp::Trie for Java7
Java
11
star
88

Sub-Retry

Perl
11
star
89

blosxom.psgi

cho45 style blosxom thing for psgi. see http://coderepos.org/share/wiki/BlosxomClones
10
star
90

cgi-extlib-perl

General extlib/ for Perl CGI applications.
Perl
10
star
91

p5-module-install-forc

M::I extension for standalone C program/library
Perl
10
star
92

DBIx-Kohada

Perl
10
star
93

Amon2-Lite

Perl
10
star
94

autolink.js

JavaScript
10
star
95

Module-Spy

Perl
10
star
96

p6-WebSocket

Perl 6
10
star
97

Harriet

Perl
10
star
98

Cache-KyotoTycoon

KyotoTycoon client library for Perl5
Perl
10
star
99

mindcheese

Editable mindmap library written in TypeScript
TypeScript
10
star
100

Perl-Lexer

C
10
star