Merge lp:~unity-api-team/unity-scopes-api/child-scopes-option into lp:unity-scopes-api/devel

[Paweł Stołowski]

Added ChildScopes config option to declare ids of aggregated scopes (for aggregators).

Added ChildScopes config option to declare ids of aggregated scopes (for aggregators). This is exposed via ScopeMetadata and will be used by shell plugin.

[Marcus Tomlinson (marcustomlinson)]

Looks good. Could you just add a short explanation of how to use this field in CONFIGFILES.

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:502
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1197/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-amd64-ci/755/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/750/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-i386-ci/749/console

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

review: Needs Fixing (continuous-integration)

[lp:~unity-api-team/unity-scopes-api/child-scopes-option]

503. By Paweł Stołowski on 2014-10-03

Updated symbols.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:503
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1198/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-amd64-ci/756
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/751
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/751/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-i386-ci/750

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

review: Approve (continuous-integration)

[lp:~unity-api-team/unity-scopes-api/child-scopes-option]

504. By Paweł Stołowski on 2014-10-06

Added ChildScopes to CONFFILES.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:504
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1201/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-amd64-ci/759
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/754
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/754/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-i386-ci/753

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

review: Approve (continuous-integration)

[Michi Henning (michihenning)]

A few comments:

The tutorial needs updating for the new config attribute. It needs to mention that this is an array setting, with semicolon as the separator. It should also say what the attribute is used for. (The scope author needs be aware of the consequences of forgetting to mention a child scope in this list.)

241 + string child_str = parser()->get_string(scope_config_group, child_scope_ids_key);
...
280 +std::vector<std::string> ScopeConfig::parse_scope_ids(std::string const& val)

We don't need this. The IniParser has a method get_string_array() that splits an array attribute into its components automatically. The separator used in .ini files is semicolon (instead of comma). We should use this because it maintains the established syntax for .ini files and also makes all the code in parse_scope_ids() redundant.

It would be good to have test for a zero-element and a single-element array of child scopes too, just to be sure that the code behaves sanely if someone does something silly in their config file.

24 + should be spearated by commas.

There is a typo here: "spearated". Also it needs to say "semicolons" (see above).

Use "must" instead of "should". If we say "should", that suggests that it's OK to use something other than commas. Also, the ini parser preserves whitespace for string array elements, so it would be good to show an example. Something along the lines of:

ChildScopes = com.acme.scopeX;com.acme.scopeY

Somewhat stupidly, the ini parser strips leading whitespace, but not trailing whitespace:

ChildScopes = a;b;c

