feat: Consider data type to set dimension resolution + do not trim cu…

…rrency values Instead of trimming currency values, we pad if necessary
visualize-admin · Aug 24, 2022 · 3b33b06 · 3b33b06
1 parent ca2323d
commit 3b33b06
Show file tree

Hide file tree

Showing 9 changed files with 69 additions and 15 deletions.
diff --git a/app/configurator/components/ui-helpers.spec.ts b/app/configurator/components/ui-helpers.spec.ts
@@ -64,6 +64,15 @@ describe("useDimensionFormatters", () => {
           currencyExponent: 1,
           __typename: "Measure",
         } as DimensionMetadataFragment,
+        {
+          iri: "iri-currency-int",
+          isNumerical: true,
+          isKeyDimension: false,
+          isCurrency: true,
+          currencyExponent: 1,
+          resolution: 0,
+          __typename: "Measure",
+        } as DimensionMetadataFragment,
       ])
     );
     return { formatters };
@@ -86,7 +95,19 @@ describe("useDimensionFormatters", () => {
 
   it("should work with currencies", () => {
     const { formatters } = setup();
-    expect(formatters["iri-currency"]("20002.3333")).toEqual("20'002,3");
+
+    // Keeps precision if it is over the currencyExponent
+    expect(formatters["iri-currency"]("20002.3333")).toEqual("20'002,3333");
+
+    // Pads with 0 otherwise
+    expect(formatters["iri-currency"]("20002")).toEqual("20'002,0");
+  });
+
+  it("should work with dimension marked with currency and with datatype integer", () => {
+    const { formatters } = setup();
+
+    // If we have a resolution on the dimension
+    expect(formatters["iri-currency-int"]("20002")).toEqual("20'002");
   });
 });
 

diff --git a/app/configurator/components/ui-helpers.ts b/app/configurator/components/ui-helpers.ts
@@ -148,15 +148,36 @@ const namedNodeFormatter = (d: DimensionMetadataFragment) => {
   };
 };
 
-const currencyFormatter = (d: Measure) => {
-  const formatLocale = getD3FormatLocale();
-  // Use the currency exponent from the dimension, with default 2
-  return formatLocale.format(`,.${d.currencyExponent || 2}f`);
+const currencyFormatter = (d: Measure, locale: string) => {
+  const formatLocale = getD3FormatLocale(locale);
+  const minDecimals = d.resolution ?? d.currencyExponent ?? 2;
+  const maxDecimals = 8;
+  const baseFormatter = formatLocale.format(`,.${maxDecimals}f`);
+  return (v: number) => {
+    const formatted = baseFormatter(v);
+    const l = formatted.length;
+
+    // TODO Decimal separator should be based on locale
+    const dot = formatted.indexOf(".");
+
+    let lastSignificantIndex = formatted.length - maxDecimals + minDecimals - 1;
+    for (let i = l - maxDecimals + minDecimals; i < l; i++) {
+      if (formatted[i] !== "0") {
+        lastSignificantIndex = i;
+      }
+    }
+    return formatted.substring(
+      0,
+      lastSignificantIndex +
+        (minDecimals === 0 || dot === lastSignificantIndex ? 0 : 1)
+    );
+  };
 };
 
 export const useDimensionFormatters = (
   dimensions: DimensionMetadataFragment[]
 ) => {
+  const locale = useLocale();
   const formatNumber = useFormatNumber() as unknown as (
     d: number | string
   ) => string;
@@ -169,7 +190,7 @@ export const useDimensionFormatters = (
         let formatter: (s: any) => string;
         if (d.__typename === "Measure") {
           if (d.isCurrency) {
-            formatter = currencyFormatter(d);
+            formatter = currencyFormatter(d, locale);
           } else {
             formatter = formatNumber;
           }
@@ -190,7 +211,7 @@ export const useDimensionFormatters = (
         return [d.iri, formatter];
       })
     );
-  }, [dimensions, formatNumber, dateFormatters, formatDateAuto]);
+  }, [locale, dimensions, formatNumber, dateFormatters, formatDateAuto]);
 };
 
 export type LocalDateFormatters = ReturnType<typeof getFormattersForLocale>;

diff --git a/app/graphql/queries/data-cubes.graphql b/app/graphql/queries/data-cubes.graphql
@@ -56,6 +56,7 @@ fragment dimensionMetadata on Dimension {
   ... on Measure {
     isCurrency
     currencyExponent
+    resolution
   }
 }
 

