sceners

README

sceners

A Go library for handling the formatting of Defacto2 sceners.

Sceners are the people, groups or organisations that create the art, music, demos, intros, cracks, etc. that are found on the Defacto2 website. They are also the sites and boards that have hosted the files and communities.

The library is used by the Defacto2 website to format the sceners' names and groups.

There are two main functions:

• Clean - Cleans the named scener to correct syntax and casing.
• Humanize - Formats the URL path of a scener into a human readable string.

Usage

import "github.com/Defacto2/sceners"

func main() {
    // Clean the the string scener name.
    name := sceners.Clean("  the  knightmare  bbs ")
    fmt.Println(name) // Output: Knightmare BBS

    // Format the scener name into a human readable string.
    const url = "https://defacto2.net/organizations/knightmare-bbs"
    name = sceners.Humanize(path.Base(url)
    fmt.Println(name) // Output: Knightmare BBS
}

Documentation

Overview

Package sceners provides functions for cleaning and formatting the scene names and titles.

Index

• func Clean(s string) string
• func Humanize(path string) string
• func Link(path string) string

Functions

func Clean

func Clean(s string) string

Clean fixes the malformed string. This includes the removal of duplicate spaces and the stripping of incompatible characters. The removal of excess whitespace and if found "The " prefix from BBS and FTP named sites.

Example:

Clean("  Defacto2  demo  group.") = "Defacto2 Demo Group"
Clean("the x bbs") = "X BBS"
Clean("The X Ftp") = "X FTP"

func Humanize

func Humanize(path string) string

Humanize deobfuscates the URL path and returns the formatted, human-readable group name. The path is expected to be in the format of a URL path without the scheme or domain. If the URL path contains invalid characters then an empty string is returned.

Example:

Humanize("defacto2") = "Defacto2"
Humanize("razor-1911-demo") = "Razor 1911 Demo"
Humanize("razor-1911-demo-ampersand-skillion") = "Razor 1911 Demo & Skillion"
Humanize("north-american-pirate_phreak-association") = "North American Pirate-Phreak Association"
Humanize("razor-1911-demo*trsi") = "Razor 1911 Demo, TRSi"
Humanize("razor-1911-demo#trsi") = "" // invalid # character

func Link

func Link(path string) string

Humanize deobfuscates the URL path and applies sceners.Humanize. In addition, the humanized name is formatted to be used as a link description. If the URL path contains invalid characters then an empty string is returned.