If there is a single trailing space on that line, the values of the array elements are "a", "b", and "c " :-(

It might be a nice touch to warn about trailing whitespace in the doc.

131 + \brief Return the list of scope identifiers aggregated by this scope.
132 + The list returned by this method comes from the .ini file and it's up

We need a newline after the first sentence, otherwise the entire para becomes part of the summary.

I recommend to avoid contractions ("it's") in the documentation. Contractions are usually shunned in formal documentation. Even better, make it two sentences:

"The list returned by this method is taken from the scope's `.ini` file. The scope author must ensure that it contains all scopes that an aggregator might collect results from."

134 + scopes which are not currently installed and are optional for proper functioning

This should be "scopes *that* are not currently installed" (because this is a defining relative clause.)

review: Needs Fixing

[lp:~unity-api-team/unity-scopes-api/child-scopes-option]

505. By Paweł Stołowski on 2014-10-22

Merged trunk.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:505
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1240/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-amd64-ci/798
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/793
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/793/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-i386-ci/792

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

review: Approve (continuous-integration)

[lp:~unity-api-team/unity-scopes-api/child-scopes-option]

506. By Paweł Stołowski on 2014-10-22

Use built-in array support from ini parser.

507. By Paweł Stołowski on 2014-10-22

Updated docs.

508. By Paweł Stołowski on 2014-10-22

Added test for empty ChildScopes value.

509. By Paweł Stołowski on 2014-10-22

Added test for single child.

510. By Paweł Stołowski on 2014-10-22

Minor doc update.y

511. By Paweł Stołowski on 2014-10-22

Removed empty lines.

512. By Paweł Stołowski on 2014-10-22

Merged devel.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:510
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1243/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-amd64-ci/801/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/796/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-i386-ci/795/console

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

review: Needs Fixing (continuous-integration)

[lp:~unity-api-team/unity-scopes-api/child-scopes-option]

513. By Paweł Stołowski on 2014-10-22

Fix test.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:512
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1245/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-amd64-ci/803/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/798/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-i386-ci/797/console

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

review: Needs Fixing (continuous-integration)

[lp:~unity-api-team/unity-scopes-api/child-scopes-option]

514. By Paweł Stołowski on 2014-10-22

Updated symbols.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:514
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1247/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-amd64-ci/805
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/800
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/800/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-i386-ci/799

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

review: Approve (continuous-integration)

[lp:~unity-api-team/unity-scopes-api/child-scopes-option]

515. By Paweł Stołowski on 2014-10-23

Merged devel.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:515
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1250/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-amd64-ci/808
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/803
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-armhf-ci/803/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-utopic-i386-ci/802/console

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

review: Needs Fixing (continuous-integration)

[lp:~unity-api-team/unity-scopes-api/child-scopes-option]

516. By Paweł Stołowski on 2014-10-24

Fixed typo in tutorial.

[Michi Henning (michihenning)]

LGTM, thanks!

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'CONFIGFILES'
--- CONFIGFILES	2014-10-10 07:01:36 +0000
+++ CONFIGFILES	2014-10-24 15:41:48 +0000
@@ -327,6 +327,15 @@
 
   The hot key for the scope. The default value is the empty string.
 
+- ChildScopes
+
+  The list of ids of scopes aggregated by this scope (if any). The values in this list
+  must be separated by semicolons. This list is translated to the names of
+  children scopes when in the scopes overview page of the Unity Dash.
+
+  Note: make sure there are no trailing spaces following
+  the ids, as they will be preserved.
+
 - Invisible
 
   Whether the scope is hidden in the UI. The default value is false.

=== modified file 'RELEASE_NOTES.md'
--- RELEASE_NOTES.md	2014-10-22 15:46:36 +0000
+++ RELEASE_NOTES.md	2014-10-24 15:41:48 +0000
@@ -3,6 +3,7 @@
 
 Changes in version 0.6.8
 ========================
+  - Added support for ChildScopes scope .ini option to list scopes ids of aggregated scopes.
   - Replaced dbus-send with "list updated" pub/sub to invalidate smart scopes.
 
 Changes in version 0.6.7

=== modified file 'STRUCTS'
--- STRUCTS	2014-09-25 08:33:58 +0000
+++ STRUCTS	2014-10-24 15:41:48 +0000
@@ -77,6 +77,7 @@
  'results_ttl_type'      : int, optional
  'settings_definitions'  : dictionary, optional
  'location_data_needed'  : bool, optional
+ 'child_scopes'          : array of strings, optional
 
 Query (returned by serialize())
 ===============================

=== modified file 'debian/changelog'
--- debian/changelog	2014-10-22 23:06:48 +0000
+++ debian/changelog	2014-10-24 15:41:48 +0000
@@ -1,8 +1,9 @@
 unity-scopes-api (0.6.8-0ubuntu1) UNRELEASED; urgency=medium
 
+  * Added support for ChildScopes scope .ini option.
   * Replaced dbus-send with "list updated" pub/sub to invalidate smart scopes.
 
- -- Marcus Tomlinson <[e-mail]>  Wed, 22 Oct 2014 17:44:46 +0200
+ -- Pawel Stolowski <[e-mail]>  Wed, 22 Oct 2014 12:00:44 -0400
 
 unity-scopes-api (0.6.7+14.10.20141014-0ubuntu1) 14.09; urgency=low
 

=== modified file 'debian/libunity-scopes3.symbols'
--- debian/libunity-scopes3.symbols	2014-10-22 19:42:17 +0000
+++ debian/libunity-scopes3.symbols	2014-10-24 15:41:48 +0000
@@ -437,6 +437,7 @@
  (c++)"unity::scopes::internal::ScopeConfig::appearance_attributes() const@Base" 0.4.2+14.04.20140404.2
  (c++)"unity::scopes::internal::ScopeConfig::art() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeConfig::author() const@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::ScopeConfig::child_scope_ids() const@Base" 0replaceme
  (c++)"unity::scopes::internal::ScopeConfig::debug_mode() const@Base" 0.6.2+rtm+rtm+rtm+14.09.20140818
  (c++)"unity::scopes::internal::ScopeConfig::description() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeConfig::display_name() const@Base" 0.4.0+14.04.20140312.1
@@ -475,6 +476,7 @@
  (c++)"unity::scopes::internal::ScopeMetadataImpl::appearance_attributes() const@Base" 0.4.2+14.04.20140404.2
  (c++)"unity::scopes::internal::ScopeMetadataImpl::art() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeMetadataImpl::author() const@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::ScopeMetadataImpl::child_scope_ids() const@Base" 0replaceme
  (c++)"unity::scopes::internal::ScopeMetadataImpl::create(std::unique_ptr<unity::scopes::internal::ScopeMetadataImpl, std::default_delete<unity::scopes::internal::ScopeMetadataImpl> >)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeMetadataImpl::description() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeMetadataImpl::deserialize(std::map<std::basic_string<char, std::char_traits<char>, std::allocator<char> >, unity::scopes::Variant, std::less<std::basic_string<char, std::char_traits<char>, std::allocator<char> > >, std::allocator<std::pair<std::basic_string<char, std::char_traits<char>, std::allocator<char> > const, unity::scopes::Variant> > > const&)@Base" 0.4.0+14.04.20140312.1
@@ -496,6 +498,7 @@
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_appearance_attributes(std::map<std::basic_string<char, std::char_traits<char>, std::allocator<char> >, unity::scopes::Variant, std::less<std::basic_string<char, std::char_traits<char>, std::allocator<char> > >, std::allocator<std::pair<std::basic_string<char, std::char_traits<char>, std::allocator<char> > const, unity::scopes::Variant> > > const&)@Base" 0.4.2+14.04.20140404.2
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_art(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_author(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::ScopeMetadataImpl::set_child_scope_ids(std::vector<std::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::basic_string<char, std::char_traits<char>, std::allocator<char> > > > const&)@Base" 0replaceme
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_description(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_display_name(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_hot_key(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
@@ -756,6 +759,7 @@
  (c++)"unity::scopes::ScopeMetadata::appearance_attributes() const@Base" 0.4.2+14.04.20140404.2
  (c++)"unity::scopes::ScopeMetadata::art() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::ScopeMetadata::author() const@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::ScopeMetadata::child_scope_ids() const@Base" 0replaceme
  (c++)"unity::scopes::ScopeMetadata::description() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::ScopeMetadata::display_name() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::ScopeMetadata::hot_key() const@Base" 0.4.0+14.04.20140312.1

=== modified file 'doc/tutorial.dox'
--- doc/tutorial.dox	2014-09-15 12:43:47 +0000
+++ doc/tutorial.dox	2014-10-24 15:41:48 +0000
@@ -1032,6 +1032,7 @@
     SearchHint = hint text displayed to user when viewing scope
     HotKey =
     ResultsTtlType = None, Small, Medium, or Large
+    ChildScopes =
 
     [Appearance]
     ForegroundColor = default text color (defaults to theme-provided foreground color)
@@ -1065,6 +1066,13 @@
 <li>http://remote-server.com/path/to/image</li>
 </ul>
 
+The value of `ChildScopes` key is to be used by aggregator scopes. It must be a semicolon separated list of scope identifiers that
+might be aggregated by this scope, for example:
+
+`ChildScopes = com.foo.bar;com.foo.bar2`
+
+This list of scopes is translated to the names of children scopes when in the scopes overview page of the Unity Dash.
+
 \subsection scopetool The scope tool
 
 The Unity Scope Tool is a stand-alone redering tool that allows you

=== modified file 'include/unity/scopes/ScopeMetadata.h'
--- include/unity/scopes/ScopeMetadata.h	2014-08-12 09:38:31 +0000
+++ include/unity/scopes/ScopeMetadata.h	2014-10-24 15:41:48 +0000
@@ -20,6 +20,7 @@
 #define UNITY_SCOPES_SCOPEMETADATA_H
 
 #include <unity/scopes/Scope.h>
+#include <vector>
 
 namespace unity
 {
@@ -183,6 +184,18 @@
     */
     bool location_data_needed() const;  // optional (default = false)
 
+    /**
+    \brief Return the list of scope identifiers aggregated by this scope.
+
+    The list returned by this method comes from the .ini file.
+    The scope author must ensure that it contains all scopes that an aggregator
+    might collect results from. This list may contain scopes that are not currently
+    installed and are optional for proper functioning of the aggregator scope.
+
+    \return The list of scopes ids aggregated by this scope.
+    */
+    std::vector<std::string> child_scope_ids() const;
+
 private:
     ScopeMetadata(std::unique_ptr<internal::ScopeMetadataImpl>);           // Instantiable only by ScopeMetadataImpl
     std::unique_ptr<internal::ScopeMetadataImpl> p;

=== modified file 'include/unity/scopes/internal/ScopeConfig.h'
--- include/unity/scopes/internal/ScopeConfig.h	2014-08-11 12:08:44 +0000
+++ include/unity/scopes/internal/ScopeConfig.h	2014-10-24 15:41:48 +0000
@@ -53,6 +53,7 @@
     int idle_timeout() const;              // Optional, returns default value if not present
     ScopeMetadata::ResultsTtlType results_ttl_type() const;  // Optional, returns none if not present
     bool debug_mode() const;               // Optional, returns false if not present
+    std::vector<std::string> child_scope_ids() const;
 
     VariantMap appearance_attributes() const; // Optional, returns empty map if no attributes are present
 
@@ -73,6 +74,7 @@
     int idle_timeout_;
     ScopeMetadata::ResultsTtlType results_ttl_type_;
     bool debug_mode_;
+    std::vector<std::string> child_scope_ids_;
 
     VariantMap appearance_attributes_;
 };

=== modified file 'include/unity/scopes/internal/ScopeMetadataImpl.h'
--- include/unity/scopes/internal/ScopeMetadataImpl.h	2014-08-12 09:38:31 +0000
+++ include/unity/scopes/internal/ScopeMetadataImpl.h	2014-10-24 15:41:48 +0000
@@ -58,6 +58,7 @@
     ScopeMetadata::ResultsTtlType results_ttl_type() const;      // optional (default: none)
     VariantArray settings_definitions() const;                   // optional (default: empty array)
     bool location_data_needed() const;                           // optional (default: false)
+    std::vector<std::string> child_scope_ids() const;            // optional (default: empty array)
 
     void set_scope_id(std::string const& scope_id);
     void set_proxy(ScopeProxy const& proxy);
@@ -74,6 +75,7 @@
     void set_results_ttl_type(ScopeMetadata::ResultsTtlType results_ttl);
     void set_settings_definitions(VariantArray const& settings_definitions);
     void set_location_data_needed(bool location_data_needed);
+    void set_child_scope_ids(std::vector<std::string> const& ids);
 
     VariantMap serialize() const;
     void deserialize(VariantMap const& var);
@@ -98,6 +100,7 @@
     ScopeMetadata::ResultsTtlType results_ttl_type_;
     std::unique_ptr<VariantArray> settings_definitions_;  // Optional, hence a pointer
     std::unique_ptr<bool> location_data_needed_;          // Optional, hence a pointer
+    std::vector<std::string> child_scope_ids_;
 };
 
 } // namespace internal

=== modified file 'scoperegistry/scoperegistry.cpp'
--- scoperegistry/scoperegistry.cpp	2014-10-16 13:31:25 +0000
+++ scoperegistry/scoperegistry.cpp	2014-10-24 15:41:48 +0000
@@ -315,6 +315,7 @@
     mi->set_author(sc.author());
     mi->set_invisible(sc.invisible());
     mi->set_appearance_attributes(sc.appearance_attributes());
+    mi->set_child_scope_ids(sc.child_scope_ids());
 
     // Prepend scope_dir to pageheader logo path if logo path is relative.
     // TODO: Once we have type-safe parsing in the config files, remove

=== modified file 'src/scopes/ScopeMetadata.cpp'
--- src/scopes/ScopeMetadata.cpp	2014-08-12 09:38:31 +0000
+++ src/scopes/ScopeMetadata.cpp	2014-10-24 15:41:48 +0000
@@ -147,6 +147,11 @@
     return p->location_data_needed();
 }
 
+std::vector<std::string> ScopeMetadata::child_scope_ids() const
+{
+    return p->child_scope_ids();
+}
+
 //! @endcond
 
 } // namespace scopes

=== modified file 'src/scopes/internal/ScopeConfig.cpp'
--- src/scopes/internal/ScopeConfig.cpp	2014-08-11 12:08:44 +0000
+++ src/scopes/internal/ScopeConfig.cpp	2014-10-24 15:41:48 +0000
@@ -56,6 +56,7 @@
     const string idle_timeout_key = "IdleTimeout";
     const string results_ttl_key = "ResultsTtlType";
     const string debug_mode_key = "DebugMode";
+    const string child_scope_ids_key = "ChildScopes";
 
     const string scope_appearance_group = "Appearance";
     const string fg_color_key = "ForegroundColor";
@@ -192,6 +193,22 @@
 
     try
     {
+        child_scope_ids_ = parser()->get_string_array(scope_config_group, child_scope_ids_key);
+    }
+    catch (LogicException const&)
+    {
+    }
+
+    for (auto const& id: child_scope_ids_)
+    {
+        if (id.size() == 0)
+        {
+            throw_ex("Invalid empty scope id for ChildScopes");
+        }
+    }
+
+    try
+    {
         debug_mode_ = parser()->get_boolean(scope_config_group, debug_mode_key);
     }
     catch (LogicException const&)
@@ -227,7 +244,8 @@
                scoperunner_key,
                idle_timeout_key,
                results_ttl_key,
-               debug_mode_key
+               debug_mode_key,
+               child_scope_ids_key
            }
         },
         {  scope_appearance_group,
@@ -401,6 +419,11 @@
     return appearance_attributes_;
 }
 