diff --git a/app/graphql/query-hooks.ts b/app/graphql/query-hooks.ts
@@ -228,6 +228,7 @@ export type Measure = Dimension & {
   isKeyDimension: Scalars['Boolean'];
   isCurrency?: Maybe<Scalars['Boolean']>;
   currencyExponent?: Maybe<Scalars['Int']>;
+  resolution?: Maybe<Scalars['Int']>;
   values: Array<Scalars['DimensionValue']>;
   related?: Maybe<Array<RelatedDimension>>;
   hierarchy?: Maybe<Array<HierarchyValue>>;
@@ -455,7 +456,7 @@ type DimensionMetadata_GeoCoordinatesDimension_Fragment = { __typename: 'GeoCoor
 
 type DimensionMetadata_GeoShapesDimension_Fragment = { __typename: 'GeoShapesDimension', iri: string, label: string, isNumerical: boolean, isKeyDimension: boolean, order?: Maybe<number>, values: Array<any>, unit?: Maybe<string>, related?: Maybe<Array<{ __typename: 'RelatedDimension', iri: string, type: string }>> };
 
-type DimensionMetadata_Measure_Fragment = { __typename: 'Measure', isCurrency?: Maybe<boolean>, currencyExponent?: Maybe<number>, iri: string, label: string, isNumerical: boolean, isKeyDimension: boolean, order?: Maybe<number>, values: Array<any>, unit?: Maybe<string>, related?: Maybe<Array<{ __typename: 'RelatedDimension', iri: string, type: string }>> };
+type DimensionMetadata_Measure_Fragment = { __typename: 'Measure', isCurrency?: Maybe<boolean>, currencyExponent?: Maybe<number>, resolution?: Maybe<number>, iri: string, label: string, isNumerical: boolean, isKeyDimension: boolean, order?: Maybe<number>, values: Array<any>, unit?: Maybe<string>, related?: Maybe<Array<{ __typename: 'RelatedDimension', iri: string, type: string }>> };
 
 type DimensionMetadata_NominalDimension_Fragment = { __typename: 'NominalDimension', iri: string, label: string, isNumerical: boolean, isKeyDimension: boolean, order?: Maybe<number>, values: Array<any>, unit?: Maybe<string>, related?: Maybe<Array<{ __typename: 'RelatedDimension', iri: string, type: string }>> };
 
@@ -854,6 +855,7 @@ export const DimensionMetadataFragmentDoc = gql`
   ... on Measure {
     isCurrency
     currencyExponent
+    resolution
   }
 }
     `;

diff --git a/app/graphql/resolver-types.ts b/app/graphql/resolver-types.ts
@@ -234,6 +234,7 @@ export type Measure = Dimension & {
   isKeyDimension: Scalars['Boolean'];
   isCurrency?: Maybe<Scalars['Boolean']>;
   currencyExponent?: Maybe<Scalars['Int']>;
+  resolution?: Maybe<Scalars['Int']>;
   values: Array<Scalars['DimensionValue']>;
   related?: Maybe<Array<RelatedDimension>>;
   hierarchy?: Maybe<Array<HierarchyValue>>;
@@ -714,6 +715,7 @@ export type MeasureResolvers<ContextType = GraphQLContext, ParentType extends Re
   isKeyDimension?: Resolver<ResolversTypes['Boolean'], ParentType, ContextType>;
   isCurrency?: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   currencyExponent?: Resolver<Maybe<ResolversTypes['Int']>, ParentType, ContextType>;
+  resolution?: Resolver<Maybe<ResolversTypes['Int']>, ParentType, ContextType>;
   values?: Resolver<Array<ResolversTypes['DimensionValue']>, ParentType, ContextType, RequireFields<MeasureValuesArgs, 'sourceType' | 'sourceUrl'>>;
   related?: Resolver<Maybe<Array<ResolversTypes['RelatedDimension']>>, ParentType, ContextType>;
   hierarchy?: Resolver<Maybe<Array<ResolversTypes['HierarchyValue']>>, ParentType, ContextType, RequireFields<MeasureHierarchyArgs, 'sourceType' | 'sourceUrl'>>;

diff --git a/app/graphql/resolvers/index.ts b/app/graphql/resolvers/index.ts
@@ -233,11 +233,8 @@ export const resolvers: Resolvers = {
   },
   Measure: {
     ...mkDimensionResolvers("Measure"),
-    isCurrency: ({ data: { isCurrency } }) => {
-      return isCurrency;
-    },
-    currencyExponent: ({ data: { currencyExponent } }) => {
-      return currencyExponent || 0;
-    },
+    isCurrency: ({ data: { isCurrency } }) => isCurrency,
+    currencyExponent: ({ data: { currencyExponent } }) => currencyExponent || 0,
+    resolution: ({ data: { resolution } }) => resolution ?? null,
   },
 };
diff --git a/app/graphql/schema.graphql b/app/graphql/schema.graphql
@@ -206,6 +206,7 @@ type Measure implements Dimension {
   isKeyDimension: Boolean!
   isCurrency: Boolean
   currencyExponent: Int
+  resolution: Int
   values(
     sourceType: String!
     sourceUrl: String!

diff --git a/app/graphql/shared-types.ts b/app/graphql/shared-types.ts
@@ -53,6 +53,7 @@ export type ResolvedDimension = {
     currencyExponent?: number;
     hasUndefinedValues: boolean;
     unit?: string;
+    resolution?: number;
     dataType?: string;
     order?: number;
     name: string;

diff --git a/app/rdf/parse.ts b/app/rdf/parse.ts
@@ -237,6 +237,13 @@ export const parseCubeDimension = ({
   const rawOrder = dim.out(ns.sh.order).value;
   const order = rawOrder !== undefined ? parseInt(rawOrder, 10) : undefined;
 
+  const name = dim.out(ns.schema.name, outOpts).value ?? dim.path?.value!;
+  const resolution =
+    dataType?.equals(ns.xsd.int) || dataType?.equals(ns.xsd.integer)
+      ? 0
+      : undefined;
+
+  console.log({ name, resolution });
   return {
     cube,
     dimension: dim,
@@ -252,11 +259,12 @@ export const parseCubeDimension = ({
       hasUndefinedValues,
       unit: dimensionUnitLabel,
       dataType: dataType?.value,
+      resolution,
       isCurrency: !!dimensionUnit?.isCurrency?.value,
       currencyExponent: dimensionUnit?.currencyExponent?.value
         ? parseInt(dimensionUnit?.currencyExponent?.value)
         : undefined,
-      name: dim.out(ns.schema.name, outOpts).value ?? dim.path?.value!,
+      name,
       order: order,
       dataKind: dataKindTerm?.equals(ns.time.GeneralDateTimeDescription)
         ? "Time"