Compare commits

..

No commits in common. "main" and "v1.0.0" have entirely different histories.
main ... v1.0.0

3 changed files with 15 additions and 26 deletions

View file

@ -14,7 +14,7 @@ _zlugify_ is a library to generate slugs from all types of UTF-8 encoded strings
## Versions
zlugify 1.0.1 is made and tested with zig 0.13.0.
ZRM 1.0.0 is made and tested with zig 0.13.0.
## How to use
@ -23,7 +23,7 @@ zlugify 1.0.1 is made and tested with zig 0.13.0.
In your project directory:
```shell
$ zig fetch --save https://code.zeptotech.net/zedd/zlugify/archive/v1.0.1.tar.gz
$ zig fetch --save https://code.zeptotech.net/zedd/zlugify/archive/v1.0.0.tar.gz
```
In `build.zig`:

View file

@ -1,6 +1,6 @@
.{
.name = "zlugify",
.version = "1.0.1",
.version = "1.0.0",
.dependencies = .{
.@"anyascii.zig" = .{

View file

@ -1,26 +1,22 @@
const std = @import("std");
const anyascii = @import("anyascii");
/// The values to strip when trimming the string.
const valuesToStrip = " \t\r\n\'\"/\\";
/// Convert the provided string to a slugged version of it.
/// With this function, you can set the separator to use.
pub fn slugifySeparator(allocator: std.mem.Allocator, str: []const u8, separator: u8) ![]u8 {
// Convert the provided UTF-8 string to ASCII.
const fullResult = try anyascii.utf8ToAscii(allocator, str);
const startShift = fullResult.len - std.mem.trimLeft(u8, fullResult, valuesToStrip).len;
const endShift = fullResult.len - std.mem.trimRight(u8, fullResult, valuesToStrip).len;
const result = fullResult[startShift..fullResult.len - endShift];
// Trim the provided string.
const trimmed = std.mem.trim(u8, str, " \xA0\t\r\n\'\"/\\");
// Convert UTF-8 string to ASCII.
const result = try anyascii.utf8ToAscii(allocator, trimmed);
// Check each char to remove them / replace them by their slugged version if needed.
var previousIsSeparator = true; // Setting it to true at start forbids the result to start with a separator.
var shift: usize = 0;
for (0..result.len, result) |i, char| {
if (char == ' ' or char == '\t' or char == '\r' or char == '\n' or char == '\'' or char == '"' or char == '/' or char == '\\') {
if (char == ' ' or char == '\xA0' or char == '\t' or char == '\r' or char == '\n' or char == '\'' or char == '"' or char == '/' or char == '\\') {
// Whitespace-like character: replace it by a dash, or remove it if the previous character is a dash.
if (!previousIsSeparator) {
fullResult[i - shift] = separator;
result[i - shift] = separator;
previousIsSeparator = true;
} else {
// To remove the current character, we just shift all future written characters.
@ -30,7 +26,7 @@ pub fn slugifySeparator(allocator: std.mem.Allocator, str: []const u8, separator
// In the general case, we keep alphanumeric characters and all the rest is shifted.
if (std.ascii.isAlphanumeric(char)) {
// Convert the ASCII character to its lowercased version.
fullResult[i - shift] = std.ascii.toLower(char);
result[i - shift] = std.ascii.toLower(char);
previousIsSeparator = false;
} else {
shift += 1;
@ -39,18 +35,12 @@ pub fn slugifySeparator(allocator: std.mem.Allocator, str: []const u8, separator
}
// If we removed characters, free the remaining unused memory.
if (shift > 0 or startShift > 0 or endShift > 0) {
if (!allocator.resize(fullResult, result.len - shift)) {
// In case of a failed resize, reallocate.
defer allocator.free(fullResult);
const resultAlloc = try allocator.alloc(u8, result.len - shift);
@memcpy(resultAlloc, fullResult[0..result.len - shift]);
return resultAlloc;
}
if (shift > 0) {
_ = allocator.resize(result, result.len - shift);
}
// Return the result without the shifted characters.
return fullResult[0..result.len - shift];
return result[0..result.len - shift];
}
/// Convert the provided string to a slugged version of it with the default '-' separator.
@ -62,7 +52,6 @@ test slugify {
try testSlugify("this-is-a-test", " This is a test.\t\n");
try testSlugify("something-else", "SôMÈThing \t ÉLSÈ");
try testSlugify("slugify-a-string", "𝒔𝒍𝒖𝒈𝒊𝒇𝒚 𝒂 𝒔𝒕𝒓𝒊𝒏𝒈");
try testSlugify("a", "à ");
try testSlugify("blosse-shenzhen", "Blöße 深圳");
try testSlugify("qiyu-xian", "埼玉 県");
@ -77,7 +66,7 @@ test slugify {
try testSlugify("toi-yeu-nhung-chu-ky-lan", "tôi yêu những chú kỳ lân");
}
/// Test slugify function.
fn testSlugify(expected: []const u8, toSlugify: []const u8) !void {
pub fn testSlugify(expected: []const u8, toSlugify: []const u8) !void {
const slug = try slugify(std.testing.allocator, toSlugify);
defer std.testing.allocator.free(slug);
@ -88,7 +77,7 @@ test slugifySeparator {
try testSlugifySeparator("something_else", "SôMÈThing \t ÉLSÈ", '_');
}
/// Test slugifySeparator function.
fn testSlugifySeparator(expected: []const u8, toSlugify: []const u8, separator: u8) !void {
pub fn testSlugifySeparator(expected: []const u8, toSlugify: []const u8, separator: u8) !void {
const slug = try slugifySeparator(std.testing.allocator, toSlugify, separator);
defer std.testing.allocator.free(slug);