+std::vector<std::string> ScopeConfig::child_scope_ids() const
+{
+    return child_scope_ids_;
+}
+
 } // namespace internal
 
 } // namespace scopes

=== modified file 'src/scopes/internal/ScopeMetadataImpl.cpp'
--- src/scopes/internal/ScopeMetadataImpl.cpp	2014-08-18 08:12:22 +0000
+++ src/scopes/internal/ScopeMetadataImpl.cpp	2014-10-24 15:41:48 +0000
@@ -57,6 +57,7 @@
     , author_(other.author_)
     , appearance_attributes_(other.appearance_attributes_)
     , results_ttl_type_(other.results_ttl_type_)
+    , child_scope_ids_(other.child_scope_ids_)
 {
     if (other.art_)
     {
@@ -112,6 +113,7 @@
         results_ttl_type_ = rhs.results_ttl_type_;
         settings_definitions_.reset(rhs.settings_definitions_ ? new VariantArray(*rhs.settings_definitions_) : nullptr);
         location_data_needed_.reset(rhs.location_data_needed_ ? new bool(*rhs.location_data_needed_) : nullptr);
+        child_scope_ids_ = rhs.child_scope_ids_;
     }
     return *this;
 }
@@ -223,6 +225,11 @@
     return false;
 }
 
