feat: add functions for parsing scales #207

kristw · 2019-08-21T00:07:19Z

🏆 Enhancements

This is part of the ongoing work for @superset-ui/encodeable.

Add types related to scales. Inherit types from vega-lite and override some fields.
Add type guards
Add functions for parsing scales from configuration object into D3 scales as well as connecting to @superset-ui/colors to get color schemes by name. Support most types of scale that D3/vega-lite has. See [vega-lite's scale documentation](https://vega.github.io/vega-lite/docs/scale.html for more details).

type ScaleConfig<Output extends Value = Value> =
  | LinearScaleConfig<Output>
  | LogScaleConfig<Output>
  | PowScaleConfig<Output>
  | SqrtScaleConfig<Output>
  | SymlogScaleConfig<Output>
  | TimeScaleConfig<Output>
  | UtcScaleConfig<Output>
  | QuantileScaleConfig<Output>
  | QuantizeScaleConfig<Output>
  | ThresholdScaleConfig<Output>
  | BinOrdinalScaleConfig<Output>
  | OrdinalScaleConfig<Output>
  | PointScaleConfig<Output>
  | BandScaleConfig<Output>;

Add tons of unit tests to keep 100% coverage.

The main function in this PR is createScaleFromScaleConfig(...)

Example usage

const scale = createScaleFromScaleConfig({
  type: 'linear',
  domain: [0, 10],
  range: [0, 100],
});
expect(scale(10)).toEqual(100);

const scale = createScaleFromScaleConfig({
  type: 'utc',
  domain: [
    {
      year: 2019,
      month: 7,
      date: 5,
      utc: true,
    },
    {
      year: 2019,
      month: 7,
      date: 30,
      utc: true,
    },
  ],
  range: [0, 100],
  nice: { interval: 'month', step: 2 },
});
expect((scale as ScaleTime<number, number>).domain()).toEqual([
  new Date(Date.UTC(2019, 6, 1)),
  new Date(Date.UTC(2019, 8, 1)),
]);

The following scale properties are supported. (See Scale.ts.)

'domain'
'range'
'reverse'
'align'
'base'
'clamp'
'constant'
'exponent'
'interpolate' // add placeholder to be implemented
'nice'
'padding'
'paddingInner'
'paddingOuter'
'reverse'
'round'
'scheme'
'namespace'
'zero'

codecov · 2019-08-21T00:13:28Z

Codecov Report

Merging #207 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #207      +/-   ##
==========================================
+ Coverage   99.91%   99.92%   +<.01%     
==========================================
  Files         112      130      +18     
  Lines        1245     1406     +161     
  Branches      307      354      +47     
==========================================
+ Hits         1244     1405     +161     
  Partials        1        1

Impacted Files	Coverage Δ
...i-encodeable/src/parsers/scale/applyInterpolate.ts	`100% <100%> (ø)`
...set-ui-encodeable/src/parsers/scale/applyDomain.ts	`100% <100%> (ø)`
...rset-ui-encodeable/src/parsers/scale/applyClamp.ts	`100% <100%> (ø)`
...le/src/parsers/scale/createScaleFromScaleConfig.ts	`100% <100%> (ø)`
...es/superset-ui-dimension/src/svg/updateTextNode.ts	`100% <100%> (ø)`	⬆️
...src/parsers/scale/getScaleCategoryFromScaleType.ts	`100% <100%> (ø)`
...-ui-encodeable/src/parsers/scale/inferScaleType.ts	`100% <100%> (ø)`
...erset-ui-encodeable/src/parsers/scale/applyZero.ts	`100% <100%> (ø)`
...rset-ui-encodeable/src/parsers/scale/applyRound.ts	`100% <100%> (ø)`
...rc/parsers/scale/isPropertySupportedByScaleType.ts	`100% <100%> (ø)`
... and 27 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8baede4...b40089d. Read the comment docs.

netlify · 2019-08-21T00:14:16Z

Deploy preview for superset-ui ready!

Built with commit b40089d

https://deploy-preview-207--superset-ui.netlify.com

schillerk · 2019-08-28T16:04:49Z

Nice! Looks great, I wish there was a better abstraction for property in obj && typeof obj.property !== 'undefined', but I guess that's just Javascript.

williaster

this is a ton of work and looks great overall! didn't have much to add ✨

williaster · 2019-08-28T17:36:37Z

packages/superset-ui-encodeable/src/parsers/parseDateTime.ts

+    .replace(/\)$/, '')
+    .split(',')
+    .map((chunk: string) => Number(chunk.trim())) as [
+    number,


not sure if it'd be useful to add comments for the parts, can probably just look up the Date api

williaster · 2019-08-28T17:42:35Z

packages/superset-ui-encodeable/src/parsers/scale/createScaleFromScaleConfig.ts

+    //   if (isAFunction(scaleFn)) const encodedValue = scaleFn(10)
+    //
+    // CategoricalColorScale is actually a function,
+    // but TypeScript is not smart enough to realize that by itself.


yeah this is a tricky one

williaster · 2019-08-28T17:44:19Z

packages/superset-ui-encodeable/src/parsers/scale/createScaleFromScaleType.ts

+  config: ScaleConfig<Output>,
+) {
+  switch (config.type) {
+    default:


whoa have never seen default first 🤯

will move to bottom :)

williaster · 2019-08-28T17:47:31Z

packages/superset-ui-encodeable/src/parsers/scale/isPropertySupportedByScaleType.ts

+// quantile depends on distribution so zero does not matter
+zeroSet.delete(ScaleType.QUANTILE);
+
+const supportedScaleTypes: Record<keyof CombinedScaleConfig, Set<ScaleType>> = {


williaster · 2019-08-28T17:51:09Z

packages/superset-ui-encodeable/src/parsers/scale/scaleCategories.ts

+export const continuousScaleTypes: ScaleType[] = continuousToContinuousScaleTypes;
+export const continuousScaleTypesSet = continuousToContinuousScaleTypesSet;
+
+export const discreteScaleTypes: ScaleType[] = ['band', 'point', 'ordinal'];


any reason not to use ScaleType.BAND, etc?

nope. forgot changed. Thank you for catching.

williaster · 2019-08-28T17:52:39Z

packages/superset-ui-encodeable/src/parsers/scale/getScaleCategoryFromScaleType.ts

+
+export default function getScaleCategoryFromScaleType(scaleType: ScaleType) {
+  if (continuousScaleTypesSet.has(scaleType)) {
+    return 'continuous';


do you think it's worth making these constants? or could at least specify the return type is ScaleCategory | undefined?

agree 👍 . Will specify the return type to enforce stricter check

kristw requested a review from a team as a code owner August 21, 2019 00:07

pull-request-size bot added the size/L label Aug 21, 2019

kristw changed the title ~~[WIP] Add functions for parsing scales~~ [WIP] feat: add functions for parsing scales Aug 21, 2019

kristw added 11 commits August 27, 2019 16:15

feat: add more util functions

6beb085

feat: add unit test

2dfa7da

feat: define HasToString

39d31e0

fix: unit test

f4b8642

fix: update unit tests

fa40671

feat: add scale types

f7756bf

feat: update scale parsing

fbb93ac

fix: enum

b8f36ac

feat: add color scale extraction

ef288bf

refactor: create scale from config

f391f5f

feat: parse more scales and add more test

f027bcb

kristw force-pushed the kristw--encode-scale branch from 0460162 to f027bcb Compare August 27, 2019 23:17

kristw added 6 commits August 27, 2019 17:03

feat: add tests for band and point

9e428f0

test: add more unit tests

04ba182

refactor: separate applyXXX into multiple files

8f51dde

feat: parse nice time

5361078

test: add unit tests

65ec8e3

test: make 100% coverage

39744e4

kristw changed the title ~~[WIP] feat: add functions for parsing scales~~ feat: add functions for parsing scales Aug 28, 2019

pull-request-size bot added size/XXL and removed size/L labels Aug 28, 2019

fix: complete coverage

187e04b

kristw added #enhancement New feature or request reviewable Ready for review labels Aug 28, 2019

refactor: update type definitions

2e9323a

williaster approved these changes Aug 28, 2019

View reviewed changes

kristw added 4 commits August 28, 2019 11:10

fix: address comments

879c4ce

fix: add comments for date parts

21910c4

fix: build issue

d6080a9

fix: broken tests

b40089d

kristw merged commit 6f56ed9 into master Aug 28, 2019

delete-merged-branch bot deleted the kristw--encode-scale branch August 28, 2019 19:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add functions for parsing scales #207

feat: add functions for parsing scales #207

kristw commented Aug 21, 2019 •

edited

Loading

codecov bot commented Aug 21, 2019 •

edited

Loading

netlify bot commented Aug 21, 2019 •

edited

Loading

schillerk commented Aug 28, 2019

williaster left a comment

williaster Aug 28, 2019

williaster Aug 28, 2019

williaster Aug 28, 2019

kristw Aug 28, 2019

williaster Aug 28, 2019

williaster Aug 28, 2019

kristw Aug 28, 2019

williaster Aug 28, 2019

kristw Aug 28, 2019 •

edited

Loading

feat: add functions for parsing scales #207

feat: add functions for parsing scales #207

Conversation

kristw commented Aug 21, 2019 • edited Loading

Example usage

codecov bot commented Aug 21, 2019 • edited Loading

Codecov Report

netlify bot commented Aug 21, 2019 • edited Loading

schillerk commented Aug 28, 2019

williaster left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kristw Aug 28, 2019 • edited Loading

Choose a reason for hiding this comment

kristw commented Aug 21, 2019 •

edited

Loading

codecov bot commented Aug 21, 2019 •

edited

Loading

netlify bot commented Aug 21, 2019 •

edited

Loading

kristw Aug 28, 2019 •

edited

Loading