Skip to content

fix: Formatting Rule Doesn't use default set by user #1547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Zhou-Ziheng merged 6 commits into from
Oct 4, 2023
Merged

fix: Formatting Rule Doesn't use default set by user #1547

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
789a7df
fix: Formatting Rule Doesn't use default set by user
Zhou-Ziheng Sep 25, 2023
5a23de3
default instead of placeholder
Zhou-Ziheng Sep 29, 2023
175f777
reduced redundent function call
Zhou-Ziheng Sep 29, 2023
b65a4c4
revert eol
Zhou-Ziheng Sep 29, 2023
93c32fb
fixed tests
Zhou-Ziheng Sep 29, 2023
c039d56
arrow function fix
Zhou-Ziheng Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions packages/code-studio/src/settings/ColumnSpecificSectionContent.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,10 @@ it('displays an error when the formatting rule is empty', async () => {
expect(screen.getByDisplayValue('test')).toBeInTheDocument();

await user.selectOptions(screen.getByLabelText('Column Type'), 'Decimal');
await user.type(screen.getByLabelText('Formatting Rule'), ' {backspace}');
await user.type(
screen.getByLabelText('Formatting Rule'),
' {Control>}A{/Control}{backspace}'
);
expect(screen.queryByText(/Empty formatting rule\./)).toBeInTheDocument();
});

