Add ViewEngine for easy server integration
- ViewEngine manages views directory with path resolution - Auto-loads mixins from views/mixins/ directory - Simplifies template paths (relative to views dir, auto-adds extension) - Updated example app to use ViewEngine - Added example mixins (buttons.pug, cards.pug) - Updated CLAUDE.md with ViewEngine documentation
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
//! Pugz Template Inheritance Demo
|
||||
//!
|
||||
//! A web application demonstrating Pug-style template inheritance
|
||||
//! using the Pugz template engine with http.zig server.
|
||||
//! using the Pugz ViewEngine with http.zig server.
|
||||
//!
|
||||
//! Routes:
|
||||
//! GET / - Home page (layout.pug)
|
||||
@@ -19,58 +19,25 @@ const Allocator = std.mem.Allocator;
|
||||
/// Application state shared across all requests
|
||||
const App = struct {
|
||||
allocator: Allocator,
|
||||
views_dir: []const u8,
|
||||
engine: pugz.ViewEngine,
|
||||
|
||||
/// File resolver for loading templates from disk
|
||||
pub fn fileResolver(allocator: Allocator, path: []const u8) ?[]const u8 {
|
||||
const file = std.fs.cwd().openFile(path, .{}) catch return null;
|
||||
defer file.close();
|
||||
return file.readToEndAlloc(allocator, 1024 * 1024) catch null;
|
||||
pub fn init(allocator: Allocator) !App {
|
||||
return .{
|
||||
.allocator = allocator,
|
||||
.engine = try pugz.ViewEngine.init(allocator, .{
|
||||
.views_dir = "src/examples/app_01/views",
|
||||
}),
|
||||
};
|
||||
}
|
||||
|
||||
/// Render a template with data
|
||||
pub fn render(self: *App, template_name: []const u8, data: anytype) ![]u8 {
|
||||
// Build full path
|
||||
const template_path = try std.fs.path.join(self.allocator, &.{ self.views_dir, template_name });
|
||||
defer self.allocator.free(template_path);
|
||||
|
||||
// Load template source
|
||||
const source = fileResolver(self.allocator, template_path) orelse {
|
||||
return error.TemplateNotFound;
|
||||
};
|
||||
defer self.allocator.free(source);
|
||||
|
||||
// Parse template
|
||||
var lexer = pugz.Lexer.init(self.allocator, source);
|
||||
const tokens = try lexer.tokenize();
|
||||
|
||||
var parser = pugz.Parser.init(self.allocator, tokens);
|
||||
const doc = try parser.parse();
|
||||
|
||||
// Setup context with data
|
||||
var ctx = pugz.runtime.Context.init(self.allocator);
|
||||
defer ctx.deinit();
|
||||
|
||||
try ctx.pushScope();
|
||||
inline for (std.meta.fields(@TypeOf(data))) |field| {
|
||||
const value = @field(data, field.name);
|
||||
try ctx.set(field.name, pugz.runtime.toValue(self.allocator, value));
|
||||
}
|
||||
|
||||
// Render with file resolver for includes/extends
|
||||
var runtime = pugz.runtime.Runtime.init(self.allocator, &ctx, .{
|
||||
.file_resolver = fileResolver,
|
||||
.base_dir = self.views_dir,
|
||||
});
|
||||
defer runtime.deinit();
|
||||
|
||||
return runtime.renderOwned(doc);
|
||||
pub fn deinit(self: *App) void {
|
||||
self.engine.deinit();
|
||||
}
|
||||
};
|
||||
|
||||
/// Handler for GET /
|
||||
fn index(app: *App, _: *httpz.Request, res: *httpz.Response) !void {
|
||||
const html = app.render("layout.pug", .{
|
||||
const html = app.engine.render(app.allocator, "layout", .{
|
||||
.title = "Home",
|
||||
}) catch |err| {
|
||||
res.status = 500;
|
||||
@@ -84,7 +51,7 @@ fn index(app: *App, _: *httpz.Request, res: *httpz.Response) !void {
|
||||
|
||||
/// Handler for GET /page-a - demonstrates extends and block override
|
||||
fn pageA(app: *App, _: *httpz.Request, res: *httpz.Response) !void {
|
||||
const html = app.render("page-a.pug", .{
|
||||
const html = app.engine.render(app.allocator, "page-a", .{
|
||||
.title = "Page A - Pets",
|
||||
.items = &[_][]const u8{ "A", "B", "C" },
|
||||
.n = 0,
|
||||
@@ -100,7 +67,7 @@ fn pageA(app: *App, _: *httpz.Request, res: *httpz.Response) !void {
|
||||
|
||||
/// Handler for GET /page-b - demonstrates sub-layout inheritance
|
||||
fn pageB(app: *App, _: *httpz.Request, res: *httpz.Response) !void {
|
||||
const html = app.render("page-b.pug", .{
|
||||
const html = app.engine.render(app.allocator, "page-b", .{
|
||||
.title = "Page B - Sub Layout",
|
||||
}) catch |err| {
|
||||
res.status = 500;
|
||||
@@ -114,7 +81,7 @@ fn pageB(app: *App, _: *httpz.Request, res: *httpz.Response) !void {
|
||||
|
||||
/// Handler for GET /append - demonstrates block append
|
||||
fn pageAppend(app: *App, _: *httpz.Request, res: *httpz.Response) !void {
|
||||
const html = app.render("page-append.pug", .{
|
||||
const html = app.engine.render(app.allocator, "page-append", .{
|
||||
.title = "Page Append",
|
||||
}) catch |err| {
|
||||
res.status = 500;
|
||||
@@ -128,7 +95,7 @@ fn pageAppend(app: *App, _: *httpz.Request, res: *httpz.Response) !void {
|
||||
|
||||
/// Handler for GET /append-opt - demonstrates optional block keyword
|
||||
fn pageAppendOptional(app: *App, _: *httpz.Request, res: *httpz.Response) !void {
|
||||
const html = app.render("page-appen-optional-blk.pug", .{
|
||||
const html = app.engine.render(app.allocator, "page-appen-optional-blk", .{
|
||||
.title = "Page Append Optional",
|
||||
}) catch |err| {
|
||||
res.status = 500;
|
||||
@@ -145,13 +112,9 @@ pub fn main() !void {
|
||||
defer _ = gpa.deinit();
|
||||
const allocator = gpa.allocator();
|
||||
|
||||
// Views directory - relative to current working directory
|
||||
const views_dir = "src/examples/app_01/views";
|
||||
|
||||
var app = App{
|
||||
.allocator = allocator,
|
||||
.views_dir = views_dir,
|
||||
};
|
||||
// Initialize view engine once at startup
|
||||
var app = try App.init(allocator);
|
||||
defer app.deinit();
|
||||
|
||||
var server = try httpz.Server(*App).init(allocator, .{ .port = 8080 }, &app);
|
||||
defer server.deinit();
|
||||
|
||||
5
src/examples/app_01/views/mixins/buttons.pug
Normal file
5
src/examples/app_01/views/mixins/buttons.pug
Normal file
@@ -0,0 +1,5 @@
|
||||
mixin btn(text, type="primary")
|
||||
button(class="btn btn-" + type)= text
|
||||
|
||||
mixin btn-link(href, text)
|
||||
a.btn.btn-link(href=href)= text
|
||||
11
src/examples/app_01/views/mixins/cards.pug
Normal file
11
src/examples/app_01/views/mixins/cards.pug
Normal file
@@ -0,0 +1,11 @@
|
||||
mixin card(title)
|
||||
.card
|
||||
.card-header
|
||||
h3= title
|
||||
.card-body
|
||||
block
|
||||
|
||||
mixin card-simple(title, body)
|
||||
.card
|
||||
h3= title
|
||||
p= body
|
||||
24
src/root.zig
24
src/root.zig
@@ -7,12 +7,33 @@
|
||||
//! - Attributes and text interpolation
|
||||
//! - Control flow (if/else, each, while)
|
||||
//! - Mixins and template inheritance
|
||||
//!
|
||||
//! ## Quick Start (Server Usage)
|
||||
//!
|
||||
//! ```zig
|
||||
//! const pugz = @import("pugz");
|
||||
//!
|
||||
//! // Initialize view engine once at startup
|
||||
//! var engine = try pugz.ViewEngine.init(allocator, .{
|
||||
//! .views_dir = "src/views",
|
||||
//! });
|
||||
//! defer engine.deinit();
|
||||
//!
|
||||
//! // Render templates (use arena allocator per request)
|
||||
//! var arena = std.heap.ArenaAllocator.init(allocator);
|
||||
//! defer arena.deinit();
|
||||
//!
|
||||
//! const html = try engine.render(arena.allocator(), "pages/home", .{
|
||||
//! .title = "Home",
|
||||
//! });
|
||||
//! ```
|
||||
|
||||
pub const lexer = @import("lexer.zig");
|
||||
pub const ast = @import("ast.zig");
|
||||
pub const parser = @import("parser.zig");
|
||||
pub const codegen = @import("codegen.zig");
|
||||
pub const runtime = @import("runtime.zig");
|
||||
pub const view_engine = @import("view_engine.zig");
|
||||
|
||||
// Re-export main types for convenience
|
||||
pub const Lexer = lexer.Lexer;
|
||||
@@ -32,6 +53,9 @@ pub const Value = runtime.Value;
|
||||
pub const render = runtime.render;
|
||||
pub const renderTemplate = runtime.renderTemplate;
|
||||
|
||||
// High-level API
|
||||
pub const ViewEngine = view_engine.ViewEngine;
|
||||
|
||||
test {
|
||||
_ = @import("std").testing.refAllDecls(@This());
|
||||
}
|
||||
|
||||
243
src/view_engine.zig
Normal file
243
src/view_engine.zig
Normal file
@@ -0,0 +1,243 @@
|
||||
//! ViewEngine - High-level template engine for web servers.
|
||||
//!
|
||||
//! Provides a simple API for rendering Pug templates with:
|
||||
//! - Views directory configuration
|
||||
//! - Auto-loading mixins from a mixins subdirectory
|
||||
//! - Relative path resolution for includes and extends
|
||||
//!
|
||||
//! Example:
|
||||
//! ```zig
|
||||
//! var engine = try ViewEngine.init(allocator, .{
|
||||
//! .views_dir = "src/views",
|
||||
//! });
|
||||
//! defer engine.deinit();
|
||||
//!
|
||||
//! const html = try engine.render(arena.allocator(), "pages/home", .{
|
||||
//! .title = "Home",
|
||||
//! });
|
||||
//! ```
|
||||
|
||||
const std = @import("std");
|
||||
const Lexer = @import("lexer.zig").Lexer;
|
||||
const Parser = @import("parser.zig").Parser;
|
||||
const runtime = @import("runtime.zig");
|
||||
const ast = @import("ast.zig");
|
||||
|
||||
const Runtime = runtime.Runtime;
|
||||
const Context = runtime.Context;
|
||||
const Value = runtime.Value;
|
||||
|
||||
/// Configuration options for the ViewEngine.
|
||||
pub const Options = struct {
|
||||
/// Root directory containing view templates.
|
||||
views_dir: []const u8,
|
||||
/// Subdirectory within views_dir containing mixin files.
|
||||
/// Defaults to "mixins". Set to null to disable auto-loading.
|
||||
mixins_dir: ?[]const u8 = "mixins",
|
||||
/// File extension for templates. Defaults to ".pug".
|
||||
extension: []const u8 = ".pug",
|
||||
/// Enable pretty-printing with indentation.
|
||||
pretty: bool = true,
|
||||
};
|
||||
|
||||
/// Error types for ViewEngine operations.
|
||||
pub const ViewEngineError = error{
|
||||
TemplateNotFound,
|
||||
ParseError,
|
||||
OutOfMemory,
|
||||
AccessDenied,
|
||||
InvalidPath,
|
||||
};
|
||||
|
||||
/// A pre-parsed mixin definition.
|
||||
const MixinEntry = struct {
|
||||
name: []const u8,
|
||||
def: ast.MixinDef,
|
||||
};
|
||||
|
||||
/// ViewEngine manages template rendering with a configured views directory.
|
||||
pub const ViewEngine = struct {
|
||||
allocator: std.mem.Allocator,
|
||||
options: Options,
|
||||
/// Absolute path to views directory.
|
||||
views_path: []const u8,
|
||||
/// Pre-loaded mixin definitions.
|
||||
mixins: std.ArrayListUnmanaged(MixinEntry),
|
||||
/// Cached mixin source files (to keep slices valid).
|
||||
mixin_sources: std.ArrayListUnmanaged([]const u8),
|
||||
|
||||
/// Initializes the ViewEngine with the given options.
|
||||
/// Loads all mixins from the mixins directory if configured.
|
||||
pub fn init(allocator: std.mem.Allocator, options: Options) !ViewEngine {
|
||||
// Resolve views directory to absolute path
|
||||
const views_path = try std.fs.cwd().realpathAlloc(allocator, options.views_dir);
|
||||
errdefer allocator.free(views_path);
|
||||
|
||||
var engine = ViewEngine{
|
||||
.allocator = allocator,
|
||||
.options = options,
|
||||
.views_path = views_path,
|
||||
.mixins = .empty,
|
||||
.mixin_sources = .empty,
|
||||
};
|
||||
|
||||
// Auto-load mixins if configured
|
||||
if (options.mixins_dir) |mixins_subdir| {
|
||||
try engine.loadMixins(mixins_subdir);
|
||||
}
|
||||
|
||||
return engine;
|
||||
}
|
||||
|
||||
/// Releases all resources held by the ViewEngine.
|
||||
pub fn deinit(self: *ViewEngine) void {
|
||||
self.allocator.free(self.views_path);
|
||||
self.mixins.deinit(self.allocator);
|
||||
for (self.mixin_sources.items) |source| {
|
||||
self.allocator.free(source);
|
||||
}
|
||||
self.mixin_sources.deinit(self.allocator);
|
||||
}
|
||||
|
||||
/// Loads all mixin files from the specified subdirectory.
|
||||
fn loadMixins(self: *ViewEngine, mixins_subdir: []const u8) !void {
|
||||
const mixins_path = try std.fs.path.join(self.allocator, &.{ self.views_path, mixins_subdir });
|
||||
defer self.allocator.free(mixins_path);
|
||||
|
||||
var dir = std.fs.openDirAbsolute(mixins_path, .{ .iterate = true }) catch |err| {
|
||||
if (err == error.FileNotFound) {
|
||||
// Mixins directory doesn't exist - that's OK
|
||||
return;
|
||||
}
|
||||
return err;
|
||||
};
|
||||
defer dir.close();
|
||||
|
||||
var iter = dir.iterate();
|
||||
while (try iter.next()) |entry| {
|
||||
if (entry.kind != .file) continue;
|
||||
|
||||
// Check for .pug extension
|
||||
if (!std.mem.endsWith(u8, entry.name, self.options.extension)) continue;
|
||||
|
||||
// Read and parse the mixin file
|
||||
try self.loadMixinFile(dir, entry.name);
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads a single mixin file and extracts its mixin definitions.
|
||||
fn loadMixinFile(self: *ViewEngine, dir: std.fs.Dir, filename: []const u8) !void {
|
||||
const source = try dir.readFileAlloc(self.allocator, filename, 1024 * 1024);
|
||||
errdefer self.allocator.free(source);
|
||||
|
||||
// Keep source alive for string slices
|
||||
try self.mixin_sources.append(self.allocator, source);
|
||||
|
||||
// Parse the file
|
||||
var lexer = Lexer.init(self.allocator, source);
|
||||
defer lexer.deinit();
|
||||
|
||||
const tokens = lexer.tokenize() catch return;
|
||||
|
||||
var parser = Parser.init(self.allocator, tokens);
|
||||
const doc = parser.parse() catch return;
|
||||
|
||||
// Extract mixin definitions
|
||||
for (doc.nodes) |node| {
|
||||
if (node == .mixin_def) {
|
||||
try self.mixins.append(self.allocator, .{
|
||||
.name = node.mixin_def.name,
|
||||
.def = node.mixin_def,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Renders a template with the given data context.
|
||||
///
|
||||
/// The template path is relative to the views directory.
|
||||
/// The .pug extension is added automatically if not present.
|
||||
///
|
||||
/// Example:
|
||||
/// ```zig
|
||||
/// const html = try engine.render(allocator, "pages/home", .{
|
||||
/// .title = "Home Page",
|
||||
/// });
|
||||
/// ```
|
||||
pub fn render(self: *ViewEngine, allocator: std.mem.Allocator, template_path: []const u8, data: anytype) ![]u8 {
|
||||
// Build full path
|
||||
const full_path = try self.resolvePath(allocator, template_path);
|
||||
defer allocator.free(full_path);
|
||||
|
||||
// Read template file
|
||||
const source = std.fs.cwd().readFileAlloc(allocator, full_path, 1024 * 1024) catch {
|
||||
return ViewEngineError.TemplateNotFound;
|
||||
};
|
||||
defer allocator.free(source);
|
||||
|
||||
// Tokenize
|
||||
var lexer = Lexer.init(allocator, source);
|
||||
defer lexer.deinit();
|
||||
const tokens = lexer.tokenize() catch return ViewEngineError.ParseError;
|
||||
|
||||
// Parse
|
||||
var parser = Parser.init(allocator, tokens);
|
||||
const doc = parser.parse() catch return ViewEngineError.ParseError;
|
||||
|
||||
// Create context with data
|
||||
var ctx = Context.init(allocator);
|
||||
defer ctx.deinit();
|
||||
|
||||
// Register pre-loaded mixins
|
||||
for (self.mixins.items) |mixin_entry| {
|
||||
try ctx.defineMixin(mixin_entry.def);
|
||||
}
|
||||
|
||||
// Populate context from data struct
|
||||
try ctx.pushScope();
|
||||
inline for (std.meta.fields(@TypeOf(data))) |field| {
|
||||
const value = @field(data, field.name);
|
||||
try ctx.set(field.name, runtime.toValue(allocator, value));
|
||||
}
|
||||
|
||||
// Create runtime with file resolver for includes/extends
|
||||
var rt = Runtime.init(allocator, &ctx, .{
|
||||
.pretty = self.options.pretty,
|
||||
.base_dir = self.views_path,
|
||||
.file_resolver = createFileResolver(),
|
||||
});
|
||||
defer rt.deinit();
|
||||
|
||||
return rt.renderOwned(doc);
|
||||
}
|
||||
|
||||
/// Resolves a template path relative to views directory.
|
||||
fn resolvePath(self: *ViewEngine, allocator: std.mem.Allocator, template_path: []const u8) ![]const u8 {
|
||||
// Add extension if not present
|
||||
const with_ext = if (std.mem.endsWith(u8, template_path, self.options.extension))
|
||||
try allocator.dupe(u8, template_path)
|
||||
else
|
||||
try std.fmt.allocPrint(allocator, "{s}{s}", .{ template_path, self.options.extension });
|
||||
defer allocator.free(with_ext);
|
||||
|
||||
return std.fs.path.join(allocator, &.{ self.views_path, with_ext });
|
||||
}
|
||||
|
||||
/// Creates a file resolver function for the runtime.
|
||||
fn createFileResolver() runtime.FileResolver {
|
||||
return struct {
|
||||
fn resolve(allocator: std.mem.Allocator, path: []const u8) ?[]const u8 {
|
||||
return std.fs.cwd().readFileAlloc(allocator, path, 1024 * 1024) catch null;
|
||||
}
|
||||
}.resolve;
|
||||
}
|
||||
};
|
||||
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Tests
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
test "ViewEngine resolves paths correctly" {
|
||||
// This test requires a views directory - skip in unit tests
|
||||
// Full integration tests are in src/tests/
|
||||
}
|
||||
Reference in New Issue
Block a user