slug/test/slug.test.js

/*
 * decaffeinate suggestions:
 * DS101: Remove unnecessary use of Array.from
 * DS102: Remove unnecessary code created because of implicit returns
 * DS205: Consider reworking code to avoid use of IIFEs
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
const slug = require('../slug');

describe('slug', function() {
    it('should convert input to string', function() {
        [slug(1)].should.eql(['1']);
        return [slug(567890)].should.eql(['567890']);
    });

    it('should replace whitespaces with replacement', function() {
        [slug('foo bar baz')].should.eql(['foo-bar-baz']);
        [slug('foo bar baz', '_')].should.eql(['foo_bar_baz']);
        return [slug('foo bar baz', '')].should.eql(['foobarbaz']);
    });

    it('should remove trailing space if any', () => [slug(' foo bar baz ')].should.eql(['foo-bar-baz']));

    it('should remove not allowed chars', function() {
        [slug('foo, bar baz')].should.eql(['foo-bar-baz']);
        [slug('foo- bar baz')].should.eql(['foo-bar-baz']);
        return [slug('foo] bar baz')].should.eql(['foo-bar-baz']);
    });

    it('should leave allowed chars in rfc3986 mode', function() {
        const allowed = ['.', '_', '~'];
        return Array.from(allowed).map((a) =>
            [slug(`foo ${a} bar baz`,
                {mode: "rfc3986"})].should.eql([`foo-${a}-bar-baz`]));
    });

    it('should leave allowed chars in pretty mode', function() {
        const allowed = ['_', '~'];
        return Array.from(allowed).map((a) =>
            [slug(`foo ${a} bar baz`)].should.eql([`foo-${a}-bar-baz`]));
    });

    it('should replace latin chars', function() {
        const char_map = {
            'À': 'A', 'Á': 'A', 'Â': 'A', 'Ã': 'A', 'Ä': 'A', 'Å': 'A', 'Æ': 'AE',
            'Ç': 'C', 'È': 'E', 'É': 'E', 'Ê': 'E', 'Ë': 'E', 'Ì': 'I', 'Í': 'I',
            'Î': 'I', 'Ï': 'I', 'Ð': 'D', 'Ñ': 'N', 'Ò': 'O', 'Ó': 'O', 'Ô': 'O',
            'Õ': 'O', 'Ö': 'O', 'Ő': 'O', 'Ø': 'O', 'Ù': 'U', 'Ú': 'U', 'Û': 'U',
            'Ü': 'U', 'Ű': 'U', 'Ý': 'Y', 'Þ': 'TH', 'ß': 'ss', 'à':'a', 'á':'a',
            'â': 'a', 'ã': 'a', 'ä': 'a', 'å': 'a', 'æ': 'ae', 'ç': 'c', 'è': 'e',
            'é': 'e', 'ê': 'e', 'ë': 'e', 'ì': 'i', 'í': 'i', 'î': 'i', 'ï': 'i',
            'ð': 'd', 'ñ': 'n', 'ò': 'o', 'ó': 'o', 'ô': 'o', 'õ': 'o', 'ö': 'o',
            'ő': 'o', 'ø': 'o', 'ù': 'u', 'ú': 'u', 'û': 'u', 'ü': 'u', 'ű': 'u',
            'ý': 'y', 'þ': 'th', 'ÿ': 'y', 'ẞ': 'SS'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                const replacement = char_map[char];
                result.push([slug(`foo ${char} bar baz`)].should.eql([`foo-${replacement}-bar-baz`]));
            }
            return result;
        })();
    });

    it('should replace greek chars', function() {
        const char_map = {
            'α':'a', 'β':'b', 'γ':'g', 'δ':'d', 'ε':'e', 'ζ':'z', 'η':'h', 'θ':'8',
            'ι':'i', 'κ':'k', 'λ':'l', 'μ':'m', 'ν':'n', 'ξ':'3', 'ο':'o', 'π':'p',
            'ρ':'r', 'σ':'s', 'τ':'t', 'υ':'y', 'φ':'f', 'χ':'x', 'ψ':'ps', 'ω':'w',
            'ά':'a', 'έ':'e', 'ί':'i', 'ό':'o', 'ύ':'y', 'ή':'h', 'ώ':'w', 'ς':'s',
            'ϊ':'i', 'ΰ':'y', 'ϋ':'y', 'ΐ':'i',
            'Α':'A', 'Β':'B', 'Γ':'G', 'Δ':'D', 'Ε':'E', 'Ζ':'Z', 'Η':'H', 'Θ':'8',
            'Ι':'I', 'Κ':'K', 'Λ':'L', 'Μ':'M', 'Ν':'N', 'Ξ':'3', 'Ο':'O', 'Π':'P',
            'Ρ':'R', 'Σ':'S', 'Τ':'T', 'Υ':'Y', 'Φ':'F', 'Χ':'X', 'Ψ':'PS', 'Ω':'W',
            'Ά':'A', 'Έ':'E', 'Ί':'I', 'Ό':'O', 'Ύ':'Y', 'Ή':'H', 'Ώ':'W', 'Ϊ':'I',
            'Ϋ':'Y'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                const replacement = char_map[char];
                result.push([slug(`foo ${char} bar baz`)].should.eql([`foo-${replacement}-bar-baz`]));
            }
            return result;
        })();
    });

    it('should replace turkish chars', function() {
        const char_map = {
            'ş':'s', 'Ş':'S', 'ı':'i', 'İ':'I', 'ç':'c', 'Ç':'C', 'ü':'u', 'Ü':'U',
            'ö':'o', 'Ö':'O', 'ğ':'g', 'Ğ':'G'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                const replacement = char_map[char];
                result.push([slug(`foo ${char} bar baz`)].should.eql([`foo-${replacement}-bar-baz`]));
            }
            return result;
        })();
    });

    it('should replace cyrillic chars', function() {
        const char_map = {
            'а':'a', 'б':'b', 'в':'v', 'г':'g', 'д':'d', 'е':'e', 'ё':'yo', 'ж':'zh',
            'з':'z', 'и':'i', 'й':'j', 'к':'k', 'л':'l', 'м':'m', 'н':'n', 'о':'o',
            'п':'p', 'р':'r', 'с':'s', 'т':'t', 'у':'u', 'ф':'f', 'х':'h', 'ц':'c',
            'ч':'ch', 'ш':'sh', 'щ':'sh', 'ъ':'u', 'ы':'y', 'ь':'', 'э':'e', 'ю':'yu',
            'я':'ya',
            'А':'A', 'Б':'B', 'В':'V', 'Г':'G', 'Д':'D', 'Е':'E', 'Ё':'Yo', 'Ж':'Zh',
            'З':'Z', 'И':'I', 'Й':'J', 'К':'K', 'Л':'L', 'М':'M', 'Н':'N', 'О':'O',
            'П':'P', 'Р':'R', 'С':'S', 'Т':'T', 'У':'U', 'Ф':'F', 'Х':'H', 'Ц':'C',
            'Ч':'Ch', 'Ш':'Sh', 'Щ':'Sh', 'Ъ':'U', 'Ы':'Y', 'Ь':'', 'Э':'E', 'Ю':'Yu',
            'Я':'Ya', 'Є':'Ye', 'І':'I', 'Ї':'Yi', 'Ґ':'G', 'є':'ye', 'і':'i', 'ї':'yi', 'ґ':'g'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                const replacement = char_map[char];
                let expected = `foo-${replacement}-bar-baz`;
                if (!replacement) { expected = "foo-bar-baz"; }
                result.push([slug(`foo ${char} bar baz`)].should.eql([expected]));
            }
            return result;
        })();
    });

    it('should replace czech chars', function() {
        const char_map = {
            'č':'c', 'ď':'d', 'ě':'e', 'ň': 'n', 'ř':'r', 'š':'s', 'ť':'t', 'ů':'u',
            'ž':'z', 'Č':'C', 'Ď':'D', 'Ě':'E', 'Ň': 'N', 'Ř':'R', 'Š':'S', 'Ť':'T',
            'Ů':'U', 'Ž':'Z'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                const replacement = char_map[char];
                result.push([slug(`foo ${char} bar baz`)].should.eql([`foo-${replacement}-bar-baz`]));
            }
            return result;
        })();
    });

    it('should replace polish chars', function() {
        const char_map = {
            'ą':'a', 'ć':'c', 'ę':'e', 'ł':'l', 'ń':'n', 'ó':'o', 'ś':'s', 'ź':'z',
            'ż':'z', 'Ą':'A', 'Ć':'C', 'Ę':'E', 'Ł':'L', 'Ń':'N', 'Ś':'S',
            'Ź':'Z', 'Ż':'Z'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                const replacement = char_map[char];
                result.push([slug(`foo ${char} bar baz`)].should.eql([`foo-${replacement}-bar-baz`]));
            }
            return result;
        })();
    });

    it('should replace latvian chars', function() {
        const char_map = {
            'ā':'a', 'č':'c', 'ē':'e', 'ģ':'g', 'ī':'i', 'ķ':'k', 'ļ':'l', 'ņ':'n',
            'š':'s', 'ū':'u', 'ž':'z', 'Ā':'A', 'Č':'C', 'Ē':'E', 'Ģ':'G', 'Ī':'I',
            'Ķ':'K', 'Ļ':'L', 'Ņ':'N', 'Š':'S', 'Ū':'U', 'Ž':'Z'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                const replacement = char_map[char];
                result.push([slug(`foo ${char} bar baz`)].should.eql([`foo-${replacement}-bar-baz`]));
            }
            return result;
        })();
    });

    it('should replace vietnamese chars', function() {
        const char_map = {
            'Ạ': 'A', 'Ả': 'A', 'Ầ': 'A', 'Ấ': 'A', 'Ậ': 'A', 'Ẩ': 'A', 'Ẫ': 'A',
            'Ằ': 'A', 'Ắ': 'A', 'Ặ': 'A', 'Ẳ': 'A', 'Ẵ': 'A', 'Ẹ': 'E', 'Ẻ': 'E',
            'Ẽ': 'E', 'Ề': 'E', 'Ế': 'E', 'Ệ': 'E', 'Ể': 'E', 'Ễ': 'E', 'Ị': 'I',
            'Ỉ': 'I', 'Ĩ': 'I', 'Ọ': 'O', 'Ỏ': 'O', 'Ồ': 'O', 'Ố': 'O', 'Ộ': 'O',
            'Ổ': 'O', 'Ỗ': 'O', 'Ơ': 'O', 'Ờ': 'O', 'Ớ': 'O', 'Ợ': 'O', 'Ở': 'O',
            'Ỡ': 'O', 'Ụ': 'U', 'Ủ': 'U', 'Ũ': 'U', 'Ư': 'U', 'Ừ': 'U', 'Ứ': 'U',
            'Ự': 'U', 'Ử': 'U', 'Ữ': 'U', 'Ỳ': 'Y', 'Ỵ': 'Y', 'Ỷ': 'Y', 'Ỹ': 'Y',
            'Đ': 'D', 'ạ': 'a', 'ả': 'a', 'ầ': 'a', 'ấ': 'a', 'ậ': 'a', 'ẩ': 'a',
            'ẫ': 'a', 'ằ': 'a', 'ắ': 'a', 'ặ': 'a', 'ẳ': 'a', 'ẵ': 'a', 'ẹ': 'e',
            'ẻ': 'e', 'ẽ': 'e', 'ề': 'e', 'ế': 'e', 'ệ': 'e', 'ể': 'e', 'ễ': 'e',
            'ị': 'i', 'ỉ': 'i', 'ĩ': 'i', 'ọ': 'o', 'ỏ': 'o', 'ồ': 'o', 'ố': 'o',
            'ộ': 'o', 'ổ': 'o', 'ỗ': 'o', 'ơ': 'o', 'ờ': 'o', 'ớ': 'o', 'ợ': 'o',
            'ở': 'o', 'ỡ': 'o', 'ụ': 'u', 'ủ': 'u', 'ũ': 'u', 'ư': 'u', 'ừ': 'u',
            'ứ': 'u', 'ự': 'u', 'ử': 'u', 'ữ': 'u', 'ỳ': 'y', 'ỵ': 'y', 'ỷ': 'y',
            'ỹ': 'y', 'đ': 'd'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                const replacement = char_map[char];
                result.push([slug(`foo ${char} bar baz`)].should.eql([`foo-${replacement}-bar-baz`]));
            }
            return result;
        })();
    });

    it('should replace currencies', function() {
        const char_map = {
            '€': 'euro', '₢': 'cruzeiro', '₣': 'french franc', '£': 'pound',
            '₤': 'lira', '₥': 'mill', '₦': 'naira', '₧': 'peseta', '₨': 'rupee', '₹': 'indian rupee',
            '₩': 'won', '₪': 'new shequel', '₫': 'dong', '₭': 'kip', '₮': 'tugrik',
            '₯': 'drachma', '₰': 'penny', '₱': 'peso', '₲': 'guarani', '₳': 'austral',
            '₴': 'hryvnia', '₵': 'cedi', '¢': 'cent', '¥': 'yen', '元': 'yuan',
            '円': 'yen', '﷼': 'rial', '₠': 'ecu', '¤': 'currency', '฿': 'baht',
            "$": 'dollar'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                let replacement = char_map[char];
                replacement = replacement.replace(' ', '-');
                result.push([slug(`foo ${char} bar baz`)].should.eql([`foo-${replacement}-bar-baz`]));
            }
            return result;
        })();
    });

    it('should replace symbols in rfc3986 mode', function() {
        const char_map = {
            '©':'c', 'œ': 'oe', 'Œ': 'OE', '∑': 'sum', '®': 'r',
            '∂': 'd', 'ƒ': 'f', '™': 'tm',
            '℠': 'sm', '…': '...', '˚': 'o', 'º': 'o', 'ª': 'a',
            '∆': 'delta', '∞': 'infinity', '♥': 'love', '&': 'and', '|': 'or',
            '<': 'less', '>': 'greater'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                const replacement = char_map[char];
                result.push([slug(`foo ${char} bar baz`,
                    {mode: "rfc3986"})].should.eql([
                        `foo-${replacement}-bar-baz`.toLowerCase()]));
            }
            return result;
        })();
    });

    it('should replace symbols in pretty mode', function() {
        const char_map = {
            '©':'c', 'œ': 'oe', 'Œ': 'OE', '∑': 'sum', '®': 'r',
            '∂': 'd', 'ƒ': 'f', '™': 'tm',
            '℠': 'sm', '˚': 'o', 'º': 'o', 'ª': 'a',
            '∆': 'delta', '∞': 'infinity', '♥': 'love', '&': 'and', '|': 'or',
            '<': 'less', '>': 'greater'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                const replacement = char_map[char];
                result.push([slug(`foo ${char} bar baz`)].should.eql([`foo-${replacement}-bar-baz`]));
            }
            return result;
        })();
    });

    it('should remove ellipsis in pretty mode', function() {
        const char_map = {
            '…': '...'
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                result.push([slug(`foo ${char} bar baz`)].should.eql(["foo-bar-baz"]));
            }
            return result;
        })();
    });

    it('should strip … symbols in pretty mode', () => [slug("foo … bar baz")].should.eql(["foo-bar-baz"]));

    it('should strip symbols', function() {
        const char_map = [
            '†', '“', '”', '‘', '’', '•'
        ];
        return Array.from(char_map).map((char) =>
            [slug(`foo ${char} bar baz`)].should.eql(["foo-bar-baz"]));
    });

    it('should replace unicode', function() {
        const char_map = {
            '☢':"radioactive",'☠':"skull-and-bones",'☤':"caduceus",
            '☣':"biohazard",'☭':"hammer-and-sickle", '☯':"yin-yang",'☮':"peace",
            '☏':"telephone",'☔':"umbrella-with-rain-drops",'☎':"telephone",
            '☀':"sun-with-rays",'★':"star",'☂':"umbrella",'☃':"snowman",
            '✈':"airplane",'✉':"envelope",'✊':"raised-fist"
        };
        return (() => {
            const result = [];
            for (let char in char_map) {
                const replacement = char_map[char];
                result.push([slug(`foo ${char} bar baz`)].should.eql([`foo-${replacement}-bar-baz`]));
            }
            return result;
        })();
    });

    it('should replace no unicode when disabled', function() {
        const char_map = '😹☢☠☤☣☭☯☮☏☔☎☀★☂☃✈✉✊'.split('');
        return Array.from(char_map).map((char) =>
            [slug(`foo ${char} bar baz`, {symbols:false})].should.eql(["foo-bar-baz"]));
    });

    it('should allow altering the charmap', function() {
        const charmap = {
            'f': 'ph', 'o':'0', 'b':'8', 'a':'4', 'r':'2', 'z':'5'
        };
        return [slug("foo bar baz", {charmap}).toUpperCase()].should.eql(['PH00-842-845']);
    });

    it('should replace lithuanian characters', () => slug('ąčęėįšųūžĄČĘĖĮŠŲŪŽ').should.eql('aceeisuuzACEEISUUZ'));

    it('should replace multichars', () => [slug("w/ <3 && sugar || ☠")].should.eql(['with-love-and-sugar-or-skull-and-bones']));

    it('should be flavourable', function() {
        const text = "It's your journey ... we guide you through.";
        const expected = "Its-your-journey-we-guide-you-through";
        return [slug(text, {mode:'pretty'})].should.eql([expected]);
    });

    it('should default to lowercase in rfc3986 mode', function() {
      const text = "It's Your Journey We Guide You Through.";
      const expected = "its-your-journey-we-guide-you-through.";
      return [slug(text, {mode:'rfc3986'})].should.eql([expected]);
    });

    it('should allow disabling of lowercase', function() {
      const text = "It's Your Journey We Guide You Through.";
      const expected = "Its-Your-Journey-We-Guide-You-Through.";
      return [slug(text, {mode:'rfc3986', lower:false})].should.eql([expected]);
    });

    it('should replace arabic characters', () => slug('مرحبا بك').should.eql('mrhba-bk'));

    it('should replace zh characters', () => slug('鳄梨').should.eql('6bOE5qKo'));
});