Merge lp:~stolowski/unity-scopes-api/canned-query-data into lp:unity-scopes-api

[Paweł Stołowski]

Added support for attaching arbitrary variant data to canned queries.

Added support for attaching arbitrary variant data to canned queries.

Note: needs changes in shell-plugin, therefore keeping not marking it ready yet.

[lp:~stolowski/unity-scopes-api/canned-query-data]

308. By Paweł Stołowski on 2015-02-24

Merged trunk

309. By Paweł Stołowski on 2015-02-25

Provide overloaded Scope::search method for passing arbitrary data.

310. By Paweł Stołowski on 2015-02-25

Updated symbols.

311. By Paweł Stołowski on 2015-02-25

Merged qt-coverage.

312. By Paweł Stołowski on 2015-02-25

Updated symbols.

313. By Paweł Stołowski on 2015-02-25

Support passing query data via subsearch() methods of SearchQueryBase.

314. By Paweł Stołowski on 2015-02-26

Implemented copy assignment operator. Renamed *data* to user_data.

315. By Paweł Stołowski on 2015-02-26

data -> user_data also in deserialize.

316. By Paweł Stołowski on 2015-02-26

More tests.

317. By Paweł Stołowski on 2015-02-26

Two more test cases.

318. By Paweł Stołowski on 2015-02-26

Updated doc of CannedQuery.

319. By Paweł Stołowski on 2015-02-26

Test for move.

320. By Paweł Stołowski on 2015-02-26

Updated symbols.

321. By Paweł Stołowski on 2015-02-27

Merged qt-coverage.

322. By Paweł Stołowski on 2015-02-27

Merged symbols fix.

323. By Paweł Stołowski on 2015-02-27

Fixed assignment copy/move tests.

324. By Paweł Stołowski on 2015-03-02

Renamed query_data -> user_data

Unmerged revisions

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-02-13 09:20:20 +0000
+++ CMakeLists.txt	2015-02-24 12:29:15 +0000
@@ -227,7 +227,7 @@
 # API version
 set(UNITY_SCOPES_MAJOR 0)
 set(UNITY_SCOPES_MINOR 6)
-set(UNITY_SCOPES_MICRO 14)
+set(UNITY_SCOPES_MICRO 15)
 set(UNITY_SCOPES_SOVERSION 3)
 
 # Version for testing, with all symbols visible

=== modified file 'RELEASE_NOTES.md'
--- RELEASE_NOTES.md	2015-02-13 09:20:20 +0000
+++ RELEASE_NOTES.md	2015-02-24 12:29:15 +0000
@@ -1,6 +1,10 @@
 Release notes
 =============
 
+Changes in version 0.6.15
+=========================
+  - Added support for attaching arbitrary data to CannedQuery.
+
 Changes in version 0.6.14
 =========================
   - Added push_surfacing_results_from_cache() to Reply proxy. This allows a scope

=== modified file 'STRUCTS'
--- STRUCTS	2015-01-28 09:03:59 +0000
+++ STRUCTS	2015-02-24 12:29:15 +0000
@@ -177,3 +177,11 @@
 ========================================
   all QueryMetadata attributes
   'scope_data'  : variant
+
+CannedQuery (returned by serialize())
+=====================================
+ 'scope'         : string
+ 'query_string'  : string
+ 'department_id' : string
+ 'filter_state'  : variant
+ 'data'          : variant (optional)

=== modified file 'debian/changelog'
--- debian/changelog	2015-02-23 14:48:28 +0000
+++ debian/changelog	2015-02-24 12:29:15 +0000
@@ -1,3 +1,9 @@
+unity-scopes-api (0.6.15-0ubuntu1) UNRELEASED; urgency=medium
+
+  * Added support for attaching arbitrary data to CannedQuery.
+
+ -- Pawel Stolowski <[e-mail]>  Tue, 24 Feb 2015 13:27:37 +0100
+
 unity-scopes-api (0.6.14+15.04.20150223-0ubuntu1) vivid; urgency=medium
 
   [ Pawel Stolowski ]

=== modified file 'include/unity/scopes/CannedQuery.h'
--- include/unity/scopes/CannedQuery.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/CannedQuery.h	2015-02-24 12:29:15 +0000
@@ -133,6 +133,28 @@
     */
     static CannedQuery from_uri(std::string const& uri);
 
+    /**
+    \brief Attach arbitrary data.
+
+    \param value Data to attach to this canned query
+    */
+    void set_data(Variant const& value);
+
+    /**
+    \brief Checks if data has been attached to this query.
+
+    \return true if data is available.
+    */
+    bool has_data() const;
+
+    /**
+    \brief Get data attached to this query.
+
+    \return Data variant
+    \throws unity::LogicException if data is not available.
+    */
+    Variant data() const;
+
 private:
     CannedQuery(internal::CannedQueryImpl *impl);
     std::unique_ptr<internal::CannedQueryImpl> p;

