Merge pull request #77 from codecrafters-io/upgrade-zig

Update Zig version to 0.12 in the starter code and solution code.

Author: rohitpaulk

compiled_starters/zig/README.md

@@ -30,7 +30,7 @@ Time to move on to the next stage!
 
 Note: This section is for stages 2 and beyond.
 
-1. Ensure you have `zig (0.11)` installed locally
+1. Ensure you have `zig (0.12)` installed locally
 1. Run `./your_sqlite3.sh` to run your program, which is implemented in
    `app/main.zig`.
 1. Commit your changes and run `git push origin master` to submit your solution

compiled_starters/zig/app/main.zig

@@ -1,35 +1,34 @@
 const std = @import("std");
 
 pub fn main() !void {
-    // You can use print statements as follows for debugging, they'll be visible when running tests.
-    try std.io.getStdOut().writer().print("Logs from your program will appear here\n", .{});
-
-    // Uncomment this to pass the first stage
-    //
-    // var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    // defer _ = gpa.deinit();
-    // const allocator = gpa.allocator();
-    //
-    // const args = try std.process.argsAlloc(allocator);
-    // defer std.process.argsFree(allocator, args);
-    //
-    //
-    // if (args.len < 3) {
-    //     try std.io.getStdErr().writer().print("Usage: {s} <database_file_path> <command>\n", .{args[0]});
-    //     return;
-    // }
-    //
-    // var database_file_path: []const u8 = args[1];
-    // var command: []const u8 = args[2];
-    //
-    // if (std.mem.eql(u8, command, ".dbinfo")) {
-    //     var file = try std.fs.cwd().openFile(database_file_path, .{});
-    //     defer file.close();
-    //
-    //     var buf: [2]u8 = undefined;
-    //     _ = try file.seekTo(16);
-    //     _ = try file.read(&buf);
-    //     const page_size = std.mem.readInt(u16, &buf, .Big);
-    //     try std.io.getStdOut().writer().print("database page size: {}\n", .{page_size});
-    // }
+    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+    defer _ = gpa.deinit();
+    const allocator = gpa.allocator();
+
+    const args = try std.process.argsAlloc(allocator);
+    defer std.process.argsFree(allocator, args);
+
+    if (args.len < 3) {
+        try std.io.getStdErr().writer().print("Usage: {s} <database_file_path> <command>\n", .{args[0]});
+        return;
+    }
+
+    const database_file_path: []const u8 = args[1];
+    const command: []const u8 = args[2];
+
+
+    if (std.mem.eql(u8, command, ".dbinfo")) {
+        var file = try std.fs.cwd().openFile(database_file_path, .{});
+        defer file.close();
+
+        // You can use print statements as follows for debugging, they'll be visible when running tests.
+        try std.io.getStdOut().writer().print("Logs from your program will appear here\n", .{});
+
+        // Uncomment this block to pass the first stage
+        // var buf: [2]u8 = undefined;
+        // _ = try file.seekTo(16);
+        // _ = try file.read(&buf);
+        // const page_size = std.mem.readInt(u16, &buf, .big);
+        // try std.io.getStdOut().writer().print("database page size: {}\n", .{page_size});
+    }
 }

compiled_starters/zig/build.zig

@@ -0,0 +1,27 @@
+const std = @import("std");
+
+// Learn more about this file here: https://ziglang.org/learn/build-system
+pub fn build(b: *std.Build) void {
+    const exe = b.addExecutable(.{
+        .name = "zig",
+        .root_source_file = b.path("src/main.zig"),
+        .target = b.standardTargetOptions(.{}),
+        .optimize = b.standardOptimizeOption(.{}),
+    });
+
+    // This declares intent for the executable to be installed into the
+    // standard location when the user invokes the "install" step (the default
+    // step when running `zig build`).
+    b.installArtifact(exe);
+
+    // This *creates* a Run step in the build graph, to be executed when another
+    // step is evaluated that depends on it. The next line below will establish
+    // such a dependency.
+    const run_cmd = b.addRunArtifact(exe);
+
+    // This creates a build step. It will be visible in the `zig build --help` menu,
+    // and can be selected like this: `zig build run`
+    // This will evaluate the `run` step rather than the default, which is "install".
+    const run_step = b.step("run", "Run the app");
+    run_step.dependOn(&run_cmd.step);
+}

compiled_starters/zig/build.zig.zon

