Merge pull request #69 from codecrafters-io/CC-1158-gleam

CC-1158: Add Gleam support to SQLite

Author: ryan-gang

compiled_starters/gleam/.gitattributes

@@ -0,0 +1 @@
+* text=auto

compiled_starters/gleam/.gitignore

@@ -0,0 +1,4 @@
+*.beam
+*.ez
+/build
+erl_crash.dump

compiled_starters/gleam/README.md

@@ -0,0 +1,77 @@
+![progress-banner](https://codecrafters.io/landing/images/default_progress_banners/sqlite.png)
+
+This is a starting point for Gleam solutions to the
+["Build Your Own SQLite" Challenge](https://codecrafters.io/challenges/sqlite).
+
+In this challenge, you'll build a barebones SQLite implementation that supports
+basic SQL queries like `SELECT`. Along the way we'll learn about
+[SQLite's file format](https://www.sqlite.org/fileformat.html), how indexed data
+is
+[stored in B-trees](https://jvns.ca/blog/2014/10/02/how-does-sqlite-work-part-2-btrees/)
+and more.
+
+**Note**: If you're viewing this repo on GitHub, head over to
+[codecrafters.io](https://codecrafters.io) to try the challenge.
+
+# Passing the first stage
+
+The entry point for your SQLite implementation is in `src/sqlite.gleam`. Study
+and uncomment the relevant code, and push your changes to pass the first stage:
+
+```sh
+git add .
+git commit -m "pass 1st stage" # any msg
+git push origin master
+```
+
+Time to move on to the next stage!
+
+# Stage 2 & beyond
+
+Note: This section is for stages 2 and beyond.
+
+1. Ensure you have `gleam (1.0)` installed locally
+1. Run `./your_sqlite3.sh` to run your program, which is implemented in
+   `src/sqlite.gleam`.
+1. Commit your changes and run `git push origin master` to submit your solution
+   to CodeCrafters. Test output will be streamed to your terminal.
+
+# Sample Databases
+
+To make it easy to test queries locally, we've added a sample database in the
+root of this repository: `sample.db`.
+
+This contains two tables: `apples` & `oranges`. You can use this to test your
+implementation for the first 6 stages.
+
+You can explore this database by running queries against it like this:
+
+```sh
+$ sqlite3 sample.db "select id, name from apples"
+1|Granny Smith
+2|Fuji
+3|Honeycrisp
+4|Golden Delicious
+```
+
+There are two other databases that you can use:
+
+1. `superheroes.db`:
+   - This is a small version of the test database used in the table-scan stage.
+   - It contains one table: `superheroes`.
+   - It is ~1MB in size.
+1. `companies.db`:
+   - This is a small version of the test database used in the index-scan stage.
+   - It contains one table: `companies`, and one index: `idx_companies_country`
+   - It is ~7MB in size.
+
+These aren't included in the repository because they're large in size. You can
+download them by running this script:
+
+```sh
+./download_sample_databases.sh
+```
+
+If the script doesn't work for some reason, you can download the databases
+directly from
+[codecrafters-io/sample-sqlite-databases](https://github.com/codecrafters-io/sample-sqlite-databases).

compiled_starters/gleam/codecrafters.yml

@@ -0,0 +1,11 @@
+# Set this to true if you want debug logs.
+#
+# These can be VERY verbose, so we suggest turning them off
+# unless you really need them.
+debug: false
+
+# Use this to change the Gleam version used to run your code
+# on Codecrafters.
+#
+# Available versions: gleam-1.0
+language_pack: gleam-1.0

compiled_starters/gleam/gleam.toml

@@ -0,0 +1,21 @@
+name = "sqlite"
+version = "1.0.0"
+
+# Fill out these fields if you intend to generate HTML documentation or publish
+# your project to the Hex package manager.
+#
+# description = ""
+# licences = ["Apache-2.0"]
+# repository = { type = "github", user = "username", repo = "project" }
+# links = [{ title = "Website", href = "https://gleam.run" }]
+#
+# For a full reference of all the available options, you can have a look at
+# https://gleam.run/writing-gleam/gleam-toml/. 
+
+[dependencies]
+gleam_stdlib = "~> 0.34 or ~> 1.0"
+argv = ">= 1.0.2 and < 2.0.0"
+file_streams = ">= 0.4.2 and < 1.0.0"
+
+[dev-dependencies]
+gleeunit = "~> 1.0"

compiled_starters/gleam/manifest.toml

@@ -0,0 +1,15 @@
+# This file was generated by Gleam
+# You typically do not need to edit this file
+
+packages = [
+  { name = "argv", version = "1.0.2", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "BA1FF0929525DEBA1CE67256E5ADF77A7CDDFE729E3E3F57A5BDCAA031DED09D" },
+  { name = "file_streams", version = "0.4.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "file_streams", source = "hex", outer_checksum = "86775D2F36B74C54C64CA9080ACA9B9CF4655759E8D3E87E1A2EA9B0FA8D0804" },
+  { name = "gleam_stdlib", version = "0.37.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "5398BD6C2ABA17338F676F42F404B9B7BABE1C8DC7380031ACB05BBE1BCF3742" },
+  { name = "gleeunit", version = "1.1.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "72CDC3D3F719478F26C4E2C5FED3E657AC81EC14A47D2D2DEBB8693CA3220C3B" },
+]
+
+[requirements]
+argv = { version = ">= 1.0.2 and < 2.0.0" }
+file_streams = { version = ">= 0.4.2 and < 1.0.0" }
+gleam_stdlib = { version = "~> 0.34 or ~> 1.0" }
+gleeunit = { version = "~> 1.0" }

compiled_starters/gleam/src/sqlite.gleam

@@ -0,0 +1,28 @@
+import argv
+import file_streams/read_stream
+import gleam/int.{to_string}
+import gleam/io
+
+pub fn main() {
+  // You can use print statements as follows for debugging, they'll be visible when running tests.
+  io.println("Logs from your program will appear here!")
+
+  let args = argv.load().arguments
+
+  // Uncomment this to pass the first stage
+  // case args {
+  //   [database_file_path, ".dbinfo", ..] -> {
+  //     let assert Ok(rs) = read_stream.open(database_file_path)
+  //     // Get a file handle to the database file, and skip the first 16 bytes
+  //     let assert Ok(_bytes) = read_stream.read_bytes_exact(rs, 16)
+  //     // The next 2 bytes hold the page size in big-endian format
+  //     let assert Ok(page_size) = read_stream.read_int16_be(rs)
+  //
+  //     io.print("database page size: ")
+  //     io.println(to_string(page_size))
+  //   }
+  //   _ -> {
+  //     io.println("Unknown command")
+  //   }
+  // }
+}

compiled_starters/gleam/your_sqlite3.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# DON'T EDIT THIS!
+#
+# CodeCrafters uses this file to test your code. Don't make any changes here!
+#
+# DON'T EDIT THIS!
+exec gleam run -- "$@"

course-definition.yml

@@ -44,6 +44,8 @@ languages:
   - slug: "zig"
   - slug: "java"
     release_status: "beta"
+  - slug: "gleam"
+    release_status: "beta"
   - slug: "typescript"
     release_status: "beta"
 

dockerfiles/gleam-1.0.Dockerfile

@@ -0,0 +1,5 @@
+FROM ghcr.io/gleam-lang/gleam:v1.0.0-erlang-alpine
+
+# Pre-compile steps
+RUN printf "cd \${CODECRAFTERS_SUBMISSION_DIR} && gleam build" > /codecrafters-precompile.sh
+RUN chmod +x /codecrafters-precompile.sh