=== modified file 'include/unity/scopes/internal/CannedQueryImpl.h'
--- include/unity/scopes/internal/CannedQueryImpl.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/internal/CannedQueryImpl.h	2015-02-24 12:29:15 +0000
@@ -40,7 +40,7 @@
     explicit CannedQueryImpl(std::string const& scope_id);
     CannedQueryImpl(std::string const& scope_id, std::string const& query_str, std::string const& department_id);
     CannedQueryImpl(VariantMap const& variant);
-    CannedQueryImpl(CannedQueryImpl const &other) = default;
+    CannedQueryImpl(CannedQueryImpl const &other);
     CannedQueryImpl(CannedQueryImpl&&) = default;
     CannedQueryImpl& operator=(CannedQueryImpl const& other) = default;
     CannedQueryImpl& operator=(CannedQueryImpl&&) = default;
@@ -56,6 +56,9 @@
     std::string to_uri() const;
     static CannedQuery from_uri(std::string const& uri);
     static CannedQuery create(VariantMap const& var);
+    void set_data(Variant const& value);
+    bool has_data() const;
+    Variant data() const;
 
     static const std::string scopes_schema;
 
@@ -65,6 +68,7 @@
     std::string query_string_;
     std::string department_id_;
     FilterState filter_state_;
+    std::unique_ptr<Variant> data_;
 };
 
 } // namespace internal

=== modified file 'include/unity/scopes/qt/QCannedQuery.h'
--- include/unity/scopes/qt/QCannedQuery.h	2015-02-06 00:12:18 +0000
+++ include/unity/scopes/qt/QCannedQuery.h	2015-02-24 12:29:15 +0000
@@ -142,6 +142,21 @@
     */
     static QCannedQuery from_uri(QString const& uri);
 
+    /**
+    \brief Checks if data has been attached to this query.
+
+    \return true if data is available.
+    */
+    bool has_data() const;
+
+    /**
+    \brief Get data attached to this query.
+
+    \return Data variant
+    \throws unity::LogicException if data is not available.
+    */
+    QVariant data() const;
+
 private:
     QCannedQuery(internal::QCannedQueryImpl* impl);
     QCannedQuery(CannedQuery const& api_query);

=== modified file 'include/unity/scopes/qt/internal/QCannedQueryImpl.h'
--- include/unity/scopes/qt/internal/QCannedQueryImpl.h	2015-02-06 00:12:18 +0000
+++ include/unity/scopes/qt/internal/QCannedQueryImpl.h	2015-02-24 12:29:15 +0000
@@ -70,6 +70,8 @@
     FilterState filter_state() const;
     QVariantMap serialize() const;
     QString to_uri() const;
+    bool has_data() const;
+    QVariant data() const;
     static QCannedQuery from_uri(QString const& uri);
 
     // added for testing purposes

=== modified file 'src/scopes/CannedQuery.cpp'
--- src/scopes/CannedQuery.cpp	2014-04-11 12:04:41 +0000
+++ src/scopes/CannedQuery.cpp	2015-02-24 12:29:15 +0000
@@ -113,6 +113,21 @@
     return internal::CannedQueryImpl::from_uri(uri);
 }
 
+void CannedQuery::set_data(Variant const& value)
+{
+    p->set_data(value);
+}
+
+bool CannedQuery::has_data() const
+{
+    return p->has_data();
+}
+
+Variant CannedQuery::data() const
+{
+    return p->data();
+}
+
 } // namespace scopes
 
 } // namespace unity

=== modified file 'src/scopes/internal/CannedQueryImpl.cpp'
--- src/scopes/internal/CannedQueryImpl.cpp	2014-12-01 08:26:52 +0000
+++ src/scopes/internal/CannedQueryImpl.cpp	2015-02-24 12:29:15 +0000
@@ -56,6 +56,18 @@
     }
 }
 
+CannedQueryImpl::CannedQueryImpl(CannedQueryImpl const &other)
+{
+    scope_id_ = other.scope_id_;
+    query_string_ = other.query_string_;
+    department_id_ = other.department_id_;
+    filter_state_ = other.filter_state_;
+    if (other.data_ != nullptr)
+    {
+        data_.reset(new Variant(*other.data_));
+    }
+}
+
 CannedQueryImpl::CannedQueryImpl(VariantMap const& variant)
 {
     auto it = variant.find("scope");
@@ -87,6 +99,12 @@
     {
         query_string_ = it->second.get_string();
     }
+
+    it = variant.find("data");
+    if (it != variant.end())
+    {
+        set_data(it->second);
+    }
 }
 
 void CannedQueryImpl::set_department_id(std::string const& dep_id)
@@ -124,6 +142,25 @@
     return filter_state_;
 }
 
+void CannedQueryImpl::set_data(Variant const& value)
+{
+    data_.reset(new Variant(value));
+}
+
+bool CannedQueryImpl::has_data() const
+{
+    return data_ != nullptr;
+}
+
+Variant CannedQueryImpl::data() const
+{
+    if (data_)
+    {
+        return *data_;
+    }
+    throw unity::LogicException("CannedQuery::data(): data is not set for this query");
+}
+
 VariantMap CannedQueryImpl::serialize() const
 {
     VariantMap vm;
@@ -131,6 +168,10 @@
     vm["query_string"] = query_string_;
     vm["department_id"] = department_id_;
     vm["filter_state"] = filter_state_.serialize();
+    if (data_)
+    {
+        vm["data"] = *data_;
+    }
     return vm;
 }
 
