Differentiated dimension-types #113
Commits on Oct 30, 2018
-
-
-
cube: make CrunchCube._all_dimensions private
* Rename CrunchCube.all_dimensions to ._all_dimensions and move it to down to the implementation method section of the class. * Update all internal references. * Update references in tests.
-
cube: remove dead CrunchCube.ca_dim_ind
CrunchCube.ca_dim_ind is not called by any other part of cr.cube or by current table-writer. Remove it as it will be made obsolete by other factoring.
-
cube: make CrunchCube.col_direction_axis private
CrunchCube.col_direction_axis is not called outside cr.cube.crunch_cube.
-
cube: make CrunchCube.data private
CrunchCube.data is used only internally to the CrunchCube class.
-
cube: make CrunchCube.flat_values private
CrunchCube.flat_values is only used internally by CrunchCube and is not a required interface method.
-
cube: make CrunchCube.prune_indices private
CrunchCube.prune_indices is not used outside CrunchCube.
-
cube: make .valid_indices_with_selections private
CrunchCube.valid_indices_with_selections is not required outside CrunchCube. Make it private.
-
dim: extract DIMENSION_TYPE enumeration
* Define DIMENSION_TYPE enumeration, defining all distinct types, even though current Dimension.dimension_type cannot differentiate all of them yet. * Change each use of `str` dimension-type key in code and tests to actual DIMENSION_TYPE member. * Remove some cruft from Dimension.dimension_type to bring it consistent with current cube response form. * Update a legacy fixture to all now-required subtype-class.
-
cube: parameterize CrunchCube unit tests
Use pytest parameterized fixtures to gather test cases into a single test plus a parameterized fixture. This clarifies the test and greatly shortens the test file making it easier to understand and maintain.
-
dim: add xfail integration test to drive TDD
Add integration tests to drive test-driven development of dimension collections objects, including the core aspect of dimension type discovery. Along the way: * Normalize CAT_X_CAT fixture to allow uniform access to result dict. * Fix unit test that depended on CAT_X_CAT being a shojified cube response.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
dim: integrate new AllDimensions implementation
* Move NewDimension methods into Dimension, replacing old implementations. * Update CrunchCube dimensions methods to use new dimension collections. * Update CrunchCube and Dimension tests as required. * Mark newly failing tests xfail for individual resolution in following commits.
-
cube: remimplement CrunchCube.is_univariate_ca
With the new fully-differentiated dimension types, a CA dimension pair has a CA_CAT dimension where it used to have an (undifferentiated) CAT dimension.
-
cube: reimplement CrunchCube.univariate_ca_main_axis
Main axis of univariate CA is now CA_CAT type where before it was undifferentiated CAT type.
-
test: rework CrunchCube.dimensions integration test
Move CrunchCube.dimensions integration test to test_crunch_cube.py and update it to reflect differentiated dimension type for CA_CAT.
-
test: rework logical-univariate integration test
* Canonicalize unpunctuated logical-univariate JSON fixture. * Move test to CrunchCube integration test module since it exercises CrunchCube methods. * Test requires DIMENSION_TYPE.LOGICAL instead of CATEGORICAL now that categorical dimension types are differentiated.
-
test: rework cat-x-logical test
JSON fixture named LOGICAL_X_CAT turns out to have CAT_X_LOGICAL dimensions. Canonicalize and rename that JSON fixture and move test to cube integration test module since that's its entry point. Use LOGICAL dimension-type to match now differentiated category type.
-
rfctr: remove CrunchCube.is_mr_selections()
CrunchCube.is_mr_selections() can now be replaced by `dimension.dimension_type == DT.MR_CAT`. Remove .is_mr_selections() and replace its usage with that snippet.
-
rfctr: remove Dimension.is_selections
Differentiated dimension-types make this API property unnecessary and making selection types explicit in client code makes it easier to reason about.
-
rfctr: remove CrunchCube.mr_selections_indices
CrunchCube.mr_selections_indices is unused and should not be required as an API property. Remove it.
-
Dimension.alias is no longer used. Remove it on YAGNI rationale.
-
cube: make CrunchCube.dim_types immutable
Returning a mutable type on an @lazyproperty is dangerous because it permits the caller to change the contents which would be returned to the next caller. Make CrunchCube.dim_types return a tuple rather than a list.
-
