v2.0

README.md

@@ -1,2 +1,23 @@
 # Compass
-A Poorly Designed Go Web Framework
+
+A Go http wrapper for quick development.
+
+### Features
+
+- Kinda extensible
+- Passplate templating engine
+- Session management
+- Resource management
+- Questionable caching
+- No dependencies
+
+Internally, there is also:
+- Documentation on how things work and are implemented `/contributor-docs`
+- Testing suite
+
+### Why?
+
+There are probably better wrappers out there. Heck, even better Go web server implementations. And faster, too. This
+project was started to move from Python (Flask) to Go, but no suitable replacement was found (there probably already
+is). Therefore, it was decided to make our own, because reinventing the wheel is always such a good and well-thought-out
+decision™

contributor-docs/README.md

@@ -0,0 +1,6 @@
+# Compass Contributor Docs
+
+We care about maintaining our work and passing down information. Therefore, these docs exist. **THIS IS NOT THE REGULAR
+DOCUMENTATION,** which you can find at [wiki.snackbag.net/compass](https://wiki.snackbag.net/compass). This is meant as
+a guide to future contributors, so they don't have to take wild guesses, reimplement things themselves, and we avoid
+knowledge discrimination. When writing code for Compass, also write documentation.

contributor-docs/passplate/README.md

@@ -0,0 +1,23 @@
+# Passplate
+
+The Compass templating engine. It consists of the following parts:
+
+- lexer
+- parser
+- renderer
+- interpreter
+
+It brings support for variables and other logic components in normal HTML files, to be evaluated on the server-side. Its
+inner workings deviate from the typical programming language interpreter. When a new request for a template is made (and
+we exclude all caching magic), it looks similar to the following:
+
+1. Load template file
+2. Generate template AST
+    - parser goes before the lexer, because the lexer only runs within Passplate blocks
+3. Render AST
+    - renderer and interpreter are separated, since the renderer mainly focuses around creating cohesive HTML, while the
+      interpreter executes the logic
+
+## Useful files
+
+You can find all Passplate files within the `passplate` directory.

contributor-docs/passplate/ast.md

@@ -0,0 +1,37 @@
+# AST
+
+Passplate generates an AST to be interpreted/rendered. Pseudo:
+
+```json lines
+[
+  {"name": "Text", "value": "<h1>hey</h1><p>"},
+  {"name": "Variable", "id": "name"},
+  {"name": "Text", "id": "</p>"}
+]
+
+/*
+
+<h1>hey</h1>
+<% if name == "cool" %>
+  <p>your name is cool</p>
+<% else %>
+  <p>ur not cool</p>
+<% end %>
+
+*/
+
+[
+  {"name": "Text", "value": "<h1>hey</h1>\n"},
+  {"name": "Statement", 
+    "expr": { // name == "cool"
+      "a": {"type": "variable", "name": "name"}, 
+      "b": {"type": "string", "value": "cool"},
+      "operator": "=="
+    },
+
+    "pass": [{"name": "Text", "value": "<p>your name is cool</p>"}],
+    "else": [{"name": "Text", "value": "<p>ur not cool</p>"}]
+  }
+]
+
+```

contributor-docs/sessions.md

@@ -0,0 +1,18 @@
+# Sessions
+
+Compass handles sessions for you.
+
+A session is built up like this:
+
+- true ID; an integer stored only on the server as primary key, autoincrement.
+- UUID; the visual session ID. Stored in the server's database as `UNIQUE`, and on the client as the `_compassId`
+  cookie. It is what the server uses to distinguish sessions per request.
+- Value; a JSON string stored only on the server.
+- Expiry; the time a session takes until it expires. Stored on the server as unix timestamp, while the client's cookie
+  is set to never disappear.
+
+The server uses SQLite and has an index for the true ID and UUID.
+
+## Useful files
+- [/session.go](/session.go) - session creation, lookup & checking
+- [/db.go](/db.go) - database setup

examples/basics/01_hello_world/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"github.com/snackbag/compass"
+)
+
+func main() {
+	server := compass.NewServer(compass.NewStandardConfiguration())
+
+	server.AddRoute("/", func(request compass.Request) compass.Response {
+		return compass.Text("hi hello hey")
+	})
+
+	server.MustRun()
+}

examples/basics/02_logging/main.go

@@ -0,0 +1,11 @@
+package main
+
+import "github.com/snackbag/compass"
+
+func main() {
+	server := compass.NewServer(compass.NewStandardConfiguration())
+
+	server.Logger.Info("I'm simply logging some things")
+	server.Logger.Warn("I warn you about stuff")
+	server.Logger.Error("I am a big red scary text")
+}

examples/basics/03_static_pages/assets/static/test.txt

@@ -0,0 +1 @@
+Hello!

examples/basics/03_static_pages/main.go

@@ -0,0 +1,11 @@
+package main
+
+import (
+	"github.com/snackbag/compass"
+)
+
+// see result on localhost:3000/static/test.txt or hi.png
+func main() {
+	server := compass.NewServer(compass.NewStandardConfiguration())
+	server.MustRun()
+}

examples/basics/04_url_parameters/main.go

@@ -0,0 +1,16 @@
+package main
+
+import (
+	"github.com/snackbag/compass"
+)
+
+func main() {
+	server := compass.NewServer(compass.NewStandardConfiguration())
+
+	server.AddRoute("/@<username>", func(request compass.Request) compass.Response {
+		param := request.GetRouteParam("username") // returns empty if not found
+		return compass.Text(param)
+	})
+
+	server.MustRun()
+}

examples/basics/05_json/main.go

@@ -0,0 +1,17 @@
+package main
+
+import "github.com/snackbag/compass"
+
+func main() {
+	server := compass.NewServer(compass.NewStandardConfiguration())
+
+	server.AddRoute("/", func(request compass.Request) compass.Response {
+		return compass.JsonString(`{"test": 123, "wow": ["a", "b", "c"]}`)
+	})
+
+	server.AddRoute("/object", func(request compass.Request) compass.Response {
+		return compass.JsonMarshal(server.Config)
+	})
+
+	server.MustRun()
+}

examples/basics/06_download/main.go

@@ -0,0 +1,17 @@
+package main
+
+import "github.com/snackbag/compass"
+
+func main() {
+	server := compass.NewServer(compass.NewStandardConfiguration())
+
+	server.AddRoute("/", func(request compass.Request) compass.Response {
+		return compass.DownloadBytes("example.txt", []byte("helo ereveryione!!"))
+	})
+
+	server.AddRoute("/file", func(request compass.Request) compass.Response {
+		return compass.DownloadFile("file.png", "example.png")
+	})
+
+	server.MustRun()
+}

examples/basics/07_redirect/main.go

@@ -0,0 +1,17 @@
+package main
+
+import "github.com/snackbag/compass"
+
+func main() {
+	server := compass.NewServer(compass.NewStandardConfiguration())
+
+	server.AddRoute("/target", func(request compass.Request) compass.Response {
+		return compass.Text("Woohooo! You've been redirected :D")
+	})
+
+	server.AddRoute("/", func(request compass.Request) compass.Response {
+		return compass.Redirect("/target", false)
+	})
+
+	server.MustRun()
+}

examples/basics/08_serve/main.go

@@ -0,0 +1,13 @@
+package main
+
+import "github.com/snackbag/compass"
+
+func main() {
+	server := compass.NewServer(compass.NewStandardConfiguration())
+
+	server.AddRoute("/", func(request compass.Request) compass.Response {
+		return compass.ServeFile("example.mp3", "example.mp3")
+	})
+
+	server.MustRun()
+}

examples/passplate/01_basic_fill/main.go

@@ -0,0 +1,16 @@
+package main
+
+import (
+	"fmt"
+	"github.com/snackbag/compass/passplate"
+)
+
+func main() {
+	text := `<h1>Good morning, <$username/>.</h1><p>You are<%if role == "admin"/>an admin<%elif role == "cool"/>pretty cool<%else/>just chill like that<%end/></p>
+`
+	node, err := passplate.Read(text)
+	if err != nil {
+		fmt.Println(err)
+	}
+	fmt.Println(passplate.Represent(node, 0))
+}

logging.go

@@ -0,0 +1,65 @@
+package compass
+
+import (
+	"fmt"
+	"net/http"
+	"time"
+)
+
+type Logger interface {
+	Info(message string)
+	Warn(message string)
+	Error(message string)
+
+	Request(r *http.Request, code int)
+}
+
+type SimpleLogger struct {
+	PrefixMaxLength int
+}
+
+func (s *SimpleLogger) log(color string, prefix string, message string) {
+	currentTime := time.Now().Format("[2006-01-02 15:04:05]")
+
+	if len(prefix) > s.PrefixMaxLength {
+		prefix = prefix[:s.PrefixMaxLength]
+	}
+	prefix = fmt.Sprintf("%-*s", s.PrefixMaxLength, prefix)
+
+	fmt.Printf("%s %s%s\033[0m %s\033[0m\n", currentTime, color, prefix, message)
+}
+
+func (s *SimpleLogger) Info(message string) {
+	s.log("\x1b[38;2;40;177;249m", "INFO", message)
+}
+
+func (s *SimpleLogger) Warn(message string) {
+	s.log("\033[1;33m", "WARN", message)
+}
+
+func (s *SimpleLogger) Error(message string) {
+	s.log("\033[1;31m", "ERROR", message)
+}
+
+func (s *SimpleLogger) Request(r *http.Request, code int) {
+	var colorCode string
+	switch {
+	case code >= 200 && code < 300:
+		colorCode = "\033[1;32m"
+	case code >= 300 && code < 400:
+		colorCode = "\033[1;33m"
+	case code >= 400 && code < 600:
+		colorCode = "\033[1;31m"
+	default:
+		colorCode = "\033[1;37m"
+	}
+
+	fmt.Printf(
+		"\x1b[0;34m%s %s%d\033[0m - \033[0;35m%s %s\033[0m \033[0;37m\"%s\"\033[0m\n",
+		r.RemoteAddr, colorCode, code, r.Method, r.URL.Path, r.UserAgent(),
+	)
+}
+
+func NewSimpleLogger() *SimpleLogger {
+	return &SimpleLogger{PrefixMaxLength: 5}
+}

passplate/ast.go

@@ -0,0 +1,35 @@
+package passplate
+
+import (
+	"fmt"
+	"strings"
+)
+
+func Represent(_n Node, indent int) string {
+	switch n := _n.(type) {
+	case *RootNode:
+		{
+			builder := strings.Builder{}
+
+			for _, child := range n.Children {
+				i := strings.Repeat("    ", indent)
+
+				builder.WriteString(i + Represent(child, indent))
+				builder.WriteString("\n")
+			}
+
+			return builder.String()
+		}
+
+	case *TextNode:
+		return fmt.Sprintf("<Text: %s/>", n.Content)
+
+	case *ExprNode:
+		return fmt.Sprintf("<Expression: %s/>", n.Expression.Repr())
+
+	case *IfNode:
+		return n.Repr(indent)
+	}
+
+	return ""
+}