@@ -152,6 +193,11 @@
         internal::JsonCppNode const jstr(var);
         s << "&filters=" << to_percent_encoding(jstr.to_json_string());
     }
+    if (data_)
+    {
+        internal::JsonCppNode const jstr(*(data_));
+        s << "&data=" << to_percent_encoding(jstr.to_json_string());
+    }
     return s.str();
 }
 
@@ -231,7 +277,14 @@
                         s << "CannedQuery::from_uri(): invalid filters data for uri: '" << uri << "'";
                         throw InvalidArgumentException(s.str());
                     }
-                } // else - unknown keys are ignored
+                }
+                else if (key == "data")
+                {
+                    auto const data_json = decode_or_throw(val, key, uri);
+                    internal::JsonCppNode const node(data_json);
+                    q.set_data(node.to_variant());
+                }
+                // else - unknown keys are ignored
             } // else - the string with no '=' is ignored
         }
     }

=== modified file 'src/scopes/qt/QCannedQuery.cpp'
--- src/scopes/qt/QCannedQuery.cpp	2015-01-20 13:59:36 +0000
+++ src/scopes/qt/QCannedQuery.cpp	2015-02-24 12:29:15 +0000
@@ -116,3 +116,13 @@
 {
     return internal::QCannedQueryImpl::from_uri(uri);
 }
+
+bool QCannedQuery::has_data() const
+{
+    return p->has_data();
+}
+
+QVariant QCannedQuery::data() const
+{
+    return p->data();
+}

=== modified file 'src/scopes/qt/internal/QCannedQueryImpl.cpp'
--- src/scopes/qt/internal/QCannedQueryImpl.cpp	2015-01-26 14:13:31 +0000
+++ src/scopes/qt/internal/QCannedQueryImpl.cpp	2015-02-24 12:29:15 +0000
@@ -81,6 +81,16 @@
     return api_query_->filter_state();
 }
 
+bool QCannedQueryImpl::has_data() const
+{
+    return api_query_->has_data();
+}
+
+QVariant QCannedQueryImpl::data() const
+{
+    return scopeVariantToQVariant(api_query_->data());
+}
+
 QVariantMap QCannedQueryImpl::serialize() const
 {
     return scopeVariantMapToQVariantMap(api_query_->serialize());

=== modified file 'test/gtest/scopes/CannedQuery/CannedQuery_test.cpp'
--- test/gtest/scopes/CannedQuery/CannedQuery_test.cpp	2014-12-01 13:10:08 +0000
+++ test/gtest/scopes/CannedQuery/CannedQuery_test.cpp	2015-02-24 12:29:15 +0000
@@ -39,9 +39,13 @@
         CannedQuery q("scope-A");
         q.set_query_string("foo");
         q.set_department_id("dep1");
+        VariantArray va({Variant(10), Variant(20)});
+        q.set_data(Variant(va));
         EXPECT_EQ("scope-A", q.scope_id());
         EXPECT_EQ("foo", q.query_string());
         EXPECT_EQ("dep1", q.department_id());
+        EXPECT_EQ(10, q.data().get_array()[0].get_int());
+        EXPECT_EQ(20, q.data().get_array()[1].get_int());
     }
 }
 
@@ -86,6 +90,13 @@
     }
     {
         CannedQuery q("scope-A");
+        q.set_query_string("foo");
+        q.set_department_id("dep1");
+        q.set_data(Variant(123));
+        EXPECT_EQ("scope://scope-A?q=foo&dep=dep1&data=123%0A", q.to_uri());
+    }
+    {
+        CannedQuery q("scope-A");
         EXPECT_EQ("scope://scope-A?q=", q.to_uri());
     }
     {
@@ -208,6 +219,13 @@
         EXPECT_EQ("Foo bar", q.query_string());
         EXPECT_EQ("a bc", q.department_id());
     }
+    {
+        auto q = CannedQuery::from_uri("scope://foo?q=Foo&data=%22bar%22%0A");
+        EXPECT_EQ("foo", q.scope_id());
+        EXPECT_EQ("Foo", q.query_string());
+        EXPECT_EQ("bar", q.data().get_string());
+    }
+
     // percent-encoded host supported for backwards compatibility
     {
         auto q = CannedQuery::from_uri("scope://com%2Ecanonical%2Escope%2Efoo?q=Foo&filters=%7B%22f1%22%3A%5B%22o1%22%5D%7D");
@@ -308,4 +326,10 @@
             FAIL();
         }
     }
+
+    // no data
+    {
+        CannedQuery q("fooscope");
+        EXPECT_THROW(q.data(), unity::LogicException);
+    }
 }