Lucas Werkmeister (WMDE) has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/359124 )
Change subject: Rename VisualEditor to QueryHelper
......................................................................
Rename VisualEditor to QueryHelper
VisualEditor is ambiguous with the MediaWiki VisualEditor extension and
feature, and the documentation already refers to our “visual editor” as
“query helper”.
Bug: T167949
Change-Id: I6b04e784a5f5f79f902728deacbac2629ddb7664
---
M embed.html
M index.html
M wikibase/init.js
M wikibase/queryService/ui/App.js
R wikibase/queryService/ui/queryHelper/QueryHelper.js
R wikibase/queryService/ui/queryHelper/QueryTemplate.js
R wikibase/queryService/ui/queryHelper/SelectorBox.js
R wikibase/queryService/ui/queryHelper/SparqlQuery.js
R wikibase/tests/QueryHelper.html
R wikibase/tests/queryService/ui/queryHelper/QueryHelper.test.js
R wikibase/tests/queryService/ui/queryHelper/QueryTemplate.test.js
R wikibase/tests/queryService/ui/queryHelper/SparqlQuery.test.js
12 files changed, 67 insertions(+), 67 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/wikidata/query/gui
refs/changes/24/359124/1
diff --git a/embed.html b/embed.html
index 869e135..d35da5f 100644
--- a/embed.html
+++ b/embed.html
@@ -146,10 +146,10 @@
<script src="wikibase/queryService/api/Wikibase.js"></script>
<script src="wikibase/queryService/api/Tracking.js"></script>
<script src="wikibase/queryService/RdfNamespaces.js"></script>
- <script
src="wikibase/queryService/ui/visualEditor/VisualEditor.js"></script>
- <script
src="wikibase/queryService/ui/visualEditor/SparqlQuery.js"></script>
- <script
src="wikibase/queryService/ui/visualEditor/SelectorBox.js"></script>
- <script
src="wikibase/queryService/ui/visualEditor/QueryTemplate.js"></script>
+ <script
src="wikibase/queryService/ui/queryHelper/QueryHelper.js"></script>
+ <script
src="wikibase/queryService/ui/queryHelper/SparqlQuery.js"></script>
+ <script
src="wikibase/queryService/ui/queryHelper/SelectorBox.js"></script>
+ <script
src="wikibase/queryService/ui/queryHelper/QueryTemplate.js"></script>
<!-- endbuild -->
<script type="text/javascript">
@@ -216,7 +216,7 @@
}
function renderEdit( query, callback ) {
- var ve = new
wikibase.queryService.ui.visualEditor.VisualEditor();
+ var ve = new
wikibase.queryService.ui.queryHelper.QueryHelper();
ve.setChangeListener( _.debounce( function( v )
{
callback( v.getQuery() );
}, 1500 ) );
diff --git a/index.html b/index.html
index 9c0a255..f9854b2 100644
--- a/index.html
+++ b/index.html
@@ -272,10 +272,10 @@
<script src="wikibase/queryService/ui/editor/hint/Rdf.js"></script>
<script src="wikibase/queryService/ui/editor/tooltip/Rdf.js"></script>
<script src="wikibase/queryService/ui/editor/Editor.js"></script>
- <script
src="wikibase/queryService/ui/visualEditor/VisualEditor.js"></script>
- <script
src="wikibase/queryService/ui/visualEditor/SparqlQuery.js"></script>
- <script
src="wikibase/queryService/ui/visualEditor/SelectorBox.js"></script>
- <script
src="wikibase/queryService/ui/visualEditor/QueryTemplate.js"></script>
+ <script
src="wikibase/queryService/ui/queryHelper/QueryHelper.js"></script>
+ <script
src="wikibase/queryService/ui/queryHelper/SparqlQuery.js"></script>
+ <script
src="wikibase/queryService/ui/queryHelper/SelectorBox.js"></script>
+ <script
src="wikibase/queryService/ui/queryHelper/QueryTemplate.js"></script>
<script src="wikibase/queryService/ui/QueryExampleDialog.js"></script>
<script
src="wikibase/queryService/ui/resultBrowser/helper/FormatterHelper.js"></script>
<script
src="wikibase/queryService/ui/resultBrowser/AbstractResultBrowser.js"></script>
diff --git a/wikibase/init.js b/wikibase/init.js
index bbd681f..c2dbbda 100644
--- a/wikibase/init.js
+++ b/wikibase/init.js
@@ -46,7 +46,7 @@
new wb.ui.App(
$( '.wikibase-queryservice ' ),
new wb.ui.editor.Editor( rdfHint, null,
rdfTooltip ),
- new wb.ui.visualEditor.VisualEditor(
api, sparqlApi ),
+ new wb.ui.queryHelper.QueryHelper( api,
sparqlApi ),
sparqlApi );
} );
diff --git a/wikibase/queryService/ui/App.js b/wikibase/queryService/ui/App.js
index 0e04421..3b2a6c7 100644
--- a/wikibase/queryService/ui/App.js
+++ b/wikibase/queryService/ui/App.js
@@ -21,12 +21,12 @@
*
* @param {jQuery} $element
* @param {wikibase.queryService.ui.editor.Editor} editor
- * @param {wikibase.queryService.api.Sparql} visualEditor
+ * @param {wikibase.queryService.api.Sparql} queryHelper
*/
- function SELF( $element, editor, visualEditor, sparqlApi,
querySamplesApi ) {
+ function SELF( $element, editor, queryHelper, sparqlApi,
querySamplesApi ) {
this._$element = $element;
this._editor = editor;
- this._visualEditor = visualEditor;
+ this._queryHelper = queryHelper;
this._sparqlApi = sparqlApi;
this._querySamplesApi = querySamplesApi;
@@ -58,10 +58,10 @@
SELF.prototype._editor = null;
/**
- * @property {wikibase.queryService.ui.visualEditor.VisualEditor}
+ * @property {wikibase.queryService.ui.queryHelper.QueryHelper}
* @private
*/
- SELF.prototype._visualEditor = null;
+ SELF.prototype._queryHelper = null;
/**
* @property {boolean}
@@ -224,7 +224,7 @@
this._initApp();
this._initEditor();
- this._initVisualEditor();
+ this._initQueryHelper();
this._initExamples();
this._initDataUpdated();
this._initQuery();
@@ -266,14 +266,14 @@
/**
* @private
*/
- SELF.prototype._initVisualEditor = function() {
+ SELF.prototype._initQueryHelper = function() {
var self = this,
cookieHide = 'visual-editor-hide';
- if ( !this._visualEditor ) {
- this._visualEditor = new
wikibase.queryService.ui.visualEditor.VisualEditor();
+ if ( !this._queryHelper ) {
+ this._queryHelper = new
wikibase.queryService.ui.queryHelper.QueryHelper();
}
- this._visualEditor.setChangeListener( function( ve ) {
+ this._queryHelper.setChangeListener( function( ve ) {
self._editor.setValue( ve.getQuery() );
} );
@@ -284,12 +284,12 @@
if ( this._editor ) {
this._editor.registerCallback( 'change', _.debounce(
function() {
if ( $( '.visual-editor-trigger' ).is(
':visible' ) ||
- self._editor.getValue() ===
self._visualEditor.getQuery() ) {
+ self._editor.getValue() ===
self._queryHelper.getQuery() ) {
return;
}
$( '.visual-editor' ).hide();
- self._drawVisualEditor();
+ self._drawQueryHelper();
}, 1500 ) );
}
@@ -303,7 +303,7 @@
$( '.visual-editor-trigger' ).click( function() {
$( '.visual-editor-trigger' ).hide();
Cookies.set( cookieHide, false );
- self._drawVisualEditor();
+ self._drawQueryHelper();
return false;
} );
};
@@ -311,10 +311,10 @@
/**
* @private
*/
- SELF.prototype._drawVisualEditor = function() {
+ SELF.prototype._drawQueryHelper = function() {
try {
- this._visualEditor.setQuery( this._editor.getValue() );
- this._visualEditor.draw( $( '.visual-editor
.panel-body' ) );
+ this._queryHelper.setQuery( this._editor.getValue() );
+ this._queryHelper.draw( $( '.visual-editor .panel-body'
) );
$( '.visual-editor' ).delay( 500 ).fadeIn();
} catch ( e ) {
diff --git a/wikibase/queryService/ui/visualEditor/VisualEditor.js
b/wikibase/queryService/ui/queryHelper/QueryHelper.js
similarity index 94%
rename from wikibase/queryService/ui/visualEditor/VisualEditor.js
rename to wikibase/queryService/ui/queryHelper/QueryHelper.js
index 15f9b78..8994a99 100644
--- a/wikibase/queryService/ui/visualEditor/VisualEditor.js
+++ b/wikibase/queryService/ui/queryHelper/QueryHelper.js
@@ -1,9 +1,9 @@
var wikibase = wikibase || {};
wikibase.queryService = wikibase.queryService || {};
wikibase.queryService.ui = wikibase.queryService.ui || {};
-wikibase.queryService.ui.visualEditor = wikibase.queryService.ui.visualEditor
|| {};
+wikibase.queryService.ui.queryHelper = wikibase.queryService.ui.queryHelper ||
{};
-wikibase.queryService.ui.visualEditor.VisualEditor = ( function( $, wikibase )
{
+wikibase.queryService.ui.queryHelper.QueryHelper = ( function( $, wikibase ) {
'use strict';
var FILTER_PREDICATES = {
@@ -18,20 +18,20 @@
/**
* A visual SPARQL editor for the Wikibase query service
*
- * @class wikibase.queryService.ui.visualEditor.VisualEditor
+ * @class wikibase.queryService.ui.queryHelper.QueryHelper
* @license GNU GPL v2+
*
* @author Jonas Kress
* @constructor
* @param {wikibase.queryService.api.Wikibase} [api]
* @param {wikibase.queryService.api.Sparql} [sparqlApi]
- * @param {wikibase.queryService.ui.visualEditor.SelectorBox}
[selectorBox]
+ * @param {wikibase.queryService.ui.queryHelper.SelectorBox}
[selectorBox]
*/
function SELF( api, sparqlApi, selectorBox ) {
this._api = api || new wikibase.queryService.api.Wikibase();
this._selectorBox = selectorBox
- || new
wikibase.queryService.ui.visualEditor.SelectorBox( this._api, sparqlApi );
- this._query = new
wikibase.queryService.ui.visualEditor.SparqlQuery();
+ || new
wikibase.queryService.ui.queryHelper.SelectorBox( this._api, sparqlApi );
+ this._query = new
wikibase.queryService.ui.queryHelper.SparqlQuery();
}
/**
@@ -41,7 +41,7 @@
SELF.prototype._api = null;
/**
- * @property {wikibase.queryService.ui.visualEditor.SelectorBox}
+ * @property {wikibase.queryService.ui.queryHelper.SelectorBox}
* @private
*/
SELF.prototype._selectorBox = null;
@@ -53,7 +53,7 @@
SELF.prototype._changeListener = null;
/**
- * @property {wikibase.queryService.ui.visualEditor.SparqlQuery}
+ * @property {wikibase.queryService.ui.queryHelper.SparqlQuery}
* @private
*/
SELF.prototype._query = null;
@@ -146,7 +146,7 @@
* @param {jQuery} $element
*/
SELF.prototype.draw = function( $element ) {
- var template =
wikibase.queryService.ui.visualEditor.QueryTemplate.parse( this._query ),
+ var template =
wikibase.queryService.ui.queryHelper.QueryTemplate.parse( this._query ),
self = this,
bindings = this._query.getBindings();
diff --git a/wikibase/queryService/ui/visualEditor/QueryTemplate.js
b/wikibase/queryService/ui/queryHelper/QueryTemplate.js
similarity index 93%
rename from wikibase/queryService/ui/visualEditor/QueryTemplate.js
rename to wikibase/queryService/ui/queryHelper/QueryTemplate.js
index 1ef19dd..e3b84bb 100644
--- a/wikibase/queryService/ui/visualEditor/QueryTemplate.js
+++ b/wikibase/queryService/ui/queryHelper/QueryTemplate.js
@@ -1,15 +1,15 @@
var wikibase = wikibase || {};
wikibase.queryService = wikibase.queryService || {};
wikibase.queryService.ui = wikibase.queryService.ui || {};
-wikibase.queryService.ui.visualEditor = wikibase.queryService.ui.visualEditor
|| {};
+wikibase.queryService.ui.queryHelper = wikibase.queryService.ui.queryHelper ||
{};
-wikibase.queryService.ui.visualEditor.QueryTemplate = ( function( $, wikibase
) {
+wikibase.queryService.ui.queryHelper.QueryTemplate = ( function( $, wikibase )
{
'use strict';
/**
* A template for a SPARQL query
*
- * @class wikibase.queryService.ui.visualEditor.QueryTemplate
+ * @class wikibase.queryService.ui.queryHelper.QueryTemplate
* @license GNU GPL v2+
*
* @author Lucas Werkmeister
@@ -131,7 +131,7 @@
/**
* @param {Function} getLabel Called with {string} variable name,
should return {Promise} for label, id, description, type.
- * @param {wikibase.queryService.ui.visualEditor.SelectorBox}
selectorBox
+ * @param {wikibase.queryService.ui.queryHelper.SelectorBox} selectorBox
* @param {Function} changeListener Called with {string} variable name,
{string} old value, {string} new value.
* @return {jQuery}
*/
diff --git a/wikibase/queryService/ui/visualEditor/SelectorBox.js
b/wikibase/queryService/ui/queryHelper/SelectorBox.js
similarity index 97%
rename from wikibase/queryService/ui/visualEditor/SelectorBox.js
rename to wikibase/queryService/ui/queryHelper/SelectorBox.js
index f4a84ff..601dbae 100644
--- a/wikibase/queryService/ui/visualEditor/SelectorBox.js
+++ b/wikibase/queryService/ui/queryHelper/SelectorBox.js
@@ -1,9 +1,9 @@
var wikibase = wikibase || {};
wikibase.queryService = wikibase.queryService || {};
wikibase.queryService.ui = wikibase.queryService.ui || {};
-wikibase.queryService.ui.visualEditor = wikibase.queryService.ui.visualEditor
|| {};
+wikibase.queryService.ui.queryHelper = wikibase.queryService.ui.queryHelper ||
{};
-wikibase.queryService.ui.visualEditor.SelectorBox = ( function( $, wikibase ) {
+wikibase.queryService.ui.queryHelper.SelectorBox = ( function( $, wikibase ) {
'use strict';
var I18N_PREFIX = 'wdqs-ve-sb';
@@ -150,7 +150,7 @@
/**
* A selector box for selecting and changing properties and items
*
- * @class wikibase.queryService.ui.visualEditor.SelectorBox
+ * @class wikibase.queryService.ui.queryHelper.SelectorBox
* @license GNU GPL v2+
*
* @author Jonas Kress
diff --git a/wikibase/queryService/ui/visualEditor/SparqlQuery.js
b/wikibase/queryService/ui/queryHelper/SparqlQuery.js
similarity index 95%
rename from wikibase/queryService/ui/visualEditor/SparqlQuery.js
rename to wikibase/queryService/ui/queryHelper/SparqlQuery.js
index d942112..404d802 100644
--- a/wikibase/queryService/ui/visualEditor/SparqlQuery.js
+++ b/wikibase/queryService/ui/queryHelper/SparqlQuery.js
@@ -1,15 +1,15 @@
var wikibase = wikibase || {};
wikibase.queryService = wikibase.queryService || {};
wikibase.queryService.ui = wikibase.queryService.ui || {};
-wikibase.queryService.ui.visualEditor = wikibase.queryService.ui.visualEditor
|| {};
+wikibase.queryService.ui.queryHelper = wikibase.queryService.ui.queryHelper ||
{};
-wikibase.queryService.ui.visualEditor.SparqlQuery = ( function( $, wikibase,
sparqljs ) {
+wikibase.queryService.ui.queryHelper.SparqlQuery = ( function( $, wikibase,
sparqljs ) {
'use strict';
/**
* A SPARQL query representation
*
- * @class wikibase.queryService.ui.visualEditor.SparqlQuery
+ * @class wikibase.queryService.ui.queryHelper.SparqlQuery
* @license GNU GPL v2+
*
* @author Jonas Kress
@@ -224,7 +224,7 @@
/**
* Get triples defined in this query
*
- * @return {wikibase.queryService.ui.visualEditor.SparqlQuery[]}
+ * @return {wikibase.queryService.ui.queryHelper.SparqlQuery[]}
*/
SELF.prototype.getSubQueries = function() {
var queries = [];
diff --git a/wikibase/tests/VisualEditor.html b/wikibase/tests/QueryHelper.html
similarity index 69%
rename from wikibase/tests/VisualEditor.html
rename to wikibase/tests/QueryHelper.html
index ad9e966..76a381f 100644
--- a/wikibase/tests/VisualEditor.html
+++ b/wikibase/tests/QueryHelper.html
@@ -24,14 +24,14 @@
<script src="../queryService/RdfNamespaces.js"></script>
<script src="../queryService/api/Wikibase.js"></script>
<script src="../queryService/api/Sparql.js"></script>
- <script src="../queryService/ui/visualEditor/VisualEditor.js"></script>
- <script src="../queryService/ui/visualEditor/SelectorBox.js"></script>
- <script src="../queryService/ui/visualEditor/SparqlQuery.js"></script>
- <script src="../queryService/ui/visualEditor/QueryTemplate.js"></script>
+ <script src="../queryService/ui/queryHelper/QueryHelper.js"></script>
+ <script src="../queryService/ui/queryHelper/SelectorBox.js"></script>
+ <script src="../queryService/ui/queryHelper/SparqlQuery.js"></script>
+ <script src="../queryService/ui/queryHelper/QueryTemplate.js"></script>
<!-- Tests -->
- <script
src="queryService/ui/visualEditor/VisualEditor.test.js"></script>
- <script src="queryService/ui/visualEditor/SparqlQuery.test.js"></script>
- <script
src="queryService/ui/visualEditor/QueryTemplate.test.js"></script>
+ <script src="queryService/ui/queryHelper/QueryHelper.test.js"></script>
+ <script src="queryService/ui/queryHelper/SparqlQuery.test.js"></script>
+ <script
src="queryService/ui/queryHelper/QueryTemplate.test.js"></script>
</body>
</html>
diff --git a/wikibase/tests/queryService/ui/visualEditor/VisualEditor.test.js
b/wikibase/tests/queryService/ui/queryHelper/QueryHelper.test.js
similarity index 86%
rename from wikibase/tests/queryService/ui/visualEditor/VisualEditor.test.js
rename to wikibase/tests/queryService/ui/queryHelper/QueryHelper.test.js
index bce69fc..e6b612d 100644
--- a/wikibase/tests/queryService/ui/visualEditor/VisualEditor.test.js
+++ b/wikibase/tests/queryService/ui/queryHelper/QueryHelper.test.js
@@ -1,7 +1,7 @@
( function ( $, QUnit, sinon, wb ) {
'use strict';
- QUnit.module( 'wikibase.queryService.ui.visualEditor' );
+ QUnit.module( 'wikibase.queryService.ui.queryHelper' );
var TEST_CASES = [
{
@@ -57,18 +57,18 @@
Q33999: 'actor'
};
- QUnit.test( 'When instantiating VisualEditor there should be no error
', function ( assert ) {
+ QUnit.test( 'When instantiating QueryHelper there should be no error ',
function ( assert ) {
assert.expect( 2 );
- var ve = new wb.queryService.ui.visualEditor.VisualEditor();
+ var qh = new wb.queryService.ui.queryHelper.QueryHelper();
assert.ok( true, 'Instantiating must not throw an error' );
- assert.ok( ( ve instanceof
wb.queryService.ui.visualEditor.VisualEditor ),
+ assert.ok( ( qh instanceof
wb.queryService.ui.queryHelper.QueryHelper ),
'Instantiating must not throw an error' );
} );
$.each( TEST_CASES, function ( index, testCase ) {
QUnit.test( 'When setting SPARQL \'' + testCase.name
- + '\' query to VisualEditor then there should
be the expected outcome', function (
+ + '\' query to QueryHelper then there should be
the expected outcome', function (
assert ) {
assert.expect( 2 );
@@ -87,13 +87,13 @@
} ).promise();
} );
- var ve = new
wb.queryService.ui.visualEditor.VisualEditor( api );
- ve.setQuery( testCase.sparqlIn );
+ var qh = new
wb.queryService.ui.queryHelper.QueryHelper( api );
+ qh.setQuery( testCase.sparqlIn );
var $html = $( '<div>' );
- ve.draw( $html );
+ qh.draw( $html );
- assert.equal( ve.getQuery().trim(), testCase.sparqlOut
);
+ assert.equal( qh.getQuery().trim(), testCase.sparqlOut
);
assert.equal( $html.text().trim(), testCase.text );
} );
} );
diff --git a/wikibase/tests/queryService/ui/visualEditor/QueryTemplate.test.js
b/wikibase/tests/queryService/ui/queryHelper/QueryTemplate.test.js
similarity index 94%
rename from wikibase/tests/queryService/ui/visualEditor/QueryTemplate.test.js
rename to wikibase/tests/queryService/ui/queryHelper/QueryTemplate.test.js
index b4a353d..02c888f 100644
--- a/wikibase/tests/queryService/ui/visualEditor/QueryTemplate.test.js
+++ b/wikibase/tests/queryService/ui/queryHelper/QueryTemplate.test.js
@@ -1,9 +1,9 @@
( function ( $, QUnit, sinon, wb ) {
'use strict';
- QUnit.module( 'wikibase.queryService.ui.visualEditor' );
+ QUnit.module( 'wikibase.queryService.ui.queryHelper' );
- var QueryTemplate = wb.queryService.ui.visualEditor.QueryTemplate;
+ var QueryTemplate = wb.queryService.ui.queryHelper.QueryTemplate;
QUnit.test( '_getQueryTemplateFragments internal function', function(
assert ) {
assert.expect( 7 );
@@ -87,7 +87,7 @@
QUnit.test( testCase.description, function( assert ) {
assert.expect( 1 );
- var query = new
wb.queryService.ui.visualEditor.SparqlQuery();
+ var query = new
wb.queryService.ui.queryHelper.SparqlQuery();
query.parse( testCase.sparql,
wb.queryService.RdfNamespaces.ALL_PREFIXES );
var qt = QueryTemplate.parse( query );
var $html = qt.getHtml(
diff --git a/wikibase/tests/queryService/ui/visualEditor/SparqlQuery.test.js
b/wikibase/tests/queryService/ui/queryHelper/SparqlQuery.test.js
similarity index 98%
rename from wikibase/tests/queryService/ui/visualEditor/SparqlQuery.test.js
rename to wikibase/tests/queryService/ui/queryHelper/SparqlQuery.test.js
index e4efc7c..4efb7bf 100644
--- a/wikibase/tests/queryService/ui/visualEditor/SparqlQuery.test.js
+++ b/wikibase/tests/queryService/ui/queryHelper/SparqlQuery.test.js
@@ -1,9 +1,9 @@
( function( $, QUnit, sinon, wb ) {
'use strict';
- QUnit.module( 'wikibase.queryService.ui.visualEditor' );
+ QUnit.module( 'wikibase.queryService.ui.queryHelper' );
- var PACKAGE = wb.queryService.ui.visualEditor;
+ var PACKAGE = wb.queryService.ui.queryHelper;
var QUERY = {
SIMPLE: 'SELECT * WHERE {}',
LIMIT: 'SELECT * WHERE {} LIMIT 10',
--
To view, visit https://gerrit.wikimedia.org/r/359124
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I6b04e784a5f5f79f902728deacbac2629ddb7664
Gerrit-PatchSet: 1
Gerrit-Project: wikidata/query/gui
Gerrit-Branch: master
Gerrit-Owner: Lucas Werkmeister (WMDE) <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