+std::vector<std::string> ScopeMetadataImpl::child_scope_ids() const
+{
+    return child_scope_ids_;
+}
+
 void ScopeMetadataImpl::set_scope_id(std::string const& scope_id)
 {
     scope_id_ = scope_id;
@@ -298,6 +305,11 @@
     location_data_needed_.reset(new bool(location_data_needed));
 }
 
+void ScopeMetadataImpl::set_child_scope_ids(std::vector<std::string> const& ids)
+{
+    child_scope_ids_ = ids;
+}
+
 namespace
 {
 
@@ -373,6 +385,15 @@
     {
         var["location_data_needed"] = *location_data_needed_;
     }
+    if (child_scope_ids_.size())
+    {
+        VariantArray va;
+        for (auto const& sid: child_scope_ids_)
+        {
+            va.push_back(Variant(sid));
+        }
+        var["child_scopes"] = Variant(va);
+    }
 
     return var;
 }
@@ -494,6 +515,16 @@
     {
         location_data_needed_.reset(new bool(it->second.get_bool()));
     }
+
+    child_scope_ids_.clear();
+    it = var.find("child_scopes");
+    if (it != var.end())
+    {
+        for (auto const& v: it->second.get_array())
+        {
+            child_scope_ids_.push_back(v.get_string());
+        }
+    }
 }
 
 ScopeMetadata ScopeMetadataImpl::create(unique_ptr<ScopeMetadataImpl> impl)

