<!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>[GlotPress][1131] trunk: Warnings: Make warnings for newline mismatches more verbose.</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://glotpress.trac.wordpress.org/changeset/1131">1131</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://glotpress.trac.wordpress.org/changeset/1131","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-24 11:36:22 +0000 (Thu, 24 Sep 2015)</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'>Warnings: Make warnings for newline mismatches more verbose.
Previously a user had to check himself if a translation needs to begin/end on a newline or not because the warning wasn't specific enough. To help translators split `warning_both_begin_end_on_newlines()` into four warnings.
Props SergeyBiryukov.
Fixes <a href="http://glotpress.trac.wordpress.org/ticket/495">#495</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgpincludeswarningsphp">trunk/gp-includes/warnings.php</a></li>
<li><a href="#trunktteststest_builtin_warningsphp">trunk/t/tests/test_builtin_warnings.php</a></li>
<li><a href="#trunktteststests_routestest_route_translationphp">trunk/t/tests/tests_routes/test_route_translation.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkgpincludeswarningsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/gp-includes/warnings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/gp-includes/warnings.php 2015-09-20 14:53:31 UTC (rev 1130)
+++ trunk/gp-includes/warnings.php 2015-09-24 11:36:22 UTC (rev 1131)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -133,16 +133,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $counts;
</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">- function warning_both_begin_end_on_newlines( $original, $translation, $locale ) {
- if ( gp_endswith( $original, "\n" ) xor gp_endswith( $translation, "\n" ) ) {
- return __('Original and translation should both end on newline.');
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function warning_should_begin_on_newline( $original, $translation, $locale ) {
+ if ( gp_startswith( $original, "\n" ) && ! gp_startswith( $translation, "\n" ) ) {
+ return __( 'Original and translation should both begin on newline.' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( gp_startswith( $original, "\n" ) xor gp_startswith( $translation, "\n" ) ) {
- return __('Original and translation should both begin on newline.');
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return true;
+ }
+
+ function warning_should_not_begin_on_newline( $original, $translation, $locale ) {
+ if ( ! gp_startswith( $original, "\n" ) && gp_startswith( $translation, "\n" ) ) {
+ return __( 'Translation should not begin on newline.' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</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">+ function warning_should_end_on_newline( $original, $translation, $locale ) {
+ if ( gp_endswith( $original, "\n" ) && ! gp_endswith( $translation, "\n" ) ) {
+ return __( 'Original and translation should both end on newline.' );
+ }
+ return true;
+ }
+
+ function warning_should_not_end_on_newline( $original, $translation, $locale ) {
+ if ( ! gp_endswith( $original, "\n" ) && gp_endswith( $translation, "\n" ) ) {
+ return __( 'Translation should not end on newline.' );
+ }
+ return true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Adds all methods starting with warning_ to $translation_warnings
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunktteststest_builtin_warningsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/t/tests/test_builtin_warnings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/t/tests/test_builtin_warnings.php 2015-09-20 14:53:31 UTC (rev 1130)
+++ trunk/t/tests/test_builtin_warnings.php 2015-09-24 11:36:22 UTC (rev 1131)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,7 +51,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $warnings = $this->getMock( 'GP_Translation_Warnings' );
</span><span class="cx" style="display: block; padding: 0 10px"> // we check for the number of warnings, because PHPUnit doesn't allow
</span><span class="cx" style="display: block; padding: 0 10px"> // us to check if each argument is a callable
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $warnings->expects( $this->exactly( 4 ) )->method( 'add' )->will( $this->returnValue( true ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $warnings->expects( $this->exactly( 7 ) )->method( 'add' )->will( $this->returnValue( true ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->w->add_all( $warnings );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -70,14 +70,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNoWarnings( 'placeholders', 'This string has %stwo variables%s.', 'Deze string heeft %stwee variabelen%s.' );
</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">- function test_both_begin_end_on_newlines() {
- $this->assertHasWarnings( 'both_begin_end_on_newlines', "baba\n", "baba" );
- $this->assertHasWarnings( 'both_begin_end_on_newlines', "baba", "baba\n" );
- $this->assertNoWarnings( 'both_begin_end_on_newlines', "baba", "baba" );
- $this->assertNoWarnings( 'both_begin_end_on_newlines', "baba\n", "baba\n" );
- $this->assertHasWarnings( 'both_begin_end_on_newlines', "\nbaba", "baba" );
- $this->assertHasWarnings( 'both_begin_end_on_newlines', "baba", "\nbaba" );
- $this->assertNoWarnings( 'both_begin_end_on_newlines', "\nbaba", "\nbaba" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_should_begin_end_on_newline() {
+ $this->assertHasWarnings( 'should_begin_on_newline', "\nbaba", "baba" );
+ $this->assertHasWarnings( 'should_not_begin_on_newline', "baba", "\nbaba" );
+ $this->assertHasWarnings( 'should_end_on_newline', "baba\n", "baba" );
+ $this->assertHasWarnings( 'should_not_end_on_newline', "baba", "baba\n" );
+
+ $this->assertNoWarnings( 'should_begin_on_newline', "baba", "baba" );
+ $this->assertNoWarnings( 'should_not_begin_on_newline', "baba", "baba" );
+ $this->assertNoWarnings( 'should_end_on_newline', "baba", "baba" );
+ $this->assertNoWarnings( 'should_not_end_on_newline', "baba", "baba" );
+
+ $this->assertNoWarnings( 'should_begin_on_newline', "baba\n", "baba\n" );
+ $this->assertNoWarnings( 'should_not_begin_on_newline', "baba\n", "baba\n" );
+ $this->assertNoWarnings( 'should_end_on_newline', "baba\n", "baba\n" );
+ $this->assertNoWarnings( 'should_not_end_on_newline', "baba\n", "baba\n" );
+
+ $this->assertNoWarnings( 'should_begin_on_newline', "\nbaba", "\nbaba" );
+ $this->assertNoWarnings( 'should_not_begin_on_newline', "\nbaba", "\nbaba" );
+ $this->assertNoWarnings( 'should_end_on_newline', "\nbaba", "\nbaba" );
+ $this->assertNoWarnings( 'should_not_end_on_newline', "\nbaba", "\nbaba" );
</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"> function test_placeholders_using_check() {
</span></span></pre></div>
<a id="trunktteststests_routestest_route_translationphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/t/tests/tests_routes/test_route_translation.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/t/tests/tests_routes/test_route_translation.php 2015-09-20 14:53:31 UTC (rev 1130)
+++ trunk/t/tests/tests_routes/test_route_translation.php 2015-09-24 11:36:22 UTC (rev 1131)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,7 +19,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Create a translation with two warnings
</span><span class="cx" style="display: block; padding: 0 10px"> $warnings = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 0 => array( 'placeholder' => 'Missing %2$s placeholder in translation.' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 1 => array( 'both_begin_end_on_newlines' => 'Original and translation should both begin on newline.' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 1 => array( 'should_begin_on_newline' => 'Original and translation should both begin on newline.' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $translation1 = $this->factory->translation->create( array( 'translation_set_id' => $set1->id, 'original_id' => $original1->id, 'status' => 'current', 'warnings' => $warnings ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $translation1->set_as_current(); //calls propagate_across_projects
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,7 +39,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $_POST['translation_id'] = $translation1->id;
</span><span class="cx" style="display: block; padding: 0 10px"> $_POST['index'] = 1;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $_POST['key'] = 'both_begin_end_on_newlines';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $_POST['key'] = 'should_begin_on_newline';
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->route->discard_warning( $project2->path, $set2->locale, $set2->slug );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Second original should be translated now.
</span></span></pre>
</div>
</div>
</body>
</html>