cube: add Cube.title

src/cr/cube/cube.py

@@ -250,7 +250,7 @@ def dimension_types(self):
 
     @lazyproperty
     def dimensions(self):
-        """_ApparentDimension object providing access to visible dimensions.
+        """_ApparentDimensions object providing access to visible dimensions.
 
         A cube involving a multiple-response (MR) variable has two dimensions
         for that variable (subvariables and categories dimensions), but is
@@ -360,7 +360,7 @@ def title(self):
         use-case it is a stand-in for the columns-dimension name since a strand has no
         columns dimension.
         """
-        raise NotImplementedError
+        return self._cube_dict.get("title", "Untitled")
 
     @lazyproperty
     def _all_dimensions(self):

tests/fixtures/cat-x-cat.json

@@ -43,6 +43,7 @@
                 "derived": false,
                 "references": {
                     "alias": "v4",
+                    "description": "Pet Owners",
                     "name": "v4"
                 },
                 "type": {
@@ -146,5 +147,6 @@
         },
         "missing": 5,
         "n": 20
-    }
+    },
+    "title": "Pony Owners"
 }

tests/fixtures/univariate-categorical.json

@@ -88,5 +88,6 @@
         },
         "missing": 5,
         "n": 20
-    }
+    },
+    "title": "Registered Voters"
 }

tests/integration/test_cube.py

@@ -24,7 +24,6 @@
 class DescribeIntegratedCube(object):
     """Integration-test suite for `cr.cube.cube.Cube` object."""
 
-    @pytest.mark.xfail(reason="WIP", strict=True)
     def it_provides_values_for_cat_x_cat(self):
         cube = Cube(CR.CAT_X_CAT)
 
@@ -35,7 +34,7 @@ def it_provides_values_for_cat_x_cat(self):
             cube.counts_with_missings, [[5, 3, 2, 0], [5, 2, 3, 0], [0, 0, 0, 0]]
         )
         assert cube.cube_index == 0
-        assert cube.description == ""
+        assert cube.description == "Pet Owners"
         assert cube.dimension_types == (DT.CAT, DT.CAT)
         assert isinstance(cube.dimensions, _ApparentDimensions)
         assert cube.has_means is False

tests/integration/test_cubepart.py

@@ -22,7 +22,7 @@ def it_provides_values_for_cat_x_cat(self):
         assert slice_.columns_dimension_name == "v7"
         assert slice_.columns_dimension_type == DT.CAT
         assert slice_.cube_is_mr_by_itself is False
-        assert slice_.description == ""
+        assert slice_.description == "Pet Owners"
         np.testing.assert_almost_equal(
             slice_.row_proportions, np.array([[0.71428571, 0.28571429], [0.625, 0.375]])
         )
@@ -39,7 +39,7 @@ def it_provides_values_for_cat_x_cat(self):
             ],
         )
         assert slice_.row_labels == ("B", "C")
-        assert slice_.rows_dimension_description == ""
+        assert slice_.rows_dimension_description == "Pet Owners"
         assert slice_.rows_dimension_fills == (None, None)
         assert slice_.rows_dimension_name == "v4"
         assert slice_.rows_dimension_type == DT.CAT
@@ -1017,7 +1017,6 @@ def it_knows_its_insertions(self):
 class Describe_Strand(object):
     """Integration-test suite for `cr.cube.cubepart._Strand` object."""
 
-    @pytest.mark.xfail(reason="WIP", strict=True)
     def it_provides_values_for_univariate_cat(self):
         strand = Cube(CR.UNIVARIATE_CATEGORICAL).partitions[0]
 
@@ -1055,7 +1054,6 @@ def it_provides_values_for_univariate_cat(self):
         assert pytest.approx(strand.var_scale_mean) == 0.8888888
         assert strand.variable_name == "v7"
 
-    @pytest.mark.xfail(reason="WIP", strict=True)
     def it_provides_values_for_cat_with_means_and_insertions(self):
         strand = Cube(CR.CAT_WITH_MEANS_AND_INSERTIONS).partitions[0]
 

tests/unit/test_cube.py

@@ -359,6 +359,14 @@ def it_knows_if_it_is_mr_by_itself(
 
         assert is_mr_by_itself is expected_value
 
+    @pytest.mark.parametrize(
+        ("cube_dict", "expected_value"),
+        (({}, "Untitled"), ({"title": "Hipsters"}, "Hipsters")),
+    )
+    def it_knows_its_title(self, _cube_dict_prop_, cube_dict, expected_value):
+        _cube_dict_prop_.return_value = cube_dict
+        assert Cube(None).title == expected_value
+
     def it_provides_access_to_the_cube_response_dict_to_help(self):
         assert Cube({"cube": "dict"})._cube_dict == {"cube": "dict"}
 
@@ -392,6 +400,10 @@ def but_it_raises_on_other_cube_response_types(self, cube_response, expected_val
 
     # fixture components ---------------------------------------------
 
+    @pytest.fixture
+    def _cube_dict_prop_(self, request):
+        return property_mock(request, Cube, "_cube_dict")
+
     @pytest.fixture
     def dimension_types_prop_(self, request):
         return property_mock(request, Cube, "dimension_types")