SimpleTools

This project aims to include simple but powerful utils and structures to simplify the Mojo development.

Installation

Just paste to the root of your project the simpletools.mojopkg package file.

To understand how to do imports check example_usage.mojo.

SimpleList

SimpleList is a generic data structure that provides a list-like interface for storing and manipulating data of any type. Think of list in Python but with extra methods.

Methods

append

Appends a value to the end of the SimpleList.

get

Returns the item at the given index, or the default value if the index is out of range.

foreach

Applies a function to each item in the SimpleList.

map

Applies a function to each item in the SimpleList and returns a new SimpleList with the results.

all

Returns True if the function returns True for all items in the SimpleList, False otherwise.

any

Returns True if the function returns True for any item in the SimpleList, False otherwise.

range

Returns a new SimpleList with items from the given start index to the end index.

reduce

Applies a function of two arguments cumulatively to the items of the SimpleList, from left to right, so as to reduce the SimpleList to a single output.

size

Returns the number of items in the SimpleList.

How to use

There are multiple examples in the test_simplelist.mojo file.

FAQ

This does not work with my struct

It is possible that you are not using the two annotations needed or that you are using String instead of StringRef. Check the example files mentioned in How to use for examples.

Why is not __iter__ implemented?

There are certain limitations in the standard lib that makes this harder than needed. Iterations support would be added sooner than later, for now you can use the foreach and map methods.

MojoTest

MojoTest is a utility struct for testing in Mojo. It provides a simple interface for common testing assertions, such as assert_true, assert_false, and assert_equal.

It enables your code to use Mojo Pytest

Usage

First, initialize a MojoTest instance with a test name:

var test = MojoTest("My Test")

Then, you can use the various assertion methods:

• assert_true(cond: Bool, message: String): Asserts that a condition is true. If not, it outputs the provided message.
• assert_true(cond: Bool): Asserts that a condition is true. If not, it outputs a default message.
• assert_false(cond: Bool, message: String): Asserts that a condition is false. If not, it outputs the provided message.
• assert_false(cond: Bool): Asserts that a condition is false. If not, it outputs a default message.
• assert_equal(a: StringRef, b: StringRef): Asserts that two strings are equal.
• assert_equal(a: Int, b: Int): Asserts that two integers are equal.

Example:

test.assert_true(1 == 1, "One should be equal to one")
test.assert_false(1 == 2, "One should not be equal to two")
test.assert_equal("Hello", "Hello")
test.assert_equal(5, 5)

License

This project is licensed under the terms of the MIT license.