arHSM / bottom-cr

Bottom spec implementation in Crystal

bottom-cr

A bottom spec implementation in Crystal

The spec can be found at https://github.com/bottom-software-foundation/spec

Installation

Just download bottom.cr and add it to your project or w/e

Usage

require "path/to/bottom.cr"

puts Bottom.encode("Hello")
# Output: 💖✨✨,,👉👈💖💖,👉👈💖💖🥺,,,👉👈💖💖🥺,,,👉👈💖💖✨,👉👈
puts Bottom.decode("💖✨✨,,👉👈💖💖,👉👈💖💖🥺,,,👉👈💖💖🥺,,,👉👈💖💖✨,👉👈")
# Output: Hello

Documentation

def decode(string : String) : String

Validates and decodes the given string. Raises an ArgumentError if string is not a valid bottom-encoded string or the string is not valid a valid UTF8 string.

Example:

Valid:

puts Bottom.decode("💖✨✨,,👉👈💖💖,👉👈💖💖🥺,,,👉👈💖💖🥺,,,👉👈💖💖✨,👉👈")
# Output: Hello

Invalid:

puts Bottom.decode("Hello")
# Output: ArgumentError

Returns String

def encode(string : String) : String

Encodes string as per the bottom spec. Raises an ArgumentError if the string is not a valid UTF8 string.

Example:

puts Bottom.encode("Hello")
# Output: 💖✨✨,,👉👈💖💖,👉👈💖💖🥺,,,👉👈💖💖🥺,,,👉👈💖💖✨,👉👈

Returns String

def verify_bottom(string : String)

Validates the given String instance. Raises an ArgumentError if string is not a valid bottom-encoded string or the string is not valid a valid UTF8 string.

Example:

Valid:

puts Bottom.verify_bottom("💖✨✨,,👉👈💖💖,👉👈💖💖🥺,,,👉👈💖💖🥺,,,👉👈💖💖✨,👉👈")
# Output: nil

Invalid:

puts Bottom.verify_bottom("Hello")
# Output: ArgumentError

Returns nil

Contributors

• arHSM - creator and maintainer