striptags-test.js

'use strict';
/* global describe, it */

let assert    = require('assert');
let fs        = require('fs');
let vm        = require('vm');
let striptags = require('../');


describe('striptags', function() {
    describe('#module', function() {
        let path   = require.resolve('../');
        let src    = fs.readFileSync(path);
        let script = new vm.Script(src);

        it('should define a Node module', function() {
            let module = { exports: {} };

            script.runInNewContext({module});

            assert.equal(module.exports.toString(), striptags.toString());
        });

        it('should define an AMD module', function() {
            let module = null;
            let define = function(module_factory) {
                module = module_factory();
            };

            define.amd = true;

            script.runInNewContext({define});

            assert.equal(module.toString(), striptags.toString());
        });

        it('should define a browser global', function() {
            let global = {};

            script.runInNewContext(global);

            assert.notEqual(global.striptags, null);
        });
    });

    describe('with no optional parameters', function() {
        it('should not strip invalid tags', function() {
            let text = 'lorem ipsum < a> < div>';

            assert.equal(striptags(text), text);
        });

        it('should remove simple HTML tags', function() {
            let html = '<a href="">lorem <strong>ipsum</strong></a>',
                text = 'lorem ipsum';

            assert.equal(striptags(html), text);
        });

        it('should remove comments', function() {
            let html = '<!-- lorem -- ipsum -- --> dolor sit amet',
                text = ' dolor sit amet';

            assert.equal(striptags(html), text);
        });

        it('should strip tags within comments', function() {
            let html = '<!-- <strong>lorem ipsum</strong> --> dolor sit',
                text = ' dolor sit';

            assert.equal(striptags(html), text);
        });


        it('should not fail with nested quotes', function() {
            let html = '<article attr="foo \'bar\'">lorem</article> ipsum',
                text = 'lorem ipsum';

            assert.equal(striptags(html), text);
        });
    });

    describe('#allowed_tags', function() {
        it('should parse a string', function() {
            let html = '<strong>lorem ipsum</strong>',
                allowed_tags = '<strong>';

            assert.equal(striptags(html, allowed_tags), html);
        });

        it('should take an array', function() {
            let html = '<strong>lorem <em>ipsum</em></strong>',
                allowed_tags = ['strong', 'em'];

            assert.equal(striptags(html, allowed_tags), html);
        });
    });

    describe('with allowable_tags parameter', function() {
        it('should leave attributes when allowing HTML', function() {
            let html = '<a href="https://example.com">lorem ipsum</a>',
                allowed_tags = '<a>';

            assert.equal(striptags(html, allowed_tags), html);
        });

        it('should strip extra < within tags', function() {
            let html = '<div<>>lorem ipsum</div>',
                text = '<div>lorem ipsum</div>',
                allowed_tags = '<div>';

            assert.equal(striptags(html, allowed_tags), text);
        });

        it('should strip <> within quotes', function() {
            let html = '<a href="<script>">lorem ipsum</a>',
                text = '<a href="script">lorem ipsum</a>',
                allowed_tags = '<a>';

            assert.equal(striptags(html, allowed_tags), text);
        });

        it('should remove blacklisted tags', function() {
            let html = '<p>a <i>text</i> with <a href="#">link</a></p>',
                text = 'a <i>text</i> with <a href="#">link</a>',
                tags = ['!p'];

            assert.equal(striptags(html, tags), text);
        });

    });

    describe('with tag_replacement parameter', function() {
        it('should replace tags with that parameter', function() {
            var html = 'Line One<br>Line Two',
                allowed_tags = [],
                tag_replacement = '\n',
                text = 'Line One\nLine Two';

            assert.equal(striptags(html, allowed_tags, tag_replacement), text);
        });
    });

    describe('#streaming_mode', function() {
        it('should strip streamed HTML', function() {
            let striptags_stream = striptags.init_streaming_mode();

            let part_one   = striptags_stream('lorem ipsum <stro');
            let part_two   = striptags_stream('ng>dolor sit <');
            let part_three = striptags_stream(' amet');

            assert.equal(part_one, 'lorem ipsum ');
            assert.equal(part_two, 'dolor sit ');
            assert.equal(part_three, '< amet');
        });

        it('should work with allowable_tags', function() {
            let striptags_stream = striptags.init_streaming_mode(['strong']);

            let part_one   = striptags_stream('lorem ipsum <stro');
            let part_two   = striptags_stream('ng>dolor sit <');
            let part_three = striptags_stream(' amet');

            assert.equal(part_one, 'lorem ipsum ');
            assert.equal(part_two, '<strong>dolor sit ');
            assert.equal(part_three, '< amet');
        });
    });
});