Merge lp:~thomir-deactivatedaccount/autopilot/trunk-support-point3d into lp:autopilot

[Thomi Richards]

Add support for 3D points.

Add support for points in 3D space, for the unity7 folk.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:338
http://jenkins.qa.ubuntu.com/job/autopilot-ci/253/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-amd64-ci/181
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-armhf-ci/181
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-i386-ci/25

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-ci/253/rebuild

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

Looks good.

review: Approve

=== modified file 'autopilot/introspection/types.py'
--- autopilot/introspection/types.py	2013-09-20 19:01:27 +0000
+++ autopilot/introspection/types.py	2013-09-26 23:36:39 +0000
@@ -66,6 +66,7 @@
     COLOR = 4
     DATETIME = 5
     TIME = 6
+    POINT3D = 7
     UNKNOWN = -1
 
 
@@ -85,6 +86,7 @@
         ValueType.SIZE: Size,
         ValueType.DATETIME: DateTime,
         ValueType.TIME: Time,
+        ValueType.POINT3D: Point3D,
         ValueType.UNKNOWN: _make_plain_type,
     }
     type_id = value[0]
@@ -618,3 +620,46 @@
         if isinstance(other, time):
             return other == self._cached_time
         return super(Time, self).__eq__(other)
+
+
+class Point3D(_array_packed_type(3)):
+
+    """The Point3D class represents a 3D point in cartesian space.
+
+    To construct a Point3D, pass in the x, y and z parameters to the class
+    constructor::
+
+        >>> my_point = Point(50,100,20)
+
+    These attributes can be accessed either using named attributes, or via
+    sequence indexes::
+
+        >>> my_point.x == my_point[0] == 50
+        True
+        >>> my_point.y == my_point[1] == 100
+        True
+        >>> my_point.z == my_point[2] == 20
+        True
+
+    Point3D instances can be compared using ``==`` and ``!=``, either to
+    another Point3D instance, or to any mutable sequence type with the correct
+    number of items::
+
+        >>> my_point == [50, 100, 20]
+        True
+        >>> my_point != Point(5, 10, 2)
+        True
+
+    """
+
+    @property
+    def x(self):
+        return self[0]
+
+    @property
+    def y(self):
+        return self[1]
+
+    @property
+    def z(self):
+        return self[2]

=== modified file 'autopilot/tests/unit/test_types.py'
--- autopilot/tests/unit/test_types.py	2013-09-18 22:22:23 +0000
+++ autopilot/tests/unit/test_types.py	2013-09-26 23:36:39 +0000
@@ -32,6 +32,7 @@
     DateTime,
     PlainType,
     Point,
+    Point3D,
     Rectangle,
     Size,
     Time,
@@ -303,6 +304,51 @@
         self.assertThat(dt1.time, IsInstance(time))
 
 
+class Point3DTypeTests(TestCase):
+
+    def test_can_construct_point3d(self):
+        r = Point3D(1, 2, 3)
+        self.assertThat(r, IsInstance(dbus.Array))
+
+    def test_point3d_has_xyz_properties(self):
+        r = Point3D(1, 2, 3)
+
+        self.assertThat(r.x, Equals(1))
+        self.assertThat(r.y, Equals(2))
+        self.assertThat(r.z, Equals(3))
+
+    def test_point3d_has_slice_access(self):
+        r = Point3D(1, 2, 3)
+
+        self.assertThat(r[0], Equals(1))
+        self.assertThat(r[1], Equals(2))
+        self.assertThat(r[2], Equals(3))
+
+    def test_equality_with_point3d(self):
+        p1 = Point3D(1, 2, 3)
+        p2 = Point3D(1, 2, 3)
+
+        self.assertThat(p1, Equals(p2))
+
+    def test_inequality_with_point3d(self):
+        p1 = Point3D(1, 2, 3)
+        p2 = Point3D(1, 2, 4)
+
+        self.assertThat(p1, NotEquals(p2))
+
+    def test_equality_with_list(self):
+        p1 = Point3D(1, 2, 3)
+        p2 = [1, 2, 3]
+
+        self.assertThat(p1, Equals(p2))
+
+    def test_inequality_with_list(self):
+        p1 = Point3D(1, 2, 3)
+        p2 = [1, 2, 4]
+
+        self.assertThat(p1, NotEquals(p2))
+
+
 class CreateValueInstanceTests(TestCase):
 
     """Tests to check that create_value_instance does the right thing."""
@@ -550,6 +596,35 @@
             ValueError("Cannot create attribute, no data supplied")
         ))
 
+    def test_point3d(self):
+        data = dbus.Array(
+            [
+                dbus.Int32(ValueType.POINT3D),
+                dbus.Int32(0),
+                dbus.Int32(10),
+                dbus.Int32(20),
+            ]
+        )
+
+        attr = create_value_instance(data, None, None)
+
+        self.assertThat(attr, IsInstance(Point3D))
+
+    def test_invalid_point3d(self):
+        data = dbus.Array(
+            [
+                dbus.Int32(ValueType.POINT3D),
+                dbus.Int32(0),
+                dbus.Int32(0),
+            ]
+        )
+
+        fn = lambda: create_value_instance(data, None, None)
+
+        self.assertThat(fn, raises(
+            ValueError("Point3D must be constructed with 3 arguments, not 2")
+        ))
+
 
 class DBusIntrospectionObjectTests(TestCase):