Tobias Gritschacher has submitted this change and it was merged.
Change subject: (bug 44683) Making use of setClaim API module in JavaScript UI
......................................................................
(bug 44683) Making use of setClaim API module in JavaScript UI
Instead of setClaimValue and createClaim, the JavaScript UI is using the
setClaim API
module now.
- patch set 4: Adjusted change set to updated implementation of claim GUID
generator
- patch set 5: Rebase
Change-Id: I952e5b9ce62db6d85439dbb88a1ae9c089859ea8
---
M lib/resources/Resources.php
M lib/resources/jquery.wikibase/jquery.wikibase.claimlistview.js
M lib/resources/jquery.wikibase/jquery.wikibase.claimview.js
M lib/resources/jquery.wikibase/jquery.wikibase.statementview.js
M lib/resources/wikibase.datamodel/wikibase.Statement.js
M lib/resources/wikibase.store/wikibase.RepoApi.js
M repo/tests/selenium/statements/statements_deleted_prop_spec.rb
M repo/tests/selenium/statements/statements_spec.rb
8 files changed, 146 insertions(+), 63 deletions(-)
Approvals:
Tobias Gritschacher: Verified; Looks good to me, approved
jenkins-bot: Checked
diff --git a/lib/resources/Resources.php b/lib/resources/Resources.php
index c79e80a..c6a45e5 100644
--- a/lib/resources/Resources.php
+++ b/lib/resources/Resources.php
@@ -595,6 +595,7 @@
'jquery.wikibase.claimview',
'jquery.wikibase.toolbarcontroller',
'wikibase.templates',
+ 'wikibase.utilities.ClaimGuidGenerator',
),
'messages' => array(
'wikibase-entity-property',
diff --git a/lib/resources/jquery.wikibase/jquery.wikibase.claimlistview.js
b/lib/resources/jquery.wikibase/jquery.wikibase.claimlistview.js
index e40aff4..70e1f6e 100644
--- a/lib/resources/jquery.wikibase/jquery.wikibase.claimlistview.js
+++ b/lib/resources/jquery.wikibase/jquery.wikibase.claimlistview.js
@@ -340,7 +340,8 @@
// TODO: not nice to use the event of the main snak, perhaps
the claimview could offer one!
$newClaim
.on( this._lmwEvent( 'stopediting' ), function( event,
dropValue ) {
- var newSnak = self._lmwInstance( $newClaim
).$mainSnak.data( 'snakview' ).snak();
+ var newClaimview = self._lmwInstance( $newClaim ),
+ newSnak = newClaimview.$mainSnak.data(
'snakview' ).snak();
if ( !self._lmwInstance( $newClaim ).isValid() &&
!dropValue ) {
event.preventDefault();
@@ -366,13 +367,28 @@
// TODO: either change toggleActionMessage to
do the disabling, then execute the
// callback and finally execute the
toggle animation, OR separate the
// disabling and call it manually, then
do the API call, then toggle.
- var api = new wb.RepoApi();
+ var api = new wb.RepoApi(),
+ newClaim,
+ guidGenerator = new
wb.utilities.ClaimGuidGenerator(),
+ guid = guidGenerator.newGuid(
mw.config.get( 'wbEntityId' ) );
- api.createClaim(
- self.option( 'entityId' ),
- wb.getRevisionStore().getBaseRevision(),
- newSnak
- )
+ if ( newClaimview.$references ) {
+ newClaim = new wb.Statement(
+ newSnak,
+ null, // TODO: Qualifiers
+ [], // TODO: References
+ null, // TODO: Rank
+ guid
+ )
+ } else {
+ newClaim = new wb.Claim(
+ newSnak,
+ null, // TODO: Qualifiers
+ guid
+ )
+ }
+
+ api.setClaim( newClaim,
wb.getRevisionStore().getBaseRevision() )
.done( function( newClaimWithGUID, pageInfo ) {
wb.getRevisionStore().setClaimRevision(
pageInfo.lastrevid,
diff --git a/lib/resources/jquery.wikibase/jquery.wikibase.claimview.js
b/lib/resources/jquery.wikibase/jquery.wikibase.claimview.js
index f2f5ad1..5a4f93c 100644
--- a/lib/resources/jquery.wikibase/jquery.wikibase.claimview.js
+++ b/lib/resources/jquery.wikibase/jquery.wikibase.claimview.js
@@ -250,41 +250,39 @@
self._isInEditMode = false;
self._trigger( 'afterstopediting', null, [
dropValue ] );
- } else if ( this._claim !== null ) {
+ } else if ( this._claim ) {
// editing an existing claim
- if ( self._claim ) {
- self._saveMainSnakApiCall(
self.$mainSnak.data( 'snakview' ).snak() )
- .done( function( savedClaim, pageInfo )
{
- self.$mainSnak.data( 'snakview'
).stopEditing( dropValue );
+ self._saveClaimApiCall()
+ .done( function( savedClaim, pageInfo ) {
+ self.$mainSnak.data( 'snakview'
).stopEditing( dropValue );
- self.enable();
+ self.enable();
- if ( !self._claim ) {
- // claim must be newly
entered, create a new claim:
- self._claim = new
wb.Claim(
-
self.$mainSnak.data( 'snakview' ).value()
- );
- }
+ if ( !self._claim ) {
+ // claim must be newly entered,
create a new claim:
+ self._claim = new wb.Claim(
+ self.$mainSnak.data(
'snakview' ).value()
+ );
+ }
- self.element.removeClass(
'wb-edit' );
- self._isInEditMode = false;
+ self.element.removeClass( 'wb-edit' );
+ self._isInEditMode = false;
- // transform toolbar and snak
view after save complete
- self._trigger(
'afterstopediting', null, [ dropValue ] );
- } )
- .fail( function( errorCode, details ) {
- var error =
wb.RepoApiError.newFromApiResponse(
- errorCode,
details, 'save'
- );
+ // transform toolbar and snak view
after save complete
+ self._trigger( 'afterstopediting',
null, [ dropValue ] );
+ } )
+ .fail( function( errorCode, details ) {
+ var error =
wb.RepoApiError.newFromApiResponse(
+ errorCode, details,
'save'
+ );
- self.enable();
- self.element.addClass(
'wb-error' );
+ self.enable();
+ self.element.addClass( 'wb-error' );
- self._trigger( 'toggleError',
null, [ error ] );
+ self._trigger( 'toggleError', null, [
error ] );
- self.__continueStopEditing =
false;
- } );
- }
+ self.__continueStopEditing = false;
+ } );
} else {
// Adding a new claim is managed in
claimlistview and will end up in here after
// having performed the API call adding the
claim.
@@ -351,35 +349,32 @@
},
/**
- * Triggers the API call to save the Main Snak.
+ * Triggers the API call to save the claim.
* @since 0.4
*
* TODO: would be nice to have all API related stuff out of here to
allow concentrating on
* MVVM relation.
*
- * @param {wb.Snak} mainSnak
- * @return jQuery.Promise
+ * @return {jQuery.Promise}
*/
- _saveMainSnakApiCall: function( mainSnak ) {
- if( !this.value() ) {
- throw new Error( 'Can\'t save Main Snak of non-existent
Claim' );
- }
- // store changed value of Claim's Main Snak:
+ _saveClaimApiCall: function() {
var self = this,
- guid = this.value().getGuid(),
api = new wb.RepoApi(),
- revStore = wb.getRevisionStore();
+ revStore = wb.getRevisionStore(),
+ guid = this.value().getGuid(),
+ claim = new wb.Claim(
+ self.$mainSnak.data( 'snakview' ).snak(),
+ new wb.SnakList(), // TODO: Qualifiers
+ guid
+ );
- return api.setClaimValue(
- guid,
- revStore.getClaimRevision( guid ),
- mainSnak
- ).done( function( savedClaim, pageInfo ) {
- // update revision store
+ return api.setClaim( claim, revStore.getClaimRevision( guid ) )
+ .done( function( savedClaim, pageInfo ) {
+ // Update revision store:
revStore.setClaimRevision( pageInfo.lastrevid,
savedClaim.getGuid() );
- // update model of represented Claim
- self._claim.setMainSnak( savedClaim.getMainSnak() );
+ // Update model of represented Claim:
+ self._claim = savedClaim;
} );
},
diff --git a/lib/resources/jquery.wikibase/jquery.wikibase.statementview.js
b/lib/resources/jquery.wikibase/jquery.wikibase.statementview.js
index bfc82ec..32e1149 100644
--- a/lib/resources/jquery.wikibase/jquery.wikibase.statementview.js
+++ b/lib/resources/jquery.wikibase/jquery.wikibase.statementview.js
@@ -244,6 +244,35 @@
},
/**
+ * Triggers the API call to save the satement.
+ * @see jQuery.wikibase.claimview._saveClaimApiCall
+ *
+ * @return {jQuery.Promise}
+ */
+ _saveClaimApiCall: function() {
+ var self = this,
+ api = new wb.RepoApi(),
+ revStore = wb.getRevisionStore(),
+ guid = this.value().getGuid(),
+ statement = new wb.Statement(
+ self.$mainSnak.data( 'snakview' ).snak(),
+ null, // TODO: Qualifiers
+ this.getReferences(),
+ null, // TODO: Rank
+ guid
+ );
+
+ return api.setClaim( statement, revStore.getClaimRevision( guid
) )
+ .done( function( newStatement, pageInfo ) {
+ // Update revision store:
+ revStore.setClaimRevision( pageInfo.lastrevid,
newStatement.getGuid() );
+
+ // Update model of represented Claim:
+ self._claim = newStatement;
+ } );
+ },
+
+ /**
* Adds one reference to the list and renders it in the view.
* @since 0.4
*
@@ -255,6 +284,23 @@
},
/**
+ * Returns all references currently set (including all pending changes).
+ *
+ * @return {wb.Reference[]}
+ */
+ getReferences: function() {
+ var self = this,
+ references = [];
+
+ $.each( this.$references.data( 'listview' ).items(), function(
i, item ) {
+ var referenceview = self._referenceviewLia.liInstance(
$( item ) );
+ references.push( referenceview.value() );
+ } );
+
+ return references;
+ },
+
+ /**
* Triggers the API call to remove a reference.
* @since 0.4
*
diff --git a/lib/resources/wikibase.datamodel/wikibase.Statement.js
b/lib/resources/wikibase.datamodel/wikibase.Statement.js
index d1b66e6..229a454 100644
--- a/lib/resources/wikibase.datamodel/wikibase.Statement.js
+++ b/lib/resources/wikibase.datamodel/wikibase.Statement.js
@@ -11,7 +11,7 @@
constructor = function( mainSnak, qualifiers, references, rank, guid ) {
PARENT.call( this, mainSnak, qualifiers, guid );
this.setReferences( references || [] );
- this.setRank( rank === undefined ? wb.Statement.RANK.NORMAL :
rank );
+ this.setRank( !rank ? wb.Statement.RANK.NORMAL : rank );
};
/**
diff --git a/lib/resources/wikibase.store/wikibase.RepoApi.js
b/lib/resources/wikibase.store/wikibase.RepoApi.js
index 14adcca..dc16409 100644
--- a/lib/resources/wikibase.store/wikibase.RepoApi.js
+++ b/lib/resources/wikibase.store/wikibase.RepoApi.js
@@ -214,6 +214,28 @@
},
/**
+ * Creates/Updates an entire claim.
+ *
+ * @param {wb.Claim|wb.Statement} claim
+ * @param {Number} baseRevId
+ * @return {jQuery.Promise}
+ */
+ setClaim: function( claim, baseRevId ) {
+ var params = {
+ action: 'wbsetclaim',
+ claim:$.toJSON( claim.toJSON() ),
+ baserevid: baseRevId
+ };
+
+ return this._postAndPromiseWithAbstraction( params, function(
result ) {
+ return [
+ wb.Claim.newFromJSON( result.claim ),
+ result.pageinfo
+ ];
+ } );
+ },
+
+ /**
* Creates a claim.
* @todo Needs testing. It would be necessary to create a property for
creating a claim.
* The API does not support setting a data type for an entity at
the moment.
diff --git a/repo/tests/selenium/statements/statements_deleted_prop_spec.rb
b/repo/tests/selenium/statements/statements_deleted_prop_spec.rb
index 1cc767c..41b9eac 100644
--- a/repo/tests/selenium/statements/statements_deleted_prop_spec.rb
+++ b/repo/tests/selenium/statements/statements_deleted_prop_spec.rb
@@ -95,14 +95,17 @@
page.statement1Name.should_not == properties_cm[0]["label"]
page.statement1Name.include?(properties_cm[0]["id"]).should be_true
page.statement1Name.include?("Deleted property").should be_true
- page.editFirstStatement
- page.statementValueInput.should == cm_string
- page.statementValueInput_element.clear
- page.statementValueInput = "changed"
- page.saveStatement
- ajax_wait
- page.wbErrorDiv?.should be_true
- page.cancelStatement
+ # TODO: In contrast to the setclaimvalue API module, the setclaim API
module does not cause
+ # an error when editing a statement that features a deleted property.
Re-evaluate the
+ # following test procedure as soon as this contradiction is solved.
+ #page.editFirstStatement
+ #page.statementValueInput.should == cm_string
+ #page.statementValueInput_element.clear
+ #page.statementValueInput = "changed"
+ #page.saveStatement
+ #ajax_wait
+ #page.wbErrorDiv?.should be_true
+ #page.cancelStatement
page.toggle_reference_section
page.reference1Property.should_not == properties_cm[0]["label"]
page.reference1Property.include?(properties_cm[0]["id"]).should be_true
diff --git a/repo/tests/selenium/statements/statements_spec.rb
b/repo/tests/selenium/statements/statements_spec.rb
index 8806b08..3adfd63 100644
--- a/repo/tests/selenium/statements/statements_spec.rb
+++ b/repo/tests/selenium/statements/statements_spec.rb
@@ -145,8 +145,8 @@
end
it "should check error handling" do
on_page(ItemPage) do |page|
- js_snippet = "wikibase.RepoApi.prototype.createClaim ="+
- "function(entityId,baseRevId,mainSnak){return
this._claimApiCall(baseRevId,mainSnak,{action:'nonexistant',entity:entityId});}"
+ js_snippet = "wikibase.RepoApi.prototype.setClaim ="+
+ "function(claim,baseRevId){var d = new $.Deferred();return
d.reject('some_error_code',{error:{info:'some info'}});}"
page.navigate_to items[0]["url"]
page.wait_for_entity_to_load
@browser.execute_script(js_snippet);
--
To view, visit https://gerrit.wikimedia.org/r/53734
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I952e5b9ce62db6d85439dbb88a1ae9c089859ea8
Gerrit-PatchSet: 6
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Henning Snater <henning.sna...@wikimedia.de>
Gerrit-Reviewer: Daniel Werner <daniel.wer...@wikimedia.de>
Gerrit-Reviewer: Tobias Gritschacher <tobias.gritschac...@wikimedia.de>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