Expand Down Expand Up @@ -215,7 +218,7 @@ it('should change the input value when column type is Integer', async () => {
await user.selectOptions(screen.getByLabelText('Column Type'), 'Integer');
await user.type(
screen.getByLabelText('Formatting Rule'),
`{selectall}${newFormat}`
`{Control>}A{/Control}${newFormat}`
);

expect(screen.getByDisplayValue(newFormat)).toBeInTheDocument();
Expand Down
73 changes: 57 additions & 16 deletions packages/code-studio/src/settings/ColumnSpecificSectionContent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,6 @@ interface ColumnSpecificSectionContentState {
showTimeZone: boolean;
showTSeparator: boolean;
timeZone: string;
defaultDateTimeFormat: string;
defaultDecimalFormatOptions: FormatOption;
defaultIntegerFormatOptions: FormatOption;
truncateNumbersWithPound: boolean;
timestampAtMenuOpen: Date;
}
Expand Down Expand Up @@ -116,9 +113,6 @@ export class ColumnSpecificSectionContent extends PureComponent<

const {
formatter,
defaultDateTimeFormat,
defaultDecimalFormatOptions,
defaultIntegerFormatOptions,
showTimeZone,
showTSeparator,
timeZone,
Expand All @@ -141,9 +135,6 @@ export class ColumnSpecificSectionContent extends PureComponent<
showTimeZone,
showTSeparator,
timeZone,
defaultDateTimeFormat,
defaultDecimalFormatOptions,
defaultIntegerFormatOptions,
truncateNumbersWithPound,
timestampAtMenuOpen: new Date(),
};
Expand Down Expand Up @@ -221,7 +212,7 @@ export class ColumnSpecificSectionContent extends PureComponent<
let resetKeys = {};
if (key === 'columnType') {
resetKeys = {
format: '',
format: this.makeDefaultFormatterItemByType(value as string),
Copy link
Copy Markdown
Member

@mofojed mofojed Oct 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if there's a way using function overloading and/or generics to correct this so you don't need to cast it: https://www.typescriptlang.org/docs/handbook/2/functions.html#function-overloads

Figuring that out isn't really necessary for this though.

};
}
const newEntry = {
Expand Down Expand Up @@ -284,14 +275,18 @@ export class ColumnSpecificSectionContent extends PureComponent<
commitChanges(): void {
const {
formatSettings,
defaultDateTimeFormat,
showTimeZone,
showTSeparator,
timeZone,
defaultDecimalFormatOptions,
defaultIntegerFormatOptions,
truncateNumbersWithPound,
} = this.state;

const {
defaultDateTimeFormat,
defaultDecimalFormatOptions,
defaultIntegerFormatOptions,
} = this.props;

const { dh } = this.props;

const formatter =
Expand Down Expand Up @@ -390,6 +385,41 @@ export class ColumnSpecificSectionContent extends PureComponent<
return error;
}

makeDefaultFormatterItemByType(
columnType: string
): TableColumnFormat | string {
switch (TableUtils.getNormalizedType(columnType)) {
case TableUtils.dataType.INT: {
const { defaultIntegerFormatOptions } = this.props;
const { defaultFormatString: defaultIntegerFormatString } =
defaultIntegerFormatOptions;
return IntegerColumnFormatter.makeFormat(
'',
defaultIntegerFormatString ??
IntegerColumnFormatter.DEFAULT_FORMAT_STRING,
IntegerColumnFormatter.TYPE_GLOBAL,
undefined
);
}

case TableUtils.dataType.DECIMAL: {
const { defaultDecimalFormatOptions } = this.props;
const { defaultFormatString: defaultDecimalFormatString } =
defaultDecimalFormatOptions;
return DecimalColumnFormatter.makeFormat(
'',
defaultDecimalFormatString ??
DecimalColumnFormatter.DEFAULT_FORMAT_STRING,
DecimalColumnFormatter.TYPE_GLOBAL,
undefined
);
}
default: {
return '';
}
}
}

renderFormatRule(i: number, rule: FormatterItem): ReactElement {
const columnNameId = `input-${i}-columnName`;
const columnTypeId = `input-${i}-columnType`;
Expand All @@ -399,8 +429,9 @@ export class ColumnSpecificSectionContent extends PureComponent<
this.handleFormatRuleChange(i, 'columnName', e.target.value);
const onNameBlur = (): void =>
this.handleFormatRuleChange(i, 'isNewRule', false);
const onTypeChange = (e: ChangeEvent<HTMLSelectElement>): void =>
const onTypeChange = (e: ChangeEvent<HTMLSelectElement>): void => {
this.handleFormatRuleChange(i, 'columnType', e.target.value);
};
Copy link
Copy Markdown
Member

@mofojed mofojed Oct 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why you added these here - handleFormatRuleChange doesn't return anything, so you can keep the shorthand. Or update the onNameChange and onNameBlur declarations to match for consistency.

const ruleError = this.getRuleError(rule);

return (
Expand Down Expand Up @@ -511,6 +542,7 @@ export class ColumnSpecificSectionContent extends PureComponent<
isInvalid: boolean
): ReactElement {
const { showTimeZone, showTSeparator, timeZone } = this.state;

const value = format.formatString ?? '';
return (
<select
Expand Down Expand Up @@ -544,6 +576,8 @@ export class ColumnSpecificSectionContent extends PureComponent<
format: Partial<TableColumnFormat>,
isInvalid: boolean
): ReactElement {
const { defaultIntegerFormatOptions } = this.props;
const { defaultFormatString } = defaultIntegerFormatOptions;
const value = format.formatString ?? '';
return (
<input
Expand All @@ -552,7 +586,9 @@ export class ColumnSpecificSectionContent extends PureComponent<
})}
data-lpignore
id={formatId}
placeholder={IntegerColumnFormatter.DEFAULT_FORMAT_STRING}
placeholder={
defaultFormatString ?? IntegerColumnFormatter.DEFAULT_FORMAT_STRING
}
type="text"
value={value}
onChange={e => {
Expand All @@ -574,6 +610,9 @@ export class ColumnSpecificSectionContent extends PureComponent<
format: Partial<TableColumnFormat>,
isInvalid: boolean
): ReactElement {
const { defaultDecimalFormatOptions } = this.props;
const { defaultFormatString } = defaultDecimalFormatOptions;

const value = format.formatString ?? '';
return (
<input
Expand All @@ -582,7 +621,9 @@ export class ColumnSpecificSectionContent extends PureComponent<
})}
data-lpignore
id={formatId}
placeholder={DecimalColumnFormatter.DEFAULT_FORMAT_STRING}
placeholder={
defaultFormatString ?? DecimalColumnFormatter.DEFAULT_FORMAT_STRING
}
type="text"
value={value}
onChange={e => {
Expand Down
2 changes: 1 addition & 1 deletion packages/code-studio/src/settings/FormattingSectionContent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,7 +617,7 @@ export class FormattingSectionContent extends PureComponent<
checked={truncateNumbersWithPound ?? null}
onChange={this.handleTruncateNumbersWithPoundChange}
>
Truncate numbers with #
Show truncated numbers as ###
Copy link
Copy Markdown
Member

@mofojed mofojed Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A contextual help bubble could be useful here... I think the phrase "Mask truncated numbers with ###" may be better as well, @dsmmcken any opinion?

Copy link
Copy Markdown
Contributor

@dsmmcken dsmmcken Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am fine with this suggestion. Using the word show is more consistent wit the other labels, like "Show T seperator", and I like the multiple hashtags in the label. It's a bit long now is my only complaint.

Copy link
Copy Markdown
Contributor Author

@Zhou-Ziheng Zhou-Ziheng Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about Show truncation as ###

Copy link
Copy Markdown
Contributor

@dsmmcken dsmmcken Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It only applies to numbers though

</Checkbox>
</div>
</div>
Expand Down
⚡