Merge lp:~jamesh/unity-scopes-api/rating-input-doc-fix into lp:unity-scopes-api

[James Henstridge]

Update docs to explain how the rating and review of a rating-input widget are delivered to the scope.

The documentation for the rating-input preview widget explains that a preview action is fired when the user submits a rating, but it doesn't explain how the rating and review are passed to the scope. This branch addresses that.

[Michi Henning (michihenning)]

Thanks for that!

The "review" entry is obviously a string, but it's not clear what type and values to expect for "rating". Do we need to say what kind of variant to expect and what the possible values are?

review: Needs Information

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:321
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/589/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/123
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/114
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/114/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/115

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/589/rebuild

review: Approve (continuous-integration)

[lp:~jamesh/unity-scopes-api/rating-input-doc-fix]

322. By James Henstridge on 2015-02-24

Document the types in the scope data.

[James Henstridge (jamesh)]

Good point. I've included the types now.

[Michi Henning (michihenning)]

I don't mean to be recalcitrant here. I'm asking because I've never used the rating widget... :-)

So the rating is a double. Is it 0.0 to 5.0? 1.0 to 5.0? Something else?

[lp:~jamesh/unity-scopes-api/rating-input-doc-fix]

323. By James Henstridge on 2015-02-24

Indicate what each value in the VariantMap holds.

[James Henstridge (jamesh)]

I believe it is 1.0 to 5.0 at integer intervals (there is a comment in the click scope complaining about the fact that it isn't an integer).

Branch updated again to make it more explicit and change the formatting a bit so it'll be easier to add extra keys should the widget type ever get them.

[Michi Henning (michihenning)]

Awesome, thank you!

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:322
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/591/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/125
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/116
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/116/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/117

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/591/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:323
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/594/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/128/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/119
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/119/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/120/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/594/rebuild

review: Needs Fixing (continuous-integration)

[Michi Henning (michihenning)]

Thank you Mr Jenkins! James edited a comment, and our build failed.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:323
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/600/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/134
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/125
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/125/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/126

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/600/rebuild

review: Approve (continuous-integration)

[Paweł Stołowski (stolowski)]

Could you please target it at devel?

review: Needs Fixing

Unmerged revisions

=== modified file 'src/scopes/PreviewWidget.cpp'
--- src/scopes/PreviewWidget.cpp	2015-01-07 23:03:50 +0000
+++ src/scopes/PreviewWidget.cpp	2015-02-24 10:45:50 +0000
@@ -288,7 +288,14 @@
 a star-based rating and an input field for the user to enter his/her review.
 It is possible to hide each widget as well as to require them to be filled in.
 
-When a user presses the "Send" button, the scope receives a preview action activation with the id \c "rated".
+When a user presses the "Send" button, the scope receives a preview
+action activation with the id \c "rated".  The actual rating and/or
+review can be accessed via unity::scopes::ActionMetadata::scope_data.
+The scope data will be a VariantMap with the following keys:
+
+  - \c "rating" - a double holding the number of stars the user
+    selected (1 to 5)
+  - \c "review" - a string holding the free text review
 
 List of attributes: