Merge lp:~ken-vandine/libunity/social_preview into lp:libunity

[Ken VanDine]

Added SocialPreview

Added SocialPreview

[Paweł Stołowski (stolowski)]

Looking good overall. Two remarks:

1) Can you add a simple serialization test to test-previews.vala?

2) This should be removed?:
176 +
177 +/* KEN
178 + public SocialPreview (Comment[] comments, string selected_item_uri)
179 + {
180 + // careful current_item_uri will be set before items are
181 + Object (current_item_uri: selected_item_uri);
182 + foreach (unowned Comment comment in comments)
183 + {
184 + add_comment (comment);
185 + }
186 + }
187 +*/

review: Needs Fixing

[Ken VanDine (ken-vandine)]

Those issues should be fined now.

[Paweł Stołowski (stolowski)]

Looks good now!

review: Approve

[Unity Merger (unity-merger)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

=== modified file 'protocol/protocol-previews.vala'
--- protocol/protocol-previews.vala	2012-09-13 15:09:15 +0000
+++ protocol/protocol-previews.vala	2012-09-17 18:01:37 +0000
@@ -279,6 +279,7 @@
     typeof (ApplicationPreview).class_ref ();
     typeof (MusicPreview).class_ref ();
     typeof (MoviePreview).class_ref ();
+    typeof (SocialPreview).class_ref ();
     typeof (SeriesPreview).class_ref ();
   }
 
@@ -306,6 +307,9 @@
       case MoviePreview.RENDERER_NAME:
         result_obj = Dee.Serializable.parse (data, typeof (MoviePreview));
         break;
+      case SocialPreview.RENDERER_NAME:
+        result_obj = Dee.Serializable.parse (data, typeof (SocialPreview));
+        break;
       case SeriesPreview.RENDERER_NAME:
         result_obj = Dee.Serializable.parse (data, typeof (SeriesPreview));
         break;
@@ -580,6 +584,98 @@
   }
 }
 
+public class SocialPreview : Preview
+{
+  internal const string RENDERER_NAME = "preview-social";
+
+  public Icon avatar { get; set; }
+  public string content { get; set; }
+  public string sender { get; set; }
+  public CommentRaw[] comments;
+  private CommentRaw[] _comments = null;
+
+  public struct CommentRaw
+  {
+    public string id;
+    public string display_name;
+    public string content;
+    public string time;
+  }
+
+  public SocialPreview ()
+  {
+    Object ();
+  }
+
+  internal override unowned string get_renderer_name ()
+  {
+    return RENDERER_NAME;
+  }
+
+  internal override void add_properties (HashTable<string, Variant> properties)
+  {
+    base.add_properties (properties);
+
+    if (_comments.length > 0)
+      properties["comments"] = _comments;
+    if (avatar != null)
+      properties["avatar"] = avatar.to_string ();
+    if (content != null)
+      properties["content"] = content;
+    if (sender != null)
+      properties["sender"] = sender;
+  }
+
+  static construct
+  {
+    Dee.Serializable.register_parser (typeof (SocialPreview),
+                                      new VariantType (PreviewRaw.SIGNATURE),
+                                      (data) =>
+    {
+      unowned string renderer = data.get_child_value (0).get_string ();
+      warn_if_fail (renderer == RENDERER_NAME);
+
+      HashTable<string, Variant> properties;
+      SocialPreview result = Preview.deserialize<SocialPreview> (
+        data, out properties);
+
+      Preview.checked_set (properties["avatar"],
+        (v) => { result.avatar = Preview.variant_to_icon (v); });
+      Preview.checked_set (properties["content"],
+        (v) => { result.content = v.get_string (); });
+      Preview.checked_set (properties["sender"],
+        (v) => { result.sender = v.get_string (); });
+
+      Preview.checked_set (properties["comments"], (v) =>
+      {
+        CommentRaw[] comments = (CommentRaw[]) v;
+        result._comments = (owned) comments;
+      });
+
+      return result;
+    });
+  }
+
+  public void add_comment (string id,
+                             string display_name,
+                             string content,
+                             string time)
+  {
+    CommentRaw? comment = CommentRaw ();
+    comment.id = id;
+    comment.display_name = display_name;
+    comment.content = content;
+    comment.time = time;
+
+    _comments += (owned) comment;
+  }
+
+  public unowned CommentRaw[] get_comments ()
+  {
+    return _comments;
+  }
+}
+
 public struct SeriesItemRaw
 {
   public string uri;

=== modified file 'src/unity-previews.vala'
--- src/unity-previews.vala	2012-09-03 14:38:59 +0000
+++ src/unity-previews.vala	2012-09-17 18:01:37 +0000
@@ -497,6 +497,61 @@
   }
 }
 
+public class SocialPreview : Preview
+{
+  public class Comment : InitiallyUnowned
+  {
+    public string id { get; construct; }
+    public string name { get; construct; }
+    public string text { get; construct; }
+    public string time { get; construct; }
+
+    public Comment (string id, string name, string text, string time)
+    {
+      Object (id: id, name: name, text: text, time: time);
+    }
+  }
+
+  public Icon avatar
+  {
+    get { return _raw.avatar; }
+    set { _raw.avatar = value; }
+  }
+  public string content
+  {
+    get { return _raw.description; }
+    set { _raw.description = value; }
+  }
+  public string sender
+  {
+    get { return _raw.sender; }
+    set { _raw.sender = value; }
+  }
+
+  public SocialPreview (string sender,
+                             string title,
+                             string content,
+                             Icon? avatar)
+  {
+    Object (sender: sender, title: title, content: content,
+            avatar: avatar);
+  }
+
+  private unowned Protocol.SocialPreview _raw;
+  internal override Object create_raw ()
+  {
+    var raw = new Protocol.SocialPreview ();
+    _raw = raw;
+    return _raw;
+  }
+
+  public void add_comment (Comment comment)
+  {
+    _raw.add_comment (comment.id, comment.name, comment.text, comment.time);
+  }
+
+}
+
 /* No support for SeriesPreview yet */
 internal class SeriesItem : Object
 {

=== modified file 'test/vala/test-previews.vala'
--- test/vala/test-previews.vala	2012-08-20 14:57:40 +0000
+++ test/vala/test-previews.vala	2012-09-17 18:01:37 +0000
@@ -35,6 +35,8 @@
                                test_preview_generic_no_details);
       GLib.Test.add_data_func ("/Unit/Preview/ApplicationPreview",
                                test_preview_application);
+      GLib.Test.add_data_func ("/Unit/Preview/SocialPreview",
+                               test_preview_social);
       GLib.Test.add_data_func ("/Unit/Preview/MusicPreview",
                                test_preview_music);
       GLib.Test.add_data_func ("/Unit/Preview/MusicPreview/WithTracks",
@@ -220,6 +222,25 @@
       assert (previews_equal (data, reconstructed.serialize ()));
     }
 
+    static void test_preview_social ()
+    {
+      var avatar = new ThemedIcon ("gwibber");
+      var preview = new SocialPreview ("sender", "title",
+                                            "content", avatar);
+
+      // check if serialization works properly
+      var data = preview.serialize ();
+      var reconstructed = Protocol.Preview.parse (data) as Protocol.SocialPreview;
+
+      assert (preview.sender == reconstructed.sender);
+      assert (preview.title == reconstructed.title);
+      assert (preview.content == reconstructed.description);
+      assert (avatar.equal (reconstructed.avatar));
+
+      assert (previews_equal (data, reconstructed.serialize ()));
+    }
+
+
     static void test_preview_music ()
     {
       var artwork = new FileIcon (File.new_for_path ("/usr/share/icons/beatles.jpg"));

=== modified file 'tools/preview-renderer.vala'
--- tools/preview-renderer.vala	2012-08-15 09:02:44 +0000
+++ tools/preview-renderer.vala	2012-09-17 18:01:37 +0000
@@ -50,7 +50,8 @@
             if (preview is Unity.Protocol.SeriesPreview) {
                 return new SeriesPreviewRenderer(preview as Unity.Protocol.SeriesPreview, scope_uri);
             }
-            return null;
+            /* fallback - a generic preview renderer */
+            return new GenericPreviewRenderer(preview, scope_uri);
         }
 
         public Unity.Protocol.Preview preview { get; construct; }
@@ -232,7 +233,7 @@
 
     public class GenericPreviewRenderer: GridRenderer
     {
-        public GenericPreviewRenderer(Unity.Protocol.GenericPreview preview, string scope_uri)
+        public GenericPreviewRenderer(Unity.Protocol.Preview preview, string scope_uri)
         {
             Object(preview: preview, scope_uri: scope_uri);
         }
@@ -241,8 +242,8 @@
         {
             assert(preview != null);
 
-            base.add_standard_attributes(preview as Unity.Protocol.GenericPreview);
-            base.add_info_hints(preview as Unity.Protocol.GenericPreview);
+            base.add_standard_attributes(preview as Unity.Protocol.Preview);
+            base.add_info_hints(preview as Unity.Protocol.Preview);
         }
     }