@@ -0,0 +1,67 @@
+.{
+    .name = "zig",
+    // This is a [Semantic Version](https://semver.org/).
+    // In a future version of Zig it will be used for package deduplication.
+    .version = "0.0.0",
+
+    // This field is optional.
+    // This is currently advisory only; Zig does not yet do anything
+    // with this value.
+    //.minimum_zig_version = "0.12.0",
+
+    // This field is optional.
+    // Each dependency must either provide a `url` and `hash`, or a `path`.
+    // `zig build --fetch` can be used to fetch all dependencies of a package, recursively.
+    // Once all dependencies are fetched, `zig build` no longer requires
+    // internet connectivity.
+    .dependencies = .{
+        // See `zig fetch --save <url>` for a command-line interface for adding dependencies.
+        //.example = .{
+        //    // When updating this field to a new URL, be sure to delete the corresponding
+        //    // `hash`, otherwise you are communicating that you expect to find the old hash at
+        //    // the new URL.
+        //    .url = "https://example.com/foo.tar.gz",
+        //
+        //    // This is computed from the file contents of the directory of files that is
+        //    // obtained after fetching `url` and applying the inclusion rules given by
+        //    // `paths`.
+        //    //
+        //    // This field is the source of truth; packages do not come from a `url`; they
+        //    // come from a `hash`. `url` is just one of many possible mirrors for how to
+        //    // obtain a package matching this `hash`.
+        //    //
+        //    // Uses the [multihash](https://multiformats.io/multihash/) format.
+        //    .hash = "...",
+        //
+        //    // When this is provided, the package is found in a directory relative to the
+        //    // build root. In this case the package's hash is irrelevant and therefore not
+        //    // computed. This field and `url` are mutually exclusive.
+        //    .path = "foo",
+
+        //    // When this is set to `true`, a package is declared to be lazily
+        //    // fetched. This makes the dependency only get fetched if it is
+        //    // actually used.
+        //    .lazy = false,
+        //},
+    },
+
+    // Specifies the set of files and directories that are included in this package.
+    // Only files and directories listed here are included in the `hash` that
+    // is computed for this package.
+    // Paths are relative to the build root. Use the empty string (`""`) to refer to
+    // the build root itself.
+    // A directory listed here means that all files within, recursively, are included.
+    .paths = .{
+        // This makes *all* files, recursively, included in this package. It is generally
+        // better to explicitly list the files and directories instead, to insure that
+        // fetching from tarballs, file system paths, and version control all result
+        // in the same contents hash.
+        "",
+        // For example...
+        //"build.zig",
+        //"build.zig.zon",
+        //"src",
+        //"LICENSE",
+        //"README.md",
+    },
+}

compiled_starters/zig/codecrafters.yml

@@ -7,5 +7,5 @@ debug: false
 # Use this to change the Zig version used to run your code
 # on Codecrafters.
 #
-# Available versions: zig-0.11
-language_pack: zig-0.11
+# Available versions: zig-0.12
+language_pack: zig-0.12

compiled_starters/zig/src/main.zig

@@ -0,0 +1,34 @@
+const std = @import("std");
+
+pub fn main() !void {
+    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+    defer _ = gpa.deinit();
+    const allocator = gpa.allocator();
+
+    const args = try std.process.argsAlloc(allocator);
+    defer std.process.argsFree(allocator, args);
+
+    if (args.len < 3) {
+        try std.io.getStdErr().writer().print("Usage: {s} <database_file_path> <command>\n", .{args[0]});
+        return;
+    }
+
+    const database_file_path: []const u8 = args[1];
+    const command: []const u8 = args[2];
+
+
+    if (std.mem.eql(u8, command, ".dbinfo")) {
+        var file = try std.fs.cwd().openFile(database_file_path, .{});
+        defer file.close();
+
+        // You can use print statements as follows for debugging, they'll be visible when running tests.
+        try std.io.getStdOut().writer().print("Logs from your program will appear here\n", .{});
+
+        // Uncomment this block to pass the first stage
+        // var buf: [2]u8 = undefined;
+        // _ = try file.seekTo(16);
+        // _ = try file.read(&buf);
+        // const page_size = std.mem.readInt(u16, &buf, .big);
+        // try std.io.getStdOut().writer().print("database page size: {}\n", .{page_size});
+    }
+}

dockerfiles/zig-0.12.Dockerfile

