<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[39150] trunk: TinyMCE: wptextpattern: Fix inline patterns.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/39150">39150</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/39150","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iseulde</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-06 23:37:09 +0000 (Sun, 06 Nov 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>TinyMCE: wptextpattern: Fix inline patterns.
* Allow spaces inside inline pattern text, unless the delimiter stands alone.
* Add more unit tests.
* Add more inline docs.
Part props azaozz.
Fixes <a href="https://core.trac.wordpress.org/ticket/37693">#37693</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjstinymcepluginswptextpatternpluginjs">trunk/src/wp-includes/js/tinymce/plugins/wptextpattern/plugin.js</a></li>
<li><a href="#trunktestsqunitwpincludesjstinymcepluginswptextpatternpluginjs">trunk/tests/qunit/wp-includes/js/tinymce/plugins/wptextpattern/plugin.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjstinymcepluginswptextpatternpluginjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/js/tinymce/plugins/wptextpattern/plugin.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/tinymce/plugins/wptextpattern/plugin.js 2016-11-06 19:08:01 UTC (rev 39149)
+++ trunk/src/wp-includes/js/tinymce/plugins/wptextpattern/plugin.js 2016-11-06 23:37:09 UTC (rev 39150)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3,12 +3,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This plugin can automatically format text patterns as you type. It includes two patterns:
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This plugin can automatically format text patterns as you type. It includes several groups of patterns.
+ *
+ * Start of line patterns:
+ * As-you-type:
</ins><span class="cx" style="display: block; padding: 0 10px"> * - Unordered list (`* ` and `- `).
</span><span class="cx" style="display: block; padding: 0 10px"> * - Ordered list (`1. ` and `1) `).
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * On enter:
+ * - h2 (## ).
+ * - h3 (### ).
+ * - h4 (#### ).
+ * - h5 (##### ).
+ * - h6 (###### ).
+ * - blockquote (> ).
+ * - hr (---).
+ *
+ * Inline patterns:
+ * - <code> (`) (backtick).
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * If the transformation in unwanted, the user can undo the change by pressing backspace,
</span><span class="cx" style="display: block; padding: 0 10px"> * using the undo shortcut, or the undo button in the toolbar.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * Setting for the patterns can be overridden by plugins by using the `tiny_mce_before_init` PHP filter.
+ * The setting name is `wptextpattern` and the value is an object containing override arrays for each
+ * patterns group. There are three groups: "space", "enter", and "inline". Example (PHP):
+ *
+ * add_filter( 'tiny_mce_before_init', 'my_mce_init_wptextpattern' );
+ * function my_mce_init_wptextpattern( $init ) {
+ * $init['wptextpattern'] = wp_json_encode( array(
+ * 'inline' => array(
+ * array( 'delimiter' => '**', 'format' => 'bold' ),
+ * array( 'delimiter' => '__', 'format' => 'italic' ),
+ * ),
+ * ) );
+ *
+ * return $init;
+ * }
+ *
+ * Note that setting this will override the default text patterns. You will need to include them
+ * in your settings array if you want to keep them working.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> ( function( tinymce, setTimeout ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( tinymce.Env.ie && tinymce.Env.ie < 9 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,20 +80,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> var inlinePatterns = settings.inline || [
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- { start: '`', end: '`', format: 'code' }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ { delimiter: '`', format: 'code' }
</ins><span class="cx" style="display: block; padding: 0 10px"> ];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> var canUndo;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var chars = [];
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- tinymce.each( inlinePatterns, function( pattern ) {
- tinymce.each( ( pattern.start + pattern.end ).split( '' ), function( c ) {
- if ( tinymce.inArray( chars, c ) === -1 ) {
- chars.push( c );
- }
- } );
- } );
-
</del><span class="cx" style="display: block; padding: 0 10px"> editor.on( 'selectionchange', function() {
</span><span class="cx" style="display: block; padding: 0 10px"> canUndo = null;
</span><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,28 +125,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // The ending character should exist in the patterns registered.
- if ( tinymce.inArray( chars, node.data.charAt( offset - 1 ) ) === -1 ) {
- return;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> var string = node.data.slice( 0, offset );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var lastChar = node.data.charAt( offset - 1 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> tinymce.each( inlinePatterns, function( p ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var regExp = new RegExp( escapeRegExp( p.start ) + '\\S+' + escapeRegExp( p.end ) + '$' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Character before selection should be delimiter.
+ if ( lastChar !== p.delimiter.slice( -1 ) ) {
+ return;
+ }
+
+ var escDelimiter = escapeRegExp( p.delimiter );
+ var delimiterFirstChar = p.delimiter.charAt( 0 );
+ var regExp = new RegExp( '(.*)' + escDelimiter + '.+' + escDelimiter + '$' );
</ins><span class="cx" style="display: block; padding: 0 10px"> var match = string.match( regExp );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! match ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Don't allow pattern characters in the text.
- if ( node.data.slice( match.index + p.start.length, offset - p.end.length ).indexOf( p.start.slice( 0, 1 ) ) !== -1 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ startOffset = match[1].length;
+ endOffset = offset - p.delimiter.length;
+
+ var before = string.charAt( startOffset - 1 );
+ var after = string.charAt( startOffset + p.delimiter.length );
+
+ // test*test* => format applied
+ // test *test* => applied
+ // test* test* => not applied
+ if ( startOffset && /\S/.test( before ) ) {
+ if ( /\s/.test( after ) || before === delimiterFirstChar ) {
+ return;
+ }
+ }
+
+ // Do not replace when only whitespace and delimiter characters.
+ if ( ( new RegExp( '^[\\s' + escapeRegExp( delimiterFirstChar ) + ']+$' ) ).test( string.slice( startOffset, endOffset ) ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- startOffset = match.index;
- endOffset = offset - p.end.length;
</del><span class="cx" style="display: block; padding: 0 10px"> pattern = p;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -142,8 +183,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> node = node.splitText( startOffset );
</span><span class="cx" style="display: block; padding: 0 10px"> zero = node.splitText( offset - startOffset );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- node.deleteData( 0, pattern.start.length );
- node.deleteData( node.data.length - pattern.end.length, pattern.end.length );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ node.deleteData( 0, pattern.delimiter.length );
+ node.deleteData( node.data.length - pattern.delimiter.length, pattern.delimiter.length );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> editor.formatter.apply( pattern.format, {}, node );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsqunitwpincludesjstinymcepluginswptextpatternpluginjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/wp-includes/js/tinymce/plugins/wptextpattern/plugin.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/wp-includes/js/tinymce/plugins/wptextpattern/plugin.js 2016-11-06 19:08:01 UTC (rev 39149)
+++ trunk/tests/qunit/wp-includes/js/tinymce/plugins/wptextpattern/plugin.js 2016-11-06 23:37:09 UTC (rev 39150)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -157,8 +157,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> plugins: 'wptextpattern',
</span><span class="cx" style="display: block; padding: 0 10px"> wptextpattern: {
</span><span class="cx" style="display: block; padding: 0 10px"> inline: [
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- { start: '`', end: '`', format: 'code' },
- { start: '``', end: '``', format: 'bold' }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ { delimiter: '`', format: 'code' },
+ { delimiter: '``', format: 'bold' },
+ { delimiter: '```', format: 'italic' }
</ins><span class="cx" style="display: block; padding: 0 10px"> ]
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> init_instance_callback: function() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -319,6 +320,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }, assert.async() );
</span><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ QUnit.test( 'Inline: allow spaces within text.', function( assert ) {
+ type( '`a a`', function() {
+ assert.equal( editor.getContent(), '<p><code>a a</code></p>' );
+ assert.equal( editor.selection.getRng().startOffset, 1 );
+ }, assert.async() );
+ } );
+
+ QUnit.test( 'Inline: disallow \\S-delimiter-\\s.', function( assert ) {
+ type( 'a` a`', function() {
+ assert.equal( editor.getContent(), '<p>a` a`</p>' );
+ assert.equal( editor.selection.getRng().startOffset, 5 );
+ }, assert.async() );
+ } );
+
+ QUnit.test( 'Inline: allow \\s-delimiter-\\s.', function( assert ) {
+ type( 'a ` a`', function() {
+ assert.equal( editor.getContent(), '<p>a <code> a</code></p>' );
+ assert.equal( editor.selection.getRng().startOffset, 1 );
+ }, assert.async() );
+ } );
+
+ QUnit.test( 'Inline: allow \\S-delimiter-\\S.', function( assert ) {
+ type( 'a`a`', function() {
+ assert.equal( editor.getContent(), '<p>a<code>a</code></p>' );
+ assert.equal( editor.selection.getRng().startOffset, 1 );
+ }, assert.async() );
+ } );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> QUnit.test( 'Inline: after typing.', function( assert ) {
</span><span class="cx" style="display: block; padding: 0 10px"> editor.setContent( '<p>test test test</p>' );
</span><span class="cx" style="display: block; padding: 0 10px"> editor.selection.setCursorLocation( editor.$( 'p' )[0].firstChild, 5 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -331,13 +360,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }, assert.async() );
</span><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- QUnit.test( 'Inline: no change.', function( assert ) {
- type( 'test `````', function() {
- assert.equal( editor.getContent(), '<p>test `````</p>' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ QUnit.test( 'Inline: no change without content.', function( assert ) {
+ type( 'test `` ``` ````', function() {
+ assert.equal( editor.getContent(), '<p>test `` ``` ````</p>' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }, assert.async() );
</span><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- QUnit.test( 'Convert with previously unconverted pattern', function( assert ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ QUnit.test( 'Inline: convert with previously unconverted pattern.', function( assert ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> editor.setContent( '<p>`test` test </p>' );
</span><span class="cx" style="display: block; padding: 0 10px"> editor.selection.setCursorLocation( editor.$( 'p' )[0].firstChild, 12 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -345,4 +374,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> assert.equal( editor.getContent(), '<p>`test` test <code>test</code></p>' );
</span><span class="cx" style="display: block; padding: 0 10px"> }, assert.async() );
</span><span class="cx" style="display: block; padding: 0 10px"> } );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ QUnit.test( 'Inline: convert with previous pattern characters.', function( assert ) {
+ editor.setContent( '<p>test``` 123</p>' );
+ editor.selection.setCursorLocation( editor.$( 'p' )[0].firstChild, 11 );
+
+ type( '``456``', function() {
+ assert.equal( editor.getContent(), '<p>test``` 123<strong>456</strong></p>' );
+ }, assert.async() );
+ } );
+
+ QUnit.test( 'Inline: disallow after previous pattern characters and leading space.', function( assert ) {
+ editor.setContent( '<p>test``` 123</p>' );
+ editor.selection.setCursorLocation( editor.$( 'p' )[0].firstChild, 11 );
+
+ type( '``` 456```', function() {
+ assert.equal( editor.getContent(), '<p>test``` 123``` 456```</p>' );
+ }, assert.async() );
+ } );
</ins><span class="cx" style="display: block; padding: 0 10px"> } )( window.jQuery, window.QUnit, window.tinymce, window.setTimeout );
</span></span></pre>
</div>
</div>
</body>
</html>