=== modified file 'test/gtest/scopes/Registry/Registry_test.cpp'
--- test/gtest/scopes/Registry/Registry_test.cpp	2014-09-23 08:33:51 +0000
+++ test/gtest/scopes/Registry/Registry_test.cpp	2014-10-24 15:41:48 +0000
@@ -104,6 +104,10 @@
     EXPECT_EQ("boolean", defs[1].get_dict()["type"].get_string());
     EXPECT_EQ(true, defs[1].get_dict()["defaultValue"].get_bool());
     EXPECT_TRUE(meta.location_data_needed());
+    auto children = meta.child_scope_ids();
+    EXPECT_EQ(2u, children.size());
+    EXPECT_EQ("com.foo.bar", children[0]);
+    EXPECT_EQ("com.foo.baz", children[1]);
 
     auto attrs = meta.appearance_attributes();
     EXPECT_EQ("fg_color", attrs["foreground-color"].get_string());
@@ -134,6 +138,7 @@
     defs = meta.settings_definitions();
     EXPECT_EQ(0, defs.size());
     EXPECT_FALSE(meta.location_data_needed());
+    EXPECT_EQ(0, meta.child_scope_ids().size());
 }
 
 auto const wait_time = std::chrono::milliseconds(1000);

=== modified file 'test/gtest/scopes/Registry/scopes/testscopeA/testscopeA.ini.in'
--- test/gtest/scopes/Registry/scopes/testscopeA/testscopeA.ini.in	2014-07-24 13:08:48 +0000
+++ test/gtest/scopes/Registry/scopes/testscopeA/testscopeA.ini.in	2014-10-24 15:41:48 +0000
@@ -7,6 +7,7 @@
 SearchHint = scope-A.SearchHint
 HotKey = scope-A.HotKey
 LocationDataNeeded = true
