Skip to content
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.

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

Copy formatted cell values to clipboard instead of raw values #3094

Merged
merged 5 commits into from
Jul 26, 2023

Conversation

seancolsen
Copy link
Contributor

Fixes #3085

Notes

  • b288c53 is the change which actually fixes the bug. It's a very small change.
  • The bug is from a mistake I made while implementing Improve TSV serialization when copying cells #2867, partly because I was also working to lay some groundwork for Frontend support for pasting from the system clipboard into Mathesar cells #2812. To support pasting cell values in a robust manner, we need to copy the formatted cell value and the raw cell value. That's why I had code to handle both of these sorts of values. But the code wasn't actually using both values before, which may have been a little confusing.
  • In this PR I've gone ahead and implemented some of the remaining logic so as to make this existing code a bit clearer. I did a little refactoring along the way to improve code cleanliness.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

- Improve readability
- Add some more code working towards copy-paste so that the intent is
  clearer behind the separation of raw vs formatted values.
@seancolsen seancolsen added this to the v0.1.3 milestone Jul 24, 2023
@seancolsen seancolsen added the pr-status: review A PR awaiting review label Jul 24, 2023
@seancolsen
Copy link
Contributor Author

@ghislaineguerin you might also be interested in looking at this since it addresses an issue you originally reported.

Comment on lines 124 to 151
for (const rowId of this.getRowIds(cells)) {
const plainTextRow: string[] = [];
const tsvRow: string[] = [];
const structuredRow: StructuredCell[] = [];
for (const columnId of this.getColumnIds(cells)) {
if (isCellSelected(cells, { rowIndex: rowId }, { id: columnId })) {
const cellText = getCellText(
indexedRecords,
processedColumns,
rowId,
columnId,
'raw',
recordSummaries,
);
plainTextRow.push(cellText);
const column = columns.get(columnId);
if (!isCellSelected(cells, { rowIndex: rowId }, { id: columnId })) {
// Ignore cells that are not selected.
continue;
}
if (!column) {
// Ignore cells with no associated column. This should never happen.
continue;
}
const rawCellValue = getRawCellValue(indexedRecords, rowId, columnId);
const formattedCellValue = getFormattedCellValue(
rawCellValue,
columns,
columnId,
recordSummaries,
);
const type = column.abstractType.identifier;
structuredRow.push({
type,
raw: rawCellValue,
formatted: formattedCellValue,
});
tsvRow.push(formattedCellValue);
}
Copy link
Member

@pavish pavish Jul 26, 2023

Choose a reason for hiding this comment

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

@seancolsen A minor nitpick.

For cases like these, where we don't have break out of the loop, I'd prefer iterating with forEach and return statements instead of a for loop and continue.

I don't have a major concern towards removing the no-continue rule, but I'm not a fan of continue either.

No action item needed. I only wanted to share this.

Copy link
Member

@pavish pavish left a comment

Choose a reason for hiding this comment

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

Looks good!

@pavish pavish added this pull request to the merge queue Jul 26, 2023
Merged via the queue into develop with commit ff2c5bc Jul 26, 2023
@pavish pavish deleted the 3085_copy_fk_values branch July 26, 2023 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: review A PR awaiting review
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Copying FK cells should copy the record summary instead of the PK value
2 participants