Skip to content

Commit b547416

Browse files
author
Antono Vasiljev
committed
Initial import
0 parents  commit b547416

26 files changed

+2013
-0
lines changed

.gitignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
tmp/*
2+
log/*.log
3+
vendor/*
4+
bin/app.valum
5+
*~
6+
*.o
7+
*.c
8+
*.h
9+
.\#*
10+
*.swp

LGPL

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

Makefile

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
CC := gcc
2+
VALAC := valac-0.14
3+
FLAGS := --enable-experimental --thread --vapidir=./vapi/ \
4+
--cc=$(CC) --gir Valum-1.0.gir -D BENCHMARK
5+
PKG := --pkg gio-2.0 --pkg json-glib-1.0 --pkg gee-1.0 \
6+
--pkg libsoup-2.4 --pkg libmemcached --pkg luajit
7+
VSRC := $(shell find 'valum/' -type f -name "*.vala")
8+
CSRC := $(shell find 'valum/' -type f -name "*.c")
9+
APP := $(shell find 'app/' -type f -name "*.vala")
10+
EXE := ./bin/app.valum
11+
12+
all: clean $(EXE)
13+
14+
run: all
15+
$(EXE)
16+
17+
$(EXE): $(SRC)
18+
$(VALAC) $(FLAGS) $(PKG) $(VSRC) $(APP) -o $(EXE)
19+
20+
debug:
21+
@$(MAKE) "FLAGS=$(FLAGS) -g"
22+
23+
genc:
24+
@$(MAKE) "FLAGS=$(FLAGS) -C"
25+
26+
clean:
27+
rm -f $(CSRC) $(shell find 'valum' -type f -name '*.[co]') $(EXE)
28+
29+
.PHONY= all clean

README.md

+159
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
# Valum Framework. Relax :)
2+
3+
Valum is a web framework written in Vala.
4+
5+
# Quickstart
6+
7+
Debian/Ubuntu:
8+
9+
sudo apt-get install git-core build-essential valac-0.14 libgee-dev libsoup2.4-dev libjson-glib-dev
10+
cd valum && make run
11+
12+
Visit http://localhost:3000/
13+
Play with app in VALUM_ROOT/app/app.vala
14+
15+
16+
## Setup application
17+
18+
Somwhere in app/myfile.vala
19+
20+
var app = new Valum.App();
21+
app.port = 8080;
22+
app.listen();
23+
24+
## Simple GET request
25+
26+
app.get('hello', (req, res) => {
27+
res.status = 200;
28+
res.mime = "text/plain";
29+
res.headers["Hello"] = "Browser";
30+
res.append("Hello World!");
31+
});
32+
33+
// GET /hello
34+
35+
## Route scoping
36+
37+
app.scope("admin", (admin) => {
38+
admin.get("user/:id", (req, res) => {
39+
var id = req.params["id"];
40+
res.append(@"User id is $id");
41+
});
42+
});
43+
44+
// GET /admin/user/11
45+
// GET /admin/user/antono
46+
47+
## Simple POST request (TODO)
48+
49+
app.post("/form", (req, res) => {
50+
req.params["title"]; // NOT YET IMPLEMENTED
51+
});
52+
53+
## Scripting languages!
54+
55+
### Embedded Lua
56+
57+
Currently it works this way:
58+
59+
// GET /lua
60+
app.get("lua", (req, res) => {
61+
res.append(lua.eval("""
62+
require "markdown"
63+
return markdown('## Hello from lua.eval!')
64+
"""));
65+
66+
res.append(lua.run("app/hello.lua"));
67+
});
68+
69+
70+
This code works with either Lua or LuaJIT depending
71+
on --pkg option in Makefile. See ./vapi/lua[jit].vapi for
72+
details.
73+
74+
We are going to implement simplier syntax for lua scripts:
75+
76+
Vala code:
77+
78+
// GET /lua.html
79+
app.get("lua.html", app.lua("hello"));
80+
81+
Lua code:
82+
83+
-- VALUM_ROOT/scripts/hello.lua
84+
require 'markdown'
85+
return markdown("# Hello from Lua!!!")
86+
-- returned value will be appended to response body
87+
88+
Resulted html:
89+
90+
<h1> Hello from Lua!!! </h1>
91+
92+
### Embedded scheme! (TODO)
93+
94+
Vala code:
95+
96+
// GET /hello.scm
97+
app.get("hello.scm", app.scm("hello"));
98+
99+
Scheme code:
100+
101+
;; VALUM_ROOT/scripts/hello.scm
102+
(+ 1 2 3)
103+
;; returned value will be casted to string
104+
;; and appended to response body
105+
106+
## Persistance
107+
108+
### Memcached
109+
110+
var mc = new Valum.NoSQL.Memcached();
111+
112+
// GET /hello
113+
app.get('hello', (req, res) => {
114+
var value = mc.get("hello");
115+
res.append(value);
116+
mc.set("hello", @"Updated $value");
117+
});
118+
119+
### Redis (TODO)
120+
121+
We need vapi for hiredis: https://github.com/antirez/hiredis
122+
123+
var redis = new Valum.NoSQL.Redis();
124+
125+
app.get('hello', (req, res) => {
126+
var value = redis.get("hello");
127+
res.append(value);
128+
redis.set("hello", @"Updated $value");
129+
});
130+
131+
132+
### MongoDB (TODO)
133+
134+
This is not yet implemented. But mongo client for
135+
vala is on the way: https://github.com/chergert/mongo-glib
136+
137+
var mongo = new Valum.NoSQL.Mongo();
138+
139+
// GET /hello.json
140+
app.get('hello.json', (req, res) => {
141+
res.mime = 'application/json';
142+
res.append(mongo.find("hello"));
143+
});
144+
145+
146+
### CouchDB (TODO)
147+
148+
https://code.launchpad.net/~adiroiban/couchdb-glib/vala-bindings
149+
150+
151+
# Contributing
152+
153+
- add [email protected] to your jabber contact list
154+
- fork reository
155+
- pick one task from TODO.md
156+
- and add your name after it in TODO
157+
- code
158+
- make pull request
159+
- enjoy :)

TODO.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
- [CTPL](http://ctpl.tuxfamily.org/) − C Template (Parser) Library integration (antono)
3+
- [fcgi](https://github.com/apmasell/vapis/blob/master/fcgi.vapi) adapter
4+
- Avahi support for Zeroconf local
5+
addresses like http://cool-app.local
6+
- Some examples for [json generation](http://www.valadoc.org/Json-1.0/index.htm)
7+
- Logger with switchable backends (file, redis, dbus).
8+
- vapi for mongo-glib
9+
- vapi for guile
10+
- better (automagical) build system
11+
12+
Random links:
13+
14+
* http://ctpl.tuxfamily.org/
15+
* https://github.com/apmasell/vapis/blob/master/fcgi.vapi
16+
* http://code.google.com/p/sqlheavy/wiki/UserGuide
17+
* https://gitorious.org/libpeas-vapi ?
18+
* https://github.com/apmasell/vapis
19+
* https://github.com/crystalnix/vala-v8/blob/master/vala-test/vala_getting_started.vala
20+
* https://github.com/gorilla3d/Pawalicious/blob/master/server.vala
21+
* https://github.com/lgunsch/zmq-vala

0 commit comments

Comments
 (0)