Skip to content

Commit

Permalink
Merge pull request #93 from ckeditor/t/ckeditor5/6398
Browse files Browse the repository at this point in the history
Other: Mentions can now be matched by any character typed. Closes #6398.
  • Loading branch information
jodator authored Apr 16, 2020
2 parents fa76892 + dca2d0f commit 5a0ae52
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 5 deletions.
4 changes: 2 additions & 2 deletions packages/ckeditor5-mention/src/mentionui.js
Original file line number Diff line number Diff line change
Expand Up @@ -640,7 +640,7 @@ export function createRegExp( marker, minimumCharacters ) {
const numberOfCharacters = minimumCharacters == 0 ? '*' : `{${ minimumCharacters },}`;

const openAfterCharacters = env.features.isRegExpUnicodePropertySupported ? '\\p{Ps}\\p{Pi}"\'' : '\\(\\[{"\'';
const mentionCharacters = env.features.isRegExpUnicodePropertySupported ? '\\p{L}\\p{N}' : 'a-zA-ZÀ-ž0-9';
const mentionCharacters = '\\S';

// The pattern consists of 3 groups:
// - 0 (non-capturing): Opening sequence - start of the line, space or an opening punctuation character like "(" or "\"",
Expand All @@ -649,7 +649,7 @@ export function createRegExp( marker, minimumCharacters ) {
//
// The pattern matches up to the caret (end of string switch - $).
// (0: opening sequence )(1: marker )(2: typed mention )$
const pattern = `(?:^|[ ${ openAfterCharacters }])([${ marker }])([_${ mentionCharacters }]${ numberOfCharacters })$`;
const pattern = `(?:^|[ ${ openAfterCharacters }])([${ marker }])([${ mentionCharacters }]${ numberOfCharacters })$`;

return new RegExp( pattern, 'u' );
}
Expand Down
6 changes: 6 additions & 0 deletions packages/ckeditor5-mention/tests/manual/mention.js
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,12 @@ ClassicEditor
'#a01', '#a02', '#a03', '#a04', '#a05', '#a06', '#a07', '#a08', '#a09', '#a10',
'#a11', '#a12', '#a13', '#a14', '#a15', '#a16', '#a17', '#a18', '#a19', '#a20'
]
},
{
marker: ':',
feed: [
':+1:', ':-1:', ':@(at-sign):', ':$(dollar-sign):', ':#(hash-sign):'
]
}
]
}
Expand Down
8 changes: 8 additions & 0 deletions packages/ckeditor5-mention/tests/manual/mention.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ The feeds:
- ...
- a20

3. Static list of "special characters" items (`:` marker)

- :+1:
- :-1:
- :@(at-sign):
- :$(dollar-sign):
- :#(hash-sign):

### Interaction

You can interact with mention panel with keyboard:
Expand Down
47 changes: 44 additions & 3 deletions packages/ckeditor5-mention/tests/mentionui.js
Original file line number Diff line number Diff line change
Expand Up @@ -518,14 +518,14 @@ describe( 'MentionUI', () => {
env.features.isRegExpUnicodePropertySupported = false;
createRegExp( '@', 2 );
sinon.assert.calledOnce( regExpStub );
sinon.assert.calledWithExactly( regExpStub, '(?:^|[ \\(\\[{"\'])([@])([_a-zA-ZÀ-ž0-9]{2,})$', 'u' );
sinon.assert.calledWithExactly( regExpStub, '(?:^|[ \\(\\[{"\'])([@])([\\S]{2,})$', 'u' );
} );

it( 'returns a ES2018 RegExp for browsers supporting Unicode punctuation groups', () => {
env.features.isRegExpUnicodePropertySupported = true;
createRegExp( '@', 2 );
sinon.assert.calledOnce( regExpStub );
sinon.assert.calledWithExactly( regExpStub, '(?:^|[ \\p{Ps}\\p{Pi}"\'])([@])([_\\p{L}\\p{N}]{2,})$', 'u' );
sinon.assert.calledWithExactly( regExpStub, '(?:^|[ \\p{Ps}\\p{Pi}"\'])([@])([\\S]{2,})$', 'u' );
} );
} );

Expand Down Expand Up @@ -1916,7 +1916,11 @@ describe( 'MentionUI', () => {
},
{
marker: '$',
feed: [ '$a1', '$a2', '$a3', '$a4', '$a5' ]
feed: [
'$a1', '$a2', '$a3', '$a4',
// A case of mention with a marker character from other feed. See #6398.
'$a@'
]
}
]
} );
Expand Down Expand Up @@ -1971,6 +1975,43 @@ describe( 'MentionUI', () => {
expect( mentionsView.items ).to.have.length( 3 );
} );
} );

it( 'should show panel for matched marker if it contains the other configured marker', () => {
setData( model, '<paragraph>foo []</paragraph>' );

model.change( writer => {
writer.insertText( '@', doc.selection.getFirstPosition() );
} );

return waitForDebounce()
.then( () => {
expect( panelView.isVisible ).to.be.true;
expect( editor.model.markers.has( 'mention' ) ).to.be.true;
expect( mentionsView.items ).to.have.length( 3 );

mentionsView.items.get( 0 ).children.get( 0 ).fire( 'execute' );
} )
.then( waitForDebounce )
.then( () => {
expect( panelView.isVisible ).to.be.false;
expect( editor.model.markers.has( 'mention' ) ).to.be.false;

model.change( writer => {
writer.insertText( '$a', doc.selection.getFirstPosition() );
} );
} )
.then( waitForDebounce )
.then( () => {
model.change( writer => {
writer.insertText( '@', doc.selection.getFirstPosition() );
} );
} )
.then( waitForDebounce )
.then( () => {
expect( panelView.isVisible ).to.be.true;
expect( editor.model.markers.has( 'mention' ) ).to.be.true;
} );
} );
} );

function testExecuteKey( name, keyCode, feedItems ) {
Expand Down

0 comments on commit 5a0ae52

Please sign in to comment.