precis-js/test/suite/PrecisEnforcer.spec.coffee

A JavaScript implementation of RFC 7564 (The PRECIS Framework).

fs = require 'fs'
UnicodeTrie = require 'unicode-trie'
unorm = require 'unorm'
{ucs2} = require 'punycode'

CodepointPropertyReader = require '../../src/unicode/CodepointPropertyReader'
DirectionalityValidator = require '../../src/unicode/DirectionalityValidator'
InvalidCodepointError = require '../../src/error/InvalidCodepointError'
InvalidDirectionalityError = require '../../src/error/InvalidDirectionalityError'
Normalizer = require '../../src/unicode/Normalizer'
precis = require '../../src/constants'
PrecisEnforcer = require '../../src/PrecisEnforcer'
PrecisPreparer = require '../../src/PrecisPreparer'
WidthMapper = require '../../src/unicode/WidthMapper'

describe 'PrecisEnforcer', ->

    before ->
        trieData = fs.readFileSync __dirname + '/../../data/properties.trie'
        widthMappingData = JSON.parse fs.readFileSync __dirname + '/../../data/width-mapping.json'

        trie = new UnicodeTrie trieData
        @propertyReader = new CodepointPropertyReader trie
        @preparer = new PrecisPreparer @propertyReader
        @widthMapper = new WidthMapper widthMappingData
        @normalizer = new Normalizer unorm
        @directionalityValidator = new DirectionalityValidator @propertyReader

    beforeEach ->
        @subject = new PrecisEnforcer @preparer, @propertyReader, @widthMapper, @normalizer, @directionalityValidator

        @profile = stringClass: precis.STRING_CLASS.FREEFORM, normalization: precis.NORMALIZATION.NONE

    describe 'enforce()', ->

        it 'supports custom width mapping logic', ->
            passedCodepoints = null
            @profile.mapWidth = (codepoints) -> passedCodepoints = codepoints.slice()
            @subject.enforce @profile, 'ab'

            assert.deepEqual passedCodepoints, [97, 98]

        it 'supports custom case mapping logic', ->
            passedCodepoints = null
            @profile.mapCase = (codepoints) -> passedCodepoints = codepoints.slice()
            @subject.enforce @profile, 'ab'

            assert.deepEqual passedCodepoints, [97, 98]

        it 'supports custom normalization logic', ->
            passedCodepoints = null
            @profile.normalize = (codepoints) -> passedCodepoints = codepoints.slice()
            @subject.enforce @profile, 'ab'

            assert.deepEqual passedCodepoints, [97, 98]

        it 'supports custom directionality validation', ->
            passedCodepoints = null
            @profile.validateDirectionality = (codepoints) -> passedCodepoints = codepoints.slice()
            @subject.enforce @profile, 'ab'

            assert.deepEqual passedCodepoints, [97, 98]

        it 'throws an error if the string class is not implemented', ->
            assert.throws (=> @subject.enforce stringClass: 111, ''), 'PRECIS string class not implemented.'

        describe 'for FreeformClass string class profiles', ->

            beforeEach ->
                @profile = stringClass: precis.STRING_CLASS.FREEFORM, normalization: precis.NORMALIZATION.NONE

            it 'allows characters in the FreeformClass string class', ->
                assert.strictEqual @subject.enforce(@profile, ' !'), ' !'

            it 'rejects characters outside the FreeformClass string class', ->
                assert.throws (=> @subject.enforce @profile, '\u0000'), InvalidCodepointError
                assert.throws (=> @subject.enforce @profile, '\u007F'), InvalidCodepointError
                assert.throws (=> @subject.enforce @profile, '\u00B7'), InvalidCodepointError
                assert.throws (=> @subject.enforce @profile, '\u0378'), InvalidCodepointError
                assert.throws (=> @subject.enforce @profile, '\u200C'), InvalidCodepointError

        describe 'for profiles with callbacks', ->

            it 'calls the custom mapping callback', ->
                passedCodepoints = null
                passedEnforcer = null
                @profile =
                    stringClass: precis.STRING_CLASS.FREEFORM
                    normalization: precis.NORMALIZATION.NONE
                    map: (codepoints, enforcer) ->
                        passedCodepoints = codepoints.slice()
                        passedEnforcer = enforcer
                @subject.enforce @profile, 'ab'

                assert.deepEqual passedCodepoints, [97, 98]
                assert.strictEqual passedEnforcer, @subject

            it 'calls the custom validation callback', ->
                passedCodepoints = null
                passedEnforcer = null
                @profile =
                    stringClass: precis.STRING_CLASS.FREEFORM
                    normalization: precis.NORMALIZATION.NONE
                    validate: (codepoints, enforcer) ->
                        passedCodepoints = codepoints.slice()
                        passedEnforcer = enforcer
                @subject.enforce @profile, 'ab'

                assert.deepEqual passedCodepoints, [97, 98]
                assert.strictEqual passedEnforcer, @subject

        describe 'profile width mapping options', ->

            it 'supports width mapping', ->
                @profile =
                    stringClass: precis.STRING_CLASS.FREEFORM
                    normalization: precis.NORMALIZATION.NONE
                    widthMapping: precis.WIDTH_MAPPING.EAW

                assert.strictEqual @subject.enforce(@profile, '\uFF61'), '\u3002'

        describe 'profile case mapping options', ->

            beforeEach ->
                @profile = stringClass: precis.STRING_CLASS.FREEFORM, normalization: precis.NORMALIZATION.NONE

            it 'supports lowercase case mapping', ->
                @profile.caseMapping = precis.CASE_MAPPING.LOWERCASE

                assert.strictEqual @subject.enforce(@profile, 'Ab\u0370\u0371'), 'ab\u0371\u0371'

        describe 'profile normalization options', ->

            beforeEach ->
                @profile = stringClass: precis.STRING_CLASS.FREEFORM, normalization: precis.NORMALIZATION.NONE

            it 'supports NFC normalization', ->
                @profile.normalization = precis.NORMALIZATION.C
                actual = @subject.enforce @profile, '\u00F6\u0307o\u0308\u0307o\u0307\u0308\u2163'
                expected = '\u00F6\u0307\u00F6\u0307\u022F\u0308\u2163'

                assert.deepEqual ucs2.decode(actual), ucs2.decode(expected)

            it 'supports NFD normalization', ->
                @profile.normalization = precis.NORMALIZATION.D
                actual = @subject.enforce @profile, '\u00F6\u0307o\u0308\u0307o\u0307\u0308\u2163'
                expected = 'o\u0308\u0307o\u0308\u0307o\u0307\u0308\u2163'

                assert.deepEqual ucs2.decode(actual), ucs2.decode(expected)

            it 'supports NFKC normalization', ->
                @profile.normalization = precis.NORMALIZATION.KC
                actual = @subject.enforce @profile, '\u00F6\u0307o\u0308\u0307o\u0307\u0308\u2163'
                expected = '\u00F6\u0307\u00F6\u0307\u022F\u0308IV'

                assert.deepEqual ucs2.decode(actual), ucs2.decode(expected)

            it 'supports NFKD normalization', ->
                @profile.normalization = precis.NORMALIZATION.KD
                actual = @subject.enforce @profile, '\u00F6\u0307o\u0308\u0307o\u0307\u0308\u2163'
                expected = 'o\u0308\u0307o\u0308\u0307o\u0307\u0308IV'

                assert.deepEqual ucs2.decode(actual), ucs2.decode(expected)

        describe 'profile directionality options', ->

            it 'supports directionality validation', ->
                @profile =
                    stringClass: precis.STRING_CLASS.FREEFORM
                    normalization: precis.NORMALIZATION.NONE
                    directionality: precis.DIRECTIONALITY.BIDI

                assert.doesNotThrow => @subject.enforce @profile, 'ab'
                assert.throws (=> @subject.enforce @profile, '0'), InvalidDirectionalityError