@@ -0,0 +1,32 @@
+# syntax=docker/dockerfile:1.7-labs
+FROM alpine:3.20
+
+# Add the testing repository
+RUN echo "@community http://dl-cdn.alpinelinux.org/alpine/edge/community" >> /etc/apk/repositories
+
+# We should use build.zig & build.zig.zon to cache downloading deps, but we don't have this wired up yet.
+#
+# For anyone interesting in helping out here, this'll need to:
+#
+# (a) Add build.zig and build.zig.zon to CODECRAFTERS_DEPENDENCY_FILE_PATHS so that the Docker container
+#     is re-built when these files change.
+# (b) Add step(s) to copy only these files (and not the entire submission) into the Docker container.
+# (c) Add a step to force Zig to download dependencies and cache them (they'll then be used in the precompile script).
+#
+# ENV CODECRAFTERS_DEPENDENCY_FILE_PATHS="build.zig,build.zig.zon"
+
+# Update the package list and install Zig
+RUN apk add --no-cache zig@community=0.12.0-r0
+
+WORKDIR /app
+
+# .git & README.md are unique per-repository. We ignore them on first copy to prevent cache misses
+COPY --exclude=.git --exclude=README.md . /app
+
+RUN zig build
+
+RUN printf "set -e \ncd \${CODECRAFTERS_SUBMISSION_DIR} \necho 'Running zig build' \nzig build \necho 'zig build completed.' \n" > /codecrafters-precompile.sh
+RUN chmod +x /codecrafters-precompile.sh
+
+# Once the heavy steps are done, we can copy all files back
+COPY . /app

solutions/zig/01-dr6/code/README.md

@@ -30,7 +30,7 @@ Time to move on to the next stage!
 
 Note: This section is for stages 2 and beyond.
 
-1. Ensure you have `zig (0.11)` installed locally
+1. Ensure you have `zig (0.12)` installed locally
 1. Run `./your_sqlite3.sh` to run your program, which is implemented in
    `app/main.zig`.
 1. Commit your changes and run `git push origin master` to submit your solution

solutions/zig/01-dr6/code/app/main.zig

@@ -8,14 +8,14 @@ pub fn main() !void {
     const args = try std.process.argsAlloc(allocator);
     defer std.process.argsFree(allocator, args);
 
-
     if (args.len < 3) {
         try std.io.getStdErr().writer().print("Usage: {s} <database_file_path> <command>\n", .{args[0]});
         return;
     }
 
-    var database_file_path: []const u8 = args[1];
-    var command: []const u8 = args[2];
+    const database_file_path: []const u8 = args[1];
+    const command: []const u8 = args[2];
+
 
     if (std.mem.eql(u8, command, ".dbinfo")) {
         var file = try std.fs.cwd().openFile(database_file_path, .{});
@@ -24,7 +24,7 @@ pub fn main() !void {
         var buf: [2]u8 = undefined;
         _ = try file.seekTo(16);
         _ = try file.read(&buf);
-        const page_size = std.mem.readInt(u16, &buf, .Big);
+        const page_size = std.mem.readInt(u16, &buf, .big);
         try std.io.getStdOut().writer().print("database page size: {}\n", .{page_size});
     }
 }

solutions/zig/01-dr6/code/build.zig

@@ -0,0 +1,27 @@
+const std = @import("std");
+
+// Learn more about this file here: https://ziglang.org/learn/build-system
+pub fn build(b: *std.Build) void {
+    const exe = b.addExecutable(.{
+        .name = "zig",
+        .root_source_file = b.path("src/main.zig"),
+        .target = b.standardTargetOptions(.{}),
+        .optimize = b.standardOptimizeOption(.{}),
+    });
+
+    // This declares intent for the executable to be installed into the
+    // standard location when the user invokes the "install" step (the default
+    // step when running `zig build`).
+    b.installArtifact(exe);
+
+    // This *creates* a Run step in the build graph, to be executed when another
+    // step is evaluated that depends on it. The next line below will establish
+    // such a dependency.
+    const run_cmd = b.addRunArtifact(exe);
+
+    // This creates a build step. It will be visible in the `zig build --help` menu,
+    // and can be selected like this: `zig build run`
+    // This will evaluate the `run` step rather than the default, which is "install".
+    const run_step = b.step("run", "Run the app");
+    run_step.dependOn(&run_cmd.step);
+}