+ChildScopes = com.foo.bar;com.foo.baz
 
 [Appearance]
 ForegroundColor = fg_color

=== modified file 'test/gtest/scopes/internal/ScopeConfig/CMakeLists.txt'
--- test/gtest/scopes/internal/ScopeConfig/CMakeLists.txt	2014-07-22 08:02:32 +0000
+++ test/gtest/scopes/internal/ScopeConfig/CMakeLists.txt	2014-10-24 15:41:48 +0000
@@ -4,12 +4,18 @@
 configure_file(ttl_medium.ini.in ttl_medium.ini copyonly)
 configure_file(bad_timeout.ini.in bad_timeout.ini copyonly)
 configure_file(bad_ttl.ini.in bad_ttl.ini copyonly)
+configure_file(bad_child_ids.ini.in bad_child_ids.ini copyonly)
+configure_file(empty_child_ids.ini.in empty_child_ids.ini copyonly)
+configure_file(single_child_id.ini.in single_child_id.ini copyonly)
 
 add_definitions(-DCOMPLETE_CONFIG="${CMAKE_CURRENT_BINARY_DIR}/complete_config.ini")
 add_definitions(-DMANDATORY_CONFIG="${CMAKE_CURRENT_BINARY_DIR}/mandatory_config.ini")
 add_definitions(-DTTL_SMALL="${CMAKE_CURRENT_BINARY_DIR}/ttl_small.ini")
 add_definitions(-DTTL_MEDIUM="${CMAKE_CURRENT_BINARY_DIR}/ttl_medium.ini")
 add_definitions(-DBAD_TIMEOUT="${CMAKE_CURRENT_BINARY_DIR}/bad_timeout.ini")
+add_definitions(-DBAD_CHILD_IDS="${CMAKE_CURRENT_BINARY_DIR}/bad_child_ids.ini")
+add_definitions(-DEMPTY_CHILD_IDS="${CMAKE_CURRENT_BINARY_DIR}/empty_child_ids.ini")
+add_definitions(-DSINGLE_CHILD_ID="${CMAKE_CURRENT_BINARY_DIR}/single_child_id.ini")
 add_definitions(-DBAD_TTL="${CMAKE_CURRENT_BINARY_DIR}/bad_ttl.ini")
 
 add_executable(ScopeConfig_test ScopeConfig_test.cpp)

=== modified file 'test/gtest/scopes/internal/ScopeConfig/ScopeConfig_test.cpp'
--- test/gtest/scopes/internal/ScopeConfig/ScopeConfig_test.cpp	2014-08-28 00:20:56 +0000
+++ test/gtest/scopes/internal/ScopeConfig/ScopeConfig_test.cpp	2014-10-24 15:41:48 +0000
@@ -61,6 +61,12 @@
         EXPECT_EQ("second", attrs["logo"].get_dict()["two"].get_string());
         EXPECT_EQ("abc", attrs["page"].get_dict()["page-header"].get_dict()["logo"].get_string());
         EXPECT_EQ("def", attrs["page"].get_dict()["page-header"].get_dict()["logo2"].get_string());
+
+        auto children = cfg.child_scope_ids();
+        EXPECT_EQ(3u, children.size());
+        EXPECT_EQ("com.foo.bar", children[0]);
+        EXPECT_EQ("com.foo.bar2", children[1]);
+        EXPECT_EQ("com.foo.boo", children[2]);
     }
 
     {
@@ -103,6 +109,31 @@
     }
 }
 
+TEST(ScopeConfig, bad_child_scope_ids)
+{
+    try
+    {
+        ScopeConfig cfg(BAD_CHILD_IDS);
+    }
+    catch(ConfigException const& e)
+    {
+        boost::regex r("unity::scopes::ConfigException: \".*\": Invalid empty scope id for ChildScopes");
+        EXPECT_TRUE(boost::regex_match(e.what(), r));
+    }
+}
+
+TEST(ScopeConfig, empty_scope_ids)
+{
+    ScopeConfig cfg(EMPTY_CHILD_IDS);
+    EXPECT_EQ(cfg.child_scope_ids().size(), 0);
+}
+
+TEST(ScopeConfig, single_scope_id)
+{
+    ScopeConfig cfg(SINGLE_CHILD_ID);
+    EXPECT_EQ(cfg.child_scope_ids().size(), 1);
+}
+
 TEST(ScopeConfig, bad_timeout)
 {
     try

=== added file 'test/gtest/scopes/internal/ScopeConfig/bad_child_ids.ini.in'
--- test/gtest/scopes/internal/ScopeConfig/bad_child_ids.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/internal/ScopeConfig/bad_child_ids.ini.in	2014-10-24 15:41:48 +0000
@@ -0,0 +1,5 @@
+[ScopeConfig]
+DisplayName = Scope name
+Description = Scope description
+Author = Canonical
+ChildScopes = com.foo.bar;;

=== modified file 'test/gtest/scopes/internal/ScopeConfig/complete_config.ini.in'
--- test/gtest/scopes/internal/ScopeConfig/complete_config.ini.in	2014-08-11 13:12:59 +0000
+++ test/gtest/scopes/internal/ScopeConfig/complete_config.ini.in	2014-10-24 15:41:48 +0000
@@ -17,6 +17,7 @@
 LocationDataNeeded = true
 ConfinementType = unconfined
 DebugMode = true
+ChildScopes = com.foo.bar;com.foo.bar2;com.foo.boo
 
 [Appearance]
 arbitrary_key = true

=== added file 'test/gtest/scopes/internal/ScopeConfig/empty_child_ids.ini.in'
--- test/gtest/scopes/internal/ScopeConfig/empty_child_ids.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/internal/ScopeConfig/empty_child_ids.ini.in	2014-10-24 15:41:48 +0000
@@ -0,0 +1,5 @@
+[ScopeConfig]
+DisplayName = Scope name
+Description = Scope description
+Author = Canonical
+ChildScopes =

=== added file 'test/gtest/scopes/internal/ScopeConfig/single_child_id.ini.in'
--- test/gtest/scopes/internal/ScopeConfig/single_child_id.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/internal/ScopeConfig/single_child_id.ini.in	2014-10-24 15:41:48 +0000
@@ -0,0 +1,5 @@
+[ScopeConfig]
+DisplayName = Scope name
+Description = Scope description
+Author = Canonical
+ChildScopes = com.foo.bar

=== modified file 'test/gtest/scopes/internal/ScopeMetadataImpl/ScopeMetadataImpl_test.cpp'
--- test/gtest/scopes/internal/ScopeMetadataImpl/ScopeMetadataImpl_test.cpp	2014-08-28 00:20:56 +0000
+++ test/gtest/scopes/internal/ScopeMetadataImpl/ScopeMetadataImpl_test.cpp	2014-10-24 15:41:48 +0000
@@ -294,11 +294,12 @@
     va.push_back(Variant("world"));
     mi->set_settings_definitions(va);
     mi->set_location_data_needed(false);
+    mi->set_child_scope_ids({"com.foo.bar", "com.foo.baz"});
 
     // Check that serialize() sets the map values correctly
     auto m = ScopeMetadataImpl::create(move(mi));
     auto var = m.serialize();
-    EXPECT_EQ(14u, var.size());
+    EXPECT_EQ(15u, var.size());
     EXPECT_EQ("scope_id", var["scope_id"].get_string());
     EXPECT_EQ("display_name", var["display_name"].get_string());
     EXPECT_EQ("description", var["description"].get_string());
@@ -314,6 +315,9 @@
     EXPECT_FALSE(var["invisible"].get_bool());
     EXPECT_EQ(va, var["settings_definitions"].get_array());
     EXPECT_FALSE(var["location_data_needed"].get_bool());
+    EXPECT_EQ(2u, var["child_scopes"].get_array().size());
+    EXPECT_EQ("com.foo.bar", var["child_scopes"].get_array()[0].get_string());
+    EXPECT_EQ("com.foo.baz", var["child_scopes"].get_array()[1].get_string());
 
     // Make another instance from the VariantMap and check its fields
     ScopeMetadataImpl c(var, &mw);